patch_ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c502af4271525d9883ffe131279f065edd0a089adcb0acc104271ee427e86a
-  data.tar.gz: 0ec3666b9e93a7ad36a810c3d07ed53e1a46162eb566c04f473a572646881405
+  metadata.gz: 7d57ecb3d4eed4573df5b34a2fe8b15abff918db6d50343d483a94daeb832ef0
+  data.tar.gz: 01ef9aced2b39b3fc83e4139682bf2ef4671cd5a1cf22c04486bb5005a8fae50
 SHA512:
-  metadata.gz: bcd3e4e634cb5faeeedcc9d3516b075858738d43cb8c1565000b15f95f2539a60d28e48df695030c31499fbeb83e06540a7f485fff4ddc27786ff01028795a9f
-  data.tar.gz: eb808b4ca051b0922ffbcb9a98cd50be35795d0beaa01d3bc0811cf39eca0744dc249a4cd289e98761bb1e30673b880eabc135262e0008ac24c7421880a08013
+  metadata.gz: 915adff1e3f63bd96b7cf1c360914faa8f2bb4d901e8960c459c0f74134385c72906f5eb9f06d4d51cccdc023b01a618c1a438a049b8fa1f39e4373682ec711a
+  data.tar.gz: 3f16c440a5d2e67c4dc864605d6201b9fb10f0c6c28fd10b821b76758b36b8a319a990f124218515265621550f3db273bd75359b6a4579af3bb132b85d4b994f

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2020-08-19
+
+### Added
+
+- `project_id` optional field to `order` creation
+- `metadata` optional field to `order` creation
+- `project_id` optional field to `estimate` creation
+- changelog file
+
+## [1.0.0] - 2020-07-05
+
+### Added
+
+- This is the first official release of Patch's Ruby Gem.
+
+## [1.0.0.pre] - 2020-07-02
+
+### Added
+
+- Pre-release of v1 Gem
+- Adds support for Orders, Estimates, Projects and Preferences
+

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.0.0.pre)
+    patch_ruby (1.1.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -15,7 +15,6 @@ GEM
     ethon (0.12.0)
       ffi (>= 1.3.0)
     ffi (1.13.1)
-    jaro_winkler (1.5.4)
     json (2.3.1)
     method_source (1.0.0)
     parallel (1.19.2)
@@ -27,9 +26,10 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    psych (3.1.0)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -43,18 +43,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.66.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (0.88.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    unicode-display_width (1.5.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -64,7 +67,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 13.0.1)
   rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 0.66.0)
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,6 +1,7 @@
 # Patch Ruby SDK
 ![Test](https://github.com/patch-technology/patch-ruby/workflows/Test/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/patch_ruby.svg)](https://badge.fury.io/rb/patch_ruby)
+[![Discord](https://img.shields.io/discord/733029448558837792)](https://discord.gg/AU8543D)
 
 The official Ruby gem for the [Patch API](https://www.usepatch.com)
 
@@ -52,6 +53,14 @@ In Patch, orders represent a purchase of carbon offsets or negative emissions by
 mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
 Patch::Order.create_order(mass_g: mass)
 
+## You can also specify a project-id field (optional) to be used instead of the preferred one
+project_id = 'pro_test_1234' # Pass in the project's ID
+Patch::Order.create_order(mass_g: mass, project_id: project_id)
+
+## Orders also accept a metadata field (optional)
+metadata = {user: "john doe"}
+Patch::Order.create_order(mass_g: mass, metadata: metadata)
+
 # Retrieve an order
 order_id = 'ord_test_1234' # Pass in the order's id
 Patch::Order.retrieve_order(order_id)
@@ -80,6 +89,10 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
 Patch::Estimate.create_mass_estimate(mass_g: mass)
 
+## You can also specify a project-id field (optional) to be used instead of the preferred one
+project_id = 'pro_test_1234' # Pass in the project's ID
+Patch::Estimate.create_mass_estimate(mass_g: mass, project_id: project_id)
+
 # Retrieve an estimate
 estimate_id = 'est_test_1234'
 Patch::Estimate.retrieve_estimate(estimate_id)
@@ -106,7 +119,7 @@ Patch::Project.retrieve_projects(page: page)
 ```
 
 ### Preferences
-Preferences are how you route your orders in Patch. If you don't have a preference, Patch will allocate your order to the least expensive option. If you do have a preference, all of your orders will be sent to that project. You can set your preferences via API, or through the [Patch Dashboard](dashboard.usepatch.com/projects).
+Preferences are how you route your orders in Patch. If you don't have a preference, Patch will allocate your order to the least expensive option. If you do have a preference, all of your orders will be sent to that project. You can set your preferences via API, or through the [Patch Dashboard](https://dashboard.usepatch.com/projects).
 
 [API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1preferences/post)
 
@@ -128,3 +141,30 @@ Patch::Preference.delete_preference(preference_id)
 page = 1 # Pass in which page of preferences you'd like
 Patch::Preference.retrieve_preferences(page: page)
 ```
+
+## Development
+
+To build the gem locally, run:
+```
+$ gem build patch_ruby.gemspec
+```
+
+This will create a .gem file. To install the local gem:
+```
+$ gem install patch_ruby-1.x.x.gem
+```
+
+Install dependencies:
+```
+$ bundle install
+```
+
+Set up required environment variables:
+```
+$ export PATCH_RUBY_API_KEY=<SANDBOX API KEY>
+```
+
+Run tests:
+```
+$ bundle exec rspec
+```

data/lib/patch_ruby/models/allocation.rb

@@ -81,12 +81,27 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @production.nil?
+        invalid_properties.push('invalid value for "production", production cannot be nil.')
+      end
+
+      if @mass_g.nil?
+        invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @production.nil?
+      return false if @mass_g.nil?
       true
     end
 

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -16,17 +16,21 @@ module Patch
   class CreateMassEstimateRequest
     attr_accessor :mass_g
 
+    attr_accessor :project_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'mass_g' => :'mass_g'
+        :'mass_g' => :'mass_g',
+        :'project_id' => :'project_id'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'mass_g' => :'Integer'
+        :'mass_g' => :'Integer',
+        :'project_id' => :'String'
       }
     end
 
@@ -59,6 +63,10 @@ module Patch
       if attributes.key?(:'mass_g')
         self.mass_g = attributes[:'mass_g']
       end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -84,7 +92,8 @@ module Patch
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          mass_g == o.mass_g
+          mass_g == o.mass_g &&
+          project_id == o.project_id
     end
 
     # @see the `==` method
@@ -96,7 +105,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g].hash
+      [mass_g, project_id].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/create_order_request.rb

@@ -16,17 +16,25 @@ module Patch
   class CreateOrderRequest
     attr_accessor :mass_g
 
+    attr_accessor :project_id
+
+    attr_accessor :metadata
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'mass_g' => :'mass_g'
+        :'mass_g' => :'mass_g',
+        :'project_id' => :'project_id',
+        :'metadata' => :'metadata'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'mass_g' => :'Integer'
+        :'mass_g' => :'Integer',
+        :'project_id' => :'String',
+        :'metadata' => :'Object'
       }
     end
 
@@ -59,6 +67,14 @@ module Patch
       if attributes.key?(:'mass_g')
         self.mass_g = attributes[:'mass_g']
       end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -84,7 +100,9 @@ module Patch
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          mass_g == o.mass_g
+          mass_g == o.mass_g &&
+          project_id == o.project_id &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -96,7 +114,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g].hash
+      [mass_g, project_id, metadata].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/estimate.rb

@@ -89,12 +89,27 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @production.nil?
+        invalid_properties.push('invalid value for "production", production cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @production.nil?
+      return false if @type.nil?
       true
     end
 

data/lib/patch_ruby/models/order.rb

@@ -28,6 +28,8 @@ module Patch
 
     attr_accessor :allocations
 
+    attr_accessor :metadata
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -59,7 +61,8 @@ module Patch
         :'state' => :'state',
         :'allocation_state' => :'allocation_state',
         :'price_cents_usd' => :'price_cents_usd',
-        :'allocations' => :'allocations'
+        :'allocations' => :'allocations',
+        :'metadata' => :'metadata'
       }
     end
 
@@ -72,7 +75,8 @@ module Patch
         :'state' => :'String',
         :'allocation_state' => :'String',
         :'price_cents_usd' => :'String',
-        :'allocations' => :'Array<Allocation>'
+        :'allocations' => :'Array<Allocation>',
+        :'metadata' => :'Object'
       }
     end
 
