Merge pull request #31 from patch-technology/pc/16

Add bitcoin estimates and registry_url

Author: pcothenet

.github/workflows/test.yml

@@ -9,14 +9,19 @@ jobs:
   build-and-test:
     name: Build and Test
     runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [3.0.1, 2.7.4, 2.6.8]
+
     steps:
       - name: Check out code
         uses: actions/checkout@v2
 
-      - name: Setup Ruby
+      - name: Setup Ruby ${{ matrix.ruby-version }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.1
+          ruby-version: ${{ matrix.ruby-version }}
 
       - name: Install Ruby Dependencies
         run: bundle install

CHANGELOG.md

@@ -5,6 +5,13 @@ 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

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
 ```

lib/patch_ruby.rb

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

lib/patch_ruby/api/estimates_api.rb

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

lib/patch_ruby/api/orders_api.rb

@@ -28,7 +28,7 @@ def initialize(api_client = ApiClient.default)
       @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 @@ def cancel_order(id, opts = {})
     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