alphavantagerb 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743749f1cf99b12c71e4c5550074305f1c7b04a5
-  data.tar.gz: 5640ecf935bc22da9f2dc6577e138e1f3846a43c
+  metadata.gz: 07f4cfa1ff82b3ce771c5c2c0147e603b44fdc8c
+  data.tar.gz: 314b436e632aec4e3855ca5a37c8ed9cbf4eba26
 SHA512:
-  metadata.gz: f46bf5a084371e19873eb21cc8ece703da94469fa079b933db4cc79f6d8b194adf0d280bb75c29f196ab7ce92c111a88b887af2156aa58faefce6e4906735bc0
-  data.tar.gz: 7bd15d518d533a731935bfaeca3b30a986e087a35be39562b97e7cf0d0f357b4ff84a3fd29e0133c5f5e422095b9577fcec7be2ab9d8442b5d3b79637aa0540d
+  metadata.gz: add330bcd18fb80ab7a16545356d38e736c9ec89bf18ec308f32f7c141851c3463869744fc37882bccc1ce46c85528cc306040cc01bc372b662023b83cb95419
+  data.tar.gz: fc1f7262bbefa9c4b1e0ecb09cefc37eaf8cf8b4f2803868038b84895cf9b86d31792410d53539c2b89a23a2a7252649d996b1c4a5c06d3ab7cad66cebbc1ab0

data/AlphavantageRB.gemspec

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

data/README.md

