coincapper 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51ccb6a048494876bbd683964f0f0f81f73faff6
-  data.tar.gz: 8c943acf1733761424d552fc601a60b72822acdf
+  metadata.gz: 48cf58727f9ab2527e3172010e0b48d28d1c0591
+  data.tar.gz: 05a4c2a9a90b9fbb2ec76e2b9302f16f8cae56c0
 SHA512:
-  metadata.gz: 84959ca7d3e1dd8dc743b4e24b70b08a91702db3567342a59c4f7262c67ed4dd1dcf5c002cc56fa3c29983759c44e9abe174801b389dce7a84ea976c99387dc0
-  data.tar.gz: 910a35423289d094763ee017a632988e2cb9e422632cf44df0c297e4cd2cb840d4a861038cab592e58e6f60c6863ffb959ba13f617a2f05623a1853be45b8dc7
+  metadata.gz: 4515cdf093bdb3d2d34f47f7c4a9f82e989d12ea051643bb88e34bfc04aecd454e74c3d3a656881a8a7f2b966fc73655d9a7750567361529c3c386112d0c59e9
+  data.tar.gz: e956f186176adb955921aafde496ba271a66b85b9dfcb5ff42def6330ffbcc9469b4ba603c159ce70ebdcd8d64e84213c8821c159f20bc19d617f3fc418f24ee

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 coverage/*
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Ankit Samarthya
+Copyright (c) 2017
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,14 +2,14 @@
 
 # CoinCapper
 
-Rub gem that provides a wrapper to the public coinmarketcap.com V1 API.
+An API wrapper to the V1 coinmarketcap.com public API with additional historic, symbol, and market functionality.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'coincapper', git: 'https://github.com/kurt-smith/coincapper', branch: 'master'
+gem 'coincapper', '~> 1.0'
 ```
 
 And then execute:
@@ -30,7 +30,7 @@ Or install it yourself as:
 CoinCapper.coins(limit: 0, rank:  nil, currency: nil)
 ```
 
-#### Coin by Coin Market Cap ID
+#### Coin by CoinMarketCap ID
 
 ```ruby
 CoinCapper.coin('litecoin', currency: nil)
@@ -48,18 +48,80 @@ CoinCapper.global(currency: nil)
 
 ```ruby
 CoinCapper.coin_by_symbol('FUN')
+
+=> {:id=>"funfair",
+ :name=>"FunFair",
+ :symbol=>"FUN",
+ :rank=>"84",
+ :price_usd=>"0.0382094",
+ :price_btc=>"0.00000557",
+ :"24h_volume_usd"=>"5375680.0",
+ :market_cap_usd=>"172083246.0",
+ :available_supply=>"4503688789.0",
+ :total_supply=>"10999873621.0",
+ :max_supply=>nil,
+ :percent_change_1h=>"-6.89",
+ :percent_change_24h=>"-24.77",
+ :percent_change_7d=>"-59.6",
+ :last_updated=>"1517873357"}
 ```
 
-#### Retrieve markets by coin
+#### Available markets by coin id or symbol
 
 ```ruby
 CoinCapper.coin_markets(id: 'iota', symbol: nil)
+
+=> [{:source=>"Bitfinex", :pair=>"MIOTA/USD", :volume_usd=>33835200.0, :price_usd=>1.41, :volume_percentage=>50.21, :last_updated=>"Recently"},
+ {:source=>"Binance", :pair=>"IOTA/BTC", :volume_usd=>7733790.0, :price_usd=>1.41, :volume_percentage=>11.48, :last_updated=>"Recently"}]
+```
+
+#### Historical prices by id, start, end date
+
+```ruby
+CoinCapper.historical_price('request-network', '2018-01-01', '2018-01-02')
+
+=> [{:date=>"2018-01-02", :open=>0.8126, :high=>0.881387, :low=>0.650608, :close=>0.783648, :average=>0.7659975},
+ {:date=>"2018-01-01", :open=>0.606538, :high=>0.888908, :low=>0.528808, :close=>0.820232, :average=>0.708858}]
 ```
 
-#### Retrieve Coin historical price
+#### All Cryptocurrencies by type (coins, tokens)
 
 ```ruby
-CoinCapper.historical_price('request-network', '2018-01-01', '2018-01-08')
+# coins
+CoinCapper.all('coins')
+
+=> [{:id=>"bitcoin",
+  :rank=>1,
+  :name=>"Bitcoin",
+  :symbol=>"BTC",
+  :market_cap_usd=>116671271686.0,
+  :market_cap_btc=>16848275.0,
+  :price_usd=>6924.82,
+  :price_btc=>1.0,
+  :circulating_supply=>16848275.0,
+  :volume_usd_24h=>9116750000.0,
+  :volume_btc_24h=>1309170.0,
+  :percent_change_1h=>-4.59,
+  :percent_change_24h=>-16.75,
+  :percent_change_7d=>-38.38}]
+
+# tokens
+CoinCapper.all('tokens')
+
+=> [{:id=>"eos",
+  :rank=>1,
+  :name=>"EOS",
+  :platform=>"Ethereum",
+  :market_cap_usd=>4598392073.93,
+  :market_cap_btc=>663307.647514,
+  :price_usd=>7.07817,
+  :price_btc=>0.00102101,
+  :circulating_supply=>649658326.083,
+  :volume_usd_24h=>630722000.0,
+  :volume_btc_24h=>90980.3,
+  :percent_change_1h=>-6.02,
+  :percent_change_24h=>-18.88,
+  :percent_change_7d=>-49.0}]
 ```
 
 ## Development
@@ -70,7 +132,7 @@ 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/kurt-smith/coinmarketcap. 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/kurt-smith/coincapper. 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
 
@@ -78,4 +140,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the CoinCapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kurt-smith/coinmarketcap/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the CoinCapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kurt-smith/coincapper/blob/master/CODE_OF_CONDUCT.md).

data/coincapper.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.version       = CoinCapper::VERSION
   spec.authors       = ['Kurt Smith']
   spec.email         = ['zippydev@protonmail.com']
-
-  spec.summary       = 'Coin Market Cap V1 API wrapper'
-  spec.description   = 'coinmarketcap.com V1 API wrapper including additional historical prices and coin market pairs.'
+  spec.summary       = 'Coinmarketcap V1 API wrapper'
+  spec.description   = 'coinmarketcap.com V1 API wrapper including additional historical prices, coin market pairs, '\
+                       'and currencies by type (coins/tokens) parsed from Coin Market Cap.'
   spec.homepage      = 'https://github.com/kurt-smith/coincapper'
   spec.license       = 'MIT'
 
@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry',        '~> 0.11'
   spec.add_development_dependency 'rake',       '~> 10.0'
   spec.add_development_dependency 'rspec',      '~> 3.7'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rubocop',    '>= 0.52'
+  spec.add_development_dependency 'simplecov',  '>= 0.14'
   spec.add_development_dependency 'webmock', '~> 3.2'
 end

data/lib/coincapper.rb

@@ -6,120 +6,176 @@ require 'coincapper/version'
 require 'http'
 require 'nokogiri'
 
-module CoinCapper
+class CoinCapper
   API_URL = 'https://api.coinmarketcap.com/v1'.freeze
   BASE_URL = 'https://coinmarketcap.com'.freeze
 
-  # @param rank [Integer] Coins market cap rank greater than or equal
-  # @param limit [Integer] Maximum limit set. Defaults to 0 to return all results
-  # @param currency [String] Country currency code to convert price
-  # @return [Array<Hash>]
-  # @see https://coinmarketcap.com/api/
-  def self.coins(limit: 0, rank: nil, currency: nil)
-    params = {
-      limit: limit,
-      start: rank,
-      convert: currency
-    }.compact.to_param
-
-    url = "#{API_URL}/ticker/"
-    url << "?#{params}" if params.present?
-
-    response = HTTP.get(url)
-    JSON.parse(response.body.to_s, symbolize_names: true)
-  end
+  class << self
+    # @param rank [Integer] Coins market cap rank greater than or equal
+    # @param limit [Integer] Maximum limit set. Defaults to 0 to return all results
+    # @param currency [String] Country currency code to convert price
+    # @return [Array<Hash>]
+    # @see https://coinmarketcap.com/api/
+    def coins(limit: 0, rank: nil, currency: nil)
+      params = {
+        limit: limit,
+        start: rank,
+        convert: currency
+      }.compact.to_param
+
+      url = "#{API_URL}/ticker/"
+      url << "?#{params}" if params.present?
+
+      response = HTTP.get(url)
+      JSON.parse(response.body.to_s, symbolize_names: true)
+    end
 
-  # @param id [Integer] Coinmarketcap coin id
-  # @param currency [String] Country currency code to convert price
-  # @return [Hash]
-  def self.coin(id, currency: nil)
-    params = {
-      convert: currency
-    }.compact.to_param
+    # @param id [Integer] Coinmarketcap coin id
+    # @param currency [String] Country currency code to convert price
+    # @return [Hash]
+    def coin(id, currency: nil)
+      params = {
+        convert: currency
+      }.compact.to_param
 
-    url = "#{API_URL}/ticker/#{id}/"
-    url << "?#{params}" if params.present?
+      url = "#{API_URL}/ticker/#{id}/"
+      url << "?#{params}" if params.present?
 
-    response = HTTP.get(url)
-    json = JSON.parse(response.body.to_s, symbolize_names: true)
-    json.is_a?(Array) ? json.first : json
-  end
+      response = HTTP.get(url)
+      json = JSON.parse(response.body.to_s, symbolize_names: true)
+      json.is_a?(Array) ? json.first : json
+    end
 
-  # @param symbol [String] Coin symbol
-  # @return [Hash]
-  def self.coin_by_symbol(symbol)
-    response = HTTP.get("#{API_URL}/ticker/?limit=0")
-    json = JSON.parse(response.body.to_s, symbolize_names: true)
-    json.find { |x| x[:symbol].strip.casecmp(symbol.strip.upcase).zero? }
-  end
+    # @param symbol [String] Coin symbol
+    # @return [Hash]
+    def coin_by_symbol(symbol)
+      response = HTTP.get("#{API_URL}/ticker/?limit=0")
+      json = JSON.parse(response.body.to_s, symbolize_names: true)
+      json.find { |x| x[:symbol].strip.casecmp(symbol.strip.upcase).zero? }
+    end
 
-  # @param id [String] Coin market cap id
-  # @param symbol [String] Coin symbol
-  # @return [Array<Hash>]
-  def self.coin_markets(id: nil, symbol: nil)
-    raise ArgumentError.new('id or symbol is required') if id.blank? && symbol.blank?
-
-    coin_id = symbol.present? ? coin_by_symbol(symbol)[:id] : id
-    response = HTTP.get("#{BASE_URL}/currencies/#{coin_id}/\#markets")
-    html = Nokogiri::HTML(response.body.to_s)
-    rows = html.css('table#markets-table tbody tr')
-
-    markets = rows.each_with_object([]) do |row, arr|
-      td = row.css('td')
-      arr << {
-        source: td[1].text.strip,
-        pair: td[2].text.strip,
-        volume_usd: td[3].text.strip[/\$(.+)/, 1].delete(',').to_f,
-        price_usd: td[4].text.strip[/\$(.+)/, 1].delete(',').to_f,
-        volume_percentage: td[5].text.to_f,
-        last_updated: td[6].text.strip
-      }
+    # @param id [String] Coin market cap id
+    # @param symbol [String] Coin symbol
+    # @return [Array<Hash>]
+    def coin_markets(id: nil, symbol: nil)
+      raise ArgumentError.new('id or symbol is required') if id.blank? && symbol.blank?
+
+      coin_id = symbol.present? ? coin_by_symbol(symbol)[:id] : id
+      response = HTTP.get("#{BASE_URL}/currencies/#{coin_id}/\#markets")
+      html = Nokogiri::HTML(response.body.to_s)
+      rows = html.css('table#markets-table tbody tr')
+      return { error: 'invalid id' } if rows.blank?
+
+      markets = rows.each_with_object([]) do |row, arr|
+        td = row.css('td')
+        arr << {
+          source: td[1].text.strip,
+          pair: td[2].text.strip,
+          volume_usd: td[3].text.strip[/\$(.+)/, 1].delete(',').to_f,
+          price_usd: td[4].text.strip[/\$(.+)/, 1].delete(',').to_f,
+          volume_percentage: td[5].text.to_f,
+          last_updated: td[6].text.strip
+        }
+      end
+
+      markets
     end
 
-    markets
-  end
+    # @param currency [String] Country currency code to convert price
+    # @return [Hash]
+    def global(currency: nil)
+      params = {
+        convert: currency
+      }.compact.to_param
 
-  # @param currency [String] Country currency code to convert price
-  # @return [Hash]
-  def self.global(currency: nil)
-    params = {
-      convert: currency
-    }.compact.to_param
+      url = "#{API_URL}/global/"
+      url << "?#{params}" if params.present?
 
-    url = "#{API_URL}/global/"
-    url << "?#{params}" if params.present?
+      response = HTTP.get(url)
+      JSON.parse(response.body.to_s, symbolize_names: true)
+    end
 
-    response = HTTP.get(url)
-    JSON.parse(response.body.to_s, symbolize_names: true)
-  end
+    # @param id [String] Coinmarketcap coin id
+    # @param start_date [String] Start date (YYYY-MM-DD)
+    # @param end_date [String] End date (YYYY-MM-DD)
+    # @return [Array<Hash>]
+    def historical_price(id, start_date, end_date)
+      sd = parse_date(start_date, format: '%Y%m%d')
+      ed = parse_date(end_date, format: '%Y%m%d')
+      return { error: 'invalid date format' } if sd.blank? || ed.blank?
+
+      url = "#{BASE_URL}/currencies/#{id}/historical-data/?start=#{sd}&end=#{ed}"
+      response = HTTP.get(url)
+      html = Nokogiri::HTML(response.body.to_s)
+      rows = html.css('#historical-data table tbody tr')
+      return { error: 'invalid id' } if rows.blank?
+
+      prices = rows.each_with_object([]) do |row, arr|
+        td = row.css('td')
+        daily = {
+          date: parse_date(td[0].text, format: '%F'),
+          open: td[1].text.to_f,
+          high: td[2].text.to_f,
+          low: td[3].text.to_f,
+          close: td[4].text.to_f
+        }
+
+        daily[:average] = ((daily[:high] + daily[:low]).to_d / 2).to_f
+        arr << daily
+      end
+
+      prices
+    end
 
-  # @param id [String] Coinmarketcap coin id
-  # @param start_date [String] Start date (YYYY-MM-DD)
-  # @param end_date [String] End date (YYYY-MM-DD)
-  # @return [Array<Hash>]
-  def self.historical_price(id, start_date, end_date)
-    sd = start_date.to_date.to_s.delete('-')
-    ed = end_date.to_date.to_s.delete('-')
-
-    url = "#{BASE_URL}/currencies/#{id}/historical-data/?start=#{sd}&end=#{ed}"
-    response = HTTP.get(url)
-    html = Nokogiri::HTML(response.body.to_s)
-    rows = html.css('#historical-data table tbody tr')
-
-    prices = rows.each_with_object([]) do |row, arr|
-      td = row.css('td')
-      daily = {
-        date: Date.parse(td[0].text).to_s,
-        open: td[1].text.to_f,
-        high: td[2].text.to_f,
-        low: td[3].text.to_f,
-        close: td[4].text.to_f
+    # Returns list of cryptocurrencies by type (coins, tokens)
+    # @param type [String] Cryptocurrency type. i.e. 'coins' or 'tokens'
+    # @return [Array<Hash>] List of all coins (or tokens)
+    def all(type)
+      return { error: 'invalid type' } unless /coins|tokens/ =~ type
+
+      url = "#{BASE_URL}/#{type}/views/all/"
+      response = HTTP.get(url)
+      html = Nokogiri::HTML(response.body.to_s)
+      table = html.css('table#currencies-all, table#assets-all')
+      rows = table.css('tbody tr')
+
+      cryptos = rows.each_with_object([]) do |row, arr|
+        td = row.css('td')
+        arr << {
+          id: row&.attribute('id')&.text[/id-(.+)/, 1],
+          rank: td[0].text.to_i,
+          name: td[1].css('a.currency-name-container').text.strip,
+          symbol: type.eql?('coins') ? td[2].text : nil,
+          platform: type.eql?('tokens') ? td[2].text : nil,
+          market_cap_usd: td[3]&.attribute('data-usd')&.text.to_f,
+          market_cap_btc: td[3]&.attribute('data-btc')&.text.to_f,
+          price_usd: td[4].css('a.price')&.attribute('data-usd')&.text.to_f,
+          price_btc: td[4].css('a.price')&.attribute('data-btc')&.text.to_f,
+          circulating_supply: td[5].css('a, span')&.attribute('data-supply')&.text.to_f,
+          volume_usd_24h: td[6].css('a')&.attribute('data-usd')&.text.to_f,
+          volume_btc_24h: td[6].css('a')&.attribute('data-btc')&.text.to_f,
+          percent_change_1h: td[7]&.attribute('data-usd')&.text.to_f,
+          percent_change_24h: td[8]&.attribute('data-usd')&.text.to_f,
+          percent_change_7d: td[9]&.attribute('data-usd')&.text.to_f
+        }.compact
+      end
+
+      cryptos
+    rescue StandardError => e
+      {
+        message: 'An unknown error occurred. Please submit a GitHub issue if problem continues.',
+        error: e.message
       }
-
-      daily[:average] = ((daily[:high] + daily[:low]).to_d / 2).to_f
-      arr << daily
     end
 
-    prices
+    private
+
+    def parse_date(date, format: nil)
+      d = Date.parse(date)
+      return d if format.blank?
+      d.strftime(format)
+    rescue StandardError
+      nil
+    end
   end
 end

data/lib/coincapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module CoinCapper
-  VERSION = '1.0.0'
+class CoinCapper
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coincapper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kurt Smith
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-28 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -114,28 +114,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -150,8 +150,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
-description: coinmarketcap.com V1 API wrapper including additional historical prices
-  and coin market pairs.
+description: coinmarketcap.com V1 API wrapper including additional historical prices,
+  coin market pairs, and currencies by type (coins/tokens) parsed from Coin Market
+  Cap.
 email:
 - zippydev@protonmail.com
 executables: []
@@ -196,5 +197,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Coin Market Cap V1 API wrapper
+summary: Coinmarketcap V1 API wrapper
 test_files: []