Project

cloverly

0.0
Repository is archived
No release in over 3 years
Low commit activity in last 3 years
cloverlycloverly/cloverly-ruby-gemHomepageDocumentationSource CodeBug Tracker
Cloverly API powers carbon offsets via an API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
16,415
Stars
4
Forks
1
Watchers
2
 Releases
Current version
0.2.0
Total releases
7
First release
2019-05-08
Latest release
2021-03-17
 Issues
Open Issues
0
Closed Issues
1
Total Issues
1
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
4
Closed Pull Requests
18
Merged Pull Requests
9
Pull Request Acceptance Rate
29%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-01-24
Reverse Dependencies
0

 Dependencies

Development

byebug
>= 0
dotenv
>= 0
guard
>= 0
guard-rspec
>= 0
rspec
>= 0

Runtime

faraday
>= 0.9, < 2.0
 Project Readme

Ruby Gem for Cloverly API

Cloverly is an API for carbon offsets. Cloverly powers the ability to "green" every day transaction with carbon offsets. Many customers use it to offer green shipping to their customers.

Other links:

Bugs

If you find issues, please report them to https://github.com/cloverly/cloverly-ruby-gem/issues

Getting started

  1. gem install cloverly
  2. Signup for Cloverly API at https://cloverly.com

Basic Usage

Below is some basic code, which can be used to show the basics of the Cloverly Ruby gem.

require 'cloverly'

Cloverly.default = Cloverly.new(<signup with cloverly to get an API key>)

# Purchase with estimate first
estimate = Cloverly::Estimate.shipping(distance: {value: 4500, units: "miles"}, weight: {value: 50, units: "kg"})
estimate.transaction_cost_in_usd_cents
purchase = estimate.purchase! # converts estimate to purchase and initializes new instance of Cloverly::Purchase
purchase.state == "purchased"

# Purchase without estimate
new_purchase = Cloverly::Purchase.shipping(distance: {value: 4500, units: "miles"}, weight: {value: 50, units: "kg"})

Detailed Usage

Initialization

To initialize cloverly, call Cloverly.new('api-key'). If you choose to set a Cloverly.default value, then you can use the class methods. This is common for 90% of our customers who use Cloverly for their own tools:

Cloverly.default = Cloverly.new(<signup with cloverly to get an API key>)

For advanced use cases, which want to interact with multiple Cloverly API keys, you can initialize the instance as needed. The Cloverly Slack app uses this method:

cloverly_one = Cloverly.new('api_key')
cloverly_two = Cloverly.new('api_key')

# Sent to first Cloverly
cloverly_one.estimate_offset("shipping", {distance: {value: 4500, units: "miles"}, weight: {value: 50, units: "kg"}})
# Sent to a second Cloverly
cloverly_two.estimate_offset("shipping", {distance: {value: 15, units: "miles"}, weight: {value: 50, units: "kg"}})

How Cloverly Works

Cloverly has outlined it's How it works in the world. On a transaction method, the method of operations are: Estimate First or Purchase without Estimate.

  • Estimate First Some use cases require receiving an estimate first. This allows showing the price of the estimate to a customer to get by in. Then, convert the estimate to a purchase later. To convert, use the purchase! method on a Cloverly::Estimate object.

  • Purchase without estimate If the use case does not require estimates first, then make a direct call to cloverly.offset or Cloverly.shipping or the methods. Below, in the examples, we will show both use cases.

Shipping Offset

A shipping offset requires two different variables: distance and weight. Cloverly can find dinstance with a to and from attribute, or with a distance attribute.

When using Cloverly.default with to and from:

Cloverly::Purchase.shipping({to: {zip: "35209"}, from: {country: "PK", postal_code: "54000"}, weight: {value: 5, units: "kg"}})
Cloverly::Estimate.shipping({to: {country: "US", postal_code: "35209"}, from: {country: "PK", postal_code: "54000"}, weight: {value: 5, units: "pounds"}})

Without Cloverly.default with distance:

cloverly.offset("shipping", {distance: {value: 15, units: "miles"}, weight: {value: 50, units: "kg"}})
cloverly.estimate_offset("shipping", {distance: {value: 15, units: "miles"}, weight: {value: 50, units: "kg"}})

Transportation and vehicle offset

When using Cloverly.default:

Cloverly::Purchase.vehicle({to: {zip: "35209"}, from: {zip: "94043"}, fuel_efficiency: {value: 22, units: "mpg", of: "gasoline"}})
Cloverly::Estimate.vehicle({to: {country: "US", postal_code: "35209"}, from: {zip: "94043"}, fuel_efficiency: {value: 35, units: "km/l", of: "diesel"}})

When not:

cloverly.offset("vehicle", {distance: {value: 15, units: "miles"}, fuel_efficiency: {value: 28, units: "km/l", of: "diesel"}})
cloverly.estimate_offset("vehicle", {distance: {value: 15, units: "miles"}, fuel_efficiency: {value: 28, units: "km/l", of: "diesel"}})

Direct offset on carbon weight

When using Cloverly.default:

Cloverly::Purchase.carbon(weight: {value: 20, units: "pounds"})
Cloverly::Estimate.carbon(weight: {value: 20, units: "pounds"})

without default:

cloverly.offset("carbon", weight: {value: 10.2, units: "kg"})
cloverly.estimate_offset("carbon", weight: {value: 10.2, units: "kg"})

Fixed dollar amount to offset

When using Cloverly.default:

Cloverly::Purchase.currency({currency: {value: 75, unit: "usd cents"}})
Cloverly::Estimate.currency({currency: {value: 285, unit: "usd cents"}})

When not:

cloverly.offset("currency", {currency: {value: 9.34, unit: "usd"}})
cloverly.estimate_offset("currency", {currency: {value: 9.34, unit: "usd"}})

Convert an estimate to a purchase

estimate = Cloverly::Estimate.shipping({to: {zip: "35209"}, from: {country: "PK", postal_code: "54000"}, weight: {value: 5, units: "kg"}})
purchase = estimate.purchase!