patch_ruby 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01dd6e1760357bf0a43bc0244e3bd6dddb5dbfe30917f5882e78faf8e76b0c70
-  data.tar.gz: be17b49e72c7132fbc7a4b6a5dbe19704eda14fd17ef5dc4a89c7fdbd154547a
+  metadata.gz: 3cf4569e76d9ab3e100909b2e1ef6baab9bec5fdccf509cbda298bef9424cf49
+  data.tar.gz: 391d81d9dd2d6bd9e761c21f28ca1bb07685ef67da8b9eef138c5c41e49012d3
 SHA512:
-  metadata.gz: 04d0e212d6aac27ebf643a1800e2a34ac3b9f2f37c5439e3497bf2d690cf106f01899e59efbafa7b9e6ab01de76b25603e83e469e0462c8a091e81a3e8130acb
-  data.tar.gz: '08d93d9433299ba112efca8ecd0a1838016684cb05a2b3a80d8c44249c2fda6ed7dc6f1684bad9b5f37a3121ab7ab2a60bd91ab0a5566d8c85e4863cd8f7dccc'
+  metadata.gz: b179c02c365df62a4f35ebb7215b5fa4fefbc143fbd76d2fc387f745d47c0d51af43af719a941f7a106903f81f060eb8af29854de811293022dc37342a4e58a3
+  data.tar.gz: bc742b04409a703f3fbc9d539743379dd4c35e921d6bc6ca13b938e98fb800b30223cdf5ccce169ee7870c93e02e726cdf48250d82955aa9f4c26bf3e7e4ca07

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.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
+
+- Updated the value validation for certain parameters to match the API
+- Added the `renewables` type
+
+## [1.5.1] - 2021-03-02
+
+### Fixed
+
+- Fixed a `NameError` that was thrown when `Patch::Sdg` was called. Specs have been added to ensure this does not happen again.
+
+## [1.5.0] - 2021-03-01
+
+### Changed
+
+- Changed base URL from https://api.usepatch.com to https://api.patch.io
+
 ## [1.4.0] - 2021-02-15
 
 ### Added
@@ -20,7 +46,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 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.
+- 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
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    patch_ruby (1.4.0)
+    patch_ruby (1.5.2)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -23,7 +23,7 @@ GEM
       ffi (>= 1.3.0)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    ffi (1.14.2)
+    ffi (1.15.0)
     i18n (1.8.7)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
@@ -86,4 +86,4 @@ DEPENDENCIES
   rubocop
 
 BUNDLED WITH
-   2.1.4
+   2.2.14

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,6 +50,7 @@ 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.
 
 In Patch, orders represent a purchase of carbon offsets or negative emissions by mass.
@@ -51,9 +59,10 @@ 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.usepatch.com/#/?id=orders)
+[API Reference](https://docs.patch.io/#/?id=orders)
 
 #### Examples
+
 ```ruby
 # Create an order - you can create an order
 # providing either mass_g or total_price_cents_usd, but not both
@@ -92,11 +101,13 @@ 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 a mass estimate
 mass = 1_000_000 # Pass in the mass in grams (i.e. 1 metric tonne)
@@ -128,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)
@@ -142,6 +157,7 @@ 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:
@@ -150,9 +166,10 @@ When fetching Projects, you can add filters to the query to narrow the result. C
 - `type`
 - `minimum_available_mass`
 
-[API Reference](https://docs.usepatch.com/#/?id=projects)
+[API Reference](https://docs.patch.io/#/?id=projects)
 
 #### Examples
+
 ```ruby
 # Retrieve a project
 project_id = 'pro_test_1234' # Pass in the project's ID
@@ -176,11 +193,13 @@ 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
@@ -202,26 +221,31 @@ Patch::Preference.retrieve_preferences(page: page)
 ## Development
 
 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/lib/patch_ruby.rb

@@ -18,6 +18,7 @@ require 'patch_ruby/configuration'
 
 # Models
 require 'patch_ruby/models/allocation'
+require 'patch_ruby/models/create_bitcoin_estimate_request'
 require 'patch_ruby/models/create_mass_estimate_request'
 require 'patch_ruby/models/create_order_request'
 require 'patch_ruby/models/create_preference_request'
@@ -36,6 +37,7 @@ require 'patch_ruby/models/preference_response'
 require 'patch_ruby/models/project'
 require 'patch_ruby/models/project_list_response'
 require 'patch_ruby/models/project_response'
+require 'patch_ruby/models/sdg'
 require 'patch_ruby/models/standard'
 
 # APIs

data/lib/patch_ruby/api/estimates_api.rb

@@ -15,6 +15,7 @@ require 'cgi'
 module Patch
   class EstimatesApi
     OPERATIONS = [
+      :create_bitcoin_estimate,
       :create_flight_estimate,
       :create_mass_estimate,
       :create_shipping_estimate,
@@ -28,6 +29,70 @@ 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 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

data/lib/patch_ruby/configuration.rb

@@ -127,7 +127,7 @@ module Patch
 
     def initialize
       @scheme = 'https'
-      @host = 'api.usepatch.com'
+      @host = 'api.patch.io'
       @base_path = ''
       @api_key = {}
       @api_key_prefix = {}
@@ -212,7 +212,7 @@ module Patch
           variables: {
             defaultHost: {
                 description: "No description provided",
-                default_value: "api.usepatch.com",
+                default_value: "api.patch.io",
               }
             }
         }

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

data/lib/patch_ruby/models/create_mass_estimate_request.rb

@@ -98,8 +98,8 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
       end
 
-      if @mass_g < 1
-        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 1.')
+      if @mass_g < 0
+        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 0.')
       end
 
       invalid_properties
@@ -110,7 +110,7 @@ module Patch
     def valid?
       return false if @mass_g.nil?
       return false if @mass_g > 2000000000
-      return false if @mass_g < 1
+      return false if @mass_g < 0
       true
     end
 
@@ -125,8 +125,8 @@ module Patch
         fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
       end
 
-      if mass_g < 1
-        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 1.'
+      if mass_g < 0
+        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 0.'
       end
 
       @mass_g = mass_g

data/lib/patch_ruby/models/create_order_request.rb

@@ -100,8 +100,8 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
       end
 
-      if !@mass_g.nil? && @mass_g < 1
-        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 1.')
+      if !@mass_g.nil? && @mass_g < 0
+        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 0.')
       end
 
       if !@total_price_cents_usd.nil? && @total_price_cents_usd < 1
@@ -115,7 +115,7 @@ module Patch
     # @return true if the model is valid
     def valid?
       return false if !@mass_g.nil? && @mass_g > 2000000000
-      return false if !@mass_g.nil? && @mass_g < 1
+      return false if !@mass_g.nil? && @mass_g < 0
       return false if !@total_price_cents_usd.nil? && @total_price_cents_usd < 1
       true
     end
@@ -127,8 +127,8 @@ module Patch
         fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
       end
 
-      if !mass_g.nil? && mass_g < 1
-        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 1.'
+      if !mass_g.nil? && mass_g < 0
+        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 0.'
       end
 
       @mass_g = mass_g

data/lib/patch_ruby/models/order.rb

@@ -38,6 +38,9 @@ module Patch
     # An array containing the inventory allocations for this order.
     attr_accessor :allocations
 
+    # The url of this order in the public registry.
+    attr_accessor :registry_url
+
     # An optional JSON object containing metadata for this order.
     attr_accessor :metadata
 
@@ -74,6 +77,7 @@ module Patch
         :'price_cents_usd' => :'price_cents_usd',
         :'patch_fee_cents_usd' => :'patch_fee_cents_usd',
         :'allocations' => :'allocations',
+        :'registry_url' => :'registry_url',
         :'metadata' => :'metadata'
       }
     end
@@ -89,6 +93,7 @@ module Patch
         :'price_cents_usd' => :'String',
         :'patch_fee_cents_usd' => :'String',
         :'allocations' => :'Array<Allocation>',
+        :'registry_url' => :'String',
         :'metadata' => :'Object'
       }
     end
@@ -164,6 +169,10 @@ module Patch
         end
       end
 
+      if attributes.key?(:'registry_url')
+        self.registry_url = attributes[:'registry_url']
+      end
+
       if attributes.key?(:'metadata')
         self.metadata = attributes[:'metadata']
       end
@@ -185,8 +194,8 @@ module Patch
         invalid_properties.push('invalid value for "mass_g", must be smaller than or equal to 2000000000.')
       end
 
-      if @mass_g < 1
-        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 1.')
+      if @mass_g < 0
+        invalid_properties.push('invalid value for "mass_g", must be greater than or equal to 0.')
       end
 
       if @production.nil?
@@ -218,10 +227,10 @@ module Patch
       return false if @id.nil?
       return false if @mass_g.nil?
       return false if @mass_g > 2000000000
-      return false if @mass_g < 1
+      return false if @mass_g < 0
       return false if @production.nil?
       return false if @state.nil?
-      state_validator = EnumAttributeValidator.new('String', ["draft", "placed", "complete", "cancelled"])
+      state_validator = EnumAttributeValidator.new('String', ["draft", "placed", "processing", "complete", "cancelled"])
       return false unless state_validator.valid?(@state)
       return false if @allocation_state.nil?
       allocation_state_validator = EnumAttributeValidator.new('String', ["pending", "partially_allocated", "allocated"])
@@ -242,8 +251,8 @@ module Patch
         fail ArgumentError, 'invalid value for "mass_g", must be smaller than or equal to 2000000000.'
       end
 
