coinmarketcap-ruby-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 378c754280f2105451ade40e5c3f56a8ffe66dded187feb5948fdc7aa83b3ba7
-  data.tar.gz: ab7bce01c3133499a282c777e4f049cbea1ad661699ca5ef2a26158fd44e670d
+  metadata.gz: c92b7dcc192e4c5124e62a64404cd9022047a2ef349face7b0231cefe95c9349
+  data.tar.gz: ce068a4e060eeaf614d3d2908009e04efc54268e6189c83e3a975ead1eb20b7e
 SHA512:
-  metadata.gz: f8058075d308ecec683b1e95b9632411ea2ef7bfe1f0540cdd80a90aa019210505f7e405506e231cd567b5ddde475b54a47f8afb60f1975f1d5f81076f7b875c
-  data.tar.gz: '079587b57b95e4b9d9bad537750b7859b18a3d79ed46d610aaf219fcdf280bd02f4f8446bacec97f384437d6cbd7cd7274f00ba6a184f68bfc09feda4ad36bab'
+  metadata.gz: ad8cdadeef43edf7aeca19f9f5ed2cba0cf95f7571acb8e62bb2c594c79ebe1a04b2f88942350e42466ed5233ccca416c08a3851f1d0623ffef880d7b13a7f39
+  data.tar.gz: 7fdc18918edec0df7c660315755bae5ae4ac7af49253c065bae9255780baa209534b4121bec1cd036666c893d4f7e8cc42dc13e9de1b1437332283b88f4f1154

