chankura_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6ec17e84eb2423228db73a189a2046c45940830
+  data.tar.gz: d3e597c3eea88b47f0b94c2433c4edea4fa3bbe9
+SHA512:
+  metadata.gz: c41bd64a72f1fd9afef3f26ed9207279dc86c5f1355e9604091268b02e217ba24b4f44c380941b7fccfcd94b9d98de3d33e6fcf8ce171971e5540e79a681b096
+  data.tar.gz: ed46d09776ef588957465fb138d30cb3180fd94da0390f3b1e8f24956ff0f802904581cfe80939ed30cf3984d863549d9df20913fddd01469d991e8f94ed4d2f

data/README.md

@@ -0,0 +1,73 @@
+# Ruby client for Chankura Exchange API
+
+[![Build Status](https://travis-ci.org/ChankuraExchange/chankura-client-ruby.svg?branch=master)](https://travis-ci.org/ChankuraExchange/chankura-client-ruby)
+[![Code Climate](https://codeclimate.com/github/ChankuraExchange/chankura-client-ruby/badges/gpa.svg)](https://codeclimate.com/github/ChankuraExchange/chankura-client-ruby)
+[![Test Coverage](https://codeclimate.com/github/ChankuraExchange/chankura-client-ruby/badges/coverage.svg)](https://codeclimate.com/github/ChankuraExchange/chankura-client-ruby/coverage)
+
+`chankura-client-ruby` is a client for Chankura Exchange API, support all Chankura Exchange API functions like submit order, get tickers, etc. It's also a reference client implementation, where you can find how to authenticate private Chankura Exchange API.
+
+### Requirements
+
+* ruby 2.0.0 or higher (if you want to run 'rake test' in this gem you'll need ruby 2.1.0 or higher)
+* openssl
+
+### Install
+
+```shell
+$ gem install chankura_client
+```
+
+### Usage
+
+#### Command line tool
+
+TBD
+
+#### REST API client
+
+Use `#get` or `#post` to access API after you created a `ChankuraAPI::Client`:
+
+```ruby
+require 'chankura_client'
+
+# Client can be initialized not providing key and sercet, but this client can only access public APIs
+client_public = ChankuraAPI::Client.new endpoint: 'https://trading.chanura.com'
+
+# GET public api /api/v2/markets
+client_public.get_public '/api/v2/markets'
+
+# To build a full functional client which can access both public/private api, access_key/secret_key
+# are required.
+#
+# If there's no data received in `timeout` seconds, Net::OpenTimeout will be raised. Default to 60.
+#
+client = ChankuraAPI::Client.new access_key: 'your_access_key', secret_key: 'your_secret_key', endpoint: 'https://trading.chankura.com', timeout: 60
+
+# GET private api /api/v2/orders with 'market=btczar'
+client.get '/api/v2/orders', market: 'btczar'
+
+# POST to create an order
+client.post '/api/v2/orders', market: 'btczar', side: 'sell', volume: '0.11', price: '2955.0'
+
+# POST to create multiple orders at once
+client.post '/api/v2/orders/multi', market: 'btczar', orders: [{side: 'buy', volume: '0.15', price: '2955.0'}, {side: 'sell', volume: '0.16', price: '2956'}]
+```
+
+Check [Chankura API v2 Documents](https://trading.chankura.com/documents/api_v2) for details on Chankura API.
+
+### Streaming API client
+
+Streaming API client is built upon eventmachine, it will start an endless loop to accept updates from server side, you only need to provide a callback block:
+
+```ruby
+require 'chankura_client'
+
+client = ChankuraAPI::StreamingClient.new access_key: 'your_access_key', secret_key: 'your_secret_key', endpoint: 'wss://trading.chankura.com:8080'
+client.run do |message|
+  # do whatever you want with message
+end
+```
+
+### How To Contribute
+
+Just create an issue or open a pull request :)

data/lib/chankura_api/auth.rb

@@ -0,0 +1,36 @@
+module ChankuraAPI
+  class Auth
+
+    def initialize(access_key, secret_key)
+      @access_key = access_key
+      @secret_key = secret_key
+    end
+
+    def signed_challenge(challenge)
+      signature = OpenSSL::HMAC.hexdigest 'SHA256', @secret_key, "#{@access_key}#{challenge}"
+      {auth: {access_key: @access_key, answer: signature}}
+    end
+
+    def signed_params(verb, path, params={})
+      params    = format_params params
+      signature = sign verb, path, URI.unescape(params.to_query)
+      params.merge(signature: signature)
+    end
+
+    def sign(verb, path, params)
+      OpenSSL::HMAC.hexdigest 'SHA256', @secret_key, payload(verb, path, params)
+    end
+
+    def payload(verb, path, params)
+      "#{verb.upcase}|#{path}|#{params}"
+    end
+
+    def format_params(params)
+      params = params.symbolize_keys
+      params[:access_key] ||= @access_key
+      params[:tonce]      ||= (Time.now.to_f*1000).to_i
+      params
+    end
+
+  end
+end

data/lib/chankura_api/client.rb

@@ -0,0 +1,79 @@
+require 'json'
+require 'net/http'
+require_relative 'client/version'
+
+module ChankuraAPI
+  class Client
+    attr_reader :auth
+
+    def initialize(options={})
+      options = options.symbolize_keys
+      setup_auth_keys options
+      @endpoint = options[:endpoint] || 'https://trading.chankura.com'
+      @timeout  = options[:timeout]  || 60
+    end
+
+    def get_public(path, params = {})
+      uri = URI("#{@endpoint}#{path}")
+      uri.query = URI.encode_www_form params
+
+      request(:get, path, nil, params) do |http, _|
+        http.request_get(uri.request_uri)
+      end
+    end
+
+    def get(path, params = {})
+      check_auth!
+
+      uri = URI("#{@endpoint}#{path}")
+
+      request(:get, path, @auth, params) do |http, signed_params|
+        uri.query = URI.encode_www_form signed_params
+        http.request_get(uri.request_uri)
+      end
+    end
+
+    def post(path, params = {})
+      check_auth!
+
+      request(:post, path, @auth, params) do |http, signed_params|
+        http.request_post(path, signed_params.to_query)
+      end
+    end
+
+    private
+
+    def request(action, path, auth, params = {})
+      uri = URI("#{@endpoint}#{path}")
+      params = auth.signed_params action.to_s.upcase, path, params if auth
+
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.open_timeout = @timeout
+      http.use_ssl = true if @endpoint.start_with?('https://')
+
+      http.start do |http|
+        parse yield(http, params)
+      end
+    end
+
+    def parse(response)
+      JSON.parse response.body
+    rescue JSON::ParserError
+      { http_error: { code: response.code, body: response.body } }
+    end
+
+    def setup_auth_keys(options)
+      if options[:access_key] && options[:secret_key]
+        @access_key = options[:access_key]
+        @secret_key = options[:secret_key]
+        @auth       = Auth.new @access_key, @secret_key
+      else
+        raise ArgumentError, 'Missing access key and/or secret key'
+      end
+    end
+
+    def check_auth!
+      raise ArgumentError, 'Missing access key and/or secret key' if @auth.nil?
+    end
+  end
+end

data/lib/chankura_api/client/version.rb

@@ -0,0 +1,5 @@
+module ChankuraAPI
+  class Client
+    VERSION = '0.0.1'
+  end
+end

data/lib/chankura_api/config.rb

@@ -0,0 +1,12 @@
+module ChankuraAPI
+  class Config
+
+    def self.get_chankurarc(path)
+      if File.exist? path
+        lines = File.readlines path
+        [ lines[0].strip, lines[1].strip ]
+      end
+    end
+
+  end
+end

data/lib/chankura_api/core_ext.rb

@@ -0,0 +1,2 @@
+require 'chankura_api/core_ext/keys'
+require 'chankura_api/core_ext/to_query'

data/lib/chankura_api/core_ext/keys.rb

@@ -0,0 +1,16 @@
+unless {}.respond_to? :symbolize_keys
+  class Hash
+    def transform_keys
+      return enum_for(:transform_keys) unless block_given?
+      result = self.class.new
+      each_key do |key|
+        result[yield(key)] = self[key]
+      end
+      result
+    end
+
+    def symbolize_keys
+      transform_keys{ |key| key.to_sym rescue key }
+    end
+  end
+end

data/lib/chankura_api/core_ext/to_query.rb

@@ -0,0 +1,60 @@
+unless Object.new.respond_to? :to_query and Object.new.respond_to? :to_param
+
+  require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+
+  class Object
+    def to_param
+      to_s
+    end
+
+    def to_query(key)
+      "#{CGI.escape(key.to_param)}=#{CGI.escape(to_param.to_s)}"
+    end
+  end
+
+  class NilClass
+    def to_param
+      self
+    end
+  end
+
+  class TrueClass
+    def to_param
+      self
+    end
+  end
+
+  class FalseClass
+    def to_param
+      self
+    end
+  end
+
+  class Array
+    def to_param
+      collect(&:to_param).join '/'
+    end
+
+    def to_query(key)
+      prefix = "#{key}[]"
+
+      if empty?
+        nil.to_query(prefix)
+      else
+        collect { |value| value.to_query(prefix) }.join '&'
+      end
+    end
+  end
+
+  class Hash
+    def to_query(namespace = nil)
+      collect do |key, value|
+        unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
+          value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+        end
+      end.compact.sort! * '&'
+    end
+
+    alias_method :to_param, :to_query
+  end
+end

data/lib/chankura_api/streaming_client.rb

@@ -0,0 +1,48 @@
+require 'logger'
+require 'json'
+require 'eventmachine'
+require 'faye/websocket'
+
+module ChankuraAPI
+  class StreamingClient < Client
+    def initialize(options = {})
+      super
+      @endpoint = options[:endpoint] || 'wss://trading.chankura.com:8080'
+      @logger   = options[:logger] || Logger.new(STDOUT)
+    end
+
+    def run(&callback)
+      EM.run do
+        ws = Faye::WebSocket::Client.new(@endpoint)
+
+        ws.on(:open) do |event|
+          @logger.info 'Connected.'
+        end
+
+        ws.on(:message) do |event|
+          msg = JSON.parse(event.data)
+
+          key = msg.keys.first
+          data = msg[key]
+          case key
+          when 'challenge'
+            ws.send JSON.dump(@auth.signed_challenge(data))
+          else
+            begin
+              callback.call msg
+            rescue
+              @logger.error "Failed to process message: #{payload}"
+              @logger.error $!
+            end
+          end
+        end
+
+        ws.on(:close) do |event|
+          @logger.info "Closed. Code: #{event.code}, Reason: #{event.reason || 'none'}"
+          ws = nil
+          EM.stop
+        end
+      end
+    end
+  end
+end

data/lib/chankura_client.rb

@@ -0,0 +1,5 @@
+require_relative 'chankura_api/core_ext'
+require_relative 'chankura_api/config'
+require_relative 'chankura_api/auth'
+require_relative 'chankura_api/client'
+require_relative 'chankura_api/streaming_client'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: chankura_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chankura Exchange
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+description: A ruby client which can access all Chankura Exchange's API.
+email:
+- support@chankura.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/chankura_api/auth.rb
+- lib/chankura_api/client.rb
+- lib/chankura_api/client/version.rb
+- lib/chankura_api/config.rb
+- lib/chankura_api/core_ext.rb
+- lib/chankura_api/core_ext/keys.rb
+- lib/chankura_api/core_ext/to_query.rb
+- lib/chankura_api/streaming_client.rb
+- lib/chankura_client.rb
+homepage: https://github.com/ChankuraExchange/chankura-client-ruby
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A ruby client to access Chankura Exchange's API.
+test_files: []