@@ -131,22 +135,61 @@ module Patch
           self.allocations = value
         end
       end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @mass_g.nil?
+        invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
+      end
+
+      if @production.nil?
+        invalid_properties.push('invalid value for "production", production cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      if @allocation_state.nil?
+        invalid_properties.push('invalid value for "allocation_state", allocation_state cannot be nil.')
+      end
+
+      if @allocations.nil?
+        invalid_properties.push('invalid value for "allocations", allocations cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @mass_g.nil?
+      return false if @production.nil?
+      return false if @state.nil?
       state_validator = EnumAttributeValidator.new('String', ["draft", "placed", "complete", "cancelled"])
       return false unless state_validator.valid?(@state)
+      return false if @allocation_state.nil?
       allocation_state_validator = EnumAttributeValidator.new('String', ["pending", "partially_allocated", "allocated"])
       return false unless allocation_state_validator.valid?(@allocation_state)
+      return false if @allocations.nil?
+      return false if @metadata.nil?
       true
     end
 
@@ -181,7 +224,8 @@ module Patch
           state == o.state &&
           allocation_state == o.allocation_state &&
           price_cents_usd == o.price_cents_usd &&
-          allocations == o.allocations
+          allocations == o.allocations &&
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -193,7 +237,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, mass_g, production, state, allocation_state, price_cents_usd, allocations].hash
+      [id, mass_g, production, state, allocation_state, price_cents_usd, allocations, metadata].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/preference.rb

@@ -81,12 +81,27 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @allocation_percentage.nil?
+        invalid_properties.push('invalid value for "allocation_percentage", allocation_percentage cannot be nil.')
+      end
+
+      if @project.nil?
+        invalid_properties.push('invalid value for "project", project cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @allocation_percentage.nil?
+      return false if @project.nil?
       true
     end
 

data/lib/patch_ruby/models/project.rb

@@ -22,15 +22,33 @@ module Patch
 
     attr_accessor :description
 
-    attr_accessor :country
+    attr_accessor :type
 
-    attr_accessor :longitude
+    attr_accessor :country
 
-    attr_accessor :latitude
+    attr_accessor :developer
 
-    attr_accessor :verifier
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    attr_accessor :developer
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -39,10 +57,8 @@ module Patch
         :'production' => :'production',
         :'name' => :'name',
         :'description' => :'description',
+        :'type' => :'type',
         :'country' => :'country',
-        :'longitude' => :'longitude',
-        :'latitude' => :'latitude',
-        :'verifier' => :'verifier',
         :'developer' => :'developer'
       }
     end
@@ -54,10 +70,8 @@ module Patch
         :'production' => :'Boolean',
         :'name' => :'String',
         :'description' => :'String',
+        :'type' => :'String',
         :'country' => :'String',
-        :'longitude' => :'Float',
-        :'latitude' => :'Float',
-        :'verifier' => :'String',
         :'developer' => :'String'
       }
     end
