shiro 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0065f9bf6fdf82f8dcbfff39ba0422c59a97691ebf4ebb42596b63063bf0aa7
+  data.tar.gz: b90f16777c189cdc817e82b60cc5fbbea31d3136f9896d48ba130afe3ee30a1c
+SHA512:
+  metadata.gz: 65e5809bce6de212f468fd3f167c021cbaf6546d2f99a972b1afcf544f80dcae914991ab651b18043572ecffa4275c85e97592b7aa645cc46a59121f8714b5a2
+  data.tar.gz: 4e3c4bf6c500da21ac3f1448aa3854552b1d7d3077c84ec5d5f872512abb75c6373a9dc1192494648ca05763f0743526af1fc665a767dc94e8c88dd22dcc3d89

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+pkg
+rdoc
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shiro.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 OpenShiro
+
+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,27 @@
+This is the official [Shiro API](https://openshiro.com/api/v1/docs) Ruby gem maintained by [OpenShiro](https://openshiro.com).
+
+To use the gem, include it in your Rails gemfile with:
+
+`bundle add shiro`
+
+or directly in the gemfile:
+
+`gem "shiro", "~> 0.1"`
+
+Example usage:
+
+````
+require "shiro"
+
+Shiro.configure do |config|
+  config[:api_key] = "your_api_key..."
+end
+
+# List deployments
+deployments = Shiro::Deployment.list
+puts deployments.body
+
+# Retrieve single deployment
+deployment = Shiro::Deployment.retrieve("dpmt_lWokJnPAwQCeV2ZWovjG7BNr")
+puts deployment.body
+````

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: :test

data/lib/shiro/client.rb

@@ -0,0 +1,27 @@
+require "httparty"
+
+module Shiro
+  class Client
+    include HTTParty
+    base_uri "https://openshiro.com/api/v1"
+
+    def initialize(api_key = ENV["SHIRO_API_KEY"])
+      raise "API key not defined" unless api_key
+      @api_key = api_key
+    end
+
+    def get(path)
+      self.class.get(path, headers: auth_header)
+    end
+
+    def post(path, body = {})
+      self.class.post(path, body: body.to_json, headers: auth_header.merge("Content-Type" => "application/json"))
+    end
+
+    private
+
+    def auth_header
+      {"Authorization" => "Bearer #{@api_key}"}
+    end
+  end
+end

data/lib/shiro/deployment.rb

@@ -0,0 +1,17 @@
+module Shiro
+  class Deployment
+    def self.list
+      client.get("/deployments").parsed_response
+    end
+
+    def self.retrieve(id)
+      client.get("/deployments/#{id}").parsed_response
+    end
+
+    private_class_method
+
+    def self.client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/shiro/version.rb

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

data/lib/shiro.rb

@@ -0,0 +1,18 @@
+require "net/http"
+require "json"
+require "uri"
+require "shiro/client"
+require "shiro/deployment"
+require "shiro/version"
+
+module Shiro
+  @config = {api_key: nil}
+
+  class << self
+    attr_accessor :config
+
+    def configure
+      yield(config)
+    end
+  end
+end

data/shiro.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shiro/version"
+
+Gem::Specification.new do |gem|
+  gem.name = "shiro"
+  gem.version = Shiro::VERSION
+  gem.authors = ["Duncan Miller"]
+  gem.email = ["ruby@openshiro.com"]
+  gem.description = "Wrapper for the Shiro API"
+  gem.summary = "A system for consuming the Shiro API"
+  gem.homepage = "https://github.com/OpenShiro/shiro-ruby"
+
+  # Runtime dependencies
+  gem.add_dependency "httparty", ">= 0.17.3"
+
+  # Development dependencies
+  gem.add_development_dependency "minitest", "~> 5.0"
+  gem.add_development_dependency "vcr", "~> 6.2"
+  gem.add_development_dependency "standardrb"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "webmock", "~> 3.0"
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

data/test/deployment_test.rb

@@ -0,0 +1,30 @@
+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
+      assert response.first.has_key?("id"), "Expected first deployment to have an 'id'"
+      assert response.first.has_key?("name"), "Expected first deployment to have a 'name'"
+      # Add more assertions as needed based on the expected structure of a deployment
+    end
+  end
+
+  def test_retrieve_deployment
+    VCR.use_cassette("deployment_retrieve") do
+      deployment_id = Shiro::Deployment.list.first["id"]
+      response = Shiro::Deployment.retrieve(deployment_id)
+
+      assert_equal deployment_id, response["id"]
+      assert response.key?("name")
+      assert response.key?("environment_type")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require "bundler/setup"
+Bundler.require(:default, :test)
+
+require "minitest/autorun"
+require "vcr"
+require "webmock/minitest"
+
+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.default_cassette_options = {record: :new_episodes}
+end

data/test/vcr_cassettes/deployment_retrieve.yml

@@ -0,0 +1,185 @@
+---
+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
+    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=1708846773&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=PwVcjx5PJ06B5oAnJPQ%2BIAinrPu%2B%2B7CBGpoKxrM9Bmc%3D"}]}'
+      Reporting-Endpoints:
+      - heroku-nel=https://nel.heroku.com/reports?ts=1708846773&sid=e11707d5-02a7-43ef-b45e-2cf4d2036f7d&s=PwVcjx5PJ06B5oAnJPQ%2BIAinrPu%2B%2B7CBGpoKxrM9Bmc%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/"5d4652949327f6cd4f954400df309967"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - bb7d1b3e-05fa-4ca2-b7a9-576d410f851e
+      X-Runtime:
+      - '0.021692'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Content-Length:
+      - '294'
+      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:33 GMT
+recorded_with: VCR 6.2.0

data/test/vcr_cassettes/deployments_list.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- 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:30:18 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
+      Etag:
+      - W/"df6856bf370905f0b5233c2350b8e440"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 3607b9bb-599f-4d2e-a4fb-85f9e7f7b287
+      X-Runtime:
+      - '0.033308'
+      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:30:18 GMT
+recorded_with: VCR 6.2.0

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: shiro
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Duncan Miller
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Wrapper for the Shiro API
+email:
+- ruby@openshiro.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/shiro.rb
+- lib/shiro/client.rb
+- lib/shiro/deployment.rb
+- lib/shiro/version.rb
+- shiro.gemspec
+- test/deployment_test.rb
+- test/test_helper.rb
+- test/vcr_cassettes/deployment_retrieve.yml
+- test/vcr_cassettes/deployments_list.yml
+homepage: https://github.com/OpenShiro/shiro-ruby
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: A system for consuming the Shiro API
+test_files: []