coinqvest_merchant_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c98289ad3631f1f67deb9dfeb42c6140bbb09e7a
+  data.tar.gz: cb27c4cb49a557007db6d39464f871d8354116b0
+SHA512:
+  metadata.gz: a4c98c934545300533a7de7a6c14aced90a5698f6b5d9b3f8923ed31392a619b1f68c94421fcfe6b95c47cd8b9658c790c5e01787de6c9935f52a3d48dbe7151
+  data.tar.gz: 5f5ddc8553c65a7e40cd5a6b4d1b58da94cd187371d05368f3c48dbf2a45bbb0b9f8ab038e85bc518b8de9ca6cd518f1bc2db831c5985583688b9b13dd629b5f

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify dependencies in coinqvest_merchant_sdk.gemspec
+gemspec

data/bin/example.rb

@@ -0,0 +1,116 @@
+#!/usr/bin/env ruby
+require 'coinqvest_merchant_sdk/client'
+
+# This file contains examples on how to interact with the COINQVEST Merchant API.
+# All endpoints of the API are documented here: https://www.coinqvest.com/en/api-docs
+
+# Create a COINQVEST Merchant API client
+# The constructor takes your API Key, API Secret and an optional log file location as parameters
+# Your API Key and Secret can be obtained here: https://www.coinqvest.com/en/api-settings
+client = CoinqvestMerchantSDK::Client.new(
+    'YOUR-API-KEY',
+    'YOUR-API-SECRET',
+    '/var/log/coinqvest-ruby.log' # an optional log file location
+)
+
+# Invoke a request to GET /auth-test (https://www.coinqvest.com/en/api-docs#get-auth-test) to see if everything worked
+response = client.get('/auth-test')
+
+# The API should return an HTTP status code of 200 if the request was successfully processed, let's have a look.
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+# Check our USD wallet balance using GET /wallet (https://www.coinqvest.com/en/api-docs#get-wallet)
+response = client.get('/wallet', {:assetCode => 'USD'})
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+# Create a checkout and get paid in two easy steps!
+#
+# It's good practice to associate payments with a customer, let's create one!
+# Invoke POST /customer (https://www.coinqvest.com/en/api-docs#post-customer) to create a new customer object.
+# Tip: At a minimum a customer needs an email address, but it's better to provide a full billing address for invoices.
+response = client.post('/customer', {:customer => {
+    :email => 'john@tester-1.com',
+    :firstname => 'John',
+    :lastname => 'Doe',
+    :company => 'ACME Inc.',
+    :adr1 => '810 Beach St',
+    :adr2 => 'Finance Department',
+    :zip => 'CA 94103',
+    :city => 'San Francisco',
+    :countrycode => 'US'
+}})
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+if response.code != 200
+  # something went wrong, let's abort and debug by looking at our log file specified above in the client.
+  print "Could not create customer, please check the logs."
+  exit 1
+end
+
+# the customer was created
+data = JSON.parse(response.body)
+# data now contains an object as specified in the success response here: https://www.coinqvest.com/en/api-docs#post-customer
+# extract the customer id to use it in our checkout below
+customer_id = data["customerId"]
+
+# We now have a customer. Let's create a checkout for him/her.
+# This creates a hosted checkout, which will provide a payment interface hosted on COINQVEST servers
+response = client.post('/checkout/hosted', {
+    :charge => {
+        :customerId => customer_id, # associates this charge with a customer
+        :currency => 'USD', # specifies the billing currency
+        :lineItems => [{ # a list of line items included in this charge
+            :description => 'T-Shirt',
+            :netAmount => 10, # denominated in the currency specified above
+            :quantity => 1
+        }],
+        :discountItems => [{ # an optional list of discounts
+            :description => 'Loyalty Discount',
+            :netAmount => 0.5
+        }],
+        :shippingCostItems => [{ # an optional list of shipping and handling costs
+            :description => 'Shipping and Handling',
+            :netAmount => 3.99,
+            :taxable => FALSE # sometimes shipping costs are taxable
+        }],
+        :taxItems => [{ # an optional list of taxes
+            :name => 'CA Sales Tax',
+            :percent => 0.0825 # 8.25% CA sales tax
+        }]
+    },
+    :settlementCurrency => 'EUR' # specifies in which currency you want to settle
+})
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+if response.code != 200
+  # something went wrong, let's abort and debug by looking at our log file specified above in the client.
+  print "Could not create checkout, please check the logs."
+  exit 1
+end
+
+# the customer was created
+data = JSON.parse(response.body)
+# data now contains an object as specified in the success response here: https://www.coinqvest.com/en/api-docs#post-customer
+checkout_id = data["checkoutId"] # store this persistently in your database
+url = data["url"] # redirect your customer to this URL to complete the payment
+
+# you can update a customer object like this
+response = client.put('/customer', {:customer => {
+    :id => customer_id,
+    :email => 'john@tester-2.com',
+    :firstname => 'John',
+    :lastname => 'Doe'
+}})
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"
+
+# delete a customer when not needed anymore
+response = client.delete('/customer', {
+    :id => customer_id
+})
+print "Status Code: " + response.code.to_s + "\n"
+print "Response Body: " + response.body + "\n"

