ruby-leonardoai 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffeeea7f957abbf1047c55db4b65e787b4c881c5bb3025cfad2b773403bcf6c9
-  data.tar.gz: aafa39eba2314b23210262dba8ccbb60b68dc688cd6f111ede64c50b641b6f5d
+  metadata.gz: 177f0c64e72ef9ede48bf722a6a8886be330abcb1f9ab10af719395cb27046c2
+  data.tar.gz: 4c1ed2cb485ada7871c810c6908194bbfe33876af0d44d983a2044494d81324c
 SHA512:
-  metadata.gz: 3e0ed3ba12d42f629cb319784c6c53b8c911a0c7c1d11d07e6b1485c26293d7a44bd1b1132515adb19207641191589d4733e84bd5cda1e4a83f323611f0c9ff4
-  data.tar.gz: 5144d1f07fb74fe88ef233255ff8e970e0985facbaa5ab56377188727e84816f740be883f10d8a607a588abe36e6d0e7924ae90a31138a5391ae8a3a9a141c68
+  metadata.gz: 06d681a7ed63d0d19df5506856d9f62c2254853b031dffd72710cd9988e6050d1c14797c8d5ec5508b323065557255a451d532d8bc322ab278a40607b7132095
+  data.tar.gz: b801221868605de96484b84fad6be03c20653b1046bb9099be052276abfe6b8b5a1b97d01d7d4eaeaf4c8b6331f8a9103333303341d115ca33590999c4a14f8e

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/README.md

@@ -1,32 +1,192 @@
-# 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
+```ruby
+# https://cloud.leonardo.ai/api/rest/v1/models-3d/upload
+
+params = {
+    :modelExtension=>"this-is-an-example", 
+    :name=>"some string"
+}
+
+response = client.models.upload_3d_model(parameters: params) 
+```
+
+```ruby
+# https://cloud.leonardo.ai/api/rest/v1/models/{id}
+
+params = {
+    :modelExtension=>"this-is-an-example", 
+    :name=>"some string"
+}
+
+response = client.models.get_custom_models_by_id(id: "your-custom-model-id-here") 
+```
+
+For more parameters, please check the API found [here](https://docs.leonardo.ai/reference/post_models-3d-upload)
+
+### 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 +194,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

@@ -27,5 +27,9 @@ module LeonardoAI
     def generations
       @generations ||= LeonardoAI::Generations.new(client: self)
     end
+
+    def models
+      @models ||= LeonardoAI::Models.new(client: self)
+    end
   end
 end

data/lib/leonardoai/generations.rb

@@ -8,16 +8,32 @@ module LeonardoAI
       @client.json_post(path: "/generations", parameters: parameters)
     end
 
-    def edit(parameters: {})
-      @client.multipart_post(path: "/edits", parameters: open_files(parameters))
+    def get_generation(id:)
+      @client.get(path: "/generations/#{id}")
     end
 
-    private
+    def delete_generation(id:)
+      @client.delete(path: "/generations/#{id}")
+    end
+
+    def get_user_generations(user_id:)
+      @client.get(path: "/generations/user/#{user_id}")
+    end
+
+    def generate_texture_generation(parameters: {})
+      @client.json_post(path: "/generations-texture", parameters: parameters)
+    end
+
+    def get_texture_generation_by_model_id(model_id:)
+      @client.get(path: "/generations-texture/model/#{model_id}")
+    end
+
+    def get_texture_generation_by_id(id:)
+      @client.get(path: "/generations-texture/model/#{id}")
+    end
 
-    def open_files(parameters)
-      parameters = parameters.merge(image: File.open(parameters[:image]))
-      parameters = parameters.merge(mask: File.open(parameters[:mask])) if parameters[:mask]
-      parameters
+    def delete_texture_generation(id:)
+      @client.delete(path: "/generations-texture/#{id}")
     end
   end
 end

data/lib/leonardoai/models.rb

@@ -0,0 +1,39 @@
+module LeonardoAI
+  class Models
+    def initialize(client: nil)
+      @client = client
+    end
+
+    def upload_3d_model(parameters: {})
+      @client.json_post(path: "/models-3d/upload", parameters: parameters)
+    end
+
+    def get_3d_models_by_user_id(user_id:, offset: 0, limit: 10)
+      @client.get(path: "/models-3d/user/#{user_id}?offset=#{offset}&limit=#{limit}")
+    end
+
+    def get_3d_models_by_id(id:, offset: 0, limit: 10)
+      @client.get(path: "/models-3d/#{id}?offset=#{offset}&limit=#{limit}")
+    end
+
+    def delete_3d_model(id:)
+      @client.delete(path: "/models-3d/#{id}")
+    end
+
+    def train(parameters: {})
+      @client.json_post(path: "/models", parameters: parameters)
+    end
+
+    def get_custom_models_by_id(id:)
+      @client.get(path: "/models/#{id}")
+    end
+
+    def delete_models_by_id(id:)
+      @client.delete(path: "/models/#{id}")
+    end
+
+    def get_platform_models(offset: 0, limit: 10)
+      @client.get(path: "/platformModels?offset=#{offset}&limit=#{limit}")
+    end
+  end
+end

data/lib/leonardoai/version.rb

@@ -1,3 +1,3 @@
 module LeonardoAI
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/leonardoai.rb

@@ -3,6 +3,7 @@ require "faraday/multipart"
 require_relative "leonardoai/http"
 require_relative "leonardoai/client"
 require_relative "leonardoai/generations"
+require_relative "leonardoai/models"
 require_relative "leonardoai/version"
 
 module LeonardoAI

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-leonardoai
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Donald Lee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -60,6 +60,7 @@ files:
 - lib/leonardoai/compatibility.rb
 - lib/leonardoai/generations.rb
 - lib/leonardoai/http.rb
+- lib/leonardoai/models.rb
 - lib/leonardoai/version.rb
 - lib/ruby/leonardoai.rb
 - ruby-leonardoai.gemspec