coinmarketcap 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62cefa3f1ddfe4a8c142dcf9dbfd6337140fcb16
-  data.tar.gz: 63f977f36f55db8cef16fa043bb88a77f0a0e1ba
+  metadata.gz: dc9d2054f652d321b6c6137ab4651e479d8e21e5
+  data.tar.gz: d8c4060feb6324a66569ec83d7afc96a3e5b7346
 SHA512:
-  metadata.gz: 7638e027668a14a0ac3863f2b362db9827772999986630047f37237e36c14bab32c83edb52a03baddbf6c28096179c06682f8454eb74f53f283ee06718ae755d
-  data.tar.gz: ada461209b89108fcf0558e93fb8f54c47aee4331add639827111621d2ff656adcf8f6463a15a5f237050fb88dce74ce8898ab13bcf85c3e38abff8c9c46f835
+  metadata.gz: f8dcc70708fc2209699da2c5ab2d731e895f27f107d9432e2b3b7561ccb995d7f6cdc36f9029cb24e6dd080188c316d4b7e92210b0ae7c846b13b8b943061912
+  data.tar.gz: e5587b209c3f50f96be7502aa6b2b243f1e794ea6f3029336e8670ba4831d6007ad6a320674622b9205d4b2bd95d8beea8daf000c87079b9de11928accf70185

data/README.md

@@ -2,9 +2,7 @@
 
 # Coinmarketcap
 
-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/coinmarketcap`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A ruby wrapper for the [coinmarketcap.com API](https://coinmarketcap.com/api/).
 
 ## Installation
 
@@ -24,7 +22,236 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Coins
+To get information for multiple coins use the `coins` method.
+
+**Parameters**
+
+| Name           | Type           | Description     |
+| :------------- | :------------- | :-------------  |
+| `limit`        | int            | Return a maximum of `limit` results (default is nil which returns all results) |
+
+**Examples**
+```ruby
+  Coinmarketcap.coins
+  #=> returns array of all available coins sorted by rank
+
+  Coinmarketcap.coins(limit = 20)
+  #=> returns array of only 20 coins sorted by rank
+```
+**Sample Response**
+```json
+{
+  "data": [
+    {
+      "id": 1,
+      "name": "Bitcoin",
+      "symbol": "BTC",
+      "website_slug": "bitcoin",
+      "rank": 1,
+      "circulating_supply": 17243837.0,
+      "total_supply": 17243837.0,
+      "max_supply": 21000000.0,
+      "quotes": {
+        "USD": {
+          "price": 7046.61259816,
+          "volume_24h": 4289789887.93929,
+          "market_cap": 121510639045.0,
+          "percent_change_1h": -0.09,
+          "percent_change_24h": 1.42,
+          "percent_change_7d": 4.74
+        }
+      },
+      "last_updated": 1535812825
+    },
+    {
+      "id": 1027,
+      "name": "Ethereum",
+      "symbol": "ETH",
+      "website_slug": "ethereum",
+      "rank": 2,
+      "circulating_supply": 101689192.0,
+      "total_supply": 101689192.0,
+      "max_supply": null,
+      "quotes": {
+        "USD": {
+          "price": 287.025145487,
+          "volume_24h": 1359873785.37404,
+          "market_cap": 29187355119.0,
+          "percent_change_1h": 0.5,
+          "percent_change_24h": 2.93,
+          "percent_change_7d": 2.34
+        }
+      },
+      "last_updated": 1535812836
+    }
+  ],
+  "metadata": {
+    "timestamp": 1535812339,
+    "num_cryptocurrencies": 1910,
+    "error": null
+  }
+}
+```
+
+### Coin
+To get information for a specific coin use the `coin` method.
+
+**Parameters**
+
+| Name           | Type           | Description     |
+| :------------- | :------------- | :-------------  |
+| `id`           | integer        | **required**. Use the ID returned from all coins api |
+| `currency`     | string         | return *price*, *24h volume*, and *market cap* in terms of another currency. Valid values are "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". (default is "USD") |
+
+**Examples**
+```ruby
+  Coinmarketcap.coin(1)
+  #=> returns information about coin with '1' as its id.
+  # Price, 24h volume and market cap are in USD
+```
+**Sample Response**
+```json
+{
+  "data": {
+    "id": 1,
+    "name": "Bitcoin",
+    "symbol": "BTC",
+    "website_slug": "bitcoin",
+    "rank": 1,
+    "circulating_supply": 17243837.0,
+    "total_supply": 17243837.0,
+    "max_supply": 21000000.0,
+    "quotes": {
+      "USD": {
+        "price": 7056.36503616,
+        "volume_24h": 4310812630.28682,
+        "market_cap": 121678808496.0,
+        "percent_change_1h": 0.04,
+        "percent_change_24h": 1.54,
+        "percent_change_7d": 4.88
+      }
+    },
+    "last_updated": 1535813063
+  },
+  "metadata": {
+    "timestamp": 1535812601,
+    "error": null
+  }
+}
+```
+
+```ruby
+  Coinmarketcap.coin(1, 'EUR')
+  #=> returns information about coin with '1' as its id.
+  # Price, 24h volume and market cap are in EUR
+```
+**Sample Response**
+```json
+{
+  "data": {
+    "id": 1,
+    "name": "Bitcoin",
+    "symbol": "BTC",
+    "website_slug": "bitcoin",
+    "rank": 1,
+    "circulating_supply": 17243837.0,
+    "total_supply": 17243837.0,
+    "max_supply": 21000000.0,
+    "quotes": {
+      "USD": {
+        "price": 7057.5191433,
+        "volume_24h": 4315628117.49539,
+        "market_cap": 121698709731.0,
+        "percent_change_1h": 0.06,
+        "percent_change_24h": 1.56,
+        "percent_change_7d": 4.9
+      },
+      "EUR": {
+        "price": 6077.93548621,
+        "volume_24h": 3716618934.7870364,
+        "market_cap": 104806928821.0,
+        "percent_change_1h": 0.06,
+        "percent_change_24h": 1.56,
+        "percent_change_7d": 4.9
+      }
+    },
+    "last_updated": 1535813303
+  },
+  "metadata": {
+    "timestamp": 1535812810,
+    "error": null
+  }
+}
+```
+
+### Global
+To get global (general) data, use the `global` method.
+
+**Parameters**
+
+| Name           | Type           | Description     |
+| :------------- | :------------- | :-------------  |
+| `currency`     | string         | return *price*, *24h volume*, and *market cap* in terms of another currency. Valid values are "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". (default is "USD") |
+
+**Examples**
+```ruby
+  Coinmarketcap.global
+  #=> returns global data
+  # Price, 24h volume and market cap are in USD
+```
+**Sample Response**
+```json
+{
+  "data":  {
+    "active_cryptocurrencies":  1910,
+    "active_markets":  13693,
+    "bitcoin_percentage_of_market_cap":  52.38,
+    "quotes":  {
+      "USD":  {
+        "total_market_cap":  232365707542.0,
+        "total_volume_24h":  12929935868.0
+      }
+    },
+    "last_updated":  1535813364
+  },
+  "metadata":  {
+    "timestamp":  1535812887,
+    "error":  null
+  }
+}
+```
+
+```ruby
+  Coinmarketcap.global('EUR')
+  #=> returns global data
+  # Price, 24h volume and market cap are in EUR
+```
+**Sample Response**
+```json
+{
+  "data":  {
+    "active_cryptocurrencies":  1910,
+    "active_markets":  13693,
+    "bitcoin_percentage_of_market_cap":  52.38,
+    "quotes":  {
+      "USD":  {
+        "total_market_cap":  232328115855.0,
+        "total_volume_24h":  12928585948.0
+      },
+      "EUR":  {
+        "total_market_cap":  200080973374.0,
+        "total_volume_24h":  11134098218.0
+      }
+    },
+    "last_updated":  1535813303
+  },
+  "metadata":  {
+    "timestamp":  1535812850,
+    "error":  null
+  }
+}
+```
 
 ## Development
 
@@ -34,7 +261,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/[USERNAME]/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/ankitsamarthya/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.
 
 ## License
 
@@ -42,4 +269,4 @@ The gem is available as open source under the terms of the [MIT License](http://
 
 ## Code of Conduct
 
-Everyone interacting in the Coinmarketcap project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/coinmarketcap/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Coinmarketcap project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ankitsamarthya/coinmarketcap/blob/master/CODE_OF_CONDUCT.md).

data/lib/coinmarketcap.rb

@@ -4,31 +4,26 @@ require 'httparty'
 require 'nokogiri'
 
 module Coinmarketcap
-
   def self.coins(limit = nil)
     if limit.nil?
-      HTTParty.get('https://api.coinmarketcap.com/v1/ticker/')
+      HTTParty.get('https://api.coinmarketcap.com/v2/ticker/?structure=array')
     else
-      HTTParty.get("https://api.coinmarketcap.com/v1/ticker/?limit=#{limit}")
+      HTTParty.get("https://api.coinmarketcap.com/v2/ticker/?limit=#{limit}&structure=array")
     end
   end
 
-  def self.coin(id)
-    HTTParty.get("https://api.coinmarketcap.com/v1/ticker/#{id}/")
+  def self.coin(id, currency = 'USD')
+    HTTParty.get("https://api.coinmarketcap.com/v2/ticker/#{id}/?convert=#{currency}")
   end
 
   def self.global(currency = 'USD')
-    HTTParty.get("https://api.coinmarketcap.com/v1/global/?convert=#{currency}")
+    HTTParty.get("https://api.coinmarketcap.com/v2/global/?convert=#{currency}")
   end
 
-  def self.get_historical_price(id, start_date, end_date) #20170908
+  def self.get_historical_price(id, start_date, end_date) # 20170908
     prices = []
     doc = Nokogiri::HTML(open("https://coinmarketcap.com/currencies/#{id}/historical-data/?start=#{start_date}&end=#{end_date}"))
     rows = doc.css('tr')
-    if rows.count == 31
-      doc = Nokogiri::HTML(open("https://coinmarketcap.com/assets/#{id}/historical-data/?start=#{start_date}&end=#{end_date}"))
-      rows = doc.css('tr')
-    end
     rows.shift
     rows.each do |row|
       begin
@@ -40,14 +35,13 @@ module Coinmarketcap
           price_bundle[:high] = each_row[2].text.to_f
           price_bundle[:low] = each_row[3].text.to_f
           price_bundle[:close] = each_row[4].text.to_f
-          price_bundle[:avg] = ( price_bundle[:high] + price_bundle[:low] ) / 2.0
+          price_bundle[:avg] = (price_bundle[:high] + price_bundle[:low]) / 2.0
           prices << price_bundle
         end
-      rescue => error
+      rescue
         next
       end
     end
     prices
   end
-
 end

data/lib/coinmarketcap/version.rb

@@ -1,3 +1,3 @@
 module Coinmarketcap
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinmarketcap
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Ankit Samarthya
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2018-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Coinmarketcap.com API ruby wrapper