cointools 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2f4474de548a07499b33a25f0f60645b990ec1e
-  data.tar.gz: c73eef132777ced15047f894fa38ad886758ed6f
+  metadata.gz: ae9c00c6df51d228fb5d401f849d963ff2c05dfb
+  data.tar.gz: cd3ed48eb9317db5d26085f8fc0059f9788a9759
 SHA512:
-  metadata.gz: ac701c46dd60b43b2311fbf572a444ec4bbf9131681e7a0edeb53a5f8ad441329ccbe214f809ec05e16813fb030f75c610e3331500e5e344691a9030cbdfd767
-  data.tar.gz: eec97b9cce9ae49995723a00cf1da3bfe65d0296e8015ac3df2703152687d38780e1a186544b813a996048313d6302306f3886cfa662b9fdeddc8e3c63e23bb6
+  metadata.gz: dcb355f0ce41f2d570425c974e91fc20510073d214c574ace8009b37a0d4fe2fc07f4fa6360e5081cfa9a96a56e76eac1ee9778e08bc24e6354bc5a31e716d38
+  data.tar.gz: 2ea61e0a5f07649ea6592b0a003058de5d4c2bedbf2f8d7d37f3aba4bc7ba040479f9747a18e52bc9f36c40c087b951c490b29d3d90af838bd97616416c58499

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+#### Version 0.2.0 (29.01.2018)
+
+* added CoinMarketCap class & coinmcap binary
+
+#### Version 0.1.2 (24.01.2018)
+
+* fixed --help command
+
+#### Version 0.1.1 (24.01.2018)
+
+* first working release

data/README.md

@@ -1,6 +1,6 @@
 # Cointools
 
-This is a collection of Ruby scripts and library classes that let you check cryptocurrency prices on various services (currently Cryptowatch).
+This is a collection of Ruby scripts and library classes that let you check cryptocurrency prices on various services.
 
 ## Installation
 
@@ -16,9 +16,7 @@ To use the code as a library, add it to your Gemfile:
 gem 'cointools'
 ```
 
-## Usage
-
-### [Cryptowatch](https://cryptowat.ch)
+## [Cryptowatch](https://cryptowat.ch)
 
 To check past price of a given coin on a chosen exchange, pass the exchange and market name and a properly formatted timestamp:
 
@@ -42,7 +40,7 @@ cryptowatch --list-markets bithumb
 In code:
 
 ```ruby
-require 'cointools'
+require 'cointools'  # or 'cointools/cryptowatch'
 cryptowatch = CoinTools::Cryptowatch.new
 
 exchange = cryptowatch.exchanges.first
@@ -60,6 +58,55 @@ puts "#{market} today: #{result.price}"
 The result object contains the requested price and (for historical prices) the actual timestamp of the found price, which might slightly differ from the timestamp passed in the argument (the earlier the date, the less precise the result).
 
 
