patch_ruby 1.21.0 → 1.24.0

data/lib/patch_ruby/models/v1_orders_issued_to.rb

@@ -0,0 +1,239 @@
+=begin
+#Patch API V1
+
+#The core API used to integrate with Patch's service
+
+The version of the OpenAPI document: v1
+Contact: engineering@usepatch.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.3.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Patch
+  class V1OrdersIssuedTo
+    attr_accessor :email
+
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'email' => :'email',
+        :'name' => :'name'
+      }
+    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
+      {
+        :'email' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'email',
+        :'name'
+      ])
+    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::V1OrdersIssuedTosApi::OPERATIONS') && Patch::V1OrdersIssuedTosApi::OPERATIONS.include?(message)
+        Patch::V1OrdersIssuedTosApi.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::V1OrdersIssuedTo` 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::V1OrdersIssuedTo`. 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?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      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 &&
+          email == o.email &&
+          name == o.name
+    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
+      [email, name].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/lib/patch_ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.1
 =end
 
 module Patch
-  VERSION = '1.21.0'
+  VERSION = '1.24.0'
 end

data/lib/patch_ruby.rb

@@ -18,12 +18,16 @@ require 'patch_ruby/configuration'
 
 # Models
 require 'patch_ruby/models/allocation'
+require 'patch_ruby/models/create_air_shipping_estimate_request'
 require 'patch_ruby/models/create_bitcoin_estimate_request'
 require 'patch_ruby/models/create_ethereum_estimate_request'
 require 'patch_ruby/models/create_flight_estimate_request'
 require 'patch_ruby/models/create_hotel_estimate_request'
 require 'patch_ruby/models/create_mass_estimate_request'
 require 'patch_ruby/models/create_order_request'
+require 'patch_ruby/models/create_rail_shipping_estimate_request'
+require 'patch_ruby/models/create_road_shipping_estimate_request'
+require 'patch_ruby/models/create_sea_shipping_estimate_request'
 require 'patch_ruby/models/create_shipping_estimate_request'
 require 'patch_ruby/models/create_success_response'
 require 'patch_ruby/models/create_vehicle_estimate_request'
@@ -33,6 +37,7 @@ require 'patch_ruby/models/estimate_list_response'
 require 'patch_ruby/models/estimate_response'
 require 'patch_ruby/models/highlight'
 require 'patch_ruby/models/inventory'
+require 'patch_ruby/models/issued_to'
 require 'patch_ruby/models/meta_index_object'
 require 'patch_ruby/models/order'
 require 'patch_ruby/models/order_inventory'
@@ -41,6 +46,7 @@ require 'patch_ruby/models/order_list_response'
 require 'patch_ruby/models/order_response'
 require 'patch_ruby/models/parent_technology_type'
 require 'patch_ruby/models/photo'
+require 'patch_ruby/models/place_order_request'
 require 'patch_ruby/models/project'
 require 'patch_ruby/models/project_list_response'
 require 'patch_ruby/models/project_response'
@@ -48,6 +54,7 @@ require 'patch_ruby/models/sdg'
 require 'patch_ruby/models/standard'
 require 'patch_ruby/models/technology_type'
 require 'patch_ruby/models/technology_type_list_response'
+require 'patch_ruby/models/v1_orders_issued_to'
 
 # APIs
 require 'patch_ruby/api/estimates_api'

data/spec/integration/estimates_spec.rb

@@ -171,4 +171,155 @@ RSpec.describe 'Estimates Integration' do
     expect(create_estimate_response.data.mass_g).to be >= 100_000
     expect(create_estimate_response.data.id).not_to be_nil
   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 >= 20_000
+    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 >= 20_000
+      expect(air_shipping_estimate.data.order.amount).to be >= 10_000
+    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 >= 15_000
+    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 >= 4_000
+    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 >= 15_000
+      expect(rail_shipping_estimate.data.order.amount).to be >= 10_000
+    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 >= 15_000
+    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 >= 4_000
+    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 >= 15_000
+      expect(road_shipping_estimate.data.order.amount).to be >= 10_000
+    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 >= 10_000
+    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 >= 4_000
+    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 >= 15_000
+      expect(sea_shipping_estimate.data.order.amount).to be >= 10_000
+    end
+  end
 end

data/spec/integration/orders_spec.rb

@@ -42,6 +42,29 @@ RSpec.describe 'Orders Integration' do
     expect(order.registry_url).not_to be_empty
   end
 
+  it 'supports create with issued_to' do
+    retrieve_project_response = Patch::Project.retrieve_project(
+      Constants::BIOMASS_TEST_PROJECT_ID
+    )
+
+    issued_to = { email: 'envimpact@companyb.com', name: 'Company B' }
+    total_price_cents_usd = 50_00
+
+    create_order_response = Patch::Order.create_order(
+      total_price_cents_usd: total_price_cents_usd,
+      issued_to: issued_to
+    )
+
+    expect(create_order_response.success).to eq true
+
+    order = create_order_response.data
+
+    expect(order.id).not_to be_nil
+    expect(order.price_cents_usd + order.patch_fee_cents_usd).to eq total_price_cents_usd
+    expect(order.issued_to.email).to eq(issued_to[:email])
+    expect(order.issued_to.name).to eq(issued_to[:name])
+  end
+
   it 'supports create with a total price' do
     retrieve_project_response = Patch::Project.retrieve_project(
       Constants::BIOMASS_TEST_PROJECT_ID
@@ -108,6 +131,17 @@ RSpec.describe 'Orders Integration' do
     expect(cancel_order_response.data.state).to eq 'cancelled'
   end
 
+  it 'supports place order with issued_to' do
+    create_estimate_to_place_response = Patch::Estimate.create_mass_estimate(mass_g: 100, create_order: true)
+    order_to_place_id = create_estimate_to_place_response.data.order.id
+
+    issued_to = { email: 'envimpact@companya.com', name: 'Company A' }
+    place_order_response = Patch::Order.place_order(order_to_place_id, issued_to: issued_to)
+    expect(place_order_response.data.state).to eq 'placed'
+    expect(place_order_response.data.issued_to.email).to eq(issued_to[:email])
+    expect(place_order_response.data.issued_to.name).to eq(issued_to[:name])
+  end
+
   it 'supports create with a vintage year' do
     create_order_response =
       Patch::Order.create_order(mass_g: 100, vintage_year: 2022)

data/spec/integration/projects_spec.rb

@@ -38,40 +38,48 @@ RSpec.describe 'Projects Integration' do
     end
   end
 
-  describe 'returned fields' do
-    it 'returns the expected fields' do
-      project = Patch::Project.retrieve_projects(page: 1).data.first
-
-      keys = attributes_for(:project).keys
-      expect(project.to_hash.keys).to include(*keys)
-
-      expect(project.photos).to be_an_instance_of(Array)
-      expect(project.average_price_per_tonne_cents_usd)
-        .to be_an_instance_of(Integer)
-      expect(project.remaining_mass_g).to be_an_instance_of(Integer)
-      expect(project.longitude).to be_an_instance_of(Float)
-      expect(project.latitude).to be_an_instance_of(Float)
-
-      expect(project.technology_type)
-        .to be_an_instance_of(Patch::TechnologyType)
-      expect(project.technology_type.name).to be_an_instance_of(String)
-      expect(project.technology_type.slug).to be_an_instance_of(String)
-
-      parent_type = project.technology_type.parent_technology_type
-      expect(parent_type).to be_an_instance_of(Patch::ParentTechnologyType)
-      expect(parent_type.name).to be_an_instance_of(String)
-      expect(parent_type.slug).to be_an_instance_of(String)
-
-      expect(project.highlights).to be_an_instance_of(Array)
-
-      inventory = project.inventory
-      expect(inventory).to be_an_instance_of(Array)
-      expect(inventory[0]).to be_an_instance_of(Patch::Inventory)
-      expect(inventory[0].vintage_year).to be_an_instance_of(Integer)
-      expect(inventory[0].amount_available).to be_an_instance_of(Integer)
-      expect(inventory[0].price).to be_an_instance_of(Integer)
-      expect(inventory[0].currency).to be_an_instance_of(String)
-      expect(inventory[0].unit).to be_an_instance_of(String)
-    end
+  it 'returns the expected fields' do
+    project = Patch::Project.retrieve_projects(page: 1).data.first
+
+    keys = attributes_for(:project).keys
+    expect(project.to_hash.keys).to include(*keys)
+
+    expect(project.photos).to be_an_instance_of(Array)
+    expect(project.average_price_per_tonne_cents_usd)
+      .to be_an_instance_of(Integer)
+    expect(project.remaining_mass_g).to be_an_instance_of(Integer)
+    expect(project.longitude).to be_an_instance_of(Float)
+    expect(project.latitude).to be_an_instance_of(Float)
+
+    expect(project.technology_type)
+      .to be_an_instance_of(Patch::TechnologyType)
+    expect(project.technology_type.name).to be_an_instance_of(String)
+    expect(project.technology_type.slug).to be_an_instance_of(String)
+
+    parent_type = project.technology_type.parent_technology_type
+    expect(parent_type).to be_an_instance_of(Patch::ParentTechnologyType)
+    expect(parent_type.name).to be_an_instance_of(String)
+    expect(parent_type.slug).to be_an_instance_of(String)
+
+    expect(project.highlights).to be_an_instance_of(Array)
+
+    inventory = project.inventory
+    expect(inventory).to be_an_instance_of(Array)
+    expect(inventory[0]).to be_an_instance_of(Patch::Inventory)
+    expect(inventory[0].vintage_year).to be_an_instance_of(Integer)
+    expect(inventory[0].amount_available).to be_an_instance_of(Integer)
+    expect(inventory[0].price).to be_an_instance_of(Integer)
+    expect(inventory[0].currency).to be_an_instance_of(String)
+    expect(inventory[0].unit).to be_an_instance_of(String)
+  end
+
+  it 'retrieves projects in the requested language' do
+    projects_response = Patch::Project.retrieve_projects(accept_language: 'fr')
+
+    expect(projects_response.data.first.name).to include 'Démo' # French
+
+    project_id = projects_response.data.first.id
+    project_response = Patch::Project.retrieve_project(project_id, accept_language: 'fr')
+    expect(project_response.data.name).to include 'Démo' # Frenc
   end
 end

data/spec/models/create_order_request_spec.rb

@@ -31,7 +31,7 @@ describe 'CreateOrderRequest' do
     let(:instance) { @instance }
     let(:instance_hash) { { project_id: @instance.project_id, mass_g: @instance.mass_g, total_price_cents_usd: @instance.total_price_cents_usd, metadata: @instance.metadata } }
     let(:nullable_properties) do
-      Set.new(%i[mass_g total_price_cents_usd project_id metadata state vintage_year total_price currency amount unit])
+      Set.new(%i[mass_g total_price_cents_usd project_id metadata state vintage_year total_price currency amount unit issued_to])
     end
   end