bitodeme 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 054db3ffb0a816ebcf1a29a3122be47fef657b23
-  data.tar.gz: 578c58d1d341a0c9857eb89db6d8f058134710d8
+  metadata.gz: b98888019e9878b395b47c1dc8b36810b9c045f7
+  data.tar.gz: fd71b503b3f8ef66e88e7c7eabd60c0bcfc6633e
 SHA512:
-  metadata.gz: 4f39409034167326d5a05bc62f401137ee2a3f73dd6aff58f18fc5949f57a38701aa747757d5a6f71ffb4df945219f624211384b75a60dcc502c7200881d6169
-  data.tar.gz: 13948b09a6426531b51131aa5bda1dbc8b81ccfb8e570f586615c72e8337dccd67bee8799ec64ac8ad1f7d7cd4134ed10b620899bd77e83140fe629d2bf713e3
+  metadata.gz: 836f05b8fe05f6160a8f348ad0bb84b8497d42883a2b680a9eff5ca9ba7be25837aa0850c72d450114d9c80918019787441974fe6a65a90f9ca5aedaad241abd
+  data.tar.gz: cd37897158f7ef590acf6949f8d20260be048956bb6e46dbf6a238c346adccd52864a128a169504de5dcc66c5c04ffba149f67378bb1294463ed40e3275673e1

data/.gitignore

@@ -12,3 +12,4 @@
 
 .env
 .byebug_history
