patch_ruby 1.2.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5a1eec7fccc6caad29eefa746c0318b3ee7c2b52ff3694e999bb1bf8086595a
-  data.tar.gz: f3acf2fe8fdf86c68b9d4bce4b4e399e9137aae7414fac9e89f96ddecd8f25a5
+  metadata.gz: dad4b825fa4e046cac94a1672e5b89d5fc1edd0ab48e414d35449e71137a1b01
+  data.tar.gz: 8a23b9c1d27d6dd8b32da5f064e7aaef3bd4c2452d3b9e4934c2dd9877d97c6b
 SHA512:
-  metadata.gz: 5e21d7cb2d176d1b5620f1d44a1c2df35cdea882e888ec7a894dbeb1991734508fe54f2b9be71153022d5f29755925d2e06217f9c50c1405471bed819efd4ded
-  data.tar.gz: c10d3372f00070ede5a70b39fe248c5065d8e5fd8fb1ef890add6581fa6ab374487d8594728d437d8aacf34e4b9cba0c71c0de69c89e4eb0259750f55140e621
+  metadata.gz: ee4a8a1abc63aea00bff1b795340ab44bad333e539f89d39733d74d8645907796afdbc2a72f0ab93a84bdde82ec2d9dc825c8fe7ebd3715337fc82a606edab12
+  data.tar.gz: 96376448d26040c8ce8be567a9ff9110964f1fb380ab7852029274508ce2b9ab599a809f927918dd0661dc153f2eee6f03315f4486b3ce7d4ebadf76e08cc951

data/CHANGELOG.md

@@ -5,9 +5,50 @@ 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.5.0] - 2021-03-01
 
-## [1.2.3] - 2020-09-28
+### Changed
+
+- Changed base URL from https://api.usepatch.com to https://api.patch.io
+
+## [1.4.0] - 2021-02-15
+
+### Added
+
+- Adds Sustainable Development Goals (SDGs) field to projects
+- Adds filtering to Projects by country, type, minimum_available_mass
+
+### Changed
+
+- vehicle estimates now support optional `make`, `model` and `year` fields.
+
+## [1.3.0] - 2021-02-08
+
+### Added
+
+- Adds support for creating carbon emission estimates for flights, shipping, and vehicles. See the [docs](https://docs.patch.io/#/?id=estimates) for more information.
+
+## [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
 
@@ -55,4 +96,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Pre-release of v1 Gem
 - Adds support for Orders, Estimates, Projects and Preferences
-

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.3)
+    patch_ruby (1.4.0)
       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)
-    ffi (1.13.1)
-    json (2.3.1)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    ffi (1.14.2)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    json (2.5.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/README.md

@@ -1,31 +1,37 @@
 # 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)
+The official Ruby gem for the [Patch API](https://www.patch.io)
 
 ## Documentation
-For a complete API reference, check out [Patch's API Reference.](https://docs.usepatch.com/)
+
+For a complete API reference, check out [Patch's API Reference.](https://docs.patch.io/)
 
 ## Installation
 
 Add the gem to your Gemfile:
+
 ```ruby
 gem 'patch_ruby'
 ```
 
 Then run:
+
 ```shell
 bundle
 ```
 
 Or install it directly with
+
 ```shell
 gem install patch_ruby
 ```
 
 ### Requirements
+
 - Ruby 1.9+
 
 ## Usage
@@ -33,6 +39,7 @@ gem install patch_ruby
 ### 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'
 
@@ -43,16 +50,31 @@ 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/#/?id=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.
+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.patch.io/#/?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)
@@ -79,16 +101,44 @@ 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)
+[API Reference](https://docs.patch.io/#/?id=estimates)
 
 #### Examples
+
 ```ruby
-# Create an estimate
+# Create a mass estimate
 mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
 Patch::Estimate.create_mass_estimate(mass_g: mass)
 
+# Create a flight estimate
+distance_m = 1_000_000 # Pass in the distance traveled in meters
+Patch::Estimate.create_flight_estimate(distance_m: distance_m)
+
+# Create a shipping estimate
+distance_m = 1_000_000 # Pass in the shipping distance in meters
+package_mass_g = 10_000 # Pass in the weight of the package shipped in grams
+transportation_method = "air" # Pass in the transportation method (air, rail, road, sea)
+Patch::Estimate.create_shipping_estimate(
+  distance_m: distance_m,
+  package_mass_g: package_mass_g,
+  transportation_method: transportation_method
+)
+
+# Create a vehicle estimate
+distance_m = 1_000_000 # Pass in the shipping distance in meters
+make = "Toyota" # Pass in the car make
+model = "Corolla" # Pass in the car model
+year = 2000 # Pass in the car year
+Patch::Estimate.create_vehicle_estimate(
+  distance_m: distance_m,
+  make: make,
+  model: model,
+  year: year
+)
+
 ## 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)
@@ -103,11 +153,19 @@ 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)
+When fetching Projects, you can add filters to the query to narrow the result. Currently supported filters are:
+
+- `country`
+- `type`
+- `minimum_available_mass`
+
+[API Reference](https://docs.patch.io/#/?id=projects)
 
 #### Examples
+
 ```ruby
 # Retrieve a project
 project_id = 'pro_test_1234' # Pass in the project's ID
@@ -116,14 +174,28 @@ 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)
+
+# Retrieve all projects from the United States
+country = 'US'
+Patch::Project.retrieve_projects(country: country)
+
+# Retrieve all biomass projects
+type = 'biomass'
+Patch::Project.retrieve_projects(type: type)
+
+# Retrieve a list of projects with at least 100 grams of available offsets
+minimum_available_mass = 100
+Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
 ```
 
 ### 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)
+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.patch.io/projects).
+
+[API Reference](https://docs.patch.io/#/?id=preferences)
 
 #### Examples
+
 ```ruby
 # Create a preference
 project_id = 'pro_test_1234' # Pass in the project_id for your preference
@@ -145,26 +217,31 @@ 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/api/estimates_api.rb

@@ -15,7 +15,10 @@ require 'cgi'
 module Patch
   class EstimatesApi
     OPERATIONS = [
+      :create_flight_estimate,
       :create_mass_estimate,
+      :create_shipping_estimate,
+      :create_vehicle_estimate,
       :retrieve_estimate,
       :retrieve_estimates,
     ]
@@ -25,6 +28,70 @@ module Patch
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create a flight estimate given the distance traveled in meters
+    # Creates a flight estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. 
+    # @param create_flight_estimate_request [CreateFlightEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_flight_estimate(create_flight_estimate_request, opts = {})
+      data, _status_code, _headers = create_flight_estimate_with_http_info(create_flight_estimate_request, opts)
+      data
+    end
+
+    # Create a flight estimate given the distance traveled in meters
+    # Creates a flight estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters, linked to the estimate. 
+    # @param create_flight_estimate_request [CreateFlightEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_flight_estimate_with_http_info(create_flight_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_flight_estimate ...'
+      end
+      # verify the required parameter 'create_flight_estimate_request' is set
+      if @api_client.config.client_side_validation && create_flight_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_flight_estimate_request' when calling EstimatesApi.create_flight_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/flight'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_flight_estimate_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EstimatesApi#create_flight_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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 [CreateMassEstimateRequest] 
@@ -89,6 +156,134 @@ module Patch
       return data, status_code, headers
     end
 
+    # Create a shipping estimate given the distance traveled in meters, package weight, and transportation method.
+    # Creates a shipping estimate for the amount of CO2 to be compensated. An order in the `draft` state may be created based on the parameters. 
+    # @param create_shipping_estimate_request [CreateShippingEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_shipping_estimate(create_shipping_estimate_request, opts = {})
+      data, _status_code, _headers = create_shipping_estimate_with_http_info(create_shipping_estimate_request, opts)
+      data
+    end
+
+    # Create a shipping estimate given the distance traveled in meters, package weight, and transportation method.
+    # Creates a shipping estimate for the amount of CO2 to be compensated. An order in the &#x60;draft&#x60; state may be created based on the parameters. 
+    # @param create_shipping_estimate_request [CreateShippingEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_shipping_estimate_with_http_info(create_shipping_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_shipping_estimate ...'
+      end
+      # verify the required parameter 'create_shipping_estimate_request' is set
+      if @api_client.config.client_side_validation && create_shipping_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_shipping_estimate_request' when calling EstimatesApi.create_shipping_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/shipping'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_shipping_estimate_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EstimatesApi#create_shipping_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a vehicle estimate given the distance traveled in meters and the type of vehicle
+    # Creates an estimate and calculates the amount of CO2 to be compensated depending on the distance and the vehicle. An order in the `draft` state may be created based on the parameters, linked to the estimate. 
+    # @param create_vehicle_estimate_request [CreateVehicleEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_vehicle_estimate(create_vehicle_estimate_request, opts = {})
+      data, _status_code, _headers = create_vehicle_estimate_with_http_info(create_vehicle_estimate_request, opts)
+      data
+    end
+
+    # Create a vehicle estimate given the distance traveled in meters and the type of vehicle
+    # Creates an estimate and calculates the amount of CO2 to be compensated depending on the distance and the vehicle. An order in the &#x60;draft&#x60; state may be created based on the parameters, linked to the estimate. 
+    # @param create_vehicle_estimate_request [CreateVehicleEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_vehicle_estimate_with_http_info(create_vehicle_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_vehicle_estimate ...'
+      end
+      # verify the required parameter 'create_vehicle_estimate_request' is set
+      if @api_client.config.client_side_validation && create_vehicle_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_vehicle_estimate_request' when calling EstimatesApi.create_vehicle_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/vehicle'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_vehicle_estimate_request) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EstimateResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['bearer_auth']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EstimatesApi#create_vehicle_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # 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 [String]