coinmarketcap_free 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c559f0f1d6dea4119d9c1c6fd6fb9d44b03559c80c694c9c18e4a452a285ed5
-  data.tar.gz: c1927861d0070f84d8c4aabaf6045de7b2da4d0a1230349bf19e257995d51d84
+  metadata.gz: f99259c2770c1da474bbe12a544a7f58456937344edc89c8f0ff99c50b266610
+  data.tar.gz: 70bb17060a85b994ec966d869eb6c64a621c504ab9ec70cd0957b6a43d875144
 SHA512:
-  metadata.gz: 94665066f532975bcfd68ed72feb3b9905e9372d9b01562ea6d5a0929a3f8604358feb578f0ffcf42e86464e103877d5549e22d4fc1e7e31565df40be64d8c13
-  data.tar.gz: 4f43a77dd4718c0be2760aabda58338741ee29e38318a5f3eb3d0b0cc06009bf4ea852f34260c0eb4b2aa50fbefa6c1157d331ae4b019b4533281f61574ff93c
+  metadata.gz: c5b48661bb1c59169e47210369320616695ea577faee4fb6b0a3bf3bcb8f413ed46cdaaea0d419fa6cceb74c9ae0e1e1a654175bd1224bcfc903cc6e3be27795
+  data.tar.gz: ea3166026893e67d2d802dd16837ff47edde03d1a4bdee6cb8744c3fe6fc6bb43b714e4a8fda5e36eb8e67eba9815cd17ef21cf632e3825e0820c81ed198a300

data/.rubocop.yml

@@ -107,7 +107,7 @@ Style/DataInheritance: # new in 1.49
 Style/DirEmpty: # new in 1.48
   Enabled: true
 Style/DocumentDynamicEvalDefinition: # new in 1.1
