coincap 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65af4f6edf23fd568e3318eb5ee35edcb8ea46b27372b1dc6f11895b8ba708e8
-  data.tar.gz: 546d6841b22503e6b407c7e7dd6521100753d1e08d5232f0145d6ead92661dae
+  metadata.gz: 3804fc6897bedeab59d3433b78d966c9ead78b479ddda7fa68224dc82ab3269a
+  data.tar.gz: e1d4b18de106069036912318ae4fe7c5fab9bfa9eee8f2ec148933f6642a2061
 SHA512:
-  metadata.gz: 6f19793fb77a993b65eb8a1b33b4a8bdfaa71279d7789c790b2e169a2c952c20043c7e3b75732b429c361a876770d851af22b4d66dc11f4cee921bce376f1957
-  data.tar.gz: c0be274b07adf3b01240fefeb92d10db9d92135ec8d71a2a8de21c6e410563b8777ca1ae1bf4ebebf8a064a69f2bf7c363f52aab31fe8371d27f8f0e0d96dab0
+  metadata.gz: 8460be7cd7edce7958d0648e71703777f4330901a53b19cab7e461d88f86bbb42d4050bd87681e422e09d9a8f54ded167b5ef293a846e863e26f2b38efdccc55
+  data.tar.gz: 27d35e1375e21db51c987d76ac0404bb654cf4511d1e472ec8110bbfccc193219175aacd578797a0908a4f90952884bcf53957e059855e1452387277474b03dc

data/Gemfile

@@ -13,3 +13,5 @@ group :test do
   gem 'minitest', '~> 5.18'
   gem 'rake', '~> 13.0'
 end
+
+gem "websocket-client-simple", "~> 0.8.0"

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    coincap (0.2.3)
+    coincap (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    event_emitter (0.2.6)
     json (2.6.3)
     minitest (5.20.0)
     net-http (0.3.2)
@@ -13,6 +14,10 @@ GEM
     openssl (3.2.0)
     rake (13.0.6)
     uri (0.12.2)
+    websocket (1.2.10)
+    websocket-client-simple (0.8.0)
+      event_emitter
+      websocket
 
 PLATFORMS
   x86_64-darwin-22
@@ -26,6 +31,7 @@ DEPENDENCIES
   openssl (~> 3.1)
   rake (~> 13.0)
   uri (~> 0.12.1)
+  websocket-client-simple (~> 0.8.0)
 
 BUNDLED WITH
-   2.4.20
+   2.5.6

data/README.md

@@ -20,7 +20,7 @@ Detailed information [here](https://docs.coincap.io/).
 
 ## Assets Price
 ```Ruby
-data = Coincap::AssetsPrice.cryptocurrencies
+data = Coincap::Assets.list
 ```
 ```JSON
     {
@@ -45,7 +45,7 @@ data = Coincap::AssetsPrice.cryptocurrencies
 ```
 
 ```Ruby
-data = Coincap::AssetsPrice.cryptocurrency('bitcoin')
+data = Coincap::Assets.single('bitcoin')
 ```
 ```JSON
       {
@@ -67,7 +67,15 @@ data = Coincap::AssetsPrice.cryptocurrency('bitcoin')
 ```
 
 ```Ruby
-data = Coincap::AssetsPrice.cryptocurrency_history('bitcoin', :one_minute)
+data = Coincap::Assets.history('bitcoin', :one_minute)
+```
+or
+```Ruby
+data = Coincap::Assets.history_one_minute('bitcoin')
+```
+and with timestamp
+```Ruby
+data = Coincap::Assets.history_one_minute('bitcoin', 1530403200000, 1533581103627)
 ```
 ```JSON
       {
@@ -83,7 +91,7 @@ data = Coincap::AssetsPrice.cryptocurrency_history('bitcoin', :one_minute)
 ```
 
 ```Ruby
-data = Coincap::AssetsPrice.cryptocurrency_with_markets('bitcoin')
+data = Coincap::Assets.markets('bitcoin')
 ```
 ```JSON
       {

data/lib/coincap/{assets_price.rb → assets.rb}

@@ -8,7 +8,7 @@ module Coincap
   # meaning higher volume exchanges have more affect on this global price.
   # All values are translated into USD (United States Dollar)
   # and can be translated into other units of measurement through the /rates endpoint.
-  module AssetsPrice
+  module Assets
     URI_API = "#{BASE_URI}#{VERSION_API}/assets"
 
     TIME_INTERVAL = {
@@ -49,9 +49,9 @@ module Coincap
     # @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)
+    # @return [Hash]
+    def self.list(search: nil, ids: nil, limit: nil, offset: nil)
+      Helper.fetch_data(URI_API, search: search, ids: ids, limit: limit, offset: offset)
     end
 
     # Get single cryptocurrency
@@ -74,9 +74,9 @@ module Coincap
     #   }
     #
     # @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}")
+    # @return [Hash]
+    def self.single(asset_id)
+      Helper.fetch_data("#{URI_API}/#{asset_id}")
     end
 
     # Get cryptocurrency history price
@@ -106,16 +106,20 @@ module Coincap
     # @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)
+    # @param start_at [Integer] Start time in milliseconds
+    # @param end_at [Integer] End time in milliseconds
+    # @return [Hash]
+    def self.history(asset_id, interval, start_at = nil, end_at = nil)
+      Helper.fetch_data("#{URI_API}/#{asset_id}/history",
+                        interval: interval.is_a?(Symbol) ? TIME_INTERVAL[interval] : interval,
+                        start: start_at,
+                        end: end_at)
     end
 
     TIME_INTERVAL.each do |key, value|
       class_eval <<~RUBY
-        def self.cryptocurrency_history_#{key}(asset_id)
-          self.cryptocurrency_history(asset_id, '#{value}')
+        def self.history_#{key}(asset_id, start_at = nil, end_at = nil)
+          self.history(asset_id, '#{value}', start_at, end_at)
         end
       RUBY
     end
@@ -142,9 +146,9 @@ module Coincap
     # @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)
+    # @return [Hash]
+    def self.markets(asset_id, limit: nil, offset: nil)
+      Helper.fetch_data("#{URI_API}/#{asset_id}/markets", limit: limit, offset: offset)
     end
   end
 end

data/lib/coincap/exchanges.rb

@@ -33,9 +33,9 @@ module Coincap
     #     "timestamp": 1536605835421
     #   }
     #
-    # @return [String]
+    # @return [Hash]
     def self.list
-      Helper.request_to_read_data(URI_API)
+      Helper.fetch_data(URI_API)
     end
 
     # Returns a single exchange.
@@ -56,9 +56,9 @@ module Coincap
     #   }
     #
     # @param exchange_id [String] Search by exchange name, for example, kraken
-    # @return [String]
+    # @return [Hash]
     def self.single(exchange_id)
-      Helper.request_to_read_data("#{URI_API}/#{exchange_id}")
+      Helper.fetch_data("#{URI_API}/#{exchange_id}")
     end
   end
 end

data/lib/coincap/helper.rb

@@ -16,9 +16,11 @@ module Coincap
       #
       # @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 build_uri(uri_string, **queries_hash)
+      # @return [Hash] Hash of the response
+      def fetch_data(uri_string, **queries_hash)
+        url = build_uri(uri_string, **queries_hash)
+        data = http_get url
+        JSON.parse data
       end
 
       private

data/lib/coincap/live_assets.rb

@@ -0,0 +1,46 @@
+require 'websocket-client-simple'
+
+module Coincap
+  class LiveAssets
+    BASE_URI = 'wss://ws.coincap.io/prices?assets='
+
+    # Initialize the websocket
+    # @param assets [Array] List of assets
+    def initialize(assets = 'ALL')
+      @assets = assets
+    end
+
+    # Connect to the websocket
+    def connect
+      uri = "#{BASE_URI}#{@assets == 'ALL' ? @assets : @assets.join(',')}"
+      @ws = WebSocket::Client::Simple.connect(uri)
+    end
+
+    # Close the websocket
+    def disconnect
+      @ws.close
+    end
+
+    # When receive the price
+    def on_price(&on_message)
+      @ws.on :message do |event|
+        on_message.call(event.data)
+      end
+    end
+
+    # When open the websocket
+    def on_open(&on_open)
+      @ws.on :open, &on_open
+    end
+
+    # When close the websocket
+    def on_close(&on_close)
+      @ws.on :close, &on_close
+    end
+
+    # When error
+    def on_error(&on_error)
+      @ws.on :error, &on_error
+    end
+  end
+end

data/lib/coincap/markets.rb

@@ -44,9 +44,9 @@ module Coincap
     # @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]
+    # @return [Hash]
     def self.list(**options)
-      Helper.request_to_read_data(URI_API,
+      Helper.fetch_data(URI_API,
                                   exchangeId: options[:exchange_id],
                                   baseSymbol: options[:base_symbol],
                                   quoteSymbol: options[:quote_symbol],

data/lib/coincap/rates.rb

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

data/lib/coincap/version.rb

@@ -2,8 +2,8 @@
 
 module Coincap
   MAJOR = 0
-  MINOR = 2
-  PATCH = 3
+  MINOR = 3
+  PATCH = 0
 
   private_constant :MAJOR, :MINOR, :PATCH
 

data/lib/coincap.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require_relative 'coincap/version'
-require_relative 'coincap/assets_price'
+require_relative 'coincap/assets'
+require_relative 'coincap/exchanges'
 require_relative 'coincap/helper'
+require_relative 'coincap/live_assets'
 require_relative 'coincap/markets'
 require_relative 'coincap/rates'
-require_relative 'coincap/exchanges'
+require_relative 'coincap/version'
 
 # CoinCap 2.0 RESTful API is currently in production!
 # The CoinCap team is excited to offer you new endpoints and more clarity on pricing!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coincap
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Vitalii Bakun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2024-04-27 00:00:00.000000000 Z
 dependencies: []
 description: "    CoinCap is a useful tool for real-time pricing and market activity
   for over 1,000 cryptocurrencies.\n"
@@ -24,11 +24,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- coincap.gemspec
 - lib/coincap.rb
-- lib/coincap/assets_price.rb
+- lib/coincap/assets.rb
 - lib/coincap/exchanges.rb
 - lib/coincap/helper.rb
+- lib/coincap/live_assets.rb
 - lib/coincap/markets.rb
 - lib/coincap/rates.rb
 - lib/coincap/version.rb
@@ -53,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: CoinCap is a useful tool for real-time pricing and market activity for over

data/coincap.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/coincap/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'coincap'
-  spec.version = Coincap::VERSION
-  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 = <<-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.7.0'
-
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  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.
-  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