gcen-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5eacc47d1fbd10bda9bff24d9acd4dc8d8a1e53b
+  data.tar.gz: c0eb18035dfb0b7096d89ee0409bf8e8c145550a
+SHA512:
+  metadata.gz: 157bed5b829fd15b9fc2c668e085f3741315d5a57263224fedb6948a2ecd3a89c5fd92d619e144c6c82f53a8bad3412f6a44150e8fb94da7645e2f320ee6d5ba
+  data.tar.gz: 636d928e4aa7f54c83de15d65b7ddfe0b7189c6fea6d03b6460d48cd3d0fa6b4c8f1eecf410f4f13e9857e70ce746c2c2b5c3dce379ca666d8364468ef83641b

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    gcen-client (0.1.0)
+      faraday_middleware (~> 0.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.14.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  gcen-client!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Dmitriy Strukov
+
+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,12 @@
+# Gcen::Client
+
+The `gcen-client` library provides access to the Gcen API from applications in the Ruby language. It
+includes a pre-defined set of methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcen-client'
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gcen/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gcen-client.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'gcen/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gcen-client'
+  spec.version       = Gcen::Client::VERSION
+  spec.authors       = ['Dmitriy Strukov']
+  spec.email         = ['dmitiry_strukov2011@mail.ru']
+
+  spec.summary       = 'GCEN API Client'
+  spec.description   = 'GCEN API: Generic Investment API 0.1.1'
+  spec.homepage      = 'http://github.com/evil-raccoon/gcen-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+end

data/lib/gcen/client.rb

@@ -0,0 +1,2 @@
+require 'gcen/client/version'
+require 'gcen/client/api'

data/lib/gcen/client/api.rb

@@ -0,0 +1,179 @@
+require 'faraday'
+require 'json'
+
+module Gcen
+  module Client
+    class API
+      API_HOST = 'https://gcen.i-dash.co.uk/Api/'
+
+      attr_reader :gcen_token
+
+      # Authentication
+      #
+      # With each request, You must send an extra HTTP header, 'Authentication'
+      # We suggest using JSON as the data transfer type, hence you should set the Content Type to application/json
+      # All API requests must be made over HTTPS in POST format.
+      def initialize(gcen_token:)
+        @gcen_token = gcen_token
+      end
+
+      # AML Registration
+      # This method will register a client with GCEN
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/AMLRegister
+      def aml_register(params:)
+        post_request('AMLRegister', params)
+      end
+
+      # GCS Balance
+      # This method will return the GCS balance for a given client's currency
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/GCSBalance
+      def gcs_balance(client_id:, currency:)
+        post_request('GCSBalance', {
+          ClientId: client_id,
+          Currency: currency
+        })
+      end
+
+      # Bank transfer deposit
+      # Instructs GCEN of impending bank transfer deposit. Supplies the bank details and reference necessary.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/InvestmentDeposit
+      def investment_deposit(params:)
+        post_request('InvestmentDeposit', params)
+      end
+
+      # Card Payment Deposit
+      # Make an investment/deposit by credit/debit card.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/CardPayment
+      def card_payment(params:)
+        post_request('CardPayment', params)
+      end
+
+      # Check Card Payment Response
+      # This method checks whether a card payment was authorised and payment was successfully taken.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/CheckCardPaymentResponse
+      def check_card_payment_response(ref:, return_mac:)
+        post_request('CheckCardPaymentResponse', {
+          REF: ref,
+          RETURNMAC: return_mac
+        })
+      end
+
+      # Payment return from balance
+      # Instructs GCEN to make a payment out using one of the clients' GCS balances.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/PaymentReturnFromGCSBalance
+      def payment_return_from_gcs_balance(params:)
+        post_request('PaymentReturnFromGCSBalance', params)
+      end
+
+      # GCS Balance Transfer
+      # Instructs GCEN to move money from one GCS client balance to another. Internally, GCEN
+      # creates a virutal deal for the "FromClient". Money is moved from the "FromClient" balance to
+      # the virtual deal, and money is moved from the virutal deal to the "ToClient" balance.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/GCSBalanceTransfer
+      def gcs_balance_transfer(params:)
+        post_request('GCSBalanceTransfer', params)
+      end
+
+      # FX Quote
+      # Generates a unique quote from GCEN to exchange currency. Returns an FX Online Deal
+      # Quotation with a quotation reference. Quote is valid for purchase up to 30 minutes.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/GetFXQuote
+      def get_fx_quote(params:)
+        post_request('GetFXQuote', params)
+      end
+
+      # Confirm FX Quote - Card Payment
+      # This method confirms a given FX quote and sets up the payment system so the user can
+      # place their transaction.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/ConfirmQuoteWithCardPayment
+      def confirm_quote_with_card_payment(params:)
+        post_request('ConfirmQuoteWithCardPayment', params)
+      end
+
+      # Confirm FX Quote - Bank Transfer
+      # This method confirms a given FX quote and returns the amount and bank account that the
+      # client must pay in to.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/ConfirmQuoteWithBankTransfer
+      def confirm_quote_with_bank_transfer(params:)
+        post_request('ConfirmQuoteWithBankTransfer', params)
+      end
+
+      # Credit GCS Balance
+      # Makes a manual adjustment to a client's GCS balance.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/CreditGCSBalance
+      def credit_gcs_balance(client_id:, currency:, amount:)
+        post_request('CreditGCSBalance', {
+          ClientId: client_id,
+          Currency: currency,
+          Amount:   amount
+        })
+      end
+
+      # Upload Documentation
+      # This method allows you to send GCEN the client's Id documents for them to verify and
+      # confirm the identity of the client.
+      #
+      # @since 0.1.0
+      #
+      # @see https://app.gcen.co.uk/Api/UploadIdDocuments
+      def upload_id_documents(client_id:, document_1:, document_2:)
+        post_request('UploadIdDocuments', {
+          ClientId:  client_id,
+          Document1: document_1,
+          Document2: document_2
+        })
+      end
+
+      private
+
+        def post_request(endpoint_name, body, content_type='application/json')
+          http = Faraday.new(url: API_HOST) do |param|
+            param.headers['Authentication'] = gcen_token
+            param.adapter Faraday.default_adapter
+          end
+
+          response = http.post do |request|
+            request.url endpoint_name
+
+            request.body = body.to_json
+            request.headers['Content-Type'] = content_type
+          end
+
+          JSON.parse(response.body)
+        end
+    end
+  end
+end

data/lib/gcen/client/version.rb

@@ -0,0 +1,5 @@
+module Gcen
+  module Client
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: gcen-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitriy Strukov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: 'GCEN API: Generic Investment API 0.1.1'
+email:
+- dmitiry_strukov2011@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gcen-client.gemspec
+- lib/gcen/client.rb
+- lib/gcen/client/api.rb
+- lib/gcen/client/version.rb
+homepage: http://github.com/evil-raccoon/gcen-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: GCEN API Client
+test_files: []