cryptoexchange 0.10.4 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bb5f56f4960e4106321369f548e4447fdea9ff2
-  data.tar.gz: da706e292376563eb40f1fbf2d34219a47c79947
+  metadata.gz: 2b047ac150f961ed2f5b074d5ae4c1b243f30e3f
+  data.tar.gz: cf2e4e5bc58c295589eb814a761b6aea187cbb11
 SHA512:
-  metadata.gz: d9d7c94137fb7444f74c00b5f3d73190e6df997628c6afa2a100c7988aed28b136c0e712c422ebcb1057b9482b0b462c9d9b0ac0b78acff7f9803a883cc342a6
-  data.tar.gz: 514812b1f6cd5a810e0305e248415a86c181580ea241809e0f4fe42701bcc83402ad9bb7fc25bc6370751767df9a060e22c3e2b755f3f3fad336e460b9e2d2b9
+  metadata.gz: b89a3703b7e3d5a559bb1ac87eabab2f7f8e9b7164dfb98c12660ec9b34d4bde5b06c906d6f75a612f59fbf40c0e820095d4b76e8f9361746f5493ac3314e569
+  data.tar.gz: 6c6bc775d4b8a2416facb85be32409c1058369946ddf370febb99c9c47aba347707388f5d5fc31156902525e019f7f2e80a6a4165ce4f88d63221a69375f9e00

data/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Introduction
+
+### 
+
+First of all, thank you for your interest to contribute to the Cryptoexchange project.
+
+There are many ways to contribute! Our documentation surely has room for improvement, bug hunting, bug fixing, writing better walkthrough tutorials for our users, and even feature implementations (new exchange, new APIs).
+
+# Ground Rules
+* Write specs (even though our integration test is currently brittle, passing specs for your implementation is highly recommended)
+* Verify that the data attribute assignment from the API response is correct (ie. base, target, volume is selected correctly)
+* Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.
+* Keep changes as small as possible, one branch one feature
+* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
+
+# Getting started
+1. Create a fork of this repository on Github
+2. You may create a new branch within your fork (name the branch according to the implementation)
+3. If you like the change and think the project could use it:
+    * Be sure you have followed the code style for the project.
+    * Send a pull request indicating that you have a CLA on file.
+
+# How to suggest a feature or enhancement
+If you have any suggestion on how we can make this gem better, feel free to open an issue for discussion.
+
+# Community
+You can chat with the core team member or other participating in this repository chat on [https://gitter.im/cryptoexchange-api/Lobby/~chat#](https://gitter.im/cryptoexchange-api/Lobby/~chat#)

data/README.md

@@ -2,7 +2,7 @@
 
 # Cryptoexchange
 
-Cryptoexchange is a rubygem for ruby developers to interact with multiple cryptocurrency exchange market data APIs in a single library.
+Cryptoexchange is a rubygem for ruby developers to interact with over 40+ cryptocurrency exchange market data APIs in a single library.
 
 ## Installation
 
@@ -51,7 +51,7 @@ Or install it yourself as:
 | EtherDelta        | Y       |            |         |         | Y           |
 | Gatecoin          | Y       |            |         |         | Y           |
 | GDAX              | Y       |            |         |         | Y           |
-| Gemini            | Y       |            |         |         | Y           |
+| Gemini            | Y       | Y          |         |         | Y           |
 | HitBTC            | Y       |            |         |         | Y           |
 | Huobi             | Y       |            |         |         | Y           |
 | Itbit             |         |            |         |         |             |
@@ -61,7 +61,7 @@ Or install it yourself as:
 | LakeBTC           | Y       |            |         |         | Y           |
 | Liqui             | Y       |            |         |         | Y           |
 | Livecoin          | Y       |            |         |         | Y           |
-| Luno              |         |            |         |         |             |
+| Luno              | Y       |            |         |         | Y           |
 | MercadoBitcoin    | Y       |            |         |         | User-Defined|
 | Nova Exchange     | Y       |            |         |         | Y           |
 | OKCoin            | Y       |            |         |         | User-Defined|
@@ -84,6 +84,13 @@ Or install it yourself as:
   pairs = client.pairs('bitflyer')
 ```
 
+### List exchange services for certain currency
+```
+  client.exchange_for('btc')
+
+  # ['anx', 'bianance', ...]
+```
+
 ### Query the Ticker API
 ```
   pair = client.pairs('bitflyer').first
@@ -93,6 +100,17 @@ Or install it yourself as:
   ticker.last
 ```
 
+### Query the OrderBook API
+```
+  # Check if exchange has support for OrderBook
+  pair = client.pairs('bitflyer').first
+  order_book = client.order_book(pairs.last)
+  order_book.base
+  order_book.target
+  order_book.bids
+  order_book.asks
+```
+
 ### Market List
 Some exchange API do not support market pair listings. For those exchanges, we included
 a custom YML file to define the list of market pairs supported by that exchange.
@@ -124,6 +142,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/coingecko/cryptoexchange. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+The [contributing guide](https://github.com/coingecko/cryptoexchange/blob/master/CONTRIBUTING.md) may also be useful to you.
+
+You can chat with the core team member or other participating in this repository chat on [https://gitter.im/cryptoexchange-api/Lobby/~chat#](https://gitter.im/cryptoexchange-api/Lobby/~chat#)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/cryptoexchange/client.rb

@@ -8,6 +8,8 @@ module Cryptoexchange
     def pairs(exchange)
       pairs_classname = "Cryptoexchange::Exchanges::#{StringHelper.camelize(exchange)}::Services::Pairs"
       Object.const_get(pairs_classname).new.fetch
+    rescue HTTP::ConnectionError, HTTP::TimeoutError, JSON::ParserError
+      return { error: "#{exchange}'s service is temporarily unavailable." }
     end
 
     def ticker(market_pair)
@@ -24,6 +26,46 @@ module Cryptoexchange
           t.base == market_pair.base && t.target == market_pair.target
         end
       end
+    rescue HTTP::ConnectionError, HTTP::TimeoutError, JSON::ParserError
+      return { error: "#{exchange}'s service is temporarily unavailable." }
+    end
+
+    def available_exchanges
+      folder_names = Dir[File.join(File.dirname(__dir__), 'cryptoexchange', 'exchanges', '**')]
+      folder_names.map do |folder_name|
+        folder_name.split('/').last
+      end
+    end
+
+    def exchange_for(currency)
+      exchanges = []
+      available_exchanges.each do |exchange|
+        pairs = pairs(exchange)
+        next if pairs.is_a?(Hash) && !pairs[:error].empty?
+        pairs.each do |pair|
+          if [pair.base, pair.target].include?(currency.upcase)
+            exchanges << exchange
+            break
+          end
+        end
+      end
+      exchanges.uniq.sort
+    end
+
+    def order_book(market_pair)
+      exchange = market_pair.market
+      market_classname = "Cryptoexchange::Exchanges::#{StringHelper.camelize(exchange)}::Services::OrderBook"
+      market_class = Object.const_get(market_classname)
+      order_book = market_class.new
+
+      if market_class.supports_individual_ticker_query?
+        order_book.fetch(market_pair)
+      else
+        order_books = order_book.fetch
+        order_books.find do |o|
+          o.base == market_pair.base && o.target == market_pair.target
+        end
+      end
     end
   end
 end

data/lib/cryptoexchange/exchanges/bitcoin_indonesia/bitcoin_indonesia.yml

@@ -1,19 +1,30 @@
 :pairs:
   - :base: BTC
     :target: IDR
+  - :base: BCH
+    :target: IDR
   - :base: ETH
+    :target: IDR
+  - :base: ETC
+    :target: IDR
+  - :base: XRP
+    :target: IDR
+  - :base: XZC
+    :target: IDR
+  - :base: BTS
     :target: BTC
   - :base: DOGE
     :target: BTC
-  - :base: BTS
+  - :base: ETH
     :target: BTC
   - :base: LTC
     :target: BTC
-  - :base: STR
-    :target: BTC
   - :base: NXT
     :target: BTC
-  - :base: XRP
+  - :base: STR
     :target: BTC
   - :base: NEM
     :target: BTC
+  - :base: XRP
+    :target: BTC
+    

data/lib/cryptoexchange/exchanges/ether_delta/market.rb

@@ -2,7 +2,7 @@ module Cryptoexchange::Exchanges
   module EtherDelta
     class Market
       NAME = 'ether_delta'
-      API_URL = 'https://cache1.etherdelta.com'
+      API_URL = 'https://api.etherdelta.com'
     end
   end
 end

data/lib/cryptoexchange/exchanges/ether_delta/services/market.rb

@@ -22,7 +22,6 @@ module Cryptoexchange::Exchanges
         def adapt(output, market_pair)
           name = "#{market_pair.target}_#{market_pair.base}"
           market = output[name]
-
           ticker = Cryptoexchange::Models::Ticker.new
           ticker.base      = market_pair.base
           ticker.target    = market_pair.target

data/lib/cryptoexchange/exchanges/ether_delta/services/pairs.rb

@@ -10,17 +10,20 @@ module Cryptoexchange::Exchanges
         end
 
         def adapt(output)
-          output.keys.map do |pair|
+          pairs = []
+          output.keys.each do |pair|
             # format example: ETH_ZRX
             # ETH is the Target, ZRX is the Base
             target, base = pair.split('_')
-
-            Cryptoexchange::Models::MarketPair.new({
+            # Ignore non-standard BASE
+            next if base =~ /\s/ || base =~ /0x/
+            pairs << Cryptoexchange::Models::MarketPair.new({
               base: base,
               target: target,
               market: EtherDelta::Market::NAME
             })
           end
+          pairs
         end
       end
     end

data/lib/cryptoexchange/exchanges/gemini/services/order_book.rb

@@ -0,0 +1,40 @@
+module Cryptoexchange::Exchanges
+  module Gemini
+    module Services
+      class OrderBook < Cryptoexchange::Services::Market
+        class << self
+          def supports_individual_ticker_query?
+            true
+          end
+        end
+
+        def fetch(market_pair)
+          output = super(ticker_url(market_pair))
+          adapt(output, market_pair)
+        end
+
+        def ticker_url(market_pair)
+          "#{Cryptoexchange::Exchanges::Gemini::Market::API_URL}/book/#{market_pair.base}#{market_pair.target}"
+        end
+
+        def adapt(output, market_pair)
+          order_book = Cryptoexchange::Models::OrderBook.new
+
+          order_book.base      = market_pair.base
+          order_book.target    = market_pair.target
+          order_book.market    = Gemini::Market::NAME
+          order_book.asks      = adapt_orders output['asks']
+          order_book.bids      = adapt_orders output['bids']
+          order_book.timestamp = Time.now.to_i
+          order_book.payload   = output
+          order_book
+        end
+
+        def adapt_orders(orders)
+          # Format as: [price, amount, timestamp]
+          orders.collect { |order_entry| order_entry.values }
+        end
+      end
+    end
+  end
+end

data/lib/cryptoexchange/exchanges/luno/market.rb

@@ -0,0 +1,8 @@
+module Cryptoexchange::Exchanges
+  module Luno
+    class Market
+      NAME = 'luno'
+      API_URL = 'https://api.mybitx.com/api/1'
+    end
+  end
+end

data/lib/cryptoexchange/exchanges/luno/services/market.rb

@@ -0,0 +1,49 @@
+module Cryptoexchange::Exchanges
+  module Luno
+    module Services
+      class Market < Cryptoexchange::Services::Market
+        class << self
+          def supports_individual_ticker_query?
+            false
+          end
+        end
+
+        def fetch
+          output = super(ticker_url)
+          adapt_all(output)
+        end
+
+        def ticker_url
+          "#{Cryptoexchange::Exchanges::Luno::Market::API_URL}/tickers"
+        end
+
+        def adapt_all(output)
+          output['tickers'].map do |ticker|
+            base = ticker['pair'][0..2]
+            target = ticker['pair'][3..5]
+            market_pair = Cryptoexchange::Models::MarketPair.new(
+                            base: base,
+                            target: target,
+                            market: Luno::Market::NAME
+                          )
+            adapt(ticker, market_pair)
+          end
+        end
+
+        def adapt(output, market_pair)
+          ticker           = Cryptoexchange::Models::Ticker.new
+          ticker.base      = market_pair.base
+          ticker.target    = market_pair.target
+          ticker.market    = Luno::Market::NAME
+          ticker.ask       = NumericHelper.to_d(output['ask'])
+          ticker.bid       = NumericHelper.to_d(output['bid'])
+          ticker.last      = NumericHelper.to_d(output['last_trade'])
+          ticker.volume    = NumericHelper.to_d(output['rolling_24_hour_volume'])
+          ticker.timestamp = output['timestamp'].to_i / 1000
+          ticker.payload   = output
+          ticker
+        end
+      end
+    end
+  end
+end

data/lib/cryptoexchange/exchanges/luno/services/pairs.rb

@@ -0,0 +1,27 @@
+module Cryptoexchange::Exchanges
+  module Luno
+    module Services
+      class Pairs < Cryptoexchange::Services::Pairs
+        PAIRS_URL = "#{Cryptoexchange::Exchanges::Luno::Market::API_URL}/tickers"
+
+        def fetch
+          output = super
+          adapt(output)
+        end
+
+        def adapt(output)
+          output['tickers'].map do |ticker|
+            base = ticker['pair'][0..2]
+            target = ticker['pair'][3..5]
+
+            Cryptoexchange::Models::MarketPair.new({
+              base: base,
+              target: target,
+              market: Luno::Market::NAME
+            })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cryptoexchange/models/order_book.rb

@@ -0,0 +1,26 @@
+module Cryptoexchange
+  module Models
+    class OrderBook
+      attr_accessor :base, :target, :market, :bids,
+                    :asks, :timestamp, :payload
+
+      def initialize(params = {})
+        @base = params[:base]
+        @target = params[:target]
+        @market = params[:market]
+        @bids = params[:bids]
+        @asks = params[:asks]
+        @timestamp = params[:timestamp]
+        @payload = params[:payload]
+      end
+
+      def base
+        @base.upcase
+      end
+
+      def target
+        @target.upcase
+      end
+    end
+  end
+end

data/lib/cryptoexchange/version.rb

@@ -1,3 +1,3 @@
 module Cryptoexchange
-  VERSION = "0.10.4"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptoexchange
 version: !ruby/object:Gem::Version
-  version: 0.10.4
+  version: 0.11.0
 platform: ruby
 authors:
 - TM Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - PULL_REQUEST_TEMPLATE
@@ -204,6 +205,7 @@ files:
 - lib/cryptoexchange/exchanges/gdax/services/pairs.rb
 - lib/cryptoexchange/exchanges/gemini/market.rb
 - lib/cryptoexchange/exchanges/gemini/services/market.rb
+- lib/cryptoexchange/exchanges/gemini/services/order_book.rb
 - lib/cryptoexchange/exchanges/gemini/services/pairs.rb
 - lib/cryptoexchange/exchanges/hitbtc/market.rb
 - lib/cryptoexchange/exchanges/hitbtc/services/market.rb
@@ -230,6 +232,9 @@ files:
 - lib/cryptoexchange/exchanges/livecoin/market.rb
 - lib/cryptoexchange/exchanges/livecoin/services/market.rb
 - lib/cryptoexchange/exchanges/livecoin/services/pairs.rb
+- lib/cryptoexchange/exchanges/luno/market.rb
+- lib/cryptoexchange/exchanges/luno/services/market.rb
+- lib/cryptoexchange/exchanges/luno/services/pairs.rb
 - lib/cryptoexchange/exchanges/mercado_bitcoin/market.rb
 - lib/cryptoexchange/exchanges/mercado_bitcoin/mercado_bitcoin.yml
 - lib/cryptoexchange/exchanges/mercado_bitcoin/services/market.rb
@@ -276,6 +281,7 @@ files:
 - lib/cryptoexchange/helpers/string_helper.rb
 - lib/cryptoexchange/lru_ttl_cache.rb
 - lib/cryptoexchange/models/market_pair.rb
+- lib/cryptoexchange/models/order_book.rb
 - lib/cryptoexchange/models/ticker.rb
 - lib/cryptoexchange/services/market.rb
 - lib/cryptoexchange/services/pairs.rb