alphavantagerb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bcc95c4192080579382239738a8f6416dc49d85
-  data.tar.gz: dd3332db7c8b9bca2a2d72f3cb29a2270f13b389
+  metadata.gz: 2846dc690fd548267b1fd3657beae0c5be91451c
+  data.tar.gz: 5b6cdcb1492ba342f1cf8e02a5284fd89dd0290b
 SHA512:
-  metadata.gz: 2fd96ffada1d455f88ea6b5cddc4e8386288278662375decb0ebacc90657bdb04c4aea39e2bc03a9d3bd47e7a77765325645b96eabb9bba7da991e9a12785dca
-  data.tar.gz: 9e8ac1b906f150071f256d1015f94e5496c725768195c60e5c379037575b4ec0537bf6abd4a84784c9e389bb46c909d5da6f71aa6a909495055e565740231eb3
+  metadata.gz: 6e62c435f993111a6c95e2b2522eea583f80c9dfb5b6b3efb9e74bddf5a7d45ca2d47c98b9ad7daf8d11003a84f6a9fbdf1447b6d297c228fc6dc3dcf759c08d
+  data.tar.gz: e0141b848e4b8512ebf1f2f7d618d109adbcec3a62217752d6a8ec6ac964ec0c50704161d074525514104e9407ac42aa05b2b6b1624f977df9824fbcf618a6b6

data/AlphavantageRB.gemspec

@@ -4,7 +4,7 @@ require "rake"
 
 Gem::Specification.new do |s|
   s.name        = "alphavantagerb"
-  s.version	    = "1.0.0"
+  s.version	    = "1.1.0"
   s.authors     = ["Stefano Martin"]
   s.email       = ["stefano.martin87@gmail.com"]
   s.homepage    = "https://github.com/StefanoMartin/AlphaVantageRB"

data/README.md

