squake 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7860b4b9cfbf3110355582ab95ce9faee0055fc6ea852b00093703fbcf8f7c8d
-  data.tar.gz: 6f05154a58469f7f52f9730bf808a3005961b7ba29e7f6ce8fe47e47b27cc651
+  metadata.gz: b36b98d0bbe6be1cfa67c8b2ba81905f7bcdcc929308332b886548bbcd189b56
+  data.tar.gz: ee666e2bbd9f7535c824063dd20d5cb9ca90c72e384ff1ed8983bd7400f81d20
 SHA512:
-  metadata.gz: d2065bbbe6bbbffa5067acf0810dbfe2c3ef32b50b5bce14b949f170a138f29ec16d2897093d9305af615e768ebcaa6da24873660572c24141e09f11b896cf08
-  data.tar.gz: 53f6a57201c32df605f6d30932baa4408bc3eafd7c02fb6f2dff6f55d0313c1e0b0f501980aa93e17bcea5ecd3bc11491f81639d138aa4c60005e62237689e92
+  metadata.gz: d53fd77ab97f24cc6c3102500863865b7e0852d936b45862bfab7c946d301601b34fc0048135601518b645373ab8e67af1495e0acd039447c703c7284f239d84
+  data.tar.gz: 7869d17821522db8690f8c9a1fd0ad950cd8471e7176c3b20f9993b4ad4f01cfb9c6f3d8f1270fb30f77f5bc91f9c5bacb55873d857e60695575c82125100a6a

data/README.md

@@ -34,7 +34,7 @@ You need a different API Key for production and sandbox.
 
 ## Usage
 
-Calculate emissions and include a price quote:
+Initialize the client:
 
 ```ruby
 config = Squake::Config.new(
@@ -48,7 +48,36 @@ config = Squake::Config.new(
 # the SQUAKE client emits canonical log lines, e.g.
 #   Request started http_method=get http_path=/api/v2/calculations
 client = Squake::Client.new(config: config)
+```
+
+Calculate emissions
+
+```ruby
+items = [
+  {
+    type: 'flight',
+    methodology: 'ICAO',
+    origin: 'BER',
+    destination: 'SIN',
+    booking_class: 'economy',
+    number_of_travellers: 2,
+    aircraft_type: '350',
+    external_reference: 'booking-id',
+  }
+]
 
+# returns Squake::Model::Carbon
+carbon = Squake::Calculation.create(
+  client: client,        # required
+  items: items,          # required
+  carbon_unit: 'gram',   # optional, default: 'gram', other options: 'kilogram', 'tonne'
+  expand: [],            # optional, default: [], allowed values: 'items' to enrich the response
+)
+```
+
+Calculate emissions and include a price quote:
+
+```ruby
 # Find all available item types and methodologies here:
 #   https://docs-v2.squake.earth/group/endpoint-calculations
 items = [
@@ -71,6 +100,7 @@ pricing = Squake::CalculationWithPricing.quote(
   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
 )
 ```
 
@@ -98,3 +128,19 @@ Squake::Purchase.cancel(
   id: purchase.id, # required
 )
 ```
+
+## Publishing a new version
+
+Have a Rubygems API key in your `~/.gem/credentials` file.
+
+```shell
+---
+:rubygems_squake: rubygems_xxx
+```
+
+Then run:
+
+```shell
+gem build
+gem push squake-0.1.0.gem --key=rubygems_squake
+```

data/lib/squake/calculation.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+# https://docs-v2.squake.earth/operation/operation-post-calculations
+module Squake
+  class Calculation
+    extend T::Sig
+
+    ENDPOINT = T.let('/v2/calculations', String)
+
+    sig do
+      params(
+        client: Squake::Client,
+        items: T::Array[Squake::Model::Items::BaseType],
+        carbon_unit: String,
+        expand: T::Array[String],
+      ).returns(Squake::Model::Carbon)
+    end
+    def self.create(client:, items:, carbon_unit: 'gram', expand: [])
+      result = client.call(
+        path: ENDPOINT,
+        method: :post,
+        params: {
+          items: items.map(&:serialize),
+          carbon_unit: carbon_unit,
+          expand: expand,
+        },
+      )
+      raise Squake::APIError.new(response: result) unless result.success?
+
+      Squake::Model::Carbon.from_api_response(
+        T.cast(result.body, T::Hash[Symbol, T.untyped]),
+      )
+    end
+  end
+end

data/lib/squake/model/carbon.rb

@@ -0,0 +1,53 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Squake
+  module Model
+    class Carbon < T::Struct
+      extend T::Sig
+
+      const :quantity, BigDecimal
+      const :unit, CarbonUnit, default: CarbonUnit::GRAM
+      const :items, T.nilable(T::Array[T::Hash[Symbol, T.untyped]]) # @TODO: resolve to typed items?
+
+      sig { params(response_body: T::Hash[Symbol, T.untyped]).returns(Squake::Model::Carbon) }
+      def self.from_api_response(response_body)
+        Squake::Model::Carbon.new(
+          quantity: BigDecimal(String(response_body.fetch(:quantity))),
+          unit: CarbonUnit.deserialize(response_body.fetch(:unit)),
+          items: response_body.fetch(:items, nil),
+        )
+      end
+
+      sig do
+        params(
+          unit: CarbonUnit,
+        ).returns(Carbon)
+      end
+      def in!(unit)
+        # this is a bit hacky, but it optimizes memory usages and we don't need `T.must`
+        # everywhere if we were to use a prop instead of a const.
+        @quantity = CarbonUnit.convert(quantity, self.unit, to: unit)
+        @unit = unit
+        self
+      end
+
+      sig do
+        params(
+          other: Carbon,
+        ).returns(Carbon)
+      end
+      def +(other)
+        other_qty = CarbonUnit.convert(other.quantity, other.unit, to: CarbonUnit::GRAM)
+        self_qty = CarbonUnit.convert(quantity, unit, to: CarbonUnit::GRAM)
+
+        Carbon.new(quantity: other_qty + self_qty)
+      end
+
+      sig { returns(Numeric) }
+      def fractional
+        quantity.to_f.round(unit.precision)
+      end
+    end
+  end
+end

data/lib/squake/model/carbon_unit.rb

@@ -0,0 +1,105 @@
+# typed: strict
+# frozen_string_literal: true
+
+# as per International System of Units ("SI", or "metric system")
+# see: https://www.nist.gov/pml/owm/si-units-mass
+module Squake
+  module Model
+    class CarbonUnit < T::Enum
+      extend T::Sig
+
+      enums do
+        GRAM     = new('gram')
+        KILOGRAM = new('kilogram')
+        TONNE    = new('tonne')
+      end
+
+      sig { returns(String) }
+      def serialize_to_abbreviation
+        case self
+        when CarbonUnit::GRAM     then 'g'
+        when CarbonUnit::KILOGRAM then 'kg'
+        when CarbonUnit::TONNE    then 't'
+        else
+          T.absurd(self)
+        end
+      end
+
+      sig do
+        params(
+          carbon_quantity: T.any(Integer, Float, Rational, BigDecimal),
+          carbon_unit: CarbonUnit,
+          to: CarbonUnit,
+        ).returns(BigDecimal)
+      end
+      def self.convert(carbon_quantity, carbon_unit, to: CarbonUnit::GRAM)
+        case carbon_unit
+        when CarbonUnit::GRAM     then gram_to_unit(carbon_quantity, to)
+        when CarbonUnit::KILOGRAM then kilogram_to_unit(carbon_quantity, to)
+        when CarbonUnit::TONNE    then tonne_to_unit(carbon_quantity, to)
+        else
+          T.absurd(carbon_unit)
+        end
+      end
+
+      sig { returns(Integer) }
+      def precision
+        case self
+        when CarbonUnit::GRAM     then 0
+        when CarbonUnit::KILOGRAM then 3
+        when CarbonUnit::TONNE    then 6
+        else
+          T.absurd(self)
+        end
+      end
+
+      sig do
+        params(
+          carbon_quantity: T.any(Integer, Float, Rational, BigDecimal),
+          to: CarbonUnit,
+        ).returns(BigDecimal)
+      end
+      private_class_method def self.gram_to_unit(carbon_quantity, to)
+        case to
+        when CarbonUnit::GRAM     then BigDecimal(carbon_quantity)
+        when CarbonUnit::KILOGRAM then BigDecimal(carbon_quantity) / 1_000
+        when CarbonUnit::TONNE    then BigDecimal(carbon_quantity) / 1_000_000
+        else
+          T.absurd(to)
+        end
+      end
+
+      sig do
+        params(
+          carbon_quantity: T.any(Integer, Float, Rational, BigDecimal),
+          to: CarbonUnit,
+        ).returns(BigDecimal)
+      end
+      private_class_method def self.kilogram_to_unit(carbon_quantity, to)
+        case to
+        when CarbonUnit::GRAM     then BigDecimal(carbon_quantity) * 1_000
+        when CarbonUnit::KILOGRAM then BigDecimal(carbon_quantity)
+        when CarbonUnit::TONNE    then BigDecimal(carbon_quantity) / 1_000
+        else
+          T.absurd(to)
+        end
+      end
+
+      sig do
+        params(
+          carbon_quantity: T.any(Integer, Float, Rational, BigDecimal),
+          to: CarbonUnit,
+        ).returns(BigDecimal)
+      end
+      private_class_method def self.tonne_to_unit(carbon_quantity, to)
+        case to
+        when CarbonUnit::GRAM     then BigDecimal(carbon_quantity) * 1_000_000
+        when CarbonUnit::KILOGRAM then BigDecimal(carbon_quantity) * 1_000
+        when CarbonUnit::TONNE    then BigDecimal(carbon_quantity)
+        else
+          T.absurd(to)
+        end
+      end
+    end
+  end
+end

data/lib/squake/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - 'Team SQUAKE :rocket:'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-14 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -104,9 +104,12 @@ files:
 - README.md
 - lib/squake.rb
 - lib/squake/api_error.rb
+- lib/squake/calculation.rb
 - lib/squake/calculation_with_pricing.rb
 - lib/squake/client.rb
 - lib/squake/config.rb
+- lib/squake/model/carbon.rb
+- lib/squake/model/carbon_unit.rb
 - lib/squake/model/items/base_type.rb
 - lib/squake/model/items/private_jet/squake.rb
 - lib/squake/model/price.rb