okcoin-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3a40254d50dbd3cceed2b4eb4e37e0dc105d595
-  data.tar.gz: 99c7d16ea936763db7e4a81471de342f1f19a726
+  metadata.gz: 29b9ddcb048174c66dfe139614dad5cc16a579cd
+  data.tar.gz: d2f1dd779b0b1e8b8df576d922175e2a303a85ed
 SHA512:
-  metadata.gz: 6ee3e7d4e30365e327fd601919bb4345172358e083667787a67086866d7657b638f5bf569f194e5fbfeb7b061807f7ce9ce1df0d49d662922eb334030dea0cac
-  data.tar.gz: b1d7580c47604d113507c1178ff3183b889b054cfc3db3f9f49b1aedf71d6415cc20b0d01b688e5e45e8e10ad094a8eadea8b44eeb979e1fcedddc5ab67f519d
+  metadata.gz: ffc68b948ae4045634288d77331033b2d716a23962cff020e13f689ccb3a287738450b592f17ce65687719ac55cfaa1faf2615eca4ac314e2e147c318041c3c9
+  data.tar.gz: db614e11a9aade87684733d50e991152567d1b87fb63e788637f6fe31e12e434d0998c28376182c932543379852aeba6380bc1456bc1a04c0e68a633124af2af

data/README.md

@@ -3,23 +3,33 @@ Supports REST and Websocket protocols
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add these gems into your Gemfile:
 
 ```ruby
 gem 'okcoin-ruby'
+gem 'celluloid-websocket-client',  :github => 'ilyacherevkov/celluloid-websocket-client'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install okcoin-ruby
+### 1. REST Example
+```
+okcoin = Okcoin::Rest.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN_SECRET']
+puts okcoin.user_info
+```
 
-## Usage
+### 2. WebSocket Example
 
-Use it with REST and Websocket protocols
+```
+  okcoin = Okcoin::WS.new api_key: ENV['OKCOIN_APIKEY'], secret_key: ENV['OKCOIN_SECRET']
+  okcoin.userinfo
+  sleep 10
+  okcoin.close
+``` 
 
 ## Contributing
 

data/lib/okcoin-ruby.rb

@@ -0,0 +1,4 @@
+require 'curb'
+require 'celluloid/websocket/client'
+require 'okcoin/rest'
+require 'okcoin/ws'

data/lib/okcoin/rest.rb

@@ -1,5 +1,4 @@
-module Okcoin
-  class Rest
+class Okcoin::Rest
   BASE_URI = "https://www.okcoin.com/api"
   TIMEOUT = 0.5
 
@@ -116,6 +115,4 @@ module Okcoin
         query ? JSON.parse(Curl.get(BASE_URI + url, query).body_str) : JSON.parse(Curl.get(BASE_URI + url).body_str)
       end
     end
-  end
-  
 end

data/lib/okcoin/version.rb

@@ -1,3 +1,3 @@
-module Okcoin
-  VERSION = "0.0.2"
+class Okcoin
+  VERSION = "0.0.3"
 end

data/lib/okcoin/ws.rb

@@ -0,0 +1,74 @@
+class Okcoin::WS
+  include Celluloid
+  BASE_URI = 'wss://real.okcoin.com:10440/websocket/okcoinapi'
+
+  def initialize(api_key: nil, secret_key: nil)
+    @driver = Celluloid::WebSocket::Client.new(BASE_URI, Celluloid::Actor.current)
+    @api_key = api_key
+    @secret_key = secret_key
+  end
+
+  public 
+    # When WebSocket is opened, register callbacks
+    def on_open
+     puts "Websocket connection to #{BASE_URI} established succesfully"
+    end
+
+    # When raw WebSocket message is received
+    def on_message(msg)
+      puts "Message received: #{msg}"
+    end
+
+    # When WebSocket is closed
+    def on_close(code, reason)
+      puts "WebSocket connection closed: #{code.inspect}, #{reason.inspect}"
+      @driver.terminate
+      terminate
+    end
+
+    # close WebSocket connection
+    def close
+      @driver.close
+    end
+
+    def pingpong
+      every(5){ @driver.text "{'event':'ping'}" }
+    end
+
+    def userinfo
+      post_data = initial_post_data
+      emit(event: 'addChannel', channel: 'ok_spotusd_userinfo', post_data: post_data)
+    end
+
+    def futures_userinfo
+      post_data = initial_post_data
+      emit(event: 'addChannel', channel: 'ok_futureusd_userinfo', post_data: post_data)
+    end
+
+    def price_api(data)
+      @driver.text data
+    end
+
+  private
+
+    def initial_post_data
+      post_data = {}
+      post_data['api_key'] = @api_key
+      post_data
+    end
+
+    def sign(post_data:)
+      params_string = post_data.sort.collect{|k, v| "#{k}=#{v}"} * '&'
+      hashed_string = params_string + "&secret_key=#{@secret_key}"
+      signature = OpenSSL::Digest.new('md5', hashed_string).to_s.upcase
+      post_data['sign'] = signature
+      post_data = post_data.sort
+      post_data.collect! { |item| "'#{item[0]}':'#{item[1]}'" }
+      post_data = post_data.join(",")
+    end
+
+    def emit(event:, channel:, post_data: nil)
+      post_data = sign(post_data: post_data)
+      @driver.text  "{'event':'#{event}', 'channel':'#{channel}', 'parameters': {#{post_data}}}"
+    end
+end

data/okcoin-ruby.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Okcoin::VERSION
   spec.authors       = ["Ilya Cherevkov"]
   spec.email         = ["icherevkov@gmail.com"]
-  spec.summary       = %q{Simple Okcoin REST and Websocket API wrapper.}
-  spec.description   = %q{Okcoin Ruby REST and Websockets API wrapper. REST is handled with Curb and Websocket with CelluloidIO}
+  spec.summary       = %q{A ruby library for okcoin.com}
+  spec.description   = %q{A ruby library for okcoin.com}
   spec.homepage      = "https://github.com/ilyacherevkov/okcoin-ruby"
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcoin-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ilya Cherevkov
@@ -66,8 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Okcoin Ruby REST and Websockets API wrapper. REST is handled with Curb
-  and Websocket with CelluloidIO
+description: A ruby library for okcoin.com
 email:
 - icherevkov@gmail.com
 executables: []
@@ -79,10 +78,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/okcoin.rb
+- lib/okcoin-ruby.rb
 - lib/okcoin/rest.rb
 - lib/okcoin/version.rb
-- lib/okcoin/websocket.rb
+- lib/okcoin/ws.rb
 - okcoin-ruby.gemspec
 homepage: https://github.com/ilyacherevkov/okcoin-ruby
 licenses:
@@ -107,5 +106,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Simple Okcoin REST and Websocket API wrapper.
+summary: A ruby library for okcoin.com
 test_files: []

data/lib/okcoin.rb

@@ -1,9 +0,0 @@
-require 'curb'
-require 'celluloid-websocket-client'
-require 'okcoin/version'
-require 'okcoin/rest'
-require 'okcoin/websocket'
-
-module Okcoin
-
-end

data/lib/okcoin/websocket.rb

@@ -1,76 +0,0 @@
-module Okcoin
-  class Websocket
-    include Celluloid
-    BASE_URI = 'wss://real.okcoin.com:10440/websocket/okcoinapi'
-
-    def initialize(api_key: nil, secret_key: nil)
-      @driver = Celluloid::WebSocket::Client.new(URL, Celluloid::Actor.current)
-      @api_key = api_key
-      @secret_key = secret_key
-    end
-
-    # When WebSocket is opened, register callbacks
-    def on_open
-     puts "Websocket connection to #{BASE_URI} established succesfully"
-    end
-
-    # When raw WebSocket message is received
-    def on_message(msg)
-      puts "Message received: #{msg}"
-    end
-
-    # When WebSocket is closed
-    def on_close(code, reason)
-      puts "WebSocket connection closed: #{code.inspect}, #{reason.inspect}"
-      @driver.terminate
-      terminate
-    end
-
-    # close WebSocket connection
-    def close
-      @driver.close
-    end
-
-    def pingpong
-      every(5){ @driver.text "{'event':'ping'}" }
-    end
-
-    def userinfo
-      post_data = initial_post_data
-      emit(event: 'addChannel', channel: 'ok_spotusd_userinfo', post_data: post_data)
-    end
-
-    def futures_userinfo
-      post_data = initial_post_data
-      emit(event: 'addChannel', channel: 'ok_futureusd_userinfo', post_data: post_data)
-    end
-
-    def price_api(data)
-      @driver.text data
-    end
-
-    private
-
-      def initial_post_data
-        post_data = {}
-        post_data['api_key'] = @api_key
-        post_data
-      end
-
-      def sign(post_data:)
-        params_string = post_data.sort.collect{|k, v| "#{k}=#{v}"} * '&'
-        hashed_string = params_string + "&secret_key=#{@secret_key}"
-        signature = OpenSSL::Digest.new('md5', hashed_string).to_s.upcase
-        post_data['sign'] = signature
-        post_data = post_data.sort
-        post_data.collect! { |item| "'#{item[0]}':'#{item[1]}'" }
-        post_data = post_data.join(",")
-      end
-
-      def emit(event:, channel:, post_data: nil)
-        post_data = sign(post_data: post_data)
-        @driver.text  "{'event':'#{event}', 'channel':'#{channel}', 'parameters': {#{post_data}}}"
-      end
-
-  end
-end