coincap 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f64f28f94bf1c7bfc899d6493f0f9e2512ce9f413adad7073d5cbd3b3aeb510
-  data.tar.gz: 7d5ac910e50b8c06611849fe7859d0a30bfa9d017cb7b33b2890c292b52eef67
+  metadata.gz: 65af4f6edf23fd568e3318eb5ee35edcb8ea46b27372b1dc6f11895b8ba708e8
+  data.tar.gz: 546d6841b22503e6b407c7e7dd6521100753d1e08d5232f0145d6ead92661dae
 SHA512:
-  metadata.gz: e5b4e8f2fda02bc248ddd777eaeccdaa20950980a3039e90572e4e9daeaf58bf001a734fdc925e0d1414cc9af6b0221bb420fe0f626d0267e9553bf253881e9b
-  data.tar.gz: fa99b3052e9dd464070aee8465fbd7d8ae45fd5a6a2d457d34a78dd9ef2f3d72f37e3fa63654a200c49e96401560cd1a8ba3db5ee8d3c054783456fed01401ce
+  metadata.gz: 6f19793fb77a993b65eb8a1b33b4a8bdfaa71279d7789c790b2e169a2c952c20043c7e3b75732b429c361a876770d851af22b4d66dc11f4cee921bce376f1957
+  data.tar.gz: c0be274b07adf3b01240fefeb92d10db9d92135ec8d71a2a8de21c6e410563b8777ca1ae1bf4ebebf8a064a69f2bf7c363f52aab31fe8371d27f8f0e0d96dab0

data/.rubocop.yml

@@ -0,0 +1,178 @@
+AllCops:
+  NewCops: enable
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: false
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: false
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: false
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+Layout/LineLength: 
+  Enabled: false
+Style/EvalWithLocation:
+  Enabled: false

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    coincap (0.1.2)
+    coincap (0.2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
     json (2.6.3)
-    minitest (5.18.0)
+    minitest (5.20.0)
     net-http (0.3.2)
       uri
-    openssl (3.1.0)
+    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.4.20

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-task default: :test
+task default: :test

data/coincap.gemspec

@@ -5,17 +5,19 @@ require_relative 'lib/coincap/version'
 Gem::Specification.new do |spec|
   spec.name = 'coincap'
   spec.version = Coincap::VERSION
-  spec.authors = ['cosmic-1']
+  spec.authors = ['Vitalii Bakun']
   spec.email = ['crossdoh@gmail.com']
 
   spec.summary = 'CoinCap is a useful tool for real-time pricing and market activity for over 1,000 cryptocurrencies.'
-  spec.description = 'CoinCap is a useful tool for real-time pricing and market activity for over 1,000 cryptocurrencies.'
+  spec.description = <<-DESC
+    CoinCap is a useful tool for real-time pricing and market activity for over 1,000 cryptocurrencies.
+  DESC
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata['source_code_uri'] = 'https://github.com/Cosmic-1/coincap'
+  spec.metadata['source_code_uri'] = 'https://github.com/vitalii-bakun/coincap'
 
   # 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.

data/lib/coincap/assets_price.rb

@@ -9,7 +9,7 @@ module Coincap
   # All values are translated into USD (United States Dollar)
   # and can be translated into other units of measurement through the /rates endpoint.
   module AssetsPrice
-    URI_API = 'https://api.coincap.io/v2/assets'
+    URI_API = "#{BASE_URI}#{VERSION_API}/assets"
 
     TIME_INTERVAL = {
       one_minute: 'm1',
@@ -73,7 +73,7 @@ module Coincap
     #     "timestamp": 1533581098863
     #   }
     #
-    # @param [String] asset_id Asset id, for example, bitcoin
+    # @param asset_id [String] Asset id, for example, bitcoin
     # @return [String]
     def self.cryptocurrency(asset_id)
       Helper.request_to_read_data("#{URI_API}/#{asset_id}")
@@ -92,14 +92,34 @@ module Coincap
     #     "timestamp": 1533581103627
     #   }
     #
-    # @param [String] asset_id Asset id, for example, bitcoin
-    # @param [Symbol] interval Select one from the list m1,m5,m15,m30,h1,h2,h6,h12,d1, for example, m1 or write a symbol, for example, :one_minute
+    # You can call the method like this:
+    #
+    #   Coincap::AssetsPrice.cryptocurrency_history('bitcoin', :one_minute)
+    #
+    #   Coincap::AssetsPrice.cryptocurrency_history('bitcoin', 'm1')
+    #
+    #
+    # Or like this:
+    #
+    #   Coincap::AssetsPrice.cryptocurrency_history_one_minute('bitcoin')
+    #
+    # @param asset_id [String] Asset id, for example, bitcoin
+    # @param interval [Symbol|String] Select one from the list of TIME_INTERVAL values
+    #   for example, a string 'm1' or a symbol :one_minute
     # @return [String]
     def self.cryptocurrency_history(asset_id, interval)
       Helper.request_to_read_data("#{URI_API}/#{asset_id}/history",
                                   interval: interval.is_a?(Symbol) ? TIME_INTERVAL[interval] : interval)
     end
 
+    TIME_INTERVAL.each do |key, value|
+      class_eval <<~RUBY
+        def self.cryptocurrency_history_#{key}(asset_id)
+          self.cryptocurrency_history(asset_id, '#{value}')
+        end
+      RUBY
+    end
+
     # Get price cryptocurrency with markets
     #
     #   {
@@ -119,9 +139,9 @@ module Coincap
     #     "timestamp": 1539289444052
     #   }
     #
-    # @param [String] asset_id Asset id, for example, bitcoin
-    # @param [Integer] limit Max limit of 2000
-    # @param [Integer] offset Offset
+    # @param asset_id [String] Asset id, for example, bitcoin
+    # @param limit [Integer] Max limit of 2000
+    # @param offset [Integer] Offset
     # @return [String]
     def self.cryptocurrency_with_markets(asset_id, limit: nil, offset: nil)
       Helper.request_to_read_data("#{URI_API}/#{asset_id}/markets", limit: limit, offset: offset)

data/lib/coincap/exchanges.rb

@@ -11,7 +11,7 @@ module Coincap
   # For that purpose you will find an "updated" key for each exchange.
   # For more details into coin pairs and volume, see the /markets endpoint.
   module Exchanges
-    URI_API = 'https://api.coincap.io/v2/exchanges'
+    URI_API = "#{BASE_URI}#{VERSION_API}/exchanges"
 
     # Returns a list of all exchanges.
     #
@@ -55,7 +55,7 @@ module Coincap
     #     "timestamp": 1536605874069
     #   }
     #
-    # @param exchange_id [String]
+    # @param exchange_id [String] Search by exchange name, for example, kraken
     # @return [String]
     def self.single(exchange_id)
       Helper.request_to_read_data("#{URI_API}/#{exchange_id}")

data/lib/coincap/helper.rb

@@ -6,35 +6,35 @@ require 'net/http'
 require 'openssl'
 
 module Coincap
+  BASE_URI = 'https://api.coincap.io/'
+  VERSION_API = 'v2'
+
   # Helper module
   module Helper
     class << self
       # Request to read data
-      # @param uri_string [String] string of the uri
-      # @param queries_hash [Hash] queries hash for the request
+      #
+      # @param uri_string [String] String of the uri
+      # @param queries_hash [Hash] Queries hash for the request
       # @return [String]
       def request_to_read_data(uri_string, **queries_hash)
-        http_get convert_hash_to_uri(uri_string, **queries_hash)
+        http_get build_uri(uri_string, **queries_hash)
       end
 
-      JSON.parse(data_str)
-    end
-
-    class << self
       private
 
       def http_get(uri)
-        config = Coincap.instance_variable_get(:@config)
+        config = Coincap.config
 
         headers = {
-          'Accept-Encoding': config.accept_encoding.nil? ? nil : config.accept_encoding,
+          'Accept-Encoding': config.accept_encoding,
           'Authorization': config.api_key.nil? ? nil : "Bearer #{config.api_key}"
         }.compact
 
         Net::HTTP.get(uri, headers)
       end
 
-      def convert_hash_to_uri(uri, **queries_hash)
+      def build_uri(uri, **queries_hash)
         queries_str = queries_hash.compact.map { |key, value| "#{key}=#{value}" }.join('&')
         URI("#{uri}#{queries_str.empty? ? '' : "?#{queries_str}"}")
       end

data/lib/coincap/markets.rb

@@ -10,7 +10,7 @@ module Coincap
   # All market data represents actual trades processed, orders on an exchange are not represented.
   # Data received from individual markets is used to calculate the current price of an asset.
   module Markets
-    URI_API = 'https://api.coincap.io/v2/markets'
+    URI_API = "#{BASE_URI}#{VERSION_API}/markets"
 
     # Returns a list of all markets.
     #
@@ -35,27 +35,27 @@ module Coincap
     #     "timestamp": 1533581173350
     #   }
     #
-    # @param [String] exchange_id (nil) Search by exchange id (e.g. 'binance')
-    # @param [String] base_symbol (nil) Returns all containing the base symbol
-    # @param [String] quote_symbol (nil) Returns all containing the quote symbol
-    # @param [String] base_id (nil) Returns all containing the base id
-    # @param [String] quote_id (nil) Returns all containing the quote id
-    # @param [String] asset_symbol (nil) Returns all assets containing symbol (base and quote)
-    # @param [String] asset_id (nil) Returns all assets containing id (base and quote)
-    # @param [Integer] limit (nil) Max limit of 2000
-    # @param [Integer] offset (nil) The number of results to skip
+    # @param exchange_id (nil) [String] Search by exchange id (e.g. 'binance')
+    # @param base_symbol (nil) [String] Returns all containing the base symbol
+    # @param quote_symbol (nil) [String] Returns all containing the quote symbol
+    # @param base_id (nil) [String] Returns all containing the base id
+    # @param quote_id (nil) [String] Returns all containing the quote id
+    # @param asset_symbol (nil) [String] Returns all assets containing symbol (base and quote)
+    # @param asset_id (nil) [String] Returns all assets containing id (base and quote)
+    # @param limit (nil) [Integer] Max limit of 2000
+    # @param offset (nil) [Integer] The number of results to skip
     # @return [String]
     def self.list(**options)
       Helper.request_to_read_data(URI_API,
-                                  'exchangeId': options[:exchange_id],
-                                  'baseSymbol': options[:base_symbol],
-                                  'quoteSymbol': options[:quote_symbol],
-                                  'baseId': options[:base_id],
-                                  'quoteId': options[:quote_id],
-                                  'assetSymbol': options[:asset_symbol],
-                                  'assetId': options[:asset_id],
-                                  'limit': options[:limit],
-                                  'offset': options[:offset])
+                                  exchangeId: options[:exchange_id],
+                                  baseSymbol: options[:base_symbol],
+                                  quoteSymbol: options[:quote_symbol],
+                                  baseId: options[:base_id],
+                                  quoteId: options[:quote_id],
+                                  assetSymbol: options[:asset_symbol],
+                                  assetId: options[:asset_id],
+                                  limit: options[:limit],
+                                  offset: options[:offset])
     end
   end
 end

data/lib/coincap/rates.rb

@@ -8,7 +8,7 @@ module Coincap
   # We offer fiat and top cryptocurrency translated rates.
   # Fiat rates are available through OpenExchangeRates.org.
   module Rates
-    URI_API = 'https://api.coincap.io/v2/rates'
+    URI_API = "#{BASE_URI}#{VERSION_API}/rates"
 
     # Returns a list of all rates.
     #

data/lib/coincap/version.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
 module Coincap
-  VERSION = '0.1.2'
+  MAJOR = 0
+  MINOR = 2
+  PATCH = 3
+
+  private_constant :MAJOR, :MINOR, :PATCH
+
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
 end

data/lib/coincap.rb

@@ -9,10 +9,13 @@ require_relative 'coincap/exchanges'
 
 # CoinCap 2.0 RESTful API is currently in production!
 # The CoinCap team is excited to offer you new endpoints and more clarity on pricing!
+#
 # CoinCap 2.0 launched on September 26, 2018.
 # Please let us know what you like, what you would hope to see, or any bugs/changes that you'd like to document.
+#
 # The easiest way to submit feedback to our team is to fill out a support ticket here.
 # The old CoinCap API is deprecated and was shut down on March 1, 2019.
+#
 # For any issues with transitioning from the old CoinCap API to the new,
 # please submit feedback via the zendesk link above!
 module Coincap
@@ -29,10 +32,16 @@ module Coincap
     end
   end
 
-  @config = Configuration.new
+  class << self
+    # Configuration the Coincap API
+    # @return [Coincap::Configuration]
+    def config
+      @config ||= Configuration.new
+    end
 
-  # Configuration the Coincap API
-  def self.configure
-    yield @config
+    # Configuration the Coincap API
+    def self.configure
+      yield config
+    end
   end
 end

metadata

@@ -1,23 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: coincap
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 platform: ruby
 authors:
-- cosmic-1
-autorequire: 
+- Vitalii Bakun
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies: []
-description: CoinCap is a useful tool for real-time pricing and market activity for
-  over 1,000 cryptocurrencies.
+description: "    CoinCap is a useful tool for real-time pricing and market activity
+  for over 1,000 cryptocurrencies.\n"
 email:
 - crossdoh@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -31,13 +32,13 @@ files:
 - lib/coincap/markets.rb
 - lib/coincap/rates.rb
 - lib/coincap/version.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  source_code_uri: https://github.com/Cosmic-1/coincap
-post_install_message: 
+  source_code_uri: https://github.com/vitalii-bakun/coincap
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,15 +46,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.4.20
+signing_key:
 specification_version: 4
 summary: CoinCap is a useful tool for real-time pricing and market activity for over
   1,000 cryptocurrencies.