+## [CoinMarketCap](https://coinmarketcap.com)
+
+CoinMarketCap's API only returns current coin prices. To look up a coin's price, you need to pass its name as used on CoinMarketCap:
+
+```
+coinmcap power-ledger
+```
+
+Alternatively, you can pass the cryptocurrency's symbol using the `-s` or `--symbol` parameter:
+
+```
+coinmcap -s powr
+```
+
+However, this operation needs to download a complete ticker for all currencies and scan through the list, so it's recommended to use the name as in the example above.
+
+You can also use the `-b` or `--btc-price` flag to request a price in BTC instead of USD:
+
+```
+coinmcap power-ledger -b
+```
+
+Or you can request the price in one of the ~30 other supported fiat currencies with `-f` or `--fiat-currency`:
+
+```
+coinmcap request-network -fEUR
+```
+
+You can print a list of supported fiat currencies with `coinmcap --list-fiat-currencies`.
+
+Same things in code:
+
+```ruby
+require 'cointools'  # or 'cointools/coinmarketcap'
+cmc = CoinTools::CoinMarketCap.new
+
+p CoinTools::CoinMarketCap::FIAT_CURRENCIES
+
+ltc = cryptowatch.get_price('litecoin')
+puts "LTC: #{ltc.usd_price} USD / #{ltc.btc_price} BTC"
+
+xmr = cryptowatch.get_price_by_symbol('xmr')
+puts "XMR: #{xmr.usd_price} USD / #{xmr.btc_price} BTC"
+
+eth = cryptowatch.get_price('ethereum', convert_to: 'EUR')
+puts "ETH: #{eth.converted_price} EUR"
+```
+
+
 ## Credits & contributing
 
 Copyright © 2018 [Kuba Suder](https://mackuba.eu). Licensed under [Very Simple Public License](https://github.com/mackuba/cointools/blob/master/VSPL-LICENSE.txt), my custom license that's basically a simplified version of the MIT license that fits in 3 lines.

data/bin/coinmcap

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cointools'
+
+require 'optparse'
+require 'time'
+
+def print_help
+  puts "Usage: #{$PROGRAM_NAME} <coin_name> [-b/--btc-price] [-fXXX/--fiat-currency XXX] [-v/--verbose]"
+  puts " e.g.: #{$PROGRAM_NAME} litecoin"
+  puts
+  puts "* To look up the currency by symbol instead of name (slower, downloads more data):"
+  puts "       #{$PROGRAM_NAME} -s/--symbol <symbol> [-b/--btc-price] [-fXXX/--fiat-currency XXX] [-v/--verbose]"
+  puts " e.g.: #{$PROGRAM_NAME} -s LTC"
+  puts
+  puts "* To list supported fiat currencies:"
+  puts "       #{$PROGRAM_NAME} --list-fiat-currences"
+  puts
+  puts "* -b / --btc-price: returns the coin's price in BTC instead of USD"
+  puts "* -fEUR / --fiat-currency EUR: returns the price in a given fiat currency instead of USD"
+end
+
+verbose = false
+btc_price = false
+fiat_currency = nil
+symbol = nil
+
+OptionParser.new do |opts|
+  opts.on('-v', '--verbose') { verbose = true }
+  opts.on('-b', '--btc-price') { btc_price = true }
+  opts.on('-fXXX', '--fiat-currency XXX') { |f| fiat_currency = f }
+
+  opts.on('--list-fiat-currencies') do
+    puts CoinTools::CoinMarketCap::FIAT_CURRENCIES
+    exit 0
+  end
+
+  opts.on('-h', '--help') do
+    print_help
+    exit 0
+  end
+
+  opts.on('-sSYMBOL', '--symbol SYMBOL') { |s| symbol = s }
+
+  opts.parse!
+end
+
+unless symbol
+  if ARGV.length != 1
+    print_help
+    exit 1
+  end
+
+  coin_name = ARGV[0].downcase
+end
+
+if fiat_currency && btc_price
+  puts "#{$PROGRAM_NAME}: --btc-price and --fiat-currency options cannot be used together"
+  exit 2
+end
+
+begin
+  if symbol
+    result = CoinTools::CoinMarketCap.new.get_price_by_symbol(symbol, convert_to: fiat_currency)
+  else
+    result = CoinTools::CoinMarketCap.new.get_price(coin_name, convert_to: fiat_currency)
+  end
+
+  if btc_price
+    price = result.btc_price
+    unit = 'BTC'
+  elsif fiat_currency
+    price = result.converted_price
+    unit = fiat_currency.upcase
+  else
+    price = result.usd_price
+    unit = 'USD'
+  end
+
+  if verbose
+    puts "#{symbol&.upcase || coin_name} @ #{result.time || Time.now} ==> #{price} #{unit}"
+    puts
+  else
+    puts price
+  end
+rescue CoinTools::CoinMarketCap::InvalidResponseException => e
+  $stderr.puts "Error: Incorrect coin name: #{coin_name} (#{e})"
+  exit 3
+rescue CoinTools::CoinMarketCap::NoDataException => e
+  $stderr.puts "Error: #{e}"
+  exit 4
+rescue CoinTools::CoinMarketCap::InvalidFiatCurrencyException => e
+  $stderr.puts "Error: Unsupported fiat currency: #{fiat_currency}"
+  exit 5
+end

data/bin/cryptowatch

@@ -66,7 +66,7 @@ rescue CoinTools::Cryptowatch::InvalidDateException => e
   $stderr.puts "Error: #{e}"
   exit 2
 rescue CoinTools::Cryptowatch::BadRequestException => e
-  $stderr.puts "Error: Incorrect exchange or market name: #{e}"
+  $stderr.puts "Error: Incorrect exchange or market name (#{e})"
   exit 3
 rescue CoinTools::Cryptowatch::NoDataException => e
   $stderr.puts "Error: #{e}: data not ready yet"

data/lib/cointools/coinmarketcap.rb

@@ -0,0 +1,135 @@
+require_relative 'version'
+
+require 'json'
+require 'net/http'
+require 'uri'
+
+module CoinTools
+  class CoinMarketCap
+    BASE_URL = "https://api.coinmarketcap.com"
+    USER_AGENT = "cointools/#{CoinTools::VERSION}"
+
+    FIAT_CURRENCIES = [
+      'AUD', 'BRL', 'CAD', 'CHF', 'CLP', 'CNY', 'CZK', 'DKK', 'EUR', 'GBP',
+      'HKD', 'HUF', 'IDR', 'ILS', 'INR', 'JPY', 'KRW', 'MXN', 'MYR', 'NOK',
+      'NZD', 'PHP', 'PKR', 'PLN', 'RUB', 'SEK', 'SGD', 'THB', 'TRY', 'TWD',
+      'ZAR'
+    ]
+
+    class DataPoint
+      attr_reader :time, :usd_price, :btc_price, :converted_price
+
+      def initialize(time, usd_price, btc_price, converted_price = nil)
+        @time = time
+        @usd_price = usd_price
+        @btc_price = btc_price
+        @converted_price = converted_price
+      end
+    end
+
+    class InvalidResponseException < StandardError
+      attr_reader :response
+
+      def initialize(response)
+        super("#{response.code} #{response.message}")
+        @response = response
+      end
+    end
+
+    class BadRequestException < InvalidResponseException
+    end
+
+    class NoDataException < StandardError
+    end
+
+    class InvalidFiatCurrencyException < StandardError
+    end
+
+    class InvalidDateException < StandardError
+    end
+
+    def get_price(coin_name, convert_to: nil)
+      url = URI("#{BASE_URL}/v1/ticker/#{coin_name}/")
+
+      if convert_to
+        validate_fiat_currency(convert_to)
+        url += "?convert=#{convert_to}"
+      end
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        record = json[0]
+
+        usd_price = record['price_usd']&.to_f
+        btc_price = record['price_btc']&.to_f
+        timestamp = Time.at(record['last_updated'].to_i)
+
+        if convert_to
+          converted_price = record["price_#{convert_to.downcase}"]&.to_f
+          raise NoDataException.new('Conversion to chosen fiat currency failed') if converted_price.nil?
+        end
+
+        return DataPoint.new(timestamp, usd_price, btc_price, converted_price)
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise InvalidResponseException.new(response)
+      end
+    end
+
+    def get_price_by_symbol(coin_symbol, convert_to: nil)
+      url = URI("#{BASE_URL}/v1/ticker/?limit=0")
+      symbol = coin_symbol.downcase
+
+      if convert_to
+        validate_fiat_currency(convert_to)
+        url += "&convert=#{convert_to}"
+      end
+
+      response = make_request(url)
+
+      case response
+      when Net::HTTPSuccess
+        json = JSON.load(response.body)
+        record = json.detect { |r| r['symbol'].downcase == symbol }
+        raise NoDataException.new('No coin found with given symbol') if record.nil?
+
+        usd_price = record['price_usd']&.to_f
+        btc_price = record['price_btc']&.to_f
+        timestamp = Time.at(record['last_updated'].to_i)
+
+        if convert_to
+          converted_price = record["price_#{convert_to.downcase}"]&.to_f
+          raise NoDataException.new('Conversion to chosen fiat currency failed') if converted_price.nil?
+        end
+
+        return DataPoint.new(timestamp, usd_price, btc_price, converted_price)
+      when Net::HTTPBadRequest
+        raise BadRequestException.new(response)
+      else
+        raise Exception.new(response)
+      end
+    end
+
+
+    private
+
+    def validate_fiat_currency(fiat_currency)
+      unless FIAT_CURRENCIES.include?(fiat_currency.upcase)
+        raise InvalidFiatCurrencyException
+      end
+    end
+
+    def make_request(url)
+      Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new(url)
+        request['User-Agent'] = USER_AGENT
+
+        http.request(request)
+      end
+    end
+  end
+end

data/lib/cointools/cryptowatch.rb

@@ -45,7 +45,7 @@ module CoinTools
       when Net::HTTPBadRequest
         raise BadRequestException.new(response)
       else
-        raise Exception.new(response)
+        raise InvalidResponseException.new(response)
       end
     end
 

data/lib/cointools/version.rb

@@ -1,3 +1,3 @@
 module CoinTools
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/cointools.rb

@@ -1,3 +1,4 @@
+require 'cointools/coinmarketcap'
 require 'cointools/cryptowatch'
 require 'cointools/version'
 

metadata

@@ -1,27 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: cointools
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kuba Suder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
 - jakub.suder@gmail.com
 executables:
 - cryptowatch
+- coinmcap
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - VSPL-LICENSE.txt
+- bin/coinmcap
 - bin/cryptowatch
 - lib/cointools.rb
+- lib/cointools/coinmarketcap.rb
 - lib/cointools/cryptowatch.rb
 - lib/cointools/version.rb
 homepage: https://github.com/mackuba/cointools
@@ -44,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A collection of scripts for checking cryptocurrency prices.