ruby-leonardoai 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267d56d7aa704aabc1811a935781aeb4a76fd33a6190814fa24d0205094e4a0a
-  data.tar.gz: 257de0b0042ce3f39de55fbb49b6df8a04b011852627cf6c3ae040c5ae76c3c9
+  metadata.gz: d108ed0e36199b2e7841810b31b77e951b1173082f97aa75410de1050aaa6080
+  data.tar.gz: c31edd35e33bc9c5a0c9ba2df992f8ce9b8f38698cdd9c48d0789a441f0eb8cd
 SHA512:
-  metadata.gz: a35af039b1a1a22e5b34d64e9fa7698dca4ecde84205699218bba8bb3a9ac8e769afb87342b97bc0a2374a1496b7ee4f8def929e356422acb476aebda0f3f69c
-  data.tar.gz: aa680397e3e68cf6e442b5c0932d09ed0423352e94c7ad53d1fa560bf6bfb4e5a50b00d2dcac6573c8d8063e890ab072103ae35e83dbddf2c2dd2273df6b8dc3
+  metadata.gz: 9fce8ddb89a37f921531baecab3ee91d95314bc94757acdbab8d140c871b64caa65d961bb1c8929242c1e0d40e075cf64f088a81c73d8e6185969ae3e2ebb159
+  data.tar.gz: 2acadd28592ca2cb8131892b853add8193afef93f22f74d00af9060df6c7cbeed8d11cfd761106ab2cb4677a4c2f6e12e552eae51086b97a1df2757d0a878375

data/CHANGELOG.md

@@ -3,3 +3,11 @@
 ## [0.1.0] - 2023-10-01
 
 - Initial release
+
+## [0.1.3] - 2023-10-10
+
+- Updated file structure and got image generation working.
+
+## [0.1.3] - 2023-10-10
+
+- Added README.md and updated installation and how-to-use instructions

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    ruby-leonardoai (0.1.3)
+      faraday (>= 1)
+      faraday-multipart (>= 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    faraday (2.7.10)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    json (2.6.3)
+    multipart-post (2.3.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.5.0)
+    vcr (6.1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.50.2)
+  ruby-leonardoai!
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.20

data/README.md

@@ -1,32 +1,170 @@
-# Ruby::Leonardoai
+# Ruby LeonardoAI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby/leonardoai`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/ruby-leonardoai)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/royalgiant/ruby-leonardoai/blob/main/LICENSE.txt)
 
-TODO: Delete this and the text above, and describe your gem
+Use the [LeonardoAI API](https://docs.leonardo.ai/reference/getuserself) with Ruby! 🤖❤️
 
-## Installation
+Generate, Get, and Delete images, models, variations, and datasets with Leonardo AI
 
-Install the gem and add to the application's Gemfile by executing:
+🚢 Based in the US and want to hire me? Now you can! [Email Me](mailto:donaldlee50@gmail.com)
 
-    $ bundle add ruby-leonardoai
+[🐦 Twitter](https://twitter.com/donaldlee50) | [▶️ Youtube](https://youtube.com/c/donaldleecrypto) 
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### Bundler
 
-    $ gem install ruby-leonardoai
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-leonardoai"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+### Gem install
+
+Or install with:
+
+```bash
+$ gem install ruby-leonardoai
+```
+
+and require with:
+
+```ruby
+require "leonardoai"
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+- Get your API access from [https://app.leonardo.ai/api-access](https://app.leonardo.ai/api-access)
+- After subscribing, you will be able to generate an api key from [https://app.leonardo.ai/settings](https://app.leonardo.ai/settings)
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = LeonardoAI::Client.new(access_token: "access_token_goes_here")
+```
+
+### With Config
+
+For a more robust setup, you can configure the gem with your API keys, for example in an `leonardoai.rb` initializer file. Never hardcode secrets into your codebase - instead use something like [dotenv](https://github.com/motdotla/dotenv) to pass the keys safely into your environments.
+
+```ruby
+LeonardoAI.configure do |config|
+    config.access_token = ENV.fetch("LEONARDOAI_ACCESS_TOKEN")
+end
+```
+If you use Rails 7, you would probably store your key in credentials.yml, then you can do something like this:
+```ruby
+LeonardoAI.configure do |config|
+    config.access_token = Rails.application.credentials[Rails.env.to_sym].dig(:leonardoai, :api_key)
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = LeonardoAI::Client.new
+```
+
+You can still override the config defaults when making new clients; any options not included will fall back to any global config set with LeonardoAI.configure. e.g. in this example the uri_base, request_timeout, etc. will fallback to any set globally using LeonardoAI.configure, with only the access_token overridden:
+
+```ruby
+client = LeonardoAI::Client.new(access_token: "access_token_goes_here")
+```
+
+#### Custom timeout or base URI
+
+The default timeout for any request using this library is 120 seconds. You can change that by passing a number of seconds to the `request_timeout` when initializing the client. You can also change the base URI used for all requests.
+
+```ruby
+client = LeonardoAI::Client.new(
+    access_token: "access_token_goes_here",
+    uri_base: "https://cloud.leonardo.ai/api/rest/v1/",
+    request_timeout: 240,
+    extra_headers: {
+      "accept" => "application/json",
+      "content-type": "application/json",
+    }
+)
+```
+
+or when configuring the gem:
+
+```ruby
+LeonardoAI.configure do |config|
+    config.access_token = ENV.fetch("LEONARDOAI_ACCESS_TOKEN") # Or Rails.application.credentials[Rails.env.to_sym].dig(:leonardoai, :api_key) for Rails 7
+    config.uri_base = "https://cloud.leonardo.ai/api/rest/v1/",
+    config.request_timeout = 240 # Optional
+    config.extra_headers = {
+      "accept" => "application/json",
+      "content-type": "application/json",
+    } # Optional
+end
+```
+
+### Generation
+
+ChatGPT is a model that can be used to generate text in a conversational style. You can use it to [generate a response](https://platform.openai.com/docs/api-reference/chat/create) to a sequence of [messages](https://platform.openai.com/docs/guides/chat/introduction):
+
+```ruby
+params = {
+    :height=>1024, 
+    :prompt=>"A ad flyer of a ninja cat, heavy texture, moonlit background, circle design, tshirt design, pen and ink style", 
+    :width=>512, :num_images=>1, 
+    :photoReal=>false, 
+    :presetStyle=>"LEONARDO", 
+    :promptMagic=>true, 
+    :promptMagicVersion=>"v2", 
+    :public=>false, 
+    :init_strength=>0.4, 
+    :sd_version=>"v2", 
+}
+
+response = client.generations.generate(parameters: params) # {"sdGenerationJob"=>{"generationId"=>"c747522c-91e7-4830-8d1f-1f1ed37efd35"}}
+puts response.dig("sdGenerationJob", "generationId")
+# => "c747522c-91e7-4830-8d1f-1f1ed37efd35"
+```
+
+### Model
+UNDER CONSTRUCTION
+
+### Unzoom
+UNDER CONSTRUCTION
+
+### Dataset
+UNDER CONSTRUCTION
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Warning
+
+If you have an `LEONARDOAI_ACCESS_TOKEN` in your `ENV`, running the specs will use this to run the specs against the actual API, which will be slow and cost you money - 2 cents or more! Remove it from your environment with `unset` or similar if you just want to run the specs against the stored VCR responses.
+
+## Release
+
+First run the specs without VCR so they actually hit the API. This will cost 2 cents or more. Set LEONARDOAI_ACCESS_TOKEN in your environment or pass it in like this:
+
+```
+LEONARDOAI_ACCESS_TOKEN=123abc bundle exec rspec
+```
+
+Then update the version number in `version.rb`, update `CHANGELOG.md`, run `bundle install` to update Gemfile.lock, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-leonardoai. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ruby-leonardoai/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/royalgiant/ruby-leonardoai>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/royalgiant/ruby-leonardoai/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -34,5 +172,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ruby::Leonardoai project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-leonardoai/blob/main/CODE_OF_CONDUCT.md).
-# ruby-leonardoai
+Everyone interacting in the Ruby LeonardoAI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/royalgiant/ruby-leonardoai/blob/main/CODE_OF_CONDUCT.md).
+
+## Influences
+Project heavily influenced by [https://github.com/alexrudall/ruby-openai](https://github.com/alexrudall/ruby-openai). Great project, go give them a star!

data/lib/leonardoai/client.rb

@@ -0,0 +1,31 @@
+module LeonardoAI
+  class Client
+    include LeonardoAI::HTTP
+
+    CONFIG_KEYS = %i[
+      api_type
+      api_version
+      access_token
+      uri_base
+      request_timeout
+      extra_headers
+    ].freeze
+    attr_reader *CONFIG_KEYS
+
+    def initialize(config = {})
+      CONFIG_KEYS.each do |key|
+        # Set instance variables like api_type & access_token. Fall back to global config
+        # if not present.
+        instance_variable_set("@#{key}", config[key] || LeonardoAI.configuration.send(key))
+      end
+    end
+
+    def chat(parameters: {})
+      json_post(path: "/chat/completions", parameters: parameters)
+    end
+
+    def generations
+      @generations ||= LeonardoAI::Generations.new(client: self)
+    end
+  end
+end

data/lib/leonardoai/compatibility.rb

@@ -0,0 +1,9 @@
+module Ruby
+  module LeonardoAI
+    VERSION = ::LeonardoAI::VERSION
+
+    Error = ::LeonardoAI::Error
+    ConfigurationError = ::LeonardoAI::ConfigurationError
+    Configuration = ::LeonardoAI::Configuration
+  end
+end

data/lib/{ruby/leonardoai → leonardoai}/generations.rb

@@ -5,11 +5,11 @@ module LeonardoAI
     end
 
     def generate(parameters: {})
-      @client.json_post(path: "/images/generations", parameters: parameters)
+      @client.json_post(path: "/generations", parameters: parameters)
     end
 
     def edit(parameters: {})
-      @client.multipart_post(path: "/images/edits", parameters: open_files(parameters))
+      @client.multipart_post(path: "/edits", parameters: open_files(parameters))
     end
 
     private
@@ -19,7 +19,5 @@ module LeonardoAI
       parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]
       parameters
     end
-
-    def 
   end
 end

data/lib/leonardoai/http.rb

@@ -0,0 +1,73 @@
+module LeonardoAI
+  module HTTP
+    def get(path:)
+      to_json(conn.get(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    def json_post(path:, parameters:)
+      to_json(conn.post(uri(path: path)) do |req|
+        req.headers = headers
+        req.body = parameters.to_json
+      end&.body)
+    end
+
+    def multipart_post(path:, parameters: nil)
+      to_json(conn(multipart: true).post(uri(path: path)) do |req|
+        req.headers = headers.merge({ "Content-Type" => "multipart/form-data" })
+        req.body = multipart_parameters(parameters)
+      end&.body)
+    end
+
+    def delete(path:)
+      to_json(conn.delete(uri(path: path)) do |req|
+        req.headers = headers
+      end&.body)
+    end
+
+    private
+
+    def to_json(string)
+      return unless string
+
+      JSON.parse(string)
+      rescue JSON::ParserError
+        # Convert a multiline string of JSON objects to a JSON array.
+        JSON.parse(string.gsub("}\n{", "},{").prepend("[").concat("]"))
+    end
+
+    def conn(multipart: false)
+      Faraday.new do |f|
+        f.options[:timeout] = @request_timeout
+        f.request(:multipart) if multipart
+      end
+    end
+
+    def uri(path:)
+      File.join(@uri_base, @api_version, path)
+    end
+
+    def headers
+      leonardoai_headers.merge(@extra_headers || {})
+    end
+
+    def leonardoai_headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{@access_token}",
+      }
+    end
+
+    def multipart_parameters(parameters)
+      parameters&.transform_values do |value|
+        next value unless value.respond_to?(:close) # File or IO object.
+
+        # Doesn't seem like OpenAI needs mime_type yet, so not worth
+        # the library to figure this out. Hence the empty string
+        # as the second argument.
+        Faraday::UploadIO.new(value, "", value.path)
+      end
+    end
+  end
+end

data/lib/leonardoai/version.rb

@@ -0,0 +1,3 @@
+module LeonardoAI
+  VERSION = "0.1.4"
+end

data/lib/leonardoai.rb

@@ -1,9 +1,11 @@
 require "faraday"
 require "faraday/multipart"
+require_relative "leonardoai/http"
+require_relative "leonardoai/client"
+require_relative "leonardoai/generations"
 require_relative "leonardoai/version"
 
-
-module Leonardoai
+module LeonardoAI
   class Error < StandardError; end
   class ConfigurationError < Error; end
 
@@ -13,7 +15,7 @@ module Leonardoai
                   :extra_headers
 
     DEFAULT_API_VERSION = "v1".freeze
-    DEFAULT_URI_BASE = "https://cloud.leonardo.ai/api/rest/v1/".freeze
+    DEFAULT_URI_BASE = "https://cloud.leonardo.ai/api/rest/".freeze
     DEFAULT_REQUEST_TIMEOUT = 120
 
     def initialize
@@ -35,5 +37,17 @@ module Leonardoai
       raise ConfigurationError, error_text
     end
   end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= LeonardoAI::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end
 

data/lib/ruby/leonardoai.rb

@@ -0,0 +1,2 @@
+require_relative "../leonardoai"
+require_relative "../leonardoai/compatibility"

data/ruby-leonardoai.gemspec

@@ -1,10 +1,8 @@
-# frozen_string_literal: true
-
-require_relative "lib/ruby/leonardoai/version"
+require_relative "lib/leonardoai/version"
 
 Gem::Specification.new do |spec|
   spec.name = "ruby-leonardoai"
-  spec.version = Ruby::Leonardoai::VERSION
+  spec.version = LeonardoAI::VERSION
   spec.authors = ["Donald Lee"]
   spec.email = ["donaldlee50@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-leonardoai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Donald Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-07 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -49,14 +49,19 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/leonardoai.rb
-- lib/ruby/leonardoai/generations.rb
-- lib/ruby/leonardoai/version.rb
+- lib/leonardoai/client.rb
+- lib/leonardoai/compatibility.rb
+- lib/leonardoai/generations.rb
+- lib/leonardoai/http.rb
+- lib/leonardoai/version.rb
+- lib/ruby/leonardoai.rb
 - ruby-leonardoai.gemspec
 - sig/ruby/leonardoai.rbs
 homepage: https://github.com/royalgiant/ruby-leonardoai

data/lib/ruby/leonardoai/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Ruby
-  module Leonardoai
-    VERSION = "0.1.0"
-  end
-end