squake 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb49aaa40493fc3d858bd94bd4de78e52f1768ffdfe2c1742e899c77fd3761d
-  data.tar.gz: 20552b4ca63fe916a479cae955dbf81b9711a59cb0d7dc2c30f9edc383e4ee3f
+  metadata.gz: 9b4d311a5ad4fb22fd6ec57a34bf0c1a2d79434d8a90129b79b5bd0bb2336587
+  data.tar.gz: 19dfd1352aa055fe5ee427a5ce4f8b1cb518b8259c770c77c6360c23a7116e06
 SHA512:
-  metadata.gz: 83b29e6ac77d1c990c15316c7449b8e7c8c212f4844a102eeab43b4f67e20b3766a87ce32bd63d505f31a1f2eb88119992f4c53721c9f2b10df70d1b744ede81
-  data.tar.gz: 43cac16e0b7604d144f3196d2ed67fd06a3ffc7e0612acb3f9612de365cd633470c5ebd6d0c7d1912ec10736c93173b8e6b55068eb7ac708af06b1dd7de67a90
+  metadata.gz: 109e5a1cc4e00f3c840252507b17a740a15a4afee802917e56df9d7e3a0c32f0c6d213313193fa2e03b429b821dcddcf4668bf5aac07744c65a4e8425b9fb3b5
+  data.tar.gz: 3f956999206d2b89d4989728a07c75d318fd8e95793df0346237ece389a069d03f31c8103eaf2526d81ab983dc4f1304b5401ea271579a284a378bb83d2b0a16

data/README.md

@@ -117,6 +117,44 @@ else
 end
 ```
 
+### Get a price quote alone
+
+#### For a given carbon quantity
+
+```ruby
+Squake::Pricing.quote(
+  client: squake_client, # optional
+  carbon_quantity: 1000, # required
+  carbon_unit: 'kilogram', # optional, default: 'gram', other options: 'kilogram', 'tonne'
+  product_id: 'some_product_id', # required
+  expand: [], # optional, default: [], allowed values: 'product', 'price' to enrich the response
+)
+
+if context.success?
+  context.result # Squake::Model::Pricing
+else
+  context.errors # [Squake::Errors::APIErrorResult]
+end
+```
+
+#### For a given fixed total
+
+```ruby
+context = Squake::Pricing.quote(
+  client: squake_client, # optional
+  fixed_total: 1000, # required
+  currency: 'USD', # optional, default: 'EUR'
+  product_id: 'some_product_id', # required
+  expand: [], # optional, default: [], allowed values: 'product', 'price' to enrich the response
+)
+
+if context.success?
+  context.result # Squake::Model::Pricing
+else
+  context.errors # [Squake::Errors::APIErrorResult]
+end
+```
+
 ### Calculate emissions and include a price quote
 
 ```ruby

data/lib/squake/client.rb

@@ -121,7 +121,7 @@ module Squake
       ::Oj.load(result_body, symbol_keys: true)
     rescue ::Oj::ParseError, TypeError, JSON::ParserError, EncodingError => e
       # in case of an error, Squake's response body is HTML not JSON
-      { 'error' => { 'message' => e.message, 'body' => result_body } }
+      { error: { 'message' => e.message, 'body' => result_body } }
     end
 
     sig { params(uri: URI::Generic).returns(Net::HTTP) }

data/lib/squake/model/pricing.rb

@@ -49,7 +49,7 @@ module Squake
         Squake::Model::Pricing.new(
           id: response_body.fetch(:id),
           items: items,
-          carbon_quantity: response_body.fetch(:carbon_quantity).to_d,
+          carbon_quantity: BigDecimal(response_body.fetch(:carbon_quantity).to_s),
           carbon_unit: response_body.fetch(:carbon_unit),
           payment_link: response_body.fetch(:payment_link, nil),
           price: price,

data/lib/squake/pricing.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Squake
+  # https://docs-v2.squake.earth/group/endpoint-pricing
+  class Pricing
+    extend T::Sig
+
+    ENDPOINT = T.let('/v2/pricing', String)
+
+    sig do
+      params(
+        product_id: String,
+        fixed_total: T.nilable(Numeric),
+        currency: String,
+        carbon_quantity: T.nilable(Numeric),
+        carbon_unit: T.nilable(String),
+        expand: T::Array[String],
+        client: Squake::Client,
+        request_id: T.nilable(String),
+      ).returns(Squake::Return[Squake::Model::Pricing])
+    end
+    def self.quote(
+      product_id:, fixed_total: nil, currency: 'EUR', carbon_quantity: nil, carbon_unit: 'gram',
+      expand: [], client: Squake::Client.new, request_id: nil
+    )
+
+      result = client.call(
+        path: ENDPOINT,
+        method: :get,
+        headers: { 'X-Request-Id' => request_id }.compact,
+        params: {
+          product: product_id,
+          fixed_total: fixed_total,
+          currency: currency,
+          carbon_quantity: carbon_quantity,
+          carbon_unit: carbon_unit,
+          expand: expand,
+        },
+      )
+
+      if result.success?
+        pricing = Squake::Model::Pricing.from_api_response(
+          T.cast(result.body, T::Hash[Symbol, T.untyped]),
+        )
+        Return.new(result: pricing)
+      else
+        error = Squake::Errors::APIErrorResult.new(
+          code: :"api_error_#{result.code}",
+          detail: result.error_message,
+        )
+        Return.new(errors: [error])
+      end
+    end
+  end
+end

data/lib/squake/products.rb

@@ -30,7 +30,7 @@ module Squake
       )
 
       if result.success?
-        products = T.cast(Array(result.body), T::Array[T::Hash[Symbol, T.untyped]]).map do |product_data|
+        products = [result.body].flatten.map do |product_data|
           Squake::Model::Product.from_api_response(product_data)
         end
         Return.new(result: products)

data/lib/squake/util.rb

@@ -11,13 +11,15 @@ module Squake
     # `&`).
     sig { params(params: T::Hash[Symbol, String]).returns(String) }
     def self.encode_parameters(params)
-      params.map { |k, v| "#{url_encode(k.to_s)}=#{url_encode(v)}" }.join('&')
+      params.map do |k, v|
+        "#{url_encode(k.to_s)}=#{url_encode(v.to_s)}" unless v.nil?
+      end.join('&')
     end
 
     # Encodes a string in a way that makes it suitable for use in a set of
     # query parameters in a URI or in a set of form parameters in a request
     # body.
-    sig { params(key: String).returns(String) }
+    sig { params(key: T.nilable(String)).returns(String) }
     def self.url_encode(key)
       CGI.escape(key.to_s).
         # Don't use strict form encoding by changing the square bracket control

data/lib/squake/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Squake
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squake
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - SQUAKE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-11 00:00:00.000000000 Z
+date: 2023-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -136,6 +136,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem provides an interface for the SQUAKE API to calculate and compensate
   carbon emissions.
 email: oss@squake.earth
@@ -162,6 +190,7 @@ files:
 - lib/squake/model/pricing.rb
 - lib/squake/model/product.rb
 - lib/squake/model/purchase.rb
+- lib/squake/pricing.rb
 - lib/squake/products.rb
 - lib/squake/purchase.rb
 - lib/squake/response.rb
@@ -189,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: The industry solution for sustainable travel and logistics.