patch_ruby 2.5.0 → 2.6.0

data/lib/patch_ruby/models/estimate_response.rb

@@ -1,257 +0,0 @@
-=begin
-#Patch API V2
-
-#The core API used to integrate with Patch's service
-
-The version of the OpenAPI document: 2
-Contact: engineering@usepatch.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.3.1
-
-=end
-
-require 'date'
-require 'time'
-
-module Patch
-  class EstimateResponse
-    attr_accessor :success
-
-    attr_accessor :error
-
-    attr_accessor :data
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'success' => :'success',
-        :'error' => :'error',
-        :'data' => :'data'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'success' => :'Boolean',
-        :'error' => :'Object',
-        :'data' => :'Estimate'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'error',
-      ])
-    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::EstimateResponsesApi::OPERATIONS') && Patch::EstimateResponsesApi::OPERATIONS.include?(message)
-        Patch::EstimateResponsesApi.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::EstimateResponse` 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::EstimateResponse`. 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?(:'success')
-        self.success = attributes[:'success']
-      end
-
-      if attributes.key?(:'error')
-        self.error = attributes[:'error']
-      end
-
-      if attributes.key?(:'data')
-        self.data = attributes[:'data']
-      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
-      if @success.nil?
-        invalid_properties.push('invalid value for "success", success cannot be nil.')
-      end
-
-      if @data.nil?
-        invalid_properties.push('invalid value for "data", data cannot be nil.')
-      end
-
-      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?
-      return false if @success.nil?
-      return false if @data.nil?
-      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 &&
-          success == o.success &&
-          error == o.error &&
-          data == o.data
-    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
-      [success, error, data].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 attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif 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
-      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 :Time
-        Time.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
-        # models (e.g. Pet) or oneOf
-        klass = Patch.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/spec/api/estimates_api_spec.rb

@@ -1,70 +0,0 @@
-=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 'spec_helper'
-require 'json'
-
-# Unit tests for Patch::EstimatesApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'EstimatesApi' do
-  before do
-    # run before each test
-    @api_instance = Patch::EstimatesApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of EstimatesApi' do
-    it 'should create an instance of EstimatesApi' do
-      expect(@api_instance).to be_instance_of(Patch::EstimatesApi)
-    end
-  end
-
-  # unit tests for create_mass_estimate
-  # Create an estimate based on mass of CO2
-  # Creates an estimate for the mass of CO2 to be compensated. An order in the `draft` state will also be created, linked to the estimate.
-  # @param create_mass_estimate_request
-  # @param [Hash] opts the optional parameters
-  # @return [EstimateResponse]
-  describe 'create_mass_estimate test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for retrieve_estimate
-  # Retrieves an estimate
-  # Retrieves a given estimate and its associated order. You can only retrieve estimates associated with the organization you are querying for.
-  # @param id
-  # @param [Hash] opts the optional parameters
-  # @return [EstimateResponse]
-  describe 'retrieve_estimate test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for retrieve_estimates
-  # Retrieves a list of estimates
-  # Retrieves a list of estimates and their associated orders. You can only retrieve estimates associated with the organization you are querying for.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :page
-  # @return [EstimateListResponse]
-  describe 'retrieve_estimates test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-end

data/spec/factories/create_mass_estimate_requests.rb

@@ -1,6 +0,0 @@
-FactoryBot.define do
-  factory :create_mass_estimate_request, class: Patch::CreateMassEstimateRequest do
-    sequence(:project_id) { |n| n }
-    mass_g { 100 }
-  end
-end

data/spec/factories/estimate_list_responses.rb

@@ -1,8 +0,0 @@
-FactoryBot.define do
-  factory :estimate_list_response, class: Patch::EstimateListResponse do
-    success { true }
-    error { {} }
-    data { {} }
-    meta { {} }
-  end
-end

data/spec/factories/estimate_responses.rb

@@ -1,7 +0,0 @@
-FactoryBot.define do
-  factory :estimate_response, class: Patch::EstimateResponse do
-    success { true }
-    error { {} }
-    data { {} }
-  end
-end

data/spec/factories/estimates.rb

@@ -1,8 +0,0 @@
-FactoryBot.define do
-  factory :estimate, class: Patch::Estimate do
-    sequence(:id) { |n| n }
-    association :order
-    production { false }
-    type { "mass" }
-  end
-end

data/spec/integration/estimates_spec.rb

