digitalhumani 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14a663d43b2ef4aa923f1731936a8e8da8919412519b35b777f2c9dc102e6360
+  data.tar.gz: 13c0e230523558df5a48ce8023fcafb762914775f0fe98f0885b9903ea76f6af
+SHA512:
+  metadata.gz: 9c2aa52feacbbf7232f08325ef9aa791ef864f6a765182d80eda340e28b15e4d776fdb22d234056f5021cbd5c4c482c38a1b760c12fc959fd5312a3b6aa05659
+  data.tar.gz: 73fcc12cd9faf8ad561b4f2487a9c66942a401369be1026b3c557590fb75bc9b6cfa0761960f7b83402ef8f2a862bf05c9f8542f8217b6acc2ef010e012ec6ff

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in digitalhumani.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem 'webmock', '~> 3.14'
+
+gem "faraday", "~> 1.7.0"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    digitalhumani (0.1.0)
+      faraday (~> 1.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    faraday (1.7.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashdiff (1.0.1)
+    multipart-post (2.1.1)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  digitalhumani!
+  faraday (~> 1.7.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  webmock (~> 3.14)
+
+BUNDLED WITH
+   2.2.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Digital Humani
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Carl Scheller
+
+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,98 @@
+# DigitalHumani Ruby SDK
+
+| :warning: | This gem is currently under development and not yet published nor recommended for production use |
+| --------- | :----------------------------------------------------------------------------------------------- |
+
+This repository hosts the DigitalHumani Ruby Gem SDK. It can be used for interacting with the DigitalHumani RaaS (Reforestation-as-a-Service) API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'digitalhumani'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install digitalhumani
+
+## Preparation
+
+- Create an account on [DigitalHumani,com](https://my.digitalhumani.com/register) and grab your API key from the **Developer** menu item.
+- Review the [DigitalHumani documentation](https://docs.digitalhumani.com) to familiarize yourself with the environments, requests, projects, etc
+
+## Usage
+
+### Configuration
+
+```ruby
+# Initialize the DigitalHumani SDK instance
+dh = DigitalHumani::SDK.new do
+    @api_key = $API_KEY             # your API key
+    @environment = "production"     # "production" or "sandbox"
+    @enterprise_id = $ENTERPRISE_ID # optional; your enterprise ID
+end
+```
+
+Alternatively, you can specify and update the `enterprise_id` separately:
+
+```ruby
+digitalHumani.enterprise_id = $ENTERPRISE_ID
+```
+
+Note that when `enterprise_id` has been specified on the instance, it will be used as a default value on all below methods and therefore does not need to be provided as a parameter.
+
+### Trees
+
+```ruby
+# Plant one or many trees
+digitalHumani.plant_tree(enterprise_id: $ENTERPRISE_ID, project_id: '81818181', user: 'test@example.com', treeCount: 5)
+
+# Get details of a single tree-planting request
+digitalHumani.tree(uuid: $TREE_UUID)
+```
+
+### Enterprises
+
+```ruby
+# Get enterprise by ID
+digitalHumani.enterprise(enterprise_id: $ENTERPRISE_ID)
+
+# Get count of trees planted by date range
+digitalHumani.treeCount(enterprise_id: $ENTERPRISE_ID, start: '2021-01-01', end: '2022-01-01')
+
+# Get count of trees planted for month
+digitalHumani.treeCount(enterprise_id: $ENTERPRISE_ID, month: '2021-01')
+
+# Get count of trees planted by specific user. User string will match what's specified in `plant_tree` call
+digitalHumani.treeCount(enterprise_id: $ENTERPRISE_ID, user: 'test@example.com')
+```
+
+### Projects
+
+```ruby
+# Get list of all projects
+digitalHumani.projects()
+
+# Get project by ID
+digitalHumani.project(project_id: '81818181')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/digitalhumani/digitalhumani-ruby-sdk.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "digitalhumani"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/digitalhumani/version.rb

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

data/lib/digitalhumani.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "json"
+require "faraday"
+require_relative "digitalhumani/version"
+
+module DigitalHumani
+  class Error < StandardError; end
+
+  class SDK
+    # Allow enterprise_id to be read, written
+    attr_accessor :enterprise_id
+
+    # Initilaize instance w/ API key, environment, and optionally enterpriseId
+    def initialize(&block)
+      instance_eval(&block)
+
+      # Validate api_key, environment inputs
+      if !@api_key or @api_key === ""
+        raise "Error: @api_key parameter required"
+      end
+      if !@environment or !["production","sandbox"].include?(@environment)
+        raise "Error: @environment parameter required and must be one of 'production','sandbox'"
+      end
+
+      # Set API base url based on environment
+      case @environment
+        when "production"
+          @url = "https://api.digitalhumani.com/"
+        when "sandbox"
+          @url = "https://api.sandbox.digitalhumani.com"
+        end
+    end
+
+    # Get enterprise by ID
+    def enterprise(enterprise_id: @enterprise_id)
+      if !enterprise_id
+        raise "Error: `enterprise_id` not set"
+      end 
+
+      request(http_method: :get, endpoint: "/enterprise/#{enterprise_id}")
+    end
+
+    # Get list of all projects
+    def projects()
+      request(endpoint: "/project", http_method: :get)
+    end
+
+    # Get project by ID
+    def project(project_id:)
+      if !project_id
+        raise "Error: `project_id` parameter required"
+      end 
+
+      request(endpoint: "/project/#{project_id}", http_method: :get)
+    end
+
+    # Plant tree
+    def plant_tree(enterprise_id: @enterprise_id, project_id:, user:, treeCount: 1)
+      if !enterprise_id
+        raise "Error: `enterprise_id` not set"
+      end 
+      if !project_id
+        raise "Error: `project_id` parameter required"
+      end 
+
+      request(endpoint: "/tree", http_method: :post, params: {
+        enterpriseId: enterprise_id,
+        projectId: project_id,
+        user: user,
+        treeCount: treeCount
+      })
+    end
+
+    # Get tree by UUID
+    def tree(uuid:)
+      if !uuid
+        raise "Error: `uuid` parameter required"
+      end 
+      request(endpoint: "/tree/#{uuid}", http_method: :get)
+    end
+
+    # Get tree count for enterprise - for date range, month, or user
+    def tree_count(enterprise_id: @enterprise_id, start_date: "", end_date: "", month: "", user: "")
+      if !enterprise_id
+        raise "Error: `enterprise_id` not set"
+      end 
+
+      if start_date and start_date != ""
+        if end_date and end_date != ""
+          # Request tree count over date range
+          request(http_method: :get, endpoint: "/enterprise/#{enterprise_id}/treeCount", params: {
+            startDate: start_date,
+            endDate: end_date
+          })
+        else
+          raise "Error: Both `start_date` and `end_date` parameters required"
+        end
+      elsif month and month != ""
+        # Request tree count for month
+        request(http_method: :get, endpoint: "/enterprise/#{enterprise_id}/treeCount/#{month}")
+      elsif user and user != ""
+        # Request tree count for user
+        request(http_method: :get, endpoint: "/tree", params: {
+          enterpriseId: enterprise_id,
+          user: user
+        })
+      else
+        raise "Error: invalid parameters. Must specify `start_date`/`end_date`, `month`, or `user`"
+      end
+    end
+
+    private
+    
+    # Initialize Faraday connection
+    def client
+      @_client ||= Faraday.new(@url) do |client|
+        client.request :url_encoded
+        client.headers["X-API-KEY"] = @api_key if @api_key
+        client.headers["Content-Type"] = "application/json"
+        client.headers["User-Agent"] = "Digital Humani Ruby SDK"
+      end
+    end
+
+    # Send request via Faraday connection object, return JSON-parse response body
+    def request(http_method:, endpoint:, params: {})
+      params = JSON.generate(params) if !params.empty? and http_method != :get
+      response = client.public_send(http_method, endpoint, params)
+      JSON.parse(response.body)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: digitalhumani
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Scheller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description: 
+email:
+- carl@digitalhumani.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/digitalhumani.rb
+- lib/digitalhumani/version.rb
+homepage: https://digitalhumani.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://digitalhumani.com
+  source_code_uri: https://github.com/digitalhumani/ruby-sdk
+  changelog_uri: https://github.com/digitalhumani/ruby-sdk/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: The official Ruby SDK for DigitalHumani's RaaS (Reforestation-as-a-Service)
+test_files: []