-  Enabled: true
+  Enabled: false
 Style/EmptyHeredoc: # new in 1.32
   Enabled: true
 Style/EndlessMethod: # new in 1.8

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    coinmarketcap_free (0.2.0)
+    coinmarketcap_free (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    json (2.6.2)
-    minitest (5.16.3)
-    net-http (0.3.0)
+    json (2.6.3)
+    minitest (5.20.0)
+    net-http (0.3.2)
       uri
-    openssl (3.0.1)
+    openssl (3.2.0)
     rake (13.0.6)
-    uri (0.12.1)
+    uri (0.12.2)
 
 PLATFORMS
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -27,4 +28,4 @@ DEPENDENCIES
   uri (~> 0.12.1)
 
 BUNDLED WITH
-   2.4.10
+   2.5.3

data/lib/coinmarketcap_free/coin.rb

@@ -5,8 +5,7 @@ require_relative 'helper'
 module CoinmarketcapFree
   # All about cryptocurrencies and their prices.
   module Coin
-    URL_API = 'https://api.coinmarketcap.com/data-api/v3/cryptocurrency/listing'
-    private_constant :URL_API
+    URI_API = "#{BASE_URI}#{VERSION_API}/cryptocurrency/listing"
 
     class << self
       # Get a list of cryptocurrencies
@@ -120,21 +119,21 @@ module CoinmarketcapFree
       #
       #
       # @return [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] sort_by 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] sort_type The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
-      # @param [String] 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] crypto_type The type of cryptocurrency to include. ('all', 'coins', 'tokens')
-      # @param [String] tag_type The tag of cryptocurrency to include. ('all', 'defi', 'filesharing')
-      # @param [TrueClass, FalseClass] audited Show audited 'true' or not 'false'
-      # @param [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.
-      # @param [String] tags If you want to see cryptocurrencies that can be mined, just type 'mineable'.
-      # @param [String] volume24h_range Optionally specify a threshold 24 hour USD volume to filter results by. For example, '0~100000000000000000'
-      # @param [String] percent_change24h_range Optionally specify a threshold 24 hour percent change to filter results by. For example, '0~100' or '-10~100'
-      # @param [String] circulating_supply_range Optionally specify a threshold circulating supply to filter results by. For example, '0~100000000000000000'
-      # @param [String] price_range Optionally specify a threshold USD price to filter results by. For example, '0~100000000000000000'
-      # @param [String] market_cap_range Optionally specify a threshold market cap to filter results by. For example, '0~100000000000000000'
+      # @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")
+      # @param sort_type [String] The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
+      # @param convert [String] 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 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'
       def list(**params)
         options = {}
 
@@ -154,7 +153,7 @@ module CoinmarketcapFree
         options[:priceRange] = params[:price_range] # String
         options[:marketCapRange] = params[:market_cap_range] # String
 
-        Helper.http_get(URL_API, options)
+        Helper.http_get(URI_API, options)
       end
     end
   end

data/lib/coinmarketcap_free/coin_history.rb

@@ -5,14 +5,31 @@ require_relative 'helper'
 module CoinmarketcapFree
   # All history cryptocurrency and their prices.
   module CoinHistory
-    URL_API = 'https://api.coinmarketcap.com/data-api/v3/cryptocurrency/detail/chart'
-    private_constant :URL_API
+    URI_API = "#{BASE_URI}#{VERSION_API}/cryptocurrency/detail/chart"
+
+    INTERVAL_TIME = {
+      one_day: '1D',
+      seven_days: '7D',
+      one_month: '1M',
+      three_months: '3M',
+      one_year: '1Y',
+      current_year: 'YTD',
+      all: 'ALL'
+    }.freeze
 
     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
+      #
       #   history = CoinmarketcapFree::CoinHistory.custom_time(1, '1D')
       #
+      # Also you can use this method like this:
+      #
+      #   history = CoinmarketcapFree::CoinHistory.interval_one_day(1)
+      #
+      # Just add a prefix to the method: interval_(one_day, seven_days, one_month, three_months, one_year, current_year, all)
+      #
       # Result json:
       #
       #   {
@@ -44,6 +61,7 @@ module CoinmarketcapFree
       #     }
       #   }
       #
+      #
       # 'data' - Results of your query returned as an object map.
       # 'points' - Price range history
       # 'status' - Standardized status object for API calls.
@@ -52,56 +70,16 @@ module CoinmarketcapFree
       # @param range_time [String] Range time. For example, '1D', '7D', '1M', '3M', '1Y', 'YTD', 'ALL' or custom range '1668981600~1671659999'
       # @return [String]
       def custom_time(id, range_time)
-        Helper.http_get(URL_API, { id: id, range: range_time })
+        Helper.http_get(URI_API, { id: id, range: range_time })
       end
 
-      # Returns an interval of historic for the day
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_day(id)
-        custom_time(id, '1D')
-      end
-
-      # Returns an interval of historic for the seven days
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_seven_days(id)
-        custom_time(id, '7D')
-      end
-
-      # Returns an interval of historic for the one month
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_one_month(id)
-        custom_time(id, '1M')
-      end
-
-      # Returns an interval of historic for the three months
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_three_months(id)
-        custom_time(id, '3M')
-      end
-
-      # Returns an interval of historic for the one year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_one_year(id)
-        custom_time(id, '1Y')
-      end
-
-      # Returns an interval of historic for the current year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_current_year(id)
-        custom_time(id, 'YTD')
-      end
-
-      # Returns an interval of historic for the current year
-      #
-      # @param [Integer] id Cryptocurrency identifier
-      def interval_all_time(id)
-        custom_time(id, 'ALL')
+      # Creating interval methods
+      INTERVAL_TIME.each do |key, value|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def interval_#{key}
+            custom_time(id, '#{value}')
+          end
+        RUBY
       end
     end
   end

data/lib/coinmarketcap_free/helper.rb

@@ -6,6 +6,9 @@ require 'openssl'
 require 'json'
 
 module CoinmarketcapFree
+  BASE_URI = 'https://api.coinmarketcap.com/data-api/'
+  VERSION_API = 'v3'
+
   # Helper module for CoinmarketcapFree
   module Helper
     class << self

data/lib/coinmarketcap_free/icon.rb

@@ -4,9 +4,9 @@ module CoinmarketcapFree
   # Get static image of a coin from coinmarketcap.com
   module Icon
     class << self
-      # Get coin logo URI
+      # Generate URI image of a coin
       #
-      #   logo = CoinmarketcapFree::Icon.img_coin(1, 64)
+      #   logo = CoinmarketcapFree::Icon.generate_url(1, 64)
       #
       # Result:
       #   "https://s2.coinmarketcap.com/static/img/coins/64x64/1.png"

data/lib/coinmarketcap_free/version.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+# Get data from Coinmarketcap API without requiring an API key.
 module CoinmarketcapFree
-  VERSION = '0.2.0'
+  MAJOR = 0
+  MINOR = 4
+  PATCH = 0
+
+  private_constant :MAJOR, :MINOR, :PATCH
+
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/lib/coinmarketcap_free.rb

@@ -7,4 +7,97 @@ require_relative 'coinmarketcap_free/version'
 
 # Get data from Coinmarketcap API without requiring an API key.
 module CoinmarketcapFree
-end
+  class << self
+    # Get a list of cryptocurrencies
+    #
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1)
+    #
+    # If you want to sort in ascending, just write parameter:
+    #
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'asc')
+    #
+    # or
+    #
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, sort_type:'desc')
+    #
+    # You can also adding sort by:
+    #
+    #   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')
+    #
+    # Also you can use this method like this:
+    #
+    #   list = CoinmarketcapFree.coins(limit: 100, start: 1, convert: 'USD,BTC,ETH') do |data|
+    #       JSON.parse(data)
+    #   end
+    #
+    #
+    # @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")
+    # @param sort_type [String] The direction in which to order cryptocurrencies against the specified sort. ('asc', 'desc')
+    # @param convert [String] 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 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]
+    def coins(**params)
+      data = Coin.list(params)
+
+      return yield data if block_given?
+
+      JSON.parse(data)
+    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')
+    #
+    # Also you can use this method like this:
+    #
+    #   history = CoinmarketcapFree.coin_history(1, '1668981600~1671659999') do |data|
+    #       JSON.parse(data)
+    #   end
+    #
+    # 'data' - Results of your query returned as an object map.
+    # 'points' - Price range history
+    # 'status' - Standardized status object for API calls.
+    #
+    # @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)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coinmarketcap_free
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
-- cosmic-1
-autorequire: 
+- Vitalii Bakun
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2024-02-12 00:00:00.000000000 Z
 dependencies: []
 description: Cryptocurrency information from the Coinmarketcap site without a key.
 email:
