ruby-stabilityai 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17277edf17941172cadec0db6163696718b1a39968f9495df13a621bc8e8f171
+  data.tar.gz: dde322e316056c9082e8929552a9818d0651b640894b494cb91381bc83def143
+SHA512:
+  metadata.gz: bfd2a44b14b3c5ddfa7a8eae1711551fd114229460938e9d33ffa12cffe6ca1631a45dc11d5be1ae94561f06efbf681dac6d6cb8c319879f10bde1ac842884e1
+  data.tar.gz: 5b013585ad4d464a6ff4ca54895bbc4042d5fb72f1eb39ab27b69cc3306079d26f42e5cb7315d0db2ad4d799f16201fe1c07640dddccaec7603c14e6c98553fc

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history
+.env
+
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
+  # Skips checking to make sure top level modules / classes have a comment.
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - "**/*.gemspec"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+# Include gem dependencies from ruby-stabilityai.gemspec
+gemspec
+
+gem "byebug", "~> 11.1.3"
+gem "dotenv", "~> 2.8.1"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.50.2"
+gem "vcr", "~> 6.1.0"
+gem "webmock", "~> 3.18.1"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    ruby-stabilityai (0.0.1)
+      httparty (>= 0.18.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      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)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    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.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    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.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+    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-22
+
+DEPENDENCIES
+  byebug (~> 11.1.3)
+  dotenv (~> 2.8.1)
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.50.2)
+  ruby-stabilityai!
+  vcr (~> 6.1.0)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.4.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kevin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,209 @@
+# Ruby Stability.ai
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kurbm/ruby-stabilityai/blob/main/LICENSE.txt)
+
+Use the [Stability.ai API](https://platform.stability.ai/) with Ruby! 🤖❤️
+
+Generate images with Stability AI, get engines, accounts and balance
+
+[Ruby AI Builders Discord](https://discord.gg/k4Uc224xVD)
+
+### Bundler
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "ruby-stabilityai"
+```
+
+And then execute:
+
+$ bundle install
+
+### Gem install
+
+Or install with:
+
+$ gem install ruby-stabilityai
+
+and require with:
+
+```ruby
+require "stabilityai"
+```
+
+
+## Usage
+
+- Get your API key from [https://beta.dreamstudio.ai/account](https://beta.dreamstudio.ai/account)
+
+
+### Quickstart
+
+For a quick test you can pass your token directly to a new client:
+
+```ruby
+client = StabilityAI::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 `stabilityai.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
+StabilityAI.configure do |config|
+    config.access_token = ENV.fetch('STABILITYAI_ACCESS_TOKEN')
+    config.organization_id = ENV.fetch('STABILITYAI_ORGANIZATION_ID') # Optional.
+end
+```
+
+Then you can create a client like this:
+
+```ruby
+client = StabilityAI::Client.new
+```
+
+#### Custom timeout and engine
+
+The default timeout for any Stability.ai request is 120 seconds. You can change that passing the `request_timeout` when initializing the client.
+
+```ruby
+client = StabilityAI::Client.new(
+    access_token: "access_token_goes_here",
+    request_timeout: 240,
+		engine_id: "/stable-diffusion-v1-5"
+)
+```
+
+or when configuring the gem:
+
+```ruby
+OpenAI.configure do |config|
+    config.access_token = ENV.fetch("STABILITYAI_ACCESS_TOKEN")
+    config.organization_id = ENV.fetch("STABILITYAI_ORGANIZATION_ID") # Optional
+		config.engine_id = "/stable-diffusion-v1-5"
+    config.request_timeout = 240 # Optional
+end
+```
+
+### Engines
+
+There are different engines that can be used to generate images. For a full list:
+
+```ruby
+client.engines
+```
+
+#### Examples
+
+- V1
+  - stable-diffusion-v1
+  - stable-diffusion-v1-5
+- V2
+  - stable-diffusion-512-v2-0
+  - stable-diffusion-768-v2-0
+
+### Account
+
+Get an overview of accounts connected to your user:
+
+```ruby
+response = client.account
+puts response
+# => "{"email":"email@email.com","id":"user-abcdefghijklmn","organizations":[{"id":"org-abcdefghijklmn","is_default":true,"name":"Personal","role":"OWNER"}],"profile_picture":"https://lh3.googleusercontent.com/a/abcdefghijklmn"}"
+```
+
+### Balance
+
+Get feedback, how much balance is left in your account:
+
+```ruby
+response = client.balance
+puts response
+# => {"credits":1001.73012}
+```
+
+### Text To Image
+
+Send a string and additional settings to create your image:
+
+```ruby
+response = client.text_to_image(
+			parameters: {
+					text_prompts:  [
+						{
+							text: "A red candle"
+						}
+					],
+					cfg_scale: 7,
+					clip_guidance_preset: "FAST_BLUE",
+					height: 512,
+					width: 512,
+					samples: 1,
+					steps: 30
+			}
+		)
+		data = response.dig("artifacts", 0, "base64")
+# => Outputs base64 string, which can be used in an image tag like this <img src="data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAgAAAAIACAIAAAB7GkOtAAACEmVYSWZNTQAq..."">
+```
+
+![Ruby](https://i.ibb.co/4mvDFG3/flamingo.png)
+
+### Parameters, which can be set
+
+- height
+- width
+- text_prompts (required)
+- cfg_scale
+  - Default: 7
+	- Between 0 and 35
+- clip_guidance_preset
+  - Default: None
+	- FAST_BLUE
+	- FAST_GREEN
+	- NONE
+	- SIMPLE
+	- SLOW
+	- SLOWER
+	- SLOWEST
+- sampler
+  - DDIM
+	- DDPM
+	- K_DPMPP_2M
+	- K_DPMPP_2S_ANCESTRAL
+	- K_DPM_2
+	- K_DPM_2_ANCESTRAL
+	- K_EULER
+	- K_EULER_ANCESTRAL
+	- K_HEUN
+	- K_LMS
+- samples (Number of images to generate)
+  - Default: 1
+	- Between 1 and 10
+- seed
+  - Default: 0
+	- Random noise seed (omit this option or use 0 for a random seed)
+- steps
+  - Default: 50
+	- Between: 10 and 150
+	- Number of diffusion steps to run
+- style_preset
+  - 3d-model
+	- analog-film
+	- anime
+	- cinematic
+	- comic-book
+	- digital-art
+	- enhance
+	- fantasy-art
+	- isometric
+	- line-art
+	- low-poly
+	- modeling-compound
+	- neon-punk
+	- origami
+	- photographic
+	- pixel-art
+	- tile-texture
+
+More information can be found here: [Stability AI Text to Image](https://platform.stability.ai/rest-api#tag/v1generation/operation/textToImage)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stabilityai"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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/ruby/stabilityai.rb

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

data/lib/stabilityai/client.rb

@@ -0,0 +1,83 @@
+module StabilityAI
+  class Client
+    def initialize(access_token: nil, organization_id: nil, folder: nil, engine_id: nil, uri_base: nil,
+                   request_timeout: nil)
+      StabilityAI.configuration.access_token = access_token if access_token
+			StabilityAI.configuration.organization_id = organization_id if organization_id
+      StabilityAI.configuration.engine_id = engine_id if engine_id
+      StabilityAI.configuration.folder = folder if folder
+      StabilityAI.configuration.uri_base = uri_base if uri_base
+      StabilityAI.configuration.request_timeout = request_timeout if request_timeout
+    end
+
+    def text_to_image(parameters: {})
+      StabilityAI::Client.json_post(path: "/text-to-image", parameters: parameters)
+    end
+
+    def engines
+      StabilityAI::Client.get(path: "/engines/list")
+    end
+
+    def account
+      StabilityAI::Client.get(path: "/user/account")
+    end
+
+    def balance
+      StabilityAI::Client.get(path: "/user/balance")
+    end
+
+    def self.get(path:)
+      HTTParty.get(
+        get_uri(path: path),
+        headers: headers,
+        timeout: request_timeout
+      )
+    end
+
+    def self.json_post(path:, parameters:)
+      HTTParty.post(
+        uri(path: path),
+        headers: headers,
+        body: parameters&.to_json,
+        timeout: request_timeout
+      )
+    end
+
+    def self.multipart_post(path:, parameters: nil)
+      HTTParty.post(
+        uri(path: path),
+        headers: headers.merge({ "Content-Type" => "multipart/form-data" }),
+        body: parameters,
+        timeout: request_timeout
+      )
+    end
+
+    def self.delete(path:)
+      HTTParty.delete(
+        uri(path: path),
+        headers: headers,
+        timeout: request_timeout
+      )
+    end
+
+    private_class_method def self.uri(path:)
+      StabilityAI.configuration.uri_base + StabilityAI.configuration.api_version + StabilityAI.configuration.folder + StabilityAI.configuration.engine_id + path
+    end
+
+    private_class_method def self.get_uri(path:)
+      StabilityAI.configuration.uri_base + StabilityAI.configuration.api_version + path
+    end
+
+    private_class_method def self.headers
+      {
+        "Content-Type" => "application/json",
+        "Authorization" => "Bearer #{StabilityAI.configuration.access_token}",
+				"Organization" => StabilityAI.configuration.organization_id
+      }
+    end
+
+    private_class_method def self.request_timeout
+      StabilityAI.configuration.request_timeout
+    end
+  end
+end

data/lib/stabilityai/compatibility.rb

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

data/lib/stabilityai/version.rb

@@ -0,0 +1,3 @@
+module StabilityAI
+  VERSION = "0.0.1".freeze
+end

data/lib/stabilityai.rb

@@ -0,0 +1,49 @@
+require "httparty"
+
+require_relative "stabilityai/client"
+require_relative "stabilityai/version"
+
+module StabilityAI
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class Configuration
+    attr_writer :access_token
+    attr_accessor :api_version, :organization_id, :folder, :uri_base, :engine_id, :request_timeout
+
+    DEFAULT_API_VERSION = "/v1".freeze
+    DEFAULT_ENGINE_ID = "/stable-diffusion-v1-5".freeze
+    DEFAULT_FOLDER = "/generation".freeze
+    DEFAULT_URI_BASE = "https://api.stability.ai".freeze
+    DEFAULT_REQUEST_TIMEOUT = 120
+
+    def initialize
+      @access_token = nil
+			@organization_id = nil
+      @api_version = DEFAULT_API_VERSION
+      @engine_id = DEFAULT_ENGINE_ID
+      @folder = DEFAULT_FOLDER
+      @uri_base = DEFAULT_URI_BASE
+      @request_timeout = DEFAULT_REQUEST_TIMEOUT
+    end
+
+    def access_token
+      return @access_token if @access_token
+
+      error_text = "StabilityAI access token missing! See https://github.com/kurbm/ruby-stabilityai#usage"
+      raise ConfigurationError, error_text
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= StabilityAI::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/ruby-stabilityai.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/stabilityai/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-stabilityai"
+  spec.version       = StabilityAI::VERSION
+  spec.authors       = ["Kevin"]
+  spec.email         = ["kurbm@users.noreply.github.com"]
+
+  spec.summary       = "StabilityAI API + Ruby! 🤖❤️"
+  spec.homepage      = "https://github.com/kurbm/ruby-stabilityai"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kurbm/ruby-stabilityai"
+  spec.metadata["changelog_uri"] = "https://github.com/kurbm/ruby-stabilityai/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", ">= 0.18.1"
+
+  spec.post_install_message = "Note if upgrading: The `::Ruby::StabilityAI` module has been removed and all classes have been moved under the top level `::StabilityAI` module. To upgrade, change `require 'ruby/stabilityai'` to `require 'stabilityai'` and change all references to `Ruby::StabilityAI` to `StabilityAI`."
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ruby-stabilityai
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description:
+email:
+- kurbm@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby/stabilityai.rb
+- lib/stabilityai.rb
+- lib/stabilityai/client.rb
+- lib/stabilityai/compatibility.rb
+- lib/stabilityai/version.rb
+- ruby-stabilityai.gemspec
+homepage: https://github.com/kurbm/ruby-stabilityai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kurbm/ruby-stabilityai
+  source_code_uri: https://github.com/kurbm/ruby-stabilityai
+  changelog_uri: https://github.com/kurbm/ruby-stabilityai/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 'Note if upgrading: The `::Ruby::StabilityAI` module has been
+  removed and all classes have been moved under the top level `::StabilityAI` module.
+  To upgrade, change `require ''ruby/stabilityai''` to `require ''stabilityai''` and
+  change all references to `Ruby::StabilityAI` to `StabilityAI`.'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: "StabilityAI API + Ruby! \U0001F916❤️"
+test_files: []