finnhubrb 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 305ff27db99c18e1a76d1034fd69b568e89b45fd8cfba42a030199b03e4ba4f2
-  data.tar.gz: a65a7dc065c422855d5a4a6685349c6a634be771b517586541ab90e43e1c9fde
+  metadata.gz: 24f55e759933953990eb11d0047d58d31ba29fe6937d5c216001021c4f708589
+  data.tar.gz: b3c5b08e7cb5a0b2383450eced49455176adbd5ac55ce99c45426baacd69611a
 SHA512:
-  metadata.gz: c8cc6932d02616b872f2ac87737acde0ce0d4b951d72f76875edf32f4fc8e1ac37d37dc67ba59570bdd1a0d5fe4ec9463939748e6dfd8e950a6f029e94c63478
-  data.tar.gz: b0323e588781a3eabd6f49347f0985e51dd5d0eb872a02e07790aaa20a8407aab5adc8d5ef7d1ff477ebd134a3e9ca5dbff750c8622388b78d5e4de284f6fd6f
+  metadata.gz: 8821e04829a448e35da18a8d3c0d6cf5281c82aeaa40a40306e9d504c691554109009cf3ef304c9418e90e5f0768b98bc6e7394c2dfaa05a6baa8365d74eaa10
+  data.tar.gz: 2c78cd652e399426d40065367dbe367c0ae5f7cfb132c1db5d2b8e152bb1d5d779933021d731f9681c46bafc1625ee96bd6857c898ff80242604f7087f832bd5

data/FinnhubRB.gemspec

@@ -4,7 +4,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "finnhubrb"
-  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/FinnhubRB"

data/README.md

