coinmarketcap_free 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 552fa8d6dc0bd48c3d3038139498e4c87df3e593411d18cd0ca669e3257f3d43
-  data.tar.gz: e53685f824b0cf866cf8e0e7b0e29ffd235f37930253d56da98eff8c3416e7cc
+  metadata.gz: 75e112c92ffd0e8f5692d2497af36cc97bf9df213219a47b974f13f6d3d21558
+  data.tar.gz: 244626426b7fb8a930c71d8b5ff468e39b22fffc476151c944c19e2af9c1c0d2
 SHA512:
-  metadata.gz: 9771e08a82dcf2314d982c763ab1f6a230efa16bde1ca684cb4ec30a0b562fac29a027180cabeaa24a87df4280d19981e882dbf0565688950cd9fac0a448af7e
-  data.tar.gz: c33962fc9682813b91eea1177e53b7325d1b578c66a0c76f0357d1478493fbf0438168e8c876e59ad6c77c439e53bbcbaf758dd98603c511809bb8d687df9642
+  metadata.gz: c23c10123ee29cb2e3db88477123abae457575357d8e173bfacf7df2ee8c8b9199382e828fc1d416e556758eacab7b73ba0c7bdfeabca1675b324a571d6267c9
+  data.tar.gz: 211ee8c04dd9995e19a760c84f75da00ef726995e35e03db44847f423315652f14ae9b2f1a7a71cfd1dd0a75336fb1f7887192e66842774d1006499e869ae280

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coinmarketcap_free (0.3.0)
+    coinmarketcap_free (0.4.1)
 
 GEM
   remote: https://rubygems.org/
@@ -28,4 +28,4 @@ DEPENDENCIES
   uri (~> 0.12.1)
 
 BUNDLED WITH
-   2.4.20
+   2.5.3

data/README.md

@@ -18,6 +18,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
 list = CoinmarketcapFree::Coin.list
 ```
 
+or short
+
+``` Ruby
+list = CoinmarketcapFree::coins
+```
+
 Result:
 ``` JSON
 {
@@ -153,6 +159,13 @@ coin = CoinmarketcapFree::CoinHistory.custom_time(1, '1D')
 coin = CoinmarketcapFree::CoinHistory.custom_time(1, '1668981600~1671659999')
 ```
 
+or short
+
+``` Ruby
+coin = CoinmarketcapFree.coin_history(1, '1D')
+coin = CoinmarketcapFree.coin_history(1, '1668981600~1671659999')
+```
+
 or
 
 ``` Ruby

data/lib/coinmarketcap_free/icon.rb

@@ -6,7 +6,7 @@ module CoinmarketcapFree
     class << self
       # 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

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

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.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Vitalii Bakun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 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,7 +23,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- coinmarketcap_free.gemspec
 - lib/coinmarketcap_free.rb
 - lib/coinmarketcap_free/coin.rb
 - lib/coinmarketcap_free/coin_history.rb
@@ -52,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Cryptocurrency information from the Coinmarketcap site without a key.

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 = ["Vitalii Bakun"]
-  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.7.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["source_code_uri"] = 'https://github.com/vitalii-bakun/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'] = 'true'
-end