replicate-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c894d68b6c7c1dcc1bfdb5fbe0067a1485c3e918029f3d1fd5139ae8acbcc8b
+  data.tar.gz: 00de848d1fc16197959283ae65c136e1723eca8c15a2a0556bb08d84e9a06a2f
+SHA512:
+  metadata.gz: b3c7f2edbba1a0e3c572e7f1f9e614336e8dd015f7683f094fda645f942c75b8abf9dac43719625761ad5b5ebbb00e65ef5f71741c1b1c0d12f2e7d3c72df75e
+  data.tar.gz: ddced9835e3e37acd8c132be0036519b63b4a5adca1332ee33aef2dd75a3830112df937492aa90e5337007db24252bacdae1cc404e063e11ac3e0608c8498566

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-12
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in replicate-ruby.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    replicate-ruby (0.1.0)
+      addressable
+      faraday (>= 2.0)
+      faraday-retry
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.1)
+    faraday-retry (2.0.0)
+      faraday (~> 2.0)
+    hashdiff (1.0.1)
+    json (2.6.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  replicate-ruby!
+  rubocop (~> 1.21)
+  webmock
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,63 @@
+# Replicate Ruby client
+
+This is a Ruby client for Replicate. It lets you run models from your Ruby code and do various other things on Replicate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'replicate-ruby'
+```
+
+## Usage
+
+Grab your token from replicate.com/account and authenticate by configuring `api_token`:
+
+```ruby
+Replicate.configure do |config|
+  config.api_token = "your_api_token"
+end
+```
+
+You can retrieve a model:
+
+```ruby
+# Latest version
+model = Replicate.client.retrieve_model("stability-ai/stable-diffusion")
+version = model.latest_version
+
+# List of versions
+version = Replicate.client.retrieve_model("stability-ai/stable-diffusion", version: all)
+
+# Specific version
+version = Replicate.client.retrieve_model("stability-ai/stable-diffusion", version: "<id>")
+```
+
+And then run predictions on it:
+
+```ruby
+prediction = version.predict(prompt: "a handsome teddy bear")
+
+# Optionally you can submit a webhook url for replicate to send a POST request once a prediction has completed
+prediction = version.predict(prompt: "a handsome teddy bear", "https://webhook.url/path")
+
+# Or manually refetch predictions
+prediction = prediction.refetch
+
+# or cancel a running prediction
+prediction = prediction.cancel
+
+# and if a prediction returns with status succeeded, you can retrieve the output
+output = prediction.output
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/YOUR_GITHUB_USERNAME/replicate-ruby. 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/YOUR_GITHUB_USERNAME/replicate-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/replicate/client/model.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Replicate
+  class Client
+    # Methods for the Prediction API
+    module Model
+      # Get a model
+      # @see https://replicate.com/docs/reference/http#get-model
+      def retrieve_model(model, version: :latest)
+        case version
+        when :latest
+          Replicate::Record::Model.new(self, get("models/#{model}"))
+        when :all
+          response = get("models/#{model}/versions")
+          response["results"].map! { |result| Replicate::Record::ModelVersion.new(self, result) }
+          response
+        else
+          Replicate::Record::ModelVersion.new(self, get("models/#{model}/versions/#{version}"))
+        end
+      end
+
+      # Get a collection of models
+      # @see https://replicate.com/docs/reference/http#get-collection
+      def retrieve_collection(slug)
+        get("collections/#{slug}")
+      end
+    end
+  end
+end

data/lib/replicate/client/prediction.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Replicate
+  class Client
+    # Methods for the Prediction API
+    module Prediction
+      # Get a prediction
+      # @see https://replicate.com/docs/reference/http#get-prediction
+      def retrieve_prediction(id)
+        Replicate::Record::Prediction.new(self, get("predictions/#{id}"))
+      end
+
+      # Get a list of predictions
+      # @see https://replicate.com/docs/reference/http#get-predictions
+      def list_predictions(cursor = nil)
+        response = get("predictions", cursor: cursor)
+        response["results"].map! { |result| Replicate::Record::Prediction.new(self, result) }
+        response
+      end
+
+      # Create a prediction
+      # @see https://replicate.com/docs/reference/http#create-prediction
+      def create_prediction(params)
+        Replicate::Record::Prediction.new(self, post("predictions", params))
+      end
+
+      # Cancel a prediction
+      # @see https://replicate.com/docs/reference/http#cancel-prediction
+      def cancel_prediction(id)
+        Replicate::Record::Prediction.new(self, post("predictions/#{id}/cancel"))
+      end
+    end
+  end
+end

data/lib/replicate/client.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "replicate/configurable"
+require "replicate/connection"
+
+require "replicate/client/model"
+require "replicate/client/prediction"
+
+module Replicate
+  class Client
+    include Replicate::Configurable
+    include Replicate::Connection
+
+    include Replicate::Client::Model
+    include Replicate::Client::Prediction
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Replicate::Configurable.keys.each do |key|
+        value = options.key?(key) ? options[key] : Replicate.instance_variable_get(:"@#{key}")
+        instance_variable_set(:"@#{key}", value)
+      end
+    end
+  end
+end

data/lib/replicate/configurable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Configurable
+    attr_accessor :api_token
+    attr_writer :api_endpoint
+
+    class << self
+      # List of configurable keys for {Datatrans::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= %i[api_token api_endpoint]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # API endpoint methods
+    def api_endpoint
+      @api_endpoint ||= "https://api.replicate.com/v1"
+    end
+
+    private
+
+    def options
+      Hash[Replicate::Configurable.keys.map { |key| [key, send(key)] }]
+    end
+  end
+end

data/lib/replicate/connection.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday/net_http"
+require "faraday/retry"
+require "addressable/uri"
+
+module Replicate
+  # Network layer for API clients.
+  module Connection
+    DEFAULT_MEDIA_TYPE = "application/json"
+    USER_AGENT = "Datatrans Ruby Gem"
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new(%i[accept content_type])
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, options
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options.to_json
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options.to_json
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options.to_json
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, options
+    end
+
+    # Hypermedia agent for the datatrans API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Faraday.new(url: endpoint) do |conn|
+        conn.request :retry
+        conn.request :authorization, 'Token', api_token
+        conn.headers["Content-Type"] = DEFAULT_MEDIA_TYPE
+        conn.headers["Accept"] = DEFAULT_MEDIA_TYPE
+
+        conn.adapter :net_http
+      end
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    protected
+
+    def endpoint
+      api_endpoint
+    end
+
+    private
+
+    def request(method, path, data)
+      @last_response = agent.send(method, Addressable::URI.parse(path.to_s).normalize.to_s, data)
+      case @last_response.status
+      when 400
+        raise Error, "#{@last_response.status} #{@last_response.reason_phrase}: #{JSON.parse(@last_response.body)}"
+      else
+        JSON.parse(@last_response.body)
+      end
+    end
+  end
+end

data/lib/replicate/record/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class Base
+      def initialize(client, params)
+        @client = client
+        self.assign_attributes = params
+      end
+
+      def assign_attributes=(params)
+        params = params.instance_variables_hash if params.is_a?(self.class)
+        params.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        if instance_variables.include? :"@#{method_name}"
+          instance_variable_get "@#{method_name}"
+        else
+          super
+        end
+      end
+
+      def instance_variables_hash
+        Hash[instance_variables.map { |name| [name.to_s[1..-1], instance_variable_get(name)] } ]
+      end
+
+      def inspect
+        string = "#<#{self.class.name}:#{object_id} "
+        fields = instance_variables_hash.except("client").map { |attr, value| "#{attr}: #{value.inspect}" }
+        string << fields.join(", ") << ">"
+      end
+    end
+  end
+end

data/lib/replicate/record/model.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class Model < Base
+      def initialize(client, params)
+        params["latest_version"] = Replicate::Record::ModelVersion.new(client, params["latest_version"])
+        super
+      end
+    end
+  end
+end

data/lib/replicate/record/model_version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class ModelVersion < Base
+      def predict(input, webhook_completed = nil)
+        params = {}
+        params[:version] = id
+        params[:input] = input
+        params[:webhook_completed] = webhook_completed
+        client.create_prediction(params)
+      end
+    end
+  end
+end

data/lib/replicate/record/prediction.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Replicate
+  module Record
+    class Prediction < Base
+      def refetch
+        self.assign_attributes = client.retrieve_prediction(id)
+      end
+
+      def cancel
+        self.assign_attributes = client.cancel_prediction(id)
+      end
+    end
+  end
+end

data/lib/replicate/version.rb

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

data/lib/replicate.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "replicate/version"
+require "replicate/client"
+
+require "replicate/record/base"
+require "replicate/record/model"
+require "replicate/record/model_version"
+require "replicate/record/prediction"
+
+module Replicate
+  class Error < StandardError; end
+
+  class << self
+    include Replicate::Configurable
+
+    def client
+      return @client if defined?(@client)
+      @client = Replicate::Client.new(options)
+    end
+  end
+end

data/sig/replicate/ruby.rbs

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: replicate-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Puglisi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  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: addressable
+  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: pry
+  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:
+email:
+- daniel@codegestalt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/replicate.rb
+- lib/replicate/client.rb
+- lib/replicate/client/model.rb
+- lib/replicate/client/prediction.rb
+- lib/replicate/configurable.rb
+- lib/replicate/connection.rb
+- lib/replicate/record/base.rb
+- lib/replicate/record/model.rb
+- lib/replicate/record/model_version.rb
+- lib/replicate/record/prediction.rb
+- lib/replicate/version.rb
+- sig/replicate/ruby.rbs
+homepage: https://github.com/danielpuglisi/replicate-ruby
+licenses: []
+metadata:
+  homepage_uri: https://github.com/danielpuglisi/replicate-ruby
+  source_code_uri: https://github.com/danielpuglisi/replicate-ruby
+  changelog_uri: https://github.com/danielpuglisi/replicate-ruby/blob/master/CHANGELOG.md
+post_install_message:
+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: Ruby client for Replicate
+test_files: []