squake 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8777e0847a6851455fbf62736f46f685c18a393e33a1586f1f879ceee4fdc4ba
-  data.tar.gz: b6c5bb698721fdce1b2d51e552ac3d1c82fac4f8330098667b4f6a17f20b0bd2
+  metadata.gz: 8d74376a8394904dde68ee22c591d59a26de63cc3f7273077cec9d1c755a8e01
+  data.tar.gz: ebf2977af63c7874817ee0251a3f3ce117f2da242597c31c07a43326eec984a8
 SHA512:
-  metadata.gz: 5c701fef3eb69146d564477e923f551328f6e5898161e58fc65ed659ed7e2c5796d02f432359fb19b1a7ea611524de3ff0daa7dbe891f963b6c1c70f62feffd7
-  data.tar.gz: 55f77258422c2f3fc525a63d2815fd3e68edf5480145e2629d4738489e42df9eafb43bb4f4de81c0ad8c9593482992eca2afbf039488ef225c2be2ee414a676d
+  metadata.gz: 5a93a636570247e9a16cf6d81b2ee94c37271d00d75516e104a7813b508173cf80f6b301422e9b5c037751a857b9a490afa2d077522aa09d50d88b96780d4be8
+  data.tar.gz: a0742ff2711d8c0e461ae6594135a532908afe498a2cca43036d7e34c981f33d928157dfe36ceb6e0af92ec1d8f3c17dc3f0e4d41e4b423a4a264b0f855e8bd7

data/README.md

@@ -123,11 +123,12 @@ end
 
 ```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
+  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
+  payment_link_return_url: 'https://squake.earth', # optional, default: nil
 )
 
 if context.success?
@@ -159,12 +160,13 @@ end
 
 ```ruby
 context = Squake::CalculationWithPricing.quote(
-  items: items,          # required
-  product: 'product-id', # required
-  currency: 'EUR',       # optional, default: 'EUR'
-  carbon_unit: 'gram',   # optional, default: 'gram', other options: 'kilogram', 'tonne'
-  expand: [],            # optional, default: [], allowed values: 'items', 'product', 'price' to enrich the response
-  client: client,        # optional
+  items: items,                                    # required
+  product: 'product-id',                           # required
+  currency: 'EUR',                                 # optional, default: 'EUR'
+  carbon_unit: 'gram',                             # optional, default: 'gram', other options: 'kilogram', 'tonne'
+  expand: [],                                      # optional, default: [], allowed values: 'items', 'product', 'price' to enrich the response
+  payment_link_return_url: 'https://squake.earth', # optional, default: nil
+  client: client,                                  # optional
 )
 
 if context.success?

data/lib/squake/calculation_with_pricing.rb

@@ -15,12 +15,14 @@ module Squake
         currency: String,
         carbon_unit: String,
         expand: T::Array[String],
+        payment_link_return_url: T.nilable(String),
         client: Squake::Client,
         request_id: T.nilable(String),
       ).returns(Squake::Return[Squake::Model::Pricing])
     end
     def self.quote(
-      items:, product:, currency: 'EUR', carbon_unit: 'gram', expand: [], client: Squake::Client.new, request_id: nil
+      items:, product:, currency: 'EUR', carbon_unit: 'gram',
+      expand: [], payment_link_return_url: nil, client: Squake::Client.new, request_id: nil
     )
       # @TODO: add typed objects for all possible items. Until then, we allow either a Hash or a T::Struct
       items = items.map do |item|
@@ -37,6 +39,7 @@ module Squake
           currency: currency,
           carbon_unit: carbon_unit,
           expand: expand,
+          payment_link_return_url: payment_link_return_url,
         },
       )
 

data/lib/squake/client.rb

@@ -68,7 +68,7 @@ module Squake
 
       headers = request_headers(api_key).merge!(headers)
       query = query_params ? Util.encode_parameters(query_params) : nil
-      body = body_params ? ::Oj.dump(body_params) : nil
+      body = body_params ? ::Oj.dump(body_params, Squake::OJ_CONFIG) : nil
       sanitized_path = path[0] == '/' ? path : "/#{path}"
       uri = URI.parse(api_base + sanitized_path)
 
@@ -93,6 +93,7 @@ module Squake
           'http.route': request.path,
           'http.headers': request.to_hash,
         },
+        Squake::OJ_CONFIG,
       )
       canonical_request_line.gsub!(api_key, 'API_KEY_REDACTED')
       @config.logger.info(canonical_request_line)
@@ -118,7 +119,7 @@ module Squake
 
     sig { params(result_body: T.untyped).returns(JsonResponseBody) }
     private def try_parse_json(result_body)
-      ::Oj.load(result_body, symbol_keys: true)
+      ::Oj.load(result_body, Squake::OJ_CONFIG)
     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 } }

data/lib/squake/pricing.rb

@@ -16,13 +16,14 @@ module Squake
         carbon_quantity: T.nilable(Numeric),
         carbon_unit: T.nilable(String),
         expand: T::Array[String],
+        payment_link_return_url: T.nilable(String),
         client: Squake::Client,
         request_id: T.nilable(String),
       ).returns(Squake::Return[Squake::Model::Pricing])
     end
-    def self.quote(
+    def self.quote( # rubocop:disable Metrics/ParameterLists
       product_id:, fixed_total: nil, currency: 'EUR', carbon_quantity: nil, carbon_unit: 'gram',
-      expand: [], client: Squake::Client.new, request_id: nil
+      expand: [], payment_link_return_url: nil, client: Squake::Client.new, request_id: nil
     )
 
       result = client.call(
@@ -36,6 +37,7 @@ module Squake
           carbon_quantity: carbon_quantity,
           carbon_unit: carbon_unit,
           expand: expand,
+          payment_link_return_url: payment_link_return_url,
         },
       )
 

data/lib/squake/response.rb

@@ -36,7 +36,7 @@ module Squake
       <<~TXT
         Failed Request
           http_code=#{code}
-          body=#{::Oj.dump(body)}
+          body=#{::Oj.dump(body, Squake::OJ_CONFIG)}
           original_request_http_method=#{original_request.method}
           original_request_http_path=#{original_request.path}
       TXT

data/lib/squake/version.rb

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

data/lib/squake.rb

@@ -5,14 +5,21 @@ require 'sorbet-runtime'
 require 'oj'
 require 'net/http'
 
-Oj.default_options = {
-  mode: :compat, # required to dump hashes with symbol-keys
-  symbol_keys: true,
-}
-
 Dir[File.join(__dir__, './**/*', '*.rb')].each { require(_1) }
 
 module Squake
+  # Don't freeze this constant, since we don't know what Oj is doing with the object under the hood
+  # Don't set this as global Oj settings to avoid bleeding into other apps that build on this gem
+  # rubocop:disable Style/MutableConstant
+  OJ_CONFIG = T.let(
+    {
+      mode: :compat, # required to dump hashes with symbol-keys
+      symbol_keys: true,
+    },
+    T::Hash[Symbol, T.untyped],
+  )
+  # rubocop:enable Style/MutableConstant
+
   class << self
     extend T::Sig
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squake
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - SQUAKE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2024-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -218,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.5.3
 signing_key:
 specification_version: 4
 summary: The industry solution for sustainable travel and logistics.