whalestack_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39a9edcd754a06acfaa517bca1ab842f45c4de90bc3b24ffd209f1b0c290c3a3
+  data.tar.gz: d855b3652542a288ece87335d85b00d7b028dfac85abe7a47dfeeaf86b890339
+SHA512:
+  metadata.gz: 05ae3d879275ebff8a772266372609bbcb320201772ca11244dc96583687e825cdcf25d9493d5c54d5655f51a39aeb3979b0d652725340fc96860d79ec530db0
+  data.tar.gz: 8b2eea8419491598926ebb4d3ffa9656bd500806be1845bd50783441f7454b61a5e44aade20027e1920bd366167a4e377197495edcafbaae589a8b2831d0ab80

data/.gitignore

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

data/Gemfile

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

data/lib/whalestack_sdk/client.rb

@@ -0,0 +1,184 @@
+require 'rest-client'
+require 'json'
+require 'time'
+require 'whalestack_sdk/config'
+require 'uri'
+require 'openssl'
+
+ # Ruby implementation of a REST client for the Whalestack Payments API
+ # see https://www.whalestack.com/en/api-docs
+module WhalestackSDK
+
+  class Client
+
+    # Merchant API client constructor, initialize this with the API key and secret as given by https://www.whalestack.com/en/api-settings
+    # @param key; as given by https://www.whalestack.com/en/api-settings
+    # @param secret; as given by https://www.whalestack.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.whalestack.com/en/api-settings
+      @key = key
+
+      # @string The API Secret as given by https://www.whalestack.com/en/api-settings
+      @secret = secret
+
+      # @string The API version to which we connect (leave it as is)
+      @api_version = WhalestackSDK::API_VERSION
+
+      # @string Used in the HTTP user agent (leave it as is)
+      @client_name = WhalestackSDK::CLIENT_NAME
+
+      # @string The current version of this SDK, used in the HTTP user agent (leave it as is)
+      @client_version = WhalestackSDK::CLIENT_VERSION
+
+      # @string Whalestack connect url
+      @connect_url = WhalestackSDK::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_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_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_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_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 Whalestack servers
+    private
+    def build_connect_url(endpoint)
+      @connect_url + @api_version + endpoint
+    end
+
+    # private class to generate authentication headers
+    private
+    def build_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,
+          :"User-Agent" => @client_name + " " + @client_version
+      }
+
+    end
+
+
+    private
+    def log(text)
+
+      if @log_file == nil
+        return
+      end
+
+      File.open(@log_file, 'a') { |f| f.write(Time.now.utc.rfc822 + " [WhalestackSDK] " + text + "\n") }
+
+    end
+
+  end
+
+end

data/lib/whalestack_sdk/config.rb

@@ -0,0 +1,11 @@
+module WhalestackSDK
+
+  CLIENT_VERSION = '1.0.0'
+
+  CLIENT_NAME = 'ruby_sdk'
+
+  API_VERSION = 'v1'
+
+  CONNECT_URL = 'https://www.whalestack.com/api/'
+
+end

data/lib/whalestack_sdk.rb

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

data/whalestack_sdk.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'whalestack_sdk/config'
+
+Gem::Specification.new do |s|
+  s.name        = 'whalestack_sdk'
+  s.version     = WhalestackSDK::CLIENT_VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Whalestack LLC']
+  s.email       = ['service@whalestack.com']
+  s.homepage    = 'https://www.whalestack.com'
+  s.summary     = %q{Whalestack SDK. 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', '~> 2.3', '>= 2.3.0'
+
+  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

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: whalestack_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Whalestack LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-05 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.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- service@whalestack.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- lib/whalestack_sdk.rb
+- lib/whalestack_sdk/client.rb
+- lib/whalestack_sdk/config.rb
+- whalestack_sdk.gemspec
+homepage: https://www.whalestack.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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Whalestack SDK. Programmatically accept and settle payments in digital currencies.
+test_files: []