coinbase_commerce_client 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c4adff7d11dee8fb401c917dcccc4a1d571af2a26f833b9931ee3f13315199e
-  data.tar.gz: 4b46f2cd7f8050a20b6e5763396b6e058fe387fb18e81797509472adcd749f64
+  metadata.gz: 1dffeec59ae055d348576c580c7d368d08f1e6cfa83eff0df98654bedc37f10c
+  data.tar.gz: b259d64a1f5acecbf1c1ba596d9dc81851a5f7ad95518e2978dccc372afe31fa
 SHA512:
-  metadata.gz: 14cc887e20de18fe1b667d29eaa2c014f539e656535243dc9910696403b1ab029eae4d8199b572469368302317c1517a9b9931cd3825bf635f3e7dd1aebcec5a
-  data.tar.gz: 6c9c4806f579bc6fc638bc45513d3d2bae10ca03474317cc3d21cc61f45b95edd2b9e1a592e9594617c33a93d779f4203d504558e56af4045130e579287e8716
+  metadata.gz: 36af3d120360de81dfbb33d60cbdfcce9dd06710e40e7d797d9ef04e85e1693757ae10e73a8bb768131b10e620aad992a87242eff16c73e1978fcb992680e86d
+  data.tar.gz: 45fe372fb55aa69c0041bca0072745558ca2f9807a0e51b3b13764834d9b14f8df5605ef1a531ca561ae2ef698d3b83b5e82838e999311600b80ef194a09dd2d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coinbase_commerce_client (0.2.0)
+    coinbase_commerce_client (0.4.2)
       faraday (~> 2.6)
       multipart-post (~> 2.0)
 

data/README.md

@@ -1,32 +1,34 @@
-[![Coverage](badge.svg)](https://github.com/viniciusborgeis/coinbase_commerce_client)
-<p>
-  <img width="100%" src="https://raw.githubusercontent.com/viniciusborgeis/coinbase_commerce_client/main/assets/banner.png" alt="Solid Vite Templates">
+<h1 align="center">
+  <br>
+  <img width="100%" src="https://raw.githubusercontent.com/viniciusborgeis/coinbase_commerce_client/main/assets/banner.png" alt="Coinbase Commerce Client">
+  <br>
+  Coinbase Commerce Client
+  <br>
+</h1>
+
+<h4 align="center">A client to handle cryptocurrency payments using <a href="https://commerce.coinbase.com/" target="_blank">Coinbase Commerce</a> platform</h4>
+
+<p align="center">
+	<img src="https://badge.fury.io/rb/coinbase_commerce_client.svg" alt="Coverage">
+	<img src="https://raw.githubusercontent.com/viniciusborgeis/coinbase_commerce_client/main/badge.svg" alt="Coverage">
+    <img src="https://img.shields.io/gem/dt/coinbase_commerce_client.svg?type=total"  alt="Total Downloads">
 </p>
 
-# Coinbase Commerce Client
-> <sub>This gem is completely inspired by official Coinbase gem [coinbase-commerce-ruby](https://github.com/coinbase/coinbase-commerce-ruby), unfortunately the oficial gem actually is deprecated, and my motivation is to continue support for this gem</sub>
-
-Coinbase Commerce Client Ruby Gem
-
-# Table of contents
-
-<!--ts-->
-* [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)
-<!--te-->
+<p align="center">
+  <a href="#ruby-version">Ruby Versions</a> •
+  <a href="#dependencies">Dependencies</a> •
+  <a href="#documentation">Docs</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#validating-webhook-signatures">Validating Webhook</a> •
+  <a href="#testing-and-contributing">Contributing</a>
+</p>
+<sub>This gem is completely inspired by official Coinbase gem <a href="https://github.com/coinbase/coinbase-commerce-ruby">coinbase-commerce-ruby</a>, unfortunately the oficial gem actually is deprecated, and my motivation is to continue support for this gem</sub>
 
 ## Ruby Version
-Ruby [2.3 -> 3.1.2] are supported and tested.
+Ruby [2.3 -> 3.2.2] are supported and tested.
 
-## Third Party Libraries and Dependencies
+## Dependencies
 
 The following libraries will be installed when you install the client library:
 * [faraday](https://github.com/lostisland/faraday)
@@ -38,6 +40,19 @@ For more details visit [Coinbase API docs](https://commerce.coinbase.com/docs/ap
 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.
 
+### On Ruby on Rails
+To use this gem in Ruby on Rails, first pass your Coinbase API_KEY to an environment variable or credentials. After doing this, create a new initializer called `coinbase_commerce_client.rb` and insert the following code:
+
+```ruby
+CoinbaseCommerceClient.configure do |config|
+  config.api_key = ENV['COINBASE_API_KEY']
+  # or
+  config.api_key = Rails.application.credentials.coinbase[:coinbase_api_key]
+end
+```
+
+### Pure ruby example
+
 Next create a ``Client`` object for interacting with the API:
 ```ruby
 require 'coinbase_commerce_client'
@@ -48,21 +63,32 @@ client = CoinbaseCommerceClient::Client.new(api_key: API_KEY)
 ``Client`` contains links to every Ruby Class representations of the API resources
 ``Checkout, Charge, Invoices, Event``
 
-You can call ``list, auto_paging, create, retrieve, modify`` methods from API resource classes
+You can call ``list, auto_paging, create, resolve, cancel, 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.
-```ruby
+#charges
+client.charge.list
+client.charge.auto_paging
+client.charge.create <payload>
+charge = client.charge.retrieve <id>
+charge.resolve
+charge.cancel
+
+#checkout
+client.checkout.list
+client.checkout.auto_paging
+client.checkout.create <payload>
 checkout = client.checkout.retrieve <id>
 checkout.refresh
 checkout.save
+checkout.modify <payload>
 checkout.delete
+
+#events
+client.event.list
+client.event.auto_paging
+event = client.event.retrieve <id>
+
 ```
 
 Each API method returns an ``APIObject`` representing the JSON response from the API, all of the models support hash and JSON representation.\
@@ -105,17 +131,25 @@ gem install coinbase_commerce_client
 ```
 
 ## Usage
+* [Checkouts](#checkouts)
+* [Charges](#charges)
+* [Events](#events)
+
+
 ```ruby
 require 'coinbase_commerce_client'
 client = CoinbaseCommerceClient::Client.new(api_key: 'your_api_key')
 ```
-## Checkouts
+
+### Checkouts
 [Checkouts API docs](https://commerce.coinbase.com/docs/api/#checkouts)
-### Retrieve
+
+#### Retrieve
 ```ruby
 checkout = client.checkout.retrieve <checkout_id>
 ```
-### Create
+
+#### Create
 ```ruby
 checkout_info = {
     "name": "The Sovereign Individual",
@@ -139,7 +173,7 @@ checkout = client.checkout.create(:name=>'The Sovereign Individual',
                                   :requested_info=>["name", "email"])                            
 ```
 
-### Update
+#### Update
 ```ruby
 checkout = client.checkout.retrieve <checkout_id>
 checkout.name = 'new name'
@@ -151,28 +185,32 @@ client.checkout.modify(<checkout_id>, "local_price": {
 })
 ```
 
-### Delete
+#### Delete
 ```ruby
 checkout.delete
 ```
-### List
+
+#### List
 ```ruby
 checkouts = client.checkout.list
 ```
-### Paging list iterations
+
+#### 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
+### Charges
+[Charges API docs](https://docs.cloud.coinbase.com/commerce/reference/getcharges)
+
+#### Retrieve
 ```ruby
 charge = client.charge.retrieve <charge_id>
 ```
-### Create
+
+#### Create
 ```ruby
 charge_info = {
     "name": "The Sovereign Individual",
@@ -194,42 +232,45 @@ charge = client.charge.create(:name=>'The Sovereign Individual',
                                   "currency": "USD"
                               })
 ```
-### List
+
+#### List
 ```ruby
 charges_list = client.charge.list
 ```
-### Cancel
+
+#### Paging list iterations
 ```ruby
-charge = client.charge.retrieve <charge_id>
-        
-charge.cancel
+client.charge.auto_paging do |charge|
+  puts charge.id
+end
 ```
 
-### Resolve
+#### Resolve
 ```ruby
 charge = client.charge.retrieve <charge_id>
-        
 charge.resolve
 ```
 
-### Paging list iterations
+#### Cancel
 ```ruby
-client.charge.auto_paging do |charge|
-  puts charge.id
-end
+charge = client.charge.retrieve <charge_id>
+charge.cancel
 ```
 
 ## Events
-[Events API Docs](https://commerce.coinbase.com/docs/api/#events)
-### Retrieve
+[Events API Docs](https://docs.cloud.coinbase.com/commerce/reference/getevents)
+
+#### Retrieve
 ```ruby
 event = client.event.retrieve <event_id>
 ```
-### List
+
+#### List
 ```ruby
 events = client.event.list
 ```
-### Paging list iterations
+
+#### Paging list iterations
 ```ruby
 client.event.auto_paging do |event|
   puts event.id
@@ -252,7 +293,7 @@ post '/webhooks' do
     # event handle
     puts "Received event id=#{event.id}, type=#{event.type}"
     status 200
-  # errors handle
+    # errors handle
   rescue JSON::ParserError => e
     puts "json parse error"
     status 400

data/badge.svg

@@ -1 +1 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="114" height="20" role="img" aria-label="coverage: 89.44%"><title>coverage: 89.44%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#97ca00"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">89.44%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">89.44%</text></g></svg>
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="114" height="20" role="img" aria-label="coverage: 89.66%"><title>coverage: 89.66%</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="114" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="61" height="20" fill="#555"/><rect x="61" width="53" height="20" fill="#97ca00"/><rect width="114" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" fill="#fff" textLength="510">coverage</text><text aria-hidden="true" x="865" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="430">89.66%</text><text x="865" y="140" transform="scale(.1)" fill="#fff" textLength="430">89.66%</text></g></svg>

data/lib/coinbase_commerce_client/client.rb

@@ -2,10 +2,28 @@ module CoinbaseCommerceClient
   BASE_API_URL = 'https://api.commerce.coinbase.com/'.freeze
   API_VERSION = '2018-03-22'.freeze
 
+  class Configuration
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+
+  @configuration = Configuration.new
+
+  def self.configure
+    yield(@configuration)
+  end
+
+  def self.config
+    @configuration
+  end
+
   class Client
     def initialize(options = {})
       check_api_key!(options[:api_key])
-      @api_key = options[:api_key]
+      @api_key = options[:api_key] || CoinbaseCommerceClient.config.api_key
       @api_uri = URI.parse(options[:api_url] || BASE_API_URL)
       @api_ver = options[:api_ver] || API_VERSION
 
@@ -46,7 +64,7 @@ module CoinbaseCommerceClient
     end
 
     def check_api_key!(api_key)
-      raise AuthenticationError, 'No API key provided' unless api_key
+      raise CoinbaseCommerceClient::Errors::AuthenticationError, 'No API key provided' unless (api_key || CoinbaseCommerceClient.config.api_key)
     end
 
     def request(method, path, params = {})

data/lib/coinbase_commerce_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoinbaseCommerceClient
-  VERSION = '0.3.0'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinbase_commerce_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Vinicius Borges
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-17 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,14 +123,14 @@ files:
 - lib/coinbase_commerce_client/version.rb
 - lib/coinbase_commerce_client/webhooks.rb
 - sig/coinbase_commerce_client.rbs
-homepage: https://github.com/viniciusborgeis/coinbase_commerce_client
+homepage: https://github.com/BiteCraft/coinbase_commerce_client
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/viniciusborgeis/coinbase_commerce_client
-  source_code_uri: https://github.com/viniciusborgeis/coinbase_commerce_client
-  changelog_uri: https://github.com/viniciusborgeis/coinbase_commerce_client
-post_install_message:
+  homepage_uri: https://github.com/BiteCraft/coinbase_commerce_client
+  source_code_uri: https://github.com/BiteCraft/coinbase_commerce_client
+  changelog_uri: https://github.com/BiteCraft/coinbase_commerce_client
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -145,8 +145,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: Coinbase Commerce integration client for crypto payments
 test_files: []