@@ -104,20 +118,12 @@ module Patch
         self.description = attributes[:'description']
       end
 
-      if attributes.key?(:'country')
-        self.country = attributes[:'country']
-      end
-
-      if attributes.key?(:'longitude')
-        self.longitude = attributes[:'longitude']
-      end
-
-      if attributes.key?(:'latitude')
-        self.latitude = attributes[:'latitude']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
-      if attributes.key?(:'verifier')
-        self.verifier = attributes[:'verifier']
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
       end
 
       if attributes.key?(:'developer')
@@ -129,15 +135,57 @@ module Patch
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @production.nil?
+        invalid_properties.push('invalid value for "production", production cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @developer.nil?
+        invalid_properties.push('invalid value for "developer", developer cannot be nil.')
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @id.nil?
+      return false if @production.nil?
+      return false if @name.nil?
+      return false if @description.nil?
+      type_validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "soil"])
+      return false unless type_validator.valid?(@type)
+      return false if @country.nil?
+      return false if @developer.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "soil"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -147,10 +195,8 @@ module Patch
           production == o.production &&
           name == o.name &&
           description == o.description &&
+          type == o.type &&
           country == o.country &&
-          longitude == o.longitude &&
-          latitude == o.latitude &&
-          verifier == o.verifier &&
           developer == o.developer
     end
 
@@ -163,7 +209,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, name, description, country, longitude, latitude, verifier, developer].hash
+      [id, production, name, description, type, country, developer].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module Patch
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 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/integration/estimates_spec.rb

@@ -1,10 +1,11 @@
 RSpec.describe 'Estimates Integration' do
