patch_ruby 1.0.0.pre

data/lib/patch_ruby/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+module Patch
+  VERSION = '1.0.0.pre'
+end

data/patch_ruby.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "patch_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "patch_ruby"
+  s.version     = Patch::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Patch Technology"]
+  s.email       = ["developers@usepatch.com"]
+  s.homepage    = "https://www.usepatch.com"
+  s.summary     = "Ruby wrapper for the Patch API"
+  s.description = "Ruby wrapper for the Patch API"
+  s.license     = 'MIT'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/estimates_api_spec.rb

@@ -0,0 +1,71 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::EstimatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EstimatesApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::EstimatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EstimatesApi' do
+    it 'should create an instance of EstimatesApi' do
+      expect(@api_instance).to be_instance_of(Patch::EstimatesApi)
+    end
+  end
+
+  # unit tests for create_mass_estimate
+  # Create an estimate based on mass of CO2
+  # Creates an estimate for the mass of CO2 to be compensated. An order in the `draft` state will also be created, linked to the estimate. 
+  # @param create_mass_estimate_request 
+  # @param [Hash] opts the optional parameters
+  # @return [EstimateResponse]
+  describe 'create_mass_estimate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_estimate
+  # Retrieves an estimate
+  # Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [EstimateResponse]
+  describe 'retrieve_estimate test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_estimates
+  # Retrieves a list of estimates
+  # Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @return [EstimateListResponse]
+  describe 'retrieve_estimates test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/orders_api_spec.rb

@@ -0,0 +1,95 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::OrdersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'OrdersApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::OrdersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of OrdersApi' do
+    it 'should create an instance of OrdersApi' do
+      expect(@api_instance).to be_instance_of(Patch::OrdersApi)
+    end
+  end
+
+  # unit tests for cancel_order
+  # Cancel an order
+  # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` state can be cancelled. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [OrderResponse]
+  describe 'cancel_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for create_order
+  # Creates an order
+  # Creates an order in the `placed` state. To create a `draft` order, create an estimate first. 
+  # @param create_order_request 
+  # @param [Hash] opts the optional parameters
+  # @return [OrderResponse]
+  describe 'create_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for place_order
+  # Place an order
+  # Placing an order confirms an order's allocation of offsets. Only orders that are in the `draft` state can be placed 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [OrderResponse]
+  describe 'place_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_order
+  # Retrieves an order
+  # Retrieves a given order and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [OrderResponse]
+  describe 'retrieve_order test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_orders
+  # Retrieves a list of orders
+  # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @return [OrderListResponse]
+  describe 'retrieve_orders test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/preferences_api_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::PreferencesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PreferencesApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::PreferencesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PreferencesApi' do
+    it 'should create an instance of PreferencesApi' do
+      expect(@api_instance).to be_instance_of(Patch::PreferencesApi)
+    end
+  end
+
+  # unit tests for create_preference
+  # creates a project preference
+  # Creates a project preference for the given organization. If you have a `preference` in place, all of your orders will be directed to the project the preference points to. 
+  # @param create_preference_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceResponse]
+  describe 'create_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_preference
+  # Deletes an organization's preference for a project
+  # Deletes the given `preference`. Once a preference is deleted, it cannot be undone. If you want to restore your previous preference, create a new one. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceResponse]
+  describe 'delete_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_preference
+  # Retrieve the preference
+  # Retrieve the preference and project of an organization. You can only retrieve preferences associated with your organization. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceResponse]
+  describe 'retrieve_preference test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_preferences
+  # Retrieves a list of preferences
+  # Retrieves a list of preferences and associated projects of an organization. You can only retrieve preferences associated with your organization. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @return [PreferenceListResponse]
+  describe 'retrieve_preferences test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/projects_api_spec.rb

@@ -0,0 +1,59 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Patch::ProjectsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ProjectsApi' do
+  before do
+    # run before each test
+    @api_instance = Patch::ProjectsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ProjectsApi' do
+    it 'should create an instance of ProjectsApi' do
+      expect(@api_instance).to be_instance_of(Patch::ProjectsApi)
+    end
+  end
+
+  # unit tests for retrieve_project
+  # Retrieves a project
+  # Retrieves a project available on Patch's platform. 
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [ProjectResponse]
+  describe 'retrieve_project test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for retrieve_projects
+  # Retrieves a list of projects
+  # Retrieves a list of projects available for purchase on Patch's platform. 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @return [ProjectListResponse]
+  describe 'retrieve_projects test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+
+describe Patch::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          Patch.configure { |c| c.host = 'http://example.com' }
+          expect(Patch::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          Patch.configure { |c| c.host = 'https://wookiee.com' }
+          expect(Patch::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          Patch.configure { |c| c.host = 'hobo.com/v4' }
+          expect(Patch::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          Patch.configure { |c| c.base_path = 'v4/dog' }
+          expect(Patch::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          Patch.configure { |c| c.base_path = '/v4/dog' }
+          expect(Patch::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          Patch.configure { |c| c.base_path = nil }
+          expect(Patch::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe 'params_encoding in #build_request' do
+    let(:config) { Patch::Configuration.new }
+    let(:api_client) { Patch::ApiClient.new(config) }
+
+    it 'defaults to nil' do
+      expect(Patch::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it 'can be customized' do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe 'timeout in #build_request' do
+    let(:config) { Patch::Configuration.new }
+    let(:api_client) { Patch::ApiClient.new(config) }
+
+    it 'defaults to 0' do
+      expect(Patch::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it 'can be customized' do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe '#deserialize' do
+    it "handles Array<Integer>" do
+      api_client = Patch::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it 'handles Array<Array<Integer>>' do
+      api_client = Patch::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it 'handles Hash<String, String>' do
+      api_client = Patch::ApiClient.new
+      headers = { 'Content-Type' => 'application/json' }
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq(:message => 'Hello')
+    end
+  end
+
+  describe "#object_to_hash" do
+    it 'ignores nils and includes empty arrays' do
+      # uncomment below to test object_to_hash for model
+      # api_client = Patch::ApiClient.new
+      # _model = Patch::ModelName.new
+      # update the model attribute below
+      # _model.id = 1
+      # update the expected value (hash) below
+      # expected = {id: 1, name: '', tags: []}
+      # expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe '#build_collection_param' do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { Patch::ApiClient.new }
+
+    it 'works for csv' do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it 'works for ssv' do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it 'works for tsv' do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it 'works for pipes' do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it 'works for multi' do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it 'fails for invalid collection format' do
+      expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe '#json_mime?' do
+    let(:api_client) { Patch::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe '#select_header_accept' do
+    let(:api_client) { Patch::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe '#select_header_content_type' do
+    let(:api_client) { Patch::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe '#sanitize_filename' do
+    let(:api_client) { Patch::ApiClient.new }
+
+    it 'works' do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end