patch_ruby 1.5.2 → 1.9.0

data/lib/patch_ruby/models/create_ethereum_estimate_request.rb

@@ -0,0 +1,264 @@
+=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 :transaction_value_eth_gwei
+
+    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',
+        :'transaction_value_eth_gwei' => :'transaction_value_eth_gwei',
+        :'project_id' => :'project_id',
+        :'create_order' => :'create_order'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'timestamp' => :'String',
+        :'gas_used' => :'Integer',
+        :'transaction_value_eth_gwei' => :'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("transaction_value_eth_gwei")
+
+      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?(:'transaction_value_eth_gwei')
+        self.transaction_value_eth_gwei = attributes[:'transaction_value_eth_gwei']
+      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 &&
+          transaction_value_eth_gwei == o.transaction_value_eth_gwei &&
+          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, transaction_value_eth_gwei, 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/estimate.rb

@@ -20,7 +20,7 @@ module Patch
     # A boolean indicating if this estimate is a production or test mode estimate.
     attr_accessor :production
 
-    # The type of estimate. Available types are mass, flight, shipping, and vehicle.
+    # The type of estimate. Available types are mass, flight, shipping, vehicle, and crypto.
     attr_accessor :type
 
     # The estimated mass in grams for this estimate.

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
@@ -86,9 +90,10 @@ module Patch
         :'production' => :'Boolean',
         :'state' => :'String',
         :'allocation_state' => :'String',
-        :'price_cents_usd' => :'String',
-        :'patch_fee_cents_usd' => :'String',
+        :'price_cents_usd' => :'Integer',
+        :'patch_fee_cents_usd' => :'Integer',
         :'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
@@ -221,7 +230,7 @@ module Patch
       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"])
@@ -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/version.rb

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

data/spec/integration/estimates_spec.rb

@@ -1,10 +1,4 @@
 RSpec.describe 'Estimates Integration' do
-  before do
-    Patch.configure do |config|
-      config.access_token = ENV['SANDBOX_API_KEY']
-    end
-  end
-
   it 'supports create, retrieve and list' do
     create_estimate_response = Patch::Estimate.create_mass_estimate(mass_g: 100)
     estimate_id = create_estimate_response.data.id
@@ -33,7 +27,7 @@ RSpec.describe 'Estimates Integration' do
     )
 
     expect(flight_estimate.data.type).to eq 'flight'
-    expect(flight_estimate.data.mass_g).to eq 1_031_697
+    expect(flight_estimate.data.mass_g).to eq 1_000_622
   end
 
   it 'supports creating vehicle estimates' do
@@ -79,4 +73,57 @@ 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
+
+  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

data/spec/integration/orders_spec.rb

@@ -1,10 +1,4 @@
 RSpec.describe 'Orders Integration' do
-  before do
-    Patch.configure do |config|
-      config.access_token = ENV['SANDBOX_API_KEY']
-    end
-  end
-
   it 'supports create, place, cancel, retrieve and list' do
     create_order_response = Patch::Order.create_order(mass_g: 100)
     order_id = create_order_response.data.id
@@ -44,8 +38,9 @@ RSpec.describe 'Orders Integration' do
     expect(create_order_response.success).to eq true
     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 - 1, expected_price + 1)
-    expect(order.patch_fee_cents_usd).not_to be_empty
+    expect(order.price_cents_usd).to be_between(expected_price - 2, expected_price + 2)
+    expect(order.patch_fee_cents_usd).to be_kind_of(Integer)
+    expect(order.registry_url).not_to be_empty
   end
 
   it 'supports create with a total price' do
@@ -54,7 +49,7 @@ RSpec.describe 'Orders Integration' do
     )
 
     project_id = retrieve_project_response.data.id
-    total_price_cents_usd = 5_00
+    total_price_cents_usd = 50_00
 
     create_order_response = Patch::Order.create_order(
       total_price_cents_usd: total_price_cents_usd,
@@ -66,23 +61,28 @@ 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.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.price_cents_usd + order.patch_fee_cents_usd).to eq total_price_cents_usd
+    expect(order.registry_url).not_to be_empty
   end
 
-  it 'supports create with metadata' do
+  it 'supports creation with and querying by metadata' do
     metadata = { user: 'john doe' }
 
-    create_order_response = Patch::Order.create_order(mass_g: 100, metadata: metadata)
+    create_order_response =
+      Patch::Order.create_order(mass_g: 100, metadata: metadata)
 
     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(100)
     expect(create_order_response.data.metadata).to eq(metadata)
+
+    retrieve_orders_response = Patch::Order.retrieve_orders(
+      page: 1, metadata: { user: 'john' }
+    )
+    expect(retrieve_orders_response.success).to eq true
+    expect(retrieve_orders_response.data.count).to be >= 1
+    expect(retrieve_orders_response.data.map(&:metadata))
+      .to all(have_key(:user))
   end
 
   it 'supports place and cancel for orders created via an estimate' do