@@ -1,218 +0,0 @@
-RSpec.describe 'Estimates Integration' do
-  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
-
-    retrieve_estimate_response = Patch::Estimate.retrieve_estimate(estimate_id)
-    expect(retrieve_estimate_response.data.id).to eq estimate_id
-
-    page_limit = 1
-    next_page = 1
-    estimates = []
-
-    while !next_page.nil? && next_page <= page_limit
-      retrieve_estimates_response = Patch::Estimate.retrieve_estimates(page: next_page)
-      next_page = retrieve_estimates_response.meta.next_page
-      estimates += retrieve_estimates_response.data
-    end
-
-    expect(estimates.length).not_to be_zero
-  end
-
-  it 'supports creating bitcoin estimates with partial information' do
-    bitcoin_estimate = Patch::Estimate.create_bitcoin_estimate()
-
-    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 bitcoin estimates with a average_daily_balance_btc_sats' do
-    bitcoin_estimate_1 = Patch::Estimate.create_bitcoin_estimate(
-      average_daily_balance_btc_sats: 1000000
-    )
-
-    bitcoin_estimate_2 = Patch::Estimate.create_bitcoin_estimate(
-      average_daily_balance_btc_sats: 10000000
-    )
-
-    expect(bitcoin_estimate_1.data.type).to eq 'bitcoin'
-    expect(bitcoin_estimate_1.data.mass_g).to be < bitcoin_estimate_2.data.mass_g
-  end
-
-  context "when creating an air shipping estimate" do
-    it "supports creating an estimate using airports" do
-      air_shipping_estimate = Patch::Estimate.create_air_shipping_estimate(
-        aircraft_type: "cargo",
-        create_order: false,
-        destination_airport: "JFK",
-        freight_mass_g: 31_300,
-        origin_airport: "SFO"
-      )
-      expect(air_shipping_estimate.data.type).to eq('shipping_air')
-      expect(air_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate with an order" do
-      air_shipping_estimate = Patch::Estimate.create_air_shipping_estimate(
-        aircraft_type: "cargo",
-        create_order: true,
-        destination_airport: "JFK",
-        freight_mass_g: 19_140,
-        origin_airport: "SFO"
-      )
-      expect(air_shipping_estimate.data.type).to eq('shipping_air')
-      expect(air_shipping_estimate.data.mass_g).to be > 0
-      expect(air_shipping_estimate.data.order.amount).to be > 0
-    end
-  end
-
-  context "when creating a rail shipping estimate" do
-    it "supports creating an estimate using locodes" do
-      rail_shipping_estimate = Patch::Estimate.create_rail_shipping_estimate(
-        create_order: false,
-        destination_locode: "USSEA",
-        emissions_scope: "wtw",
-        freight_mass_g: 419_060,
-        fuel_type: "diesel",
-        origin_locode: "USSD2"
-      )
-      expect(rail_shipping_estimate.data.type).to eq('shipping_rail')
-      expect(rail_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate using postal codes" do
-      rail_shipping_estimate = Patch::Estimate.create_rail_shipping_estimate(
-        create_order: false,
-        destination_country_code: "US",
-        destination_postal_code: "97209",
-        emissions_scope: "wtw",
-        freight_mass_g: 226_000,
-        fuel_type: "diesel",
-        origin_country_code: "US",
-        origin_postal_code: "90210"
-      )
-      expect(rail_shipping_estimate.data.type).to eq('shipping_rail')
-      expect(rail_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate with an order" do
-      rail_shipping_estimate = Patch::Estimate.create_rail_shipping_estimate(
-        create_order: true,
-        destination_locode: "USSEA",
-        freight_mass_g: 359_000,
-        origin_locode: "USSD2"
-      )
-      expect(rail_shipping_estimate.data.type).to eq('shipping_rail')
-      expect(rail_shipping_estimate.data.mass_g).to be > 0
-      expect(rail_shipping_estimate.data.order.amount).to be > 0
-    end
-  end
-
-  context "when creating a road shipping estimate" do
-    it "supports creating an estimate using locodes" do
-      road_shipping_estimate = Patch::Estimate.create_road_shipping_estimate(
-        create_order: false,
-        container_size_code: "20GP",
-        destination_locode: "USSEA",
-        emissions_scope: "wtw",
-        freight_mass_g: 124_870,
-        origin_locode: "USSD2"
-      )
-      expect(road_shipping_estimate.data.type).to eq('shipping_road')
-      expect(road_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate using postal codes" do
-      road_shipping_estimate = Patch::Estimate.create_road_shipping_estimate(
-        create_order: false,
-        destination_country_code: "US",
-        destination_postal_code: "97209",
-        emissions_scope: "wtw",
-        freight_mass_g: 226_000,
-        origin_country_code: "US",
-        origin_postal_code: "90210"
-      )
-      expect(road_shipping_estimate.data.type).to eq('shipping_road')
-      expect(road_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate with an order" do
-      road_shipping_estimate = Patch::Estimate.create_road_shipping_estimate(
-        create_order: true,
-        destination_locode: "USSEA",
-        freight_mass_g: 359_000,
-        origin_locode: "USSD2"
-      )
-      expect(road_shipping_estimate.data.type).to eq('shipping_road')
-      expect(road_shipping_estimate.data.mass_g).to be > 0
-      expect(road_shipping_estimate.data.order.amount).to be > 0
-    end
-  end
-
-  context "when creating a sea shipping estimate" do
-    it "supports creating an estimate using locodes" do
-      sea_shipping_estimate = Patch::Estimate.create_sea_shipping_estimate(
-        create_order: false,
-        container_size_code: "20GP",
-        destination_locode: "HKHKG",
-        emissions_scope: "wtw",
-        freight_mass_g: 124_870,
-        origin_locode: "FRMRS"
-      )
-      expect(sea_shipping_estimate.data.type).to eq('shipping_sea')
-      expect(sea_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate using postal codes" do
-      sea_shipping_estimate = Patch::Estimate.create_sea_shipping_estimate(
-        create_order: false,
-        destination_country_code: "US",
-        destination_postal_code: "97209",
-        emissions_scope: "wtw",
-        freight_mass_g: 226_000,
-        origin_country_code: "US",
-        origin_postal_code: "90210"
-      )
-      expect(sea_shipping_estimate.data.type).to eq('shipping_sea')
-      expect(sea_shipping_estimate.data.mass_g).to be > 0
-    end
-
-    it "supports creating an estimate with an order" do
-      sea_shipping_estimate = Patch::Estimate.create_sea_shipping_estimate(
-        create_order: true,
-        destination_locode: "USSEA",
-        freight_mass_g: 359_000,
-        origin_locode: "USSD2"
-      )
-      expect(sea_shipping_estimate.data.type).to eq('shipping_sea')
-      expect(sea_shipping_estimate.data.mass_g).to be > 0
-      expect(sea_shipping_estimate.data.order.amount).to be > 0
-    end
-  end
-end

data/spec/models/create_mass_estimate_request_spec.rb

@@ -1,46 +0,0 @@
-=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 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for Patch::CreateMassEstimateRequest
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'CreateMassEstimateRequest' do
-  before do
-    # run before each test
-    @instance = build(:create_mass_estimate_request)
-  end
-
-  after do
-    # run after each test
-  end
-
-  it_behaves_like "a generated class" do
-    let(:instance) { @instance }
-    let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g, create_order: @instance.create_order } }
-    let(:nullable_properties) { Set.new([:create_order]) }
-  end
-
-  describe 'test an instance of CreateMassEstimateRequest' do
-    it 'should create an instance of CreateMassEstimateRequest' do
-      expect(@instance).to be_instance_of(Patch::CreateMassEstimateRequest)
-    end
-  end
-  describe 'test attribute "mass_g"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-end

data/spec/models/estimate_list_response_spec.rb

@@ -1,64 +0,0 @@
-=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 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for Patch::EstimateListResponse
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'EstimateListResponse' do
-  before do
-    # run before each test
-    @instance = build(:estimate_list_response)
-  end
-
-  after do
-    # run after each test
-  end
-
-  it_behaves_like "a generated class" do
-    let(:instance) { @instance }
-    let(:instance_hash) { { success: @instance.success, error: @instance.error, data: @instance.data, meta: @instance.meta } }
-    let(:nullable_properties) { Set.new([:error]) }
-  end
-
-  describe 'test an instance of EstimateListResponse' do
-    it 'should create an instance of EstimateListResponse' do
-      expect(@instance).to be_instance_of(Patch::EstimateListResponse)
-    end
-  end
-  describe 'test attribute "success"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "error"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "data"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  describe 'test attribute "meta"' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-end