kucoin-api 0.2.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kucoin/api"
+
+# 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/kucoin-api.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kucoin/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kucoin-api"
+  spec.version       = Kucoin::Api::VERSION
+  spec.authors       = ["Michael Lang"]
+  spec.email         = ["mwlang@cybrains.net"]
+
+  spec.summary       = "Implements Kucoin 2.0 API and Websocket"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/mwlang/kucoin-api"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  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_runtime_dependency 'faraday', '~> 0.15'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.12'
+  spec.add_runtime_dependency 'faye-websocket', '~> 0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.5'
+  spec.add_development_dependency 'simplecov'
+end

data/lib/kucoin/api.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+require 'faye/websocket'
+
+require 'kucoin/api/version'
+require 'kucoin/api/error'
+
+require 'kucoin/api/middleware/auth_request'
+require 'kucoin/api/middleware/nonce_request'
+
+require 'kucoin/api/websocket'
+
+require 'kucoin/api/endpoints'
+
+require 'kucoin/api/rest'
+require 'kucoin/api/rest/connection'
+
+module Kucoin
+  module Api
+    def self.default_key
+      ENV['KUCOIN_API_KEY'].to_s
+    end
+
+    def self.default_secret
+      ENV['KUCOIN_API_SECRET'].to_s
+    end
+
+    def self.default_passphrase
+      ENV['KUCOIN_API_PASSPHRASE'].to_s
+    end
+  end
+end

