cryptocompare 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5904d15aafe69b345265133262f61f2644155957
-  data.tar.gz: 2e2aefc132bc419487894755aec41b4abf695fd3
+  metadata.gz: 3214abf1e4db6cdc7ad1b14fae33f48991f4b14c
+  data.tar.gz: 99daf1104f9a4e855d2972d50d735615d0f57b53
 SHA512:
-  metadata.gz: 0ab351322c5f2a7044c451fb580d90bcb7e560de42c78d0c6df6d5104784256e2fca5b0a2fc94698ef9e1cd3fe0792e65aa8a1a67379a11f91697c5d4b017487
-  data.tar.gz: e8b84aa64788c9810f1ba7668497811f8c29c4c8df01c1d5b37bfd905e3e3627165adc87efeb68c65efc4a62ca7024e0356702482797cd37b2572ae66485d370
+  metadata.gz: 10a42fc41ffe732ba377ca3246e41730cfab7bb27ac56feb893520b7b5b6ae63cb9ed14f6d624a10022e42b93c1e8864a154065c5279af5707e37f06a33c85c2
+  data.tar.gz: 1fc267b87ab24e42c4fc657e5928aa09557c5774a195e91e4bda933dd82ceb758a8c54083997e2d6a85c0c939467f5afb11a746522c1abc70fdbd63095d7e51e

data/.travis.yml

@@ -3,9 +3,3 @@ 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,8 +2,3 @@ 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

@@ -294,6 +294,51 @@ Cryptocompare::HistoHour.find('BTC', 'USD')
 # }
 ```
 
+### HistoDay
+
+Get open, high, low, close, volumefrom and volumeto daily historical data. The values are based on 00:00 GMT time. It uses BTC conversion if data is not available because the coin is not trading in the specified currency.
+
+**Examples:**
+
+Find historical data by day for BTC to USD.
+
+```ruby
+Cryptocompare::HistoDay.find('BTC', 'USD')
+# => {
+#   Response: "Success",
+#   Type: 100,
+#   Aggregated: false,
+#   Data: [
+#     {
+#       time: 1500854400,
+#       close: 2763.42,
+#       high: 2798.89,
+#       low: 2715.69,
+#       open: 2756.61,
+#       volumefrom: 83009.25,
+#       volumeto: 229047365.02
+#     },
+#     {
+#       time: 1500940800,
+#       close: 2582.58,
+#       high: 2779.08,
+#       low: 2472.62,
+#       open: 2763.42,
+#       volumefrom: 205883.15,
+#       volumeto: 534765380.75
+#     },
+#     ...
+#   ],
+#   TimeTo: 1503446400,
+#   TimeFrom: 1500854400,
+#   FirstValueInArray: true,
+#   ConversionType: {
+#     type: "direct",
+#     conversionSymbol: ""
+#   }
+# }
+```
+
 ## Supported Exchanges
 
 * BTC38

data/lib/cryptocompare.rb

@@ -1,5 +1,6 @@
 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"

data/lib/cryptocompare/histo_day.rb

@@ -0,0 +1,83 @@
+require 'faraday'
+require 'json'
+
+module Cryptocompare
+  module HistoDay
+    API_URL = 'https://min-api.cryptocompare.com/data/histoday'
+
+    # Get open, high, low, close, volumefrom and volumeto daily historical data.
+    # The values are based on 00:00 GMT time. 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 30. 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 days.
+    # * +tc+        [Boolean]          - (optional) try conversion. Default true. If the crypto does not trade directly into the toSymbol requested, BTC will be used for conversion.
+    # * +all_data+  [Boolean]          - (optional) all data. Default false. Returns all available data instead of limit.
+    #
+    # ==== 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 day.
+    #
+    # ==== Examples
+    #
+    #   Cryptocompare::HistoDay.find('BTC', 'USD')
+    #
+    # Sample response
+    #
+    #   {
+    #     Response: "Success",
+    #     Type: 100,
+    #     Aggregated: false,
+    #     Data: [
+    #       {
+    #         time: 1500854400,
+    #         close: 2763.42,
+    #         high: 2798.89,
+    #         low: 2715.69,
+    #         open: 2756.61,
+    #         volumefrom: 83009.25,
+    #         volumeto: 229047365.02
+    #       },
+    #       {
+    #         time: 1500940800,
+    #         close: 2582.58,
+    #         high: 2779.08,
+    #         low: 2472.62,
+    #         open: 2763.42,
+    #         volumefrom: 205883.15,
+    #         volumeto: 534765380.75
+    #       },
+    #       ...
+    #     ],
+    #     TimeTo: 1503446400,
+    #     TimeFrom: 1500854400,
+    #     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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cryptocompare
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Alexander David Pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-21 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -131,6 +131,7 @@ files:
 - lib/cryptocompare/coin_snapshot.rb
 - lib/cryptocompare/helpers/exchange_name_helper.rb
 - lib/cryptocompare/helpers/query_param_helper.rb
+- lib/cryptocompare/histo_day.rb
 - lib/cryptocompare/histo_hour.rb
 - lib/cryptocompare/histo_minute.rb
 - lib/cryptocompare/price.rb