patch_ruby 1.2.5 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 034d244a5779a4ba17a6cdd074f0099905f190ac25fa274b8efc37757b5f6cfc
-  data.tar.gz: acc6a37eb68e11f88e5092ffe666f962d14798d317761e55bf9777707615fb41
+  metadata.gz: 1dfa80bf469d57550d91fd6347ecc9b98ea263ea3f07c634f1ad8ad5a0061fef
+  data.tar.gz: 2464d81c7fb0256e66ac82957c0e1c4915f1f519b711434fa058d165fba225ec
 SHA512:
-  metadata.gz: c371f8237161ec6fd8be9ddd5e269dc73168718016a5dbc3d3e8a2dca62df9c334171eec45ba8645451c4ee1933b1089844e42fc1002569f43671bac9b01f849
-  data.tar.gz: 8d8c39a9380511af517ad1057da04f1e69997f994cded647d41c4adfe016ec65ac5a5ce73ccac1b5323ae91cf56a88de94736dab8b44d19336cd80a94d276331
+  metadata.gz: eedc8a08e6518436a8c275b6d9abd27391f16d18cc83d1301b1234bc118e51bd25b0b650b064325aa3d8ec94b0d11a91a35040d31f36d52bf4ce55332a96e14f
+  data.tar.gz: 48bf74563009752e9696617c3134d2716c2e75ba28264f2f7af729c3146767ffcf8020b9904fbe35b83d66f685a0d6b0c018ccb2d9c5ece29231cccf476546fa

data/CHANGELOG.md

@@ -5,7 +5,11 @@ 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.3.0] - 2021-02-08
+
+### Added
+
+- Adds support for creating carbon emission estimates for flights, shipping, and vehicles. See the [docs](https://docs.usepatch.com/#/?id=estimates) for more information.
 
 ## [1.2.5] - 2020-01-08
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.2.5)
+    patch_ruby (1.3.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -98,10 +98,36 @@ Estimates allow API users to get a quote for the cost of compensating a certain
 
 #### 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)

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] 

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -16,12 +16,15 @@ module Patch
   class CreateMassEstimateRequest
     attr_accessor :mass_g
 
+    attr_accessor :create_order
+
     attr_accessor :project_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'mass_g' => :'mass_g',
+        :'create_order' => :'create_order',
         :'project_id' => :'project_id'
       }
     end
@@ -30,6 +33,7 @@ module Patch
     def self.openapi_types
       {
         :'mass_g' => :'Integer',
+        :'create_order' => :'Boolean',
         :'project_id' => :'String'
       }
     end
@@ -38,6 +42,8 @@ module Patch
     def self.openapi_nullable
       nullable_properties = Set.new
 
+      nullable_properties.add("create_order")
+
       nullable_properties
     end
 
@@ -71,6 +77,10 @@ module Patch
         self.mass_g = attributes[:'mass_g']
       end
 
+      if attributes.key?(:'create_order')
+        self.create_order = attributes[:'create_order']
+      end
+
       if attributes.key?(:'project_id')
         self.project_id = attributes[:'project_id']
       end
@@ -128,6 +138,7 @@ module Patch
       return true if self.equal?(o)
       self.class == o.class &&
           mass_g == o.mass_g &&
+          create_order == o.create_order &&
           project_id == o.project_id
     end
 
@@ -140,7 +151,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [mass_g, project_id].hash
+      [mass_g, create_order, project_id].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/estimate.rb

@@ -20,9 +20,12 @@ module Patch
     # A boolean indicating if this estimate is a production or test mode estimate.
     attr_accessor :production
 
-    # The type of estimate. Currently mass is the only supported value.
+    # The type of estimate. Available types are mass, flight, shipping, and vehicle.
     attr_accessor :type
 
+    # The estimated mass in grams for this estimate.
+    attr_accessor :mass_g
+
     # An object returning the order associated with this estimate. See the [Order section](/?id=orders) for the full schema.
     attr_accessor :order
 
@@ -32,6 +35,7 @@ module Patch
         :'id' => :'id',
         :'production' => :'production',
         :'type' => :'type',
+        :'mass_g' => :'mass_g',
         :'order' => :'order'
       }
     end
@@ -42,6 +46,7 @@ module Patch
         :'id' => :'String',
         :'production' => :'Boolean',
         :'type' => :'String',
+        :'mass_g' => :'Integer',
         :'order' => :'Order'
       }
     end
@@ -93,6 +98,10 @@ module Patch
         self.type = attributes[:'type']
       end
 
+      if attributes.key?(:'mass_g')
+        self.mass_g = attributes[:'mass_g']
+      end
+
       if attributes.key?(:'order')
         self.order = attributes[:'order']
       end
@@ -134,6 +143,7 @@ module Patch
           id == o.id &&
           production == o.production &&
           type == o.type &&
+          mass_g == o.mass_g &&
           order == o.order
     end
 
@@ -146,7 +156,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, type, order].hash
+      [id, production, type, mass_g, order].hash
     end
 
     # Builds the object from hash
@@ -239,7 +249,7 @@ module Patch
           is_nullable = self.class.openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
-
+        
         hash[param] = _to_hash(value)
       end
       hash

data/lib/patch_ruby/models/photo.rb

@@ -70,6 +70,10 @@ module Patch
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?

data/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module Patch
-  VERSION = '1.2.5'
+  VERSION = '1.3.0'
 end

data/spec/integration/estimates_spec.rb

@@ -24,4 +24,47 @@ RSpec.describe 'Estimates Integration' do
 
     expect(estimates.length).not_to be_zero
   end
+
+  it 'supports creating flight estimates' do
+    distance_m = 10_000_000
+    flight_estimate = Patch::Estimate.create_flight_estimate(
+      distance_m: distance_m,
+      create_order: false
+    )
+
+    expect(flight_estimate.data.type).to eq 'flight'
+    expect(flight_estimate.data.mass_g).to eq 1_032_000
+  end
+
+  it 'supports creating vehicle estimates' do
+    distance_m = 10_000
+    make = "Toyota"
+    model = "Prius"
+    year = 2000
+
+    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
+      distance_m: distance_m,
+      make: make,
+      model: model,
+      year: year,
+      create_order: false
+    )
+
+    expect(vehicle_estimate.data.type).to eq 'vehicle'
+    expect(vehicle_estimate.data.mass_g).to eq 2_132
+  end
+
+  it 'supports creating shipping estimates' do
+    distance_m = 100_000_000
+    package_mass_g = 10_000
+    create_estimate_response = Patch::Estimate.create_shipping_estimate(
+      distance_m: distance_m,
+      package_mass_g: package_mass_g,
+      transportation_method: 'rail',
+      create_order: false
+    )
+
+    expect(create_estimate_response.data.type).to eq 'shipping'
+    expect(create_estimate_response.data.mass_g).to eq 12_431
+  end
 end

data/spec/integration/preferences_spec.rb

@@ -10,8 +10,12 @@ RSpec.describe 'Preferences Integration' do
     expect(retrieve_projects_response.data.length).not_to be_zero
     project_id = retrieve_projects_response.data.first.id
 
-    create_preference_response = Patch::Preference.create_preference(project_id: project_id)
-    preference_id = create_preference_response.data.id
+    begin
+      create_preference_response = Patch::Preference.create_preference(project_id: project_id)
+      preference_id = create_preference_response.data.id
+    rescue => Patch::ApiError
+      preference_id = Patch::Preference.retrieve_preferences().data.first.id
+    end
 
     retrieve_preference_response = Patch::Preference.retrieve_preference(preference_id)
     expect(retrieve_preference_response.data.id).to eq preference_id

data/spec/models/create_mass_estimate_request_spec.rb

@@ -30,7 +30,7 @@ describe 'CreateMassEstimateRequest' do
   it_behaves_like "a generated class" do
     let(:instance) { @instance }
     let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g } }
-    let(:nullable_properties) { Set.new }
+    let(:nullable_properties) { Set.new(["create_order"]) }
   end
 
   describe 'test an instance of CreateMassEstimateRequest' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -186,52 +186,52 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Patch API
 test_files:
-- spec/api/projects_api_spec.rb
 - spec/api/orders_api_spec.rb
-- spec/api/preferences_api_spec.rb
+- spec/api/projects_api_spec.rb
 - spec/api/estimates_api_spec.rb
+- spec/api/preferences_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/constants.rb
-- spec/factories/estimates.rb
-- spec/factories/estimate_list_responses.rb
-- spec/factories/create_order_requests.rb
+- spec/factories/project_responses.rb
+- spec/factories/create_preference_requests.rb
+- spec/factories/meta_index_objects.rb
 - spec/factories/project_list_responses.rb
+- spec/factories/orders.rb
 - spec/factories/order_list_responses.rb
-- spec/factories/estimate_responses.rb
-- spec/factories/error_responses.rb
-- spec/factories/preference_list_responses.rb
-- spec/factories/preference_responses.rb
-- spec/factories/meta_index_objects.rb
 - spec/factories/order_responses.rb
 - spec/factories/preferences.rb
-- spec/factories/project_responses.rb
-- spec/factories/create_preference_requests.rb
-- spec/factories/orders.rb
+- spec/factories/preference_responses.rb
+- spec/factories/error_responses.rb
+- spec/factories/estimates.rb
+- spec/factories/estimate_list_responses.rb
+- spec/factories/create_order_requests.rb
+- spec/factories/allocations.rb
 - spec/factories/projects.rb
+- spec/factories/estimate_responses.rb
+- spec/factories/preference_list_responses.rb
 - spec/factories/create_mass_estimate_requests.rb
-- spec/factories/allocations.rb
-- spec/integration/orders_spec.rb
 - spec/integration/estimates_spec.rb
 - spec/integration/preferences_spec.rb
+- spec/integration/orders_spec.rb
 - spec/integration/projects_spec.rb
-- spec/models/error_response_spec.rb
-- spec/models/preference_list_response_spec.rb
-- spec/models/preference_spec.rb
-- spec/models/project_response_spec.rb
-- spec/models/project_spec.rb
-- spec/models/create_preference_request_spec.rb
-- spec/models/order_response_spec.rb
 - spec/models/order_list_response_spec.rb
 - spec/models/allocation_spec.rb
+- spec/models/order_response_spec.rb
+- spec/models/preference_list_response_spec.rb
+- spec/models/create_preference_request_spec.rb
+- spec/models/estimate_list_response_spec.rb
+- spec/models/project_spec.rb
+- spec/models/project_list_response_spec.rb
 - spec/models/estimate_response_spec.rb
+- spec/models/preference_spec.rb
+- spec/models/create_order_request_spec.rb
+- spec/models/create_mass_estimate_request_spec.rb
+- spec/models/project_response_spec.rb
 - spec/models/order_spec.rb
+- spec/models/error_response_spec.rb
+- spec/models/estimate_spec.rb
 - spec/models/meta_index_object_spec.rb
-- spec/models/project_list_response_spec.rb
 - spec/models/preference_response_spec.rb
-- spec/models/estimate_spec.rb
-- spec/models/create_mass_estimate_request_spec.rb
-- spec/models/estimate_list_response_spec.rb
-- spec/models/create_order_request_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/generated_classes.rb