@@ -1,4 +1,4 @@
-FinnhubRB
+FinnhubRB [![Gem Version](https://badge.fury.io/rb/finnhubrb.svg)](https://badge.fury.io/rb/finnhubrb)
 =========================================================
 
 [Finnhub](https://finnhub.io/) is an API for retrieving Stock
@@ -22,7 +22,7 @@ Then run "rspec spec/test_all.rb".
 
 ## Support
 
-* Without a premium account, testing is hard and I could have missed something. Any bug, suggestions and improvements are more than welcome. Please do not be shy to create issues or pull requests.
+* Without a premium account, testing is hard and I could have missed something. Any bug, suggestions and improvements are more than welcome. Please do not be shy to create issues or pull requests. Premium features are implemented but untested.
 * This is a personal project, any stars for giving your support will make a man happy.
 
 ## Client
@@ -44,24 +44,49 @@ setup verbose equal to true.
 
 ## Stock
 
-Finnhub::Stock is used to manage a stock class.
-To create a new Stock class you can use a client.
+To analyse a stock you can start by choosing which stock exchange you want to analyse.
+
+``` ruby
+client.stock_exchanges # Retrieve the available stock exchanges on Finnhub (Finnhub::Stock_Exchange instances)
+client.stock_exchanges(plain: true) # As above, but it returns simply the output of the request
+stock_exchange = client.stock_exchanges(name: "NAME_CRYPTO_EXCHANGE") # Create a single instance of Finnhub::Stock_Exchange
+```
+
+After that you can choose in that crypto exchange which symbol you want to check.
+
+``` ruby
+stock_exchange.symbols # Retrieve the available stock symbols on the chosen stock exchange (Finnhub::Stock instances)
+stock_exchange.symbols(plain: true) # As above, but it returns simply the output of the request
+```
+
+In alternative you can create a stock instance directly:.
 
 ``` ruby
 stock = client.stock symbol: "AAPL"
 ```
 
+Finnhub::Stock is used to manage a stock class.
 Several methods are available under this class:
 
 ``` ruby
   stock.symbol # Return the symbol
   stock.profile # Retrieve profile of the stock
+  stock.profile(isin: "US5949181045") # Retrieve profile of the stock by its isin
+  stock.profile(cusip: "023135106") # Retrieve profile of the stock by its cusip
+  stock.profile # Retrieve profile of the stock
   stock.ceo_compensation # Retrieve compensation of the stock's CEO
+  stock.executive # Retrieve list of company's executives
   stock.recommendation # Retrieve recommendation about this stock
   stock.price_target # Retrieve price target about this stock
+  stock.upgrade_downgrade # Retrieve latest stock upgrade and downgrade
   stock.option_chain # Retrieve option chain about this stock
   stock.earnings # Retrieve earnings about this stock
+  stock.metrics # Retrieve key metrics
+  stock.investors # Retrieve full list of investors
+  stock.funds # Retrieve list of fund investors
+  stock.financials # (PREMIUM) Retrieve standardized balances sheet
   stock.news # Retrieve news about this stock (only US)
+  stock.major_development # Retrieve major development
   stock.sentiment # Retrieve social sentiment about this stock (only US)
   stock.peers(plain: true) # Retrieve peers company similar to the one chosen
   stock.peers # Like the previous one, but the results are Finnhub::Stock instances
@@ -77,6 +102,7 @@ To create a timeseries you can use:
   stock.timeseries(resolution: "D") # Resolution is daily "D", alternative are 1, 5, 15, 30, 60, D, W, M) where the numeric one are for minutes (default resolution is "D")
   stock.timeseries(from: Time.now-24*30*3600, to: Time.now) # Fetch from a date to another date (default from: nil, to: nil)
   stock.timeseries(format: "json") # Return the output in json or in csv (default format: "json")
+  stock.timeseries(adjusted: true) # Return adjusted data (default false)
 ```
 
 Remember count and from/to are exclusive. If you use one, you cannot use the other two.
@@ -85,7 +111,7 @@ The methods "open", "high", "low", "close", "volume" and "status" will not work
 ``` ruby
   timeseries = stock.timeseries(from: Time.now-24*30*3600, to: Time.now, resolution: 60)
   timeseries.output # Return output obtained from the request
-  timeseris.timestamps # Return timestamps obtained from the request
+  timeseries.timestamps # Return timestamps obtained from the request
   timeseries.open # Return open obtained from the request  
   timeseries.low # Return low obtained from the request
   timeseries.close # Return close obtained from the request
@@ -93,14 +119,35 @@ The methods "open", "high", "low", "close", "volume" and "status" will not work
   timeseries.status # Return status obtained from the request  
 ```
 
+
+(PREMIUM) To manage tick data use:
+
+``` ruby
+  tick = stock.tick(from: Time.now-24*30*3600, to: Time.now) # Create stick data
+  tick.output # Return output obtained from the request
+  tick.timestamps # Return timestamps obtained from the request
+  tick.price  # Return price  obtained from the request
+  tick.volume # Return volume obtained from the request
+  tick.status # Return status obtained from the request  
+```
+
+
+(PREMIUM) To retrieve transcripts you can use:
+
+``` ruby
+  stock.stock_exchanges # Retrieve the available stock exchanges on Finnhub (Finnhub::Stock_Exchange instances)
+  client.stock_exchanges(plain: true) # As above, but it returns simply the output of the request
+  stock_exchange = client.stock_exchanges(name: "NAME_CRYPTO_EXCHANGE") # Create a single instance of Finnhub::Stock_Exchange
+```
+
 ## Crypto
 
 To analyse a crypto currency you should start by choosing which crypto exchange you want to analyse.
 
 ``` ruby
-client.crypto_exchanges # Retrieve the available crypto exchanges on Finnhub (Finnhub::Crypto_Exchange instances)
-client.crypto_exchanges(plain: true) # As above, but it returns simply the output of the request
-crypto_exchange = client.crypto_exchange(name: "NAME_CRYPTO_EXCHANGE") # Create a single instance of Finnhub::Crypto_Exchange
+client.transcripts # Retrieve the available transcripts on Finnhub (Finnhub::Transcript instances)
+client.transcripts(plain: true) # As above, but it returns simply the output of the request
+client.transcripts[0].transcript # Retrieve the specific transcript
 ```
 
 After that you can choose, in that crypto exchange which symbol you want to check.
@@ -175,7 +222,7 @@ Furthermore you can create a timeseries with the same logic used for Stock times
 
 ## Merge
 
-You can retrieve information about company that are merging in relation of a given country.
+(PREMIUM) You can retrieve information about company that are merging in relation of a given country.
 
 ``` ruby
 client.merge_countries # Retrieve the available merge countries on Finnhub (Finnhub::Merge_Country instances)

data/lib/Client.rb

@@ -48,6 +48,13 @@ module Finnhub
       Finnhub::Websocket.new(@apikey)
     end
 
+    def stock_exchanges(plain: false)
+      output = request("/stock/exchange")
+      return output if plain
+
+      output.map{|o| Finnhub::Stock_Exchange.new(client: self, code: o[:code], hash: o)}
+    end
+
     def stock(symbol:)
       Finnhub::Stock.new(client: self, symbol: symbol)
     end

data/lib/Crypto.rb

@@ -1,4 +1,4 @@
- module Finnhub
+module Finnhub
   class Crypto_Exchange
     def initialize(client:, name:)
       @client = client

data/lib/Stock.rb

@@ -1,22 +1,64 @@
 module Finnhub
+  class Stock_Exchange
+    def initialize(client:, code:, hash:)
+      @client = client
+      @hash = hash
+      @code = code
+    end
+
+    attr_reader :hash, :code
+
+    def symbols(plain: false)
+      output = @client.request("/stock/symbol?exchange=#{@code}")
+      return output if plain
+
+      output.map do |o|
+        Finnhub::Stock.new(client: @client, exchange: @code, **o)
+      end
+    end
+
+    def symbol(**args)
+      Finnhub::Stock.new(client: @client, exchange: @code, **args)
+    end
+  end
+
+
   class Stock
     include Finnhub::Analysis
 
-    def initialize(client:, symbol:)
+    def initialize(client:, symbol:,
+      displaySymbol: nil, description: nil, exchange: nil)
       @client = client
       @symbol = symbol
+      @displaySymbol = displaySymbol
+      @description = description
+      @exchange = exchange
     end
 
-    attr_reader :symbol
+    attr_reader :symbol, :displaySymbol, :description, :exchange
 
-    def profile
-      @client.request("/stock/profile?symbol=#{@symbol}")
+    def profile(isin: nil, cusip: nil)
+      if !isin.nil?
+        string = "isin".freeze
+        symbol = isin
+      elsif !cusip.nil?
+        string = "cusip".freeze
+        symbol = cusip
+      else
+        string = "symbol".freeze
+        symbol = @symbol
+      end
+      @client.request("/stock/profile?#{string}=#{symbol}")
     end
 
     def ceo_compensation
       @client.request("/stock/ceo-compensation?symbol=#{@symbol}")
     end
 
+    def executive
+      @client.request("/stock/executive?symbol=#{@symbol}")
+    end
+
     def recommendation
       @client.request("/stock/recommendation?symbol=#{@symbol}")
     end
@@ -25,6 +67,10 @@ module Finnhub
       @client.request("/stock/price-target?symbol=#{@symbol}")
     end
 
+    def upgrade_downgrade
+      @client.request("/stock/upgrade-downgrade?symbol=#{@symbol}")
+    end
+
     def option_chain
       @client.request("/stock/option-chain?symbol=#{@symbol}")
     end
@@ -36,20 +82,62 @@ module Finnhub
       output.map{|o| Finnhub::Stock.new(client: @client, symbol: o)}
     end
 
-    def earnings
-      @client.request("/stock/earnings?symbol=#{@symbol}")
+    def earnings(limit: nil)
+      url = "/stock/earnings?symbol=#{@symbol}"
+      url += "&limit=#{limit}" unless limit.nil?
+      @client.request(url)
+    end
+
+    def metrics(metric: "price")
+      @client.request("/stock/metric?symbol=#{@symbol}&metric=#{metric}")
+    end
+
+    def investors(limit: nil)
+      url = "/stock/investor-ownership?symbol=#{@symbol}"
+      url += "&limit=#{limit}" unless limit.nil?
+      @client.request(url)
+    end
+
+    def funds(limit: nil)
+      url = "/stock/fund-ownership?symbol=#{@symbol}"
+      url += "&limit=#{limit}" unless limit.nil?
+      @client.request(url)
+    end
+
+    def financials(statement: "bs", freq: "annual")
+      @client.request("/stock/financials?symbol=#{@symbol}&statement=#{statement}&freq=#{freq}")
+    end
+
+    def quote
+      @client.request("/quote?symbol=#{@symbol}")
     end
 
     def news
       @client.request("/news/#{@symbol}")
     end
 
+    def major_development
+      @client.request("/major-development?symbol=#{@symbol}")
+    end
+
     def sentiment
       @client.request("/news-sentiment?symbol=#{@symbol}")
     end
 
+    def transcripts(plain: false)
+      output = @client.request("/stock/transcripts/list?symbol=#{@symbol}")
+      return output if plain
+
+      output[:transcripts].map{|o| Finnhub::Transcript.new(client: self, id: o[:id], hash: o)}
+    end
+
     def timeseries(**args)
       Finnhub::Timeseries.new(client: @client, stock: self, **args)
     end
+    alias :candles :timeseries
+
+    def tick(**args)
+      Finnhub::Tick.new(client: @client, stock: self, **args)
+    end
   end
 end

data/lib/Tick.rb

@@ -0,0 +1,40 @@
+module Finnhub
+  class Tick
+    def initialize(client:, stock:, from:, to:)
+      url = "/stock/candle?symbol=#{stock.symbol}"
+      from = from.to_i if from.is_a?(Time)
+      url += "&from=#{from}"
+      to = to.to_i if to.is_a?(Time)
+      @output = client.request(url)
+      if @output.is_a?(Hash) && @output[:s] == "ok"
+        @timestamps = @output[:trades][:t]&.map{|t| Time.strptime(t.to_s,'%L')}
+      else
+        @timestamps = []
+      end
+    end
+
+    attr_reader :output, :timestamps
+
+    def price
+      operation(:p)
+    end
+
+    def volume
+      operation(:v)
+    end
+
+
+    def status
+      raise Finnhub::Error message: "Output is not a hash" unless @output.is_a?(Hash)
+      @output[:s]
+    end
+
+    private
+
+    def operation(type)
+      raise Finnhub::Error message: "Output is not a hash" unless @output.is_a?(Hash)
+      return [] if @output[:trades][0][type].nil?
+      @timestamps.zip(@output[:trades].map{|t| t[type]})
+    end
+  end
+end

data/lib/Timeseries.rb

@@ -1,7 +1,7 @@
 module Finnhub
   class Timeseries
     def initialize(client:, stock:, resolution: "D", count: 100,
-      from: nil, to: nil, format: nil)
+      from: nil, to: nil, format: nil, adjusted: false)
       url = "/stock/candle?symbol=#{stock.symbol}&resolution=#{resolution}"
       url += "&count=#{count}" unless count.nil?
       from = from.to_i if from.is_a?(Time)
@@ -9,9 +9,10 @@ module Finnhub
       to = to.to_i if to.is_a?(Time)
       url += "&to=#{to}" unless to.nil?
       url += "&format=#{format}" unless format.nil?
+      url += "&adjusted=#{adjusted}" if adjusted
       @output = client.request(url)
       if @output.is_a?(Hash) && @output[:s] == "ok"
-        @timestamps = @output[:t]&.map{|t| DateTime.strptime(t.to_s,'%s')}
+        @timestamps = @output[:t]&.map{|t| Time.strptime(t.to_s,'%s')}
       else
         @timestamps = []
       end

data/lib/Transcript.rb

@@ -0,0 +1,15 @@
+module Finnhub
+  class Transcript
+    def initialize(client:, id:, hash: nil)
+      @client = client
+      @id = id
+      @hash = hash
+    end
+
+    attr_reader :id, :hash
+
+    def transcript
+      @client.request("/stock/transcripts?id=#{@id}")
+    end
+  end
+end

data/lib/{finnhubrb.rb → finnhub.rb}

@@ -14,3 +14,5 @@ require_relative "Error"
 require_relative "Forex"
 require_relative "Stock"
 require_relative "Websocket"
+require_relative "Tick"
+require_relative "Transcript"

data/spec/1.0.0/stock.rb

@@ -44,7 +44,7 @@ describe "1.0.0" do
 
     it "can retrieve a peers" do
       output = @store[:stock].peers(plain: true)
-      expect(output).to include "ALOT"
+      expect(output).to include "AAPL"
 
       output2 = @store[:stock].peers[0].profile
       expect(output2[:ticker]).to eq output[0]
@@ -69,7 +69,7 @@ describe "1.0.0" do
     end
 
     it "can retrieve timeseries" do
-      timeseries = @store[:stock].timeseries(count: 100)
+      timeseries = @store[:stock].timeseries(count: 100, adjusted: true)
       expect(timeseries.open.class).to be Array
       expect(timeseries.high.class).to be Array
       expect(timeseries.low.class).to be Array

data/spec/1.1.0/stock.rb

@@ -0,0 +1,90 @@
+require_relative '../spec_helper'
+
+describe "1.1.0" do
+  context "Stock" do
+    it "create a new client" do
+      @store[:client] = Finnhub::Client.new(key: @key, verbose: true)
+      expect(@store[:client].class).to be Finnhub::Client
+    end
+    
+    it "retrieve stock exchanges" do
+      @store[:stock] = @store[:client].stock_exchanges
+      symbols = @store[:stock].map{|s| s.code}
+      expect(symbols).to include "US"
+    end
+
+    it "retrieve symbols from stock exchanges" do
+      symbols = @store[:stock][0].symbols
+      expect(symbols[0].exchange).to eq @store[:stock][0].code
+    end
+
+    it "create a new stock" do
+      @store[:stock] = @store[:client].stock(symbol: "AAPL")
+      expect(@store[:stock].symbol).to eq "AAPL"
+    end
+
+    it "can retrieve a executive" do
+      output = @store[:stock].executive
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve a upgrade_downgrade" do
+      output = @store[:stock].upgrade_downgrade
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve metrics" do
+      output = @store[:stock].metrics
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve investors" do
+      output = @store[:stock].investors
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve funds" do
+      output = @store[:stock].funds
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve financials" do
+      skip "Premium" if @skip_premium
+      output = @store[:stock].financials
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve quote" do
+      skip "Premium"  if @skip_premium
+      output = @store[:stock].quote
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve major_development" do
+      output = @store[:stock].major_development
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve transcripts" do
+      skip "Premium" if @skip_premium
+      output = @store[:stock].transcripts
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+
+    it "can retrieve tick" do
+      skip "Premium" if @skip_premium
+      output = @store[:stock].tick(from: Time.now-24*30*3600, to: Time.now)
+
+      expect(output[:symbol]).to eq "AAPL"
+    end
+  end
+end

data/spec/all.rb

@@ -3,3 +3,4 @@ require_relative "1.0.0/forex"
 require_relative "1.0.0/other"
 require_relative "1.0.0/stock"
 require_relative "1.0.0/websocket"
+require_relative "1.1.0/stock"

data/spec/config.yml

@@ -1 +1 @@
-key: "bn0s9fvrh5r8qh5rphq0"
+key: bn0s9fvrh5r8qh5rphq0

data/spec/spec_helper.rb

@@ -1,16 +1,14 @@
 require "rspec"
 require "pry-byebug"
 require "yaml"
-# require_relative "../lib/finnhub"
-require "finnhubrb"
-require "openssl"
-OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+require_relative "../lib/finnhub"
 
 RSpec.configure do |config|
 	config.color = true
 	config.before(:all) do
 		val = YAML.load_file("#{__dir__}/config.yml")
     @key = val["key"]
+		@skip_premium = val["skip_premium"].nil? ? true : val["skip_premium"]
     @store = {}
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finnhubrb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefano Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -164,14 +164,17 @@ files:
 - lib/Error.rb
 - lib/Forex.rb
 - lib/Stock.rb
+- lib/Tick.rb
 - lib/Timeseries.rb
+- lib/Transcript.rb
 - lib/Websocket.rb
-- lib/finnhubrb.rb
+- lib/finnhub.rb
 - spec/1.0.0/crypto.rb
 - spec/1.0.0/forex.rb
 - spec/1.0.0/other.rb
 - spec/1.0.0/stock.rb
 - spec/1.0.0/websocket.rb
+- spec/1.1.0/stock.rb
 - spec/all.rb
 - spec/config.yml
 - spec/spec_helper.rb
@@ -195,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A gem for Alpha Vantage