squake 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7860b4b9cfbf3110355582ab95ce9faee0055fc6ea852b00093703fbcf8f7c8d
-  data.tar.gz: 6f05154a58469f7f52f9730bf808a3005961b7ba29e7f6ce8fe47e47b27cc651
+  metadata.gz: '00325909416eb7545b395e8a0ffa0ee164b6c9ec125f5f9900c5f3efe7f1e058'
+  data.tar.gz: 003ce1f90f3e379f995169079672319a8a044db9f46684582a59d7c333b082d0
 SHA512:
-  metadata.gz: d2065bbbe6bbbffa5067acf0810dbfe2c3ef32b50b5bce14b949f170a138f29ec16d2897093d9305af615e768ebcaa6da24873660572c24141e09f11b896cf08
-  data.tar.gz: 53f6a57201c32df605f6d30932baa4408bc3eafd7c02fb6f2dff6f55d0313c1e0b0f501980aa93e17bcea5ecd3bc11491f81639d138aa4c60005e62237689e92
+  metadata.gz: '06795250b08b0b20e15d7283c7f29e9761a9f21a3553ed269f4c2b49bffee2afdae3d5143577ded233cafe1b86fde494471ef60363c635c8bcbd7d4cd9e2322c'
+  data.tar.gz: 6eebe00fa09b233feb52fc156e1bd7b922d4831d53e1da6f90381dbc9830d70f14e6ea935801cfc79f4ab328ff034ece20b8fde985433c07c6797d07cfe6fc19

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.0] - 2023-06-15
+
+### Added
+
+* request carbon emissions (without price quote)
+
+## [0.1.0] - 2023-06-14
+
+Initial release of an MVP/POC library. Only v2 of the SQUAKE API is supported.
+
+### Added
+
+* request carbon emission and price quote
+* make a purchase
+* retrieve a purchase
+* cancel a purchase

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 squake-earth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -4,20 +4,16 @@ Find the documentation here: [docs](https://docs.squake.earth/).
 
 ## Installation
 
-Via git:
+Via rubygems:
 
 ```ruby
-# Gemfile
-
-gem 'squake', git: 'git@github.com:squake-earth/squake-ruby'
+gem 'squake'
 ```
 
-Via rubygems:
+Via git:
 
 ```ruby
-# Gemfile
-
-gem 'squake', '~> 0.1.0'
+gem 'squake', git: 'git@github.com:squake-earth/squake-ruby'
 ```
 
 ## Auth
@@ -28,13 +24,13 @@ You need a different API Key for production and sandbox.
 ## Functionality
 
 * compute emission values
-* request a price quote (with a product id)
+* request a price quote for your emissions (with a product id)
 * place a purchase order (with a price quote id)
 * get a list of all available products (includes price information)
 
 ## Usage
 
-Calculate emissions and include a price quote:
+Initialize the client:
 
 ```ruby
 config = Squake::Config.new(
@@ -48,7 +44,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 +96,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 +124,31 @@ Squake::Purchase.cancel(
   id: purchase.id, # required
 )
 ```
+
+## Contributions
+
+We welcome contributions from the community. Before starting work on a major feature, please get in touch with us either via email or by opening an issue on GitHub. "Major feature" means anything that changes user-facing features or significant changes to the codebase itself.
+
+Please commit small and focused PRs with descriptive commit messages. If you are unsure about a PR, please open a draft PR to get early feedback. A PR must have a short description ("what"), a motiviation ("why"), and, if applicable, instructions how to test the changes, measure performance improvements, etc.
+
+## Publishing a new version
+
+Have a Rubygems API key in your `~/.gem/credentials` file.
+
+```shell
+---
+:rubygems_squake: rubygems_xxx
+```
+
+Then run:
+
+```shell
+bin/release
+```
+
+which will guide you through the release process:
+
+* create a new git tag from current main
+* create a GitHub release from the tag
+* build the gem locally
+* publish the gem to RubyGems

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/config.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'logger'
+
 module Squake
   class Config < T::Struct
     extend T::Sig
@@ -10,7 +12,7 @@ module Squake
 
     const :api_key, String
     const :keep_alive_timeout, Integer, default: 30
-    const :logger, Logger, factory: -> { Logger.new($stdout) }
+    const :logger, ::Logger, factory: -> { ::Logger.new($stdout) }
     const :sandbox_mode, T::Boolean, default: true
     const :enforced_api_base, T.nilable(String)
 

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.1'
 end

data/lib/squake.rb

@@ -3,5 +3,8 @@
 
 require 'sorbet-runtime'
 require 'oj'
+require 'net/http'
 
-require_relative 'squake/version'
+Dir[File.join(__dir__, './**/*', '*.rb')].each { require(_1) }
+
+module Squake; end

data/sorbet/rbi/dsl/active_support/callbacks.rbi

@@ -0,0 +1,22 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for dynamic methods in `ActiveSupport::Callbacks`.
+# Please instead update this file by running `bin/tapioca dsl ActiveSupport::Callbacks`.
+
+module ActiveSupport::Callbacks
+  include GeneratedInstanceMethods
+
+  mixes_in_class_methods GeneratedClassMethods
+
+  module GeneratedClassMethods
+    def __callbacks; end
+    def __callbacks=(value); end
+    def __callbacks?; end
+  end
+
+  module GeneratedInstanceMethods
+    def __callbacks; end
+    def __callbacks?; end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: squake
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
-- 'Team SQUAKE :rocket:'
+- SQUAKE
 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: net-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: rubocop-dbl
   requirement: !ruby/object:Gem::Requirement
@@ -101,12 +129,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
 - 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
@@ -118,6 +151,7 @@ files:
 - lib/squake/response.rb
 - lib/squake/util.rb
 - lib/squake/version.rb
+- sorbet/rbi/dsl/active_support/callbacks.rbi
 homepage: https://github.com/squake-earth/squake-ruby
 licenses:
 - MIT