The official Ruby gem for the Patch API
For a complete API reference, check out Patch's API Reference.
Add the gem to your Gemfile:
gem'patch_ruby'Then run:
bundleOr install it directly with
gem install patch_ruby- Ruby 1.9+
After installing the gem, you'll have to configure it with your API key which is available from the API key page in the Patch dashboard:
require'patch_ruby'Patch.configuredo |config|
# Configure the Patch gem with your API key hereconfig.access_token=ENV['SANDBOX_API_KEY']endIn Patch, orders represent a purchase of carbon offsets or negative emissions by amount. Place orders directly if you know the amount of carbon dioxide you would like to sequester. If you do not know how much to purchase, use an estimate.
You can also create an order with a maximum desired price, and we'll allocate enough to fulfill the order for you.
# Create an order - you can create an order# providing either amount (and unit) or total_price (and currency), but not both# Create order with amountamount=1_000_000# Pass in the amount in unit specifiedunit="g"Patch::Order.create_order(amount: amount,unit: unit)# Create an order with total pricetotal_price=5_00# Pass in the total price in smallest currency unit (ie cents for USD).currency="USD"Patch::Order.create_order(total_price: total_price,currency: currency)# Create an order with issued_to field (optional)total_price=5_00# Pass in the total price in smallest currency unit (ie cents for USD).currency="USD"issued_to={email: "envimpact@companya.com",name: "Company A"}Patch::Order.create_order(total_price: total_price,currency: currency,issued_to: issued_to)## You can also specify a project-id field (optional) to be used instead of the preferred oneproject_id='pro_test_1234'# Pass in the project's IDPatch::Order.create_order(amount: amount,unit: unit,project_id: project_id)## Orders also accept a metadata field (optional)metadata={user: "john doe"}Patch::Order.create_order(amount: amount,unit: unit,metadata: metadata)# Retrieve an orderorder_id='ord_test_1234'# Pass in the order's idPatch::Order.retrieve_order(order_id)# Place an orderorder_id='ord_test_1234'# Pass in the order's idPatch::Order.place_order(order_id)## Placing an order on behalf of another party with the issued_to field (optional)order_id='ord_test_1234'# Pass in the order's idissued_to={email: "envimpact@companya.com",name: "Company A"}Patch::Order.place_order(order_id,issued_to: issued_to)# Cancel an orderorder_id='ord_test_1234'# Pass in the order's idPatch::Order.cancel_order(order_id)# Retrieve a list of orderspage=1# Pass in which page of orders you'd likePatch::Order.retrieve_orders(page: page)Projects are the ways Patch takes CO2 out of the air. They can represent reforestation, enhanced weathering, direct air carbon capture, etc. When you place an order via Patch, it is allocated to a project.
When fetching Projects, you can add filters to the query to narrow the result. Currently supported filters are:
countrytypeminimum_available_mass
# Retrieve a projectproject_id='pro_test_1234'# Pass in the project's IDPatch::Project.retrieve_project(project_id)# Retrieve a list of projectspage=1# Pass in which page of projects you'd likePatch::Project.retrieve_projects(page: page)# Retrieve all projects from the United Statescountry='US'Patch::Project.retrieve_projects(country: country)# Retrieve all biomass projectstype='biomass'Patch::Project.retrieve_projects(type: type)# Retrieve a list of projects with at least 100 grams of available offsetsminimum_available_mass=100Patch::Project.retrieve_projects(minimum_available_mass: minimum_available_mass)# Retrieve a project in a different language# See http://docs.patch.test:3000/#/internationalization for more information and supportproject_id='pro_test_1234'Patch::Project.retrieve_project(project_id,accept_language: 'fr')# Retrieve a list of projects in a different language# See http://docs.patch.test:3000/#/internationalization for more information and supportPatch::Project.retrieve_projects(accept_language: 'fr')While we value open-source contributions to this SDK, the core of this library is generated programmatically. Complex additions made directly to the library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README, as well as new test cases are always very welcome!
To build the gem locally, run:
gem build patch_ruby.gemspecThis will create a .gem file. To install the local gem:
gem install patch_ruby-1.x.x.gemOnce you have installed the gem, you can easily test with irb. Here's an example of testing Order creation:
brett@Bretts-MacBook-Pro patch-ruby $ irb
irb(main):001:0> require 'patch_ruby'
=>true
irb(main):002:0>
irb(main):003:1* Patch.configure do|config|
irb(main):004:1*# Configure the Patch gem with your API key here
irb(main):005:1* config.access_token = ENV['SANDBOX_API_KEY']
irb(main):006:0> end
=>"[REDACTED]"
irb(main):007:0> total_price = 5_00
=> 500
irb(main):008:0> currency = "USD"
=>"USD"
irb(main):009:0> issued_to = {email: "envimpact@companya.com", name: "Company A"}
irb(main):010:0> Patch::Order.create_order(total_price: total_price, currency: currency, issued_to: issued_to)Set up the required environment variable.
export SANDBOX_API_KEY=<SANDBOX API KEY>then run the tests:
make test