patch_ruby 1.2.2 → 1.4.0

data/lib/patch_ruby/models/standard.rb

@@ -14,10 +14,13 @@ require 'date'
 
 module Patch
   class Standard
+    # The standard type.
     attr_accessor :type
 
+    # The acronym for the standard.
     attr_accessor :acronym
 
+    # The description of the standard.
     attr_accessor :description
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -38,6 +41,13 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties
+    end
+
     # Allows models with corresponding API classes to delegate API operations to those API classes
     # Exposes Model.operation_id which delegates to ModelsApi.new.operation_id
     # Eg. Order.create_order delegates to OrdersApi.new.create_order

data/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module Patch
-  VERSION = '1.2.2'
+  VERSION = '1.4.0'
 end

data/spec/constants.rb

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

data/spec/factories/allocations.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :allocation, class: Patch::Allocation do
+    sequence(:id) { |n| n }
+    production { false }
+    mass_g { 100 }
+  end
+end

data/spec/factories/create_mass_estimate_requests.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :create_mass_estimate_request, class: Patch::CreateMassEstimateRequest do
+    sequence(:project_id) { |n| n }
+    mass_g { 100 }
+  end
+end

data/spec/factories/create_order_requests.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :create_order_request, class: Patch::CreateOrderRequest do
+    sequence(:project_id) { |n| n }
+    mass_g { 100 }
+    total_price_cents_usd { 100 }
+    metadata { {} }
+  end
+end

data/spec/factories/create_preference_requests.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :create_preference_request, class: Patch::CreatePreferenceRequest do
+    sequence(:project_id) { |n| n }
+  end
+end

data/spec/factories/error_responses.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :error_response, class: Patch::ErrorResponse do
+    success { true }
+    error { {} }
+    data { {} }
+  end
+end

data/spec/factories/estimate_list_responses.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :estimate_list_response, class: Patch::EstimateListResponse do
+    success { true }
+    error { {} }
+    data { {} }
+    meta { {} }
+  end
+end

data/spec/factories/estimate_responses.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :estimate_response, class: Patch::EstimateResponse do
+    success { true }
+    error { {} }
+    data { {} }
+  end
+end

data/spec/factories/estimates.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :estimate, class: Patch::Estimate do
+    sequence(:id) { |n| n }
+    association :order
+    production { false }
+    type { "mass" }
+  end
+end

data/spec/factories/meta_index_objects.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :meta_index_object, class: Patch::MetaIndexObject do
+    sequence(:next_page) { |n| n + 1 }
+    sequence(:prev_page) { |n| n - 1 }
+  end
+end

data/spec/factories/order_list_responses.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :order_list_response, class: Patch::OrderListResponse do
+    success { true }
+    error { {} }
+    data { {} }
+    meta { {} }
+  end
+end

data/spec/factories/order_responses.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :order_response, class: Patch::OrderResponse do
+    success { true }
+    error { {} }
+    data { {} }
+  end
+end

data/spec/factories/orders.rb

@@ -0,0 +1,12 @@
+FactoryBot.define do
+  factory :order, class: Patch::Order do
+    sequence(:id) { |n| n }
+    mass_g { 1_000 }
+    production { false }
+    state { "draft" }
+    allocation_state { "pending" }
+    price_cents_usd { 500 }
+    patch_fee_cents_usd { 5 }
+    metadata { {} }
+  end
+end

data/spec/factories/preference_list_responses.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :preference_list_response, class: Patch::PreferenceListResponse do
+    success { true }
+    error { {} }
+    data { {} }
+    meta { {} }
+  end
+end

data/spec/factories/preference_responses.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :preference_response, class: Patch::PreferenceResponse do
+    success { true }
+    error { {} }
+    data { {} }
+  end
+end

data/spec/factories/preferences.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :preference, class: Patch::Preference do
+    sequence(:id) { |n| n }
+    association :project
+    allocation_percentage { 1 }
+  end
+end

data/spec/factories/project_list_responses.rb

@@ -0,0 +1,8 @@
+FactoryBot.define do
+  factory :project_list_response, class: Patch::ProjectListResponse do
+    success { true }
+    error { {} }
+    data { {} }
+    meta { {} }
+  end
+end

data/spec/factories/project_responses.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :project_response, class: Patch::ProjectResponse do
+    success { true }
+    error { {} }
+    data { {} }
+  end
+end

data/spec/factories/projects.rb

@@ -0,0 +1,15 @@
+FactoryBot.define do
+  factory :project, class: Patch::Project do
+    sequence(:id) { |n| n }
+    production { false }
+    name { "New Project" }
+    description { "New Descirption" }
+    type { "biomass" }
+    country { "DK" }
+    developer { "Danish Developer" }
+    photos { [] }
+    average_price_per_tonne_cents_usd { 120 }
+    remaining_mass_g { 1_000 }
+    standard { 'european_biochar_certificate' }
+  end
+end

data/spec/integration/estimates_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe 'Estimates Integration' do
   before do
     Patch.configure do |config|
-      config.access_token = ENV['PATCH_RUBY_API_KEY']
+      config.access_token = ENV['SANDBOX_API_KEY']
     end
   end
 
@@ -25,14 +25,58 @@ RSpec.describe 'Estimates Integration' do
     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
+  it 'supports creating flight estimates' do
+    distance_m = 10_000_000
+    flight_estimate = Patch::Estimate.create_flight_estimate(
+      distance_m: distance_m,
+      create_order: false
+    )
+
+    expect(flight_estimate.data.type).to eq 'flight'
+    expect(flight_estimate.data.mass_g).to eq 1_031_697
+  end
+
+  it 'supports creating vehicle estimates' do
+    distance_m = 10_000
+    make = "Toyota"
+    model = "Corolla"
+    year = 2000
+
+    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
+      distance_m: distance_m,
+      make: make,
+      model: model,
+      year: year,
+      create_order: false
+    )
+
+    expect(vehicle_estimate.data.type).to eq 'vehicle'
+    expect(vehicle_estimate.data.mass_g).to eq 5_500
+  end
+
+  it 'supports creating vehicle estimates with partial information' do
+    distance_m = 10_000
+
+    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
+      distance_m: distance_m,
+      create_order: false
+    )
+
+    expect(vehicle_estimate.data.type).to eq 'vehicle'
+    expect(vehicle_estimate.data.mass_g).to eq 2_132
+  end
+
+  it 'supports creating shipping estimates' do
+    distance_m = 100_000_000
+    package_mass_g = 10_000
+    create_estimate_response = Patch::Estimate.create_shipping_estimate(
+      distance_m: distance_m,
+      package_mass_g: package_mass_g,
+      transportation_method: 'rail',
+      create_order: false
+    )
 
-    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)
+    expect(create_estimate_response.data.type).to eq 'shipping'
+    expect(create_estimate_response.data.mass_g).to eq 12_431
   end
 end

data/spec/integration/orders_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe 'Orders Integration' do
   before do
     Patch.configure do |config|
-      config.access_token = ENV['PATCH_RUBY_API_KEY']
+      config.access_token = ENV['SANDBOX_API_KEY']
     end
   end
 
@@ -26,14 +26,51 @@ RSpec.describe 'Orders Integration' do
   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
+    retrieve_project_response = Patch::Project.retrieve_project(
+      Constants::BIOMASS_TEST_PROJECT_ID
+    )
 
-    create_order_response = Patch::Order.create_order(mass_g: 100, project_id: project_id)
+    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(100)
+    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 create with a total price' do
+    retrieve_project_response = Patch::Project.retrieve_project(
+      Constants::BIOMASS_TEST_PROJECT_ID
+    )
+
+    project_id = retrieve_project_response.data.id
+    total_price_cents_usd = 5_00
+
+    create_order_response = Patch::Order.create_order(
+      total_price_cents_usd: total_price_cents_usd,
+      project_id: project_id
+    )
+
+    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_00_000)
+    expect(order.price_cents_usd).not_to be_empty
+    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

data/spec/integration/preferences_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe 'Preferences Integration' do
   before do
     Patch.configure do |config|
-      config.access_token = ENV['PATCH_RUBY_API_KEY']
+      config.access_token = ENV['SANDBOX_API_KEY']
     end
   end
 
@@ -10,8 +10,12 @@ RSpec.describe 'Preferences Integration' do
     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
+    begin
+      create_preference_response = Patch::Preference.create_preference(project_id: project_id)
+      preference_id = create_preference_response.data.id
+    rescue => Patch::ApiError
+      preference_id = Patch::Preference.retrieve_preferences().data.first.id
+    end
 
     retrieve_preference_response = Patch::Preference.retrieve_preference(preference_id)
     expect(retrieve_preference_response.data.id).to eq preference_id

data/spec/integration/projects_spec.rb

@@ -1,6 +1,6 @@
 RSpec.describe 'Projects Integration' do
   Patch.configure do |config|
-    config.access_token = ENV['PATCH_RUBY_API_KEY']
+    config.access_token = ENV['SANDBOX_API_KEY']
   end
 
   it 'supports retrieve and list' do
@@ -22,6 +22,26 @@ RSpec.describe 'Projects Integration' do
     expect(retrieve_project_response.data.id).to eq project_id
   end
 
+  it 'supports filtering projects' do
+    country = 'US'
+    projects = Patch::Project.retrieve_projects(country: country)
+    projects.data.map do |project|
+      expect(project.country).to eq country
+    end
+
+    type = 'dac'
+    projects = Patch::Project.retrieve_projects(type: type)
+    projects.data.map do |project|
+      expect(project.type).to eq type
+    end
+
+    minimum_available_mass = 100
+    projects = Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
+    projects.data.map do |project|
+      expect(project.remaining_mass_g >= minimum_available_mass).to be true
+    end
+  end
+
   describe 'returned fields' do
     before do
       @project = Patch::Project.retrieve_projects(page: 1).data.first

data/spec/models/allocation_spec.rb

@@ -20,18 +20,25 @@ require 'date'
 describe 'Allocation' do
   before do
     # run before each test
-    @instance = Patch::Allocation.new
+    @instance = build(:allocation)
   end
 
   after do
     # run after each test
   end
 
+  it_behaves_like "a generated class" do
+    let(:instance) { @instance }
+    let(:instance_hash) { { id: @instance.id, mass_g: @instance.mass_g, production: @instance.production } }
+    let(:nullable_properties) { Set.new }
+  end
+
   describe 'test an instance of Allocation' do
     it 'should create an instance of Allocation' do
       expect(@instance).to be_instance_of(Patch::Allocation)
     end
   end
+
   describe 'test attribute "id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers