patch_ruby 1.0.0.pre → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adcc2ae16ffd8f1fae30c7231ea100282a46b9cb59fa04ef855d37b3c0269b7e
-  data.tar.gz: 87c2e5a75eec03a3d05ccca1bc74201e658f3d1bf1a0eec3759b7df3c6815c77
+  metadata.gz: 2cc157169de2e66eca8ad5c41897f0345f9bd9286bf8ee62ab6c1040a327d3ff
+  data.tar.gz: 5960f6ea41e96264a1293c6b40531817afcd810dd9e5a36988750d94a042c34b
 SHA512:
-  metadata.gz: 0d8c3b806824a51b72215cab36372c1608e46c02b3e6ea007f060871da0c3e22e943edffc7484cbe9a9d551685bedd3e14e2eb35b3655e38dd6cfec8f9abcca6
-  data.tar.gz: b66e6323bfa7932d43d3865b28bc9e09d3cac9a14daa5177fe7a0c1bc5355403e64aed6cee1ba126c5c1fcf3b7c01152dd25408cb7add2742ddf07e20977c129
+  metadata.gz: 7053e90b8e96ab75c3c3563146adb3cafa62c370e8c6bf429c7c0ff5e8d90f5020603d4ffb90b63847fd8821e47f5c47ccff1eace9f02734aa40e9053421597f
+  data.tar.gz: 589fd1ec70c6ac629bc77d4249d82b0b17205d465909990f8c86992792a661ca972cfa32e666e0a1807c1dff94807d13b9e7c2c293e2becf15bf006a54a2f5af

data/CHANGELOG.md

@@ -0,0 +1,69 @@
+# 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.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,6 +5,5 @@ gemspec
 group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
-  gem 'rubocop', '~> 0.66.0'
-  gem 'vcr', '~> 6.0'
+  gem 'rubocop'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.0.0.pre)
+    patch_ruby (1.2.4)
       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,19 +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)
-    vcr (6.0.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -65,8 +67,7 @@ DEPENDENCIES
   pry-byebug
   rake (~> 13.0.1)
   rspec (~> 3.6, >= 3.6.0)
-  rubocop (~> 0.66.0)
-  vcr (~> 6.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
+# 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 detailed documentation and examples, see the [Patch API docs](https://www.usepatch.com).
+For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/)
 
 ## Installation
 
@@ -29,26 +30,154 @@ gem install patch_ruby
 
 ## Usage
 
+### Configuration
+
 After installing the gem, you'll have to configure it with your API key which is available from the API key page in the Patch dashboard:
 ```ruby
 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
 ```
 
-Once configured, you can test it out:
+### 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.
+
+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
-begin
-  orders_response = Patch::Order.retrieve_orders
-
-  orders_response.data.each do |order|
-    puts "Order ID: #{order.id}, Order State: #{order.state}"
-  end
-# Rescue from any Patch API errors
-rescue Patch::ApiError => e
-  puts "Failed to retrieve Orders with status code #{e.code}: #{e.message}"
-end
+# 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)
+
+# Place an order
+order_id = 'ord_test_1234' # Pass in the order's id
+Patch::Order.place_order(order_id)
+
+# Cancel an order
+order_id = 'ord_test_1234' # Pass in the order's id
+Patch::Order.cancel_order(order_id)
+
+# Retrieve a list of orders
+page = 1 # Pass in which page of orders you'd like
+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/#/?id=estimates)
+
+#### Examples
+```ruby
+# Create an estimate
+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)
+
+# Retrieve a list of estimates
+page = 1 # Pass in which page of estimates you'd like
+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/#/?id=projects)
+
+#### Examples
+```ruby
+# Retrieve a project
+project_id = 'pro_test_1234' # Pass in the project's ID
+Patch::Project.retrieve_project(project_id)
+
+# Retrieve a list of projects
+page = 1 # Pass in which page of projects you'd like
+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](https://dashboard.usepatch.com/projects).
+
+[API Reference](https://docs.usepatch.com/#/?id=preferences)
+
+#### Examples
+```ruby
+# Create a preference
+project_id = 'pro_test_1234' # Pass in the project_id for your preference
+Patch::Preference.create_preference(project_id: project_id)
+
+# Retrieve a preference
+preference_id = 'pre_test_1234' # Pass in the preferences's id
+Patch::Preference.retrieve_preference(preference_id)
+
+# Delete a preference
+preference_id = 'pre_test_1234' # Pass in the preferences's id
+Patch::Preference.delete_preference(preference_id)
+
+# Retrieve a list of preferences
+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

@@ -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?
@@ -69,6 +77,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 +92,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 +133,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