sep6_client 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 585b0211026abc26214470978dd4c60d368680509f70cf6050771d78881667b7
+  data.tar.gz: 54f0ed9d094d44a8cc8303d4c7b45cf641caf210cea588e9883b9e38b0e17cca
+SHA512:
+  metadata.gz: 5f48d6b6c33b0419421445cbcef951dff4c343061a8d8bc2400503608b4a360fbaaa2638d9556a0c7f4fa0980ffcafc6a25f15917f6ae044dc2049e401ca9eb7
+  data.tar.gz: dee4f7127e6b042b7c99a25cbd48782e1bfd249b046b71b453192998a87e2acd9c0707b8ffe23975d7c455061da69f2a1c66885235e47db0af876250cfadc41d

data/.gitignore

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

data/Gemfile

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

data/lib/sep6_client/client.rb

@@ -0,0 +1,163 @@
+require 'rest-client'
+require 'json'
+require 'time'
+require 'sep6_client/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 Sep6Client
+
+  class Client
+
+    # Initializes the Sep-6 Client
+    # @param transfer_server; the SEP-6 transfer server
+    # @param log_file; optional log file path
+    # @constructor
+    def initialize(transfer_server = nil, log_file = nil)
+
+      # @string Used in the HTTP user agent (leave it as is)
+      @client_name = Sep6Client::CLIENT_NAME
+
+      # @string The current version of this SDK, used in the HTTP user agent (leave it as is)
+      @client_version = Sep6Client::CLIENT_VERSION
+
+      # @string COINQVEST connect url
+      @transfer_server = transfer_server ? transfer_server : Sep6Client::TRANSFER_SERVER
+
+      # @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 COINQVEST servers
+    private
+    def build_connect_url(endpoint)
+      "https://" + @transfer_server + endpoint
+    end
+
+    # private class to generate authentication headers
+    private
+    def build_headers(endpoint, method, params)
+      {
+          :"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 + " [CoinqvestMerchantSDK] " + text + "\n") }
+      # print Time.now.utc.rfc822 + " [CoinqvestMerchantSDK] " + text + "\n"
+
+    end
+
+  end
+
+end

data/lib/sep6_client/config.rb

@@ -0,0 +1,9 @@
+module Sep6Client
+
+  CLIENT_VERSION = '0.0.2'
+
+  CLIENT_NAME = 'sep6_client'
+
+  TRANSFER_SERVER = 'sep6.coinqvest.com'
+
+end

data/lib/sep6_client.rb

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

data/sep6_client.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'sep6_client/config'
+
+Gem::Specification.new do |s|
+  s.name        = 'sep6_client'
+  s.version     = Sep6Client::CLIENT_VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['COINQVEST LLC']
+  s.email       = ['service@coinqvest.com']
+  s.homepage    = 'https://www.coinqvest.com'
+  s.summary     = %q{Ruby based Stellar SEP-6 Client by COINQVEST}
+  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: sep6_client
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- COINQVEST LLC
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-01 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: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+description:
+email:
+- service@coinqvest.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- lib/sep6_client.rb
+- lib/sep6_client/client.rb
+- lib/sep6_client/config.rb
+- sep6_client.gemspec
+homepage: https://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: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Ruby based Stellar SEP-6 Client by COINQVEST
+test_files: []