coinmarketcap_free 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f89d021dcc8f88f0730ed6c3a95de9fe66125138007e30f643e2637c3cc0829
-  data.tar.gz: 5402fc9c5ff6766a6ee126057de2e12d96519c9622325b3d939e978f5e8f5dcb
+  metadata.gz: 4297fadc64121db9012143a350b4030cd841416f7a7b6fdeb07b46a3234b6af9
+  data.tar.gz: 9860e70e322113e3cc9fbeae4af47a71c0f69032931b28705fb09448fdf42091
 SHA512:
-  metadata.gz: 47678471ba7e3a8362485be4f4781d0c0837c22b969e90f20bcb40bfe662080827742fe6790137102817b076f18bb3a45685ef6199ea829d5d2cb861960835e9
-  data.tar.gz: 3a46d496f02511b7b6536c8d4dda4b1cc4ca73ee485b39a8271ca5ce1436ff0404563633ab792028f5226c8226b3426074f8497a6fed249b66408f9a90fac586
+  metadata.gz: 47a049b178e777f9bf609ccd2a4015e36e4340626dc311d9850adc513e8530020c7a68a16a9d501bad48bcdf4fed516cbf4dd3f9454c000f7d0aed7aa92b811a
+  data.tar.gz: c54fc0e35cbbf0dc6c36f3ea8426eeaacfb11116baa46adb14b9638941d6d6f6c48eb4c395692b21371c832d6efcb7caddfc37fb9290323c8c6b0763f91f8b35

data/Gemfile.lock

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

data/lib/coinmarketcap_free/coin.rb

@@ -54,71 +54,6 @@ module CoinmarketcapFree
       @id = id
       @range_time = range_time
     end
-    class << self
-      @@coin = Coin.new()
-
-      # Returns an interval of historic for the day
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_day(id)
-        history(id, '1D')
-      end
-      # Returns an interval of historic for the seven days
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_seven_days(id)
-        history(id, '7D')
-      end
-      # Returns an interval of historic for the one month
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_one_month(id)
-        history(id, '1M')
-      end
-      # Returns an interval of historic for the three months
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_three_months(id)
-        history(id, '3M')
-      end
-      # Returns an interval of historic for the one year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_one_year(id)
-        history(id, '1Y')
-      end
-      # Returns an interval of historic for the current year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_current_year(id)
-        history(id, 'YTD')
-      end
-      # Returns an interval of historic for the current year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def history_all(id)
-        history(id, 'ALL')
-      end
-
-      # Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.
-      #
-      # Unix Epoch. (SECONDS SINCE JAN 01 1970 (UTC))
-      #
-      #   CoinmarketcapFree::Coin.history_custom_time(1, 1675085165, 1675105165)
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      # @param [Integer] from Enter a Timestamp
-      # @param [Integer] to Enter a Timestamp
-      def history_custom_time(id, from, to)
-        history(id, "#{from}~#{to}")
-      end
-
-      private def history(id, range_time)
-        @@coin.id = id
-        @@coin.range_time = range_time
-        @@coin.update ? @@coin.get_data : nil
-      end
-    end
 
     private
     def generate_uri_for_data

data/lib/coinmarketcap_free/cryptocurrencies.rb

@@ -114,40 +114,53 @@ module CoinmarketcapFree
     URL_API = 'https://api.coinmarketcap.com/data-api/v3/cryptocurrency/listing'.freeze
     private_constant :URL_API
 
-    # Returns the CoinmarketcapFree::Cryptocurrencies that's dictated by the options hash. The primary options are:
+    # Returns the CoinmarketcapFree::Cryptocurrencies that's dictated by the options hash.
     #