-  it 'supports create, retrieve and list' do
-    # Configure the Patch gem
+  before do
     Patch.configure do |config|
       config.access_token = ENV['PATCH_RUBY_API_KEY']
     end
+  end
 
+  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
 
@@ -23,4 +24,15 @@ 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
+
+    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

@@ -25,6 +25,28 @@ RSpec.describe 'Orders Integration' do
     expect(orders.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_order_response = Patch::Order.create_order(mass_g: 100, 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)
+  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

data/spec/models/allocation_spec.rb

@@ -49,5 +49,4 @@ describe 'Allocation' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/create_mass_estimate_request_spec.rb

@@ -37,5 +37,4 @@ describe 'CreateMassEstimateRequest' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/create_order_request_spec.rb

@@ -37,5 +37,4 @@ describe 'CreateOrderRequest' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/create_preference_request_spec.rb

@@ -37,5 +37,4 @@ describe 'CreatePreferenceRequest' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/error_response_spec.rb

@@ -49,5 +49,4 @@ describe 'ErrorResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/estimate_list_response_spec.rb

@@ -55,5 +55,4 @@ describe 'EstimateListResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/estimate_response_spec.rb

@@ -49,5 +49,4 @@ describe 'EstimateResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/estimate_spec.rb

@@ -55,5 +55,4 @@ describe 'Estimate' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/meta_index_object_spec.rb

@@ -43,5 +43,4 @@ describe 'MetaIndexObject' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/order_list_response_spec.rb

@@ -55,5 +55,4 @@ describe 'OrderListResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/order_response_spec.rb

@@ -49,5 +49,4 @@ describe 'OrderResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/order_spec.rb

@@ -81,5 +81,4 @@ describe 'Order' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/preference_list_response_spec.rb

@@ -55,5 +55,4 @@ describe 'PreferenceListResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/preference_response_spec.rb

@@ -49,5 +49,4 @@ describe 'PreferenceResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/preference_spec.rb

@@ -49,5 +49,4 @@ describe 'Preference' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/project_list_response_spec.rb

@@ -55,5 +55,4 @@ describe 'ProjectListResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/project_response_spec.rb

@@ -49,5 +49,4 @@ describe 'ProjectResponse' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

data/spec/models/project_spec.rb

@@ -85,5 +85,4 @@ describe 'Project' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -77,6 +77,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -162,32 +163,32 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Patch API
 test_files:
+- spec/api/preferences_api_spec.rb
 - spec/api/orders_api_spec.rb
-- spec/api/estimates_api_spec.rb
 - spec/api/projects_api_spec.rb
-- spec/api/preferences_api_spec.rb
+- spec/api/estimates_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/integration/orders_spec.rb
 - spec/integration/preferences_spec.rb
-- spec/integration/estimates_spec.rb
 - spec/integration/projects_spec.rb
-- spec/models/create_mass_estimate_request_spec.rb
-- spec/models/order_response_spec.rb
-- spec/models/order_list_response_spec.rb
-- spec/models/order_spec.rb
-- spec/models/create_preference_request_spec.rb
-- spec/models/error_response_spec.rb
-- spec/models/preference_spec.rb
-- spec/models/preference_list_response_spec.rb
+- spec/integration/estimates_spec.rb
+- spec/integration/orders_spec.rb
+- spec/models/estimate_response_spec.rb
 - spec/models/project_list_response_spec.rb
-- spec/models/create_order_request_spec.rb
+- spec/models/create_preference_request_spec.rb
+- spec/models/project_response_spec.rb
+- spec/models/allocation_spec.rb
+- spec/models/estimate_spec.rb
 - spec/models/meta_index_object_spec.rb
 - spec/models/estimate_list_response_spec.rb
-- spec/models/preference_response_spec.rb
-- spec/models/estimate_spec.rb
-- spec/models/estimate_response_spec.rb
-- spec/models/project_response_spec.rb
 - spec/models/project_spec.rb
-- spec/models/allocation_spec.rb
+- spec/models/order_list_response_spec.rb
+- spec/models/create_mass_estimate_request_spec.rb
+- spec/models/preference_spec.rb
+- spec/models/error_response_spec.rb
+- spec/models/order_response_spec.rb
+- spec/models/preference_response_spec.rb
+- spec/models/order_spec.rb
+- spec/models/create_order_request_spec.rb
+- spec/models/preference_list_response_spec.rb
 - spec/spec_helper.rb