@@ -1,11 +1,15 @@
-AlphavantageRB
+AlphavantageRB [![Gem Version](https://badge.fury.io/rb/alphavantagerb.svg)](https://badge.fury.io/rb/alphavantagerb)
 =========================================================
 
 [Alpha Vantage](https://www.alphavantage.co/) is a great API for retrieving Stock
 market data in JSON or CSV format.
-AlphavantageRB is a Gem to use Alpha Vantage with Ruby. AlphavangateRB is based
+AlphavantageRB is a Gem to use Alpha Vantage with Ruby. AlphavantageRB is based
 on the [HTTP API of Alpha Vantage](https://www.alphavantage.co/documentation/).
 
+To install AlphavantageRB: `gem install alphavantagerb`
+
+To use it in your application: `require "alphavantagerb"`
+
 ## Classes
 
 AlphavantateRB has the following classes:
@@ -14,6 +18,7 @@ AlphavantateRB has the following classes:
   Vantage
 * [Alphavantage::Stock](#Stock): to create a stock class
 * [Alphavantage::Timeseries](#Timeseries): to retrieve historical data of a stock
+* [Alphavantage::Batch](#Batch): to retrieve multiple stock data at once
 * [Alphavantage::Indicator](#Indicator): to use some technical indicator of a stock
 * [Alphavantage::Crypto](#Crypto): to create a crypto currency class
 * [Alphavantage::Crypto_Timeseries](#Crypto_Timeseries): to retrieve historical
@@ -126,6 +131,44 @@ You can order the data in ascending or descending order.
   timeseries.open("asc")
 ```
 
+<a name="Batch"></a>
+## Alphavantage::Batch
+
+Alphavantage::Batch is used to retrieve the last updated values of multiple stocks.
+To create a new Batch class you can use a Client class or you can create it directly.
+These two creation commands are equivalent:
+
+``` ruby
+batch = client.batch symbols: ["MSFT", "FB", "AAPL"]
+batch = Alphavantage::Batch.new symbols: ["MSFT", "FB", "AAPL"], key: "YOURKEY"
+```
+
+Note that the initialization owns different entries:
+* symbols: it is an array of string that denote the stocks you want to retrieve.
+* key: authentication key.  This value cannot be setup if you are initializing a batch from a client
+* verbose: used to see the request to Alpha Vantage (default false). This value cannot be setup if you are initializing a batch from a client
+* datatype: it can be "json" or "csv" (default "json")
+* file: path where a csv file should be saved (default "nil")
+
+You can retrieve all the output from Alpha Vantage by doing.
+``` ruby
+  batch.hash
+```
+
+The array of the stocks is found by using:
+``` ruby
+  batch.stock_quotes
+```
+
+Specific information about the batch can be retrieved using the following methods:
+
+``` ruby
+  batch.information # Retrieve information about the batch
+  batch.symbols # Symbols used by the batch
+  batch.notes # Generic notes of the batch
+  batch.time_zone # Time zone of the batch
+```
+
 <a name="Indicator"></a>
 ## Alphavantage::Indicator
 
@@ -597,8 +640,8 @@ To create a new Crypto class you can use a client or you can create it directly.
 These two creation commands are equivalent:
 
 ``` ruby
-stock = client.crypto symbol: "BTC", market: "DKK"
-stock = Alphavantage::Crypto.new symbol: "BTC", market: "DKK", key: "YOURKEY"
+crypto = client.crypto symbol: "BTC", market: "DKK"
+crypto = Alphavantage::Crypto.new symbol: "BTC", market: "DKK", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entry:
@@ -611,7 +654,7 @@ Note that the initialization owns different entry:
 You can setup the datatype of future retrieving by doing:
 
 ``` ruby
-stock.datatype = "csv"
+crypto.datatype = "csv"
 ```
 
 <a name="Crypto_Timeseries"></a>
@@ -622,8 +665,8 @@ To create a new Crypto_Timeseries class you can use a Crypto class or you can cr
 These two creation commands are equivalent:
 
 ``` ruby
-crypto_timeseries = crypto.timeseries type: "daily"
-crypto_timeseries = Alphavantage::Crypto_Timeseries.new type: "daily", symbol: "BTC", market: "DKK", key: "YOURKEY"
+crypto_timeseries = crypto.timeseries
+crypto_timeseries = Alphavantage::Crypto_Timeseries.new symbol: "BTC", market: "DKK", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entries:
@@ -631,7 +674,6 @@ Note that the initialization owns different entries:
 * market: it is a string that denote the market you want to analyze. This value cannot be setup if you are initializing a timeseries from a stock
 * key: authentication key.  This value cannot be setup if you are initializing a timeseries from a crypto class
 * verbose: used to see the request to Alpha Vantage (default false). This value cannot be setup if you are initializing a timeseries from a stock
-* type: it can be "intraday", "daily", "weekly", "monthly" (default "daily")
 * datatype: it can be "json" or "csv" (default "json")
 * file: path where a csv file should be saved (default "nil")
 
@@ -658,23 +700,17 @@ These methods will return an array of couples where the first entry is a timesta
 These timeseries return always the corrispective timeseries in relation of the USD market.
 
 ``` ruby
-  crypto_timeseries.open
-  crypto_timeseries.close
-  crypto_timeseries.high
-  crypto_timeseries.low
+  crypto_timeseries.price
+  crypto_timeseries.price_usd
   crypto_timeseries.volume
-  crypto_timeseries.open_usd
-  crypto_timeseries.close_usd
-  crypto_timeseries.high_usd
-  crypto_timeseries.low_usd
   crypto_timeseries.market_cap_usd
 ```
 
 You can order the data in ascending or descending order.
 
 ``` ruby
-  timeseries.open("desc") # Default
-  timeseries.open("asc")
+  crypto_timeseries.price("desc") # Default
+  crypto_timeseries.price("asc")
 ```
 <a name="Exchange"></a>
 ## Alphavantage::Exchange
@@ -734,24 +770,23 @@ Note that the initialization owns different entries:
 
 You can retrieve all the output from Alpha Vantage by doing.
 ``` ruby
-  crypto_timeseries.hash
+  sector.hash
 ```
 
 Specific information about the timeseries can be retrieved using the following methods:
 ``` ruby
-  exchange.information
-  exchange.last_refreshed
-  exchange.hash
-  exchange.real_time_performance
-  exchange.one_day_performance
-  exchange.five_day_performance
-  exchange.one_month_performance
-  exchange.three_month_performance
-  exchange.year_to_date_performance
-  exchange.one_year_performance
-  exchange.three_year_performance
-  exchange.five_year_performance
-  exchange.ten_year_performance
+  sector.information
+  sector.last_refreshed
+  sector.real_time_performance
+  sector.one_day_performance
+  sector.five_day_performance
+  sector.one_month_performance
+  sector.three_month_performance
+  sector.year_to_date_performance
+  sector.one_year_performance
+  sector.three_year_performance
+  sector.five_year_performance
+  sector.ten_year_performance
 ```
 
 <a name="Error"></a>

data/lib/Batch.rb

@@ -0,0 +1,52 @@
+module Alphavantage
+  class Batch
+    include HelperFunctions
+
+    def initialize symbols:, datatype: "json", key:, verbose: false, file: nil
+      check_argument([true, false], verbose, "verbose")
+      symbols = [symbols] unless symbols.is_a?(Array)
+      @client = return_client(key, verbose)
+      @symbols = symbols
+      @datatype = datatype
+      @verbose = verbose
+      @file = file
+      check_argument(["json", "csv"], datatype, "datatype")
+      if datatype == "csv" && file.nil?
+        raise Alphavantage::Error.new message: "No file specified where to save the CSV ata"
+      elsif datatype != "csv" && !file.nil?
+        raise Alphavantage::Error.new message: "Hash error: No file necessary"
+      end
+      name_symbols = symbols.join(",")
+      name_symbols.upcase!
+      url = "function=BATCH_STOCK_QUOTES&symbols=#{name_symbols}"
+      return @client.download(url, file) if datatype == "csv"
+      @hash = @client.request(url)
+      metadata = @hash.dig("Meta Data") || {}
+      metadata.each do |key, val|
+        key_sym = recreate_metadata_key(key)
+        define_singleton_method(key_sym) do
+          return val
+        end
+      end
+
+      begin
+        stock_quote = @hash.find{|key, val| key.include?("Stock Quotes")}[1]
+      rescue Exception => e
+        raise Alphavantage::Error.new message: "No Stock Quotes found: #{e.message}",
+          data: @hash
+      end
+
+      @stock_quote = []
+      stock_quote.each do |sq|
+        sval = {}
+        sq.each do |key, val|
+          key_sym = key.downcase.gsub(/[0-9.]/, "").lstrip.gsub(" ", "_")
+          sval[key_sym] = val
+        end
+        @stock_quote << sval
+      end
+    end
+
+    attr_reader :datatype, :stock_quote, :hash, :symbols
+  end
+end

data/lib/Client.rb

@@ -51,6 +51,10 @@ module Alphavantage
       return "CSV saved in #{file}"
     end
 
+    def batch(symbols:, datatype: "json", file: nil)
+      Alphavantage::Batch.new symbols: symbols, key: self, datatype: datatype, file: file
+    end
+
     def stock(symbol:, datatype: "json")
       Alphavantage::Stock.new symbol: symbol, key: self, datatype: datatype
     end

data/lib/Crypto.rb

@@ -18,8 +18,8 @@ module Alphavantage
       @datatype = datatype
     end
 
-    def timeseries type: "intraday", market: @market, file: nil, datatype: @datatype
-      Alphavantage::Crypto_Timeseries.new type: type, market: market,
+    def timeseries market: @market, file: nil, datatype: @datatype
+      Alphavantage::Crypto_Timeseries.new market: market,
         symbol: @symbol, datatype: datatype, file: file, key: @client
     end
   end

data/lib/Crypto_Timeseries.rb

@@ -2,7 +2,7 @@ module Alphavantage
   class Crypto_Timeseries
     include HelperFunctions
 
-    def initialize type: "intraday", market:, symbol:, datatype: "json", file: nil,
+    def initialize market:, symbol:, datatype: "json", file: nil,
       key:, verbose: false
       check_argument([true, false], verbose, "verbose")
       @client = return_client(key, verbose)
@@ -13,8 +13,8 @@ module Alphavantage
         raise Alphavantage::Error.new message: "Hash error: No file necessary"
       end
 
-      @selected_time_series = which_series(type)
-      url = "function=#{@selected_time_series}&symbol=#{symbol}&market=#{market}"
+      # @selected_time_series = which_series(type)
+      url = "function=DIGITAL_CURRENCY_INTRADAY&symbol=#{symbol}&market=#{market}"
       return @client.download(url, file) if datatype == "csv"
       @hash = @client.request(url)
       metadata = @hash.dig("Meta Data") || {}
@@ -57,11 +57,11 @@ module Alphavantage
 
     attr_reader :hash
 
-    def which_series(type)
-      check_argument(["intraday", "daily", "weekly", "monthly"], type, "type")
-      series = "DIGITAL_CURRENCY_"
-      series += type.upcase
-      return series
-    end
+    # def which_series(type)
+    #   check_argument(["intraday", "daily", "weekly", "monthly"], type, "type")
+    #   series = "DIGITAL_CURRENCY_"
+    #   series += type.upcase
+    #   return series
+    # end
   end
 end

data/lib/alphavantagerb.rb

@@ -11,3 +11,4 @@ require_relative "Crypto"
 require_relative "Crypto_Timeseries"
 require_relative "Sector"
 require_relative "Client"
+require_relative "Batch"

data/spec/lib/1.0.0/crypto_timeseries.rb

@@ -3,17 +3,17 @@ require_relative './../../spec_helper'
 describe Alphavantage::Crypto_Timeseries do
   context "#new" do
     it "create a new timeseries without stock" do
-      sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "BTC", key: @config["key"], verbose: false, market: "DKK", type: "daily"
+      sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "BTC", key: @config["key"], verbose: false, market: "DKK"
       expect(stock.class).to eq Alphavantage::Crypto_Timeseries
     end
 
     it "create a new stock from stock" do
-      sleep(1); timeseries = @client.crypto(symbol: "BTC", market: "DKK").timeseries(type: "monthly")
+      sleep(1); timeseries = @client.crypto(symbol: "BTC", market: "DKK").timeseries
       expect(timeseries.class).to eq Alphavantage::Crypto_Timeseries
     end
 
     it "own multiple data" do
-      sleep(1); timeseries = @client.crypto(symbol: "BTC", market: "DKK").timeseries(type: "monthly")
+      sleep(1); timeseries = @client.crypto(symbol: "BTC", market: "DKK").timeseries
       bool = []
       bool << timeseries.information.is_a?(String)
       bool << (timeseries.digital_currency_code == "BTC")
@@ -23,33 +23,27 @@ describe Alphavantage::Crypto_Timeseries do
       bool << timeseries.last_refreshed.is_a?(String)
       bool << timeseries.time_zone.is_a?(String)
       bool << timeseries.hash.is_a?(Hash)
-      bool << timeseries.open.is_a?(Array)
-      bool << timeseries.high.is_a?(Array)
-      bool << timeseries.low.is_a?(Array)
-      bool << timeseries.close.is_a?(Array)
       bool << timeseries.volume("asc").is_a?(Array)
-      bool << timeseries.open_usd.is_a?(Array)
-      bool << timeseries.high_usd.is_a?(Array)
-      bool << timeseries.low_usd.is_a?(Array)
-      bool << timeseries.close_usd.is_a?(Array)
+      bool << timeseries.price.is_a?(Array)
+      bool << timeseries.price_usd.is_a?(Array)
       bool << timeseries.market_cap_usd.is_a?(Array)
       expect(bool.all?{|e| e}).to eq true
     end
 
-    it "cannot retrieve with wrong key" do
-      error = false
-      begin
-        sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "BTC", key: "wrong_key", market: "DKK", type: "daily"
-      rescue Alphavantage::Error => e
-        error = true
-      end
-      expect(error).to eq true
-    end
+    # it "cannot retrieve with wrong key" do
+    #   error = false
+    #   begin
+    #     sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "BTC", key: "wrong_key", market: "DKK"
+    #   rescue Alphavantage::Error => e
+    #     error = true
+    #   end
+    #   expect(error).to eq true
+    # end
 
     it "cannot retrieve with wrong symbol" do
       error = false
       begin
-        sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "wrong_symbol", key: @config["key"], market: "DKK", type: "daily"
+        sleep(1); stock = Alphavantage::Crypto_Timeseries.new symbol: "wrong_symbol", key: @config["key"], market: "DKK"
       rescue Alphavantage::Error => e
         error = true
       end

data/spec/lib/1.0.0/exchange.rb

@@ -26,15 +26,15 @@ describe Alphavantage::Exchange do
       expect(bool.all?{|e| e}).to eq true
     end
 
-    it "cannot retrieve with wrong key" do
-      error = false
-      begin
-        sleep(1); stock = Alphavantage::Exchange.new from: "USD", to: "DKK", key:"wrong_key"
-      rescue Alphavantage::Error => e
-        error = true
-      end
-      expect(error).to eq true
-    end
+    # it "cannot retrieve with wrong key" do
+    #   error = false
+    #   begin
+    #     sleep(1); stock = Alphavantage::Exchange.new from: "USD", to: "DKK", key:"wrong_key"
+    #   rescue Alphavantage::Error => e
+    #     error = true
+    #   end
+    #   expect(error).to eq true
+    # end
 
     it "cannot retrieve with wrong symbol" do
       error = false

data/spec/lib/1.0.0/sector.rb

@@ -31,14 +31,14 @@ describe Alphavantage::Sector do
       expect(bool.all?{|e| e}).to eq true
     end
 
-    it "cannot retrieve with wrong key" do
-      error = false
-      begin
-        sleep(1); stock = Alphavantage::Sector.new key:"wrong_key"
-      rescue Alphavantage::Error => e
-        error = true
-      end
-      expect(error).to eq true
-    end
+    # it "cannot retrieve with wrong key" do
+    #   error = false
+    #   begin
+    #     sleep(1); stock = Alphavantage::Sector.new key:"wrong_key"
+    #   rescue Alphavantage::Error => e
+    #     error = true
+    #   end
+    #   expect(error).to eq true
+    # end
   end
 end

data/spec/lib/1.0.0/timeseries.rb

@@ -78,15 +78,15 @@ describe Alphavantage::Stock do
       expect(bool).to eq [false, true]
     end
 
-    it "cannot retrieve with wrong key" do
-      error = false
-      begin
-        sleep(1); stock = Alphavantage::Timeseries.new symbol: "MSFT", key:"wrong key"
-      rescue Alphavantage::Error => e
-        error = true
-      end
-      expect(error).to eq true
-    end
+    # it "cannot retrieve with wrong key" do
+    #   error = false
+    #   begin
+    #     sleep(1); stock = Alphavantage::Timeseries.new symbol: "MSFT", key:"wrong key"
+    #   rescue Alphavantage::Error => e
+    #     error = true
+    #   end
+    #   expect(error).to eq true
+    # end
 
     it "cannot retrieve with wrong symbol" do
       error = false

data/spec/lib/1.1.0/batch.rb

@@ -0,0 +1,45 @@
+require_relative './../../spec_helper'
+
+describe Alphavantage::Batch do
+  context "#new" do
+    it "create a new batch without client" do
+      stock = Alphavantage::Batch.new symbols: ["MSFT", "FB", "AAPL"], key: @config["key"]
+      expect(stock.class).to eq Alphavantage::Batch
+    end
+
+    it "create a new batch from client" do
+      stock = @client.batch symbols: ["MSFT", "FB", "AAPL"]
+      expect(stock.class).to eq Alphavantage::Batch
+    end
+
+    it "own multiple data" do
+      sleep(1); timeseries = @client.batch symbols: ["MSFT", "FB", "AAPL"]
+      bool = []
+      bool << timeseries.information.is_a?(String)
+      bool << timeseries.notes.is_a?(String)
+      bool << timeseries.time_zone.is_a?(String)
+      bool << timeseries.stock_quote.is_a?(Array)
+      expect(bool.all?{|e| e}).to eq true
+    end
+
+    it "can retrieve csv files" do
+      bool = []
+      directory = "#{__dir__}/test.csv"
+      bool << File.exists?(directory)
+      sleep(1); @client.batch(symbols: ["MSFT", "FB", "AAPL"], datatype: "csv", file: directory)
+      bool << File.exists?(directory)
+      File.delete(directory)
+      expect(bool).to eq [false, true]
+    end
+
+    it "cannot retrieve with wrong symbol" do
+      error = false
+      begin
+        sleep(1); stock = Alphavantage::Batch.new symbols: ["MSAFT", "FDB", "AAAPL"], key: @config["key"]
+      rescue Alphavantage::Error => e
+        error = true
+      end
+      expect(stock.stock_quote.empty?).to eq true
+    end
+  end
+end

data/spec/test_all.rb

@@ -6,3 +6,4 @@ require_relative "lib/1.0.0/indicator"
 require_relative "lib/1.0.0/sector"
 require_relative "lib/1.0.0/stock"
 require_relative "lib/1.0.0/timeseries"
+require_relative "lib/1.1.0/batch"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alphavantagerb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefano Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2018-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -49,6 +49,7 @@ files:
 - Gemfile
 - LICENSE.md
 - README.md
+- lib/Batch.rb
 - lib/Client.rb
 - lib/Crypto.rb
 - lib/Crypto_Timeseries.rb
@@ -69,6 +70,7 @@ files:
 - spec/lib/1.0.0/sector.rb
 - spec/lib/1.0.0/stock.rb
 - spec/lib/1.0.0/timeseries.rb
+- spec/lib/1.1.0/batch.rb
 - spec/spec_helper.rb
 - spec/test_all.rb
 homepage: https://github.com/StefanoMartin/AlphaVantageRB