data/.github/workflows/ruby.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,6 +1,12 @@
-### 1.0.1 (Next)
-* Contributions here
+### 1.1.1 (Next)
+
+- your contributions here ...
+
+### 1.1.0 (2021/10/09)
+
+- [#5](https://github.com/koffeefinance/coinmarketcap-ruby-client/pull/5): Added support to fetch metadata for a cryptocurrency via the /info endpoint - [@mathu97](https://github.com/mathu97).
+- [#10](https://github.com/koffeefinance/coinmarketcap-ruby-client/pull/10): Added support to fetch latest listings - [@mathu97](https://github.com/mathu97).
 
 ### 1.0.0 (2021/10/05)
-* [#1](https://github.com/koffeefinance/coinmarketcap-ruby-client/pull/1): Added support to fetch the CoinMarketCap ID Map.
 
+- [#1](https://github.com/koffeefinance/coinmarketcap-ruby-client/pull/1): Added support to fetch the CoinMarketCap ID Map - [@mathu97](https://github.com/mathu97).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coinmarketcap-ruby-client (1.0.0)
+    coinmarketcap-ruby-client (1.1.0)
       faraday (>= 1.8)
       faraday_middleware (>= 1.1)
       hashie

data/README.md

@@ -1,5 +1,7 @@
 # CoinMarketCap Ruby API Client
 
+[![Gem Version](https://badge.fury.io/rb/coinmarketcap-ruby-client.svg)](https://badge.fury.io/rb/coinmarketcap-ruby-client) ![Build Status](https://github.com/koffeefinance/coinmarketcap-ruby-client/actions/workflows/ruby.yml/badge.svg)
+
 A ruby API client for [CoinMarketCap](https://coinmarketcap.com/api/documentation/v1/)
 
 # Table of Contents
@@ -9,6 +11,8 @@ A ruby API client for [CoinMarketCap](https://coinmarketcap.com/api/documentatio
   - [Get an API Key](#get-an-api-token)
   - [Configure](#configure)
   - [Get CoinMarketCap ID Map](#get-coinmarketcap-id-map)
+  - [Get Cryptocurrency Metadata](#get-cryptocurrency-metadata)
+  - [Get Latest Listings](#get-latest-listings)
 - [Development](#development)
 - [Contributing](#contributing)
 - [License](#license)
@@ -71,7 +75,80 @@ platform.slug # 'ethereum'
 platform.token_address # '0xdac17f958d2ee523a2206206994597c13d831ec7'
 ```
 
-See [Cryptocurrency Map](https://coinmarketcap.com/api/documentation/v1/#operation/getV1CryptocurrencyMap) for detailed documentation.
+See [CoinMarketCap ID Map](https://coinmarketcap.com/api/documentation/v1/#operation/getV1CryptocurrencyMap) for detailed documentation.
+
+### Get Cryptocurrency Metadata
+
+Fetches static metadata available for one or more cryptocurrencies.
+
+```ruby
+  info = client.info(symbol: 'ETH')
+
+  metadata = info['ETH']
+  metadata.id # 1027
+  metadata.name # 'Ethereum'
+  metadata.symbol # 'ETH'
+  metadata.category # 'coin'
+  metadata.description # 'Ethereum (ETH) is a cryptocurrency . Users are able to generate ETH ...'
+  metadata.slug # 'ethereum'
+  metadata.logo # 'https://s2.coinmarketcap.com/static/img/coins/64x64/1027.png'
+  metadata.notice # ''
+  metadata.tags # ['mineable', 'pow', 'smart-contracts', ...]
+  metadata.platform # nil
+
+  urls = metadata.urls
+  urls.website # ['https://www.ethereum.org/', 'https://en.wikipedia.org/wiki/Ethereum']
+  urls.twitter # ['https://twitter.com/ethereum']
+  urls.message_board # ['https://forum.ethereum.org/', 'https://ethresear.ch/']
+  urls.chat # ['https://gitter.im/orgs/ethereum/rooms']
+  urls.explorer # ['https://etherscan.io/', 'https://ethplorer.io/', 'https://blockchair.com/ethereum', ...]
+  urls.reddit # ['https://reddit.com/r/ethereum']
+  urls.technical_doc # ['https://github.com/ethereum/wiki/wiki/White-Paper']
+  urls.source_code # ['https://github.com/ethereum']
+  urls.announcement # ['https://bitcointalk.org/index.php?topic=428589.0']
+```
+
+See [Cryptocurrency Metadata](https://coinmarketcap.com/api/documentation/v1/#operation/getV1CryptocurrencyInfo) for detailed documentation.
+
+### Get Latest Listings
+
+Returns a paginated list of all active cryptocurrencies with latest market data.
+
+```ruby
+  listings = client.listings_latest
+  listing = listings.first
+
+  listing.id # 1
+  listing.name # 'Bitcoin'
+  listing.symbol # 'BTC'
+  listing.slug # 'bitcoin'
+  listing.num_market_pairs # 8527
+  listing.date_added # <Date: 2013-04-28 ((2456411j,0s,0n),+0s,2299161j)>
+  listing.tags # ['mineable', 'pow', 'sha-256', 'store-of-value', ...]
+  listing.max_supply # 21000000
+  listing.circulating_supply # 18837706
+  listing.total_supply # 18837706
+  listing.platform # nil
+  listing.cmc_rank # 1
+  listing.last_updated # <Date: 2021-10-08 ((2459496j,0s,0n),+0s,2299161j)>
+
+  quote_in_usd = listing.quote['USD']
+
+  quote_in_usd.price # 53853.84605722145
+  quote_in_usd.volume_24h # 35664606394.86121
+  quote_in_usd.percent_change_1h # -0.08049597
+  quote_in_usd.percent_change_24h # -1.93058
+  quote_in_usd.percent_change_7d # 23.57830268
+  quote_in_usd.percent_change_30d # 15.8506565
+  quote_in_usd.percent_change_60d # 24.08594399
+  quote_in_usd.percent_change_90d # 59.25745607
+  quote_in_usd.market_cap # 1014482918995.1969
+  quote_in_usd.market_cap_dominance # 44.5955
+  quote_in_usd.fully_diluted_market_cap # 1130930767201.65
+  quote_in_usd.last_updated # <Date: 2021-10-08 ((2459496j,0s,0n),+0s,2299161j)>
+```
+
+See [Listings Latest](https://coinmarketcap.com/api/documentation/v1/#operation/getV1CryptocurrencyListingsLatest) for detailed documentation.
 
 ## Development
 

data/lib/coinmarketcap/endpoints/cryptocurrency.rb

@@ -2,9 +2,21 @@ module CoinMarketCap
   module Endpoints
     module Cryptocurrency
       def map(options = {})
-        response = get('cryptocurrency/map', {}.merge(options))
+        response = get('cryptocurrency/map', options)
         response['data'].map { |row| CoinMarketCap::Resources::Cryptocurrency.new(row) }
       end
+
+      def info(options = {})
+        response = get('cryptocurrency/info', options)
+        response['data'].map do |key, value|
+          [key, CoinMarketCap::Resources::Metadata.new(value)]
+        end.to_h
+      end
+
+      def listings_latest(options = {})
+        response = get('cryptocurrency/listings/latest', options)
+        response['data'].map { |row| CoinMarketCap::Resources::Listing.new(row) }
+      end
     end
   end
 end

data/lib/coinmarketcap/resources/listing.rb

@@ -0,0 +1,27 @@
+module CoinMarketCap
+  module Resources
+    class Listing < Resource
+      property 'id'
+      property 'name'
+      property 'symbol'
+      property 'slug'
+      property 'cmc_rank'
+      property 'num_market_pairs'
+      property 'circulating_supply'
+      property 'total_supply'
+      property 'market_cap_by_total_supply'
+      property 'max_supply'
+      property 'last_updated', transform_with: ->(v) { iso8601_date(v) }
+      property 'date_added', transform_with: ->(v) { iso8601_date(v) }
+      property 'tags'
+      property 'platform', transform_with: lambda { |v|
+        CoinMarketCap::Resources::Platform.new(v) unless v.nil?
+      }
+      property 'quote', transform_with: lambda { |v|
+        v.map do |key, value|
+          [key, CoinMarketCap::Resources::Quote.new(value)]
+        end.to_h
+      }
+    end
+  end
+end

data/lib/coinmarketcap/resources/metadata.rb

@@ -0,0 +1,22 @@
+module CoinMarketCap
+  module Resources
+    class Metadata < Resource
+      property 'id'
+      property 'name'
+      property 'symbol'
+      property 'category'
+      property 'slug'
+      property 'logo'
+      property 'description'
+      property 'date_added', transform_with: ->(v) { iso8601_date(v) }
+      property 'notice'
+      property 'tags'
+      property 'platform', transform_with: lambda { |v|
+        CoinMarketCap::Resources::Platform.new(v) unless v.nil?
+      }
+      property 'urls', transform_with: lambda { |v|
+        CoinMarketCap::Resources::URL.new(v) unless v.nil?
+      }
+    end
+  end
+end

data/lib/coinmarketcap/resources/quote.rb

@@ -0,0 +1,23 @@
+module CoinMarketCap
+  module Resources
+    class Quote < Resource
+      property 'price'
+      property 'volume_24h'
+      property 'volume_24h_reported'
+      property 'volume_7d'
+      property 'volume_7d_reported'
+      property 'volume_30d'
+      property 'volume_30d_reported'
+      property 'market_cap'
+      property 'market_cap_dominance'
+      property 'fully_diluted_market_cap'
+      property 'percent_change_1h'
+      property 'percent_change_24h'
+      property 'percent_change_7d'
+      property 'percent_change_30d'
+      property 'percent_change_60d'
+      property 'percent_change_90d'
+      property 'last_updated', transform_with: ->(v) { iso8601_date(v) }
+    end
+  end
+end

data/lib/coinmarketcap/resources/url.rb

@@ -0,0 +1,15 @@
+module CoinMarketCap
+  module Resources
+    class URL < Resource
+      property 'website'
+      property 'technical_doc'
+      property 'explorer'
+      property 'source_code'
+      property 'message_board'
+      property 'chat'
+      property 'announcement'
+      property 'reddit'
+      property 'twitter'
+    end
+  end
+end

data/lib/coinmarketcap/resources.rb

@@ -2,3 +2,7 @@ require_relative 'resources/resource'
 
 require_relative 'resources/platform'
 require_relative 'resources/cryptocurrency'
+require_relative 'resources/url'
+require_relative 'resources/metadata'
+require_relative 'resources/quote'
+require_relative 'resources/listing'

data/lib/coinmarketcap/version.rb

@@ -1,3 +1,3 @@
 module CoinMarketCap
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinmarketcap-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mathusan Selvarajah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -141,8 +142,12 @@ files:
 - lib/coinmarketcap/errors/permission_denied_error.rb
 - lib/coinmarketcap/resources.rb
 - lib/coinmarketcap/resources/cryptocurrency.rb
+- lib/coinmarketcap/resources/listing.rb
+- lib/coinmarketcap/resources/metadata.rb
 - lib/coinmarketcap/resources/platform.rb
+- lib/coinmarketcap/resources/quote.rb
 - lib/coinmarketcap/resources/resource.rb
+- lib/coinmarketcap/resources/url.rb
 - lib/coinmarketcap/version.rb
 homepage: https://github.com/koffeefinance/coinmarketcap-ruby-client
 licenses: