intrinio-realtime 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6c6b1e8ef7761659187a4f70cfd2d63b22a6bfb
-  data.tar.gz: 1ce5ed2d02a98101de4f36e6ba8b7a0db0bc1868
+  metadata.gz: a230dd8a59f925f023ddde64d91f7d6c33e40ecb
+  data.tar.gz: d6fe3f0b65ececa7e939d036d9bdf7322b396737
 SHA512:
-  metadata.gz: 6555c857b6e00546c9d9fa6d237a74fda2cb410803dd2ff6c8fcf648be9da1cbb60cb2d6fb4eb49bb987541b16363c3b2cd28073ccf8873e7e177f28e725f0ab
-  data.tar.gz: a2392977884efb471d1db6fd42f1093fddfe4f0b68e02e63194aab3b560e286ae464a15ffffaa2ee3cc710b248844822e8e6a8db7cb76aa1441d373fae269413
+  metadata.gz: 194bf4c83eda268fcd8df8e522588e326027aeb23e9f769bf608bedcf4538414bd8e9849b669d9e94f84f18731c484fb146c2d678f802f2caccb2df92bdc9147
+  data.tar.gz: e5170c7f944938e482f8a205c3694cd137faa277a07834b199df81a41ab760ab60e40b5859cde468adbc46458f760e6937f9a073f9933a585e9940a0d5791b39

data/lib/intrinio-realtime.rb

@@ -7,10 +7,11 @@ require 'websocket-client-simple'
 module Intrinio
   module Realtime
     HEARTBEAT_TIME = 3
-    SELF_HEAL_BACKOFFS = [0,100,500,1000,2000,5000]
-    IEX = "iex"
-    QUODD = "quodd"
-    PROVIDERS = [IEX, QUODD]
+    SELF_HEAL_BACKOFFS = [0, 100, 500, 1000, 2000, 5000].freeze
+    IEX = "iex".freeze
+    QUODD = "quodd".freeze
+    CRYPTOQUOTE = "cryptoquote".freeze
+    PROVIDERS = [IEX, QUODD, CRYPTOQUOTE].freeze
 
     def self.connect(options, &b)
       EM.run do
@@ -21,16 +22,22 @@ module Intrinio
     end
 
     class Client
+
       def initialize(options) 
         raise "Options parameter is required" if options.nil? || !options.is_a?(Hash)
-        
-        @username = options[:username]
-        @password = options[:password]
-        raise "Username and password are required" if @username.nil? || @username.empty? || @password.nil? || @password.empty?
-        
+
+        @api_key = options[:api_key]
+        raise "API Key was formatted invalidly." if @api_key && !valid_api_key?(@api_key)
+
+        unless @api_key
+          @username = options[:username]
+          @password = options[:password]
+          raise "API Key or Username and password are required" if @username.nil? || @username.empty? || @password.nil? || @password.empty?
+        end
+
         @provider = options[:provider]
         raise "Provider must be 'quodd' or 'iex'" unless PROVIDERS.include?(@provider)
-        
+
         @channels = []
         @channels = parse_channels(options[:channels]) if options[:channels]
         bad_channels = @channels.select{|x| !x.is_a?(String)}
@@ -44,7 +51,7 @@ module Intrinio
           @logger = Logger.new($stdout)
           @logger.level = Logger::INFO
         end
-        
+
         @quotes = EventMachine::Channel.new
         @ready = false
         @joined_channels = []
@@ -53,7 +60,7 @@ module Intrinio
         @selfheal_backoffs = Array.new(SELF_HEAL_BACKOFFS)
         @ws = nil
       end
-      
+
       def provider
         @provider
       end
@@ -124,32 +131,55 @@ module Intrinio
       
       def refresh_token
         @token = nil
-        
-        response =  HTTP.basic_auth(:user => @username, :pass => @password).get(auth_url)
+
+        if @api_key
+          response = HTTP.get(auth_url)
+        else
+          response = HTTP.basic_auth(:user => @username, :pass => @password).get(auth_url)
+        end
+
         return fatal("Unable to authorize") if response.status == 401
         return fatal("Could not get auth token") if response.status != 200
-        
+
         @token = response.body
         debug "Token refreshed"
       end
       
       def auth_url 
+        url = ""
+
         case @provider 
-        when IEX then "https://realtime.intrinio.com/auth"
-        when QUODD then "https://api.intrinio.com/token?type=QUODD"
+        when IEX then url = "https://realtime.intrinio.com/auth"
+        when QUODD then url = "https://api.intrinio.com/token?type=QUODD"
+        when CRYPTOQUOTE then url = "https://crypto.intrinio.com/auth"
         end
+
+        url = api_auth_url(url) if @api_key
+
+        url
       end
-      
+
+      def api_auth_url(url)
+        if @api_key.include? "?"
+          url = "#{url}&"
+        else
+          url = "#{url}?"
+        end
+
+        "#{url}api_key=#{@api_key}"
+      end
+
       def socket_url 
         case @provider 
         when IEX then URI.escape("wss://realtime.intrinio.com/socket/websocket?vsn=1.0.0&token=#{@token}")
         when QUODD then URI.escape("wss://www5.quodd.com/websocket/webStreamer/intrinio/#{@token}")
+        when CRYPTOQUOTE then URI.escape("wss://crypto.intrinio.com/socket/websocket?vsn=1.0.0&token=#{@token}")
         end
       end
-      
+
       def refresh_websocket
         me = self
-        
+
         @ws.close() unless @ws.nil?
         @ready = false
         @joined_channels = []
@@ -160,7 +190,7 @@ module Intrinio
         ws.on :open do
           me.send :info, "Connection established"
           me.send :ready, true
-          if me.send(:provider) == IEX
+          if me.send(:provider) == IEX || me.send(:provider) == CRYPTOQUOTE
             me.send :refresh_channels
           end
           me.send :start_heartbeat
@@ -185,6 +215,10 @@ module Intrinio
               elsif json["event"] == "quote" || json["event"] == "trade"
                 json["data"]
               end
+            when CRYPTOQUOTE
+              if json["event"] == "book_update" || json["event"] == "ticker" || json["event"] == "trade"
+                json["payload"]
+              end
             end
             
             if quote && quote.is_a?(Hash)
@@ -245,6 +279,7 @@ module Intrinio
         case @provider 
         when IEX then {topic: 'phoenix', event: 'heartbeat', payload: {}, ref: nil}.to_json
         when QUODD then {event: 'heartbeat', data: {action: 'heartbeat', ticker: (Time.now.to_f * 1000).to_i}}.to_json
+        when CRYPTOQUOTE then {topic: 'phoenix', event: 'heartbeat', payload: {}, ref: nil}.to_json
         end
       end
       
@@ -341,6 +376,13 @@ module Intrinio
               action: "subscribe"
             }
           }
+        when CRYPTOQUOTE
+          {
+            topic: channel,
+            event: "phx_join",
+            payload: {},
+            ref: nil
+          }
         end
       end
       
@@ -361,8 +403,22 @@ module Intrinio
               action: "unsubscribe"
             }
           }
+        when CRYPTOQUOTE
+          {
+            topic: channel,
+            event: "phx_leave",
+            payload: {},
+            ref: nil
+          }
         end
       end
+
+      def valid_api_key?(api_key)
+        return false unless api_key.is_a?(String)
+        return false if api_key.empty?
+        true
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intrinio-realtime
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Intrinio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-18 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Intrinio provides real-time stock prices from the IEX stock exchange, via