+*.gem

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in bitodeme.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    bitodeme (0.1.0)
+      dotenv (~> 2.2, >= 2.2)
+      faraday (~> 0.13)
+      faraday_middleware (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dotenv (2.2.1)
+    faraday (0.13.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    json (2.1.0)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bitodeme!
+  bundler (~> 1.14)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.15)
+
+BUNDLED WITH
+   1.16.0

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bitodeme.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'pry', '~> 0.11'
 
   spec.add_dependency 'dotenv', '~> 2.2', '>= 2.2'
   spec.add_dependency 'faraday', '~> 0.13'

data/lib/bitodeme/auth.rb

@@ -0,0 +1,71 @@
+require 'forwardable'
+
+module Bitodeme
+  # OAuth2 client credentials authenticator for Bitodeme
+  class Auth
+    extend Forwardable
+
+    def initialize
+      @expires_at = 0
+    end
+
+    # Valid access token for Bitodeme endpoints
+    def token
+      reset_token if expired?
+      access_token
+    end
+
+    private
+
+    USER_AGENT    = "Ruby / Bitodeme v#{Bitodeme::VERSION}".freeze
+    GRANT_TYPE    = 'client_credentials'.freeze
+    AUTH_ENDPOINT = '/api/v1/tokens'.freeze
+
+    def_delegators :Bitodeme, :config
+    def_delegators :config, :hostname, :client_id, :client_secret
+
+    attr_reader :access_token, :expires_at
+
+    def expired?
+      Time.now.to_i > expires_at
+    end
+
+    def reset_token
+      token         = authenticate.fetch('token', {})
+      @access_token = token.fetch('value', '')
+      @expires_at   = token.fetch('expires_at', 0)
+    end
+
+    def authenticate
+      conn.post(AUTH_ENDPOINT, auth_body).body
+    end
+
+    def conn
+      @conn ||= Faraday.new(faraday_opts) do |faraday|
+        faraday.request  :json
+        faraday.response :logger
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def faraday_opts
+      {
+        url:     "https://#{hostname}",
+        headers: { 'User-Agent' => USER_AGENT }
+      }
+    end
+
+    def auth_body
+      @auth_body ||= { token: auth_params }
+    end
+
+    def auth_params
+      {
+        client_id:     client_id,
+        client_secret: client_secret,
+        grant_type:    GRANT_TYPE
+      }
+    end
+  end
+end

data/lib/bitodeme/configuration.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+
+module Bitodeme
+  # Configuration for Bitodeme
+  class Configuration
+    include Singleton
+
+    attr_reader :hostname,
+                :client_id,
+                :client_secret
+
+    def initialize
+      @hostname      = ENV['BITODEME_HOSTNAME']
+      @client_id     = ENV['BITODEME_CLIENT_ID']
+      @client_secret = ENV['BITODEME_CLIENT_SECRET']
+    end
+  end
+end

data/lib/bitodeme/conn.rb

@@ -0,0 +1,43 @@
+require 'singleton'
+require 'json'
+
+module Bitodeme
+  # HTTP Connection for Bitodeme
+  class Conn
+    include Singleton
+
+    private_class_method :new
+
+    USER_AGENT = "Ruby / Bitodeme v#{Bitodeme::VERSION}".freeze
+
+    def self.build
+      @conn ||= new.send(:conn)
+    end
+
+    private
+
+    attr_reader :auth, :hostname
+
+    def initialize
+      @auth     = Bitodeme::Auth.new
+      @hostname = Bitodeme.config.hostname
+    end
+
+    def conn
+      Faraday.new(faraday_opts) do |faraday|
+        faraday.request  :oauth2, auth.token, token_type: :bearer
+        faraday.request  :json
+        faraday.response :logger
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter  Faraday.default_adapter
+      end
+    end
+
+    def faraday_opts
+      @faraday_opts ||= {
+        url:     "https://#{hostname}",
+        headers: { 'User-Agent' => USER_AGENT }
+      }
+    end
+  end
+end

data/lib/bitodeme/resources/base.rb

@@ -0,0 +1,77 @@
+require 'forwardable'
+
+module Bitodeme
+  module Resource
+    # Base class for all Bitodeme resources
+    class Base
+      extend SingleForwardable
+
+      def_delegators :conn, :post, :get, :put, :delete
+
+      class << self
+        private
+
+        def conn
+          Bitodeme::Conn.build
+        end
+
+        def _find(collection, resource, id)
+          get("/api/v1/#{collection}/#{id}").body.fetch(resource, {}) || {}
+        end
+
+        def _all(collection, page: 1, per_page: 50, since: 0)
+          query_params = { page: page, per_page: per_page, since: since }
+          get("/api/v1/#{collection}", query_params).body.fetch(collection, [])
+        end
+
+        def _update(collection, resource, id, data)
+          put("/api/v1/#{collection}/#{id}", data).body.fetch(resource, data)
+        end
+
+        def _create(collection, resource, data)
+          post("/api/v1/#{collection}", data).body.fetch(resource, data)
+        end
+
+        def _delete(collection, id)
+          delete("/api/v1/#{collection}/#{id}").body
+        end
+      end
+
+      def to_h
+        hash = {}
+        attrs.each do |attr|
+          val               = instance_variable_get(:"@#{attr}")
+          hash[attr.to_sym] = val unless val.nil?
+        end
+        hash
+      end
+
+      private
+
+      def initialize(attrs:, params:)
+        attrs.each do |attr|
+          instance_variable_set(
+            "@#{attr}",
+            params.fetch(attr.to_s, params.fetch(attr.to_sym, nil))
+          )
+        end
+      end
+
+      def attrs
+        methods - klass_methods - excluded_attrs
+      end
+
+      def klass_methods
+        self.class.methods - [:name]
+      end
+
+      def excluded_attrs
+        %i[to_h validate]
+      end
+
+      def raise_for(attr)
+        raise Bitodeme::ValidationError.new(attr, send(:"#{attr}"))
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/currency.rb

@@ -0,0 +1,34 @@
+module Bitodeme
+  module Resource
+    # Currency resource
+    class Currency < Base
+      private_class_method :new
+
+      attr_reader :withdrawable,
+                  :withdraw_fee,
+                  :updated_at,
+                  :name,
+                  :min_withdrawable_amount,
+                  :min_depositable_amount,
+                  :exchangeable,
+                  :depositable,
+                  :deposit_fee,
+                  :current_status,
+                  :created_at,
+                  :code
+
+      class << self
+        def all(options = {})
+          items = _all('currencies', options)
+          items.map { |item| new(item) }
+        end
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/deposit.rb

@@ -0,0 +1,26 @@
+module Bitodeme
+  module Resource
+    # Deposit resource
+    class Deposit < Base
+      private_class_method :new
+
+      attr_reader :id
+
+      class << self
+        PLURAL   = 'deposits'.freeze
+        SINGULAR = 'deposit'.freeze
+
+        def all(options = {})
+          items = _all(PLURAL, options)
+          items.map { |item| new(item) }
+        end
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/fund.rb

@@ -0,0 +1,36 @@
+module Bitodeme
+  module Resource
+    # Fund resource
+    class Fund < Base
+      private_class_method :new
+
+      attr_reader :account_id,
+                  :amount,
+                  :currency_code,
+                  :current_status,
+                  :id,
+                  :updated_at
+
+      class << self
+        PLURAL   = 'funds'.freeze
+        SINGULAR = 'fund'.freeze
+
+        def find(code)
+          item = _find(PLURAL, SINGULAR, code)
+          new(item)
+        end
+
+        def all(options = {})
+          items = _all(PLURAL, options)
+          items.map { |item| new(item) }
+        end
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/fund_address.rb

@@ -0,0 +1,39 @@
+module Bitodeme
+  module Resource
+    # FundAddress resource
+    class FundAddress < Base
+      private_class_method :new
+
+      attr_reader :account_id,
+                  :address,
+                  :created_at,
+                  :currency_code,
+                  :current_status,
+                  :fund_id,
+                  :id,
+                  :is_temporary,
+                  :updated_at
+
+      class << self
+        PLURAL   = 'fund_addresses'.freeze
+        SINGULAR = 'fund_address'.freeze
+
+        def find(code)
+          item = _find(PLURAL, SINGULAR, code)
+          new(item)
+        end
+
+        def all(options = {})
+          items = _all(PLURAL, options)
+          items.map { |item| new(item) }
+        end
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/invoice.rb

@@ -0,0 +1,82 @@
+module Bitodeme
+  module Resource
+    # Invoice resource
+    class Invoice < Base
+      private_class_method :new
+
+      attr_reader :account_id,
+                  :address,
+                  :amount,
+                  :created_at,
+                  :currency_code,
+                  :current_status,
+                  :deleted_at,
+                  :description,
+                  :external_id,
+                  :id,
+                  :name,
+                  :original_amount,
+                  :original_currency_code,
+                  :purchasable,
+                  :updated_at
+
+      class << self
+        PLURAL   = 'invoices'.freeze
+        SINGULAR = 'invoice'.freeze
+
+        def build(params)
+          new(params).validate
+        end
+
+        def find(code)
+          item = _find(PLURAL, SINGULAR, code)
+          new(item)
+        end
+
+        def create(invoice)
+          raise_for('invoice', invoice) unless invoice.is_a?(Invoice)
+          item = _create(PLURAL, SINGULAR, invoice: invoice.to_h)
+          new(item)
+        end
+
+        private
+
+        def raise_for(attr, val)
+          raise Bitodeme::ValidationError.new(attr, val)
+        end
+      end
+
+      def validate
+        validate_original_amount
+        validate_original_currency_code
+        validate_external_id
+        validate_purchasable
+        self
+      end
+
+      private
+
+      def validate_original_amount
+        return if /^\d{0,8}(\.\d{1,8})?$/.match?(original_amount.to_s)
+        raise_for('original_amount')
+      end
+
+      def validate_original_currency_code
+        return if /^[a-zA-Z]{3}$/.match?(original_currency_code.to_s)
+        raise_for('original_currency_code')
+      end
+
+      def validate_external_id
+        raise_for('external_id') unless external_id.is_a?(String)
+      end
+
+      def validate_purchasable
+        raise_for('purchasable') unless purchasable.is_a?(Hash)
+      end
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/transaction_log.rb

@@ -0,0 +1,41 @@
+module Bitodeme
+  module Resource
+    # TransactionLog resource
+    class TransactionLog < Base
+      private_class_method :new
+
+      attr_reader :account_id,
+                  :amount,
+                  :created_at,
+                  :currency_code,
+                  :current_status,
+                  :description,
+                  :fund_id,
+                  :id,
+                  :transactable_id,
+                  :transactable_type,
+                  :updated_at
+
+      class << self
+        PLURAL   = 'transaction_logs'.freeze
+        SINGULAR = 'transaction_log'.freeze
+
+        def find(code)
+          item = _find(PLURAL, SINGULAR, code)
+          new(item)
+        end
+
+        def all(options = {})
+          items = _all(PLURAL, options)
+          items.map { |item| new(item) }
+        end
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+    end
+  end
+end

data/lib/bitodeme/resources/withdrawal.rb

@@ -0,0 +1,65 @@
+module Bitodeme
+  module Resource
+    # Withdrawal resource
+    class Withdrawal < Base
+      private_class_method :new
+
+      attr_reader :address,
+                  :amount,
+                  :fund_id,
+                  :otp_value
+
+      class << self
+        PLURAL   = 'withdrawals'.freeze
+        SINGULAR = 'withdrawal'.freeze
+
+        def build(params)
+          new(params).validate
+        end
+
+        def create(withdrawal)
+          raise_for('withdrawal') unless withdrawal.is_a?(Withdrawal)
+          item = _create(PLURAL, SINGULAR, withdrawal: withdrawal.to_h)
+          new(item)
+        end
+
+        private
+
+        def raise_for(attr, val)
+          raise Bitodeme::ValidationError.new(attr, val)
+        end
+      end
+
+      def validate
+        validate_address
+        validate_amount
+        validate_fund_id
+        validate_otp_value
+        self
+      end
+
+      private
+
+      def initialize(params)
+        super(attrs: attrs, params: params)
+      end
+
+      def validate_address
+        raise_for('address') unless address.is_a?(String)
+      end
+
+      # TODO: Validate with UUID format
+      def validate_fund_id
+        raise_for('fund_id') unless fund_id.is_a?(String)
+      end
+
+      def validate_amount
+        raise_for('amount') unless /^\d{0,8}(\.\d{1,8})?$/.match?(amount.to_s)
+      end
+
+      def validate_otp_value
+        raise_for('otp_value') unless /^\d{6}$/.match?(otp_value.to_s)
+      end
+    end
+  end
+end

data/lib/bitodeme/validation_error.rb

@@ -0,0 +1,8 @@
+module Bitodeme
+  # Validation Error
+  class ValidationError < ::StandardError
+    def initialize(attr, val)
+      super("Unacceptable value('#{val}') for '#{attr}'!")
+    end
+  end
+end

data/lib/bitodeme/version.rb

@@ -1,3 +1,3 @@
 module Bitodeme
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/bitodeme.rb

@@ -1,19 +1,19 @@
 require 'json'
 require 'faraday'
 require 'faraday_middleware'
-require 'bitodeme/version'
-require 'bitodeme/error'
-require 'bitodeme/configuration'
-require 'bitodeme/auth'
-require 'bitodeme/conn'
-require 'bitodeme/resources/base'
-require 'bitodeme/resources/currency'
-require 'bitodeme/resources/deposit'
-require 'bitodeme/resources/fund'
-require 'bitodeme/resources/fund_address'
-require 'bitodeme/resources/invoice'
-require 'bitodeme/resources/transaction_log'
-require 'bitodeme/resources/withdrawal'
+require_relative 'bitodeme/version'
+require_relative 'bitodeme/validation_error'
+require_relative 'bitodeme/configuration'
+require_relative 'bitodeme/auth'
+require_relative 'bitodeme/conn'
+require_relative 'bitodeme/resources/base'
+require_relative 'bitodeme/resources/currency'
+require_relative 'bitodeme/resources/deposit'
+require_relative 'bitodeme/resources/fund'
+require_relative 'bitodeme/resources/fund_address'
+require_relative 'bitodeme/resources/invoice'
+require_relative 'bitodeme/resources/transaction_log'
+require_relative 'bitodeme/resources/withdrawal'
 
 # Base module for Bitodome Client
 module Bitodeme

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitodeme
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Bitodeme Integrations Team
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -146,6 +147,18 @@ files:
 - bin/setup
 - bitodeme.gemspec
 - lib/bitodeme.rb
+- lib/bitodeme/auth.rb
+- lib/bitodeme/configuration.rb
+- lib/bitodeme/conn.rb
+- lib/bitodeme/resources/base.rb
+- lib/bitodeme/resources/currency.rb
+- lib/bitodeme/resources/deposit.rb
+- lib/bitodeme/resources/fund.rb
+- lib/bitodeme/resources/fund_address.rb
+- lib/bitodeme/resources/invoice.rb
+- lib/bitodeme/resources/transaction_log.rb
+- lib/bitodeme/resources/withdrawal.rb
+- lib/bitodeme/validation_error.rb
 - lib/bitodeme/version.rb
 homepage: https://github.com/bitodeme-integrations/bitodeme_rb
 licenses: