ruby-openai 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d4334878bbc6975011c4a27e0b7e9670d4b0abe37ac02dcd9059e2c98d3ecb
-  data.tar.gz: db0896a130eb8931d4847127f1b165e234706c9d402728da89c326b3702ac919
+  metadata.gz: bdfaef88879152f3de0bd34e96e5cce4c669693347715a4cc776cd2da4e27864
+  data.tar.gz: 171f6b21eb32a63142a11c7964d3f1871343634bbe845c30a56a9ff72ea912dc
 SHA512:
-  metadata.gz: f2d419f61441f4afb4d2aaaeb9d11b14d7ac0db905bc6f886d9069c3b9575a59657586b9a0094cf2f99c9bf1390d46a663cf4b19ea85aca89a91e78ccc59053b
-  data.tar.gz: 6b539d35aab4aee91b8ecdd2055f26c2854435589bfd6b8665689b58983eb7bfadd0e62ff425cc1d73b4d5ef15451dcf3d41e29f00bb289a4c42937c30b04855
+  metadata.gz: 2471a90fddcad074339e338f24df56980ab47c76b70aa3f4f4d5676b6e8d841525a5d911ee69d586165697ecd177d3b9f9d11bec93a7c73f7ecc1a6df5fb4036
+  data.tar.gz: 41c2a29991c0b60cc574fe65fdf3043fe610a96e36075ee963882bee2b52e741d1cb57ad8a95e4a02c72eabcbb3999318ddad7f822c9b27d92802d33ae66cc47

data/.circleci/config.yml

@@ -1,25 +1,24 @@
 version: 2.1 # Use 2.1 to enable using orbs and other features.
 
 # Declare the orbs that we'll use in our config.
-# read more about orbs: https://circleci.com/docs/2.0/using-orbs/
 orbs:
   ruby: circleci/ruby@1.0
 
 jobs:
-  build: # our first job, named "build"
+  rubocop:
+    parallelism: 1
     docker:
-      - image: cimg/ruby:2.7-node # use a tailored CircleCI docker image.
+      - image: cimg/ruby:2.7-node
     steps:
-      - checkout # pull down our git code.
-      - ruby/install-deps # use the ruby orb to install dependencies
-
-  test:  # our next job, called "test"
-    # we can run "parallel job containers" to enable speeding up our tests;
-    # this splits our tests across multiple containers.
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
     parallelism: 1
     docker:
-      - image: cimg/ruby:2.7-node # this is our primary docker image, where step commands run.
-    # A series of steps to run, some are similar to those in "build".
+      - image: cimg/ruby:2.7-node
     steps:
       - checkout
       - ruby/install-deps
@@ -27,12 +26,9 @@ jobs:
           name: Run tests
           command: bundle exec rspec -fd
 
-# We use workflows to orchestrate the jobs that we declared above.
 workflows:
   version: 2
-  build_and_test:    # The name of our workflow is "build_and_test"
-    jobs:             # The list of jobs we run as part of this workflow.
-      - build         # Run build first.
-      - test:         # Then run test,
-          requires:   # Test requires that build passes for it to run.
-            - build   # Finally, run the build job.
+  checks:
+    jobs:
+      - rubocop
+      - test

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/CHANGELOG.md

@@ -5,7 +5,47 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.2.0] - 2020-11-22
+
+### Added
+
+- Add method to use the search endpoint.
+
+## [0.1.4] - 2020-10-18
+
+### Changed
+
+- Bump Rubocop to 3.9.2.
+- Bump Webmock to 3.9.1.
+
+## [0.1.3] - 2020-09-09
+
+### Changed
+
+- Add ability to change API version in the future.
+- Fix README typos.
+
+## [0.1.2] - 2020-09-09
+
+### Added
+
+- Add tests and cached responses for the different engines.
+- Add issue templates.
+
+### Changed
+
+- Add README instructions for using the gem without dotenv.
+- Add list of engines to README.
+
+## [0.1.1] - 2020-09-08
+
+### Added
+
+- Run Rubocop on pulls using CircleCI.
+
+### Changed
+
+- Clean up CircleCI config file.
 
 ## [0.1.0] - 2020-09-06
 

data/Gemfile

@@ -6,6 +6,6 @@ gemspec
 gem "byebug", "~> 11.1.3"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rubocop", "~> 0.90.0"
+gem "rubocop", "~> 0.93.1"
 gem "vcr", "~> 6.0.0"