-    # @param [Hash] options the parameters for creating a request to the server
-    # @option options [Integer] :start (1) Optionally offset the start (1-based index) of the paginated list of items to return.
-    # @option options [Integer] :limit (100) Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
-    # @option options [String] :sortBy ('market_cap') 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")
-    # @option options [String] :sortType ('desc') The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
-    # @option options [String] :convert ('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'). For example, many 'USD,BTC,ETH' to convert or only one 'USD'
-    # @option options [String] :cryptoType ('all') The type of cryptocurrency to include. ('all', 'coins', 'tokens')
-    # @option options [String] :tagType ('all') The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
-    # @option options [false, true] :audited Show audited 'true' or not 'false'
-    # @option options [String] :aux 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.
-    # @option options [String] :tags If you want to see cryptocurrencies that can be mined, just type 'mineable'.
-    # @option options [String] :volume24hRange Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :percentChange24hRange Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
-    # @option options [String] :circulatingSupplyRange Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :priceRange Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :marketCapRange Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
-    def initialize(options = {})
-      @limit = options[:limit].nil? ? 100 : options[:limit] # Integer
-      @start = options[:start].nil? ? 1 : options[:start] # Integer
-      @sortBy = options[:sortBy] # String
-      @sortType = options[:sortType] # String
-      @convert = options[:convert] # String
-      @cryptoType = options[:cryptoType] # String
-      @tagType = options[:tagType] # String
-      @audited = options[:audited] # Boolean
-      @aux = options[:aux] # String
-      @tags = options[:tags] # String
-      @volume24hRange = options[:volume24hRange] # String
-      @percentChange24hRange = options[:percentChange24hRange] # String
-      @circulatingSupplyRange = options[:circulatingSupplyRange] # String
-      @priceRange = options[:priceRange] # String
-      @marketCapRange = options[:marketCapRange] # String
+    # @param [Integer] start Optionally offset the start (1-based index) of the paginated list of items to return.
+    # @param [Integer] limit Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
+    # @param [String (frozen)] sortBy 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")
+    # @param [String (frozen)] sortType The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
+    # @param [String (frozen)] convert 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'). For example, many 'USD,BTC,ETH' to convert or only one 'USD'
+    # @param [String (frozen)] cryptoType The type of cryptocurrency to include. ('all', 'coins', 'tokens')
+    # @param [String (frozen)] tagType The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
+    # @param [TrueClass, FalseClass] audited Show audited 'true' or not 'false'
+    # @param [String (frozen)] aux 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 [String (frozen)] tags If you want to see cryptocurrencies that can be mined, just type 'mineable'.
+    # @param [String (frozen)] volume24hRange Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] percentChange24hRange Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
+    # @param [String (frozen)] circulatingSupplyRange Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] priceRange Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] marketCapRange Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
+    def initialize(start:1,
+                   limit:100, 
+                   sortBy: 'market_cap',
+                   sortType:'desc', 
+                   convert:'USD', 
+                   cryptoType:'all',
+                   tagType:'all',
+                   audited:false,
+                   aux:nil, 
+                   tags:nil,
+                   volume24hRange:nil,
+                   percentChange24hRange:nil,
+                   circulatingSupplyRange:nil,
+                   priceRange:nil,
+                   marketCapRange:nil)
+      @limit = limit # Integer
+      @start = start # Integer
+      @sortBy = sortBy # String
+      @sortType = sortType # String
+      @convert = convert # String
+      @cryptoType = cryptoType # String
+      @tagType = tagType # String
+      @audited = audited # Boolean
+      @aux = aux # String
+      @tags = tags # String
+      @volume24hRange = volume24hRange # String
+      @percentChange24hRange = percentChange24hRange # String
+      @circulatingSupplyRange = circulatingSupplyRange # String
+      @priceRange = priceRange # String
+      @marketCapRange = marketCapRange # String
     end
 
     attr_accessor :limit,

data/lib/coinmarketcap_free/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CoinmarketcapFree
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/coinmarketcap_free.rb

@@ -58,6 +58,68 @@ module CoinmarketcapFree
       @@coin.update ? @@coin.get_data : nil
     end
 
+    # Returns an interval of historic for the day
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_day(id)
+      coin_history(id, '1D')
+    end
+
+    # Returns an interval of historic for the seven days
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_seven_days(id)
+      coin_history(id, '7D')
+    end
+
+    # Returns an interval of historic for the one month
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_one_month(id)
+      coin_history(id, '1M')
+    end
+
+    # Returns an interval of historic for the three months
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_three_months(id)
+      coin_history(id, '3M')
+    end
+
+    # Returns an interval of historic for the one year
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_one_year(id)
+      coin_history(id, '1Y')
+    end
+
+    # Returns an interval of historic for the current year
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_current_year(id)
+      coin_history(id, 'YTD')
+    end
+
+    # Returns an interval of historic for the current year
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    def coin_history_all(id)
+      coin_history(id, 'ALL')
+    end
+
+    # Returns an interval of historic market quotes for any cryptocurrency based on time and interval parameters.
+    #
+    # Unix Epoch. (SECONDS SINCE JAN 01 1970 (UTC))
+    #
+    #   CoinmarketcapFree.coin_history_custom_time(1, 1675085165, 1675105165)
+    #
+    # @param [Integer] id Cryptocurrency identifier
+    # @param [Integer] from Enter a Timestamp
+    # @param [Integer] to Enter a Timestamp
+    def coin_history_custom_time(id, from, to)
+      coin_history(id, "#{from}~#{to}")
+    end
+
     # Get a list of cryptocurrencies
     #
     #   list = CoinmarketcapFree.coins(limit: 100, start: 1)
