cf-trade-client 0.1.9 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e90e17269fa8e89671639959552dff79f388e655
+  data.tar.gz: 87f02f75a2485d8595e8fb6ab862c34179c34b46
+SHA512:
+  metadata.gz: 2928593e151240c5d61b8b80769ba326de82cf826304006ddbcf2859fccb0f5e23b5f94d97665070cbad5cd852c6c8aac0b7ecb00dad5df4fb61e0cd84b4326a
+  data.tar.gz: b31e3bbaf441ac1b2fa2c523f4c31c33e4ea8ef261d898d1d3b985122ab23d01e3d44387d04005e22099d59eb1e4d92d7815459df115f560583721c9f6c9cf4c

data/lib/client/client.rb

@@ -1,86 +1,71 @@
-=begin
-Copyright 2014 Coinfloor LTD.
+require "faye/websocket"
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-=end
-require 'faye/websocket'
 module Coinfloor
   class CFClient
-    def initialize(domain,uid,pass,api_key=nil,pkey=nil)
-      if domain.include?("ws://")||domain.include?("wss://")
-        @messages=[]
-        if uid==0
-          @con=CFAcon.new(uid,pass)
+    def initialize(domain, uid, pass, api_key = nil, pkey = nil)
+      if domain.include?("ws://") || domain.include?("wss://")
+        @messages = []
+        if uid == 0
+          @con = CFAcon.new(uid, pass)
         else
           if api_key.nil?
             abort("An API key is required")
           elsif pkey
-            @con=CFcon.new(uid,pass,api_key,pkey)
+            @con = CFcon.new(uid, pass, api_key, pkey)
           else
-            @con=CFcon.new(uid,pass,api_key)
+            @con = CFcon.new(uid, pass, api_key)
           end
         end
-        @domain=domain
+        @domain = domain
       else
         puts "domain must be a ws:// or wss:// formatted string, if port is not 80 it must be specified"
       end
-      
     end
-    def auth(ws,msg)
+
+    def auth(ws, msg)
       @messages.push(:auth)
-      nonce=msg["nonce"]
-      result=@con.auth(nonce)
+      nonce = msg["nonce"]
+      result = @con.auth(nonce)
       ws.send(result)
     end
-    
+
     def begin_connection(sendata)
       puts "begining connection"
-      output=nil
+      output = nil
       EM.run {
         ws = Faye::WebSocket::Client.new(@domain)
         ws.on :open do |event|
         end
-        
+
         ws.on :message do |event|
-          puts "message from server"
-          evtdata=event.data
-          msg=JSON.parse(evtdata)
+          evtdata = event.data
+          msg = JSON.parse(evtdata)
           puts msg
-          if msg["notice"]&&msg["notice"]=="Welcome"
-            auth(ws,msg)
+          if msg["notice"] && msg["notice"] == "Welcome"
+            auth(ws, msg)
           elsif msg["notice"].nil?
-            ret_msg=@messages.delete_at(0)
+            ret_msg = @messages.delete_at(0)
             case ret_msg
             when nil
               ws.close
-              ws=nil
+              ws = nil
               EM.stop
             when :auth
-              if msg["error_code"]==0
+              if msg["error_code"] == 0
                 @messages.push(:reply)
                 ws.send(sendata)
               else
                 ws.close
-                ws=nil
+                ws = nil
                 EM.stop
               end
             when :reply
-              if msg["error_code"]==0
-                output=msg
+              if msg["error_code"] == 0
+                output = msg
                 ws.close
                 EM.stop
               else
-                output=msg
+                output = msg
                 ws.close
                 EM.stop
               end
@@ -97,13 +82,13 @@ module Coinfloor
           else
             raise "Somethings gone wrong with the client"
           end
-        end# end of on message event 
-        
+        end
+
         ws.on :error do |event|
           EM.stop
           ws = nil
         end
-        
+
         ws.on :close do |event|
           EM.stop
           ws = nil
@@ -111,18 +96,16 @@ module Coinfloor
       }
       return output
     end
-    
-    def exec(cfcon_method,arguments)
-      
-      data=@con.send(cfcon_method.to_s,arguments)
-      
+
+    def exec(cfcon_method, args)
+      data = @con.send(cfcon_method.to_s, args)
       begin_connection(data)
     end
-    
+
     def get_balance
-      self.exec(:getbalance,{})
+      self.exec(:getbalance, {})
     end
-    
+
     def public_key
       @con.public_key
     end

data/lib/trade_api/trade_api.rb

@@ -1,106 +1,111 @@
-=begin
-Copyright 2014 Coinfloor LTD.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-=end
-
-require 'libecp'
-require 'json'
+require "json"
+require "libecp"
 
 module Coinfloor
-  # The Coinfloor trade API
-  # All method calls return json which is to be sent to the API.
   class CFcon
     # coinfloor user trade id, password
-    def initialize(uid,password,api_key,pkey=nil)
-      @uid=uid
-      @uid_byte=LibEcp.gen_uid(uid)
+    def initialize(uid, password, api_key, pkey = nil)
+      @uid = uid
+      @uid_byte = LibEcp.gen_uid(uid)
+
       if pkey
-        @private_key=pkey
+        @private_key = pkey
       else
-        @password=password
-        @private_key=LibEcp.private_key(@uid_byte,password)
-
+        @password = password
+        @private_key = LibEcp.private_key(@uid_byte, password)
       end
-      @public_key=LibEcp.gen_pub(@private_key)
-      @cookie=api_key
-      @password=nil
+
+      @public_key = LibEcp.gen_pub(@private_key)
+      @cookie = api_key
+      @password = nil
     end
 
