shiro 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0065f9bf6fdf82f8dcbfff39ba0422c59a97691ebf4ebb42596b63063bf0aa7
-  data.tar.gz: b90f16777c189cdc817e82b60cc5fbbea31d3136f9896d48ba130afe3ee30a1c
+  metadata.gz: 21a6f05dddc41d4f36a795d0903dae119f30462e146aa2af7c94493b33150140
+  data.tar.gz: 59bc2c1218890363a96d140cc377b08d5498e37b29b8132bebed4b331ce89074
 SHA512:
-  metadata.gz: 65e5809bce6de212f468fd3f167c021cbaf6546d2f99a972b1afcf544f80dcae914991ab651b18043572ecffa4275c85e97592b7aa645cc46a59121f8714b5a2
-  data.tar.gz: 4e3c4bf6c500da21ac3f1448aa3854552b1d7d3077c84ec5d5f872512abb75c6373a9dc1192494648ca05763f0743526af1fc665a767dc94e8c88dd22dcc3d89
+  metadata.gz: 2afd817c73c752788847b60608f2a14d9c5640cd6f3fa480bec2543e8e4ee703ca2e80d4f956b81afedef8078c933147e5ea4b7df938810980052de97d97928a
+  data.tar.gz: df0eeabce7ad42f8733591b405d6c53f43853e7eee301613aa3a3292ac21180f0ef41bf7185624b1f6039961b18845e2d3af4e32c058f766b34d9dc9310134ae

data/README.md

