coin_falcon 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570c78fd30472cbfec2fd585eb64deacd8e305e66082d2cf1ac0692415521830
-  data.tar.gz: 1e7cf3facbd7b72c0c5a6212755aab5fd5534b25369c0ef097c62e3e5e64e66d
+  metadata.gz: c8e8327a393ac7ccbb94118375d6e8705901e42566c00b1c9bef4d27f7d98c5a
+  data.tar.gz: 15c7875175f2655614002a8818d32a22a0fa75968c778b6ab1908c8d4081492d
 SHA512:
-  metadata.gz: a52f9f79a3620bb450010fa991e9ec85005228c53bcbd3043a3f9e4143290eaa14c2dbaf1e02a58d830b7c64f7c7f6dc3da455982ce6ec83dbb0a0f54cad3ce2
-  data.tar.gz: e603e184d54bab783f57b854b94b879c88d66f3d399b94dc61b3b39d24564da7d025f3df92b49886a2bc312f33fcb3fc9dd574dae98c37c642bb911e2f9005d0
+  metadata.gz: 981d0ab1d37b4fef79a1021def4d1954a35688b6f16301f1dfda9acfe3d7a7c763a6e632b686b886479c31c073c2cd8fc52d06bc72c11ea83ddff62779beb80f
+  data.tar.gz: a1cfb3d7483ccefe0547fbef2e3dafa6d15ebe5d820a66b68b287bd9f162011c51a0bbf1a8b318f2cd8b5ed934afa657087672d28473d821f81df70b5ff5f73f

data/Gemfile.lock

@@ -1,12 +1,21 @@
 PATH
   remote: .
   specs:
-    coin_falcon (0.0.0)
+    coin_falcon (0.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    byebug (10.0.0)
+    coderay (1.1.2)
     diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -28,6 +37,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   coin_falcon!
+  pry-byebug
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/README.md

@@ -1,3 +1,139 @@
 # CoinFalcon Ruby Library
 
 The CoinFalcon Ruby Library provides convenient access to the CoinFalcon API from applications written in the Ruby language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'coin_falcon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coin_falcon
+
+## Usage
+
+The library needs to be configured with your account's `key` and `secret` which is available in your CoinFalcon Dashboard:
+
+```ruby
+require 'coin_falcon'
+
+client = CoinFalcon::Client.new(key, secret)
+```
+
+It is also possible to set up an API `endpoint` and `version`:
+
+```ruby
+require 'coin_falcon'
+
+client = CoinFalcon::Client.new(key, secret, endpoint, version)
+```
+
+Defaults:
+
+```ruby
+ENDPOINT = 'https://staging.coinfalcon.com'
+VERSION = 1
+```
+
+### Accounts
+
+Get a list of your trading accounts.
+
+```ruby
+client.accounts
+```
+
+### Create order
+
+```ruby
+client.create_order(market: 'ETH-BTC', operation_type: :limit_order, order_type: :buy, size: 1, price: 0.01)
+```
+
+### Cancel order
+
+```ruby
+client.cancel_order(order_id)
+```
+
+### List orders
+
+```ruby
+client.my_orders
+```
+
+### List trades
+
+```ruby
+client.my_trades
+```
+
+### Deposit address
+
+```ruby
+client.deposit_address('btc')
+```
+
+### Deposit history
+
+```ruby
+client.deposit_history
+```
+
+### Deposit details
+
+```ruby
+client.deposit_details(deposit_id)
+```
+
+### Create withdrawal
+
+```ruby
+client.create_withdrawal(currency: :btc, address: 'your_address_here', amount: 0.1)
+```
+
+### Withdrawal details
+
+```ruby
+client.withdrawal_details(withdrawal_id)
+```
+
+### Withdrawal history
+
+```ruby
+client.withdrawal_history(params)
+```
+
+### Cancel withdrawal
+
+```ruby
+client.cancel_withdrawal(withdrawal_id)
+```
+
+### List market's trades
+
+```ruby
+client.trades('ETH-BTC')
+```
+
+### List orderbook
+
+```ruby
+client.orderbook('ETH-BTC')
+client.orderbook('ETH-BTC', level: 3)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thetonyrom/coin_falcon
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/coin_falcon.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'pry-byebug'
 end

data/lib/coin_falcon/cipher.rb

@@ -0,0 +1,45 @@
+module CoinFalcon
+  class Cipher
+    ALGORITHM = 'SHA256'.freeze
+
+    KEY_HEADER  = 'CF-API-KEY'.freeze
+    TIME_HEADER = 'CF-API-TIMESTAMP'.freeze
+    SIGN_HEADER = 'CF-API-SIGNATURE'.freeze
+
+    def initialize(key, secret)
+      @key = key
+      @secret = secret
+    end
+
+    def sign!(request)
+      headers(request.to_a).each do |header, value|
+        request[header] = value
+      end
+    end
+
+    private
+
+    attr_reader :key, :secret
+
+    def headers(attrs)
+      timestamp = Time.now.to_i
+
+      {
+        KEY_HEADER => key,
+        TIME_HEADER => timestamp,
+        SIGN_HEADER => encode(timestamp, attrs),
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def encode(timestamp, attrs)
+      payload = build_payload(timestamp, attrs)
+
+      OpenSSL::HMAC.hexdigest(ALGORITHM, secret, payload)
+    end
+
+    def build_payload(timestamp, attrs)
+      [timestamp, *attrs].compact.join('|')
+    end
+  end
+end

data/lib/coin_falcon/client.rb

@@ -2,71 +2,99 @@ module CoinFalcon
   # Client executes requests against the CoinFalcon API.
   #
   class Client
-    KEY_HEADER  = 'CF-API-KEY'.freeze
-    TIME_HEADER = 'CF-API-TIMESTAMP'.freeze
-    SIGN_HEADER = 'CF-API-SIGNATURE'.freeze
+    ENDPOINT = 'https://staging.coinfalcon.com'.freeze
+    VERSION = 1
 
-    attr_reader :api_key, :api_secret
+    def initialize(key, secret, endpoint = ENDPOINT, version = VERSION)
+      @conn = Connection.new(key, secret, endpoint, version)
+    end
+
+    def accounts
+      path = 'user/accounts'
 
-    def initialize(api_key, api_secret)
-      @api_key = api_key
-      @api_secret = api_secret
+      conn.get(path)
     end
 
-    def orderbook(market)
-      url = build_url("markets/#{market}/orders")
+    def create_order(order)
+      path = 'user/orders'
 
-      response = get(url)
+      conn.post(path, order)
+    end
+
+    def cancel_order(id)
+      path = "user/orders/#{id}"
 
-      JSON.parse(response.body)
+      conn.delete(path)
     end
 
-    def accounts
-      url = build_url('user/accounts')
+    def my_orders(params = nil)
+      path = 'user/orders'
 
-      response = get(url)
+      conn.get(path, params)
+    end
+
+    def my_trades(params = nil)
+      path = 'user/trades'
 
-      JSON.parse(response.body)
+      conn.get(path, params)
     end
 
-    private
+    def deposit_address(currency)
+      path = 'account/deposit_address'
 
-    def build_url(path)
-      URI(CoinFalcon.api_base + path)
+      conn.get(path, { currency: currency })
     end
 
-    def headers(method, path, body = nil)
-      timestamp = Time.now.to_i
+    def deposit_history(params = nil)
+      path = 'account/deposits'
 
-      {
-        KEY_HEADER => api_key,
-        TIME_HEADER => timestamp,
-        SIGN_HEADER => sign(timestamp, method, path, body),
-        'Content-Type' => 'application/json'
-      }
+      conn.get(path, params)
     end
 
-    def sign(timestamp, method, path, body)
-      payload = build_payload(timestamp, method, path, body)
+    def deposit_details(id)
+      path = 'account/deposit'
 
-      OpenSSL::HMAC.hexdigest('sha256', api_secret, payload)
+      conn.get(path, { id: id })
     end
 
-    def build_payload(timestamp, method, path, body)
-      [timestamp, method, path, body].compact.join('|')
+    def create_withdrawal(params)
+      path = 'account/withdraw'
+
+      conn.post(path, params)
     end
 
-    def get(url)
-      request = Net::HTTP::Get.new(url)
+    def withdrawal_details(id)
+      path = 'account/withdrawal'
 
-      headers('GET', url.path).each do |header, value|
-        request[header] = value
-      end
+      conn.get(path, { id: id })
+    end
 
-      http = Net::HTTP.new(url.hostname, url.port)
-      http.use_ssl = true
+    def withdrawal_history(params = nil)
+      path = 'account/withdrawals'
 
-      http.request(request)
+      conn.get(path, params)
     end
+
+    def cancel_withdrawal(id)
+      path = "account/withdrawals/#{id}"
+
+      conn.delete(path)
+    end
+
+    def trades(market, params = nil)
+      path = "markets/#{market}/trades"
+
+      conn.get(path, params)
+    end
+
+    def orderbook(market, params = nil)
+      path = "markets/#{market}/orders"
+
+      conn.get(path, params)
+    end
+
+    private
+
+    attr_reader :conn
   end
 end

data/lib/coin_falcon/connection.rb

@@ -0,0 +1,44 @@
+module CoinFalcon
+  class Connection
+    def initialize(key, secret, endpoint, version)
+      @cipher = Cipher.new(key, secret)
+      @http = initialize_http(endpoint)
+      @version = version
+    end
+
+    def get(path, params = nil)
+      request :get, path, params
+    end
+
+    def post(path, params)
+      request :post, path, params
+    end
+
+    def delete(path, params = {})
+      request :delete, path, params
+    end
+
+    private
+
+    attr_reader :cipher, :http, :version
+
+    def initialize_http(endpoint)
+      uri = URI.parse(endpoint)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      http
+    end
+
+    def request(method, path, params)
+      request = Request.new(method, api(path), params)
+      cipher.sign!(request)
+
+      Response.new(http.request(request))
+    end
+
+    def api(path)
+      "/api/v#{version}/#{path}"
+    end
+  end
+end

data/lib/coin_falcon/request.rb

@@ -0,0 +1,47 @@
+module CoinFalcon
+  class Request
+    VERBS = {
+      :get => Net::HTTP::Get,
+      :post => Net::HTTP::Post,
+      :delete => Net::HTTP::Delete
+    }
+
+    def initialize(method, path, params)
+      case method
+      when :get
+        full_path = encode_path_params(path, params)
+        @request = VERBS[method].new(full_path)
+      else
+        @request = VERBS[method].new(path)
+        @request.body = params.to_json
+      end
+    end
+
+    def to_a
+      [verb, path, body]
+    end
+
+    def method_missing(method, *args)
+      if request.respond_to?(method)
+        request.send(method, *args)
+      else
+        super
+      end
+    end
+
+    private
+
+    attr_reader :request
+
+    def verb
+      request.method
+    end
+
+    def encode_path_params(path, params)
+      return path unless params
+
+      encoded = URI.encode_www_form(params)
+      [path, encoded].join('?')
+    end
+  end
+end

data/lib/coin_falcon/response.rb

@@ -0,0 +1,12 @@
+module CoinFalcon
+  class Response
+    attr_reader :code, :body
+
+    def initialize(response)
+      @code = response.code.to_i
+      @body = JSON.parse(response.body)
+    rescue JSON::ParserError
+      @body = response.body
+    end
+  end
+end

data/lib/coin_falcon/version.rb

@@ -1,3 +1,3 @@
 module CoinFalcon
-  VERSION = '0.0.0'.freeze
+  VERSION = '0.0.1'.freeze
 end

data/lib/coin_falcon.rb

@@ -1,15 +1,14 @@
 require 'net/http'
-require 'json'
 require 'openssl'
+require 'json'
 
+require 'coin_falcon/cipher'
 require 'coin_falcon/client'
+require 'coin_falcon/connection'
+require 'coin_falcon/request'
+require 'coin_falcon/response'
 
 require 'coin_falcon/version'
 
 module CoinFalcon
-  @api_base = 'https://staging.coinfalcon.com/api/v1/'
-
-  class << self
-    attr_accessor :api_base
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coin_falcon
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Tony Rom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-08 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - thetonyrom@gmail.com
@@ -71,7 +85,11 @@ files:
 - bin/setup
 - coin_falcon.gemspec
 - lib/coin_falcon.rb
+- lib/coin_falcon/cipher.rb
 - lib/coin_falcon/client.rb
+- lib/coin_falcon/connection.rb
+- lib/coin_falcon/request.rb
+- lib/coin_falcon/response.rb
 - lib/coin_falcon/version.rb
 homepage: https://github.com/thetonyrom/coin_falcon
 licenses: