coin_falcon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e8327a393ac7ccbb94118375d6e8705901e42566c00b1c9bef4d27f7d98c5a
-  data.tar.gz: 15c7875175f2655614002a8818d32a22a0fa75968c778b6ab1908c8d4081492d
+  metadata.gz: 3cf549899440b504ac92dd7c53b25356ccc07443e21e424e685a56e2bf31a791
+  data.tar.gz: b1506d575d9dfce685b9dbf0fa7ec1841962e04a908abb6c3263875cd33c8b7e
 SHA512:
-  metadata.gz: 981d0ab1d37b4fef79a1021def4d1954a35688b6f16301f1dfda9acfe3d7a7c763a6e632b686b886479c31c073c2cd8fc52d06bc72c11ea83ddff62779beb80f
-  data.tar.gz: a1cfb3d7483ccefe0547fbef2e3dafa6d15ebe5d820a66b68b287bd9f162011c51a0bbf1a8b318f2cd8b5ed934afa657087672d28473d821f81df70b5ff5f73f
+  metadata.gz: 7d3222b7e5561a48a760d08ea22a1b8f7cb285b769abb2d5c5cdfe4a698e89b173957fcd9b762f44ed6e02036479cce263018443cc1855e04aa0b25c51d4318a
+  data.tar.gz: 51ecc3d86a2bcb7ebd613331a6fddcc6352d541c599ce3488b9a962e8bad2a75a6d8c96cc4b952a09058866acb10887d34f6c51d4366fcf5e26afd8805cef042

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    coin_falcon (0.0.1)
+    coin_falcon (0.0.2)
+      faye-websocket
 
 GEM
   remote: https://rubygems.org/
@@ -9,6 +10,10 @@ GEM
     byebug (10.0.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    eventmachine (1.2.5)
+    faye-websocket (0.10.7)
+      eventmachine (>= 0.12.0)
+      websocket-driver (>= 0.5.1)
     method_source (0.9.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
@@ -30,6 +35,9 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-The library needs to be configured with your account's `key` and `secret` which is available in your CoinFalcon Dashboard:
+The client needs to be configured with your account's `key` and `secret` which is available in your CoinFalcon Dashboard:
+
+## API Client
 
 ```ruby
 require 'coin_falcon'
@@ -31,15 +33,13 @@ 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'
+ENDPOINT = 'https://coinfalcon.com'
 VERSION = 1
 ```
 
@@ -72,7 +72,7 @@ client.my_orders
 ### List trades
 
 ```ruby
-client.my_trades
+client.my_trades(market: 'ETH-BTC')
 ```
 
 ### Deposit address
@@ -130,6 +130,44 @@ client.orderbook('ETH-BTC')
 client.orderbook('ETH-BTC', level: 3)
 ```
 
+## Websocket Client
+
+```ruby
+require 'coin_falcon'
+
+websocket_client = CoinFalcon::WebsocketClient.new(key, secret)
+```
+
+It is also possible to set up an `endpoint`:
+
+```ruby
+websocket_client = CoinFalcon::WebsocketClient.new(key, secret, endpoint)
+```
+
+Defaults:
+
+```ruby
+ENDPOINT = 'wss://ws.coinfalcon.com'
+```
+
+### Set up channels
+
+```ruby
+websocket_client.channels << { channel: 'TickerChannel' } << { channel: 'OrderbookChannel', market: 'ETH-BTC' }
+```
+
+### Run feed
+
+```ruby
+websocket_client.feed
+```
+
+It is also possible to send a block
+
+```ruby
+websocket_client.feed { |msg| puts msg }
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/thetonyrom/coin_falcon

data/coin_falcon.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'faye-websocket'
+
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/coin_falcon/client.rb

@@ -2,7 +2,7 @@ module CoinFalcon
   # Client executes requests against the CoinFalcon API.
   #
   class Client
-    ENDPOINT = 'https://staging.coinfalcon.com'.freeze
+    ENDPOINT = 'https://coinfalcon.com'.freeze
     VERSION = 1
 
     def initialize(key, secret, endpoint = ENDPOINT, version = VERSION)

data/lib/coin_falcon/version.rb

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

data/lib/coin_falcon/websocket_client.rb

@@ -0,0 +1,62 @@
+module CoinFalcon
+  class WebsocketClient
+    ENDPOINT = 'wss://ws.coinfalcon.com'.freeze
+    AUTH_PATH = '/auth/feed'.freeze
+
+    attr_accessor :channels
+
+    def initialize(key = nil, secret = nil, endpoint = ENDPOINT)
+      @endpoint = endpoint
+      @channels = []
+      @cipher = Cipher.new(key, secret)
+    end
+
+    def feed
+      EM.run do
+        @ws = Faye::WebSocket::Client.new(@endpoint, nil, { headers: headers })
+
+        @ws.on :open do |event|
+          channels.each { |channel| subscribe(channel) }
+        end
+
+        @ws.on :message do |event|
+          data = JSON.parse(event.data)
+
+          if block_given?
+            yield data
+          else
+            p [:message, data]
+          end
+        end
+
+        @ws.on :close do |event|
+          p [:close, event.code, event.reason]
+          @ws = nil
+          EM.stop
+        end
+      end
+    end
+
+    def subscribe(identifier)
+      request = { command: :subscribe, identifier: identifier.to_json }.to_json
+
+      @ws.send(request)
+    end
+
+    private
+
+    def request
+      @request ||= Request.new(:get, AUTH_PATH, nil)
+    end
+
+    def headers
+      @cipher.sign!(request)
+
+      {
+        'CF-API-KEY' => request['CF-API-KEY'],
+        'CF-API-TIMESTAMP' => request['CF-API-TIMESTAMP'],
+        'CF-API-SIGNATURE' => request['CF-API-SIGNATURE']
+      }
+    end
+  end
+end

data/lib/coin_falcon.rb

@@ -2,12 +2,17 @@ require 'net/http'
 require 'openssl'
 require 'json'
 
+require 'faye/websocket'
+require 'eventmachine'
+
 require 'coin_falcon/cipher'
 require 'coin_falcon/client'
 require 'coin_falcon/connection'
 require 'coin_falcon/request'
 require 'coin_falcon/response'
 
+require 'coin_falcon/websocket_client'
+
 require 'coin_falcon/version'
 
 module CoinFalcon

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: coin_falcon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tony Rom
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-03-21 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - lib/coin_falcon/request.rb
 - lib/coin_falcon/response.rb
 - lib/coin_falcon/version.rb
+- lib/coin_falcon/websocket_client.rb
 homepage: https://github.com/thetonyrom/coin_falcon
 licenses:
 - MIT