@@ -168,28 +230,52 @@ module CoinmarketcapFree
     #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH')
     #
     #
-    # @param [Hash] options the parameters for creating a request to the server
     # @return [String, nil]
-    # @option options [Integer] :start (1) Optionally offset the start (1-based index) of the paginated list of items to return.
-    # @option options [Integer] :limit (100) Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
-    # @option options [String] :sortBy ('market_cap') 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")
-    # @option options [String] :sortType ('desc') The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
-    # @option options [String] :convert ('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'). For example, many 'USD,BTC,ETH' to convert or only one 'USD'
-    # @option options [String] :cryptoType ('all') The type of cryptocurrency to include. ('all', 'coins', 'tokens')
-    # @option options [String] :tagType ('all') The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
-    # @option options [false, true] :audited Show audited 'true' or not 'false'
-    # @option options [String] :aux 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.
-    # @option options [String] :tags If you want to see cryptocurrencies that can be mined, just type 'mineable'.
-    # @option options [String] :volume24hRange Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :percentChange24hRange Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
-    # @option options [String] :circulatingSupplyRange Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :priceRange Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
-    # @option options [String] :marketCapRange Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
-    def coins(options = {})
-      @@cryptocurrencies.instance_variables.each do |var_name|
-        value = options[var_name.to_s.delete('@').to_sym]
-        @@cryptocurrencies.instance_variable_set(var_name, value) unless value.nil?
-      end
+    # @param [Integer] start Optionally offset the start (1-based index) of the paginated list of items to return.
+    # @param [Integer] limit Optionally specify the number of results to return. Use this parameter and the 'start' parameter to determine your own pagination size.
+    # @param [String (frozen)] sortBy 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")
+    # @param [String (frozen)] sortType The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
+    # @param [String (frozen)] convert 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'). For example, many 'USD,BTC,ETH' to convert or only one 'USD'
+    # @param [String (frozen)] cryptoType The type of cryptocurrency to include. ('all', 'coins', 'tokens')
+    # @param [String (frozen)] tagType The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
+    # @param [TrueClass, FalseClass] audited Show audited 'true' or not 'false'
+    # @param [String (frozen)] aux 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 [String (frozen)] tags If you want to see cryptocurrencies that can be mined, just type 'mineable'.
+    # @param [String (frozen)] volume24hRange Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] percentChange24hRange Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
+    # @param [String (frozen)] circulatingSupplyRange Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] priceRange Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
+    # @param [String (frozen)] marketCapRange Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
+    def coins(start: 1,
+              limit: 100,
+              sortBy: 'market_cap',
+              sortType: 'desc',
+              convert: 'USD',
+              cryptoType: 'all',
+              tagType: 'all',
+              audited: false,
+              aux: nil,
+              tags: nil,
+              volume24hRange: nil,
+              percentChange24hRange: nil,
+              circulatingSupplyRange: nil,
+              priceRange: nil,
+              marketCapRange: nil)
+      @@cryptocurrencies.limit = limit # Integer
+      @@cryptocurrencies.start = start # Integer
+      @@cryptocurrencies.sortBy = sortBy # String
+      @@cryptocurrencies.sortType = sortType # String
+      @@cryptocurrencies.convert = convert # String
+      @@cryptocurrencies.cryptoType = cryptoType # String
+      @@cryptocurrencies.tagType = tagType # String
+      @@cryptocurrencies.audited = audited # Boolean
+      @@cryptocurrencies.aux = aux # String
+      @@cryptocurrencies.tags = tags # String
+      @@cryptocurrencies.volume24hRange = volume24hRange # String
+      @@cryptocurrencies.percentChange24hRange = percentChange24hRange # String
+      @@cryptocurrencies.circulatingSupplyRange = circulatingSupplyRange # String
+      @@cryptocurrencies.priceRange = priceRange # String
+      @@cryptocurrencies.marketCapRange = marketCapRange # String
 
       @@cryptocurrencies.update ? @@cryptocurrencies.get_data : nil
     end
@@ -208,7 +294,8 @@ module CoinmarketcapFree
       size_x_size = case size
                     when 64, 128, 200
                       "#{size}x#{size}"
-                    else raise ArgumentError
+                    else
+                      raise ArgumentError, "Can't find this value: #{size}"
                     end
       "https://s2.coinmarketcap.com/static/img/coins/#{size_x_size}/#{id_coin}.png"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinmarketcap_free
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - cosmic-1
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies: []
 description: Cryptocurrency information from the Coinmarketcap site without a key.
 email: