coinmarketcap_free 0.4.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75e112c92ffd0e8f5692d2497af36cc97bf9df213219a47b974f13f6d3d21558
-  data.tar.gz: 244626426b7fb8a930c71d8b5ff468e39b22fffc476151c944c19e2af9c1c0d2
+  metadata.gz: 84d7327edba1a064c58e5b76ec5e5046519e7226fa91bc4e0f98dfb35c3fb34b
+  data.tar.gz: cecb71581b982b9fc34afab19606d085278e57ce39f4ecb2e497ce1abdafd2a2
 SHA512:
-  metadata.gz: c23c10123ee29cb2e3db88477123abae457575357d8e173bfacf7df2ee8c8b9199382e828fc1d416e556758eacab7b73ba0c7bdfeabca1675b324a571d6267c9
-  data.tar.gz: 211ee8c04dd9995e19a760c84f75da00ef726995e35e03db44847f423315652f14ae9b2f1a7a71cfd1dd0a75336fb1f7887192e66842774d1006499e869ae280
+  metadata.gz: 976ec0dfecfe6cc6d553937d42ed6afac390100b94d0e9d8a4b2e8c57bb6b045b1588494eaa8dde8c30441dc0d6d15753a3cc722c6b33e1758c4e9d7f29203ac
+  data.tar.gz: 16818ff459c549b658992e4ffefef6464103edbd57ef6ad969a538e1298316f6b900d67c24383e52ff968ecdc6c2a7298c5c2dc5b0cff976d7817549b9791b8c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coinmarketcap_free (0.4.1)
+    coinmarketcap_free (1.0.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -15,16 +15,75 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## How to use?
 
 ``` Ruby
-list = CoinmarketcapFree::Coin.list
+    coins = CoinmarketcapFree::Coin.list
 ```
 
-or short
+or
 
 ``` Ruby
-list = CoinmarketcapFree::coins
+    coins = CoinmarketcapFree.coins
+```
+
+####Result:
+
+Model:
+```Ruby
+[...
+#<CoinmarketcapFree::Coin:0x00000001064388a0                                     
+ @cmc_rank=1,                                                                    
+ @id=1,                                                                          
+ @market_pair_count=10861,                                                       
+ @name=#<struct Struct::FullName name="Bitcoin", symbol="BTC", slug="bitcoin">,  
+ @quotes=                                                                        
+  [#<struct Struct::Quotes                                                       
+    name="USD",                                                                  
+    price=66949.41999188314,                                                     
+    volume_24h=92116022162.1663,                                                 
+    market_cap=1315314616282.593,                                                
+    percent_change_1h=0.39277979,                                                
+    percent_change_24h=3.06216236,                                               
+    percent_change_7d=10.037655,                                                 
+    percent_change_30d=56.63354406,
+    percent_change_60d=52.21058851,
+    percent_change_90d=54.57419557,
+    percent_change_1y=197.24478021,
+    last_updated=#<DateTime: 2024-03-06T17:46:00+00:00 ((2460376j,63960s,0n),+0s,2299161j)>>],
+ @state=#<struct Struct::State last_updated=#<DateTime: 2024-03-06T17:46:00+00:00 ((2460376j,63960s,0n),+0s,2299161j)>, added=#<DateTime: 2010-07-13T00:00:00+00:00 ((2455391j,0s,0n),+0s,2299161j)>>,
+ @supply=#<struct Struct::Supply circulating=19646393.0, total=19646393.0, maximum=21000000.0>,
+ @tags=
+  ["mineable",
+   "pow",
+   "sha-256",
+   "store-of-value",
+   "state-channel",
+   "coinbase-ventures-portfolio",
+   "three-arrows-capital-portfolio",
+   "polychain-capital-portfolio",
+   "binance-labs-portfolio",
+   "blockchain-capital-portfolio",
+   "boostvc-portfolio",
+   "cms-holdings-portfolio",
+   "dcg-portfolio",
+   "dragonfly-capital-portfolio",
+   "electric-capital-portfolio",
+   "fabric-ventures-portfolio",
+   "framework-ventures-portfolio",
+   "galaxy-digital-portfolio",
+   "huobi-capital-portfolio",
+   "alameda-research-portfolio",
+   "a16z-portfolio",
+   "1confirmation-portfolio",
+   "winklevoss-capital-portfolio",
+   "usv-portfolio",
+   "placeholder-ventures-portfolio",
+   "pantera-capital-portfolio",
+   "multicoin-capital-portfolio",
+   "paradigm-portfolio",
+   "bitcoin-ecosystem",
+   "ftx-bankruptcy-estate"]>]
 ```
 
-Result:
+Json data:
 ``` JSON
 {
     "data": {
@@ -109,77 +168,115 @@ Result:
 }
 ```
 
-If you want to sort in ascending, just write parameter:
+Get a list of cryptocurrencies
+ ``` Ruby
+    list = CoinmarketcapFree.coins(limit: 100, start: 1)
+```
+
+If you want to sort in ascending:
 
 ``` Ruby
-list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc')
+    list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'asc')    
 ```
 
-You can also adding sort by:
+or in descending
 
 ``` Ruby
-list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc', sort_by: 'name')
+    list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'desc')
 ```
 
-Convert all cryptocurrencies to USD,BTC,ETH:
+Also you can sort by name with ascending:
 
 ``` Ruby
-list = CoinmarketcapFree::Coin.list(limit: 100, 
-                                         start: 1, 
-                                         sort_type:'asc', 
-                                         sort_by: 'name', 
-                                         convert: 'USD,BTC,ETH')
+    list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'asc', sort_by: 'name')    
 ```
 
+Convert cryptocurrency to USD:
+
+``` Ruby
+    list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD')    
+```
+
+or together
+
+``` Ruby
+    list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH')
+```
 
-Parameters for CoinmarketcapFree::Coin.list:
+Parameters for ```CoinmarketcapFree::Coin.list``` or ```CoinmarketcapFree.coins```:
 
 | Name                          | Type     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Examples                                     |
 |:------------------------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------|
-| ```limit:```                  | Integer. | Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.                                                                                                                                                                                                                                                                                                                            ||
-| ```start:```                  | Integer. | Optionally offset the start (1-based index) of the paginated list of items to return.                                                                                                                                                                                                                                                                                                                                                                              ||
-| ```sort_by:```                 | String.  | Default: ```market_cap```. (```rank```, ```name```, ```symbol```, ```date_added```, ```market_cap```, ```market_cap_strict```, ```price```, ```circulating_supply```, ```total_supply```, ```max_supply```, ```num_market_pairs```, ```volume_24h```, ```percent_change_1h```, ```percent_change_24h```, ```percent_change_7d```, ```market_cap_by_total_supply_strict```, ```volume_7d```, ```volume_30d```). What field to sort the list of cryptocurrencies by. ||
-| ```sort_type:```               | String.  | Default: ```desc```. (```asc``` or ```desc```). The direction in which to order cryptocurrencies against the specified sort.                                                                                                                                                                                                                                                                                                                                       ||
-| ```convert:```                | String.  | Default: ```USD,BTC,ETH``` . Select cryptocurrencies to exchange (```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```).                                            | ```USD``` or ```USD,BTC,ETH```               |
-| ```crypto_type:```             | String.  | Default: ```all```. (```all```, ```coins```, ```tokens```). The type of cryptocurrency to include.                                                                                                                                                                                                                                                                                                                                                                 ||
-| ```tag_type:```                | String.  | Default: ```all```. (```all```, ```defi```, ```filesharing```). The tag of cryptocurrency to include.                                                                                                                                                                                                                                                                                                                                                              ||
-| ```audited:```                | Boolean. | Show audited (true) or not (false)                                                                                                                                                                                                                                                                                                                                                                                                                                 ||
-| ```aux:```                    | String.  | Optionally specify a comma-separated list of supplemental data fields to return. Pass ```ath, atl, high24h, low24h, num_market_pairs, cmc_rank, date_added, max_supply, circulating_supply, total_supply, volume_7d, volume_30d, self_reported_circulating_supply, self_reported_market_cap``` to include all auxiliary fields.                                                                                                                                    | ```ath``` or ```ath, atl, high24h, low24h``` |
-| ```tags:```                   | string.  | If you want to see cryptocurrencies that can be mined, just type ```mineable```.                                                                                                                                                                                                                                                                                                                                                                                   ||
-| ```volume24h_range:```         | String.  | Optionally specify a threshold 24 hour USD volume to filter results by.                                                                                                                                                                                                                                                                                                                                                                                            | ```0~100000000000000000```                   |
-| ```percent_change24h_range:```  | String.  | Optionally specify a threshold 24 hour percent change to filter results by.                                                                                                                                                                                                                                                                                                                                                                                        | ```0~100``` or ```-10~100```                 |
-| ```circulating_supply_range:``` | String.  | Optionally specify a threshold circulating supply to filter results by.                                                                                                                                                                                                                                                                                                                                                                                            | ```0~100000000000000000```                   |
-| ```price_range:```             | String.  | Optionally specify a threshold USD price to filter results by.                                                                                                                                                                                                                                                                                                                                                                                                     | ```0~100000000000000000```                   |
-| ```market_cap_range:```         | String.  | Optionally specify a threshold market cap to filter results by.                                                                                                                                                                                                                                                                                                                                                                                                    | ```0~100000000000000000```                   |
+| ```limit:```                  | Integer | Optionally specify the number of results to return. Use this parameter and the "start" parameter to determine your own pagination size.                                                                                                                                                                                                                                                                                                                            ||
+| ```start:```                  | Integer | Optionally offset the start (1-based index) of the paginated list of items to return.                                                                                                                                                                                                                                                                                                                                                                              ||
+| ```sort_by:```                 | String  | Default: ```market_cap```. (```rank```, ```name```, ```symbol```, ```date_added```, ```market_cap```, ```market_cap_strict```, ```price```, ```circulating_supply```, ```total_supply```, ```max_supply```, ```num_market_pairs```, ```volume_24h```, ```percent_change_1h```, ```percent_change_24h```, ```percent_change_7d```, ```market_cap_by_total_supply_strict```, ```volume_7d```, ```volume_30d```). What field to sort the list of cryptocurrencies by. ||
+| ```sort_type:```               | String  | Default: ```desc```. (```asc``` or ```desc```). The direction in which to order cryptocurrencies against the specified sort.                                                                                                                                                                                                                                                                                                                                       ||
+| ```convert:```                | String  | Default: ```USD``` . Select cryptocurrencies to exchange (```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```).                                            | ```USD``` or together ```USD,BTC,ETH```               |
+| ```crypto_type:```             | String  | Default: ```all```. (```all```, ```coins```, ```tokens```). The type of cryptocurrency to include.                                                                                                                                                                                                                                                                                                                                                                 ||
+| ```tag_type:```                | String  | Default: ```all```. (```all```, ```defi```, ```filesharing```). The tag of cryptocurrency to include.                                                                                                                                                                                                                                                                                                                                                              ||
+| ```audited:```                | Boolean | Show audited (true) or not (false)                                                                                                                                                                                                                                                                                                                                                                                                                                 ||
+| ```tags:```                   | String  | If you want to see cryptocurrencies that can be mined, just type ```mineable```.                                                                                                                                                                                                                                                                                                                                                                                   ||
+| ```volume24h_range:```         | String  | Optionally specify a threshold 24 hour USD volume to filter results by.                                                                                                                                                                                                                                                                                                                                                                                            | ```0~100000000000000000```                   |
+| ```percent_change24h_range:```  | String  | Optionally specify a threshold 24 hour percent change to filter results by.                                                                                                                                                                                                                                                                                                                                                                                        | ```0~100``` or ```-10~100```                 |
+| ```circulating_supply_range:``` | String  | Optionally specify a threshold circulating supply to filter results by.                                                                                                                                                                                                                                                                                                                                                                                            | ```0~100000000000000000```                   |
+| ```price_range:```             | String  | Optionally specify a threshold USD price to filter results by.                                                                                                                                                                                                                                                                                                                                                                                                     | ```0~100000000000000000```                   |
+| ```market_cap_range:```         | String  | Optionally specify a threshold market cap to filter results by.                                                                                                                                                                                                                                                                                                                                                                                                    | ```0~100000000000000000```                   |
 
 ### Returns an interval of historic market quotes:
 
 ``` Ruby
-coin = CoinmarketcapFree::CoinHistory.custom_time(1, '1D')
-coin = CoinmarketcapFree::CoinHistory.custom_time(1, '1668981600~1671659999')
+    histories = CoinmarketcapFree::CoinHistory.custom_time(id_coin, '1D')
+    histories = CoinmarketcapFree::CoinHistory.custom_time(id_coin, '1668981600~1671659999')
 ```
 
 or short
 
 ``` Ruby
-coin = CoinmarketcapFree.coin_history(1, '1D')
-coin = CoinmarketcapFree.coin_history(1, '1668981600~1671659999')
+    histories = CoinmarketcapFree.coin_histories(id_coin, '1D')
+    histories = CoinmarketcapFree.coin_histories(id_coin, '1668981600~1671659999')
 ```
 
-or
+Also you can call method like this:
 
 ``` Ruby
-coin = CoinmarketcapFree::CoinHistory.interval_day(1)
-coin = CoinmarketcapFree::CoinHistory.interval_seven_days(1)
-coin = CoinmarketcapFree::CoinHistory.interval_one_month(1)
-coin = CoinmarketcapFree::CoinHistory.interval_three_months(1)
-coin = CoinmarketcapFree::CoinHistory.interval_one_year(1)
-coin = CoinmarketcapFree::CoinHistory.interval_current_year(1)
-coin = CoinmarketcapFree::CoinHistory.interval_all_time(1)
+    histories = CoinmarketcapFree::CoinHistory.one_day(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.seven_days(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.one_month(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.three_months(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.one_year(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.current_year(id_coin)
+    histories = CoinmarketcapFree::CoinHistory.all(id_coin)
 ```
 
-Result:
-``` JSON
+or in model ```CoinmarketcapFree::Coin```
+
+``` Ruby
+    coin = CoinmarketcapFree::Coin.list.first
+    histories = coin.histories('1D')
+    histories = coin.one_day
+    histories = coin.seven_days
+    histories = coin.one_month
+    histories = coin.three_months
+    histories = coin.one_year
+    histories = coin.current_year
+    histories = coin.all
+```
+
+####Result:
+
+Model:
+
+```Ruby
+ [... #<CoinmarketcapFree::CoinHistory:0x0000000106479530
+  @market_cap=1317962149986.5,
+  @price=67084.17926825049,
+  @time=2024-03-06 19:50:10 +0200,
+  @totaly_supply=19646392.999999978,
+  @volume_24h=92029823321.77837>]
+```
+
+Json:
+```JSON
  {
      "data": {
          "points": {
@@ -211,22 +308,21 @@ Result:
  
 ```
 
-Parameters for CoinmarketcapFree::CoinHistory.custom_time:
+Parameters for ```CoinmarketcapFree::CoinHistory.custom_time``` or ```CoinmarketcapFree.coin_histories```:
 
 | Name             | Type     | Description                                   | Examples                                                                                                           |
 |:-----------------|:---------|:----------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|
-| ```id```         | Integer. | Cryptocurrency identifier from coinmarketcap. | Bitcoin has the number 1                                                                                           |
-| ```range_time``` | String.  | Range time.                                   | ```1D```, ```7D```, ```1M```, ```3M```, ```1Y```, ```YTD```, ```ALL``` or custom range ```1668981600~1671659999``` |
+| ```id```         | Integer | Cryptocurrency identifier from coinmarketcap. | Bitcoin has id 1                                                                                           |
+| ```range_time``` | String  | Range time.                                   | ```1D```, ```7D```, ```1M```, ```3M```, ```1Y```, ```YTD```, ```ALL``` or custom range ```1668981600~1671659999``` |
 
-### Generation a link to access the picture:
+### Generation a link:
 
 ``` Ruby
-logo_coin_url = CoinmarketcapFree::Icon.generate_url(1, 64)
+    coin = CoinmarketcapFree.coins.first # take first coin
+    icon = coin.get_icon(64) # generate string uri
 ```
 
-``` Ruby
-"https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"
-```
+Result string: ```https://s2.coinmarketcap.com/static/img/coins/64x64/1.png```
 
 | Name             | Type     | Description                                   | Examples                                                                                                           |
 |:-----------------|:---------|:----------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|

data/lib/coinmarketcap_free/coin/histories.rb

@@ -0,0 +1,29 @@
+module CoinmarketcapFree
+  class Coin
+    # Create all methods for each time interval
+    CoinHistory::INTERVAL_TIME.each do |key, value|
+      class_eval("def #{key}; histories('#{value}'); end", __FILE__, __LINE__)
+    end
+
+    # Get the full history of cryptocurrencies and their prices.
+    #
+    #     coin = CoinmarketcapFree::Coin.list.first
+    #     histories = coin.histories('1D')
+    #
+    # or
+    #
+    #     histories = coin.one_day
+    #     histories = coin.seven_days
+    #     histories = coin.one_month
+    #     histories = coin.three_months
+    #     histories = coin.one_year
+    #     histories = coin.current_year
+    #     histories = coin.all
+    #
+    # @param interval [String] Select time interval. ('1D', '7D', '1M', '3M', '1Y', 'YTD', 'ALL' or custom '1668981600~1671659999')
+    # @return [Array<CoinmarketcapFree::CoinHistory>] Return CoinHistory object
+    def histories(interval)
+      CoinHistory.custom_time(@id, interval)
+    end
+  end
+end

data/lib/coinmarketcap_free/coin/icon.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CoinmarketcapFree
+  class Coin
+    # Generate a URI icon of a coin
+    #
+    #   coin = CoinmarketcapFree::Coin.list.first
+    #   logo = coin.get_icon(64) # size 64x64
+    #
+    # Result:
+    #
+    #   "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"
+    #
+    # @param [Integer] id_coin Identify coin. For example, bitcoin has 1
+    # @param [Integer] size Choose one size: 64, 128, 200
+    # @return [String] Return URI from coinmarketcap
+    def get_icon(size)
+      size_x_size = case size
+                    when 64, 128, 200
+                      "#{size}x#{size}"
+                    else
+                      raise ArgumentError, "Can't find this value: #{size}"
+                    end
+      "https://s2.coinmarketcap.com/static/img/coins/#{size_x_size}/#{@id}.png"
+    end
+  end
+end

data/lib/coinmarketcap_free/coin/model.rb

@@ -0,0 +1,63 @@
+module CoinmarketcapFree
+  class Coin
+    FullName = Struct.new('FullName',
+                          :name,
+                          :symbol,
+                          :slug) do
+                            def self.convert_json(data)
+                              FullName.new(data['name'],
+                                           data['symbol'],
+                                           data['slug'])
+                            end
+                          end
+
+    Supply = Struct.new("Supply",
+                        :circulating,
+                        :total,
+                        :maximum) do
+                          def self.convert_json(data)
+                            Supply.new(data['circulatingSupply'],
+                                       data['totalSupply'],
+                                       data['maxSupply'])
+                          end
+                        end
+
+    State = Struct.new("State",
+                       :last_updated,
+                       :added) do
+                         def self.convert_json(data)
+                           State.new(DateTime.parse(data['lastUpdated']),
+                                     DateTime.parse(data['dateAdded']))
+                         end
+                       end
+
+    Quotes = Struct.new("Quotes",
+                        :name,
+                        :price,
+                        :volume_24h,
+                        :market_cap,
+                        :percent_change_1h,
+                        :percent_change_24h,
+                        :percent_change_7d,
+                        :percent_change_30d,
+                        :percent_change_60d,
+                        :percent_change_90d,
+                        :percent_change_1y,
+                        :last_updated) do
+                          def self.convert_json(data)
+                            Quotes.new(data['name'],
+                                       data['price'],
+                                       data['volume24h'],
+                                       data['marketCap'],
+                                       data['percentChange1h'],
+                                       data['percentChange24h'],
+                                       data['percentChange7d'],
+                                       data['percentChange30d'],
+                                       data['percentChange60d'],
+                                       data['percentChange90d'],
+                                       data['percentChange1y'],
+                                       DateTime.parse(data['lastUpdated']))
+                          end
+                        end
+  end
+end

data/lib/coinmarketcap_free/coin.rb

@@ -1,18 +1,65 @@
 # frozen_string_literal: true
 
 require_relative 'helper'
+require_relative 'coin/icon'
+require_relative 'coin/model'
+require_relative 'coin_history'
+require_relative 'coin/histories'
 
 module CoinmarketcapFree
-  # All about cryptocurrencies and their prices.
-  module Coin
-    URI_API = "#{BASE_URI}#{VERSION_API}/cryptocurrency/listing"
+  # Model for Cryptocurrency
+  class Coin
+    attr_accessor :id,
+                  :name,
+                  :tags,
+                  :cmc_rank,
+                  :market_pair_count,
+                  :supply,
+                  :state,
+                  :quotes
+
+    def initialize(id, name, tags, cmc_rank, market_pair_count, supply, state, quotes)
+      @id = id
+      @name = name
+      @tags = tags
+      @cmc_rank = cmc_rank
+      @market_pair_count = market_pair_count
+      @supply = supply
+      @state = state
+      @quotes = quotes
+    end
 
     class << self
       # Get a list of cryptocurrencies
       #
       #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1)
       #
-      # Result json:
+      # If you want to sort in ascending, just write parameter:
+      #
+      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc')
+      #
+      # or in descending
+      #
+      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'desc')
+      #
+      # Or sort by name with ascending:
+      #
+      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc', sort_by: 'name')
+      #
+      # Convert cryptocurrency to USD:
+      #
+      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, convert: 'USD')
+      #
+      # or together
+      #
+      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, convert: 'USD,BTC,ETH')
+      #
+      # Also you can get all histories of cryptocurrency:
+      #
+      #   coin = CoinmarketcapFree::Coin.list(limit: 100, start: 1).first
+      #   coin.histories('1D')
+      #
+      # Result json data:
       #
       #   {
       #     "data": {
@@ -101,24 +148,6 @@ module CoinmarketcapFree
       # 'totalCount' - Total number of cryptocurrencies
       # 'status' - Standardized status object for API calls.
       #
-      # If you want to sort in ascending, just write parameter:
-      #
-      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc')
-      #
-      # or
-      #
-      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'desc')
-      #
-      # You can also adding sort by:
-      #
-      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, sort_type:'asc', sort_by: 'name')
-      #
-      # Convert cryptocurrency to::
-      #
-      #   list = CoinmarketcapFree::Coin.list(limit: 100, start: 1, convert: 'USD,BTC,ETH')
-      #
-      #
-      # @return [String]
       # @param start [Integer] Optionally offset the start (1-based index) of the paginated list of items to return.
       # @param limit [Integer] Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
       # @param sort_by [String] What field to sort the list of cryptocurrencies by. ('rank', 'name', 'symbol', 'date_added', 'market_cap', 'market_cap_strict', 'price', 'circulating_supply', 'total_supply', 'max_supply', 'num_market_pairs', 'volume_24h', 'percent_change_1h', 'percent_change_24h', 'percent_change_7d', 'market_cap_by_total_supply_strict', 'volume_7d', 'volume_30d")
@@ -127,14 +156,48 @@ module CoinmarketcapFree
       # @param crypto_type [String] The type of cryptocurrency to include. ('all', 'coins', 'tokens')
       # @param tag_type [String] The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
       # @param audited [TrueClass, FalseClass] Show audited 'true' or not 'false'
-      # @param aux [String] Optionally specify a comma-separated list of supplemental data fields to return. Pass 'ath, atl, high24h, low24h, num_market_pairs, cmc_rank, date_added, max_supply, circulating_supply, total_supply, volume_7d, volume_30d, self_reported_circulating_supply, self_reported_market_cap' to include all auxiliary fields.
       # @param tags [String] If you want to see cryptocurrencies that can be mined, just type 'mineable'.
       # @param volume24h_range [String] Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
       # @param percent_change24h_range [String] Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
       # @param circulating_supply_range [String] Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
       # @param price_range [String] Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
       # @param market_cap_range [String] Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
+      # @return [CoinmarketcapFree::Coin] Return Coin object
       def list(**params)
+        options = generate_options(params)
+        json = Helper.get_cryptocarencies(options)
+
+        @total_count = json['data']['totalCount'].to_i # update total count
+
+        json['data']["cryptoCurrencyList"].map { |coin| Coin.convert_json(coin) }
+      end
+
+      def total_count
+        @total_count || 0
+      end
+
+      # Convert json data to Coin
+      # @param data [Hash] Data
+      # @return [CoinmarketcapFree::Coin] Return Coin object
+      def convert_json(data)
+        id = data['id']
+        name = FullName.convert_json(data)
+        tags = data['tags'] || []
+        cmc_rank = data['cmcRank']
+        market_pair_count = data['marketPairCount']
+        supply = Supply.convert_json(data)
+        state = State.convert_json(data)
+        quotes = data['quotes'].nil? ? [] : data['quotes'].map { |quote| Quotes.convert_json(quote) }
+
+        Coin.new(id, name, tags, cmc_rank, market_pair_count, supply, state, quotes)
+      end
+
+      private
+
+      # Generate options
+      # @param params [Hash]
+      # @return [Hash] Return options
+      def generate_options(params)
         options = {}
 
         options[:start] = params[:start] || 1 # Integer
@@ -145,7 +208,6 @@ module CoinmarketcapFree
         options[:cryptoType] = params[:crypto_type] || 'all' # String
         options[:tagType] = params[:tag_type] || 'all' # String
         options[:audited] = params[:audited] || false # Boolean
-        options[:aux] = params[:aux] # String
         options[:tags] = params[:tags] # String
         options[:volume24hRange] = params[:volume24h_range] # String
         options[:percentChange24hRange] = params[:percent_change24h_range] # String
@@ -153,7 +215,7 @@ module CoinmarketcapFree
         options[:priceRange] = params[:price_range] # String
         options[:marketCapRange] = params[:market_cap_range] # String
 
-        Helper.http_get(URI_API, options)
+        options
       end
     end
   end

data/lib/coinmarketcap_free/coin_history.rb

@@ -1,12 +1,8 @@
-# frozen_string_literal: true
-
 require_relative 'helper'
 
 module CoinmarketcapFree
-  # All history cryptocurrency and their prices.
-  module CoinHistory
-    URI_API = "#{BASE_URI}#{VERSION_API}/cryptocurrency/detail/chart"
-
+  # Model for Cryptocurrency History
+  class CoinHistory
     INTERVAL_TIME = {
       one_day: '1D',
       seven_days: '7D',
@@ -17,36 +13,56 @@ module CoinmarketcapFree
       all: 'ALL'
     }.freeze
 
+    attr_accessor :time,
+                  :price,
+                  :volume_24h,
+                  :market_cap,
+                  :totaly_supply
+
+    def initialize(date, price, volume_24h, market_cap, totaly_supply)
+      @time = date
+      @price = price
+      @volume_24h = volume_24h
+      @market_cap = market_cap
+      @totaly_supply = totaly_supply
+    end
+
     class << self
       # Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.
       #
-      # You can use one of the following intervals: 1D, 7D, 1M, 3M, 1Y, YTD, ALL
+      # You can use one of the following intervals: 1D, 7D, 1M, 3M, 1Y, YTD, ALL or custom range '1668981600~1671659999'
+      # or call the method by its full name: one_day, seven_days, one_month, three_months, one_year, current_year, all
       #
-      #   history = CoinmarketcapFree::CoinHistory.custom_time(1, '1D')
+      #   history = CoinmarketcapFree::CoinHistory.custom_time(id_coin, '1D')
       #
-      # Also you can use this method like this:
+      # or
       #
-      #   history = CoinmarketcapFree::CoinHistory.interval_one_day(1)
+      #   histories = CoinmarketcapFree::CoinHistory.one_day(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.seven_days(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.one_month(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.three_months(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.one_year(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.current_year(id_coin)
+      #   histories = CoinmarketcapFree::CoinHistory.all(id_coin)
       #
-      # Just add a prefix to the method: interval_(one_day, seven_days, one_month, three_months, one_year, current_year, all)
       #
       # Result json:
       #
       #   {
       #     "data": {
       #         "points": {
-      #             "1673192010": {
+      #             "1673192010": { # time in seconds
       #               "v": [
-      #                     16953.771282696678,
-      #                     7609543976.45,
-      #                     326457581376.786557398500,
+      #                     16953.771282696678, # price
+      #                     7609543976.45, # volume 24h
+      #                     326457581376.786557398500, # market cap
       #                     1,
-      #                     19255750.00000000000000000000
+      #                     19255750.00000000000000000000 # total supply
       #                 ],
       #                 "c": [
-      #                     16953.771282696678,
-      #                     7609543976.45,
-      #                     326457581376.786557398500
+      #                     16953.771282696678, # price
+      #                     7609543976.45, # volume 24h
+      #                     326457581376.786557398500 # market cap
       #                 ]
       #             },
       #           ...
@@ -68,19 +84,35 @@ module CoinmarketcapFree
       #
       # @param id [Integer] Cryptocurrency identifier from coinmarketcap. For example, Bitcoin has the number 1
       # @param range_time [String] Range time. For example, '1D', '7D', '1M', '3M', '1Y', 'YTD', 'ALL' or custom range '1668981600~1671659999'
-      # @return [String]
+      # @return [Array<CoinmarketcapFree::CoinHistory] Return CoinHistory object
       def custom_time(id, range_time)
-        Helper.http_get(URI_API, { id: id, range: range_time })
+        json = Helper.get_cryptocurrency_histories({ id: id, range: range_time })
+
+        json['data']['points'].map { |key, value| CoinHistory.convert_json(key, value['v']) }
       end
 
-      # Creating interval methods
+      # Create interval methods
       INTERVAL_TIME.each do |key, value|
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def interval_#{key}
+          def #{key}(id)
             custom_time(id, '#{value}')
           end
         RUBY
       end
+
+      # Convert json data to CoinHistory
+      # @param utc_timestamp [Integer] Time in seconds
+      # @param data [Array] Data
+      # @return [CoinmarketcapFree::CoinHistory] Return CoinHistory object
+      def convert_json(utc_timestamp, data)
+        timestamp = utc_timestamp.is_a?(String) ? utc_timestamp.to_i : utc_timestamp
+
+        CoinHistory.new(Time.at(timestamp), # convert time utc
+                        data[0],  # price
+                        data[1],  # volume 24h
+                        data[2], # market cap
+                        data[4]) # total supply
+      end
     end
   end
 end

data/lib/coinmarketcap_free/helper.rb

@@ -1,24 +1,42 @@
-# frozen_string_literal: true
-
 require 'uri'
 require 'net/http'
 require 'openssl'
 require 'json'
+require 'date'
 
 module CoinmarketcapFree
-  BASE_URI = 'https://api.coinmarketcap.com/data-api/'
-  VERSION_API = 'v3'
-
-  # Helper module for CoinmarketcapFree
+  # Helper module
   module Helper
+    BASE_URI = 'https://api.coinmarketcap.com/data-api/'
+    VERSION_API = 'v3'
+
+    URI_API_CRYPTOCURRENCIES = "#{BASE_URI}#{VERSION_API}/cryptocurrency/listing"
+    URI_API_CRYPTOCURRENCY_HISTORIES = "#{BASE_URI}#{VERSION_API}/cryptocurrency/detail/chart"
+
     class << self
+      # Get cryptocurrency of histories
+      # @param data [Hash] Parameters for Coinmarketcap API
+      # @return [Hash] Return coin histories
+      def get_cryptocurrency_histories(data)
+        str = http_get(URI_API_CRYPTOCURRENCY_HISTORIES, data)
+        JSON.parse(str)
+      end
+
+      # Get cryptocurrencies
+      # @param data [Hash] Parameters for Coinmarketcap API
+      # @return [Hash] Return cryptocurrencies
+      def get_cryptocarencies(data)
+        str = http_get(URI_API_CRYPTOCURRENCIES, data)
+        JSON.parse(str)
+      end
+
+      private
+
       def http_get(url, data = nil)
         uri = URI(generate_url(url, data))
         Net::HTTP.get(uri)
       end
 
-      private
-
       def generate_url(url, data = nil)
         "#{url}#{data ? '?' : ''}#{data.map { |key, value| "#{key}=#{value}" }.join('&')}"
       end

data/lib/coinmarketcap_free/version.rb

@@ -2,8 +2,8 @@
 
 # Get data from Coinmarketcap API without requiring an API key.
 module CoinmarketcapFree
-  MAJOR = 0
-  MINOR = 4
+  MAJOR = 1
+  MINOR = 0
   PATCH = 1
 
   private_constant :MAJOR, :MINOR, :PATCH

data/lib/coinmarketcap_free.rb

@@ -1,8 +1,5 @@
-# frozen_string_literal: true
-
 require_relative 'coinmarketcap_free/coin_history'
 require_relative 'coinmarketcap_free/coin'
-require_relative 'coinmarketcap_free/icon'
 require_relative 'coinmarketcap_free/version'
 
 # Get data from Coinmarketcap API without requiring an API key.
@@ -16,24 +13,21 @@ module CoinmarketcapFree
     #
     #   list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'asc')
     #
-    # or
+    # or in descending
     #
     #   list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'desc')
     #
-    # You can also adding sort by:
+    # Or sort by name with ascending:
     #
     #   list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'asc', sort_by: 'name')
     #
-    # Convert cryptocurrency to::
-    #
-    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH')
+    # Convert cryptocurrency to USD:
     #
-    # Also you can use this method like this:
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD')
     #
-    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH') do |data|
-    #       JSON.parse(data)
-    #   end
+    # or together
     #
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH')
     #
     # @param start [Integer] Optionally offset the start (1-based index) of the paginated list of items to return.
     # @param limit [Integer] Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
@@ -43,61 +37,33 @@ module CoinmarketcapFree
     # @param crypto_type [String] The type of cryptocurrency to include. ('all', 'coins', 'tokens')
     # @param tag_type [String] The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
     # @param audited [TrueClass, FalseClass] Show audited 'true' or not 'false'
