quick_openai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c100b819268f04a4bf818f9b011a35d0fce11652398bdab7d837594eefa09ecb
+  data.tar.gz: 2b8d7e92373f869306c6c02e4194635b7676422a8362239df619f47ea9c8a7d5
+SHA512:
+  metadata.gz: 63970fcd91f0802d14ce0fcdd62ae515f6d73d2076f0450c67131ea19b689466b06901d0b7e0473f9579aedc8da0fa8f0a03e0fdab01718e030ecd1701220ab4
+  data.tar.gz: e268e1471966d8adad75b3ea609df8faa562f5aadb5948ffa80ebec1c89ce6420b2c63c6e2911449e2dc0bc85560172c4e4a1df151c5690d56341de9a270011b

data/.env.test

@@ -0,0 +1 @@
+OPENAI_ACCESS_TOKEN=fakeopenaiaccesstoken

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+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-12-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in quick_openai.gemspec
+gemspec
+
+gem "dotenv"
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "vcr", "~> 6"

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    quick_openai (0.1.0)
+      down (~> 5)
+      ruby-openai (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    dotenv (2.8.1)
+    down (5.3.1)
+      addressable (~> 2.8)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    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.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.40.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.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-openai (2.1.0)
+      dotenv (>= 2.7.6, < 2.9.0)
+      httparty (>= 0.18.1, < 0.21.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.3.0)
+    vcr (6.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  quick_openai!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  vcr (~> 6)
+
+BUNDLED WITH
+   2.3.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 John DeSilva
+
+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,68 @@
+# QuickOpenAI
+
+This gem is a wrapper of [ruby-openai](https://github.com/alexrudall/ruby-openai), providing quick convenience methods for experimenting with OpenAI language and image models.
+
+## Usage
+
+Quickly get results from GPT3:
+
+```ruby
+puts "Hello, what is your name?".gpt3
+# => My name is Aileen.
+```
+
+Quickly get images from DALLE2:
+
+```ruby
+"a drawing of a cat in a hat".dalle2.then { |tempfile|
+  File.write('./cat.png', tempfile.read)
+}
+```
+<img src="https://raw.githubusercontent.com/Aesthetikx/quick_openai/master/.github/cat.png" height=256 width=256></img>
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add quick_openai
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install quick_openai
+
+## Setup
+
+Make sure you have your OpenAI access token in ENV, and then require QuickOpenAI to include String extensions.
+```ruby
+ENV['OPENAI_ACCESS_TOKEN'] = '12345'
+
+require 'quick_openai'
+```
+
+## Options
+
+You can pass options supported by `ruby-openai` to the convenience methods:
+
+```ruby
+"a drawing of a cat in a hat".dalle2(n: 2) # => An array of two tempfiles
+
+"count to ten in italian".gpt3(model: 'text-ada-001') # Use a different model
+
+"write me an essay on napoleon".gpt3(max_tokens: 2048) # Produce more or less output. The default is 2048.
+```
+
+Read more about GPT3 models [here](https://beta.openai.com/docs/models/gpt-3).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/aesthetikx/quick_openai.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/quick_openai/dalle2.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module QuickOpenAI
+  module Dalle2
+    def self.dalle2(prompt, **options)
+      parameters = {
+        prompt: prompt,
+        **options
+      }
+
+      response = QuickOpenAI.fetch_response_from_client do |client|
+        client.images.generate(parameters: parameters)
+      end
+
+      results = response.fetch("data")
+
+      tempfiles = results.map do |result|
+        url = result["url"]
+
+        Down.download(url)
+      end
+
+      if tempfiles.size == 1
+        tempfiles.first
+      else
+        tempfiles
+      end
+    end
+  end
+end

data/lib/quick_openai/extensions/string.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module QuickOpenAI
+  module Extensions
+    module String
+      def gpt3(**options)
+        QuickOpenAI::Gpt3.gpt3(self, **options)
+      end
+
+      def dalle2(**options)
+        QuickOpenAI::Dalle2.dalle2(self, **options)
+      end
+    end
+  end
+end

data/lib/quick_openai/gpt3.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module QuickOpenAI
+  module Gpt3
+    def self.gpt3(prompt, **options)
+      parameters = {
+        model: "text-davinci-003",
+        max_tokens: 2048,
+        prompt: prompt,
+        **options
+      }
+
+      response = QuickOpenAI.fetch_response_from_client do |client|
+        client.completions(parameters: parameters)
+      end
+
+      text = response.dig("choices", 0, "text")
+
+      raise QuickOpenAI::Error, "Unable to parse response." if text.nil? || text.empty?
+
+      text.chomp.strip
+    end
+  end
+end

data/lib/quick_openai/version.rb

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

data/lib/quick_openai.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "quick_openai/version"
+require_relative "quick_openai/dalle2"
+require_relative "quick_openai/gpt3"
+require_relative "quick_openai/extensions/string"
+
+module QuickOpenAI
+  class Error < StandardError; end
+
+  def self.client
+    OpenAI::Client.new
+  end
+
+  def self.fetch_response_from_client
+    begin
+      response = yield client
+    rescue StandardError
+      raise QuickOpenAI::Error, "Unable to fetch response."
+    end
+
+    if (error = response.dig("error", "message"))
+      raise QuickOpenAI::Error, "Unable to fetch response: #{error}"
+    end
+
+    response
+  end
+end
+
+require "down"
+require "ruby/openai"
+require "tempfile"
+
+class String
+  include QuickOpenAI::Extensions::String
+end

data/sig/quick_openai.rbs

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: quick_openai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John DeSilva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: down
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Provides monkey patches for quick usage of GPT3 and DALLE2
+email:
+- desilvjo@umich.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.test"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/quick_openai.rb
+- lib/quick_openai/dalle2.rb
+- lib/quick_openai/extensions/string.rb
+- lib/quick_openai/gpt3.rb
+- lib/quick_openai/version.rb
+- sig/quick_openai.rbs
+homepage: https://github.com/Aesthetikx/quick_openai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Aesthetikx/quick_openai
+  source_code_uri: https://github.com/Aesthetikx/quick_openai
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.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: Convenience extensions for using OpenAI with Ruby
+test_files: []