rails_ai_tag 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '081c2a789ce7fc4edc77b8fe9ff24445953f021588106460191094e23dcc66a5'
+  data.tar.gz: 945f655bc60334fa115b54aa2b577eedc59601117b1e813d03a48b019b885860
+SHA512:
+  metadata.gz: a6d04bcc98305761e95064e3b69e52799a11c8f70e5d31141c8effe577510992859fc3877c8a2674d66ecd4a9f83d54f119664d6c5816a6b33ead504a23b52bc
+  data.tar.gz: 9780e180b6df6801348c825b5fbe4aebec240d92117c15c79eb67c404525a853c2dd1806ccafb8df712383a998d12f22b5faa5b55239c003b3fdba303f66cf34

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_ai_tag.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "httparty"

data/README.md

@@ -0,0 +1,60 @@
+# RailsAiTag
+
+```erb
+<%= ai_image_tag("A cute cat with a barretina that likes ruby on rails") %>
+```
+![alt text](doc/image_ai_cat.png)
+
+RailsAiTag is a Ruby on Rails gem that provides custom HTML helpers for AI-powered image generation. Currently, it supports generating `<img>` tags with images created by OpenAI's image generation API, based on a given description. This gem is designed to be extendable, with plans for supporting other AI services.
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'rails_ai_tag'
+```
+Then, run:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+Configure the gem by specifying your AI service provider and API key. Currently, only OpenAI is supported as the provider.
+
+Add the configuration in an initializer (e.g., config/initializers/rails_ai_tag.rb):
+
+```ruby
+RailsAiTag.configure do |config|
+  config.provider = :openai        # Currently, only :openai is supported
+  config.api_key = "YOUR_OPENAI_API_KEY"  # Replace with your actual OpenAI API key
+end
+```
+
+## Usage
+Use the ai_image_tag helper in your Rails views. 
+
+Provide a description, and the helper will generate an image based on the description using OpenAI's API.
+
+```erb
+<%= ai_image_tag("A futuristic cityscape at sunset") %>
+```
+
+This helper method generates an <img> tag with the AI-generated image URL and sets the alt attribute to the description.
+![alt text](doc/image_ai_tag.png)
+![alt text](doc/image_ai_tag_2.png)
+## Example
+```erb
+<%= ai_image_tag("A lush green forest with misty mountains in the background") %>
+```
+
+The above code will generate an image tag for an AI-generated image that matches the description provided.
+![alt text](doc/image_ai_tag_3.png)
+## Testing
+RailsAiTag uses RSpec and WebMock for testing. You can run the tests with:
+
+```bash
+rspec
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_ai_tag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_ai_tag/configuration.rb

@@ -0,0 +1,11 @@
+# lib/rails_ai_tag/configuration.rb
+module RailsAiTag
+  class Configuration
+    attr_accessor :provider, :api_key
+
+    def initialize
+      @provider = :openai  # Default to OpenAI
+      @api_key = ENV["OPENAI_API_KEY"]  # Can be set via environment variable or manually
+    end
+  end
+end

data/lib/rails_ai_tag/helpers/ai_image_helper.rb

@@ -0,0 +1,40 @@
+# lib/rails_ai_tag/helpers/ai_image_helper.rb
+require "httparty"
+
+module RailsAiTag
+  module Helpers
+    module AiImageHelper
+      def ai_image_tag(description, **options)
+        image_url = generate_image(description)
+        image_tag(image_url, alt: description, **options)
+      end
+
+      private
+
+      def generate_image(description)
+        case RailsAiTag.configuration.provider
+        when :openai
+          generate_image_openai(description)
+        else
+          raise NotImplementedError, "Provider #{RailsAiTag.configuration.provider} is not supported"
+        end
+      end
+
+      def generate_image_openai(description)
+        response = HTTParty.post("https://api.openai.com/v1/images/generations", {
+          body: { prompt: description, n: 1, size: "512x512" }.to_json,
+          headers: {
+            'Content-Type' => 'application/json',
+            'Authorization' => "Bearer #{RailsAiTag.configuration.api_key}"
+          }
+        })
+
+        if response.code == 200
+          response.parsed_response["data"].first["url"]
+        else
+          "/assets/default_image.png" # Fallback image
+        end
+      end
+    end
+  end
+end

data/lib/rails_ai_tag/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsAiTag
+  VERSION = "0.1.1"
+end

data/lib/rails_ai_tag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# lib/rails_ai_tag.rb
+require "rails_ai_tag/version"
+require "rails_ai_tag/configuration"
+require "rails_ai_tag/helpers/ai_image_helper"
+
+module RailsAiTag
+  class Railtie < ::Rails::Railtie
+    initializer "rails_ai_tag.helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include RailsAiTag::Helpers::AiImageHelper
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/sig/rails_ai_tag.rbs

@@ -0,0 +1,4 @@
+module RailsAiTag
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/spec/helpers/ai_image_helper_spec.rb

@@ -0,0 +1,77 @@
+# spec/helpers/ai_image_helper_spec.rb
+require "rails_helper"
+require "rails_ai_tag/helpers/ai_image_helper"
+
+RSpec.describe RailsAiTag::Helpers::AiImageHelper do
+  include RailsAiTag::Helpers::AiImageHelper
+
+  before do
+    RailsAiTag.configure do |config|
+      config.provider = :openai
+      config.api_key = "test_api_key"
+    end
+  end
+
+  describe "#ai_image_tag" do
+    let(:description) { "A futuristic cityscape at sunset" }
+
+    context "when OpenAI is the provider" do
+      before do
+        RailsAiTag.configuration.provider = :openai
+      end
+
+      it "returns an image tag with the generated image URL" do
+        allow(self).to receive(:generate_image_openai).and_return("https://example.com/generated_image.png")
+
+        result = ai_image_tag(description)
+        expect(result).to include("https://example.com/generated_image.png")
+        expect(result).to include("alt=\"A futuristic cityscape at sunset\"")
+      end
+    end
+  end
+end
+
+# spec/helpers/ai_image_helper_spec.rb
+require "rails_helper"
+require "rails_ai_tag/helpers/ai_image_helper"
+
+RSpec.describe RailsAiTag::Helpers::AiImageHelper do
+  include RailsAiTag::Helpers::AiImageHelper
+
+  before do
+    RailsAiTag.configure do |config|
+      config.provider = :openai
+      config.api_key = "test_api_key" # Mocked API key
+    end
+  end
+
+  describe "#ai_image_tag" do
+    let(:description) { "A futuristic cityscape at sunset" }
+
+    context "when OpenAI is the provider" do
+      before do
+        RailsAiTag.configuration.provider = :openai
+
+        # Mock the OpenAI API response
+        stub_request(:post, "https://api.openai.com/v1/images/generations")
+          .with(
+            body: { prompt: description, n: 1, size: "512x512" }.to_json,
+            headers: {
+              'Content-Type' => 'application/json',
+              'Authorization' => "Bearer test_api_key"
+            }
+          ).to_return(
+            status: 200,
+            body: { "data" => [{ "url" => "https://example.com/generated_image.png" }] }.to_json,
+            headers: { 'Content-Type' => 'application/json' }
+          )
+      end
+
+      it "returns an image tag with the generated image URL" do
+        result = ai_image_tag(description)
+        expect(result).to include("https://example.com/generated_image.png")
+        expect(result).to include("alt=\"A futuristic cityscape at sunset\"")
+      end
+    end
+  end
+end

data/spec/rails_ai_tag_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+RSpec.describe RailsAiTag do
+  it "has a version number" do
+    expect(RailsAiTag::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails_ai_tag"
+require "webmock/rspec"
+
+# Disable external requests in tests
+WebMock.disable_net_connect!(allow_localhost: true)
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: rails_ai_tag
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jordi Bari Corberó
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that extends Rails helpers with AI-powered image generation. Current
+  functionality includes a custom image_tag helper that generates images based on
+  a description.
+email:
+- jordi.bari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc/image_ai_cat.png
+- doc/image_ai_tag.png
+- doc/image_ai_tag_2.png
+- doc/image_ai_tag_3.png
+- lib/rails_ai_tag.rb
+- lib/rails_ai_tag/configuration.rb
+- lib/rails_ai_tag/helpers/ai_image_helper.rb
+- lib/rails_ai_tag/version.rb
+- sig/rails_ai_tag.rbs
+- spec/helpers/ai_image_helper_spec.rb
+- spec/rails_ai_tag_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rails-cat/rails_ai_tag
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rails-cat/rails_ai_tag
+  source_code_uri: https://github.com/rails-cat/rails_ai_tag
+  changelog_uri: https://github.com/rails-cat/rails_ai_tag
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Custom Rails helper for AI-generated image tags
+test_files: []