okex-ruby-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ec2d0c0ee3a810735420175e6dfa11a25c9b5bf37d9ca9c1f1a06386e22990b
-  data.tar.gz: 917e0911819a63fe5c42ab6159fb5617164fd024c9e172d854dc84efef77bbd5
+  metadata.gz: afa60a5ac3bcd6673a4c8baafe0ad83345e177a257a87daf52f6320efd4dddef
+  data.tar.gz: e5b6c80f4fd1f9a9916055f74fcc41b724f030760e893b1fb1575d4da7dfe365
 SHA512:
-  metadata.gz: 7d1005119c5a496122e0340dda52abd7f23eb2d059811a82e219fabbcccff8a99c3b8f170d7739ad8baa224e0e800054ce26912d0b8cf3312aa2a544e6e74ec7
-  data.tar.gz: 5d139dba46035e69bbdcd02c685c2a9a7b4faa29485e5ab5f3131d4b4d961f700c2bf56c9f5e6d86152bbe1fc1556a1b5be87592a57b8c810f14ca4333f5ea94
+  metadata.gz: e66a83ee46f8231a5dc18f632a908cd293f173b9ea451f5ad2acc7f0f7c54ae558b212451cdc6aae99a749421238a8a21f6c055fd542687ad2cfe78e34ef5d1d
+  data.tar.gz: c7b582ecdc31bd71656d4769a3b95a8228b1fc90c670ea99862318e37718284a88af4b1d5c0782bc2e429720e9e4c89b5f997af1da0d7a124eeaf1cfb9bf6a36

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    okex-ruby-api (0.1.0)
+    okex-ruby-api (0.2.0)
       httparty (~> 0.19)
       openssl (~> 2.2)
 

data/README.md

@@ -23,28 +23,45 @@ Or install it yourself as:
 
 ## Usage
 
-### Futures
+### Markets
 
-Initialize a futures session:
+Initialize a markets session:
 ```ruby
-futures = OKEX::API::Futures.new
+markets = OKEX::API::Markets.new
 ```
 
 Query for all current futures specs:
 ```ruby
-futures.list
+markets.list(type: :futures)
+```
+
+Query for all current spot specs:
+```ruby
+markets.list(type: :spot)
 ```
 
 Query for all current futures prices:
 ```ruby
-futures.tickers
+markets.tickers(type: :futures)
+```
+
+Query for all current spot prices:
+```ruby
+markets.tickers(type: :spot)
 ```
 
 Fetch a single current futures price:
 ```ruby
-futures.ticker('BTC-USDT-220325')
+markets.ticker('BTC-USDT-220325', type: :futures)
 ```
 
+Fetch a single current spot price:
+```ruby
+markets.ticker('BTC-USDT', type: :spot)
+```
+
+> Note: type is optional and defaults to 'spot'.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/okex/api/markets.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'public'
+
+class OKEX::API::Markets < OKEX::API::Public
+
+  def list(type: :spot)
+    raise ArgumentError, "type must be either 'futures' or 'spot'" unless %w(futures spot).include?(type.to_s)
+    send_request(:get, "/#{type.to_s}/v3/instruments", {})
+  end
+
+  def tickers(type: :spot)
+    raise ArgumentError, "type must be either 'futures' or 'spot'" unless %w(futures spot).include?(type.to_s)
+    send_request(:get, "/#{type.to_s}/v3/instruments/ticker", {})
+  end
+
+  def ticker(futures_name, type: :spot)
+    raise ArgumentError, "type must be either 'futures' or 'spot'" unless %w(futures spot).include?(type.to_s)
+    send_request(:get, "/#{type.to_s}/v3/instruments/#{futures_name}/ticker", {})
+  end
+  
+end

data/lib/okex/api/version.rb

@@ -2,6 +2,6 @@
 
 module OKEX
   module API
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/okex/api.rb

@@ -2,4 +2,4 @@
 require_relative "../ext/base"
 require_relative "api/version"
 require_relative "api/config"
-require_relative "api/futures"
+require_relative "api/markets"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okex-ruby-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - benrs44
@@ -61,7 +61,7 @@ files:
 - lib/okex/api.rb
 - lib/okex/api/base.rb
 - lib/okex/api/config.rb
-- lib/okex/api/futures.rb
+- lib/okex/api/markets.rb
 - lib/okex/api/private.rb
 - lib/okex/api/public.rb
 - lib/okex/api/version.rb

data/lib/okex/api/futures.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'public'
-
-class OKEX::API::Futures < OKEX::API::Public
-
-  def list
-    send_request(:get, '/futures/v3/instruments', {})
-  end
-
-  def tickers
-    send_request(:get, '/futures/v3/instruments/ticker', {})
-  end
-
-  def ticker(futures_name)
-    send_request(:get, "/futures/v3/instruments/#{futures_name}/ticker", {})
-  end
-  
-end