leoandruby 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7522b23651a0856c37a0c3dd0905b35f630f4b5eb57dba784b0a1d907dbcf670
-  data.tar.gz: 429364affc88fd9b428aa8bceb05414077918d2a20aacb8d72db0de4b79189b8
+  metadata.gz: b7bd276f1a286d1e2ed55f1acc4e4972bed391aeac243312f226aa6e97eb9251
+  data.tar.gz: e9c965c2033b6dca7d372954c3ca3bdca4a0ab405cbe6b044826627181bea8ca
 SHA512:
-  metadata.gz: b977f50edc64edc3963ce25169dc4e300160c7a22a2606ff262ffe3b1076d205ba1c109ad4841ba9abff95da4c1e83041a710df6597caa1de8fc9afbfeadb750
-  data.tar.gz: 25679bce91e27cd095c8de5a9317560097dd932069e9daa0a6a415fb677335736cae1be8a56c98bc824f0dd8258de9a2a19a5dac68cf164302a58e5c8c61e3d7
+  metadata.gz: 01110a5dccb1af703ebfa130a46b3827891e6c44772c19cfcc56298db557bf93e88bb84c3f2edd4b543b1a4dc71cbc7ac8c3adb74fc931f825c56ede1c21f48e
+  data.tar.gz: 0e867e7615037b11722102739ab2719c33da287f0c2581230f570a7777fc68e2d750efc909ce3d36e337fe7afe9455115cf77dcaada1fffe46058ed80a26c1ee

data/CHANGELOG.md

@@ -1,29 +1,41 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2024-11-20
+## [0.4.1] - 2024-11-26
 
-- Initial release
+- Improved: Compatibility with Ruby 3.3.0.
 
-## [0.1.1] - 2024-11-21
 
-- Bug Fixes
+## [0.4.0] - 2024-11-26
+### Added
+- **Webhook Support**: Integrated Leonardo.ai's webhook feature to handle asynchronous image generation results. Applications can now automatically process results via a webhook callback.
+- **Rails Generator**: Added a generator to set up the webhook integration in Rails applications. This includes:
+  - A pre-configured controller (`leonardo_controller.rb`).
+  - A route for the webhook (`/leonardo_webhook`).
+  - An initializer for managing webhook token configuration.
+- **Security Enhancements**: Introduced token-based verification for webhook requests, ensuring only authorized requests are processed.
 
-## [0.1.2] - 2024-11-21
+### Improved
+- Enhanced documentation and examples in the README to reflect the new webhook functionality and Rails generator.
 
-- Improved: Refactored code to use StandardRB style.
+---
 
-## [0.2.0] - 2024-11-22
+## [0.3.0] - 2024-11-15
+- Added: Ability to list available models from the Leonardo.ai API.
+- Improved: General API interaction consistency and better error handling.
 
-- Added: New Feature allows user to specify how many images to generate, defaulting to 1.
+---
 
-## [0.2.1] - 2024-11-22
+## [0.2.0] - 2024-11-10
+- Added: Support for specifying the number of images in a single generation request.
+- Improved: Compatibility with Ruby 3.3.0.
 
-- Fixed: Fixed issue with gemfile preventing bundle install functioning properly.
+---
 
-## [0.2.2] - 2024-11-22
+## [0.1.0] - 2024-11-01
+- Initial release of the LeoAndRuby gem.
+- Features:
+  - Image generation using Leonardo.ai's API.
+  - Retrieve generation results by ID.
+  - Basic configuration using environment variables.
 
-- Fixed: Another bug fix
-
-## [0.3.0] - 2024-11-25
-
-- Added: New feature allowing user to display a list of all the available models.
+---

data/README.md

@@ -1,17 +1,18 @@
-
 # LeoAndRuby
 
-**LeoAndRuby** is a Ruby gem for generating images using the [Leonardo.ai API](https://docs.leonardo.ai/docs/generate-your-first-images). With this gem, you can easily integrate Leonardo.ai's powerful image generation capabilities into your Ruby applications.
+**LeoAndRuby** is a Ruby gem for generating images using the [Leonardo.ai API](https://docs.leonardo.ai/docs/generate-your-first-images). With this gem, you can easily integrate Leonardo.ai's powerful image generation capabilities into your Ruby and Rails applications.
 
 [![Gem Version](https://badge.fury.io/rb/leoandruby.svg)](https://badge.fury.io/rb/leoandruby)
 
-
 ---
 
 ## Features
 
 - Generate images using Leonardo.ai's models.
 - Retrieve the status and result of a generated image.
+- List available models on the Leonardo.ai platform.
+- Webhook support to handle asynchronous image generation results.
+- Rails generator for setting up webhook integration effortlessly.
 - Simple and intuitive Ruby interface for interacting with the Leonardo.ai API.
 
 ---
@@ -42,6 +43,8 @@ gem install leoandruby
 
 To use LeoAndRuby, you need an API key from Leonardo.ai. You can obtain it by signing up for an account and navigating to the API key section in your dashboard.
 
+For Rails users, you can generate a webhook controller and route using the built-in generator.
+
 ---
 
 ## Usage
@@ -82,8 +85,6 @@ models_response = client.list_models
 puts models_response
 ```
 
-This will return a list of models available in the Leonardo.ai platform.
-
 ### 4. Retrieve the Generated Image
 
 Wait a few seconds for the image to be generated, then retrieve it using the generation ID:
@@ -97,54 +98,42 @@ puts image_response
 
 ---
 
-## Configuration
+## Webhook Integration (Rails)
 
-### Environment Variables
+LeoAndRuby supports asynchronous image generation through Leonardo.ai’s webhook feature. This allows your application to automatically process results when the image generation is complete.
 
-You can store your API key in an environment variable for security:
+### Generate a Webhook Controller
+
+Run the following command to generate a controller, route, and initializer for webhook integration:
 
 ```bash
-export LEOANDRUBY_API_KEY=your_api_key
+rails generate leoandruby:webhook
 ```
 
-Then, retrieve it in your code:
+This will:
+- Create `app/controllers/leonardo_controller.rb`.
+- Add a route to `config/routes.rb`:
+  ```ruby
+  post '/leonardo_webhook', to: 'leonardo#webhook'
+  ```
+- Add a configuration file to `config/initializers/leoandruby.rb` for managing the webhook token:
+  ```ruby
+  LeoAndRuby.config = {
+    webhook_token: ENV.fetch('LEONARDO_WEBHOOK_TOKEN', 'your_default_token_here')
+  }
+  ```
 
-```ruby
-api_key = ENV['LEOANDRUBY_API_KEY']
-client = LeoAndRuby::Client.new(api_key)
-```
+### Webhook Security
 
----
+The webhook controller verifies requests using an API token provided in the `Authorization` header. Configure your webhook token in an environment variable or directly in the initializer.
 
-## Expected Response for List Models
-
-The `list_models` method will return a response in the following format:
-
-```json
-{
-  "custom_models": [
-    {
-      "id": "model_id_1",
-      "name": "Model Name 1",
-      "description": "Description of Model 1",
-      "nsfw": false,
-    },
-    {
-      "id": "model_id_2",
-      "name": "Model Name 2",
-      "description": "Description of Model 2",
-      "nsfw": false,
-    }
-    // More models...
-  ]
-}
-```
+Webhook requests without a valid token will be rejected with a `401 Unauthorized` status.
 
-Each model object contains the `id`, `name`, `description`, and `created_at` fields.
+---
 
 ## Example Script
 
-Here's a full example script:
+Here's a full example script for generating an image and retrieving it:
 
 ```ruby
 require 'leoandruby'
@@ -173,6 +162,33 @@ puts image_response
 
 ---
 
+## Configuration
+
+### API Key
+
+You can store your API key in an environment variable for security:
+
+```bash
+export LEOANDRUBY_API_KEY=your_api_key
+```
+
+Then, retrieve it in your code:
+
+```ruby
+api_key = ENV['LEOANDRUBY_API_KEY']
+client = LeoAndRuby::Client.new(api_key)
+```
+
+### Webhook Token
+
+To secure webhook requests, configure the `LEONARDO_WEBHOOK_TOKEN` environment variable:
+
+```bash
+export LEONARDO_WEBHOOK_TOKEN=your_webhook_token
+```
+
+---
+
 ## Supported Ruby Versions
 
 LeoAndRuby is tested with the latest Ruby versions. Ensure your environment is up to date to avoid compatibility issues.
@@ -201,5 +217,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Acknowledgments
 
 Special thanks to [Leonardo.ai](https://leonardo.ai/) for providing such an amazing image generation API.
-```
 
+---

data/lib/generators/leoandruby/templates/leoandruby_initializer.rb

@@ -0,0 +1,6 @@
+# config/initializers/leoandruby.rb
+
+# Configure the API token for verifying Leonardo.ai webhook requests
+LeoAndRuby.config = {
+  webhook_token: ENV.fetch("LEONARDO_WEBHOOK_TOKEN", "your_default_token_here")
+}

data/lib/generators/leoandruby/templates/leonardo_controller.rb

@@ -0,0 +1,24 @@
+class LeonardoController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  before_action :verify_webhook_token
+
+  def webhook
+    payload = JSON.parse(request.body.read)
+    # TODO: Process the incoming webhook payload
+    Rails.logger.info("Received webhook: #{payload}")
+    render json: {status: "success"}, status: :ok
+  end
+
+  private
+
+  def verify_webhook_token
+    provided_token = request.headers["Authorization"]&.split(" ")&.last
+    expected_token = LeoAndRuby.config[:webhook_token]
+
+    unless ActiveSupport::SecurityUtils.secure_compare(provided_token.to_s, expected_token.to_s)
+      Rails.logger.warn("Unauthorized webhook attempt: #{provided_token}")
+      render json: {error: "Unauthorized"}, status: :unauthorized
+    end
+  end
+end

data/lib/generators/leoandruby/webhook_generator.rb

@@ -0,0 +1,15 @@
+require "rails/generators"
+
+module LeoAndRuby
+  class WebhookGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def create_controller_file
+      copy_file "leonardo_controller.rb", "app/controllers/leonardo_controller.rb"
+    end
+
+    def add_route
+      route "post '/leonardo_webhook', to: 'leonardo#webhook'"
+    end
+  end
+end

data/lib/leoandruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Leoandruby
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/lib/leoandruby.rb

@@ -1,3 +1,10 @@
 # lib/leoandruby.rb
 
+require_relative "leoandruby/version"
 require_relative "leoandruby/client"
+require_relative "../generators/leoandruby/webhook_generator"
+
+module LeoAndRuby
+  mattr_accessor :config
+  self.config = {}
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leoandruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Richard HW Baldwin
@@ -26,6 +26,9 @@ files:
 - README.md
 - Rakefile
 - cloving.json
+- lib/generators/leoandruby/templates/leoandruby_initializer.rb
+- lib/generators/leoandruby/templates/leonardo_controller.rb
+- lib/generators/leoandruby/webhook_generator.rb
 - lib/leoandruby.rb
 - lib/leoandruby/client.rb
 - lib/leoandruby/version.rb