-    attr_reader  :public_key
+    attr_reader :public_key
 
-    # Authenticate using your generated private key, pass in the nonce given by the server on initial authenticate open
+    # Authenticate using your generated private key, pass in the nonce given by
+    # the server on initial authenticate open.
     def auth(server_nonce)
-      nonce=LibEcp.gen_nonce
-      while nonce.bytes.count==15
-        nonce=LibEcp.gen_nonce
+      nonce = LibEcp.gen_nonce
+      while nonce.bytes.count == 15
+        nonce = LibEcp.gen_nonce
       end
-      sigs=LibEcp.sign(@uid_byte,Base64.decode64(server_nonce),nonce,@private_key)
+
+      sigs = LibEcp.sign(@uid_byte, Base64.decode64(server_nonce), nonce, @private_key)
       {
-        "method"=>"Authenticate",
-        "user_id"=>@uid,
-        "cookie"=>@cookie,
-        "nonce"=>Base64.encode64(nonce).rstrip,
-        "signature"=>[Base64.encode64(sigs[0]).rstrip,Base64.encode64(sigs[1]).rstrip]
+        "method"    => "Authenticate",
+        "user_id"   => @uid,
+        "cookie"    => @cookie,
+        "nonce"     => Base64.encode64(nonce).rstrip,
+        "signature" => [Base64.encode64(sigs[0]).rstrip, Base64.encode64(sigs[1]).rstrip]
       }.to_json.gsub(/\s+/, "")
     end
 
-    # Cancels users existing order, arguments: {:id=>order_id_integer}
+    # Cancels users existing order.
     def cancelorder(args)
       {
-        :method=>"CancelOrder",
-        :id=>args[:id]
+        :method => "CancelOrder",
+        :id     => args[:id],
       }.to_json
     end
 
-    # return any available balance, no arguments
-    def getbalance(args={})
+    # Return any available balance.
+    def getbalance(args = {})
       {
-        :method=> "GetBalances"
+        :method => "GetBalances",
       }.to_json
     end
 
-    # return a list of open orders, no arguments
-    def getorders(args={})
+    # Return a list of open orders.
+    def getorders(args = {})
       {
-        :method=> "GetOrders"
+        :method => "GetOrders",
       }.to_json
     end
 
-    # Place an order,arguments:
-    # {:base_asset_id=>integer,:counter_asset_id=>integer,:quantity=>integer,:price=>integer}
-    # quantity is positive for a buy, negative for a sell
-    def placeorder(arguments)
+    # Place an order.
+    def placeorder(args)
+      {
+        :method   => "PlaceOrder",
+        :base     => args[:base_asset_id],
+        :counter  => args[:counter_asset_id],
+        :quantity => args[:quantity],
+        :price    => args[:price],
+        :total    => args[:total],
+      }.delete_if { |k, v| v.nil? }.to_json
+    end
 
+    # Gets a copy of the orderbook, does not subscribe.
+    # The subscription connection is not working because we are not doing a
+    # continious conection.
+    def orderbook(args)
       {
-        :method => "PlaceOrder",
-        :base => arguments[:base_asset_id],
-        :counter => arguments[:counter_asset_id],
-        :quantity => arguments[:quantity],
-        :price => arguments[:price]
-      }.delete_if { |k, v| v.nil? }.to_json #removes empty values that might not be given as arguments
+        :method  => "WatchOrders",
+        :base    => args[:base_asset_id],
+        :counter => args[:counter_asset_id],
+        :watch   => true,
+      }.to_json
     end
 
-    # Gets a copy of the orderbook, does not subscribe
-    def orderbook(arguments)
+    # Simulates the execution of a market order and returns the quantity and
+    # total that would have been traded. This estimation does not take into
+    # account trading fees.
+    def estimatemarketorder(args)
       {
-        :method => "WatchOrders",
-        :base => arguments[:base_asset_id],
-        :counter => arguments[:counter_asset_id],
-        :watch => true
+        :method   => "EstimateMarketOrder",
+        :base     => args[:base_asset_id],
+        :counter  => args[:counter_asset_id],
+        :quantity => args[:quantity],
+        :total    => args[:total],
       }.to_json
     end
-  end
 
+    # Retrieves the 30-day trailing trade volume for the authenticated user.
+    def gettradevolume(args)
+      {
+        :method => "GetTradeVolume",
+        :asset  => args[:asset_id],
+      }.to_json
+    end
+  end
 end
 

data/lib/trade_client.rb

@@ -1,18 +1,2 @@
-=begin
-Copyright 2014 Coinfloor LTD.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-=end
-
 require 'trade_api/trade_api'
 require 'client/client'

metadata

@@ -1,100 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: cf-trade-client
 version: !ruby/object:Gem::Version
-  version: 0.1.9
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
-- Coinfloor
+- Coinfloor LTD
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faye-websocket
+  name: cf-ruby-libecp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
-  name: cf-ruby-libecp
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.7'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.7'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
-description: This client allows a user to trade on the coinfloor plaform using their
-  API, it uses EventMachine and Faye websockets library as well as depending on the
-  coinfloor libecp gem
+description: Client to trade on the Coinfloor platform using their API.
 email: development@coinfloor.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/trade_client.rb
 - lib/client/client.rb
 - lib/trade_api/trade_api.rb
-homepage: http://coinfloor.co.uk
+- lib/trade_client.rb
+homepage: https://github.com/coinfloor/ruby-client
 licenses:
-- APACHE 2.0
+- Apache License Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
-summary: An example ruby client library to trade on the Coinfloor platform using their
-  API
+specification_version: 4
+summary: Ruby Coinfloor Client
 test_files: []
-has_rdoc: