cobinhood 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb26b0d6d0be6237f3973bb89693d6eebb5c600f33e5b0b383e20495ea6a5308
-  data.tar.gz: 31cb040867b0e5433942268c607433366e17d8bf4da25b59ac8a918d53927e54
+  metadata.gz: 4d802d8a32ec4913646aa40dd06e2e9cf0cc3e5350ff14de57b2ca0e589b910e
+  data.tar.gz: 88e9cd0cde28ea6f14386622dc799f7765b066085accd8da4642fbaf4fe0f2b3
 SHA512:
-  metadata.gz: 856cf4554b437e3e08de2eb2210931c3c43b1057fac494cf386604f09fd9f454ed43588be47f3f278b2e59ea2105d2777262bff164664f5063c2dbbc23072993
-  data.tar.gz: 627f64273a4ff84f24a4e380794f96c6748057b77edb0128c1aba737ffb89cdea8175d2976aa9cc28888572f2186598ef2677cb0bd85dd631612da986d598164
+  metadata.gz: 5551cdcf8bafc74a093adec6003a7f1216c995ba5a2b256323dce210c2c2d8ae6067cb5f3ecb105444c096666a78c1b6895e9940fb1a4aec9f6819341c7221c0
+  data.tar.gz: 87c233c3f517e0d7b7e68df968321371811ce1d9cd21e5930baf1f3472897567c34bc934d80cfd38af416f9324c83134b2e332a31b65ebddcb795d231996f080

data/README.md

@@ -62,7 +62,7 @@ Create a new instance of the REST Client:
 client = Cobinhood::Client::REST.new
 
 # Otherwise provide an api_key as keyword arguments
-client = Cobinhood::Client::REST.new api_key: 'x'
+client = Cobinhood::Client::REST.new api_key: 'your.api_key'
 ```
 
 ALTERNATIVELY, set your API key in exported environment variable:
@@ -134,117 +134,170 @@ of the endpoint's URL and alias method follows the title/name given in Cobinhood
 where there would otherwise be name clashes/overloading.
 
 #### System Endpoints
-
-name: time
+----
+```ruby
+time
+```
 * required params: none
-
-name: info
+----
+```ruby
+info
+```
 * required params: none
 
 #### Market Endpoints
-
-name: currencies
-alias: get_all_currencies
+----
+```ruby
+currencies
+```
+* alias: get_all_currencies
 * required params: none
-
-name: trading_pairs
-alias: get_all_trading_pairs
+----
+```ruby
+trading_pairs
+```
+* alias: get_all_trading_pairs
 * required params: none
-
-name: order_book trading_pair_id
-alias: get_order_book
+----
+```ruby
+order_book trading_pair_id
+```
+* alias: get_order_book
 * required params: trading_pair_id
-
-name: precisions trading_pair_id
-alias: get_order_book_precisions
+----
+```ruby
+precisions trading_pair_id
+```
+* alias: get_order_book_precisions
 * required params: trading_pair_id
-
-name: stats
+----
+```ruby
+stats
+```
 * required params: none
-
-name: tickers trading_pair_id
-alias: get_ticker
+----
+```ruby
+tickers trading_pair_id
+```
+* alias: get_ticker
 * required params: none
-
-alias : :market_trades
-name: market_trades trading_pair_id
-alias: get_recent_trades
+----
+```ruby
+market_trades trading_pair_id
+```
+* alias: get_recent_trades
 * required params: none
 
 #### Chart Endpoints
-
-name: candles trading_pair_id, options={}
+----
+```ruby
+candles trading_pair_id, options={}
+```
 * required params: trading_pair_id, timeframe
 
 #### Trading Endpoints
-
-name: order order_id
-alias: get_order
+----
+```ruby
+order order_id
+```
+* alias: get_order
 * required params: order_id
-
-name: order_trades order_id
-alias: get_trades_of_an_order
+----
+```ruby
+order_trades order_id
+```
+* alias: get_trades_of_an_order
 * required params: order_id
-
-name: orders
-alias: get_all_orders
+----
+```ruby
+orders
+```
+* alias: get_all_orders
 * required params: none
-
-name: place_order trading_pair_id, options={}
+----
+```ruby
+place_order trading_pair_id, options={}
+  ```
 * required params: side, type, size, price (except market orders)
-
-name: modify_order order_id, options={}
+----
+```ruby
+modify_order order_id, options={}
+```
 * required params: order_id, size, price
-
-name: cancel_order order_id
+----
+```ruby
+cancel_order order_id
+```
 * required params: order_id
-
-name: order_history trading_pair_id=nil, options={}
-alias: get_order_history
+----
+```ruby
+order_history trading_pair_id=nil, options={}
+```
+* alias: get_order_history
 * required params: none
-
-name: get_trade trade_id
-alias: trade
+----
+```ruby
+get_trade trade_id
+```
+* alias: trade
 * required params: trade_id
-
-name: trades trading_pair_id, options={}
+----
+```ruby
+trades trading_pair_id, options={}
+```
 * required params: trading_pair_id
 
 #### Wallet Endpoints
-
-name: balances
-alias: get_wallet_balances
+----
+```ruby
+balances
+```
+* alias: get_wallet_balances
 * required params: none
-
-name: ledger
-alias: get_ledger_entries
+----
+```ruby
+ledger
+```
+* alias: get_ledger_entries
 * required params: none
-
-name: deposit_addresses
-alias: get_deposit_addresses
+----
+```ruby
+deposit_addresses
+```
+* alias: get_deposit_addresses
 * required params: none
-
-name: withdrawal_addresses
-alias: get_withdrawal_addresses
+----
+```ruby
+withdrawal_addresses
+```
+* alias: get_withdrawal_addresses
 * required params: none
-
-name: withdrawal withdrawal_id
-alias: get_withdrawal
+----
+```ruby
+withdrawal withdrawal_id
+```
+* alias: get_withdrawal
 * required params: withdrawal_id
-
-name: withdrawals
-alias: get_all_withdrawals
+----
+```ruby
+withdrawals
+```
+* alias: get_all_withdrawals
 * required params: none
-
-name: deposit deposit_id
-alias: get_deposit
+----
+```ruby
+deposit deposit_id
+```
+* alias: get_deposit
 * required params: deposit_id
-
-name: deposits
-alias: get_all_deposits
+----
+```ruby
+deposits
+```
+* alias: get_all_deposits
 * required params: none
 
-#### WebSocket Client
+### WebSocket Client
 
 * COMING SOON!
 

data/lib/cobinhood.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'faraday'
 require 'faraday_middleware'
 

data/lib/cobinhood/client/rest.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'rest/api_endpoints'
 require_relative 'rest/nonce_request_middleware'
 require_relative 'rest/auth_request_middleware'
@@ -9,10 +10,10 @@ require_relative 'rest/trading_api'
 require_relative 'rest/wallet_api'
 
 module Cobinhood
-  MissingParamError = Class.new(Exception)
-  InvalidParamError = Class.new(Exception)
-  MissingApiKeyError = Class.new(Exception)
-  ClientError = Class.new(Exception)
+  MissingParamError = Class.new(StandardError)
+  InvalidParamError = Class.new(StandardError)
+  MissingApiKeyError = Class.new(StandardError)
+  ClientError = Class.new(StandardError)
 
   module Client
     # Public: Client with methods mirroring the Cobinhood REST APIs
@@ -62,7 +63,7 @@ module Cobinhood
       def public_client adapter
         Faraday.new(url: BASE_URL) do |conn|
           conn.request :json
-          conn.response :json, content_type: /\bjson$/
+          conn.response :json, content_type: /\bjson\z/
           conn.use NonceRequestMiddleware
           conn.adapter adapter
         end
@@ -71,7 +72,7 @@ module Cobinhood
       def auth_client api_key, adapter
         Faraday.new(url: BASE_URL) do |conn|
           conn.request :json
-          conn.response :json, content_type: /\bjson$/
+          conn.response :json, content_type: /\bjson\z/
           conn.use NonceRequestMiddleware
           conn.use AuthRequestMiddleware, api_key
           conn.adapter adapter
@@ -91,13 +92,13 @@ module Cobinhood
       #           Each endpoint will have their own required and optional
       #           params.
       def request api, method, endpoint, options = {}
-        response = @library[api].send(method) do |req|
+        response = @library[api].public_send(method) do |req|
 
           # substitute path parameters and remove from options hash
           endpoint_url = API_ENDPOINTS[api][endpoint].dup
           options.each do |option, value|
-            path_param = Regexp.new(":#{option}")
-            if endpoint_url =~ path_param
+            path_param = /":#{option}"/
+            if endpoint_url match? path_param
               options.delete(option)
               endpoint_url.gsub!(path_param, value)
             end

data/lib/cobinhood/client/rest/api_endpoints.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
   module Client
     class REST

data/lib/cobinhood/client/rest/auth_request_middleware.rb

@@ -1,12 +1,13 @@
+# frozen_string_literal: true
 module Cobinhood
   class AuthRequestMiddleware < Faraday::Middleware
     def initialize app, api_key
       super(app)
-      @api_key = api_key
+      @api_key = api_key.to_s
     end
 
     def call env
-      raise Cobinhood::MissingApiKeyError.new('API KEY not provided') if @api_key.to_s == ''
+      raise Cobinhood::MissingApiKeyError.new('API KEY not provided') if @api_key.empty?
       env[:request_headers]["authorization"] = @api_key
       @app.call(env)
     end

data/lib/cobinhood/client/rest/chart_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
   module Client
     class REST

data/lib/cobinhood/client/rest/market_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
   module Client
     class REST
@@ -7,22 +8,22 @@ module Cobinhood
         def currencies
           request :market, :get, :currencies
         end
-        alias :get_all_currencies :currencies
+        alias get_all_currencies currencies
 
         def trading_pairs
           request :market, :get, :trading_pairs
         end
-        alias :get_all_trading_pairs :trading_pairs
+        alias get_all_trading_pairs trading_pairs
 
         def order_book trading_pair_id
           request :market, :get, :order_book, trading_pair_id: trading_pair_id
         end
-        alias :get_order_book :order_book
+        alias get_order_book order_book
 
         def precisions trading_pair_id
           request :market, :get, :precisions, trading_pair_id: trading_pair_id
         end
-        alias :get_order_book_precisions :precisions
+        alias get_order_book_precisions precisions
 
         def stats
           request :market, :get, :stats
@@ -31,12 +32,12 @@ module Cobinhood
         def tickers trading_pair_id
           request :market, :get, :tickers, trading_pair_id: trading_pair_id
         end
-        alias :get_ticker :tickers
+        alias get_ticker tickers
 
         def market_trades trading_pair_id
           request :market, :get, :trades, trading_pair_id: trading_pair_id
         end
-        alias :get_recent_trades :market_trades
+        alias get_recent_trades market_trades
       end
     end
   end

data/lib/cobinhood/client/rest/nonce_request_middleware.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'date'
 
 module Cobinhood

data/lib/cobinhood/client/rest/trading_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
   module Client
     class REST
@@ -7,17 +8,17 @@ module Cobinhood
         def order order_id
           request :trading, :get, :order, order_id: order_id
         end
-        alias :get_order :order
+        alias get_order order
 
         def order_trades order_id
           request :trading, :get, :order_trades, order_id: order_id
         end
-        alias :get_trades_of_an_order :order_trades
+        alias get_trades_of_an_order order_trades
 
         def orders
           request :trading, :get, :orders
         end
-        alias :get_all_orders :orders
+        alias get_all_orders orders
 
         def place_order trading_pair_id, options={}
           assert_required_param options, :side, sides
@@ -41,12 +42,12 @@ module Cobinhood
           options.merge!(trading_pair_id: trading_pair_id) unless trading_pair_id.nil?
           request :trading, :get, :order_history, options
         end
-        alias :get_order_history :order_history
+        alias get_order_history order_history
 
         def get_trade trade_id
           request :trading, :get, :get_trade, options.merge(trade_id: trade_id)
         end
-        alias :trade :get_trade
+        alias trade get_trade
 
         def trades trading_pair_id, options={}
           request :trading, :get, :trades, options.merge(trading_pair_id: trading_pair_id)

data/lib/cobinhood/client/rest/wallet_api.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
   module Client
     class REST
@@ -7,42 +8,42 @@ module Cobinhood
         def balances
           request :wallet, :get, :balances
         end
-        alias :get_wallet_balances :balances
+        alias get_wallet_balances balances
 
         def ledger
           request :wallet, :get, :ledger
         end
-        alias :get_ledger_entries :ledger
+        alias get_ledger_entries ledger
 
         def deposit_addresses
           request :wallet, :get, :deposit_addresses
         end
-        alias :get_deposit_addresses :deposit_addresses
+        alias get_deposit_addresses deposit_addresses
 
         def withdrawal_addresses
           request :wallet, :get, :withdrawal_addresses
         end
-        alias :get_withdrawal_addresses :withdrawal_addresses
+        alias get_withdrawal_addresses withdrawal_addresses
 
         def withdrawal withdrawal_id
           request :wallet, :get, :withdrawal, withdrawal_id: withdrawal_id
         end
-        alias :get_withdrawal :withdrawal
+        alias get_withdrawal withdrawal
 
         def withdrawals
           request :wallet, :get, :withdrawals
         end
-        alias :get_all_withdrawals :withdrawals
+        alias get_all_withdrawals withdrawals
 
         def deposit deposit_id
           request :wallet, :get, :deposit, deposit_id: deposit_id
         end
-        alias :get_deposit :deposit
+        alias get_deposit deposit
 
         def deposits
           request :wallet, :get, :deposits
         end
-        alias :get_all_deposits :deposits
+        alias get_all_deposits deposits
       end
     end
   end

data/lib/cobinhood/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Cobinhood
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cobinhood
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Lang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler