Add factories; refactor specs to services

Author: biglovisa

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixes [issues/5](https://github.com/patch-technology/patch-ruby/issues/5). Adds method `.openapi_nullable` which returns a set with all nullable properties. This method is referenced in `#to_hash` which returns a hash representation of the resource.
 - Removes non-deterministic integration spec that is creating an Estimate with a specific project-id. Since we do not control the test data (yet) and make queries against our Test projects, we cannot be sure that we will have offsets available for a project ID. Instead we can rely on Patch core specs to cover this.
 - Fixes a spec that was failing due to a Patch core change.
+- Add spec factories and refactor generated method specs to shared examples.
 
 ## [1.2.4] - 2020-10-14
 

Gemfile

@@ -6,4 +6,5 @@ group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop'
+  gem 'factory_bot'
 end

Gemfile.lock

@@ -8,15 +8,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     byebug (11.1.3)
     coderay (1.1.3)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.4.3)
     ethon (0.12.0)
       ffi (>= 1.3.0)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
     ffi (1.13.1)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
     json (2.4.1)
     method_source (1.0.0)
+    minitest (5.14.3)
     parallel (1.19.2)
     parser (2.7.1.4)
       ast (~> 2.4.1)
@@ -57,12 +69,16 @@ GEM
     ruby-progressbar (1.10.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.7.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  factory_bot
   patch_ruby!
   pry-byebug
   rake (~> 13.0.1)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

spec/models/allocation_spec.rb

@@ -20,13 +20,19 @@
 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)
@@ -50,10 +56,4 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
-  describe '.openapi_nullable' do
-    it 'returns a set with nullable properties' do
-      expect(Patch::Allocation.openapi_nullable).to be_empty
-    end
-  end
 end

spec/models/create_mass_estimate_request_spec.rb

@@ -20,13 +20,19 @@
 describe 'CreateMassEstimateRequest' do
   before do
     # run before each test
-    @instance = Patch::CreateMassEstimateRequest.new
+    @instance = build(:create_mass_estimate_request)
   end
 
   after do
     # run after each test
   end
 
+  it_behaves_like "a generated class" do
+    let(:instance) { @instance }
+    let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g } }
+    let(:nullable_properties) { Set.new }
+  end
+
   describe 'test an instance of CreateMassEstimateRequest' do
     it 'should create an instance of CreateMassEstimateRequest' do
       expect(@instance).to be_instance_of(Patch::CreateMassEstimateRequest)
@@ -37,10 +43,4 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
-  describe '.openapi_nullable' do
-    it 'returns a set with nullable properties' do
-      expect(Patch::CreateMassEstimateRequest.openapi_nullable).to be_empty
-    end
-  end
 end

spec/models/create_order_request_spec.rb

@@ -20,13 +20,19 @@
 describe 'CreateOrderRequest' do
   before do
     # run before each test
-    @instance = Patch::CreateOrderRequest.new
+    @instance = build(:create_order_request)
   end
 
   after do
     # run after each test
   end
 
+  it_behaves_like "a generated class" do
+    let(:instance) { @instance }
+    let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g, total_price_cents_usd: @instance.total_price_cents_usd, metadata: @instance.metadata } }
+    let(:nullable_properties) { Set.new }
+  end
+
   describe 'test an instance of CreateOrderRequest' do
     it 'should create an instance of CreateOrderRequest' do
       expect(@instance).to be_instance_of(Patch::CreateOrderRequest)
@@ -37,10 +43,4 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
-  describe '.openapi_nullable' do
-    it 'returns a set with nullable properties' do
-      expect(Patch::CreateOrderRequest.openapi_nullable).to be_empty
-    end
-  end
 end

spec/models/create_preference_request_spec.rb

@@ -20,27 +20,28 @@
 describe 'CreatePreferenceRequest' do
   before do
     # run before each test
-    @instance = Patch::CreatePreferenceRequest.new
+    @instance = build(:create_preference_request)
   end
 
   after do
     # run after each test
   end
 
+  it_behaves_like "a generated class" do
+    let(:instance) { @instance }
+    let(:instance_hash) { { project_id: @instance.project_id } }
+    let(:nullable_properties) { Set.new }
+  end
+
   describe 'test an instance of CreatePreferenceRequest' do
     it 'should create an instance of CreatePreferenceRequest' do
       expect(@instance).to be_instance_of(Patch::CreatePreferenceRequest)
     end
   end
+
   describe 'test attribute "project_id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
-  describe '.openapi_nullable' do
-    it 'returns a set with nullable properties' do
-      expect(Patch::CreatePreferenceRequest.openapi_nullable).to be_empty
-    end
-  end
 end

spec/models/error_response_spec.rb

@@ -20,13 +20,19 @@
 describe 'ErrorResponse' do
   before do
     # run before each test
-    @instance = Patch::ErrorResponse.new
+    @instance = build(:error_response)
   end
 
   after do
     # run after each test
   end
 
+  it_behaves_like "a generated class" do
+    let(:instance) { @instance }
+    let(:instance_hash) { { success: @instance.success, error: @instance.error, data: @instance.data } }
+    let(:nullable_properties) { Set.new(["data"]) }
+  end
+
   describe 'test an instance of ErrorResponse' do
     it 'should create an instance of ErrorResponse' do
       expect(@instance).to be_instance_of(Patch::ErrorResponse)
@@ -49,10 +55,4 @@
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
-  describe '.openapi_nullable' do
-    it 'returns a set with nullable properties' do
-      expect(Patch::ErrorResponse.openapi_nullable).to contain_exactly("data")
-    end
-  end
 end