Merge pull request #5 from alexrudall/improve_documentation

Improve documentation

Author: alexrudall

.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.

.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.

CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-openai (0.1.1)
+    ruby-openai (0.1.2)
       dotenv (~> 2.7.6)
       httparty (~> 0.18.1)
 

README.md

@@ -26,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
 ```
 
-Create a client:
+And create a client:
 
 ```
     client = OpenAI::Client.new
 ```
 
-Use it to hit the OpenAI API for a completion:
+### Without dotenv
+
+Alternativeely 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

lib/ruby/openai/version.rb

@@ -1,5 +1,5 @@
 module Ruby
   module OpenAI
-    VERSION = "0.1.1".freeze
+    VERSION = "0.1.2".freeze
   end
 end

spec/fixtures/cassettes/ada_Once_upon_a_time_5.yml

@@ -3,16 +3,55 @@
     expect { OpenAI::Client.new }.not_to raise_error
   end
 
-  context "with an engine, prompt and max_tokens", :vcr do
-    let(:engine) { "davinci" }
+  context "with a prompt and max_tokens", :vcr do
     let(:prompt) { "Once upon a time" }
     let(:max_tokens) { 5 }
 
-    it "can make a request to the OpenAI API" do
-      VCR.use_cassette("#{engine} #{prompt} #{max_tokens}") do
-        response = OpenAI::Client.new.call(engine: engine, prompt: prompt, max_tokens: max_tokens)
-        text = JSON.parse(response.body)["choices"].first["text"]
-        expect(text.split(" ").empty?).to eq(false)
+    context "with engine: ada" do
+      let(:engine) { "ada" }
+
+      it "can make a request to the OpenAI API" do
+        VCR.use_cassette("#{engine} #{prompt} #{max_tokens}") do
+          response = OpenAI::Client.new.call(engine: engine, prompt: prompt, max_tokens: max_tokens)
+          text = JSON.parse(response.body)["choices"].first["text"]
+          expect(text.split(" ").empty?).to eq(false)
+        end
+      end
+    end
+
+    context "with engine: babbage" do
+      let(:engine) { "babbage" }
+
+      it "can make a request to the OpenAI API" do
+        VCR.use_cassette("#{engine} #{prompt} #{max_tokens}") do
+          response = OpenAI::Client.new.call(engine: engine, prompt: prompt, max_tokens: max_tokens)
+          text = JSON.parse(response.body)["choices"].first["text"]
+          expect(text.split(" ").empty?).to eq(false)
+        end
+      end
+    end
+
+    context "with engine: curie" do
+      let(:engine) { "curie" }
+
+      it "can make a request to the OpenAI API" do
+        VCR.use_cassette("#{engine} #{prompt} #{max_tokens}") do
+          response = OpenAI::Client.new.call(engine: engine, prompt: prompt, max_tokens: max_tokens)
+          text = JSON.parse(response.body)["choices"].first["text"]
+          expect(text.split(" ").empty?).to eq(false)
+        end
+      end
+    end
+
+    context "with engine: davinci" do
+      let(:engine) { "davinci" }
+
+      it "can make a request to the OpenAI API" do
+        VCR.use_cassette("#{engine} #{prompt} #{max_tokens}") do
+          response = OpenAI::Client.new.call(engine: engine, prompt: prompt, max_tokens: max_tokens)
+          text = JSON.parse(response.body)["choices"].first["text"]
+          expect(text.split(" ").empty?).to eq(false)
+        end
       end
     end
   end