coincap 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa1a230a189db830d8bf24f43c48312c5645841537e2222164b10d73250e6407
-  data.tar.gz: 38b15fd2c64ee1534519000d99301394903f43b9365c8a5dec9cab2dcf471f76
+  metadata.gz: 769b5aae59da08d6280a6982da0ca953443cd35b9652c94b5a1120d365563416
+  data.tar.gz: 7fb79111622a4237e07696889c7fa5c70f68e8c1a495426bb7c665b72120abfa
 SHA512:
-  metadata.gz: 837299ff2ce6a3614a95f70990249690ba81fef73de6e7e248bda5f0379a2502f69463534432f1f0f837de4a9b637993a263c38639a2469ddb014e05d6a42a8a
-  data.tar.gz: d2b1616ead42dc7428353ec929b8146efff1025bd9b21a1a26fb7153cc8a14dbe3ac2a059db108c01b2101e10ac40ac57152b53e58c9015306316db5fc45578a
+  metadata.gz: 7a6b8b0c5773cdc3784a3fa353e3054be921e2e8d44a8057d52d06b6a2291c666fbfed5b2d7fc32246db1751ed9bc3d8828d32e098e1b83412b9f4e02d936e5e
+  data.tar.gz: a54d75fa5f9f0a1c9d1332bf99f07ec025c61d9516342296dfce90785c157a138007058d48c5cf328dd8f4daea69b18bd503a215e0bce396acb96423421a8b1e

data/Gemfile.lock

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

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,26 +8,24 @@ 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)
-
-      JSON.parse(data_str)
-    end
-
     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
+
       private
 
       def http_get(uri)
         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.1'
+  VERSION = '0.1.3'
 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.1
+  version: 0.1.3
 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.
@@ -23,6 +23,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- coincap.gemspec
 - lib/coincap.rb
 - lib/coincap/assets_price.rb
 - lib/coincap/exchanges.rb