-    # @param aux [String] Optionally specify a comma-separated list of supplemental data fields to return. Pass 'ath, atl, high24h, low24h, num_market_pairs, cmc_rank, date_added, max_supply, circulating_supply, total_supply, volume_7d, volume_30d, self_reported_circulating_supply, self_reported_market_cap' to include all auxiliary fields.
     # @param tags [String] If you want to see cryptocurrencies that can be mined, just type 'mineable'.
     # @param volume24h_range [String] Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
     # @param percent_change24h_range [String] Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
     # @param circulating_supply_range [String] Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
     # @param price_range [String] Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
     # @param market_cap_range [String] Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
-    # @return [Hash]
+    # @return [Array<CoinmarketcapFree::Coin>] Return CoinmarketcapFree::Coin object
     def coins(**params)
-      data = Coin.list(**params)
-
-      return yield data if block_given?
-
-      JSON.parse(data)
+      Coin.list(**params)
     end
 
     # Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.
     #
-    # You can use one of the following intervals: 1D, 7D, 1M, 3M, 1Y, YTD, ALL
-    #
-    #   history = CoinmarketcapFree.coin_history(1, '1D')
+    # You can use one of the following intervals: 1D, 7D, 1M, 3M, 1Y, YTD, ALL or custom range like this '1668981600~1671659999'
+    # or call the method by its full name: one_day, seven_days, one_month, three_months, one_year, current_year, all
     #
-    # Also you can use this method like this:
+    #   history = CoinmarketcapFree::CoinHistory.custom_time(id_coin, '1D')
     #
-    #   history = CoinmarketcapFree.coin_history(1, '1668981600~1671659999') do |data|
-    #       JSON.parse(data)
-    #   end
+    # OR
     #
-    # 'data' - Results of your query returned as an object map.
-    # 'points' - Price range history
-    # 'status' - Standardized status object for API calls.
+    #   history = CoinmarketcapFree::CoinHistory.one_day(id_coin)
     #
     # @param id [Integer] Cryptocurrency identifier from coinmarketcap. For example, Bitcoin has the number 1
-    # @param range_time [String] Range time. For example, '1D', '7D', '1M', '3M', '1Y', 'YTD', 'ALL' or custom range '1668981600~1671659999'
-    # @return [Hash]
-    def coin_history(id, range_time)
-      data = CoinHistory.custom_time(id, range_time)
-
-      return yield data if block_given?
-
-      JSON.parse(data)
-    end
-
-    # Generate URI image of a coin
-    #
-    #   logo = CoinmarketcapFree.coin_icon(1, 64)
-    #
-    # Result:
-    #   "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"
-    #
-    # @param [Integer] id_coin Identify coin. For example, bitcoin has 1
-    # @param [Integer] size Choose one size: 64, 128, 200
-    # @return [String] Return URI from coinmarketcap
-    def coin_icon(id_coin, size)
-      Icon.generate_url(id_coin, size)
+    # @param range_time [String] Range time. For example, '1D', '7D', '1M', '3M', '1Y', 'YTD', 'ALL' or custom range like this '1668981600~1671659999'
+    # @return [Array<CoinmarketcapFree::CoinHistory] Return CoinHistory object
+    def coin_histories(id, range_time)
+      CoinHistory.custom_time(id, range_time)
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinmarketcap_free
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Vitalii Bakun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-12 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies: []
 description: Cryptocurrency information from the Coinmarketcap site without a key.
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
@@ -25,9 +26,11 @@ files:
 - Rakefile
 - lib/coinmarketcap_free.rb
 - lib/coinmarketcap_free/coin.rb
+- lib/coinmarketcap_free/coin/histories.rb
+- lib/coinmarketcap_free/coin/icon.rb
+- lib/coinmarketcap_free/coin/model.rb
 - lib/coinmarketcap_free/coin_history.rb
 - lib/coinmarketcap_free/helper.rb
-- lib/coinmarketcap_free/icon.rb
 - lib/coinmarketcap_free/version.rb
 homepage:
 licenses:

data/lib/coinmarketcap_free/icon.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module CoinmarketcapFree
-  # Get static image of a coin from coinmarketcap.com
-  module Icon
-    class << self
-      # Generate URI image of a coin
-      #
-      #   logo = CoinmarketcapFree::Icon.generate_url(1, 64)
-      #
-      # Result:
-      #   "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"
-      #
-      # @param [Integer] id_coin Identify coin. For example, bitcoin has 1
-      # @param [Integer] size Choose one size: 64, 128, 200
-      # @return [String] Return URI from coinmarketcap
-      def generate_url(id_coin, size)
-        size_x_size = case size
-                      when 64, 128, 200
-                        "#{size}x#{size}"
-                      else
-                        raise ArgumentError, "Can't find this value: #{size}"
-                      end
-        "https://s2.coinmarketcap.com/static/img/coins/#{size_x_size}/#{id_coin}.png"
-      end
-    end
-  end
-end