coincap 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 400102f77c2de8996aed21a75f3dd351998cceb7fe88130814474dce51ddef33
-  data.tar.gz: d1cf37117aeb04e4d956fdbd0c4de56d9dc93537e3672e0ca2016ffeedb370d4
+  metadata.gz: 5f64f28f94bf1c7bfc899d6493f0f9e2512ce9f413adad7073d5cbd3b3aeb510
+  data.tar.gz: 7d5ac910e50b8c06611849fe7859d0a30bfa9d017cb7b33b2890c292b52eef67
 SHA512:
-  metadata.gz: 57971399dfeb1d52affcb456202ced30853b1d21f2adc6812fc6a68105833c4445f8c7d1c1848f1930befe1d914ab42000da101204e034b9fe84e42cf385805f
-  data.tar.gz: 340c5c6cbaeacd4990955e51faed298b93ebbbffc80cb4944887cc61bf68d1a7219fdf3fd34eaef5affd17be3867216e8b7ebe0d8ab24f1861069434917232dc
+  metadata.gz: e5b4e8f2fda02bc248ddd777eaeccdaa20950980a3039e90572e4e9daeaf58bf001a734fdc925e0d1414cc9af6b0221bb420fe0f626d0267e9553bf253881e9b
+  data.tar.gz: fa99b3052e9dd464070aee8465fbd7d8ae45fd5a6a2d457d34a78dd9ef2f3d72f37e3fa63654a200c49e96401560cd1a8ba3db5ee8d3c054783456fed01401ce

data/Gemfile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem 'json'
-gem 'net-http'
-gem 'openssl'
-gem 'uri'
+gem 'json', '~> 2.6'
+gem 'net-http', '~> 0.3.2'
+gem 'openssl', '~> 3.1'
+gem 'uri', '~> 0.12.1'
 
 group :test do
-  gem 'minitest'
-  gem 'rake'
-end
+  gem 'minitest', '~> 5.18'
+  gem 'rake', '~> 13.0'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    coincap (0.1.0)
+    coincap (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -19,12 +19,12 @@ PLATFORMS
 
 DEPENDENCIES
   coincap!
-  json
-  minitest
-  net-http
-  openssl
-  rake
-  uri
+  json (~> 2.6)
+  minitest (~> 5.18)
+  net-http (~> 0.3.2)
+  openssl (~> 3.1)
+  rake (~> 13.0)
+  uri (~> 0.12.1)
 
 BUNDLED WITH
    2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 cosmic-1
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -4,6 +4,7 @@ CoinCap is a useful tool for real-time pricing and market activity for over 1,00
 If you want to add 'api key' or change 'accept encoding', just call the 'configure' method.
 
 No API Key: 200 requests per minute
+
 API Key: 500 requests per minute
 
 Generate API KEY [here](https://coincap.io/api-key).
@@ -211,4 +212,4 @@ data = Coincap::Markets.list
       ],
       "timestamp": 1533581173350
     }
-```
+```

data/coincap.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/coincap/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'coincap'
+  spec.version = Coincap::VERSION
+  spec.authors = ['cosmic-1']
+  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.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/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.
+  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
+end

data/lib/coincap/assets_price.rb

@@ -45,20 +45,13 @@ module Coincap
     #     "timestamp": 1533581088278
     #   }
     #
-    # @param [Hash] options
-    # @option options [String] :search (nil) Search by asset id (bitcoin) or symbol (BTC)
-    # @option options [String] :ids (nil) Query with multiple ids=bitcoin,ethereum,monero
-    # @option options [Integer] :limit (nil) Max limit of 2000
-    # @option options [Integer] :offset (nil) Offset
-    # @return [Hash]
-    def self.cryptocurrencies(**options)
-      quries = {
-        'search': options[:search],
-        'ids': options[:ids],
-        'limit': options[:limit],
-        'offset': options[:offset]
-      }
-      Helper.request_to_read_data(URI_API, **quries)
+    # @param [String] search (nil) Search by asset id (bitcoin) or symbol (BTC)
+    # @param [String] ids (nil) Query with multiple ids=bitcoin,ethereum,monero
+    # @param [Integer] limit (nil) Max limit of 2000
+    # @param [Integer] offset (nil) Offset
+    # @return [String]
+    def self.cryptocurrencies(search: nil, ids: nil, limit: nil, offset: nil)
+      Helper.request_to_read_data(URI_API, search: search, ids: ids, limit: limit, offset: offset)
     end
 
     # Get single cryptocurrency
@@ -81,7 +74,7 @@ module Coincap
     #   }
     #
     # @param [String] asset_id Asset id, for example, bitcoin
-    # @return [Hash]
+    # @return [String]
     def self.cryptocurrency(asset_id)
       Helper.request_to_read_data("#{URI_API}/#{asset_id}")
     end
@@ -101,6 +94,7 @@ module Coincap
     #
     # @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
+    # @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)
@@ -128,6 +122,7 @@ module Coincap
     # @param [String] asset_id Asset id, for example, bitcoin
     # @param [Integer] limit Max limit of 2000
     # @param [Integer] offset 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)
     end

data/lib/coincap/exchanges.rb

@@ -33,7 +33,7 @@ module Coincap
     #     "timestamp": 1536605835421
     #   }
     #
-    # @return [Hash]
+    # @return [String]
     def self.list
       Helper.request_to_read_data(URI_API)
     end
@@ -56,7 +56,7 @@ module Coincap
     #   }
     #
     # @param exchange_id [String]
-    # @return [Hash]
+    # @return [String]
     def self.single(exchange_id)
       Helper.request_to_read_data("#{URI_API}/#{exchange_id}")
     end

data/lib/coincap/helper.rb

@@ -8,10 +8,14 @@ require 'openssl'
 module Coincap
   # Helper module
   module Helper
-    def self.request_to_read_data(uri_string, **queries_hash)
-      uri = convert_hash_to_uri(uri_string, **queries_hash)
-
-      data_str = http_get(uri)
+    class << self
+      # Request to read data
+      # @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)
+      end
 
       JSON.parse(data_str)
     end
@@ -23,11 +27,9 @@ module Coincap
         config = Coincap.instance_variable_get(:@config)
 
         headers = {
-          'Accept-Encoding': config.accept_encoding,
+          'Accept-Encoding': config.accept_encoding.nil? ? nil : config.accept_encoding,
           'Authorization': config.api_key.nil? ? nil : "Bearer #{config.api_key}"
-        }
-
-        headers.compact!
+        }.compact
 
         Net::HTTP.get(uri, headers)
       end

data/lib/coincap/markets.rb

@@ -35,30 +35,27 @@ module Coincap
     #     "timestamp": 1533581173350
     #   }
     #
-    # @param options [Hash] options for the request
-    # @option options [String] :exchange_id (nil) Search by exchange id (e.g. 'binance')
-    # @option options [String] :base_symbol (nil) Returns all containing the base symbol
-    # @option options [String] :quote_symbol (nil) Returns all containing the quote symbol
-    # @option options [String] :base_id (nil) Returns all containing the base id
-    # @option options [String] :quote_id (nil) Returns all containing the quote id
-    # @option options [String] :asset_symbol (nil) Returns all assets containing symbol (base and quote)
-    # @option options [String] :asset_id (nil) Returns all assets containing id (base and quote)
-    # @option options [Integer] :limit (nil) Max limit of 2000
-    # @option options [Integer] :offset (nil) The number of results to skip
-    # @return [Hash]
+    # @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
+    # @return [String]
     def self.list(**options)
-      queries = {
-        '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]
-      }
-      Helper.request_to_read_data(URI_API, **queries)
+      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])
     end
   end
 end

data/lib/coincap/rates.rb

@@ -26,7 +26,7 @@ module Coincap
     #     "timestamp": 1536347807471
     #   }
     #
-    # @return [Hash]
+    # @return [String]
     def self.list
       Helper.request_to_read_data(URI_API)
     end
@@ -45,7 +45,7 @@ module Coincap
     #   }
     #
     # @param asset_id [String] The asset id (bitcoin)
-    # @return [Hash]
+    # @return [String]
     def self.single(asset_id)
       Helper.request_to_read_data("#{URI_API}/#{asset_id}")
     end

data/lib/coincap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coincap
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

data/lib/coincap.rb

@@ -31,9 +31,8 @@ module Coincap
 
   @config = Configuration.new
 
+  # Configuration the Coincap API
   def self.configure
-    # @yield [Coincap::Configuration]
     yield @config
-    @config.accept_encoding
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coincap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - cosmic-1
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies: []
 description: CoinCap is a useful tool for real-time pricing and market activity for
   over 1,000 cryptocurrencies.
@@ -20,8 +20,10 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- coincap.gemspec
 - lib/coincap.rb
 - lib/coincap/assets_price.rb
 - lib/coincap/exchanges.rb
@@ -30,7 +32,8 @@ files:
 - lib/coincap/rates.rb
 - lib/coincap/version.rb
 homepage: 
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/Cosmic-1/coincap