@@ -1,27 +1,111 @@
-This is the official [Shiro API](https://openshiro.com/api/v1/docs) Ruby gem maintained by [OpenShiro](https://openshiro.com).
+# Shiro Ruby Library
 
-To use the gem, include it in your Rails gemfile with:
+This is the official [Shiro API](https://openshiro.com/api/v1/docs) Ruby library gem maintained by [OpenShiro](https://openshiro.com). The Shiro Ruby library provides convenient access to the Stripe API from applications written in the Ruby language.
 
-`bundle add shiro`
+## Documentation
+
+See the [API docs](https://openshiro.com/api/v1/docs) and also this post on [Getting Started with the Shiro API](https://openshiro.com/docs/getting-started-with-the-shiro-api).
+
+## Installation
+
+To install the gem:
+
+```
+gem install shiro
+```
+
+Include it in your Rails gemfile with:
+
+```
+bundle add shiro
+```
 
 or directly in the gemfile:
 
-`gem "shiro", "~> 0.1"`
+```
+gem "shiro", "~> 0.1.1"
+```
 
-Example usage:
+## Usage
 
-````
+The library needs to be configured with your account's api key which is available in your Shiro account under API Keys.
+
+```ruby
 require "shiro"
 
 Shiro.configure do |config|
   config[:api_key] = "your_api_key..."
 end
+```
+
+### Deployment Actions
 
-# List deployments
+**List deployments**
+
+```ruby
 deployments = Shiro::Deployment.list
-puts deployments.body
+```
+
+**Retrieve a single deployment**
 
-# Retrieve single deployment
+```ruby
 deployment = Shiro::Deployment.retrieve("dpmt_lWokJnPAwQCeV2ZWovjG7BNr")
-puts deployment.body
-````
+```
+
+**Update a deployment**
+
+```ruby
+updated_deployment = Shiro::Deployment.update("dpmt_lWokJnPAwQCeV2ZWovjG7BNr", { name: "New Deployment Name" })
+```
+
+### Generating Completions
+
+**Generate a completion for a deployment**
+
+```ruby
+content = Shiro::GenerateCompletion.create("dpmt_lWokJnPAwQCeV2ZWovjG7BNr",
+  environment: "PRODUCTION",
+  prompt_id: "prmt_WnAlbE5lEMtxAG2Qly6jo2dV", # optional
+  input_variables: { "key": "value" }
+)
+```
+
+### User Account Actions
+
+**Retrieve current user's details**
+
+```ruby
+current_user = Shiro::Me.retrieve
+```
+
+**Delete current user's account**
+
+```ruby
+response = Shiro::Me.destroy
+```
+
+### Prompt Actions
+
+**List prompts**
+
+```ruby
+prompts = Shiro::Prompt.list
+```
+
+**Retrieve a single prompt**
+
+```ruby
+prompt = Shiro::Prompt.retrieve("prmt_WnAlbE5lEMtxAG2Qly6jo2dV")
+```
+
+## Support
+
+New features and bug fixes are released on the latest major version of the Shiro Python library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.
+
+## Development
+
+Run the tests:
+
+```
+rake test
+```

data/lib/shiro/client.rb

@@ -18,6 +18,14 @@ module Shiro
       self.class.post(path, body: body.to_json, headers: auth_header.merge("Content-Type" => "application/json"))
     end
 
+    def patch(path, body = {})
+      self.class.patch(path, body: body.to_json, headers: auth_header.merge("Content-Type" => "application/json"))
+    end
+
+    def delete(path)
+      self.class.delete(path, headers: auth_header)
+    end
+
     private
 
     def auth_header

data/lib/shiro/deployment.rb

@@ -8,10 +8,16 @@ module Shiro
       client.get("/deployments/#{id}").parsed_response
     end
 
-    private_class_method
+    def self.update(id, attributes)
+      client.patch("/deployments/#{id}", attributes).parsed_response
+    end
+
+    private
 
     def self.client
       @client ||= Client.new
     end
+
+    private_class_method :client
   end
 end

data/lib/shiro/generate_completion.rb

@@ -0,0 +1,23 @@
+module Shiro
+  class GenerateCompletion
+    def self.create(deployment_id, options = {})
+      body = {
+        deployment_id: deployment_id,
+        environment: options[:environment],
+        prompt_id: options[:prompt_id],
+        input_variables: options[:input_variables]
+      }.compact
+
+      response = client.post("/generate_completion", body)
+      response.parsed_response
+    end
+
+    private
+
+    def self.client
+      @client ||= Client.new
+    end
+
+    private_class_method :client
+  end
+end

data/lib/shiro/me.rb

@@ -0,0 +1,21 @@
+module Shiro
+  class Me
+    def self.retrieve
+      response = client.get("/me")
+      response.parsed_response
+    end
+
+    def self.delete
+      response = client.delete("/me")
+      response.parsed_response
+    end
+
+    private
+
+    def self.client
+      @client ||= Client.new
+    end
+
+    private_class_method :client
+  end
+end

data/lib/shiro/prompt.rb

@@ -0,0 +1,19 @@
+module Shiro
+  class Prompt
+    def self.list
+      client.get("/prompts").parsed_response
+    end
+
+    def self.retrieve(id)
+      client.get("/prompts/#{id}").parsed_response
+    end
+
+    private
+
+    def self.client
+      @client ||= Client.new
+    end
+
+    private_class_method :client
+  end
+end

data/lib/shiro/version.rb

@@ -1,3 +1,3 @@
 module Shiro
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/shiro.rb

@@ -1,9 +1,12 @@
 require "net/http"
 require "json"
 require "uri"
+require "shiro/version"
 require "shiro/client"
 require "shiro/deployment"
-require "shiro/version"
+require "shiro/prompt"
+require "shiro/generate_completion"
+require "shiro/me"
 
 module Shiro
   @config = {api_key: nil}

data/test/deployment_test.rb

@@ -2,12 +2,6 @@ require "test_helper"
 require "shiro"
 
 class DeploymentTest < Minitest::Test
-  def setup
-    Shiro.configure do |config|
-      config[:api_key] = ENV["SHIRO_API_KEY"]
-    end
-  end
-
   def test_list_deployments
     VCR.use_cassette("deployments_list") do
       response = Shiro::Deployment.list
@@ -19,12 +13,21 @@ class DeploymentTest < Minitest::Test
 
   def test_retrieve_deployment
     VCR.use_cassette("deployment_retrieve") do
-      deployment_id = Shiro::Deployment.list.first["id"]
-      response = Shiro::Deployment.retrieve(deployment_id)
+      response = Shiro::Deployment.retrieve(ENV['SHIRO_DEPLOYMENT_ID'])
 
-      assert_equal deployment_id, response["id"]
+      assert_equal ENV['SHIRO_DEPLOYMENT_ID'], response["id"]
       assert response.key?("name")
       assert response.key?("environment_type")
     end
   end
+
+  def test_update_deployment_name
+    VCR.use_cassette("deployment_update") do
+      new_name = "Updated Deployment Name"
+
+      response = Shiro::Deployment.update(ENV['SHIRO_DEPLOYMENT_ID'], {name: new_name})
+
+      assert_equal new_name, response["name"], "Expected the deployment's name to be updated"
+    end
+  end
 end

data/test/generate_completion_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+require "shiro"
+
+class GenerateCompletionTest < Minitest::Test
+  def test_create_generates_completion
+    VCR.use_cassette("generate_completion_create") do
+      options = {
+        environment: "PRODUCTION",
+        prompt_id: ENV['SHIRO_PROMPT_ID'],
+        input_variables: { "review_text": "I loved the movie." }
+      }
+
+      response = Shiro::GenerateCompletion.create(ENV['SHIRO_DEPLOYMENT_ID'], options)
+
+      assert response.key?("content"), "Expected response to include 'content'"
+    end
+  end
+end

data/test/me_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+require "shiro"
+
+class MeTest < Minitest::Test
+  def test_retrieve_current_user_details
+    VCR.use_cassette("me_retrieve") do
+      response = Shiro::Me.retrieve
+      assert response.key?("id"), "Expected response to include 'id'"
+    end
+  end
+
+  def test_delete_current_user_account
+    VCR.use_cassette("me_delete") do
+      response = Shiro::Me.delete
+      assert response.empty? || response.key?("message"), "Expected successful deletion message or empty response"
+    end
+  end
+end

data/test/prompt_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+require "shiro"
+
+class PromptTest < Minitest::Test
+  def test_list_prompts
+    VCR.use_cassette("prompts_list") do
+      response = Shiro::Prompt.list
+      assert response.first.has_key?("id"), "Expected first prompt to have an 'id'"
+      assert response.first.has_key?("name"), "Expected first prompt to have a 'name'"
+      # Add more assertions based on the expected structure of a prompt
+    end
+  end
+
+  def test_retrieve_prompt
+    VCR.use_cassette("prompt_retrieve") do
+      response = Shiro::Prompt.retrieve(ENV['SHIRO_PROMPT_ID'])
+
+      assert_equal ENV['SHIRO_PROMPT_ID'], response["id"]
+      assert response.key?("name"), "Expected prompt to have a 'name'"
+      assert response.key?("body"), "Expected prompt to have a 'body'"
+      # Add more assertions based on the expected structure of a prompt
+    end
+  end
+end

data/test/test_helper.rb

@@ -5,9 +5,15 @@ require "minitest/autorun"
 require "vcr"
 require "webmock/minitest"
 
+Shiro.configure do |config|
+  config[:api_key] = ENV["SHIRO_API_KEY"]
+end
+
 VCR.configure do |config|
   config.cassette_library_dir = "test/vcr_cassettes"
   config.hook_into :webmock
   config.filter_sensitive_data("<SHIRO_API_KEY>") { ENV["SHIRO_API_KEY"] }
+  config.filter_sensitive_data('<SHIRO_PROMPT_ID>') { ENV['SHIRO_PROMPT_ID'] }
+  config.filter_sensitive_data('<SHIRO_DEPLOYMENT_ID>') { ENV['SHIRO_DEPLOYMENT_ID'] }
   config.default_cassette_options = {record: :new_episodes}
 end

data/test/vcr_cassettes/deployment_retrieve.yml

@@ -2,127 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://openshiro.com/api/v1/deployments/dpmt_lWokJnPAwQCeV2ZWovjG7BNr
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Authorization:
-      - Bearer <SHIRO_API_KEY>
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 404
-      message: Not Found
-    headers:
-      Server:
-      - Cowboy
-      Date:
-      - Sun, 25 Feb 2024 07:30:17 GMT
-      Report-To:
-      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708846218&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZbYV%2BK%2FVaHIjbZJOaO61NdSl3OhGZ%2FBe4vLc1XEiSeE%3D"}]}'
-      Reporting-Endpoints:
-      - heroku-nel=https://nel.heroku.com/reports?ts=1708846218&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZbYV%2BK%2FVaHIjbZJOaO61NdSl3OhGZ%2FBe4vLc1XEiSeE%3D
-      Nel:
-      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
-      Connection:
-      - keep-alive
-      X-Frame-Options:
-      - SAMEORIGIN
-      X-Xss-Protection:
-      - '0'
-      X-Content-Type-Options:
-      - nosniff
-      X-Permitted-Cross-Domain-Policies:
-      - none
-      Referrer-Policy:
-      - strict-origin-when-cross-origin
-      Content-Type:
-      - application/json; charset=utf-8
-      X-Request-Id:
-      - b096e5ce-a064-4441-aa4f-a898670988df
-      X-Runtime:
-      - '0.083281'
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      Content-Length:
-      - '21'
-      Via:
-      - 1.1 vegur
-    body:
-      encoding: UTF-8
-      string: '{"error":"Not found"}'
-  recorded_at: Sun, 25 Feb 2024 07:30:18 GMT
-- request:
-    method: get
-    uri: https://openshiro.com/api/v1/deployments
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Authorization:
-      - Bearer <SHIRO_API_KEY>
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - Cowboy
-      Date:
-      - Sun, 25 Feb 2024 07:39:32 GMT
-      Report-To:
-      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708846772&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=cdr7XBdIFoAGME5VTc3DFKxAU7Nr720WZ%2FcYOtjLQls%3D"}]}'
-      Reporting-Endpoints:
-      - heroku-nel=https://nel.heroku.com/reports?ts=1708846772&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=cdr7XBdIFoAGME5VTc3DFKxAU7Nr720WZ%2FcYOtjLQls%3D
-      Nel:
-      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
-      Connection:
-      - keep-alive
-      X-Frame-Options:
-      - SAMEORIGIN
-      X-Xss-Protection:
-      - '0'
-      X-Content-Type-Options:
-      - nosniff
-      X-Permitted-Cross-Domain-Policies:
-      - none
-      Referrer-Policy:
-      - strict-origin-when-cross-origin
-      Content-Type:
-      - application/json; charset=utf-8
-      Etag:
-      - W/"df6856bf370905f0b5233c2350b8e440"
-      Cache-Control:
-      - max-age=0, private, must-revalidate
-      X-Request-Id:
-      - 713eeb82-2a79-4d93-b709-ec083cfc0c1c
-      X-Runtime:
-      - '0.026924'
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      Content-Length:
-      - '296'
-      Via:
-      - 1.1 vegur
-    body:
-      encoding: UTF-8
-      string: '[{"id":"dpmt_o6drBgMEZv9YmU9vYjb5QwxR","name":"Categorization","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1707946238,"url":"https://openshiro.com/api/v1/deployments/dpmt_o6drBgMEZv9YmU9vYjb5QwxR"}]'
-  recorded_at: Sun, 25 Feb 2024 07:39:32 GMT
-- request:
-    method: get
-    uri: https://openshiro.com/api/v1/deployments/dpmt_o6drBgMEZv9YmU9vYjb5QwxR
+    uri: https://openshiro.com/api/v1/deployments/<SHIRO_DEPLOYMENT_ID>
     body:
       encoding: US-ASCII
       string: ''
@@ -143,11 +23,11 @@ http_interactions:
       Server:
       - Cowboy
       Date:
-      - Sun, 25 Feb 2024 07:39:32 GMT
+      - Mon, 26 Feb 2024 05:59:29 GMT
       Report-To:
-      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708846773&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=PwVcjx5PJ06B5oAnJPQ%2BIAinrPu%2B%2B7CBGpoKxrM9Bmc%3D"}]}'
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708927170&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=zpkRbZ%2FmJU3mj5JXwnVKm2Hui9MBTOOQ7pWaH9TE7jg%3D"}]}'
       Reporting-Endpoints:
-      - heroku-nel=https://nel.heroku.com/reports?ts=1708846773&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=PwVcjx5PJ06B5oAnJPQ%2BIAinrPu%2B%2B7CBGpoKxrM9Bmc%3D
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708927170&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=zpkRbZ%2FmJU3mj5JXwnVKm2Hui9MBTOOQ7pWaH9TE7jg%3D
       Nel:
       - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
       Connection:
@@ -169,9 +49,9 @@ http_interactions:
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - bb7d1b3e-05fa-4ca2-b7a9-576d410f851e
+      - 6eee47fd-8717-48d2-bf75-33a8ffbadaa9
       X-Runtime:
-      - '0.021692'
+      - '0.020676'
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       Content-Length:
@@ -180,6 +60,6 @@ http_interactions:
       - 1.1 vegur
     body:
       encoding: UTF-8
-      string: '{"id":"dpmt_o6drBgMEZv9YmU9vYjb5QwxR","name":"Categorization","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1707946238,"url":"https://openshiro.com/api/v1/deployments/dpmt_o6drBgMEZv9YmU9vYjb5QwxR"}'
-  recorded_at: Sun, 25 Feb 2024 07:39:33 GMT
+      string: '{"id":"<SHIRO_DEPLOYMENT_ID>","name":"Categorization","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1707946238,"url":"https://openshiro.com/api/v1/deployments/<SHIRO_DEPLOYMENT_ID>"}'
+  recorded_at: Mon, 26 Feb 2024 05:59:30 GMT
 recorded_with: VCR 6.2.0

data/test/vcr_cassettes/deployment_update.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://openshiro.com/api/v1/deployments/<SHIRO_DEPLOYMENT_ID>
+    body:
+      encoding: UTF-8
+      string: '{"name":"Updated Deployment Name"}'
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Mon, 26 Feb 2024 06:24:18 GMT
+      Report-To:
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708928658&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Sr1eJVSUC9bOxeL3PEppE165oApuzHd%2Bmqpb%2FdbDeww%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708928658&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Sr1eJVSUC9bOxeL3PEppE165oApuzHd%2Bmqpb%2FdbDeww%3D
+      Nel:
+      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"c87bc2c44f7f1903b49ac02299e8bf7a"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8e3ca24e-1abc-4f63-96bc-a6453e611591
+      X-Runtime:
+      - '0.044823'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '303'
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"<SHIRO_DEPLOYMENT_ID>","name":"Updated Deployment Name","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1708928658,"url":"https://openshiro.com/api/v1/deployments/<SHIRO_DEPLOYMENT_ID>"}'
+  recorded_at: Mon, 26 Feb 2024 06:24:18 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/deployments_list.yml

@@ -23,11 +23,11 @@ http_interactions:
       Server:
       - Cowboy
       Date:
-      - Sun, 25 Feb 2024 07:30:18 GMT
+      - Mon, 26 Feb 2024 05:59:28 GMT
       Report-To:
-      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708846218&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZbYV%2BK%2FVaHIjbZJOaO61NdSl3OhGZ%2FBe4vLc1XEiSeE%3D"}]}'
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708927169&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Snz3k5OG%2BB%2F1n9t9Hkk7u5FR%2Bq0FFEtUFx2FloiO86s%3D"}]}'
       Reporting-Endpoints:
-      - heroku-nel=https://nel.heroku.com/reports?ts=1708846218&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZbYV%2BK%2FVaHIjbZJOaO61NdSl3OhGZ%2FBe4vLc1XEiSeE%3D
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708927169&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Snz3k5OG%2BB%2F1n9t9Hkk7u5FR%2Bq0FFEtUFx2FloiO86s%3D
       Nel:
       - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
       Connection:
@@ -49,9 +49,9 @@ http_interactions:
       Cache-Control:
       - max-age=0, private, must-revalidate
       X-Request-Id:
-      - 3607b9bb-599f-4d2e-a4fb-85f9e7f7b287
+      - c8ded587-ba2e-43f9-ba6a-06b58140165b
       X-Runtime:
-      - '0.033308'
+      - '0.019040'
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       Content-Length:
@@ -60,6 +60,6 @@ http_interactions:
       - 1.1 vegur
     body:
       encoding: UTF-8
-      string: '[{"id":"dpmt_o6drBgMEZv9YmU9vYjb5QwxR","name":"Categorization","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1707946238,"url":"https://openshiro.com/api/v1/deployments/dpmt_o6drBgMEZv9YmU9vYjb5QwxR"}]'
-  recorded_at: Sun, 25 Feb 2024 07:30:18 GMT
+      string: '[{"id":"<SHIRO_DEPLOYMENT_ID>","name":"Categorization","environment_type":{"id":"env_ZWaJKVvg9wQEAILwnNqxk0zy","object":"environment_type","name":"PRODUCTION"},"created_at":1707946238,"updated_at":1707946238,"url":"https://openshiro.com/api/v1/deployments/<SHIRO_DEPLOYMENT_ID>"}]'
+  recorded_at: Mon, 26 Feb 2024 05:59:29 GMT
 recorded_with: VCR 6.2.0

data/test/vcr_cassettes/generate_completion_create.yml

@@ -0,0 +1,68 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://openshiro.com/api/v1/generate_completion
+    body:
+      encoding: UTF-8
+      string: '{"deployment_id":"<SHIRO_DEPLOYMENT_ID>","environment":"PRODUCTION","prompt_id":"<SHIRO_PROMPT_ID>","input_variables":{"review_text":"I
+        loved the movie."}}'
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Mon, 26 Feb 2024 06:03:48 GMT
+      Report-To:
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708927427&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=sQB7OR7nXa%2BfXt4OL6e1AVB06%2FixC0Mup%2FaxCIn9ie0%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708927427&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=sQB7OR7nXa%2BfXt4OL6e1AVB06%2FixC0Mup%2FaxCIn9ie0%3D
+      Nel:
+      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"fd68791208451c24a3ba8a8d0a590581"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - fc2e9a78-8e89-4689-8413-b1e1fcf97bb8
+      X-Runtime:
+      - '0.555866'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '22'
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"content":"Positive"}'
+  recorded_at: Mon, 26 Feb 2024 06:03:48 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/me_delete.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://openshiro.com/api/v1/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"44136fa355b3678a1146ad16f7e8649e"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 86f451d4-9e9c-453f-8647-26a586cf2b65
+      X-Runtime:
+      - '0.347555'
+      Server-Timing:
+      - start_processing.action_controller;dur=0.06, sql.active_record;dur=137.93,
+        instantiation.active_record;dur=25.10, transaction.active_record;dur=296.68,
+        broadcast.action_cable;dur=3.67, process_action.action_controller;dur=333.74
+      Content-Length:
+      - '2'
+    body:
+      encoding: UTF-8
+      string: "{}"
+  recorded_at: Mon, 26 Feb 2024 06:16:40 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/me_retrieve.yml

@@ -0,0 +1,119 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://openshiro.com/api/v1/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Mon, 26 Feb 2024 06:09:20 GMT
+      Report-To:
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708927761&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Vh%2Feruwe0tEyg5ah3p8a0tQcitVvGyR0tcVyw8HtXjo%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708927761&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Vh%2Feruwe0tEyg5ah3p8a0tQcitVvGyR0tcVyw8HtXjo%3D
+      Nel:
+      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"60cc97c152f0d947e79864495341f1b7"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - ed072458-5136-454a-935f-3f8737e61acd
+      X-Runtime:
+      - '0.019382'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '1360'
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"user_dWqxZ3mGOJ6kXIXwD40KXlPn","name":"Duncan Miller","avatar_url":{"blob":{"id":1,"key":"x8q37po2gfbe8d2421kk1m4l2y8y","filename":"duncan-headshot-200.jpg","content_type":"image/jpeg","metadata":{"identified":true,"width":200,"height":200,"analyzed":true},"byte_size":92039,"checksum":"RUXifzZRlURZb1D7Nn450w==","created_at":"2023-10-23T14:36:16.375-07:00","service_name":"amazon","attachable_sgid":"eyJfcmFpbHMiOnsiZGF0YSI6ImdpZDovL2p1bXBzdGFydC1hcHAvQWN0aXZlU3RvcmFnZTo6QmxvYi8xP2V4cGlyZXNfaW4iLCJwdXIiOiJhdHRhY2hhYmxlIn19--84dad8a8e74ccf46f7208c191d2c8f70f8a19cf2"},"variation":{"transformations":{"format":"jpg","resize_to_fit":[48,48]}}},"sgid":"eyJfcmFpbHMiOnsiZGF0YSI6ImdpZDovL2p1bXBzdGFydC1hcHAvVXNlci8xP2V4cGlyZXNfaW4iLCJwdXIiOiJhdHRhY2hhYmxlIn19--7d79db2c0f4b25214e358449bc1e4d3b61374a3c","content":"  \u003cspan\u003e\n    \u003cimg
+        height=\"14\" width=\"14\" class=\"inline-block rounded-full\" src=\"https://openshiro.com/rails/active_storage/representations/redirect/BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVGkGSSIIcHVyBjsAVEkiDGJsb2JfaWQGOwBG--a64858739d09ceec3a56d85e5af5eb1f446fb886/BAh7BkkiC19yYWlscwY6BkVUewdJIglkYXRhBjsAVHsHOgtmb3JtYXRJIghqcGcGOwBUOhJyZXNpemVfdG9fZml0WwdpNWk1SSIIcHVyBjsAVEkiDnZhcmlhdGlvbgY7AEY=--65ac645c590797100032e4bd99b1c7cddb63b2bb/duncan-headshot-200.jpg\"
+        /\u003e\n    Duncan Miller\n  \u003c/span\u003e\n"}'
+  recorded_at: Mon, 26 Feb 2024 06:09:21 GMT
+- request:
+    method: get
+    uri: http://localhost:3000/api/v1/me
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"c280e16cc3b6444421ad4419c17b084f"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 410538e3-e868-40c9-b53f-86867a4900b8
+      X-Runtime:
+      - '0.030299'
+      Server-Timing:
+      - start_processing.action_controller;dur=0.05, sql.active_record;dur=10.79,
+        instantiation.active_record;dur=0.26, transaction.active_record;dur=6.58,
+        render_partial.action_view;dur=2.39, process_action.action_controller;dur=19.01
+      Content-Length:
+      - '623'
+    body:
+      encoding: UTF-8
+      string: '{"id":"user_dWqxZ3mGOJ6kXIXwD40KXlPn","name":"Admin User","avatar_url":"https://secure.gravatar.com/avatar/ffed0d373ee73e94d740ccc42d5482f6.png?default=mp\u0026rating=pg\u0026size=48","sgid":"eyJfcmFpbHMiOnsiZGF0YSI6ImdpZDovL2p1bXBzdGFydC1hcHAvVXNlci8xP2V4cGlyZXNfaW4iLCJwdXIiOiJhdHRhY2hhYmxlIn19--c304d75afe7bdcba99999d278c24e4f941dd9797","content":"  \u003cspan\u003e\n    \u003cimg
+        height=\"14\" width=\"14\" class=\"inline-block rounded-full\" src=\"https://secure.gravatar.com/avatar/ffed0d373ee73e94d740ccc42d5482f6.png?default=mp\u0026amp;rating=pg\u0026amp;size=48\"
+        /\u003e\n    Admin User\n  \u003c/span\u003e\n"}'
+  recorded_at: Mon, 26 Feb 2024 06:11:30 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/prompt_retrieve.yml

@@ -0,0 +1,67 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://openshiro.com/api/v1/prompts/<SHIRO_PROMPT_ID>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Mon, 26 Feb 2024 05:59:29 GMT
+      Report-To:
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708927169&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Snz3k5OG%2BB%2F1n9t9Hkk7u5FR%2Bq0FFEtUFx2FloiO86s%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708927169&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=Snz3k5OG%2BB%2F1n9t9Hkk7u5FR%2Bq0FFEtUFx2FloiO86s%3D
+      Nel:
+      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"a575c0b29702255cb670921a0f872d1f"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - c606f154-b317-490a-879c-c939a9f952ca
+      X-Runtime:
+      - '0.022605'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '473'
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"id":"<SHIRO_PROMPT_ID>","name":"Categorization prompt 1","body":"Categorize
+        the following review as either positive or negative. Respond with one word
+        only, positive or negative. {{ review_text }}","temperature":0.5,"language_model":{"id":"lm_4Rz6y7lNwKRwgSybQMEB1j82","object":"language_model","name":"gpt-4","provider_name":"OpenAI"},"created_at":1707946227,"updated_at":1707946227,"url":"https://openshiro.com/api/v1/prompts/<SHIRO_PROMPT_ID>"}'
+  recorded_at: Mon, 26 Feb 2024 05:59:29 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/prompts_list.yml

@@ -0,0 +1,75 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://openshiro.com/api/v1/prompts
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <SHIRO_API_KEY>
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - Cowboy
+      Date:
+      - Mon, 26 Feb 2024 04:49:40 GMT
+      Report-To:
+      - '{"group":"heroku-nel","max_age":3600,"endpoints":[{"url":"https://nel.heroku.com/reports?ts=1708922980&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZxXLE2FPmGnf8UTsugNEf5pYtoLHvvTY4KWPtFrf91M%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708922980&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=ZxXLE2FPmGnf8UTsugNEf5pYtoLHvvTY4KWPtFrf91M%3D
+      Nel:
+      - '{"report_to":"heroku-nel","max_age":3600,"success_fraction":0.005,"failure_fraction":0.05,"response_headers":["Via"]}'
+      Connection:
+      - keep-alive
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Xss-Protection:
+      - '0'
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+      Content-Type:
+      - application/json; charset=utf-8
+      Etag:
+      - W/"6c286312298ab48ed557e97b8c1d270b"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - ff3372fa-be53-46ba-a347-79bda5605735
+      X-Runtime:
+      - '0.035550'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '1665'
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '[{"id":"prmt_qWdKlNznA8bQws61v039e2wk","name":"New hire letter","body":"Write
+        a new hire welcome letter to a new employee whose first name is {{ first_name
+        }}. {{ first_name }} has been hired as a {{ job_title }}. Let them know that
+        their new company email address will be {{ email }}. ","temperature":0.0,"language_model":{"id":"lm_4Rz6y7lNwKRwgSybQMEB1j82","object":"language_model","name":"gpt-4","provider_name":"OpenAI"},"created_at":1706838837,"updated_at":1706838837,"url":"https://openshiro.com/api/v1/prompts/prmt_qWdKlNznA8bQws61v039e2wk"},{"id":"prmt_B2Q3O6anr10rzSr5RMNzqvde","name":"New
+        hire letter fun","body":"Imagine you are a fun writer and write in a light,
+        but still professional manner.  Please write a new hire welcome letter to
+        a new employee whose first name is {{ first_name }}. {{ first_name }} has
+        been hired as a {{ job_title }}. Let them know that their new company email
+        address will be {{ email }}","temperature":0.0,"language_model":{"id":"lm_4Rz6y7lNwKRwgSybQMEB1j82","object":"language_model","name":"gpt-4","provider_name":"OpenAI"},"created_at":1706842288,"updated_at":1706842288,"url":"https://openshiro.com/api/v1/prompts/prmt_B2Q3O6anr10rzSr5RMNzqvde"},{"id":"prmt_6q9JKvEmp5LPxub5ONgawnrB","name":"Categorization
+        prompt 1","body":"Categorize the following review as either positive or negative.
+        Respond with one word only, positive or negative. {{ review_text }}","temperature":0.5,"language_model":{"id":"lm_4Rz6y7lNwKRwgSybQMEB1j82","object":"language_model","name":"gpt-4","provider_name":"OpenAI"},"created_at":1707946227,"updated_at":1707946227,"url":"https://openshiro.com/api/v1/prompts/prmt_6q9JKvEmp5LPxub5ONgawnrB"}]'
+  recorded_at: Mon, 26 Feb 2024 04:49:40 GMT
+recorded_with: VCR 6.2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiro
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Duncan Miller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -109,12 +109,24 @@ files:
 - lib/shiro.rb
 - lib/shiro/client.rb
 - lib/shiro/deployment.rb
+- lib/shiro/generate_completion.rb
+- lib/shiro/me.rb
+- lib/shiro/prompt.rb
 - lib/shiro/version.rb
 - shiro.gemspec
 - test/deployment_test.rb
+- test/generate_completion_test.rb
+- test/me_test.rb
+- test/prompt_test.rb
 - test/test_helper.rb
 - test/vcr_cassettes/deployment_retrieve.yml
+- test/vcr_cassettes/deployment_update.yml
 - test/vcr_cassettes/deployments_list.yml
+- test/vcr_cassettes/generate_completion_create.yml
+- test/vcr_cassettes/me_delete.yml
+- test/vcr_cassettes/me_retrieve.yml
+- test/vcr_cassettes/prompt_retrieve.yml
+- test/vcr_cassettes/prompts_list.yml
 homepage: https://github.com/OpenShiro/shiro-ruby
 licenses: []
 metadata: {}