-gem "webmock", "~> 3.8.3"
+gem "webmock", "~> 3.9.2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (0.1.0)
+    ruby-openai (0.2.0)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 
@@ -12,8 +12,7 @@ GEM
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.1)
     byebug (11.1.3)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.4)
     diff-lcs (1.4.4)
     dotenv (2.7.6)
     hashdiff (1.0.1)
@@ -25,12 +24,12 @@ GEM
     mime-types-data (3.2020.0512)
     multi_xml (0.6.0)
     parallel (1.19.2)
-    parser (2.7.1.4)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.1)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -45,22 +44,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.90.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
     unicode-display_width (1.7.0)
     vcr (6.0.0)
-    webmock (3.8.3)
+    webmock (3.9.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -72,10 +70,10 @@ DEPENDENCIES
   byebug (~> 11.1.3)
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.90.0)
+  rubocop (~> 0.93.1)
   ruby-openai!
   vcr (~> 6.0.0)
-  webmock (~> 3.8.3)
+  webmock (~> 3.9.2)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,7 +1,8 @@
 # Ruby::OpenAI
 
-[![CircleCI Build Status](https://circleci.com/gh/alexrudall/ruby-openai.svg?style=shield)](https://circleci.com/gh/alexrudall/ruby-openai)
+[![Gem Version](https://badge.fury.io/rb/ruby-openai.svg)](https://badge.fury.io/rb/ruby-openai)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/alexrudall/ruby-openai/blob/master/LICENSE.txt)
+[![CircleCI Build Status](https://circleci.com/gh/alexrudall/ruby-openai.svg?style=shield)](https://circleci.com/gh/alexrudall/ruby-openai)
 
 A simple Ruby wrapper for the [OpenAI GPT-3 API](https://openai.com/blog/openai-api/).
 
@@ -25,23 +26,36 @@ Or install it yourself as:
 
 Get your API key from [https://beta.openai.com/docs/developer-quickstart/your-api-keys](https://beta.openai.com/docs/developer-quickstart/your-api-keys)
 
-Add your secret key to your .env file:
+### With dotenv
+
+If you're using [dotenv](https://github.com/motdotla/dotenv), you can add your secret key to your .env file:
 
 ```
-    OPENAI_ACCESS_TOKEN=secretkeygoeshere
+    OPENAI_ACCESS_TOKEN=access_token_goes_here
 ```
 
-Create a client:
+And create a client:
 
 ```
     client = OpenAI::Client.new
 ```
 
-Use it to hit the OpenAI API for a completion:
+### Without dotenv
+
+Alternatively you can pass your key directly to a new client:
+
+```
+    client = OpenAI::Client.new(access_token: "access_token_goes_here")
+```
+
+### Get a response
+
+The engine options are currently "ada", "babbage", "curie" and "davinci". Hit the OpenAI API for a completion:
 
 ```
     response = client.call(engine: "davinci", prompt: "Once upon a time", max_tokens: 5)
-    response.parsed_response['choices'].map{ |c| c["text"] }
+    puts response.parsed_response['choices'].map{ |c| c["text"] }
+    => [", there lived a great"]
 ```
 
 ## Development

data/lib/ruby/openai/client.rb

@@ -1,15 +1,15 @@
 module OpenAI
   class Client
     include HTTParty
-    base_uri "https://api.openai.com/v1/engines"
+    base_uri "https://api.openai.com"
 
     def initialize(access_token: nil)
       @access_token = access_token || ENV["OPENAI_ACCESS_TOKEN"]
     end
 
-    def call(engine:, prompt:, max_tokens:)
+    def call(engine:, prompt:, max_tokens:, version: default_version)
       self.class.post(
-        "/#{engine}/completions",
+        "/#{version}/engines/#{engine}/completions",
         headers: {
           "Content-Type" => "application/json",
           "Authorization" => "Bearer #{@access_token}"
@@ -19,5 +19,24 @@ module OpenAI
         }.to_json
       )
     end
+
+    def search(engine:, documents:, query:, version: default_version)
+      self.class.post(
+        "/#{version}/engines/#{engine}/search",
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer #{@access_token}"
+        },
+        body: {
+          documents: documents, query: query
+        }.to_json
+      )
+    end
+
+    private
+
+    def default_version
+      "v1".freeze
+    end
   end
 end

data/lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "0.1.0".freeze
+    VERSION = "0.2.0".freeze
   end
 end

data/ruby-openai.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Ruby gem for the OpenAI GPT-3 API"
   spec.homepage      = "https://github.com/alexrudall/ruby-openai"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/alexrudall/ruby-openai"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-06 00:00:00.000000000 Z
+date: 2020-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -78,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for the OpenAI GPT-3 API