data/coinqvest_merchant_sdk.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'coinqvest_merchant_sdk/config'
+
+Gem::Specification.new do |s|
+  s.name        = 'coinqvest_merchant_sdk'
+  s.version     = CoinqvestMerchantSDK::CLIENT_VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['COINQVEST Ltd.']
+  s.email       = ['service@coinqvest.com']
+  s.homepage    = 'http://www.coinqvest.com'
+  s.summary     = %q{Ruby Merchant SDK for COINQVEST. Programmatically accept and settle payments in digital currencies.}
+  s.licenses    = ['Apache-2.0']
+  s.required_ruby_version = '>= 2.0.0'
+
+  s.add_runtime_dependency 'rest-client', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

data/lib/coinqvest_merchant_sdk.rb

@@ -0,0 +1,3 @@
+module CoinqvestMerchantSDK
+  # Your code goes here...
+end

data/lib/coinqvest_merchant_sdk/client.rb

@@ -0,0 +1,186 @@
+require 'rest-client'
+require 'json'
+require 'time'
+require 'coinqvest_merchant_sdk/config'
+require 'uri'
+require 'openssl'
+
+ # Ruby implementation of a REST client for the COINQVEST Merchant API
+ # see https://www.coinqvest.com/en/api-docs
+module CoinqvestMerchantSDK
+
+  class Client
+
+    # Merchant API client constructor, initialize this with the API key and secret as given by https://www.coinqvest.com/en/api-settings
+    # @param key; as given by https://www.coinqvest.com/en/api-settings
+    # @param secret; as given by https://www.coinqvest.com/en/api-settings
+    # @param log_file; optional log file path
+    # @constructor
+    def initialize(key, secret, log_file = NIL)
+
+      # @string The API Key as given by https://www.coinqvest.com/en/api-settings
+      @key = key
+
+      # @string The API Secret as given by https://www.coinqvest.com/en/api-settings
+      @secret = secret
+
+      # @string The API version to which we connect (leave it as is)
+      @api_version = CoinqvestMerchantSDK::API_VERSION
+
+      # @string Used in the HTTP user agent (leave it as is)
+      @client_name = CoinqvestMerchantSDK::CLIENT_NAME
+
+      # @string The current version of this SDK, used in the HTTP user agent (leave it as is)
+      @client_version = CoinqvestMerchantSDK::CLIENT_VERSION
+
+      # @string COINQVEST connect url
+      @connect_url = CoinqvestMerchantSDK::CONNECT_URL
+
+      # @string|NIL Specifies the log file to which to write, if any.
+      @log_file = log_file ? log_file : NIL
+
+    end
+
+    # Use this method to communicate with GET endpoints
+    # @param endpoint (string), e.g. GET /customer
+    # @param params (hash), a list of GET parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def get(endpoint, params = {})
+
+      path = build_connect_url(endpoint) + '?' +  URI.encode_www_form(params)
+      headers = build_auth_headers(endpoint, 'GET', params)
+
+      log "GET " + path
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :get, url: path, headers: headers, timeout: 180)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with POST endpoints
+    # @param endpoint (string), e.g. POST /checkout/hosted
+    # @param params (hash), a list of GET parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def post(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_auth_headers(endpoint, 'POST', params)
+
+      log "POST " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :post, url: path, payload: params.to_json, headers: headers, timeout: 180)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with PUT endpoints
+    # @param endpoint (string), e.g. PUT /customer
+    # @param params (hash), a list of GET parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def put(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_auth_headers(endpoint, 'PUT', params)
+
+      log "PUT " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :put, url: path, payload: params.to_json, headers: headers, timeout: 180)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # Use this method to communicate with PUT endpoints
+    # @param endpoint (string), e.g. PUT /customer
+    # @param params (hash), a list of GET parameters to be included in the request
+    # @return RestClient::Response, https://github.com/rest-client/rest-client/blob/2c72a2e77e2e87d25ff38feba0cf048d51bd5eca/lib/restclient/response.rb
+    def delete(endpoint, params = {})
+
+      path = build_connect_url(endpoint)
+      headers = build_auth_headers(endpoint, 'DELETE', params)
+
+      log "DELETE " + path + " " + params.to_s
+      log headers.to_s
+
+      begin
+        response = RestClient::Request.execute(method: :delete, url: path, payload: params.to_json, headers: headers, timeout: 180)
+      rescue RestClient::ExceptionWithResponse => e
+        log e.http_code.to_s + " " + e.response.to_s
+        return e.response
+      end
+
+      log response.code.to_s + " " + response.to_s
+
+      response
+
+    end
+
+    # private class to generate connect url on COINQVEST servers
+    private
+    def build_connect_url(endpoint)
+      @connect_url + @api_version + endpoint
+    end
+
+    # private class to generate authentication headers
+    private
+    def build_auth_headers(endpoint, method, params)
+
+      timestamp = Time.now.to_i
+      body = NIL
+      if method != 'GET'
+        body = params.length > 0 ? params.to_json : NIL
+      end
+      data = endpoint + timestamp.to_s + method + body.to_s
+
+      {
+          :"X-Digest-Key" => @key,
+          :"X-Digest-Signature" => OpenSSL::HMAC.hexdigest('sha256', @secret, data),
+          :"X-Digest-Timestamp" => timestamp
+      }
+
+    end
+
+
+    private
+    def log(text)
+
+      if @log_file == NIL
+        return
+      end
+
+      File.open(@log_file, 'a') { |f| f.write(Time.now.utc.rfc822 + " [CoinqvestMerchantSDK] " + text + "\n") }
+
+      # todo: remove this before commit
+      # print Time.now.utc.rfc822 + " [CoinqvestMerchantSDK] " + text + "\n"
+
+    end
+
+  end
+
+end

data/lib/coinqvest_merchant_sdk/config.rb

@@ -0,0 +1,11 @@
+module CoinqvestMerchantSDK
+
+  CLIENT_VERSION = '0.0.1'
+
+  CLIENT_NAME = 'ruby_merchant_sdk'
+
+  API_VERSION = 'v1'
+
+  CONNECT_URL = 'https://www.coinqvest.com/api/'
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: coinqvest_merchant_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- COINQVEST Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: 
+email:
+- service@coinqvest.com
+executables:
+- example.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- bin/example.rb
+- coinqvest_merchant_sdk.gemspec
+- lib/coinqvest_merchant_sdk.rb
+- lib/coinqvest_merchant_sdk/client.rb
+- lib/coinqvest_merchant_sdk/config.rb
+homepage: http://www.coinqvest.com
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Ruby Merchant SDK for COINQVEST. Programmatically accept and settle payments
+  in digital currencies.
+test_files: []