cryptocompare 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d00d76f9c9a92203e67633a4d76831db01273259
-  data.tar.gz: c9bd0a4255153b1f2760021c9e7f654cb4dfaa3c
+  metadata.gz: 5904d15aafe69b345265133262f61f2644155957
+  data.tar.gz: 2e2aefc132bc419487894755aec41b4abf695fd3
 SHA512:
-  metadata.gz: 906225c0c70ffec0e8ccfdafad3be6808c39720dc06277a38f14097ea94c53ccd8779e06f2fc53a668a903dff228bfdbbfb1168a9b6249bc90d48c7082fc3266
-  data.tar.gz: ac27297ecb113ee31a83eb1767a47e6be39fc9f3b348c58bc8ce9c399a8a7c06f625831d1aa2515e6c995226b927a13ac11ac9454d550483435557eb2315e8b6
+  metadata.gz: 0ab351322c5f2a7044c451fb580d90bcb7e560de42c78d0c6df6d5104784256e2fca5b0a2fc94698ef9e1cd3fe0792e65aa8a1a67379a11f91697c5d4b017487
+  data.tar.gz: e8b84aa64788c9810f1ba7668497811f8c29c4c8df01c1d5b37bfd905e3e3627165adc87efeb68c65efc4a62ca7024e0356702482797cd37b2572ae66485d370

data/.travis.yml

@@ -3,3 +3,9 @@ language: ruby
 rvm:
   - 2.0.0
 before_install: gem install bundler -v 1.12.5
+addons:
+  code_climate:
+    repo_token: 69656235648d9fc861fdb7a11a06cf1481e3aae42c8381873f1b72341bdeac6c
+# regular test configuration
+after_success:
+  - bundle exec codeclimate-test-reporter

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cryptocompare.gemspec
 gemspec
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end

data/README.md

@@ -67,7 +67,7 @@ Convert multiple cryptocurrencies to multiple fiat.
 
 ```ruby
 Cryptocompare::Price.find(['BTC','ETH', 'LTC'], ['USD', 'EUR', 'CNY'])
- # => {"BTC"=>{"USD"=>2501.61, "EUR"=>2197.04, "CNY"=>17329.48}, "ETH"=>{"USD"=>236.59, "EUR"=>209.39, "CNY"=>1655.15}, "LTC"=>{"USD"=>45.74, "EUR"=>40.33, "CNY"=>310.5}}
+# => {"BTC"=>{"USD"=>2501.61, "EUR"=>2197.04, "CNY"=>17329.48}, "ETH"=>{"USD"=>236.59, "EUR"=>209.39, "CNY"=>1655.15}, "LTC"=>{"USD"=>45.74, "EUR"=>40.33, "CNY"=>310.5}}
 ```
 
 Convert multiple fiat to multiple cryptocurrencies.
