patch_ruby 1.0.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c502af4271525d9883ffe131279f065edd0a089adcb0acc104271ee427e86a
-  data.tar.gz: 0ec3666b9e93a7ad36a810c3d07ed53e1a46162eb566c04f473a572646881405
+  metadata.gz: 034d244a5779a4ba17a6cdd074f0099905f190ac25fa274b8efc37757b5f6cfc
+  data.tar.gz: acc6a37eb68e11f88e5092ffe666f962d14798d317761e55bf9777707615fb41
 SHA512:
-  metadata.gz: bcd3e4e634cb5faeeedcc9d3516b075858738d43cb8c1565000b15f95f2539a60d28e48df695030c31499fbeb83e06540a7f485fff4ddc27786ff01028795a9f
-  data.tar.gz: eb808b4ca051b0922ffbcb9a98cd50be35795d0beaa01d3bc0811cf39eca0744dc249a4cd289e98761bb1e30673b880eabc135262e0008ac24c7421880a08013
+  metadata.gz: c371f8237161ec6fd8be9ddd5e269dc73168718016a5dbc3d3e8a2dca62df9c334171eec45ba8645451c4ee1933b1089844e42fc1002569f43671bac9b01f849
+  data.tar.gz: 8d8c39a9380511af517ad1057da04f1e69997f994cded647d41c4adfe016ec65ac5a5ce73ccac1b5323ae91cf56a88de94736dab8b44d19336cd80a94d276331

data/CHANGELOG.md

@@ -0,0 +1,78 @@
+# 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.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
+
+- `total_price_cents_usd` field to `orders`
+- allows users to create an order by total price
+
+### Changed
+
+- order creation requires either `mass_g` or `total_price_cents_usd`, but not both
+
+## [1.2.3] - 2020-10-05
+
+### Added
+
+- `patch_fee_cents_usd` field to `orders`
+
+## [1.2.2] - 2020-09-18
+
+### Added
+
+- `photos` field to `projects`
+
+## [1.2.1] - 2020-09-18
+
+### Fixed
+
+- Fixing an issue related to the OpenApi code generator.
+
+## [1.2.0] - 2020-09-17
+
+### Added
+
+- `average_price_per_tonne_cents_usd` field to `projects`
+- `remaining_mass_g` field to `projects`
+- `standard` field to `projects`
+- validations on `mass_g` field (has to be greater than 1 and less than 2,000,000,000).
+
+## [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,6 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
-  gem 'rubocop', '~> 0.66.0'
+  gem 'rubocop'
+  gem 'factory_bot'
 end

data/Gemfile.lock

@@ -1,23 +1,34 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.0.0.pre)
+    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)
-    jaro_winkler (1.5.4)
-    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)
@@ -27,9 +38,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,28 +55,35 @@ 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)
+    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)
   rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 0.66.0)
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/Makefile

@@ -0,0 +1,10 @@
+SHELL = /bin/bash
+
+build:
+	rubocop -a && \
+	bundle install
+
+test:
+	bundle exec rspec
+
+.PHONY: build test

data/README.md

@@ -1,11 +1,12 @@
 # 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)
 
 ## Documentation
-For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml)
+For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/)
 
 ## Installation
 
@@ -37,21 +38,42 @@ require 'patch_ruby'
 
 Patch.configure do |config|
   # Configure the Patch gem with your API key here
-  config.access_token = ENV['PATCH_RUBY_API_KEY']
+  config.access_token = ENV['SANDBOX_API_KEY']
 end
 ```
 
 ### Orders
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
 
-[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1orders/get)
+In Patch, orders represent a purchase of carbon offsets or negative emissions by mass.
+Place orders directly if you know the amount of carbon dioxide you would like to sequester.
+If you do not know how much to purchase, use an estimate.
+You can also create an order with a maximum desired price, and we'll allocate enough mass to
+fulfill the order for you.
+
+[API Reference](https://docs.usepatch.com/#/?id=orders)
 
 #### Examples
 ```ruby
-# Create an order
+# Create an order - you can create an order
+# providing either mass_g or total_price_cents_usd, but not both
+
+# Create order with mass
 mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
 Patch::Order.create_order(mass_g: mass)
 
+# Create an order with maximum total price
+total_price_cents_usd = 5_00 # Pass in the total price in cents (i.e. 5 dollars)
+Patch::Order.create_order(total_price_cents_usd: total_price_cents_usd)
+
+## 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)
@@ -72,7 +94,7 @@ Patch::Order.retrieve_orders(page: page)
 ### Estimates
 Estimates allow API users to get a quote for the cost of compensating a certain amount of CO2. When creating an estimate, an order in the `draft` state will also be created, reserving the allocation of a project for 5 minutes. If you don't place your draft order within those 5 minutes, the order will automatically be cancelled.
 
-[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1estimates/get)
+[API Reference](https://docs.usepatch.com/#/?id=estimates)
 
 #### Examples
 ```ruby
@@ -80,6 +102,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)
@@ -92,7 +118,7 @@ Patch::Estimate.retrieve_estimates(page: page)
 ### Projects
 Projects are the ways Patch takes CO2 out of the air. They can represent reforestation, enhanced weathering, direct air carbon capture, etc. When you place an order via Patch, it is allocated to a project.
 
-[API Reference](https://docs.usepatch.com/docs/patch/openapi/v1/swagger.yaml/paths/~1v1~1projects/get)
+[API Reference](https://docs.usepatch.com/#/?id=projects)
 
 #### Examples
 ```ruby
@@ -106,9 +132,9 @@ 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)
+[API Reference](https://docs.usepatch.com/#/?id=preferences)
 
 #### Examples
 ```ruby
@@ -128,3 +154,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 SANDBOX_API_KEY=<SANDBOX API KEY>
+```
+
+Run tests:
+```
+$ bundle exec rspec
+```

data/lib/patch_ruby.rb

@@ -29,12 +29,14 @@ require 'patch_ruby/models/meta_index_object'
 require 'patch_ruby/models/order'
 require 'patch_ruby/models/order_list_response'
 require 'patch_ruby/models/order_response'
+require 'patch_ruby/models/photo'
 require 'patch_ruby/models/preference'
 require 'patch_ruby/models/preference_list_response'
 require 'patch_ruby/models/preference_response'
 require 'patch_ruby/models/project'
 require 'patch_ruby/models/project_list_response'
 require 'patch_ruby/models/project_response'
+require 'patch_ruby/models/standard'
 
 # APIs
 require 'patch_ruby/api/estimates_api'

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
@@ -81,12 +91,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,20 +16,31 @@ 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
 
+    # 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
@@ -59,6 +70,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?
@@ -69,6 +84,14 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", mass_g cannot be nil.')
       end
 
+      if @mass_g > 2000000000
+        invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
+      end
+
+      if @mass_g < 1
+        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 1.')
+      end
+
       invalid_properties
     end
 
@@ -76,15 +99,36 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if @mass_g.nil?
+      return false if @mass_g > 2000000000
+      return false if @mass_g < 1
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] mass_g Value to be assigned
+    def mass_g=(mass_g)
+      if mass_g.nil?
+        fail ArgumentError, 'mass_g cannot be nil'
+      end
+
+      if mass_g > 2000000000
+        fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
+      end
+
+      if mass_g < 1
+        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 1.'
+      end
+
+      @mass_g = mass_g
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     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 +140,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