patch_ruby 1.5.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc6db1f9c2667e24cdcc6e9d1e0f3b4866572a98ffe6131329772cc75c140aa4
-  data.tar.gz: d3db3c6c7ac66a2b41516a52187a373cc8fa8efa9df1bd12e7cb163d6b83a31f
+  metadata.gz: b9f4307913b3197f4bf734c1c2f304210445268d022786c5dff9f454d77a9ca2
+  data.tar.gz: f0d29217913cc6d74e14c43a763e2c05b01aa746a4afcab0b9c8baf426c1b420
 SHA512:
-  metadata.gz: f63cd496d573267bb060c8470ae80856b1b1865a28aea4bbd800866ae19612b05aaf6177cdd5e3155707817d594900dc68a61c014c3485b43615d02090495599
-  data.tar.gz: fa029a9b055376f7b7c0f873691f5adf1530fbd72548aa505d384bf4ceabd8f4a769eb0c90f46c53cff71e198af144ac0ec3a344e48c2b63aa772d6c912824b9
+  metadata.gz: e06026d89b14cbdf33ed4f9d3a3bdd9aa4f698044a1fadd5cf46cca7c981aa469f9eac7095a473b360426d2291802fc11de9136773787704832861e2a496edba
+  data.tar.gz: 514089ea6fe7202c394e7a5b1642a070dda9ff5d1168696b8fa337e2d8f16509365ab38dd7f90ee951e227c1655d7a69a7e7b6ac195b767120b8853e955e8fd7

data/CHANGELOG.md

@@ -5,6 +5,32 @@ 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.9.0] - 2021-08-17
+
+### Added
+
+- Add support for querying Orders by `metadata`
+- Added `transaction_value_eth_gwei` as an alternative way to compute transaction level emissions for ethereum
+
+## [1.8.0] - 2021-07-20
+
+### Added
+
+- Add support for Ethereum estimates
+
+## [1.7.0] - 2021-07-14
+
+### Changed
+
+- [BREAKING] Changed `order.price_cents_usd` and `order.patch_fee_cents_usd` from string to integer.
+
+## [1.6.0] - 2021-07-14
+
+### Added
+
+- Order responses return a `registry_url` field
+- Add support for Bitcoin estimates
+
 ## [1.5.2] - 2021-03-30
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.5.2)
+    patch_ruby (1.9.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -19,11 +19,11 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.3)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
+    ethon (0.14.0)
+      ffi (>= 1.15.0)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    ffi (1.15.0)
+    ffi (1.15.3)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     json (2.5.1)

data/README.md

@@ -139,6 +139,10 @@ Patch::Estimate.create_vehicle_estimate(
   year: year
 )
 
+# Create a flight estimate
+transaction_value_btc_sats = 1000; # [Optional] Pass in the transaction value in satoshis
+Patch::Estimate.create_bitcoin_estimate(transaction_value_btc_sats: transaction_value_btc_sats)
+
 ## 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)
@@ -218,30 +222,30 @@ Patch::Preference.retrieve_preferences(page: page)
 
 To build the gem locally, run:
 
-```
-$ gem build patch_ruby.gemspec
+```bash
+gem build patch_ruby.gemspec
 ```
 
 This will create a .gem file. To install the local gem:
 
-```
-$ gem install patch_ruby-1.x.x.gem
+```bash
+gem install patch_ruby-1.x.x.gem
 ```
 
 Install dependencies:
 
-```
-$ bundle install
+```bash
+bundle install
 ```
 
 Set up required environment variables:
 
-```
-$ export SANDBOX_API_KEY=<SANDBOX API KEY>
+```bash
+export SANDBOX_API_KEY=<SANDBOX API KEY>
 ```
 
 Run tests:
 
-```
-$ bundle exec rspec
+```bash
+bundle exec rspec
 ```

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/lib/patch_ruby.rb

@@ -18,6 +18,8 @@ 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

@@ -15,6 +15,8 @@ require 'cgi'
 module Patch
   class EstimatesApi
     OPERATIONS = [
+      :create_bitcoin_estimate,
+      :create_ethereum_estimate,
       :create_flight_estimate,
       :create_mass_estimate,
       :create_shipping_estimate,
@@ -28,6 +30,134 @@ module Patch
     def initialize(api_client = ApiClient.default)
       @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. 
+    # @param create_bitcoin_estimate_request [CreateBitcoinEstimateRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [EstimateResponse]
+    def create_bitcoin_estimate(create_bitcoin_estimate_request, opts = {})
+      data, _status_code, _headers = create_bitcoin_estimate_with_http_info(create_bitcoin_estimate_request, opts)
+      data
+    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. 
+    # @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
+    def create_bitcoin_estimate_with_http_info(create_bitcoin_estimate_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EstimatesApi.create_bitcoin_estimate ...'
+      end
+      # verify the required parameter 'create_bitcoin_estimate_request' is set
+      if @api_client.config.client_side_validation && create_bitcoin_estimate_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_bitcoin_estimate_request' when calling EstimatesApi.create_bitcoin_estimate"
+      end
+      # resource path
+      local_var_path = '/v1/estimates/crypto/btc'
+
+      # 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_bitcoin_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_bitcoin_estimate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      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/api/orders_api.rb

@@ -28,7 +28,7 @@ module Patch
       @api_client = api_client
     end
     # Cancel an order
-    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` state can be cancelled. 
+    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [OrderResponse]
@@ -38,7 +38,7 @@ module Patch
     end
 
     # Cancel an order
-    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` state can be cancelled. 
+    # Cancelling an order removes the associated offset allocation from an order. You will not be charged for cancelled orders. Only orders in the `draft` or `placed` state can be cancelled. 
     # @param id [String] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
@@ -281,6 +281,9 @@ module Patch
     # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :metadata 
+    # @option opts [String] :metadata_example1 
+    # @option opts [String] :metadata_example2 
     # @return [OrderListResponse]
     def retrieve_orders(opts = {})
       data, _status_code, _headers = retrieve_orders_with_http_info(opts)
@@ -291,6 +294,9 @@ module Patch
     # Retrieves a list of orders and its allocation offsets or negative emissions. You can only retrieve orders associated with the organization you are querying for. 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page 
+    # @option opts [String] :metadata 
+    # @option opts [String] :metadata_example1 
+    # @option opts [String] :metadata_example2 
     # @return [Array<(OrderListResponse, Integer, Hash)>] OrderListResponse data, response status code and response headers
     def retrieve_orders_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -302,6 +308,9 @@ module Patch
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'metadata'] = opts[:'metadata'] if !opts[:'metadata'].nil?
+      query_params[:'metadata[example1]'] = opts[:'metadata_example1'] if !opts[:'metadata_example1'].nil?
+      query_params[:'metadata[example2]'] = opts[:'metadata_example2'] if !opts[:'metadata_example2'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/patch_ruby/models/create_bitcoin_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 CreateBitcoinEstimateRequest
+    attr_accessor :timestamp
+
+    attr_accessor :transaction_value_btc_sats
+
+    attr_accessor :project_id
+
+    attr_accessor :create_order
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'timestamp' => :'timestamp',
+        :'transaction_value_btc_sats' => :'transaction_value_btc_sats',
+        :'project_id' => :'project_id',
+        :'create_order' => :'create_order'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'timestamp' => :'String',
+        :'transaction_value_btc_sats' => :'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("transaction_value_btc_sats")
+
+      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::CreateBitcoinEstimateRequestsApi::OPERATIONS') && Patch::CreateBitcoinEstimateRequestsApi::OPERATIONS.include?(message)
+        Patch::CreateBitcoinEstimateRequestsApi.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::CreateBitcoinEstimateRequest` 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::CreateBitcoinEstimateRequest`. 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?(:'transaction_value_btc_sats')
+        self.transaction_value_btc_sats = attributes[:'transaction_value_btc_sats']
+      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 &&
+          transaction_value_btc_sats == o.transaction_value_btc_sats &&
+          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, transaction_value_btc_sats, 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