privacygate 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f07cc6ae11d0fdfdd6972cda01666bbe4713ddbcd164e2fd79fe38fdc31b7cb
+  data.tar.gz: 10e8c687b0040ae96276663c29b22f425c51d4a8e13de0778cade52dfc935e40
+SHA512:
+  metadata.gz: c410c66a8912aa4aa218102390988fc2b8f47d0d02c26061043d13801480bf2f300ed989929ece57f3142b06fef5d7d124033da6960cf1bbcbb4e5df0fc87878
+  data.tar.gz: 90a1737cede4bfeaaa133573e94238ff063bcbb81a38667cb96cf1d2acaf1a23a036acc056a02b1e50ce0658cf34e1064699eed04925711b142cad4c1d7de1af

data/.github/ISSUE_REQUEST_TEMPLATE/issue_request_template.md

@@ -0,0 +1,36 @@
+<!---
+ISSUE TITLE: Please make your title easy to understand short summary, usually 4-10 words. Examples:
+
+> Cannot install dependencies due to version error.
+> How do I set a callback redirect url?
+> Curl with API Key not working.
+--->
+
+**Severity:** <severity>
+
+<!---
+Replace <severity> with a priority ranking P0-P3:
+
+> P0: severe/ blocking - completely broken or unusable.
+> P1: high priority - breaking but non-essential.
+> P2: medium priority - non-breaking issue.
+> P3: low priority - questions or nice-to-haves.
+--->
+
+**Description:**
+<description>
+
+<!---
+Replace <description> with a detailed summary of the issue or question, including any relevant context to avoid follow-up questions.
+--->
+
+**Steps to Reproduce:**
+<steps>
+
+<!---
+Replace <steps> with instructions so others can reproduce.
+--->
+
+**Configuration:**
+
+<!--- List your relevant environment/ server/ dependency versions. Any 3rd party plugin use (ie WooCommerce, etc) and corresponding versions. --->

