patch_ruby 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a97b1d48e2a6ae9a50749434d02046c07d2c29f719294f62a30f6de392ec32
-  data.tar.gz: 5c2fdd1a90d0e41f9ada976ad4f7bdbfdbe5926cfc6892f183aee3d241ab8f3f
+  metadata.gz: 7ab75a1c077e255f54aa542b15eefc55ae4125994a71d8138be99a0534c1a5bd
+  data.tar.gz: f0cd837fc4ed2187a775a01d33711b4d54b16ca30f992386305b32a81a159c1c
 SHA512:
-  metadata.gz: 22a036eb09ecd66937e745b0403af743bb25c712fa9c485be9dfdf4f2762247e47a0c0df5a21d5701073983af4de64abffd24889415a3f2c5b53ca4b695150e1
-  data.tar.gz: a183b61d3de80803aae094ab765f97c19d3fd01afec70335b839d3af7796577d320c4141b25ebc0d9c732d820ecd8c8d55c4f3d8b1e7f704cc07b3347fd843ec
+  metadata.gz: a6706f4e0965eaa1edbed707a18609f04e85e5de5808d8ab95646a5c8d63c95cdbcb0d1b7dc7859270bbb098f28e6e094ca973b9ff13c403c08982a4d6292aea
+  data.tar.gz: 4fcf46077c53e8e79c72d5a2caf88200b39e9c6297c67b6709c86dcc6572e3f559332bff888872e1b2b8e4827fefd829a3990045232b89f83841bae0d7e65490

data/CHANGELOG.md

@@ -5,6 +5,12 @@ 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.8.0] - 2021-07-20
+
+### Added
+
+- Add support for Ethereum estimates
+
 ## [1.7.0] - 2021-07-14
 
 ### Changed

data/Gemfile.lock

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

data/lib/patch_ruby.rb

@@ -19,6 +19,7 @@ require 'patch_ruby/configuration'
 # Models
 require 'patch_ruby/models/allocation'
 require 'patch_ruby/models/create_bitcoin_estimate_request'
+require 'patch_ruby/models/create_ethereum_estimate_request'
 require 'patch_ruby/models/create_mass_estimate_request'
 require 'patch_ruby/models/create_order_request'
 require 'patch_ruby/models/create_preference_request'

data/lib/patch_ruby/api/estimates_api.rb

@@ -16,6 +16,7 @@ module Patch
   class EstimatesApi
     OPERATIONS = [
       :create_bitcoin_estimate,
+      :create_ethereum_estimate,
       :create_flight_estimate,
       :create_mass_estimate,
       :create_shipping_estimate,
@@ -30,7 +31,7 @@ module Patch
       @api_client = api_client
     end
     # Create a bitcoin estimate given a timestamp and transaction value
-    # Creates a bitcoin 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. 
+    # Creates a bitcoin 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_bitcoin_estimate_request [CreateBitcoinEstimateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [EstimateResponse]
@@ -40,7 +41,7 @@ module Patch
     end
 
     # Create a bitcoin estimate given a timestamp and transaction value
-    # Creates a bitcoin 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. 
+    # Creates a bitcoin 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_bitcoin_estimate_request [CreateBitcoinEstimateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
@@ -93,6 +94,70 @@ module Patch
       return data, status_code, headers
     end
 
+    # Create an ethereum estimate given a timestamp and gas used
+    # Creates an ethereum 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_ethereum_estimate_request [CreateEthereumEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_ethereum_estimate(create_ethereum_estimate_request, opts = {})
+      data, _status_code, _headers = create_ethereum_estimate_with_http_info(create_ethereum_estimate_request, opts)
+      data
+    end
+
+    # Create an ethereum estimate given a timestamp and gas used
+    # Creates an ethereum estimate for the amount of CO2 to be compensated. An order in the &#x60;draft&#x60; state may be created based on the parameters, linked to the estimate. 
+    # @param create_ethereum_estimate_request [CreateEthereumEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EstimateResponse, Integer, Hash)>] EstimateResponse data, response status code and response headers
+    def create_ethereum_estimate_with_http_info(create_ethereum_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_ethereum_estimate ...'
+      end
+      # verify the required parameter 'create_ethereum_estimate_request' is set
+      if @api_client.config.client_side_validation && create_ethereum_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_ethereum_estimate_request' when calling EstimatesApi.create_ethereum_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/crypto/eth'
+
+      # 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_ethereum_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_ethereum_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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] 

data/lib/patch_ruby/models/create_ethereum_estimate_request.rb

@@ -0,0 +1,253 @@
+=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 CreateEthereumEstimateRequest
+    attr_accessor :timestamp
+
+    attr_accessor :gas_used
+
+    attr_accessor :project_id
+
+    attr_accessor :create_order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'timestamp' => :'timestamp',
+        :'gas_used' => :'gas_used',
+        :'project_id' => :'project_id',
+        :'create_order' => :'create_order'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'timestamp' => :'String',
+        :'gas_used' => :'Integer',
+        :'project_id' => :'String',
+        :'create_order' => :'Boolean'
+      }
+    end
+
+    # Set with nullable attributes.
+    def self.openapi_nullable
+      nullable_properties = Set.new
+
+      nullable_properties.add("timestamp")
+
+      nullable_properties.add("gas_used")
+
+      nullable_properties.add("project_id")
+
+      nullable_properties.add("create_order")
+
+      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::CreateEthereumEstimateRequestsApi::OPERATIONS') && Patch::CreateEthereumEstimateRequestsApi::OPERATIONS.include?(message)
+        Patch::CreateEthereumEstimateRequestsApi.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::CreateEthereumEstimateRequest` 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::CreateEthereumEstimateRequest`. 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?(:'timestamp')
+        self.timestamp = attributes[:'timestamp']
+      end
+
+      if attributes.key?(:'gas_used')
+        self.gas_used = attributes[:'gas_used']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'create_order')
+        self.create_order = attributes[:'create_order']
+      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
+      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?
+      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 &&
+          timestamp == o.timestamp &&
+          gas_used == o.gas_used &&
+          project_id == o.project_id &&
+          create_order == o.create_order
+    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
+      [timestamp, gas_used, project_id, create_order].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.7.0'
+  VERSION = '1.8.0'
 end

data/spec/integration/estimates_spec.rb

@@ -99,4 +99,37 @@ RSpec.describe 'Estimates Integration' do
     expect(bitcoin_estimate.data.type).to eq 'bitcoin'
     expect(bitcoin_estimate.data.mass_g).to be < bitcoin_estimate_2.data.mass_g
   end
+
+  it 'supports creating bitcoin estimates with a timestamp' do
+    bitcoin_estimate_1 = Patch::Estimate.create_bitcoin_estimate(
+      timestamp: '2021-06-01T20:31:18.403Z'
+    )
+
+    bitcoin_estimate_2 = Patch::Estimate.create_bitcoin_estimate(
+      timestamp: '2021-07-01T20:31:18.403Z'
+    )
+
+    expect(bitcoin_estimate_1.data.type).to eq 'bitcoin'
+    expect(bitcoin_estimate_1.data.mass_g).to be > bitcoin_estimate_2.data.mass_g # Bitcoin was emitting less in July 2021 than in June
+  end
+
+  it 'supports creating ethereum estimates with a gas amount' do
+    ethereum_estimate = Patch::Estimate.create_ethereum_estimate(
+      gas_used: 100
+    )
+
+    ethereum_estimate_2 = Patch::Estimate.create_ethereum_estimate(
+      gas_used: 1000
+    )
+
+    expect(ethereum_estimate.data.type).to eq 'ethereum'
+    expect(ethereum_estimate.data.mass_g).to be < ethereum_estimate_2.data.mass_g
+  end
+
+  it 'supports creating ethereum estimates with partial information' do
+    ethereum_estimate = Patch::Estimate.create_ethereum_estimate({ create_order: false })
+
+    expect(ethereum_estimate.data.type).to eq 'ethereum'
+    expect(ethereum_estimate.data.mass_g).to be >= 2_000
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-14 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -93,6 +93,7 @@ files:
 - lib/patch_ruby/configuration.rb
 - lib/patch_ruby/models/allocation.rb
 - lib/patch_ruby/models/create_bitcoin_estimate_request.rb
+- lib/patch_ruby/models/create_ethereum_estimate_request.rb
 - lib/patch_ruby/models/create_mass_estimate_request.rb
 - lib/patch_ruby/models/create_order_request.rb
 - lib/patch_ruby/models/create_preference_request.rb