coinbase_commerce_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9f34093c391c693ffc11f40d67a89b2f2401c2156144d5b8c1808e92482d656
+  data.tar.gz: f14707f0574281bfebe9d4ed929b16c1e0da0988da2253afb391b0daefd35678
+SHA512:
+  metadata.gz: 29791b039fab0a91e23c3965bf0ed7c14fc90d921048355b8f58ba795a48ac989e43c43a6d12ab47c21a4592d40a7677fa9fbb6a098f1cb620312f5417582649
+  data.tar.gz: e6fecf8770323a2270e6340a3a4a00939d435a784f13001a29f290ea662c1d85e2318cf2a809b4cc7053041fe05574068edc551072be6423a856b6be87a2e30f

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/coinbase_commerce_client.iml

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.3.23, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="byebug (v11.1.3, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="coderay (v1.1.3, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.5, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="docile (v1.4.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faraday (v2.6.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="faraday-net_http (v3.0.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="hashdiff (v1.0.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="json (v2.6.2, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="multipart-post (v2.2.3, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="pry (v0.14.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="pry-byebug (v3.10.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v5.0.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.6.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.36.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.21.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.21.2, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-html (v0.12.3, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-shields-badge (v0.1.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.4, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.3.0, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="webmock (v3.18.1, Remote-asdf: ruby-3.1.2-p20) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build coinbase_commerce_client-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if coinbase_commerce_client-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install coinbase_commerce_client-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install coinbase_commerce_client-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push coinbase_commerce_client-0.1.0.gem to http://mygemserver.com" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="Remote-asdf: ruby-3.1.2-p20" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/coinbase_commerce_client.iml" filepath="$PROJECT_DIR$/.idea/coinbase_commerce_client.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'libs/**/*'
+Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EndOfLine:
+  EnforcedStyle: lf

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at viniciusborgeis@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in coinbase_commerce_client.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem 'faraday', '~> 2.6'
+gem 'multipart-post', '~> 2.0'
+
+group :development do
+  gem 'pry-byebug', '~> 3.4'
+  gem 'rubocop', '~> 1.36', require: false
+end
+
+group :test do
+  gem 'rspec', '~> 3.0'
+  gem 'webmock', '~> 3.18'
+  gem 'simplecov', '~> 0.21.2', require: false
+  gem 'simplecov-shields-badge', '~> 0.1.0', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,99 @@
+PATH
+  remote: .
+  specs:
+    coinbase_commerce_client (0.1.0)
+      faraday (~> 2.6)
+      multipart-post (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    faraday (2.6.0)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.1)
+    hashdiff (1.0.1)
+    json (2.6.2)
+    method_source (1.0.0)
+    multipart-post (2.2.3)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-shields-badge (0.1.0)
+      simplecov (~> 0.15)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  coinbase_commerce_client!
+  faraday (~> 2.6)
+  multipart-post (~> 2.0)
+  pry-byebug (~> 3.4)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.36)
+  simplecov (~> 0.21.2)
+  simplecov-shields-badge (~> 0.1.0)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.3.23

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vinicius Borges
+
+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) 2022 Vinicius Borges
+
+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,267 @@
+[![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">
+</p>
+
+# Coinbase Commerce Client
+> <sub>This gem is completely inspired by official Coinbase gem [coinbase-commerce-ruby](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-->
+
+## Ruby Version
+Ruby [2.3 -> 3.1.2] 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_client'
+API_KEY = "API KEY"
+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
+
+```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
+checkout = client.checkout.retrieve <id>
+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_client'
+```
+Then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install coinbase_commerce_client
+```
+
+## Usage
+```ruby
+require 'coinbase_commerce'
+client = CoinbaseCommerceClient::Client.new(api_key: 'your_api_key')
+```
+## Checkouts
+[Checkouts API docs](https://commerce.coinbase.com/docs/api/#checkouts)
+### Retrieve
+```ruby
+checkout = client.checkout.retrieve <checkout_id>
+```
+### 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_id>
+checkout.name = 'new name'
+checkout.save
+# or
+client.checkout.modify(<checkout_id>, "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 <charge_id>
+```
+### 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 <event_id>
+```
+### 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 = CoinbaseCommerceClient::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 CoinbaseCommerceClient::Errors::SignatureVerificationError => e
+    puts "signature verification error"
+    status 400
+    return
+  rescue CoinbaseCommerceClient::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