data/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,51 @@
+<!---
+PR TITLE: Please name your pull request according to this format: [type] short summary. Examples:
+
+> [bugfix] added callback function to charge example.
+> [feature] enabled refunds event signature.
+> [chore] updated docs with webhooks instructions.
+--->
+
+**Issue:** <link>
+
+<!---
+IMPORTANT: Please do not create a Pull Request without creating an issue first. Replace <link> with the url link to the issue.
+--->
+
+**Type:** <type>
+
+<!---
+Same as in title, replace <type> with one of the following options: bugfix | feature | chore
+
+> bugfix: a change which fixes an issue.
+> feature: a change which adds functionality.
+> chore: doc updates, dependencies, refactor, etc.
+--->
+
+**Description:** <description>
+
+<!---
+Replace <description> with a detailed summary of the change, including any relevant context to avoid follow-up questions.
+--->
+
+**Testing:** <testing>
+
+<!---
+Replace <testing> with a description of how you've tested/ verified your changes.
+--->
+
+**Configuration:**
+
+<!---
+List your relevant environment/ server/ dependency versions. Any 3rd party plugin use (ie WooCommerce, etc) and corresponding versions.
+--->
+
+<!---
+CHECKLIST: Please ensure you have done the following.
+> 1. I have performed a self-review of my own code.
+> 2. I have commented my code, particularly in hard-to-understand areas.
+> 3. I have made relevant changes to the documentation.
+> 4. My changes generate no new warnings.
+> 5. I have added any tests that prove my fix is effective or that my feature works.
+> 6. New and existing unit tests pass locally with my changes.
+--->

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+.idea/
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+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,278 @@
+# privacygate-ruby
+PrivacyGate 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, 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)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'privacygate'
+```
+Then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install privacygate
+```
+
+## Documentation
+
+For more details visit [PrivacyGate API docs](https://privacygate.io/docs/).
+
+To start using library, you'll need to [create a PrivacyGate account](https://dash.privacygate.io).
+Once you've created your PrivacyGate account, create an ``API_KEY`` in Settings.
+
+Next create a ``Client`` object for interacting with the API:
+```ruby
+require 'privacygate'
+
+API_KEY = "API KEY"
+client = PrivacyGate::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 <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 'privacygate'
+```
+Then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install privacygate
+```
+
+## Usage
+```ruby
+require 'privacygate'
+
+client = PrivacyGate::Client.new(api_key: 'your_api_key')
+```
+## Checkouts 
+[Checkouts API docs](https://privacygate.io/docs/#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://privacygate.io/docs/#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://privacygate.io/docs/#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 = PrivacyGate::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 PrivacyGate::Errors::SignatureVerificationError => e
+    puts "signature verification error"
+    status 400
+    return
+  rescue PrivacyGate::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:

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/examples/charge.rb

@@ -0,0 +1,38 @@
+require 'privacygate'
+
+client = PrivacyGate::Client.new(api_key: 'your_api_key')
+
+# create charge
+data = {
+    "name": "The Sovereign Individual",
+    "description": "Mastering the Transition to the Information Age",
+    "local_price": {
+        "amount": "100.00",
+        "currency": "USD"
+    },
+    "pricing_type": "fixed_price"
+
+}
+charge = client.charge.create(data)
+
+# or retrieve it if you know charge id
+charge = client.charge.retrieve charge.id
+
+# get charges list
+charges_list = client.charge.list
+
+# in case you need provide additional params
+charges_list = client.charge.list(limit: 10)
+
+# or get results from another page
+charges_list = client.charge.list(starting_after: charge.id, limit: 3)
+
+# charges list could be iterated like
+charges_list.data.each do |charge|
+  puts charge.id
+end
+
+# iterate over all charges with per-page limitation
+client.charge.auto_paging limit: 20 do |charge|
+  puts charge.id
+end

data/examples/checkout.rb

@@ -0,0 +1,61 @@
+require 'privacygate'
+
+client = PrivacyGate::Client.new(api_key: 'your_api_key')
+
+# create checkout
+data = {
+    "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(data)
+
+# or retrieve it if you know checkout id
+checkout = client.checkout.retrieve checkout.id
+
+# update checkout with modify method
+upd_checkout = client.checkout.modify(checkout.id, "local_price": {
+    "amount": "10000.00",
+    "currency": "USD"
+})
+
+# or with save method if you already have checkout object
+upd_checkout.name
+upd_checkout.description = "foo"
+upd_checkout.to_hash
+upd_checkout.name = "bar"
+amount = "1000.00"
+upd_checkout.local_price.amount = amount
+upd_checkout.save
+
+# get checkouts list
+checkouts_list = client.checkout.list
+
+# in case you need provide additional params
+checkouts_list = client.checkout.list(limit: 10)
+
+# or get results from another page
+checkouts_list = client.checkout.list(starting_after: checkout.id, limit: 3)
+
+# checkout list could be iterated like
+checkouts_list.data.each do |ch|
+  # work with each checkout
+  puts ch.id
+end
+
+# iterate over all checkouts and modify them with per-page limitation
+client.checkout.auto_paging limit: 20 do |ch|
+  puts ch.id
+  ch.name = 'name updated'
+  ch.save
+  # also could be deleted by
+  # ch.delete
+end
+
+# delete checkout
+upd_checkout.delete

data/examples/event.rb

@@ -0,0 +1,26 @@
+require 'privacygate'
+
+client = PrivacyGate::Client.new(api_key: 'your_api_key')
+
+# get events list
+events_list = client.event.list
+
+# in case you need provide additional params
+events_list = client.event.list(limit: 10)
+
+# or get results from another page
+event = events_list.data[0]
+events_list = client.event.list(starting_after: event.id, limit: 3)
+
+# event list could be iterated like
+events_list.data.each do |event|
+  puts event.id
+end
+
+# retrieve single event
+event = client.event.retrieve event.id
+
+# iterate over all events with per-page limitation
+client.event.auto_paging limit: 20 do |event|
+  puts event.id
+end

data/examples/webhook.rb

@@ -0,0 +1,35 @@
+# Sinatra server example to test webhooks
+# You may need tunnels to localhost webhook development tool and debugging tool.
+# f.e. you could try ngrok
+
+require 'sinatra'
+require 'privacygate'
+
+set :port, 5000
+WEBHOOK_SECRET = 'your_webhook_secret'
+
+# Using Sinatra
+post '/webhooks' do
+  payload = request.body.read
+  sig_header = request.env['HTTP_X_CC_WEBHOOK_SIGNATURE']
+
+  begin
+    event = PrivacyGate::Webhook.construct_event(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 PrivacyGate::Errors::SignatureVerificationError => e
+    puts "signature verification error"
+    status 400
+    return
+  rescue PrivacyGate::Errors::WebhookInvalidPayload => e
+    puts "missing request or headers data"
+    status 400
+    return
+  end
+end