patch_ruby 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cc157169de2e66eca8ad5c41897f0345f9bd9286bf8ee62ab6c1040a327d3ff
-  data.tar.gz: 5960f6ea41e96264a1293c6b40531817afcd810dd9e5a36988750d94a042c34b
+  metadata.gz: 034d244a5779a4ba17a6cdd074f0099905f190ac25fa274b8efc37757b5f6cfc
+  data.tar.gz: acc6a37eb68e11f88e5092ffe666f962d14798d317761e55bf9777707615fb41
 SHA512:
-  metadata.gz: 7053e90b8e96ab75c3c3563146adb3cafa62c370e8c6bf429c7c0ff5e8d90f5020603d4ffb90b63847fd8821e47f5c47ccff1eace9f02734aa40e9053421597f
-  data.tar.gz: 589fd1ec70c6ac629bc77d4249d82b0b17205d465909990f8c86992792a661ca972cfa32e666e0a1807c1dff94807d13b9e7c2c293e2becf15bf006a54a2f5af
+  metadata.gz: c371f8237161ec6fd8be9ddd5e269dc73168718016a5dbc3d3e8a2dca62df9c334171eec45ba8645451c4ee1933b1089844e42fc1002569f43671bac9b01f849
+  data.tar.gz: 8d8c39a9380511af517ad1057da04f1e69997f994cded647d41c4adfe016ec65ac5a5ce73ccac1b5323ae91cf56a88de94736dab8b44d19336cd80a94d276331

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.2.5] - 2020-01-08
+
+### Fixed
+
+- 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
 
 ### Added

data/Gemfile

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

data/Gemfile.lock

@@ -1,22 +1,34 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.2.4)
+    patch_ruby (1.2.5)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 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)
-    json (2.3.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)

data/lib/patch_ruby/models/allocation.rb

@@ -14,10 +14,13 @@ require 'date'
 
 module Patch
   class Allocation
+    # A unique uid for the record. UIDs will be prepended by all_prod or all_test depending on the mode it was created in.
     attr_accessor :id
 
+    # A boolean indicating if this project is a production or test mode project.
     attr_accessor :production
 
+    # The amount (in grams) of allocated carbon offsets.
     attr_accessor :mass_g
 
     # 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/models/create_mass_estimate_request.rb

@@ -34,6 +34,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/models/create_order_request.rb

@@ -42,6 +42,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/models/create_preference_request.rb

@@ -30,6 +30,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/models/error_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("data")
+
+      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/models/estimate.rb

@@ -14,12 +14,16 @@ require 'date'
 
 module Patch
   class Estimate
+    # A unique uid for the record. UIDs will be prepended by est_prod or est_test depending on the mode it was created in.
     attr_accessor :id
 
+    # A boolean indicating if this estimate is a production or test mode estimate.
     attr_accessor :production
 
+    # The type of estimate. Currently mass is the only supported value.
     attr_accessor :type
 
+    # An object returning the order associated with this estimate. See the [Order section](/?id=orders) for the full schema.
     attr_accessor :order
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -42,6 +46,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("order")
+
+      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
@@ -226,7 +239,7 @@ module Patch
           is_nullable = self.class.openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
-        
+
         hash[param] = _to_hash(value)
       end
       hash

data/lib/patch_ruby/models/estimate_list_response.rb

@@ -42,6 +42,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      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/models/estimate_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      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/models/meta_index_object.rb

@@ -34,6 +34,17 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("prev_page")
+
+      nullable_properties.add("next_page")
+
+      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/models/order.rb

@@ -14,22 +14,31 @@ require 'date'
 
 module Patch
   class Order
+    # A unique uid for the record. UIDs will be prepended by ord_prod or ord_test depending on the mode it was created in.
     attr_accessor :id
 
+    # The amount of carbon offsets in grams purchased through this order.
     attr_accessor :mass_g
 
+    # A boolean indicating if this order is a production or test mode order.
     attr_accessor :production
 
+    # The current state of the order.
     attr_accessor :state
 
+    # The current state of the allocated carbon offsets of the order.
     attr_accessor :allocation_state
 
+    # The total price in cents USD of the carbon offsets purchased through this order.
     attr_accessor :price_cents_usd
 
+    # The Patch Fee in cents USD for this order.
     attr_accessor :patch_fee_cents_usd
 
+    # An array containing the inventory allocations for this order.
     attr_accessor :allocations
 
+    # An optional JSON object containing metadata for this order.
     attr_accessor :metadata
 
     class EnumAttributeValidator
@@ -84,6 +93,17 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("price_cents_usd")
+
+      nullable_properties.add("patch_fee_cents_usd")
+
+      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/models/order_list_response.rb

@@ -42,6 +42,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      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/models/order_response.rb

@@ -38,6 +38,15 @@ module Patch
       }
     end
 
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("error")
+
+      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/models/photo.rb

@@ -16,20 +16,31 @@ module Patch
   class Photo
     attr_accessor :url
 
+    attr_accessor :id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'url' => :'url'
+        :'url' => :'url',
+        :'id' => :'id'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'url' => :'String'
+        :'url' => :'String',
+        :'id' => :'String'
       }
     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
@@ -69,6 +80,10 @@ module Patch
         invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -76,6 +91,7 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @url.nil?
+      return false if @id.nil?
       true
     end
 
@@ -84,7 +100,8 @@ module Patch
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          url == o.url
+          url == o.url &&
+          id == o.id
     end
 
     # @see the `==` method
@@ -96,7 +113,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url].hash
+      [url, id].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/preference.rb

@@ -14,10 +14,13 @@ require 'date'
 
 module Patch
   class Preference
+    # A unique uid for the record. UIDs will be prepended by pre_prod or pre_test depending on the mode it was created in.
     attr_accessor :id
 
+    # Percentage of total purchased offsets that should go to a project. Default is 100%.
     attr_accessor :allocation_percentage
 
+    # An object returning the Project record this Preference is associated with. See the [Project section](/?id=projects) for the full schema.
     attr_accessor :project
 
     # 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