patch_ruby 1.0.0.pre → 1.2.4

data/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module Patch
-  VERSION = '1.0.0.pre'
+  VERSION = '1.2.4'
 end

data/spec/api/estimates_api_spec.rb

@@ -34,8 +34,8 @@ describe 'EstimatesApi' do
 
   # 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 
+  # 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
@@ -46,8 +46,8 @@ describe 'EstimatesApi' do
 
   # 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 
+  # 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
@@ -58,14 +58,13 @@ describe 'EstimatesApi' do
 
   # 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. 
+  # 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 
+  # @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

@@ -34,8 +34,8 @@ describe 'OrdersApi' do
 
   # 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 
+  # 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
@@ -46,8 +46,8 @@ describe 'OrdersApi' do
 
   # 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 
+  # 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
@@ -58,8 +58,8 @@ describe 'OrdersApi' do
 
   # 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 
+  # 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
@@ -70,8 +70,8 @@ describe 'OrdersApi' do
 
   # 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 
+  # 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
@@ -82,14 +82,13 @@ describe 'OrdersApi' do
 
   # 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. 
+  # 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 
+  # @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

@@ -34,8 +34,8 @@ describe 'PreferencesApi' do
 
   # 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 
+  # 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
@@ -46,8 +46,8 @@ describe 'PreferencesApi' do
 
   # 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 
+  # 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
@@ -58,8 +58,8 @@ describe 'PreferencesApi' do
 
   # 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 
+  # 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
@@ -70,14 +70,13 @@ describe 'PreferencesApi' do
 
   # 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. 
+  # 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 
+  # @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

@@ -34,8 +34,8 @@ describe 'ProjectsApi' do
 
   # unit tests for retrieve_project
   # Retrieves a project
-  # Retrieves a project available on Patch's platform. 
-  # @param id 
+  # Retrieves a project available on Patch's platform.
+  # @param id
   # @param [Hash] opts the optional parameters
   # @return [ProjectResponse]
   describe 'retrieve_project test' do
@@ -46,14 +46,13 @@ describe 'ProjectsApi' do
 
   # unit tests for retrieve_projects
   # Retrieves a list of projects
-  # Retrieves a list of projects available for purchase on Patch's platform. 
+  # Retrieves a list of projects available for purchase on Patch's platform.
   # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page 
+  # @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

@@ -10,43 +10,22 @@ 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
+    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
 
-      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
+      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

data/spec/constants.rb

@@ -0,0 +1,3 @@
+module Constants
+  BIOMASS_TEST_PROJECT_ID = "pro_test_c3a9feba769fc7a8806377266ca9ff6a"
+end

data/spec/integration/estimates_spec.rb

@@ -1,31 +1,38 @@
-require 'spec_helper'
-
 RSpec.describe 'Estimates Integration' do
-  it "supports create, retrieve and list" do
-    VCR.use_cassette('estimates') do
-      # Configure the Patch gem
-      Patch.configure do |config|
-        config.access_token = ENV['PATCH_RUBY_API_KEY']
-        config.host = ENV['PATCH_RUBY_HOST']
-      end
-
-      create_estimate_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
-      estimate_id = create_estimate_response.data.id
+  before do
+    Patch.configure do |config|
+      config.access_token = ENV['SANDBOX_API_KEY']
+    end
+  end
 
-      retrieve_estimate_response = Patch::Estimate.retrieve_estimate(estimate_id)
-      expect(retrieve_estimate_response.data.id).to eq estimate_id
+  it 'supports create, retrieve and list' do
+    create_estimate_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
+    estimate_id = create_estimate_response.data.id
 
-      page_limit = 1
-      next_page = 1
-      estimates = []
+    retrieve_estimate_response = Patch::Estimate.retrieve_estimate(estimate_id)
+    expect(retrieve_estimate_response.data.id).to eq estimate_id
 
-      while !next_page.nil? && next_page <= page_limit
-        retrieve_estimates_response = Patch::Estimate.retrieve_estimates(page: next_page)
-        next_page = retrieve_estimates_response.meta.next_page
-        estimates += retrieve_estimates_response.data
-      end
+    page_limit = 1
+    next_page = 1
+    estimates = []
 
-      expect(estimates.length).not_to be_zero
+    while !next_page.nil? && next_page <= page_limit
+      retrieve_estimates_response = Patch::Estimate.retrieve_estimates(page: next_page)
+      next_page = retrieve_estimates_response.meta.next_page
+      estimates += retrieve_estimates_response.data
     end
+
+    expect(estimates.length).not_to be_zero
+  end
+
+  it 'supports create with a project-id' do
+    retrieve_projects_response = Patch::Project.retrieve_projects(page: 1)
+    project_id = retrieve_projects_response.data.first.id
+    create_estimate_response = Patch::Estimate.create_mass_estimate(mass_g: 100, project_id: project_id)
+    estimate_id = create_estimate_response.data.id
+
+    expect(create_estimate_response.success).to eq true
+    expect(create_estimate_response.data.order.id).not_to be_nil
+    expect(create_estimate_response.data.order.mass_g).to eq(100)
   end
 end

data/spec/integration/orders_spec.rb

@@ -1,53 +1,100 @@
-require 'spec_helper'
-
 RSpec.describe 'Orders Integration' do
-  it "supports create, place, cancel, retrieve and list" do
-    VCR.use_cassette('orders') do
-      # Configure the Patch gem
-      Patch.configure do |config|
-        config.access_token = ENV['PATCH_RUBY_API_KEY']
-        config.host = ENV['PATCH_RUBY_HOST']
-      end
+  before do
+    Patch.configure do |config|
+      config.access_token = ENV['SANDBOX_API_KEY']
+    end
+  end
 
-      create_order_response = Patch::Order.create_order(mass_g: 100)
-      order_id = create_order_response.data.id
+  it 'supports create, place, cancel, retrieve and list' do
+    create_order_response = Patch::Order.create_order(mass_g: 100)
+    order_id = create_order_response.data.id
 
-      retrieve_order_response = Patch::Order.retrieve_order(order_id)
-      expect(retrieve_order_response.data.id).to eq order_id
+    retrieve_order_response = Patch::Order.retrieve_order(order_id)
+    expect(retrieve_order_response.data.id).to eq order_id
 
-      # place_order_response = Patch::Order.place_order(order_id)
-      # expect(place_order_response.data.state).to eq 'placed'
+    page_limit = 1
+    next_page = 1
+    orders = []
 
-      # place_order_response = Patch::Order.cancel_order(order_id)
-      # expect(place_order_response.data.state).to eq 'cancelled'
+    while !next_page.nil? && next_page <= page_limit
+      retrieve_orders_response = Patch::Order.retrieve_orders(page: next_page)
+      next_page = retrieve_orders_response.meta.next_page
+      orders += retrieve_orders_response.data
+    end
 
-      page_limit = 1
-      next_page = 1
-      orders = []
+    expect(orders.length).not_to be_zero
+  end
 
-      while !next_page.nil? && next_page <= page_limit
-        retrieve_orders_response = Patch::Order.retrieve_orders(page: next_page)
-        next_page = retrieve_orders_response.meta.next_page
-        orders += retrieve_orders_response.data
-      end
+  it 'supports create with a project-id' do
+    retrieve_project_response = Patch::Project.retrieve_project(
+      Constants::BIOMASS_TEST_PROJECT_ID
+    )
 
-      expect(orders.length).not_to be_zero
-    end
+    project_id = retrieve_project_response.data.id
+    average_price_per_tonne_cents_usd = retrieve_project_response.data.average_price_per_tonne_cents_usd
+
+    order_mass_g = 100_000
+    tonne_per_gram = 1_000_000
+
+    expected_price = (average_price_per_tonne_cents_usd.to_f / tonne_per_gram) * order_mass_g
+
+    create_order_response = Patch::Order.create_order(mass_g: order_mass_g, project_id: project_id)
+
+    expect(create_order_response.success).to eq true
+    expect(create_order_response.data.id).not_to be_nil
+    expect(create_order_response.data.mass_g).to eq(order_mass_g)
+    expect(create_order_response.data.price_cents_usd.to_i).to eq(expected_price)
+    expect(create_order_response.data.patch_fee_cents_usd).not_to be_empty
   end
 
-  it "supports place and cancel for order created via an estimate" do
-    VCR.use_cassette('estimate_orders') do
-      create_estimate_to_place_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
-      order_to_place_id = create_estimate_to_place_response.data.order.id
+  it 'supports create with a total price' do
+    retrieve_project_response = Patch::Project.retrieve_project(
+      Constants::BIOMASS_TEST_PROJECT_ID
+    )
 
-      place_order_response = Patch::Order.place_order(order_to_place_id)
-      expect(place_order_response.data.state).to eq 'placed'
+    project_id = retrieve_project_response.data.id
+    total_price_cents_usd = 5_00
 
-      create_estimate_to_cancel_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
-      order_to_cancel_id = create_estimate_to_cancel_response.data.order.id
+    create_order_response = Patch::Order.create_order(
+      total_price_cents_usd: total_price_cents_usd,
+      project_id: project_id
+    )
 
-      cancel_order_response = Patch::Order.cancel_order(order_to_cancel_id)
-      expect(cancel_order_response.data.state).to eq 'cancelled'
-    end
+    expect(create_order_response.success).to eq true
+
+    order = create_order_response.data
+
+    expect(order.id).not_to be_nil
+    expect(order.mass_g).to eq(5_000_000)
+    expect(order.price_cents_usd.to_i).to eq(500)
+    expect(order.patch_fee_cents_usd).not_to be_empty
+    expect(
+      order.price_cents_usd.to_i + order.patch_fee_cents_usd.to_i
+    ).to eq(total_price_cents_usd)
+  end
+
+  it 'supports create with metadata' do
+    metadata = { user: 'john doe' }
+
+    create_order_response = Patch::Order.create_order(mass_g: 100, metadata: metadata)
+
+    expect(create_order_response.success).to eq true
+    expect(create_order_response.data.id).not_to be_nil
+    expect(create_order_response.data.mass_g).to eq(100)
+    expect(create_order_response.data.metadata).to eq(metadata)
+  end
+
+  it 'supports place and cancel for orders created via an estimate' do
+    create_estimate_to_place_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
+    order_to_place_id = create_estimate_to_place_response.data.order.id
+
+    place_order_response = Patch::Order.place_order(order_to_place_id)
+    expect(place_order_response.data.state).to eq 'placed'
+
+    create_estimate_to_cancel_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
+    order_to_cancel_id = create_estimate_to_cancel_response.data.order.id
+
+    cancel_order_response = Patch::Order.cancel_order(order_to_cancel_id)
+    expect(cancel_order_response.data.state).to eq 'cancelled'
   end
 end

data/spec/integration/preferences_spec.rb

@@ -1,40 +1,34 @@
-require 'spec_helper'
-
 RSpec.describe 'Preferences Integration' do
-  it "supports create, delete, retrieve and list" do
-    VCR.use_cassette('preferences') do
-      # Configure the Patch gem
-      Patch.configure do |config|
-        config.access_token = ENV['PATCH_RUBY_API_KEY']
-        config.host = ENV['PATCH_RUBY_HOST']
-      end
+  before do
+    Patch.configure do |config|
+      config.access_token = ENV['SANDBOX_API_KEY']
+    end
+  end
 
-      retrieve_projects_response = Patch::Project.retrieve_projects
-      expect(retrieve_projects_response.data.length).not_to be_zero
-      project_id = retrieve_projects_response.data.first.id
+  it 'supports create, delete, retrieve and list' do
+    retrieve_projects_response = Patch::Project.retrieve_projects
+    expect(retrieve_projects_response.data.length).not_to be_zero
+    project_id = retrieve_projects_response.data.first.id
 
-      create_preference_response = Patch::Preference.create_preference(project_id: project_id)
-      preference_id = create_preference_response.data.id
+    create_preference_response = Patch::Preference.create_preference(project_id: project_id)
+    preference_id = create_preference_response.data.id
 
-      retrieve_preference_response = Patch::Preference.retrieve_preference(preference_id)
-      expect(retrieve_preference_response.data.id).to eq preference_id
+    retrieve_preference_response = Patch::Preference.retrieve_preference(preference_id)
+    expect(retrieve_preference_response.data.id).to eq preference_id
 
-      # START receive_preferences
-      page_limit = 1
-      next_page = 1
-      preferences = []
+    page_limit = 1
+    next_page = 1
+    preferences = []
 
-      while !next_page.nil? && next_page <= page_limit
-        retrieve_preferences_response = Patch::Preference.retrieve_preferences(page: next_page)
-        next_page = retrieve_preferences_response.meta.next_page
-        preferences += retrieve_preferences_response.data
-      end
+    while !next_page.nil? && next_page <= page_limit
+      retrieve_preferences_response = Patch::Preference.retrieve_preferences(page: next_page)
+      next_page = retrieve_preferences_response.meta.next_page
+      preferences += retrieve_preferences_response.data
+    end
 
-      expect(preferences.length).not_to be_zero
-      # END receive_preferences
+    expect(preferences.length).not_to be_zero
 
-      delete_preference_response = Patch::Preference.delete_preference(preference_id)
-      expect(delete_preference_response.data.id).to eq preference_id
-    end
+    delete_preference_response = Patch::Preference.delete_preference(preference_id)
+    expect(delete_preference_response.data.id).to eq preference_id
   end
 end