@@ -1,6 +1,8 @@
 AlphavantageRB [![Gem Version](https://badge.fury.io/rb/alphavantagerb.svg)](https://badge.fury.io/rb/alphavantagerb)
 =========================================================
 
+Last update: 11/10/2018
+
 [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. AlphavantageRB is based
@@ -13,6 +15,7 @@ To use it in your application: `require "alphavantagerb"`
 ## How to test
 
 To test the Gem create a config.yml file inside the folder /spec with inside a line
+
 ``` ruby
 key: [YOUR KEY]
 ```
@@ -44,6 +47,7 @@ Alphavantage::Client is used to create a client that will be used from the Alpha
 To contact Alpha Vantage you need to use a valid key that you can require from [here](https://www.alphavantage.co/support/#api-key).
 
 To setup your credentials use:
+
 ``` ruby
 client = Alphavantage::Client.new key: "YOURKEY"
 ```
@@ -56,12 +60,14 @@ setup verbose equal to true.
 ```
 
 You can use the method search to find some stocks by name.
+
 ``` ruby
   stocks_found = client.search keywords: "MSFT"
   stocks_found.output # Return the hash retrieved
 ```
 
 This will return an array where each elements has the following structure:
+
 ``` ruby
   stocks_found.stocks[0].symbol
   stocks_found.stocks[0].name
@@ -94,6 +100,7 @@ stock = Alphavantage::Stock.new symbol: "MSFT", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entry:
+
 * symbol: it is a string that denote the stock you want to retrieve.
 * key: authentication key. This value cannot be setup if you are initializing a Stock class from a client
 * 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
@@ -105,6 +112,28 @@ You can setup the datatype of future retrieving by doing:
   stock.datatype = "csv"
 ```
 
+You can retrieve an Openstruct document of the actual status of the stock by using:
+
+``` ruby
+  stock_quote = stock.quote
+```
+
+This include different method with several information:
+
+``` ruby
+stock_quote.output # Output of the request
+stock_quote.symbol
+stock_quote.open
+stock_quote.high
+stock_quote.low
+stock_quote.price
+stock_quote.volume
+stock_quote.latest_trading_day
+stock_quote.previous_close
+stock_quote.change
+stock_quote.change_percent
+```
+
 <a name="Timeseries"></a>
 ## Alphavantage::Timeseries
 
@@ -118,6 +147,7 @@ timeseries = Alphavantage::Timeseries.new symbol: "MSFT", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entries:
+
 * symbol: it is a string that denote the stock you want to retrieve. 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 stock
 * 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
@@ -130,6 +160,7 @@ Note that the initialization owns different entries:
 * file: path where a csv file should be saved (default "nil")
 
 You can retrieve all the output from Alpha Vantage by doing.
+
 ``` ruby
   timeseries.output
 ```
@@ -180,6 +211,7 @@ indicator = Alphavantage::Indicator.new function: "SMA", symbol: "MSFT", key: "Y
 
 Note that the initialization owns different entries (for deeper explanation on the parameters, please consult the Alpha Vantage documentation).
 Some of these parameters are necessary for each functions.
+
 * symbol: it is a string that denote the stock you want to retrieve. 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 stock
 * 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
@@ -196,6 +228,7 @@ positive integer parameters, positive float parameters and MA parameters.
 The MA parameters accept as an entry one of these attributes: "0", "1", "2", "3", "4", "5", "6", "7", "8", "SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "T3", "KAMA", or "MAMA".
 
 Each indicator has several methods that can use in relation of the type. Some are used for each indicator.
+
 ``` ruby
 indicator = stock.indicator(function: "SMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.output # Retrieve the output from Alpha vantage
@@ -207,55 +240,65 @@ indicator.time_zone
 ```
 
 Some other are more specific in relation of the type of indicator used.
+
 ``` ruby
 indicator.time_period # time_period is only supported by "SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3", "RSI", "STOCHRSI", "WILLR", "ADX", "ADXR", "MOM", "CCI", "CMO", "ROC", "ROCR", "AROON", "AROONOSC", "MFI", "TRIX", "DX", "MINUS_DI", "PLUS_DI", "MINUS_DM", "PLUS_DM", "BBANDS", "MIDPOINT", "MIDPRICE", "ATR","NATR"
 indicator.series_type # series_type is only supported by "SMA", "EMA", "WMA", "DEMA", "TEMA", "TRIMA", "KAMA", "T3", "RSI", "MAMA", "MACD", "MACDEXT", "STOCHRSI", "APO", "PPO", "MOM", "ROC","ROCR", "TRIX", "BBANDS", "MIDPOINT", "HT_SINE", "HT_TRENDLINE",  "HT_TRENDMODE", "HT_DCPERIOD", "HT_DCPHASE", "HT_PHASOR", "CMO"
 ```
+
 Then there are really specific indicator, for only some functions.
 
 ### SMA
+
 ``` ruby
 indicator = stock.indicator(function: "SMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.sma
 ```
 
 ### EMA
+
 ``` ruby
 indicator = stock.indicator(function: "EMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.ema
 ```
 
 ### WMA
+
 ``` ruby
 indicator = stock.indicator(function: "WMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.wma
 ```
 
 ### DEMA
+
 ``` ruby
 indicator = stock.indicator(function: "DEMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.dema
 ```
 
 ### TEMA
+
 ``` ruby
 indicator = stock.indicator(function: "TEMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.tema
 ```
 
 ### TRIMA
+
 ``` ruby
 indicator = stock.indicator(function: "TRIMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.trima
 ```
 
 ### KAMA
+
 ``` ruby
 indicator = stock.indicator(function: "KAMA", interval: "weekly", time_period: "60", series_type: "close")
 indicator.kama
 ```
 
 ### MAMA
+
 * fastlimit:  it can be a positive float (default "0.01")
 * slowlimit: it can be a positive float (default "0.01")
 
@@ -268,12 +311,14 @@ indicator.mama
 ```
 
 ### T3
+
 ``` ruby
 indicator = stock.indicator(function: "T3", interval: "weekly", time_period: "60", series_type: "close")
 indicator.t3
 ```
 
 ### MACD
+
 * fastperiod:  it can be a positive integer (default "12")
 * slowperiod: it can be a positive integer (default "26")
 * signalperiod: it can be a positive integer (default "9")
@@ -289,6 +334,7 @@ indicator.macd
 ```
 
 ### MACDEXT
+
 * fastperiod:  it can be a positive integer (default "12")
 * slowperiod: it can be a positive integer (default "26")
 * signalperiod: it can be a positive integer (default "9")
@@ -310,6 +356,7 @@ indicator.macd
 ```
 
 ### STOCH
+
 * fastkperiod: it can be a positive integer (default "5")
 * slowkperiod: it can be a positive integer (default "3")
 * slowdperiod: it can be a positive integer (default "3")
@@ -328,6 +375,7 @@ indicator.slowd
 ```
 
 ### STOCHF
+
 * fastkperiod: it can be a positive integer (default "5")
 * fastdperiod: it can be a positive integer (default "3")
 * fastdmatype: it is a MA parameter (default "0")
@@ -342,12 +390,14 @@ indicator.fastd
 ```
 
 ### RSI
+
 ``` ruby
 indicator = stock.indicator(function: "RSI", interval: "weekly", time_period: "60", series_type: "close")
 indicator.rsi
 ```
 
 ### STOCHRSI
+
 * fastkperiod: it can be a positive integer (default "5")
 * fastdperiod: it can be a positive integer (default "3")
 * fastdmatype: it is a MA parameter (default "0")
@@ -362,24 +412,28 @@ indicator.fastd
 ```
 
 ### WILLR
+
 ``` ruby
 indicator = stock.indicator(function: "WILLR", interval: "weekly", time_period: "60")
 indicator.willr
 ```
 
 ### ADX
+
 ``` ruby
 indicator = stock.indicator(function: "ADX", interval: "weekly", time_period: "60")
 indicator.adx
 ```
 
 ### ADXR
+
 ``` ruby
 indicator = stock.indicator(function: "ADXR", interval: "weekly", time_period: "60")
 indicator.adxr
 ```
 
 ### APO
+
 * fastperiod:  it can be a positive integer (default "12")
 * slowperiod: it can be a positive integer (default "26")
 * signalperiod: it can be a positive integer (default "9")
@@ -394,6 +448,7 @@ indicator.apo
 ```
 
 ### PPO
+
 * fastperiod:  it can be a positive integer (default "12")
 * slowperiod: it can be a positive integer (default "26")
 * signalperiod: it can be a positive integer (default "9")
@@ -408,42 +463,49 @@ indicator.ppo
 ```
 
 ### MOM
+
 ``` ruby
 indicator = stock.indicator(function: "MOM", interval: "weekly", time_period: "60", series_type: "close")
 indicator.mom
 ```
 
 ### BOP
+
 ``` ruby
 indicator = stock.indicator(function: "MOM", interval: "weekly", time_period: "60", series_type: "close")
 indicator.bop
 ```
 
 ### CCI
+
 ``` ruby
 indicator = stock.indicator(function: "CCI", interval: "weekly", time_period: "60")
 indicator.cci
 ```
 
 ### CMO
+
 ``` ruby
 indicator = stock.indicator(function: "CMO", interval: "weekly", time_period: "60")
 indicator.cmo
 ```
 
 ### ROC
+
 ``` ruby
 indicator = stock.indicator(function: "ROC", interval: "weekly", time_period: "60", series_type: "close")
 indicator.roc
 ```
 
 ### ROCR
+
 ``` ruby
 indicator = stock.indicator(function: "ROCR", interval: "weekly", time_period: "60", series_type: "close")
 indicator.rocr
 ```
 
 ### AROON
+
 ``` ruby
 indicator = stock.indicator(function: "AROON", interval: "weekly", time_period: "60")
 indicator.aroon_down
@@ -451,24 +513,28 @@ indicator.aroon_up
 ```
 
 ### AROONOSC
+
 ``` ruby
 indicator = stock.indicator(function: "AROONOSC", interval: "weekly", time_period: "60")
 indicator.aroonosc
 ```
 
 ### MFI
+
 ``` ruby
 indicator = stock.indicator(function: "MFI", interval: "weekly", time_period: "60")
 indicator.mfi
 ```
 
 ### TRIX
+
 ``` ruby
 indicator = stock.indicator(function: "TRIX", interval: "weekly", time_period: "60", series_type: "close")
 indicator.trix
 ```
 
 ### ULTOSC
+
 * timeperiod1: it can be a positive integer (default "7")
 * timeperiod2: it can be a positive integer (default "14")
 * timeperiod3:  it can be a positive integer (default "28")
@@ -482,36 +548,42 @@ indicator.ultosc
 ```
 
 ### DX
+
 ``` ruby
 indicator = stock.indicator(function: "DX", interval: "weekly", time_period: "60")
 indicator.dx
 ```
 
 ### MINUS_DI
+
 ``` ruby
 indicator = stock.indicator(function: "MINUS_DI", interval: "weekly", time_period: "60")
 indicator.minus_di
 ```
 
 ### PLUS_DI
+
 ``` ruby
 indicator = stock.indicator(function: "PLUS_DI", interval: "weekly", time_period: "60")
 indicator.plus_di
 ```
 
 ### MINUS_DM
+
 ``` ruby
 indicator = stock.indicator(function: "PLUS_DI", interval: "weekly", time_period: "60")
 indicator.minus_dm
 ```
 
 ### PLUS_DM
+
 ``` ruby
 indicator = stock.indicator(function: "PLUS_DM", interval: "weekly", time_period: "60", series_type: "close")
 indicator.plus_dm
 ```
 
 ### BBANDS
+
 * matype: it is a MA parameter (default "0")
 * nbdevup: it can be a positive integer (default "2")
 * nbdevdn:  it can be a positive integer (default "2")
@@ -527,18 +599,21 @@ indicator.real_upper_band
 ```
 
 ### MIDPOINT
+
 ``` ruby
 indicator = stock.indicator(function: "MIDPOINT", interval: "weekly", time_period: "60", series_type: "close")
 indicator.midpoint
 ```
 
 ### MIDPRICE
+
 ``` ruby
 indicator = stock.indicator(function: "MIDPRICE", interval: "weekly", time_period: "60", series_type: "close")
 indicator.midprice
 ```
 
 ### SAR
+
 * acceleration: it can be a positive float (default "0.01")
 * maximum: it can be a positive float (default "0.20")
 
@@ -550,30 +625,35 @@ indicator.sar
 ```
 
 ### TRANGE
+
 ``` ruby
 indicator = stock.indicator(function: "TRANGE", interval: "weekly")
 indicator.trange
 ```
 
 ### ATR
+
 ``` ruby
 indicator = stock.indicator(function: "ATR", interval: "weekly", time_period: "60")
 indicator.atr
 ```
 
 ### NATR
+
 ``` ruby
 indicator = stock.indicator(function: "NATR", interval: "weekly", time_period: "60")
 indicator.natr
 ```
 
 ### AD
+
 ``` ruby
 indicator = stock.indicator(function: "AD", interval: "weekly")
 indicator.chaikin_ad
 ```
 
 ### ADOSC
+
 * fastperiod:  it can be a positive integer (default "12")
 * slowperiod: it can be a positive integer (default "26")
 
@@ -585,18 +665,21 @@ indicator.adosc
 ```
 
 ### OBV
+
 ``` ruby
 indicator = stock.indicator(function: "OBV", interval: "weekly")
 indicator.obv
 ```
 
 ### HT_TRENDLINE
+
 ``` ruby
 indicator = stock.indicator(function: "HT_TRENDLINE", interval: "weekly", time_period: "60", series_type: "close")
 indicator.ht_trendline
 ```
 
 ### HT_SINE
+
 ``` ruby
 indicator = stock.indicator(function: "HT_SINE", interval: "weekly", series_type: "close")
 indicator.sine
@@ -604,29 +687,34 @@ indicator.lead_sine
 ```
 
 ### HT_TRENDMODE
+
 ``` ruby
 indicator = stock.indicator(function: "HT_TRENDMODE", interval: "weekly", series_type: "close")
 indicator.trendmode
 ```
 
 ### HT_DCPERIOD
+
 ``` ruby
 indicator = stock.indicator(function: "HT_DCPERIOD", interval: "weekly", series_type: "close")
 indicator.dcperiod
 ```
 
 ### HT_DCPHASE
+
 ``` ruby
 indicator = stock.indicator(function: "EMA", interval: "weekly", series_type: "close")
 indicator.ht_dcphase
 ```
 
 ### HT_PHASOR
+
 ``` ruby
 indicator = stock.indicator(function: "HT_PHASOR", interval: "weekly", series_type: "close")
 indicator.quadrature
 indicator.phase
 ```
+
 <a name="Crypto"></a>
 ## Alphavantage::Crypto
 
@@ -642,6 +730,7 @@ crypto = Alphavantage::Crypto.new symbol: "BTC", market: "DKK", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entry:
+
 * symbol: it is a string that denote the cryptocurrency you want to retrieve.
 * market: denote the market where you want to analyze the cryptocurrency
 * key: authentication key. This value cannot be setup if you are initializing a Stock class from a client
@@ -667,8 +756,9 @@ crypto_timeseries = Alphavantage::Crypto_Timeseries.new type: "daily", symbol: "
 ```
 
 Note that the initialization owns different entries:
+
 * symbol: it is a string that denote the stock you want to retrieve. This value cannot be setup if you are initializing a timeseries from a crypto class from a crypto class
-* 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
+* market: it is a string that denote the market you want to analyse. 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")
@@ -676,6 +766,7 @@ Note that the initialization owns different entries:
 * file: path where a csv file should be saved (default "nil")
 
 You can retrieve all the output from Alpha Vantage by doing.
+
 ``` ruby
   crypto_timeseries.output
 ```
@@ -716,6 +807,7 @@ You can order the data in ascending or descending order.
   crypto_timeseries.open("desc") # Default
   crypto_timeseries.open("asc")
 ```
+
 <a name="Exchange"></a>
 ## Alphavantage::Exchange
 
@@ -730,6 +822,7 @@ exchange = Alphavantage::Exchange.new from: "USD", to: "DKK", key: "YOURKEY"
 ```
 
 Note that the initialization owns different entry:
+
 * from: input currency you want to check the value
 * to: output currency you want to see the value
 * symbol: it is a string that denote the stock you want to retrieve.
@@ -738,6 +831,7 @@ Note that the initialization owns different entry:
 * datatype: it can be "json" or "csv" (default "json")  
 
 You can retrieve the actual situation of the exchange from Alpha Vantage by doing.
+
 ``` ruby
   ex_now = exchange.now
 ```
@@ -770,6 +864,7 @@ exchange_timeseries = Alphavantage::Exchange_Timeseries.new from: "USD", to: "DK
 ```
 
 Note that the initialization owns different entries:
+
 * symbol: it is a string that denote the stock you want to retrieve. 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 stock
 * 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
@@ -782,6 +877,7 @@ Note that the initialization owns different entries:
 * file: path where a csv file should be saved (default "nil")
 
 You can retrieve all the output from Alpha Vantage by doing.
+
 ``` ruby
   exchange_timeseries.output
 ```
@@ -828,14 +924,17 @@ sector = Alphavantage::Sector.new key: "YOURKEY"
 ```
 
 Note that the initialization owns different entries:
+
 * key: authentication key.  This value cannot be setup if you are initializing a timeseries from a crypto class
 
 You can retrieve all the output from Alpha Vantage by doing.
+
 ``` ruby
   sector.output
 ```
 
 Specific information about the timeseries can be retrieved using the following methods:
+
 ``` ruby
   sector.information
   sector.last_refreshed
@@ -856,6 +955,7 @@ Specific information about the timeseries can be retrieved using the following m
 
 Errors are handled by this class.
 You receive errors in the following cases:
+
 * "Failed request": a request to Alpha Vantage fails
 * "Parsing failed": the parsing of the JSON from Alpha Vantage fails
 * A generic message from Alpha Vantage (for example by using a wrong key, a wrong query or too many requests at once). This message is equal as the one returned from Alpha Vantage API
@@ -869,6 +969,7 @@ You receive errors in the following cases:
 * "Key should be a string": you are trying to use a wrong key
 
 You can retrieve more information from your error by using:
+
 ``` ruby
   e.message
   e.data # Data retrieved from Alpha vantage or further information to correct the error

data/spec/lib/1.0.0/stock.rb

@@ -27,6 +27,24 @@ describe Alphavantage::Stock do
       expect(bool).to eq ["json", "error", "csv"]
     end
 
+    it "can retrieve quote" do
+      stock = @client.stock symbol: "MSFT"
+      stock_quote = stock.quote
+      res = []
+      res << stock_quote.output.is_a?(Hash)
+      res << stock_quote.symbol.is_a?(String)
+      res << stock_quote.open.is_a?(String)
+      res << stock_quote.high.is_a?(String)
+      res << stock_quote.low.is_a?(String)
+      res << stock_quote.price.is_a?(String)
+      res << stock_quote.volume.is_a?(String)
+      res << stock_quote.latest_trading_day.is_a?(String)
+      res << stock_quote.previous_close.is_a?(String)
+      res << stock_quote.change.is_a?(String)
+      res << stock_quote.change_percent.is_a?(String)
+      expect(res.all?{|e| e}).to eq true
+    end
+
     it "can create a new timeseries from stock" do
       stock = @client.stock symbol: "MSFT"
       timeseries = stock.timeseries

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alphavantagerb
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Stefano Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-10 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty