Project

contai

0.0
The project is in a healthy, maintained state
contaicapaas/contaiHomepageDocumentationSource CodeBug Tracker
A Ruby on Rails gem that provides seamless integration with AI services to automatically generate content for your Rails models. It offers a simple interface to enhance your models with AI-generated content, supporting various content types and customization options.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
624
Stars
1
Forks
0
Watchers
0
 Releases
Current version
0.1.5
Total releases
6
First release
2025-06-06
Latest release
2025-06-06
 Development
Primary Language
Ruby
Licenses
CAPAAL
Average date of last 50 commits
2025-06-06
Reverse Dependencies
0

 Dependencies

Development

rspec
~> 3.0
sqlite3
~> 1.4

Runtime

httparty
~> 0.20
rails
>= 7.0, < 9.0
 Project Readme

Contai

AI content generation for Rails models. Integrate external AI APIs seamlessly into your Rails applications.

Installation

Add this line to your application's Gemfile:

gem 'contai'

And then execute:

$ bundle install

Usage

Basic Setup

Include Contai::Generatable in your model and configure it:

class Article < ApplicationRecord
  include Contai::Generatable
  
  contai do
    prompt_from :title, :description
    output_to :body
    provider :openai, api_key: ENV["OPENAI_API_KEY"]
    template "Write a blog post about: {{title}} - {{description}}"
  end
end

Generate Content

article = Article.new(title: "Ruby on Rails", description: "Web framework")
article.generate_ai_content!
# Content will be generated and saved to article.body

# Async generation
article.generate_ai_content!(async: true)

Supported Providers

OpenAI

provider :openai, 
  api_key: ENV["OPENAI_API_KEY"],
  model: "gpt-4",
  max_tokens: 1000

Claude

provider :claude,
  api_key: ENV["CLAUDE_API_KEY"],
  model: "claude-3-sonnet-20240229"

N8N Webhook

provider :n8n,
  webhook_url: "https://your-n8n-instance.com/webhook/your-webhook-id",
  headers: { "Authorization" => "Bearer #{ENV['N8N_API_KEY']}" },
  response_path: "output"

Custom HTTP

provider :http,
  url: "https://api.example.com/generate",
  method: :post,
  headers: { "Authorization" => "Bearer #{ENV['API_KEY']}" },
  body_template: { prompt: "{{prompt}}", model_name: "custom-model" },
  response_path: "result.text"

Configuration

Configure global defaults:

# config/initializers/contai.rb
Contai.configure do |config|
  config.default_provider = :openai
  config.default_template = "Generate content based on: {{prompt}}"
  config.timeout = 30
  
  # Configure default headers for all HTTP-based providers
  config.default_headers = {
    "Content-Type" => "application/json",
    "Authorization" => "Bearer #{ENV['DEFAULT_API_KEY']}"
  }
end

HTTP Headers Configuration

You can configure HTTP headers in three ways:

  1. Global default headers in the initializer (applies to all HTTP-based providers):
Contai.configure do |config|
  config.default_headers = {
    "Content-Type" => "application/json",
    "Authorization" => "Bearer #{ENV['DEFAULT_API_KEY']}"
  }
end
  1. Provider-specific headers in your model:
contai do
  provider :http,
    url: "https://api.example.com/generate",
    headers: { "Authorization" => "Bearer #{ENV['SPECIFIC_API_KEY']}" }
end
  1. Combining both - provider headers will be merged with default headers:
# In config/initializers/contai.rb
Contai.configure do |config|
  config.default_headers = {
    "Content-Type" => "application/json",
    "X-API-Version" => "v1"
  }
end

# In your model
contai do
  provider :n8n,
    webhook_url: "https://your-n8n-instance.com/webhook/id",
    headers: { "Authorization" => "Bearer #{ENV['N8N_API_KEY']}" }
    # Final headers will be:
    # {
    #   "Content-Type" => "application/json",
    #   "X-API-Version" => "v1",
    #   "Authorization" => "Bearer ..."
    # }
end

Routes

Add to your routes file:

# config/routes.rb
Rails.application.routes.draw do
  post '/contai/generate', to: 'contai/generations#create', as: 'contai_generation'
end

Error Handling

The gem provides comprehensive error handling:

article = Article.new(title: "Test")
result = article.generate_ai_content!

unless result
  puts article.errors.full_messages
  # => ["AI generation failed: API error"]
end

Testing

Test your models with Contai:

# spec/models/article_spec.rb
RSpec.describe Article do
  describe '#generate_ai_content!' do
    let(:article) { create(:article, title: "Test", description: "Test desc") }
    
    before do
      allow_any_instance_of(Contai::Providers::OpenAI).to receive(:generate)
        .and_return(double(success?: true, content: "Generated content"))
    end
    
    it 'generates content' do
      expect { article.generate_ai_content! }.to change { article.body }
        .from(nil).to("Generated content")
    end
  end
end

Development

After checking out the repo, run:

bundle install
rake spec

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

The gem is available as open source under the terms of the CAPAA License.