ruby-openai 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100378df0cba6c07efb76083f5f74fac7a2c3cd0c3d94ce7eb82e81919182262
-  data.tar.gz: 14cbb7954884e1b0860b2408b92b6c366f0fffe7d665b07bc6bb9276778f1fe4
+  metadata.gz: 313bb227de3cea2ce36b0f521e708490644c517abf08e2e68ac6f55ec975174a
+  data.tar.gz: cfdf91ec66558f09f01a5b9b1c9d900504425b396b6471a5fa2acdef00cd58cb
 SHA512:
-  metadata.gz: fc4e80b899ccb6de28790cc8193a0ce99c95e0aa66f71b6aadcb0b39c6bd1f2081fdc64a49e01e481ae94ccc2bfdecd8029885a1dea286bfb91dd20870f9d6c5
-  data.tar.gz: 383de94193c910154b142f350d80b5ca8e45dfb434bbb79c6c5b14b6faf49fd3fed39681591a0f4d591fde6f6cf532dc8c1510f9b73d0d04e1bab7d380c7dd7c
+  metadata.gz: 449a6b7a79e15d4717edc3634275cecb886f883da8efc0c1b99759954b417c95cbfcfdd62da7adae2077313aecb4028981676afa6d291c8f904bb598fa4221c8
+  data.tar.gz: 6228927ccb6403db42c89d19fb357c61ab2016f07acceffe2c5b376dfb6dfaa7e14fc9d74326e00d8879f5233728b63bdaef57606c899f934b016ceba5accd64

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

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

data/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)
 

data/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

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-openai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alex
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-07 00:00:00.000000000 Z
+date: 2020-09-09 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"