ecologi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9463079cfabd5f778fe294f8e133c7078dcaf25c9fc619ec0c55c791b650518
+  data.tar.gz: ded8a55cee96108e54d91d4a0a7ceb91621e1b59624060bee34d06abc4e30fcf
+SHA512:
+  metadata.gz: edb7ded5902efc78cb1812fab3a864ed54afc8f01f6e1c72b0ce4cf3f7dadd5bc1eb35fcaffa1ce50ef1087911380b79e5d3e3e7720760494ccd1581cef9f3c6
+  data.tar.gz: 8a1739fb807c082a5081a0f3a15c82572a38f445256c65c0da14a0d6ab800131778403702830e162a74c4b40850c9a26d23a272664d74ea32fabe384d673611e

data/.env.example

@@ -0,0 +1 @@
+API_KEY=

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ecologi.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "dotenv"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    ecologi (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.1)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  dotenv
+  ecologi!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dean Perry
+
+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

@@ -0,0 +1,81 @@
+# Ecologi
+
+This is a Ruby library for interacting with the Ecologi API.
+
+## Usage
+
+To get started, install the gem as normal:
+
+```
+gem "ecologi"
+```
+
+Then you'll need to grab an API key from your [Impact API page](https://ecologi.com/account/api).
+
+Once you've got an API key, setup a client like so:
+
+```ruby
+@client = Ecologi::Client.new(api_key: ENV["API_KEY"])
+```
+
+You can then use the following methods.
+
+### Purchasing Trees
+
+To purchase trees for an account. Requires a number. The name parameter is optional. Returns a `Ecologi::TreePurchase` response.
+
+```ruby
+@client.trees.purchase number: 2, name: "Tree's for user"
+
+#=> #<Ecologi::TreePurchase amount=0.38...
+```
+
+### Purchasing Carbon Offsets
+
+To purchase carbon offsets for an account. Requires number and units. Returns a `Ecologi::CarbonOffsetPurchase` response.
+
+Units must be either KG or Tonnes.
+
+```ruby
+@client.carbon_offsets.purchase number: 2, units: "KG"
+
+#=> #<Ecologi::CarbonOffsetPurchase number=2...
+```
+
+### Reporting - Total Impact
+
+Returns a `Ecologi::Report` object with the total number of trees and carbon offset for a user.
+
+```ruby
+@client.reporting.total_impact username: "deanpcmad"
+
+#=> #<Ecologi::Report trees=1337...
+```
+
+### Reporting - Total Trees
+
+Returns a `Ecologi::Report` object with the total number of trees for a user.
+
+```ruby
+@client.reporting.total_trees username: "deanpcmad"
+
+#=> #<Ecologi::Report total=1337...
+```
+
+### Reporting - Total Carbon Offset
+
+Returns a `Ecologi::Report` object with the total amount of carbon offset for a user.
+
+```ruby
+@client.reporting.total_carbon username: "deanpcmad"
+
+#=> #<Ecologi::Report total=1337...
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/ecologi.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/ecologi.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/ecologi/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ecologi"
+  spec.version = Ecologi::VERSION
+  spec.authors = ["Dean Perry"]
+  spec.email = ["dean@deanpcmad.com"]
+
+  spec.summary = "A Ruby library for interacting with the Ecologi API"
+  spec.description = spec.summary
+  spec.homepage = "https://deanpcmad.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

data/lib/ecologi/client.rb

@@ -0,0 +1,39 @@
+module Ecologi
+  class Client
+    BASE_URL = "https://public.ecologi.com"
+
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
+      @api_key = api_key
+      @adapter = adapter
+
+      # Test stubs for requests
+      @stubs = stubs
+    end
+
+    def trees
+      TreesResource.new(self)
+    end
+
+    def carbon_offsets
+      CarbonOffsetsResource.new(self)
+    end
+
+    def reporting
+      ReportingResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new(BASE_URL) do |conn|
+        conn.request :authorization, :Bearer, api_key
+        conn.request :json
+
+        conn.response :json, content_type: "application/json"
+
+        conn.adapter adapter, @stubs
+      end
+    end
+
+  end
+end

data/lib/ecologi/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Ecologi
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/ecologi/objects/carbon_offset_purchase.rb

@@ -0,0 +1,4 @@
+module Ecologi
+  class CarbonOffsetPurchase < Object
+  end
+end

data/lib/ecologi/objects/report.rb

@@ -0,0 +1,4 @@
+module Ecologi
+  class Report < Object
+  end
+end

data/lib/ecologi/objects/tree_purchase.rb

@@ -0,0 +1,4 @@
+module Ecologi
+  class TreePurchase < Object
+  end
+end

data/lib/ecologi/resource.rb

@@ -0,0 +1,42 @@
+module Ecologi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, headers)
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Error 400: Your request was malformed. '#{response.body["responseText"]}'"
+      when 401
+        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+      when 403
+        raise Error, "Error 403: You are not allowed to perform that action."
+      when 404
+        raise Error, "Error 404: No results were found for your request."
+      when 409
+        raise Error, "Error 409: Your request was a conflict."
+      when 429
+        raise Error, "Error 429: Your request exceeded the API rate limit."
+      when 500
+        raise Error, "Error 500: We were unable to perform the request due to server-side problems."
+      when 503
+        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second."
+      end
+
+      response
+    end
+  end
+end

data/lib/ecologi/resources/carbon_offsets.rb

@@ -0,0 +1,10 @@
+module Ecologi
+  class CarbonOffsetsResource < Resource
+    
+    def purchase(number:, units:)
+      response = post_request("impact/carbon", body: {number: number, units: units})
+      CarbonOffsetPurchase.new response.body
+    end
+
+  end
+end

data/lib/ecologi/resources/reporting.rb

@@ -0,0 +1,20 @@
+module Ecologi
+  class ReportingResource < Resource
+    
+    def total_impact(username:)
+      response = get_request("users/#{username}/impact")
+      Report.new response.body
+    end
+
+    def total_trees(username:)
+      response = get_request("users/#{username}/trees")
+      Report.new response.body
+    end
+
+    def total_carbon(username:)
+      response = get_request("users/#{username}/carbon-offset")
+      Report.new response.body
+    end
+
+  end
+end

data/lib/ecologi/resources/trees.rb

@@ -0,0 +1,10 @@
+module Ecologi
+  class TreesResource < Resource
+    
+    def purchase(number:, name: nil)
+      response = post_request("impact/trees", body: {number: number, name: name})
+      TreePurchase.new response.body
+    end
+
+  end
+end

data/lib/ecologi/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ecologi
+  VERSION = "0.1.0"
+end

data/lib/ecologi.rb

@@ -0,0 +1,20 @@
+require "faraday"
+require "json"
+require_relative "ecologi/version"
+
+module Ecologi
+  class Error < StandardError; end
+
+  autoload :Client, "ecologi/client"
+  autoload :Resource, "ecologi/resource"
+  autoload :Object, "ecologi/object"
+
+  autoload :TreesResource, "ecologi/resources/trees"
+  autoload :CarbonOffsetsResource, "ecologi/resources/carbon_offsets"
+  autoload :ReportingResource, "ecologi/resources/reporting"
+
+  autoload :TreePurchase, "ecologi/objects/tree_purchase"
+  autoload :CarbonOffsetPurchase, "ecologi/objects/carbon_offset_purchase"
+  autoload :Report, "ecologi/objects/report"
+
+end

data/sig/ecologi.rbs

@@ -0,0 +1,4 @@
+module Ecologi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: ecologi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby library for interacting with the Ecologi API
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ecologi.gemspec
+- lib/ecologi.rb
+- lib/ecologi/client.rb
+- lib/ecologi/object.rb
+- lib/ecologi/objects/carbon_offset_purchase.rb
+- lib/ecologi/objects/report.rb
+- lib/ecologi/objects/tree_purchase.rb
+- lib/ecologi/resource.rb
+- lib/ecologi/resources/carbon_offsets.rb
+- lib/ecologi/resources/reporting.rb
+- lib/ecologi/resources/trees.rb
+- lib/ecologi/version.rb
+- sig/ecologi.rbs
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A Ruby library for interacting with the Ecologi API
+test_files: []