@@ -23,21 +23,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- coinmarketcap_free.gemspec
 - lib/coinmarketcap_free.rb
 - lib/coinmarketcap_free/coin.rb
 - lib/coinmarketcap_free/coin_history.rb
 - lib/coinmarketcap_free/helper.rb
 - lib/coinmarketcap_free/icon.rb
 - lib/coinmarketcap_free/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  source_code_uri: https://github.com/Cosmic-1/coinmarketcap_free
-  rubygems_mfa_required: 'false'
-post_install_message: 
+  source_code_uri: https://github.com/vitalii-bakun/coinmarketcap_free
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,15 +44,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Cryptocurrency information from the Coinmarketcap site without a key.
 test_files: []

data/coinmarketcap_free.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/coinmarketcap_free/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "coinmarketcap_free"
-  spec.version = CoinmarketcapFree::VERSION
-  spec.authors = ["cosmic-1"]
-  spec.email = ["crossdoh@gmail.com"]
-
-  spec.summary = "Cryptocurrency information from the Coinmarketcap site without a key."
-  spec.description = "Cryptocurrency information from the Coinmarketcap site without a key."
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["source_code_uri"] = 'https://github.com/Cosmic-1/coinmarketcap_free'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-  spec.metadata['rubygems_mfa_required'] = 'false'
-end