https://github.com/coinbase/coinbase-commerce-ruby
Coinbase Commerce Ruby Gem
https://github.com/coinbase/coinbase-commerce-ruby
Last synced: about 1 year ago
JSON representation
Coinbase Commerce Ruby Gem
- Host: GitHub
- URL: https://github.com/coinbase/coinbase-commerce-ruby
- Owner: coinbase
- License: mit
- Created: 2018-06-13T17:45:22.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T22:26:44.000Z (over 2 years ago)
- Last Synced: 2025-03-24T10:38:47.847Z (about 1 year ago)
- Language: Ruby
- Size: 30.3 KB
- Stars: 35
- Watchers: 14
- Forks: 33
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/coinbase/coinbase-commerce-ruby)
# coinbase-commerce-ruby
**Note: This repository is not actively maintained.**
Coinbase Commerce Ruby Gem
# Table of contents
* [Ruby Versions](#ruby-version)
* [Third Party Libraries and Dependencies](#third-party-libraries-and-dependencies)
* [Documentation](#documentation)
* [Installation](#installation)
* [Usage](#usage)
* [Checkouts](#checkouts)
* [Charges](#charges)
* [Events](#events)
* [Validating webhook signatures](#validating-webhook-signatures)
* [Testing and Contributing](#testing-and-contributing)
## Ruby Version
Ruby 2.3, 2.4, 2.5, 2.6RC are supported and tested.
## Third Party Libraries and Dependencies
The following libraries will be installed when you install the client library:
* [faraday](https://github.com/lostisland/faraday)
## Documentation
For more details visit [Coinbase API docs](https://commerce.coinbase.com/docs/api/).
To start using library, you'll need to [create a Coinbase Commmerce account](https://commerce.coinbase.com/signup).
Once you've created your Coinbase Commerce account, create an ``API_KEY`` in Settings.
Next create a ``Client`` object for interacting with the API:
```ruby
require 'coinbase_commerce'
API_KEY = "API KEY"
client = CoinbaseCommerce::Client.new(api_key: API_KEY)
```
``Client`` contains links to every Ruby Class representations of the API resources
``Checkout, Charge, Event``
You can call ``list, auto_paging, create, retrieve, modify`` methods from API resource classes
```ruby
client.charge.create
client.checkout.auto_paging
client.event.list
client.charge.retrieve
client.checkout.modify
```
as well as ``save, delete, refresh`` methods from API resource class instances.
```python
checkout = client.checkout.retrieve
checkout.refresh
checkout.save
checkout.delete
```
Each API method returns an ``APIObject`` representing the JSON response from the API, all of the models support hash and JSON representation.\
Also when the response data is parsed into Ruby objects, the appropriate ``APIObject`` subclasses will be used automatically.
All subclasses of ``APIResource`` class support ``refresh`` method. This will update their attributes and all nested data by making a fresh ``GET`` request to the relevant API endpoint.
The client supports handling of common API errors and warnings.
All errors occuring during the interaction with the API will be raised as exceptions.
| Error | Status Code |
|--------------------------|-------------|
| APIError | * |
| InvalidRequestError | 400 |
| ParamRequiredError | 400 |
| ValidationError | 400 |
| AuthenticationError | 401 |
| ResourceNotFoundError | 404 |
| RateLimitExceededError | 429 |
| InternalServerError | 500 |
| ServiceUnavailableError | 503 |
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'coinbase_commerce'
```
Then execute:
```sh
bundle install
```
Or install it yourself as:
```sh
gem install coinbase_commerce
```
## Usage
```ruby
require 'coinbase_commerce'
client = CoinbaseCommerce::Client.new(api_key: 'your_api_key')
```
## Checkouts
[Checkouts API docs](https://commerce.coinbase.com/docs/api/#checkouts)
### Retrieve
```ruby
checkout = client.checkout.retrieve
```
### Create
```ruby
checkout_info = {
"name": "The Sovereign Individual",
"description": "Mastering the Transition to the Information Age",
"pricing_type": "fixed_price",
"local_price": {
"amount": "1.00",
"currency": "USD"
},
"requested_info": ["name", "email"]
}
checkout = client.checkout.create(checkout_info)
# or
checkout = client.checkout.create(:name=>'The Sovereign Individual',
:description=>'Mastering the Transition to the Information Age',
:pricing_type=>'fixed_price',
:local_price=>{
"amount": "100.00",
"currency": "USD"
},
:requested_info=>["name", "email"])
```
### Update
```ruby
checkout = client.checkout.retrieve
checkout.name = 'new name'
checkout.save
# or
client.checkout.modify(, "local_price": {
"amount": "10000.00",
"currency": "USD"
})
```
### Delete
```ruby
checkout.delete
```
### List
```ruby
checkouts = client.checkout.list
```
### Paging list iterations
```ruby
client.checkout.auto_paging do |ch|
puts ch.id
end
```
## Charges
[Charges API docs](https://commerce.coinbase.com/docs/api/#charges)
### Retrieve
```ruby
charge = client.charge.retrieve
```
### Create
```ruby
charge_info = {
"name": "The Sovereign Individual",
"description": "Mastering the Transition to the Information Age",
"pricing_type": "fixed_price",
"local_price": {
"amount": "1.00",
"currency": "USD"
},
"requested_info": ["name", "email"]
}
charge = client.charge.create(charge_info)
# or
charge = client.charge.create(:name=>'The Sovereign Individual',
:description=>'Mastering the Transition to the Information Age',
:pricing_type=>'fixed_price',
:local_price=>{
"amount": "100.00",
"currency": "USD"
})
```
### List
```ruby
charges_list = client.charge.list
```
### Paging list iterations
```ruby
client.charge.auto_paging do |charge|
puts charge.id
end
```
## Events
[Events API Docs](https://commerce.coinbase.com/docs/api/#events)
### Retrieve
```ruby
event = client.event.retrieve
```
### List
```ruby
events = client.event.list
```
### Paging list iterations
```ruby
client.event.auto_paging do |event|
puts event.id
end
```
## Validating webhook signatures
You should verify the webhook signatures using our library.
To perform the verification you'll need to provide the event data, a webhook signature from the request header, and the endpoint’s secret.
In case of an invalid request signature or request payload, you will receive an appropriate error message.
```ruby
WEBHOOK_SECRET = 'your_webhook_secret'
# Using Sinatra
post '/webhooks' do
request_payload = request.body.read
sig_header = request.env['HTTP_X_CC_WEBHOOK_SIGNATURE']
begin
event = CoinbaseCommerce::Webhook.construct_event(request_payload, sig_header, WEBHOOK_SECRET)
# event handle
puts "Received event id=#{event.id}, type=#{event.type}"
status 200
# errors handle
rescue JSON::ParserError => e
puts "json parse error"
status 400
return
rescue CoinbaseCommerce::Errors::SignatureVerificationError => e
puts "signature verification error"
status 400
return
rescue CoinbaseCommerce::Errors::WebhookInvalidPayload => e
puts "missing request or headers data"
status 400
return
end
end
```
### Testing and Contributing
Any and all contributions are welcome! The process is simple: fork this repo, make your changes, add tests, run the test suite, and submit a pull request. Tests are run via rspec. To run the tests, clone the repository and then:
# Install the requirements
gem install coinbase_commerce
rspec spec
# or via Bundle
bundle install
bundle exec rspec spec