cryptocompare 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d20e62b88d867db1cbca707672c55176fc66517a
-  data.tar.gz: ba8adf2091a559f4df530a0fac701335aa50bae6
+  metadata.gz: 3ac9166226c481cf02e4943f7ff9d340fad3102d
+  data.tar.gz: 2bed9e8d7c43a11b55bef587e08d3b505911154d
 SHA512:
-  metadata.gz: 6341cad1ddd37cf355fac24ce4c61b37d7d75017b8b242f1fecf133e5f7ff2164c7178e21cbb4160cbab0acf12cbb124d1e4a77cb417cea5bf06b3f35593ef37
-  data.tar.gz: 47a2e9f163e8bb860911e00403c345147c5f07676b92dbfcfd79cba61d88e97ce6eeac6aae81d3387229c8500ce69224eca66787504378ed8cb24bc1e4cc65d9
+  metadata.gz: ddf5f8016df804ec197f96604609b615e1773bb61f4c3334e33400ce6d32bc4f48ab6030a4b01ceabd788024628d94593ba935728eaa7df935de34dccab95333
+  data.tar.gz: 0bb7317bf99b124a0f0944e5365cfbbaf20526c195f94b7a8feb3451f4c6b9947909867721b622e06c691a6bd71b86582f4709d022f06d7bf80e6d100adc904f

data/README.md

@@ -172,6 +172,38 @@ Cryptocompare::CoinSnapshot.find('BTC', 'USD')
 #   }
 ```
 
+### TopPairs
+
+Get top pairs by volume for a currency (always uses aggregated data). The number of pairs you get is the minimum of the limit you set (default 5) and the total number of pairs available.
+
+**Examples:**
+
+Find top pairs by trading volume for a given currency.
+
+```ruby
+Cryptocompare::TopPairs.find('ETH')
+# => {
+#   Response: "Success",
+#   Data: [
+#     {
+#       exchange: "CCCAGG",
+#       fromSymbol: "ETH",
+#       toSymbol: "USD",
+#       volume24h: 1310705.3005027298,
+#       volume24hTo: 288031723.3503975
+#     },
+#     {
+#       exchange: "CCCAGG",
+#       fromSymbol: "ETH",
+#       toSymbol: "BTC",
+#       volume24h: 978200.2198323006,
+#       volume24hTo: 77883.06190085363
+#     },
+#     ...
+#   ]
+# }
+```
+
 ## Supported Exchanges
 
 * BTC38

data/lib/cryptocompare.rb

@@ -2,6 +2,7 @@ require_relative "cryptocompare/version"
 require_relative "cryptocompare/coin_snapshot"
 require_relative "cryptocompare/price"
 require_relative "cryptocompare/price_historical"
+require_relative "cryptocompare/top_pairs"
 
 module Cryptocompare
 end

data/lib/cryptocompare/coin_snapshot.rb

@@ -1,6 +1,5 @@
 require 'faraday'
 require 'json'
-require 'yaml'
 
 module Cryptocompare
   module CoinSnapshot

data/lib/cryptocompare/helpers/exchange_name_helper.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+# Helper module for exchange names.
+module ExchangeNameHelper
+  EXCHANGES = YAML::load_file(File.join(__dir__, '../../../config/exchanges.yml'))
+
+  # Helper method to overcome case-sensitive exchange name enforced by the API.
+  # If no supported exchange mapping is found, it will try user's input.
+  def self.set_exchange(exchange)
+    EXCHANGES[exchange.upcase] || exchange
+  end
+end

data/lib/cryptocompare/price.rb

@@ -1,11 +1,11 @@
 require 'faraday'
 require 'json'
-require 'yaml'
+require_relative 'helpers/exchange_name_helper'
 
 module Cryptocompare
-  EXCHANGES = YAML::load_file(File.join(__dir__, '../../config/exchanges.yml'))
-
   module Price
+    extend ExchangeNameHelper
+
     API_URL = 'https://min-api.cryptocompare.com/data/pricemulti'
 
     # Finds the currency price(s) of a given currency symbol. Really fast,
@@ -62,17 +62,11 @@ module Cryptocompare
       fsyms = Array(from_syms).join(',')
       tsyms = Array(to_syms).join(',')
       full_path = API_URL + "?fsyms=#{fsyms}&tsyms=#{tsyms}"
-      full_path += "&e=#{set_exchange(opts['e'])}" if opts['e']
+      if (exchange = opts['e'])
+        full_path += "&e=#{ExchangeNameHelper.set_exchange(exchange)}"
+      end
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end
-
-    private
-
-    # Helper method to overcome case-sensitive exchange name enforced by the API.
-    # If no supported exchange mapping is found, it will try user's input.
-    def self.set_exchange(exchange)
-      EXCHANGES[exchange.upcase] || exchange
-    end
   end
 end

data/lib/cryptocompare/price_historical.rb

@@ -1,6 +1,5 @@
 require 'faraday'
 require 'json'
-require 'yaml'
 
 module Cryptocompare
   module PriceHistorical

data/lib/cryptocompare/top_pairs.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'json'
+
+module Cryptocompare
+  module TopPairs
+    API_URL = 'https://min-api.cryptocompare.com/data/top/pairs'
+
+    # Get top pairs by volume for a currency (always uses aggregated data).
+    # The number of pairs you get is the minimum of the limit you set
+    # (default 5) and the total number of pairs available.
+    #
+    # ==== Parameters
+    #
+    # * +from_sym+  [String]           - (required) currency symbol (ex: 'BTC', 'ETH', 'LTC', 'USD', 'EUR', 'CNY')
+    # * +opts+      [Hash]             - (optional) options hash
+    #
+    # ==== Options
+    # * +limit+     [Integer]          - (optional) limit. Default 5. Max 2000.
+    #
+    # ==== Returns
+    # [Hash] Returns a hash containing data as an array of hashes containing
+    #        info about top-traded pairs.
+    #
+    # ==== Examples
+    #
+    # Find top pairs by trading volume for a given currency.
+    #
+    #   Cryptocompare::TopPairs.find('ETH')
+    #
+    # Sample response
+    #
+    #   {
+    #     Response: "Success",
+    #     Data: [
+    #       {
+    #         exchange: "CCCAGG",
+    #         fromSymbol: "ETH",
+    #         toSymbol: "USD",
+    #         volume24h: 1310705.3005027298,
+    #         volume24hTo: 288031723.3503975
+    #       },
+    #       {
+    #         exchange: "CCCAGG",
+    #         fromSymbol: "ETH",
+    #         toSymbol: "BTC",
+    #         volume24h: 978200.2198323006,
+    #         volume24hTo: 77883.06190085363
+    #       },
+    #       ...
+    #     ]
+    #   }
+    def self.find(from_sym, opts = {})
+      full_path = API_URL + "?fsym=#{from_sym}"
+      full_path += "&limit=#{opts['limit']}" if opts['limit']
+      api_resp = Faraday.get(full_path)
+      JSON.parse(api_resp.body)
+    end
+  end
+end

data/lib/cryptocompare/version.rb

@@ -1,3 +1,3 @@
 module Cryptocompare
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptocompare
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Alexander David Pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,8 +128,10 @@ files:
 - cryptocompare.gemspec
 - lib/cryptocompare.rb
 - lib/cryptocompare/coin_snapshot.rb
+- lib/cryptocompare/helpers/exchange_name_helper.rb
 - lib/cryptocompare/price.rb
 - lib/cryptocompare/price_historical.rb
+- lib/cryptocompare/top_pairs.rb
 - lib/cryptocompare/version.rb
 homepage: https://github.com/alexanderdavidpan/cryptocompare
 licenses: