cryptocompare 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ac9166226c481cf02e4943f7ff9d340fad3102d
-  data.tar.gz: 2bed9e8d7c43a11b55bef587e08d3b505911154d
+  metadata.gz: d00d76f9c9a92203e67633a4d76831db01273259
+  data.tar.gz: c9bd0a4255153b1f2760021c9e7f654cb4dfaa3c
 SHA512:
-  metadata.gz: ddf5f8016df804ec197f96604609b615e1773bb61f4c3334e33400ce6d32bc4f48ab6030a4b01ceabd788024628d94593ba935728eaa7df935de34dccab95333
-  data.tar.gz: 0bb7317bf99b124a0f0944e5365cfbbaf20526c195f94b7a8feb3451f4c6b9947909867721b622e06c691a6bd71b86582f4709d022f06d7bf80e6d100adc904f
+  metadata.gz: 906225c0c70ffec0e8ccfdafad3be6808c39720dc06277a38f14097ea94c53ccd8779e06f2fc53a668a903dff228bfdbbfb1168a9b6249bc90d48c7082fc3266
+  data.tar.gz: ac27297ecb113ee31a83eb1767a47e6be39fc9f3b348c58bc8ce9c399a8a7c06f625831d1aa2515e6c995226b927a13ac11ac9454d550483435557eb2315e8b6

data/README.md

@@ -204,6 +204,51 @@ Cryptocompare::TopPairs.find('ETH')
 # }
 ```
 
+### HistoMinute
+
+Get open, high, low, close, volumefrom and volumeto for each minute of historical data. This data is only stored for 7 days, if you need more, use the hourly or daily path. It uses BTC conversion if data is not available because the coin is not trading in the specified currency.
+
+**Examples:**
+
+Find historical data by minute for BTC to USD.
+
+```ruby
+Cryptocompare::HistoMinute.find('BTC', 'USD')
+# => {
+#   Response: "Success",
+#   Type: 100,
+#   Aggregated: true,
+#   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: 1502259360,
+#   TimeFrom: 1502259120,
+#   FirstValueInArray: true,
+#   ConversionType: {
+#     type: "direct",
+#     conversionSymbol: ""
+#   }
+# }
+```
+
 ## Supported Exchanges
 
 * BTC38

data/lib/cryptocompare.rb

@@ -1,5 +1,8 @@
 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/top_pairs"

data/lib/cryptocompare/coin_snapshot.rb

@@ -10,10 +10,12 @@ module Cryptocompare
     # available.
     #
     # ==== Parameters
+    #
     # * +from_sym+  [String]  - (required) currency symbol (ex: 'BTC', 'ETH', 'LTC', 'USD', 'EUR', 'CNY')
     # * +to_sym+    [String]  - (required) currency symbol (ex: 'USD', 'EUR', 'CNY', 'USD', 'EUR', 'CNY')
     #
     # ==== Returns
+    #
     # [Hash] Hash with data about given currency pair.
     #
     # ==== Example

data/lib/cryptocompare/histo_minute.rb

@@ -0,0 +1,102 @@
+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
+    # historical data. This data is only stored for 7 days, if you need more,
+    # use the hourly or daily path. 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 1440. 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 minutes.
+    # * +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 minute.
+    #
+    # ==== Examples
+    #
+    # Find historical data by minute for BTC to USD.
+    #
+    #   Cryptocompare::HistoMinute.find('BTC', 'USD')
+    #
+    #   {
+    #     Response: "Success",
+    #     Type: 100,
+    #     Aggregated: true,
+    #     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: 1502259360,
+    #     TimeFrom: 1502259120,
+    #     FirstValueInArray: true,
+    #     ConversionType: {
+    #       type: "direct",
+    #       conversionSymbol: ""
+    #     }
+    #   }
+    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
+
+      api_resp = Faraday.get(full_path)
+      JSON.parse(api_resp.body)
+    end
+  end
+end

data/lib/cryptocompare/price.rb

@@ -12,14 +12,17 @@ module Cryptocompare
     # 20-60 ms. Cached each 10 seconds.
     #
     # ==== Parameters
+    #
     # * +from_syms+ [String, Array] - (required) currency symbols  (ex: 'BTC', 'ETH', 'LTC', 'USD', 'EUR', 'CNY')
     # * +to_syms+   [String, Array] - (required) currency symbols  (ex: 'USD', 'EUR', 'CNY', 'USD', 'EUR', 'CNY')
     # * +opts+      [Hash]          - (optional) options hash
     #
     # ==== Options
+    #
     # * +e+         [String]        - (optional) name of exchange (ex: 'Coinbase','Poloniex') Default: CCCAGG.
     #
     # ==== Returns
+    #
     # [Hash] Hash with currency prices
     #
     # ==== Examples

data/lib/cryptocompare/price_historical.rb

@@ -20,9 +20,11 @@ module Cryptocompare
     # * +opts+      [Hash]             - (optional) options hash
     #
     # ==== Options
+    #
     # * +ts+        [String, Integer]  - (optional) timestamp
     #
     # ==== Returns
+    #
     # [Hash] Hash with currency prices
     #
     # ==== Examples

data/lib/cryptocompare/top_pairs.rb

@@ -15,9 +15,11 @@ module Cryptocompare
     # * +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.
     #

data/lib/cryptocompare/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptocompare
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alexander David Pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,7 @@ files:
 - lib/cryptocompare.rb
 - lib/cryptocompare/coin_snapshot.rb
 - lib/cryptocompare/helpers/exchange_name_helper.rb
+- lib/cryptocompare/histo_minute.rb
 - lib/cryptocompare/price.rb
 - lib/cryptocompare/price_historical.rb
 - lib/cryptocompare/top_pairs.rb
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for communicating with the CryptoCompare API