patch_ruby 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dfa80bf469d57550d91fd6347ecc9b98ea263ea3f07c634f1ad8ad5a0061fef
-  data.tar.gz: 2464d81c7fb0256e66ac82957c0e1c4915f1f519b711434fa058d165fba225ec
+  metadata.gz: 01dd6e1760357bf0a43bc0244e3bd6dddb5dbfe30917f5882e78faf8e76b0c70
+  data.tar.gz: be17b49e72c7132fbc7a4b6a5dbe19704eda14fd17ef5dc4a89c7fdbd154547a
 SHA512:
-  metadata.gz: eedc8a08e6518436a8c275b6d9abd27391f16d18cc83d1301b1234bc118e51bd25b0b650b064325aa3d8ec94b0d11a91a35040d31f36d52bf4ce55332a96e14f
-  data.tar.gz: 48bf74563009752e9696617c3134d2716c2e75ba28264f2f7af729c3146767ffcf8020b9904fbe35b83d66f685a0d6b0c018ccb2d9c5ece29231cccf476546fa
+  metadata.gz: 04d0e212d6aac27ebf643a1800e2a34ac3b9f2f37c5439e3497bf2d690cf106f01899e59efbafa7b9e6ab01de76b25603e83e469e0462c8a091e81a3e8130acb
+  data.tar.gz: '08d93d9433299ba112efca8ecd0a1838016684cb05a2b3a80d8c44249c2fda6ed7dc6f1684bad9b5f37a3121ab7ab2a60bd91ab0a5566d8c85e4863cd8f7dccc'

data/CHANGELOG.md

@@ -5,6 +5,17 @@ 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).
 
+## [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
@@ -79,4 +90,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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.3.0)
+    patch_ruby (1.4.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -23,10 +23,10 @@ GEM
       ffi (>= 1.3.0)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    ffi (1.13.1)
+    ffi (1.14.2)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    json (2.4.1)
+    json (2.5.1)
     method_source (1.0.0)
     minitest (5.14.3)
     parallel (1.19.2)

data/README.md

@@ -144,6 +144,12 @@ 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.
 
+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.usepatch.com/#/?id=projects)
 
 #### Examples
@@ -155,6 +161,18 @@ 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

data/lib/patch_ruby/api/projects_api.rb

@@ -90,6 +90,9 @@ module Patch
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [ProjectListResponse]
     def retrieve_projects(opts = {})
       data, _status_code, _headers = retrieve_projects_with_http_info(opts)
@@ -100,6 +103,9 @@ module Patch
     # Retrieves a list of projects available for purchase on Patch's platform. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :country 
+    # @option opts [String] :type 
+    # @option opts [Integer] :minimum_available_mass 
     # @return [Array<(ProjectListResponse, Integer, Hash)>] ProjectListResponse data, response status code and response headers
     def retrieve_projects_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -111,6 +117,9 @@ module Patch
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'minimum_available_mass'] = opts[:'minimum_available_mass'] if !opts[:'minimum_available_mass'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/patch_ruby/models/project.rb

@@ -47,6 +47,9 @@ module Patch
     # An object returning the Standard associated with this project.
     attr_accessor :standard
 
+    # An array returning the UN Sustainable Development Goals associated with this project.
+    attr_accessor :sdgs
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -82,7 +85,8 @@ module Patch
         :'photos' => :'photos',
         :'average_price_per_tonne_cents_usd' => :'average_price_per_tonne_cents_usd',
         :'remaining_mass_g' => :'remaining_mass_g',
-        :'standard' => :'standard'
+        :'standard' => :'standard',
+        :'sdgs' => :'sdgs'
       }
     end
 
@@ -99,7 +103,8 @@ module Patch
         :'photos' => :'Array<Photo>',
         :'average_price_per_tonne_cents_usd' => :'Integer',
         :'remaining_mass_g' => :'Integer',
-        :'standard' => :'Standard'
+        :'standard' => :'Standard',
+        :'sdgs' => :'Array<Sdg>'
       }
     end
 
@@ -111,6 +116,8 @@ module Patch
 
       nullable_properties.add("standard")
 
+      nullable_properties.add("sdgs")
+
       nullable_properties
     end
 
@@ -185,6 +192,12 @@ module Patch
       if attributes.key?(:'standard')
         self.standard = attributes[:'standard']
       end
+
+      if attributes.key?(:'sdgs')
+        if (value = attributes[:'sdgs']).is_a?(Array)
+          self.sdgs = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -267,7 +280,8 @@ module Patch
           photos == o.photos &&
           average_price_per_tonne_cents_usd == o.average_price_per_tonne_cents_usd &&
           remaining_mass_g == o.remaining_mass_g &&
-          standard == o.standard
+          standard == o.standard &&
+          sdgs == o.sdgs
     end
 
     # @see the `==` method
@@ -279,7 +293,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, production, name, description, type, country, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, standard].hash
+      [id, production, name, description, type, country, developer, photos, average_price_per_tonne_cents_usd, remaining_mass_g, standard, sdgs].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/sdg.rb

@@ -0,0 +1,269 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: developers@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module Patch
+  class Sdg
+    # The title of the Sustainable Development Goal.
+    attr_accessor :title
+
+    # The Sustainable Development Goal number.
+    attr_accessor :number
+
+    # The description of the Sustainable Development Goal.
+    attr_accessor :description
+
+    # The url to an information page for the Sustainable Development Goal.
+    attr_accessor :url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title' => :'title',
+        :'number' => :'number',
+        :'description' => :'description',
+        :'url' => :'url'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'title' => :'String',
+        :'number' => :'Integer',
+        :'description' => :'String',
+        :'url' => :'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
+    def self.method_missing(message, *args, &block)
+      if Object.const_defined?('Patch::SdgsApi::OPERATIONS') && Patch::SdgsApi::OPERATIONS.include?(message)
+        Patch::SdgsApi.new.send(message, *args)
+      else
+        super
+      end
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Patch::Sdg` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Patch::Sdg`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url 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 @title.nil?
+      return false if @number.nil?
+      return false if @description.nil?
+      return false if @url.nil?
+      true
+    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 &&
+          title == o.title &&
+          number == o.number &&
+          description == o.description &&
+          url == o.url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [title, number, description, url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        Patch.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          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
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/patch_ruby/version.rb

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

data/spec/integration/estimates_spec.rb

@@ -33,13 +33,13 @@ RSpec.describe 'Estimates Integration' do
     )
 
     expect(flight_estimate.data.type).to eq 'flight'
-    expect(flight_estimate.data.mass_g).to eq 1_032_000
+    expect(flight_estimate.data.mass_g).to eq 1_031_697
   end
 
   it 'supports creating vehicle estimates' do
     distance_m = 10_000
     make = "Toyota"
-    model = "Prius"
+    model = "Corolla"
     year = 2000
 
     vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
@@ -50,6 +50,18 @@ RSpec.describe 'Estimates Integration' do
       create_order: false
     )
 
+    expect(vehicle_estimate.data.type).to eq 'vehicle'
+    expect(vehicle_estimate.data.mass_g).to eq 5_500
+  end
+
+  it 'supports creating vehicle estimates with partial information' do
+    distance_m = 10_000
+
+    vehicle_estimate = Patch::Estimate.create_vehicle_estimate(
+      distance_m: distance_m,
+      create_order: false
+    )
+
     expect(vehicle_estimate.data.type).to eq 'vehicle'
     expect(vehicle_estimate.data.mass_g).to eq 2_132
   end

data/spec/integration/orders_spec.rb

@@ -66,7 +66,7 @@ RSpec.describe 'Orders Integration' do
 
     expect(order.id).not_to be_nil
     expect(order.mass_g).to eq(5_00_000)
-    expect(order.price_cents_usd.to_i).to eq(500)
+    expect(order.price_cents_usd).not_to be_empty
     expect(order.patch_fee_cents_usd).not_to be_empty
     expect(
       order.price_cents_usd.to_i + order.patch_fee_cents_usd.to_i

data/spec/integration/projects_spec.rb

@@ -22,6 +22,26 @@ RSpec.describe 'Projects Integration' do
     expect(retrieve_project_response.data.id).to eq project_id
   end
 
+  it 'supports filtering projects' do
+    country = 'US'
+    projects = Patch::Project.retrieve_projects(country: country)
+    projects.data.map do |project|
+      expect(project.country).to eq country
+    end
+
+    type = 'dac'
+    projects = Patch::Project.retrieve_projects(type: type)
+    projects.data.map do |project|
+      expect(project.type).to eq type
+    end
+
+    minimum_available_mass = 100
+    projects = Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)
+    projects.data.map do |project|
+      expect(project.remaining_mass_g >= minimum_available_mass).to be true
+    end
+  end
+
   describe 'returned fields' do
     before do
       @project = Patch::Project.retrieve_projects(page: 1).data.first

data/spec/models/project_spec.rb

@@ -44,7 +44,7 @@ describe 'Project' do
         standard: @instance.standard
       }
     }
-    let(:nullable_properties) { Set.new(["photos", "standard"]) }
+    let(:nullable_properties) { Set.new(["photos", "standard", "sdgs"]) }
   end
 
   describe 'test an instance of Project' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -110,6 +110,7 @@ files:
 - lib/patch_ruby/models/project.rb
 - lib/patch_ruby/models/project_list_response.rb
 - lib/patch_ruby/models/project_response.rb
+- lib/patch_ruby/models/sdg.rb
 - lib/patch_ruby/models/standard.rb
 - lib/patch_ruby/version.rb
 - patch_ruby.gemspec