data/lib/kucoin/api/endpoints.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+Dir[File.expand_path('endpoints/*.rb', File.dirname(__FILE__))].each {|file| require file }
+Dir[File.expand_path('endpoints/*/*.rb', File.dirname(__FILE__))].each {|file| require file }
+
+module Kucoin
+  module Api
+    ENDPOINTS = {
+      user:  {
+        accounts: {
+          index:            '/api/v1/accounts',
+          inner_transfer:   '/api/v1/accounts/inner-transfer',
+          # member
+          show:             '/api/v1/accounts/:account_id',
+          ledgers:          '/api/v1/accounts/:account_id/ledgers',
+          holds:            '/api/v1/accounts/:account_id/holds',
+        },
+        deposits: {
+          create:           '/api/v1/deposit-addresses',
+          index:            '/api/v1/deposits',
+          # member
+          show:             '/api/v1/deposit-addresses?currency=:currency',
+        },
+        withdrawals: {
+          index:            '/api/v1/withdrawals',
+          quotas:           '/api/v1/withdrawals/quotas',
+          # member
+          delete:           '/api/v1/withdrawals/:withdrawal_id',
+        }
+      },
+      trade:  {
+        orders: {
+          index:              '/api/v1/orders',
+          recent:             '/api/v1/limit/orders',
+          # member
+          show:               '/api/v1/orders/:order_id',
+        },
+        fills: {
+          index:              '/api/v1/fills',
+          recent:             '/api/v1/limit/fills',
+        }
+      },
+      markets: {
+        index:                '/api/v1/markets',
+        # member
+        stats:                '/api/v1/market/stats?symbol=:symbol',
+        symbols: {
+          index:              '/api/v1/symbols',
+        },
+        tickers: {
+          # member
+          index:              '/api/v1/market/allTickers',
+          inside:             '/api/v1/market/orderbook/level1?symbol=:symbol',
+        },
+        order_book: {
+          part_aggregated:    '/api/v1/market/orderbook/level2_:depth?symbol=:symbol',
+          full_aggregated:    '/api/v2/market/orderbook/level2?symbol=:symbol',
+          full_atomic:        '/api/v1/market/orderbook/level3?symbol=:symbol',
+        },
+        histories: {
+          trade:              '/api/v1/market/histories?symbol=:symbol',
+          klines:             '/api/v1/market/candles?symbol=:symbol'
+        },
+        currencies: {
+          index:              '/api/v1/currencies',
+          fiat:               '/api/v1/prices',
+          # member
+          show:               '/api/v1/currencies/:currency',
+        }
+      },
+      other: {
+        timestamp:            '/api/v1/timestamp'
+      },
+
+      websocket: {
+        public:                '/api/v1/bullet-public',
+        private:               '/api/v1/bullet-private'
+      }
+    }
+
+    module Endpoints
+      def self.get_klass name, parent=nil
+        Object.const_get("#{parent || 'Kucoin::Api::Endpoints'}::#{name.to_s.split('_').map(&:capitalize).join}")
+      end
+
+      def self.endpoint_method client_klass, name, result, parent_var = nil
+        child_endpoint_klass = Endpoints.get_klass(name, (parent_var && parent_var.class))
+
+        if parent_var
+          parent_var.define_singleton_method name do
+            endpoint_var = "@#{name}"
+            var = instance_variable_get(endpoint_var) || instance_variable_set(endpoint_var, child_endpoint_klass.new(parent_var.client))
+            client_klass.generate_endpoint_methods result: result, parent_var: var
+            var
+          end
+        else
+          client_klass.class_exec do
+            define_method name do
+              endpoint_var = "@#{name}"
+              var = instance_variable_get(endpoint_var) || instance_variable_set(endpoint_var, child_endpoint_klass.new(self))
+              client_klass.generate_endpoint_methods result: result, parent_var: var
+              var
+            end
+          end
+        end
+      end
+
+      def generate_endpoint_methods result: ENDPOINTS, parent_var: nil
+        result.each do |endpoint_name, _result|
+          if _result.is_a?(Hash)
+            Kucoin::Api::Endpoints.endpoint_method(self, endpoint_name, _result, parent_var)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/base.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Base
+        attr_reader :client
+        def initialize client
+          @client = client
+        end
+
+        def open
+          client.open(self)
+        end
+
+        def auth
+          client.auth(self)
+        end
+
+        def path
+          self.class.name
+            .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .tr('-', '_')
+            .downcase.split('::')[3..-1].join('::')
+        end
+
+        def url action
+          path_array = path.split('::').map(&:to_sym)
+          path_array.reduce(Kucoin::Api::ENDPOINTS) { |m, k| m.fetch(k, {}) }[action]
+        end
+
+        def assert_required_param options, param, valid_values=nil
+          raise Kucoin::Api::MissingParamError.new("#{param} is required") unless options.has_key?(param)
+          assert_param_is_one_of options, param, valid_values if valid_values
+        end
+
+        def assert_param_is_one_of options, param, valid_values
+          return if valid_values.include? options[param].to_s
+          raise Kucoin::Api::InvalidParamError.new("#{param} must be one of #{valid_values.inspect}")
+        end
+
+        private
+
+        def side_types
+          %w(buy sell)
+        end
+
+        def order_types
+          %w(limit market)
+        end
+
+        def account_types
+          %w(main trade)
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets < Base
+        def index
+          open.ku_request :get, :index
+        end
+        alias all index
+
+        def stats symbol
+          open.ku_request :get, :stats, symbol: symbol
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets/currencies.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets
+        class Currencies < Markets
+          def index options={}
+            open.ku_request :get, :index, options
+          end
+          alias all index
+
+          def fiat options= {}
+            open.ku_request :get, :fiat, options
+          end
+
+          def show currency
+            open.ku_request :get, :show, currency: currency
+          end
+          alias detail show
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets/histories.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets
+        class Histories < Markets
+          def trade symbol
+            open.ku_request :get, :trade, symbol: symbol
+          end
+
+          def klines symbol, type, options={}
+            open.ku_request :get, :klines, symbol: symbol, type: type, **options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets/order_book.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets
+        class OrderBook < Markets
+          def part symbol, depth
+            options = { symbol: symbol, depth: depth }
+            assert_required_param options, :depth, depth_types
+            open.ku_request :get, :part_aggregated, **options
+          end
+
+          def full_aggregated symbol
+            open.ku_request :get, :full_aggregated, symbol: symbol
+          end
+
+          def full_atomic symbol
+            open.ku_request :get, :full_atomic, symbol: symbol
+          end
+
+          private
+
+          def depth_types
+            %w(20 100)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets/symbols.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets
+        class Symbols < Markets
+          def index options={}
+            open.ku_request :get, :index, **options
+          end
+          alias all index
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/markets/tickers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Markets
+        class Tickers < Markets
+          def index
+            open.ku_request :get, :index
+          end
+          alias all index
+
+          def inside symbol
+            open.ku_request :get, :inside, symbol: symbol
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/other.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Other < Base
+        def timestamp
+          auth.ku_request :get, :timestamp
+        end
+      end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/trade.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Trade < Base; end
+    end
+  end
+end

data/lib/kucoin/api/endpoints/trade/fills.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module Kucoin
+  module Api
+    module Endpoints
+      class Trade
+        class Fills < Trade
+          def index options={}
+            auth.ku_request :get, :index, **options
+          end
+          alias all index
+          alias list index
+
+          def recent
+            auth.ku_request :get, :recent
+          end
+        end
+      end
+    end
+  end
+end