squake 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b36b98d0bbe6be1cfa67c8b2ba81905f7bcdcc929308332b886548bbcd189b56
-  data.tar.gz: ee666e2bbd9f7535c824063dd20d5cb9ca90c72e384ff1ed8983bd7400f81d20
+  metadata.gz: 878657f24a04c4d4ea9ac849fbde8db18e2b7899fb4b277666ffadb3d9287807
+  data.tar.gz: b29ad578e8187896048ba9bb807be01f3b82308de8cba2bb5bc5d1edff4b49cf
 SHA512:
-  metadata.gz: d53fd77ab97f24cc6c3102500863865b7e0852d936b45862bfab7c946d301601b34fc0048135601518b645373ab8e67af1495e0acd039447c703c7284f239d84
-  data.tar.gz: 7869d17821522db8690f8c9a1fd0ad950cd8471e7176c3b20f9993b4ad4f01cfb9c6f3d8f1270fb30f77f5bc91f9c5bacb55873d857e60695575c82125100a6a
+  metadata.gz: 6e8420f30d8cf7ef3afb890c0723da12727e785e84582725868321a18e108f6c715da6c33abc08d4a679df8375c6d2e63d9ff0448bf0354cb4edb149ebacbc2d
+  data.tar.gz: 418592b0bc53e33bf94661c20c572e196f7f94c70f15fa626f41dd385143204b13bc7eaa838e3940a41b734b34299738bf76c1d79e6a534ff084482aaa4f3890

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,7 +24,7 @@ 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)
 
@@ -129,6 +125,12 @@ Squake::Purchase.cancel(
 )
 ```
 
+## 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.
@@ -141,6 +143,12 @@ Have a Rubygems API key in your `~/.gem/credentials` file.
 Then run:
 
 ```shell
-gem build
-gem push squake-0.1.0.gem --key=rubygems_squake
+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/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

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require_relative 'carbon_unit'
+
 module Squake
   module Model
     class Carbon < T::Struct

data/lib/squake/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Squake
-  VERSION = '0.2.0'
+  VERSION = '0.2.2'
 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.2.0
+  version: 0.2.2
 platform: ruby
 authors:
-- 'Team SQUAKE :rocket:'
+- SQUAKE
 autorequire:
 bindir: bin
 cert_chain: []
 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,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE
 - README.md
 - lib/squake.rb
 - lib/squake/api_error.rb
@@ -121,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