@@ -249,6 +249,51 @@ Cryptocompare::HistoMinute.find('BTC', 'USD')
 # }
 ```
 
+### HistoHour
+
+Get open, high, low, close, volumefrom and volumeto from the each hour historical data. It uses BTC conversion if data is not available because the coin is not trading in the specified currency.
+
+**Examples:**
+
+Find historical data by hour for BTC to USD.
+
+```ruby
+Cryptocompare::HistoHour.find('BTC', 'USD')
+# => {
+#   Response: "Success",
+#   Type: 100,
+#   Aggregated: false,
+#     Data: [
+#     {
+#       time: 1502259120,
+#       close: 3396.44,
+#       high: 3397.63,
+#       low: 3396.34,
+#       open: 3397.39,
+#       volumefrom: 98.2,
+#       volumeto: 335485
+#     },
+#     {
+#       time: 1502259300,
+#       close: 3396.86,
+#       high: 3396.94,
+#       low: 3396.44,
+#       open: 3396.44,
+#       volumefrom: 16.581031,
+#       volumeto: 56637.869999999995
+#     },
+#     ...
+#   ],
+#   TimeTo: 1503248400,
+#   TimeFrom: 1502643600,
+#   FirstValueInArray: true,
+#   ConversionType: {
+#     type: "direct",
+#     conversionSymbol: ""
+#   }
+# }
+```
+
 ## Supported Exchanges
 
 * BTC38

data/config/query_param_mapping.yml

@@ -0,0 +1,12 @@
+# Mapping of cryptocompare gem parameters to CryptoCompare API query parameters
+agg: aggregate
+all_data: allData
+e: e
+from_sym: fsym
+from_syms: fsyms
+limit: limit
+tc: tryConversion
+to_sym: tsym
+to_syms: tsyms
+to_ts: toTs
+ts: ts

data/lib/cryptocompare.rb

@@ -1,10 +1,10 @@
 require_relative "cryptocompare/version"
 require_relative "cryptocompare/coin_snapshot"
-require_relative "cryptocompare/histo_day"
 require_relative "cryptocompare/histo_hour"
 require_relative "cryptocompare/histo_minute"
 require_relative "cryptocompare/price"
 require_relative "cryptocompare/price_historical"
+require_relative "cryptocompare/helpers/query_param_helper"
 require_relative "cryptocompare/top_pairs"
 
 module Cryptocompare

data/lib/cryptocompare/coin_snapshot.rb

@@ -78,7 +78,12 @@ module Cryptocompare
     #     }
     #   }
     def self.find(from_sym, to_sym)
-      full_path = API_URL + "?fsym=#{from_sym}&tsym=#{to_sym}"
+      params = {
+        'from_sym' => from_sym,
+        'to_sym'   => to_sym
+      }
+
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end

data/lib/cryptocompare/helpers/exchange_name_helper.rb

@@ -1,12 +1,14 @@
 require 'yaml'
 
 # Helper module for exchange names.
-module ExchangeNameHelper
-  EXCHANGES = YAML::load_file(File.join(__dir__, '../../../config/exchanges.yml'))
+module Cryptocompare
+  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
+    # 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/helpers/query_param_helper.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+require_relative 'exchange_name_helper'
+
+# Helper module for setting query params.
+module Cryptocompare
+  module QueryParamHelper
+    QUERY_PARAM_MAPPING = YAML::load_file(File.join(__dir__, '../../../config/query_param_mapping.yml'))
+
+    # Appends query parameters to path
+    def self.set_query_params(path, opts)
+      path + "?#{to_query(opts)}"
+    end
+
+    # Helper method to parse parameters and build query parameters
+    def self.to_query(opts)
+      opts.collect do |key, value|
+        value = ExchangeNameHelper.set_exchange(value) if key == 'e'
+        "#{QUERY_PARAM_MAPPING[key]}=#{value}"
+      end.sort * '&'
+    end
+  end
+end

data/lib/cryptocompare/histo_hour.rb

@@ -0,0 +1,82 @@
+require 'faraday'
+require 'json'
+
+module Cryptocompare
+  module HistoHour
+    API_URL = 'https://min-api.cryptocompare.com/data/histohour'
+
+    # Get open, high, low, close, volumefrom and volumeto from the each hour
+    # historical data. It uses BTC conversion if data is not available because
+    # the coin is not trading in the specified currency.
+    #
+    # ==== Parameters
+    #
+    # * +from_sym+  [String]           - (required) currency symbol (ex: 'BTC', 'ETH', 'LTC', 'USD', 'EUR', 'CNY')
+    # * +to_syms+   [String, Array]    - (required) currency symbol(s)  (ex: 'USD', 'EUR', 'CNY', 'USD', 'EUR', 'CNY')
+    # * +opts+      [Hash]             - (optional) options hash
+    #
+    # ==== Options
+    #
+    # * +e+         [String]           - (optional) name of exchange (ex: 'Coinbase','Poloniex') Default: CCCAGG.
+    # * +limit+     [Integer]          - (optional) limit. Default 168. Max 2000. Must be positive integer. Returns limit + 1 data points.
+    # * +agg+       [Integer]          - (optional) number of data points to aggregate. Default 1.
+    # * +to_ts+     [Integer]          - (optional) timestamp. Use the timestamp option to set a historical start point. By default, it gets historical data for the past several hours.
+    # * +tc+        [Boolean]          - (optional) try conversion. Default true. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion.
+    #
+    # ==== Returns
+    #
+    # [Hash] Returns a hash containing data as an array of hashes containing
+    #        info such as open, high, low, close, volumefrom and volumeto for
+    #        each hour.
+    #
+    # ==== Examples
+    #
+    #   Cryptocompare::HistoHour.find('BTC', 'USD')
+    #
+    # Sample response
+    #
+    #   {
+    #     Response: "Success",
+    #     Type: 100,
+    #     Aggregated: false,
+    #     Data: [
+    #       {
+    #         time: 1502643600,
+    #         close: 3998.47,
+    #         high: 4069.8,
+    #         low: 3982.5,
+    #         open: 4059.28,
+    #         volumefrom: 5087.23,
+    #         volumeto: 20453919.02
+    #       },
+    #       {
+    #         time: 1502647200,
+    #         close: 4061.5,
+    #         high: 4074.57,
+    #         low: 3998.47,
+    #         open: 3998.47,
+    #         volumefrom: 3839.78,
+    #         volumeto: 15606476.19
+    #       },
+    #       ...
+    #     ],
+    #     TimeTo: 1503248400,
+    #     TimeFrom: 1502643600,
+    #     FirstValueInArray: true,
+    #     ConversionType: {
+    #       type: "direct",
+    #       conversionSymbol: ""
+    #     }
+    #   }
+    def self.find(from_sym, to_sym, opts = {})
+      params = {
+        'from_sym' => from_sym,
+        'to_sym' => to_sym
+      }.merge!(opts)
+
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
+      api_resp = Faraday.get(full_path)
+      JSON.parse(api_resp.body)
+    end
+  end
+end

data/lib/cryptocompare/histo_minute.rb

@@ -1,11 +1,8 @@
 require 'faraday'
 require 'json'
-require_relative 'helpers/exchange_name_helper'
 
 module Cryptocompare
   module HistoMinute
-    extend ExchangeNameHelper
-
     API_URL = 'https://min-api.cryptocompare.com/data/histominute'
 
     # Get open, high, low, close, volumefrom and volumeto for each minute of
@@ -39,6 +36,8 @@ module Cryptocompare
     #
     #   Cryptocompare::HistoMinute.find('BTC', 'USD')
     #
+    # Sample response
+    #
     #   {
     #     Response: "Success",
     #     Type: 100,
@@ -73,28 +72,12 @@ module Cryptocompare
     #     }
     #   }
     def self.find(from_sym, to_sym, opts = {})
-      full_path = API_URL + "?fsym=#{from_sym}&tsym=#{to_sym}"
-
-      if (exchange = opts['e'])
-        full_path += "&e=#{ExchangeNameHelper.set_exchange(exchange)}"
-      end
-
-      if (limit = opts['limit'])
-        full_path += "&limit=#{limit}"
-      end
-
-      if (agg = opts['agg'])
-        full_path += "&aggregate=#{agg}"
-      end
-
-      if (to_ts = opts['to_ts'])
-        full_path += "&toTs=#{to_ts}"
-      end
-
-      if (opts['tc'] == false)
-        full_path += "&tryConversion=false"
-      end
+      params = {
+        'from_sym' => from_sym,
+        'to_sym' => to_sym
+      }.merge!(opts)
 
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end

data/lib/cryptocompare/price.rb

@@ -1,11 +1,8 @@
 require 'faraday'
 require 'json'
-require_relative 'helpers/exchange_name_helper'
 
 module Cryptocompare
   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,12 +59,12 @@ module Cryptocompare
     #   Cryptocompare::Price.find('DASH', 'USD', {'e' => 'Kraken'})
     #   #=> {"DASH"=>{"USD"=>152.4}}
     def self.find(from_syms, to_syms, opts = {})
-      fsyms = Array(from_syms).join(',')
-      tsyms = Array(to_syms).join(',')
-      full_path = API_URL + "?fsyms=#{fsyms}&tsyms=#{tsyms}"
-      if (exchange = opts['e'])
-        full_path += "&e=#{ExchangeNameHelper.set_exchange(exchange)}"
-      end
+      params = {
+        'from_syms' => Array(from_syms).join(','),
+        'to_syms' => Array(to_syms).join(',')
+      }.merge!(opts)
+
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end

data/lib/cryptocompare/price_historical.rb

@@ -44,9 +44,12 @@ module Cryptocompare
     #   Cryptocompare::PriceHistorical.find('ETH', ['BTC', 'USD', 'EUR'], {'ts' => '1452680400'})
     #   #=> {"ETH"=>{"BTC"=>0.08006, "USD"=>225.93, "EUR"=>194.24}}
     def self.find(from_sym, to_syms, opts = {})
-      tsyms = Array(to_syms).join(',')
-      full_path = API_URL + "?fsym=#{from_sym}&tsyms=#{tsyms}"
-      full_path += "&ts=#{opts['ts']}" if opts['ts']
+      params = {
+        'from_sym' => from_sym,
+        'to_syms'  => Array(to_syms).join(',')
+      }.merge!(opts)
+
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end

data/lib/cryptocompare/top_pairs.rb

@@ -52,8 +52,11 @@ module Cryptocompare
     #     ]
     #   }
     def self.find(from_sym, opts = {})
-      full_path = API_URL + "?fsym=#{from_sym}"
-      full_path += "&limit=#{opts['limit']}" if opts['limit']
+      params = {
+        'from_sym' => from_sym
+      }.merge!(opts)
+
+      full_path = QueryParamHelper.set_query_params(API_URL, params)
       api_resp = Faraday.get(full_path)
       JSON.parse(api_resp.body)
     end

data/lib/cryptocompare/version.rb

@@ -1,3 +1,3 @@
 module Cryptocompare
-  VERSION = "0.6.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptocompare
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Alexander David Pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-14 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,10 +125,13 @@ files:
 - bin/console
 - bin/setup
 - config/exchanges.yml
+- config/query_param_mapping.yml
 - cryptocompare.gemspec
 - lib/cryptocompare.rb
 - lib/cryptocompare/coin_snapshot.rb
 - lib/cryptocompare/helpers/exchange_name_helper.rb
+- lib/cryptocompare/helpers/query_param_helper.rb
+- lib/cryptocompare/histo_hour.rb
 - lib/cryptocompare/histo_minute.rb
 - lib/cryptocompare/price.rb
 - lib/cryptocompare/price_historical.rb
@@ -155,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for communicating with the CryptoCompare API