-      if mass_g < 1
-        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 1.'
+      if mass_g < 0
+        fail ArgumentError, 'invalid value for "mass_g", must be greater than or equal to 0.'
       end
 
       @mass_g = mass_g
@@ -252,7 +261,7 @@ module Patch
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] state Object to be assigned
     def state=(state)
-      validator = EnumAttributeValidator.new('String', ["draft", "placed", "complete", "cancelled"])
+      validator = EnumAttributeValidator.new('String', ["draft", "placed", "processing", "complete", "cancelled"])
       unless validator.valid?(state)
         fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
       end
@@ -282,6 +291,7 @@ module Patch
           price_cents_usd == o.price_cents_usd &&
           patch_fee_cents_usd == o.patch_fee_cents_usd &&
           allocations == o.allocations &&
+          registry_url == o.registry_url &&
           metadata == o.metadata
     end
 
@@ -294,7 +304,7 @@ module Patch
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, mass_g, production, state, allocation_state, price_cents_usd, patch_fee_cents_usd, allocations, metadata].hash
+      [id, mass_g, production, state, allocation_state, price_cents_usd, patch_fee_cents_usd, allocations, registry_url, metadata].hash
     end
 
     # Builds the object from hash

data/lib/patch_ruby/models/project.rb

@@ -26,7 +26,7 @@ module Patch
     # The description of the project.
     attr_accessor :description
 
-    # The type of carbon removal project, currently available project types are Biomass, Dac, Forestry, Mineralization, Ocean, Soil.
+    # The type of carbon removal project, currently available project types are Biomass, Dac, Forestry, Mineralization, Ocean, Renewables, Soil.
     attr_accessor :type
 
     # The country of origin of the project.
@@ -246,7 +246,7 @@ module Patch
       return false if @production.nil?
       return false if @name.nil?
       return false if @description.nil?
-      type_validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "soil"])
+      type_validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "renewables", "soil"])
       return false unless type_validator.valid?(@type)
       return false if @country.nil?
       return false if @developer.nil?
@@ -258,7 +258,7 @@ module Patch
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "soil"])
+      validator = EnumAttributeValidator.new('String', ["biomass", "dac", "forestry", "mineralization", "ocean", "renewables", "soil"])
       unless validator.valid?(type)
         fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end

data/lib/patch_ruby/version.rb

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

data/patch_ruby.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Patch Technology"]
   s.email       = ["developers@usepatch.com"]
-  s.homepage    = "https://www.usepatch.com"
+  s.homepage    = "https://www.patch.io"
   s.summary     = "Ruby wrapper for the Patch API"
   s.description = "Ruby wrapper for the Patch API"
   s.license     = 'MIT'

data/spec/configuration_spec.rb

@@ -18,7 +18,7 @@ describe Patch::Configuration do
   before(:each) do
     # uncomment below to setup host and base_path
     # require 'URI'
-    # uri = URI.parse("https://api.usepatch.com")
+    # uri = URI.parse("https://api.patch.io")
     # Patch.configure do |c|
     #   c.host = uri.host
     #   c.base_path = uri.path
@@ -28,14 +28,14 @@ describe Patch::Configuration do
   describe '#base_url' do
     it 'should have the default value' do
       # uncomment below to test default value of the base path
-      # expect(config.base_url).to eq("https://api.usepatch.com")
+      # expect(config.base_url).to eq("https://api.patch.io")
     end
 
     it 'should remove trailing slashes' do
       [nil, '', '/', '//'].each do |base_path|
         config.base_path = base_path
         # uncomment below to test trailing slashes
-        # expect(config.base_url).to eq("https://api.usepatch.com")
+        # expect(config.base_url).to eq("https://api.patch.io")
       end
     end
   end

data/spec/integration/estimates_spec.rb

@@ -79,4 +79,24 @@ RSpec.describe 'Estimates Integration' do
     expect(create_estimate_response.data.type).to eq 'shipping'
     expect(create_estimate_response.data.mass_g).to eq 12_431
   end
+
+  it 'supports creating bitcoin estimates with partial information' do
+    bitcoin_estimate = Patch::Estimate.create_bitcoin_estimate({ create_order: false })
+
+    expect(bitcoin_estimate.data.type).to eq 'bitcoin'
+    expect(bitcoin_estimate.data.mass_g).to be >= 2_000
+  end
+
+  it 'supports creating bitcoin estimates with a transaction amount' do
+    bitcoin_estimate = Patch::Estimate.create_bitcoin_estimate(
+      transaction_value_btc_sats: 10_000
+    )
+
+    bitcoin_estimate_2 = Patch::Estimate.create_bitcoin_estimate(
+      transaction_value_btc_sats: 100_000
+    )
+
+    expect(bitcoin_estimate.data.type).to eq 'bitcoin'
+    expect(bitcoin_estimate.data.mass_g).to be < bitcoin_estimate_2.data.mass_g
+  end
 end

data/spec/integration/orders_spec.rb

@@ -40,11 +40,13 @@ RSpec.describe 'Orders Integration' do
 
     create_order_response = Patch::Order.create_order(mass_g: order_mass_g, project_id: project_id)
 
+    order = create_order_response.data
     expect(create_order_response.success).to eq true
-    expect(create_order_response.data.id).not_to be_nil
-    expect(create_order_response.data.mass_g).to eq(order_mass_g)
-    expect(create_order_response.data.price_cents_usd.to_i).to eq(expected_price)
-    expect(create_order_response.data.patch_fee_cents_usd).not_to be_empty
+    expect(order.id).not_to be_nil
+    expect(order.mass_g).to eq(order_mass_g)
+    expect(order.price_cents_usd.to_i).to be_between(expected_price - 2, expected_price + 2)
+    expect(order.patch_fee_cents_usd).not_to be_empty
+    expect(order.registry_url).not_to be_empty
   end
 
   it 'supports create with a total price' do
@@ -65,12 +67,14 @@ RSpec.describe 'Orders Integration' do
     order = create_order_response.data
 
     expect(order.id).not_to be_nil
-    expect(order.mass_g).to eq(5_00_000)
+    expect(order.mass_g).to be > 450_000
+    expect(order.mass_g).to be < 460_000
     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
     ).to eq(total_price_cents_usd)
+    expect(order.registry_url).not_to be_empty
   end
 
   it 'supports create with metadata' do

data/spec/patch_ruby_spec.rb

@@ -0,0 +1,18 @@
+describe Patch do
+  context 'Models' do
+    it 'defines all models' do
+      constants.each do |constant|
+        expect { Patch.const_get(constant) }.not_to raise_error
+      end
+    end
+  end
+
+  def constants
+    # Given a file path return the constant of that path, for example:
+    # 'lib/patch_ruby/models/project_response.rb' -> ProjectResponse
+    Dir.glob("lib/patch_ruby/models/*.rb").map do |file|
+      parsed_filename = file.split('/').last.split('.').first
+      constant = parsed_filename.split('_').map(&:capitalize).join('')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patch_ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Patch Technology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -92,6 +92,7 @@ files:
 - lib/patch_ruby/api_error.rb
 - 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_mass_estimate_request.rb
 - lib/patch_ruby/models/create_order_request.rb
 - lib/patch_ruby/models/create_preference_request.rb
@@ -161,9 +162,10 @@ files:
 - spec/models/project_list_response_spec.rb
 - spec/models/project_response_spec.rb
 - spec/models/project_spec.rb
+- spec/patch_ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/generated_classes.rb
-homepage: https://www.usepatch.com
+homepage: https://www.patch.io
 licenses:
 - MIT
 metadata: {}
@@ -187,52 +189,53 @@ signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Patch API
 test_files:
-- 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/orders_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
 - spec/constants.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/order_responses.rb
 - spec/factories/preferences.rb
-- spec/factories/preference_responses.rb
-- spec/factories/error_responses.rb
+- spec/factories/project_responses.rb
 - spec/factories/estimates.rb
+- spec/factories/preference_responses.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/create_preference_requests.rb
+- spec/factories/project_list_responses.rb
+- spec/factories/error_responses.rb
+- spec/factories/meta_index_objects.rb
 - spec/factories/preference_list_responses.rb
+- spec/factories/projects.rb
 - spec/factories/create_mass_estimate_requests.rb
-- spec/integration/estimates_spec.rb
-- spec/integration/preferences_spec.rb
+- spec/factories/order_responses.rb
+- spec/factories/allocations.rb
+- spec/factories/orders.rb
+- spec/factories/create_order_requests.rb
+- spec/factories/estimate_responses.rb
 - spec/integration/orders_spec.rb
+- spec/integration/preferences_spec.rb
+- spec/integration/estimates_spec.rb
 - spec/integration/projects_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/preference_spec.rb
+- spec/models/estimate_response_spec.rb
+- spec/models/error_response_spec.rb
 - spec/models/estimate_list_response_spec.rb
+- spec/models/create_mass_estimate_request_spec.rb
 - spec/models/project_spec.rb
+- spec/models/order_spec.rb
+- spec/models/preference_response_spec.rb
+- spec/models/order_list_response_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/preference_response_spec.rb
+- spec/models/order_response_spec.rb
+- spec/models/preference_list_response_spec.rb
+- spec/models/allocation_spec.rb
+- spec/models/create_order_request_spec.rb
+- spec/patch_ruby_spec.rb
 - spec/spec_helper.rb
 - spec/support/shared/generated_classes.rb