cryptocompare 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f8133ee058822cc3531df3961de9889336dedd4
-  data.tar.gz: 3ead7fcfed5d1867b769fb0d3d6757cfb36cd440
+  metadata.gz: 58a7edd2c27081e3d18bd5a9c5f55bd4d6188ed1
+  data.tar.gz: 4d975e8065f816ebd0a4fd29a8fabcf01d62cb52
 SHA512:
-  metadata.gz: 4dae6daacfecec746cb2ae149d6f9dd4823dc8dfb765daf6bb547c08b42c5c660908295b3614fcba273e71eecacaefab3b89236bdd742bca6d52bef299395822
-  data.tar.gz: f1000a6478adb71a97c3b48bbc6e4da8a958d1dfba34d82fef3a4a17ab07b58398fd6db16d9150c736501c069be4851b846fbc447ee25769b9bc6c2b1ba38c19
+  metadata.gz: 407a2341f2489649265710af467979b09646cf1c3180c24e6fe69a535b7cc078571b8d40f74cd561d00a41f3e6d32c2a4d1d0de4406d2d9aeef3d071b23b5594
+  data.tar.gz: 2355645467ebc2f6f5f09ea8bbc484f553a3c72f2fc5dbac5c30583308164c8d2a9082bf6c078841016f3ca6fd9732c87f65a40f482e9f60e91f075258302ca7

data/.travis.yml

@@ -1,5 +1,5 @@
 sudo: false
 language: ruby
 rvm:
-  - 1.9.3
+  - 2.0.0
 before_install: gem install bundler -v 1.12.5

data/README.md

@@ -1,8 +1,9 @@
 # Cryptocompare
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cryptocompare`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/cryptocompare.svg)](http://badge.fury.io/rb/cryptocompare) [![Build Status](https://travis-ci.org/alexanderdavidpan/cryptocompare.svg)](https://travis-ci.org/alexanderdavidpan/cryptocompare)
 
-TODO: Delete this and the text above, and describe your gem
+
+This is a Ruby gem that utilizes the CryptoCompare API to fetch data related to cryptocurrencies.
 
 ## Installation
 
@@ -22,7 +23,121 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use Cryptocompare, just require it like so:
+
+```ruby
+require 'cryptocompare'
+```
+
+Examples:
+
+1. Cryptocurrency to Fiat
+
+```ruby
+Cryptocompare::Price.find('BTC', 'USD')
+# => {"BTC"=>{"USD"=>2594.07}}
+```
+
+2. Fiat to Cryptocurrency
+
+```ruby
+Cryptocompare::Price.find('USD', 'BTC')
+# => {"USD"=>{"BTC"=>0.0004176}}
+```
+3. Cryptocurrency to Cryptocurrency
+
+```ruby
+Cryptocompare::Price.find('BTC', 'ETH')
+# =>{"BTC"=>{"ETH"=>9.29}}
+```
+
+4. Fiat to Fiat
+
+```ruby
+Cryptocompare::Price.find('USD', 'EUR')
+# => {"USD"=>{"EUR"=>0.8772}}
+```
+
+5. 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}}
+```
+
+6. Multiple fiat to multiple cryptocurrencies
+
+```ruby
+Cryptocompare::Price.find(['USD', 'EUR'], ['BTC','ETH', 'LTC'])
+# => {"USD"=>{"BTC"=>0.0003996, "ETH"=>0.004238, "LTC"=>0.02184}, "EUR"=>{"BTC"=>0.0004548, "ETH"=>0.00477, "LTC"=>0.0248}}
+```
+
+7. Find prices based on exchange
+
+```ruby
+Cryptocompare::Price.find('DASH', 'USD', {'e' => 'Kraken'})
+# => {"DASH"=>{"USD"=>152.4}}
+```
+
+## Supported Exchanges
+
+* BTC38
+* BTCC
+* BTCE
+* BTCMarkets
+* BTCXIndia
+* BTER
+* Bit2C
+* BitBay
+* bitFlyer
+* bitFlyerFX
+* BitMarket
+* BitSquare
+* Bitfinex
+* Bitso
+* Bitstamp
+* Bittrex
+* Bleutrade
+* CCEDK
+* Cexio
+* CoinCheck
+* Coinbase
+* Coinfloor
+* Coinone
+* Coinse
+* Coinsetter
+* Cryptopia
+* Cryptsy
+* EtherDelta
+* EthexIndia
+* Gatecoin
+* Gemini
+* HitBTC
+* Huobi
+* itBit
+* Korbit
+* Kraken
+* LakeBTC
+* Liqui
+* LiveCoin
+* LocalBitcoins
+* Luno
+* MercadoBitcoin
+* MonetaGo
+* OKCoin
+* Paymium
+* Poloniex
+* QuadrigaCX
+* Quoine
+* TheRockTrading
+* Tidex
+* Unocoin
+* Vaultoro
+* Yacuna
+* Yobit
+* Yunbi
+
+If no exchange option is specified, then the default 'CCCAGG' is used. This is cryptocompare's aggregated data.
 
 ## Development
 
@@ -32,10 +147,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cryptocompare. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/alexanderdavidpan/cryptocompare. 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.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
 task :default => :test

data/config/exchanges.yml

@@ -0,0 +1,55 @@
+BTC38: BTC38
+BTCC: BTCC
+BTCE: BTCE
+BTCMARKETS: BTCMarkets
+BTCXINDIA: BTCXIndia
+BTER: BTER
+BIT2C: Bit2C
+BITBAY: BitBay
+BITFLYER: bitFlyer
+BITFLYERFX: bitFlyerFX
+BITMARKET: BitMarket
+BITSQUARE: BitSquare
+BITFINEX: Bitfinex
+BITSO: Bitso
+BITSTAMP: Bitstamp
+BITTREX: Bittrex
+BLEUTRADE: Bleutrade
+CCEDK: CCEDK
+CEXIO: Cexio
+COINCHECK: CoinCheck
+COINBASE: Coinbase
+COINFLOOR: Coinfloor
+COINONE: Coinone
+COINSE: Coinse
+COINSETTER: Coinsetter
+CRYPTOPIA: Cryptopia
+CRYPTSY: Cryptsy
+ETHERDELTA: EtherDelta
+ETHEXINDIA: EthexIndia
+GATECOIN: Gatecoin
+GEMINI: Gemini
+HITBTC: HitBTC
+HUOBI: Huobi
+ITBIT: itBit
+KORBIT: Korbit
+KRAKEN: Kraken
+LAKEBTC: LakeBTC
+LIQUI: Liqui
+LIVECOIN: LiveCoin
+LOCALBITCOINS: LocalBitcoins
+LUNO: Luno
+MERCADOBITCOIN: MercadoBitcoin
+MONETAGO: MonetaGo
+OKCOIN: OKCoin
+PAYMIUM: Paymium
+POLONIEX: Poloniex
+QUADRIGACX: QuadrigaCX
+QUOINE: Quoine
+THEROCKTRADING: TheRockTrading
+TIDEX: Tidex
+UNOCOIN: Unocoin
+VAULTORO: Vaultoro
+YACUNA: Yacuna
+YOBIT: Yobit
+YUNBI: Yunbi

data/lib/cryptocompare.rb

@@ -2,5 +2,4 @@ require "cryptocompare/version"
 require_relative "cryptocompare/price"
 
 module Cryptocompare
-  # Your code goes here...
 end

data/lib/cryptocompare/price.rb

@@ -1,8 +1,10 @@
 require 'faraday'
 require 'json'
+require 'yaml'
 
 module Cryptocompare
   API_URL = 'https://min-api.cryptocompare.com/data/pricemulti'
+  EXCHANGES = YAML::load_file(File.join(__dir__, '../../config/exchanges.yml'))
 
   module Price
     # Finds the currency price(s) of a given currency symbol
@@ -10,6 +12,8 @@ module Cryptocompare
     # Params:
     # from_syms [String, Array] - currency symbols  (ex: 'BTC', 'ETH', 'LTC', 'USD', 'EUR', 'CNY')
     # to_syms   [String, Array] - currency symbols  (ex: 'USD', 'EUR', 'CNY', 'USD', 'EUR', 'CNY')
+    # opts      [Hash] - Options hash
+    # opts[e]   [String] - name of exchange (ex: 'Coinbase','Poloniex') Default: CCCAGG.
     #
     # Returns:
     # [Hash] Hash with currency prices
@@ -33,12 +37,34 @@ module Cryptocompare
     # 4. Fiat to Fiat
     # Cryptocompare::Price.find('USD', 'EUR')
     # => {"USD"=>{"EUR"=>0.8772}}
-    def self.find(from_syms, to_syms)
+    #
+    # 5. Multiple cryptocurrencies to multiple fiat
+    # 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}}
+    #
+    # 6. Multiple fiat to multiple cryptocurrencies
+    # Cryptocompare::Price.find(['USD', 'EUR'], ['BTC','ETH', 'LTC'])
+    # => {"USD"=>{"BTC"=>0.0003996, "ETH"=>0.004238, "LTC"=>0.02184}, "EUR"=>{"BTC"=>0.0004548, "ETH"=>0.00477, "LTC"=>0.0248}}
+    #
+    # 7. Find prices based on exchange
+    # 
+    # 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}"
+      full_path += "&e=#{set_exchange(opts['e'])}" if opts['e']
       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/version.rb

@@ -1,3 +1,3 @@
 module Cryptocompare
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: cryptocompare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander David Pan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-08 00:00:00.000000000 Z
+date: 2017-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby gem for communicating with the CryptoCompare API
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -124,6 +124,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/exchanges.yml
 - cryptocompare.gemspec
 - lib/cryptocompare.rb
 - lib/cryptocompare/price.rb
@@ -139,17 +140,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Ruby gem for communicating with the CryptoCompare API