Merge pull request #3 from taylorfinnell/various-tweaks

support multiple countries

Author: taylorfinnell

README.md

@@ -24,7 +24,8 @@ class WordFrequencyBot
 
   getter words
 
-  def initialize
+  def initialize(@show : HqTrivia::Model::Show, @coordinator : HqTrivia::Coordinator)
+    super
     @words = {} of String => Int32
   end
 
@@ -36,8 +37,12 @@ class WordFrequencyBot
   end
 end
 
-bot = WordFrequencyBot.new
-bot.play # blocks until there is an active show, pass false to #play for non blocking
+coordinator = HqTrivia::HqCoordinator.new("us")
+HqTrivia.on_show(coordinator) do |show|
+  bot = WordFrequencyBot.new(show, coordinator)
+
+  bot.play
+end
 ```
 
 Other messages that can be handled include

shard.yml

@@ -1,5 +1,5 @@
 name: hqtrivia
-version: 0.1.1
+version: 0.2.0
 
 authors:
   - Taylor Finnell <[email protected]>

spec/hqtrivia/bot_spec.cr

@@ -5,7 +5,8 @@ class MyBot
 
   getter words
 
-  def initialize
+  def initialize(@show : HqTrivia::Model::Show, @coordinator : HqTrivia::Coordinator)
+    super
     @words = {} of String => Int32
   end
 
@@ -21,16 +22,17 @@ module HqTrivia
   describe Bot do
     it "works" do
       messages = File.read("./spec/data/fullgame").each_line.to_a
-      show = Model::Show.new(active: true, prize: 100, show_id: 666, start_time: Time.now)
-      connection = Connection::Local.new(messages, show)
+      show = Model::Show.new(active: true, show_type: "hq-us", prize: 100, show_id: 666, start_time: Time.now)
+      connection = Connection::Local.new(messages)
 
-      bot = MyBot.new
+      bot = MyBot.new(show, LocalCoordinator.new("us"))
       bot.play(connection)
 
       bot.words.values.max.should eq(328)
       bot.start_time.should eq(show.start_time)
       bot.show_id.should eq(show.show_id)
       bot.prize.should eq(show.prize)
+      bot.country.should eq("us")
     end
   end
 end

spec/hqtrivia/connection/local_spec.cr

@@ -7,12 +7,12 @@ module HqTrivia::Connection
       {"type":"interaction","ts":"2018-05-02T18:56:04.465Z","itemId":"chat","userId":5169584,"metadata":{"userId":5169584,"message":"🧠","avatarUrl":"https://d2xu1hdomh3nrx.cloudfront.net/72x72/default_avatars/Untitled-1_0001_blue.png","interaction":"chat","username":"kboogie1"},"sent":"2018-05-02T18:56:04.466Z"}
       MSG
 
-      show = Model::Show.new(active: true, prize: 100, show_id: 666, start_time: Time.now)
-      local = Local.new([msg], show)
+      show = Model::Show.new(active: true, show_type: "hq-us", prize: 100, show_id: 666, start_time: Time.now)
+      local = Local.new([msg])
       local.on_message do |msg|
         msg.should be_a(Model::Interaction)
       end
-      local.connect
+      local.connect(show, LocalCoordinator.new("us"))
     end
   end
 end

spec/hqtrivia/show_coordinator_spec.cr

@@ -0,0 +1,21 @@
+require "../../spec_helper"
+
+module HqTrivia
+  describe ShowCoordinator do
+    it "yields the show if it is active" do
+      coordinator = LocalCoordinator.new("us", active: true)
+      show_coord = ShowCoordinator.new(coordinator)
+      show_coord.on_show do |show|
+        show.should be_a(Model::Show)
+      end
+    end
+
+    it "does not yield the show if it is inactive" do
+      coordinator = LocalCoordinator.new("us", active: false)
+      show_coord = ShowCoordinator.new(coordinator)
+      show_coord.on_show(blocking: false) do |show|
+        raise "bad"
+      end
+    end
+  end
+end

spec/hqtrivia_spec.cr

@@ -1,4 +1,19 @@
 require "./spec_helper"
 
 describe HqTrivia do
+  it "yields active shows" do
+    coordinator = HqTrivia::LocalCoordinator.new("us", active: true)
+
+    HqTrivia.on_show(coordinator) do |show|
+      show.should be_a(HqTrivia::Model::Show)
+    end
+  end
+
+  it "does not yield inactive shows" do
+    coordinator = HqTrivia::LocalCoordinator.new("us", active: false)
+
+    HqTrivia.on_show(coordinator, blocking: false) do |show|
+      raise "should not have yielded"
+    end
+  end
 end

src/hqtrivia.cr

@@ -3,9 +3,23 @@ require "./hqtrivia/*"
 module HqTrivia
   # :nodoc:
   @@LOGGER = Logger.new
+  @@AUTH = Auth.new
 
   # HqTrivia logging instance
   def self.logger
     @@LOGGER
   end
+
+  def self.logger=(logger)
+    @@LOGGER = logger
+  end
+
+  def self.auth
+    @@AUTH
+  end
+
+  def self.on_show(coordinator : Coordinator, blocking = true, &block : Model::Show ->)
+    show_coordinator = ShowCoordinator.new(coordinator)
+    show_coordinator.on_show(blocking, &block)
+  end
 end

src/hqtrivia/auth.cr

@@ -0,0 +1,11 @@
+module HqTrivia
+  class Auth
+    def header(country : String)
+      HTTP::Headers{"Authorization" => "Bearer #{token(country)}"}
+    end
+
+    private def token(country : String)
+      ENV["#{country.upcase}_AUTHORIZATION_TOKEN"]
+    end
+  end
+end

src/hqtrivia/bot.cr

@@ -3,12 +3,11 @@ require "./model/message_types"
 module HqTrivia
   # The HqTrivia bot, given a connection it has call backs for messages received
   module Bot
-    @show : HqTrivia::Model::Show?
+    def initialize(@show : HqTrivia::Model::Show, @coordinator : Coordinator)
+    end
 
-    def play(connection = Connection::Hq.new, blocking = true, record_network = false)
-      connection.on_show do |show|
-        @show = show
-      end
+    def play(connection = HqTrivia::Connection::Hq.new)
+      HqTrivia.logger.debug("Bot playing #{@coordinator.country} show #{@show.to_json}")
 
       connection.on_message do |message|
         handle_message(message)
@@ -18,22 +17,26 @@ module HqTrivia
         handle_message(json)
       end
 
-      connection.connect(blocking, record_network)
+      connection.connect(@show, @coordinator)
     end
 
     # The start time of the current show, nil if no show is going
     def start_time
-      @show.try &.start_time
+      @show.start_time
     end
 
     # The id of the current show, nil if no show is going
     def show_id
-      @show.try &.show_id
+      @show.show_id
     end
 
     # The prize of the current show, nil if no show is going
     def prize
-      @show.try &.prize
+      @show.prize
+    end
+
+    def country
+      @coordinator.country
     end
 
     {% for msg, index in Model::MessageTypes.constant("MESSAGE_LIST") %}

src/hqtrivia/connection/hq.cr

@@ -9,9 +9,6 @@ module HqTrivia
     class Hq
       include Interface
 
-      class HttpException < Exception
-      end
-
       # Yields a `Model::WebSocketMessage`
       def on_message(&block : HqTrivia::Model::WebSocketMessage ->)
         @on_message_callback = block
@@ -21,34 +18,24 @@ module HqTrivia
         @on_raw_message_callback = block
       end
 
-      # Yields a `Model::Show` if a show is active, otherwise nil
-      def on_show(&block : HqTrivia::Model::Show? ->)
-        @on_show = block
-      end
-
       # Connects to the HQ websocket
-      def connect(blocking = true, record_network = false)
-        while show = current_show
-          @on_show.try &.call show
-
-          break if show.active || !blocking
-
-          HqTrivia.logger.debug("No active show")
-          sleep 5
+      def connect(show : Model::Show, coordinator : Coordinator)
+        if coordinator.current_show.active
+          open_socket(show, coordinator)
+        else
+          HqTrivia.logger.info "Not connecting show (#{coordinator.country}) is no longer active"
         end
-
-        open_socket(show, record_network) if show.active
       end
 
-      private def open_socket(show, record_network)
-        HqTrivia.logger.debug("Connecting...")
+      private def open_socket(show, coordinator)
+        HqTrivia.logger.debug("Connecting: #{coordinator.country}")
 
-        socket = HTTP::WebSocket.new(show.socket_url.not_nil!, headers: websocket_headers)
+        socket = HTTP::WebSocket.new(show.socket_url.not_nil!, headers: websocket_headers(coordinator))
 
-        HqTrivia.logger.debug("Connected...")
+        HqTrivia.logger.debug("Connected: #{coordinator.country}")
 
         socket.on_close do
-          connect(false) # don't block, either the game is still active or it is not
+          connect(show, coordinator)
         end
 
         socket.on_message do |json|
@@ -59,43 +46,15 @@ module HqTrivia
         socket.run
       end
 
-      private def current_show
-        connection_failed = ->(ex : Exception) do
-          HqTrivia.logger.debug("Connection to HQ server failed...retrying. #{ex}")
-        end
-
-        retryable(on: HttpException | Socket::Error, tries: 5, wait: 1, callback: connection_failed) do
-          resp = HTTP::Client.get(current_show_url, headers: authorization_header)
-
-          if (200..299).includes?(resp.status_code)
-            Model::Show.from_json(resp.body)
-          else
-            raise HttpException.new("#{resp.body} (#{resp.status_code})")
-          end
-        end
-      end
-
-      private def current_show_url
-        "https://api-quiz.hype.space/shows/now?type=hq"
-      end
-
-      private def authorization_header
-        HTTP::Headers{"Authorization" => "Bearer #{authorization_token}"}
-      end
-
-      private def authorization_token
-        ENV["AUTHORIZATION_TOKEN"]?
-      end
-
-      private def websocket_headers
+      private def websocket_headers(coordinator)
         HTTP::Headers{
           "x-hq-client"     => "iOS/1.2.17",
           "x-hq-stk"        => "MQ==",
           "Host"            => "api-quiz.hype.space",
           "Connection"      => "Keep-Alive",
           "Accept-Encoding" => "gzip",
           "User-Agent"      => "okhttp/3.8.0",
-        }.merge!(authorization_header)
+        }.merge!(HqTrivia.auth.header(coordinator.country))
       end
     end
   end

src/hqtrivia/connection/interface.cr

@@ -1,10 +1,9 @@
 module HqTrivia
   module Connection
     module Interface
-      abstract def on_show(&block : HqTrivia::Model::Show? ->)
       abstract def on_message(&block : HqTrivia::Model::WebSocketMessage ->)
       abstract def on_raw_message(&block : String ->)
-      abstract def connect(async = false, record_network = false)
+      abstract def connect(show : Model::Show, coordinator : Coordinator)
     end
   end
 end

src/hqtrivia/connection/local.cr

@@ -3,7 +3,7 @@ module HqTrivia
     class Local
       include Interface
 
-      def initialize(@raw_messages : Array(String), @show : Model::Show)
+      def initialize(@raw_messages : Array(String))
       end
 
       def on_message(&block : HqTrivia::Model::WebSocketMessage ->)
@@ -14,13 +14,7 @@ module HqTrivia
         @on_raw_message_callback = block
       end
 
-      def on_show(&block : HqTrivia::Model::Show? ->)
-        @on_show = block
-      end
-
-      def connect(blocking = true, record_network = false)
-        @on_show.try &.call @show
-
+      def connect(show : Model::Show, coordinator : Coordinator)
         @raw_messages.each do |msg|
           @on_raw_message_callback.try &.call msg
           @on_message_callback.try &.call Model::RawWebSocketMessage.decode(msg)

src/hqtrivia/model/show.cr

@@ -10,13 +10,16 @@ module HqTrivia
         start_time: {type: Time?, key: "startTime"},
         broadcast:  Broadcast?,
         prize:      Int32?,
+        show_type:  {type: String?, key: "showType"},
       })
 
       def initialize(@active : Bool, @show_id : Int32?, @start_time : Time?,
-                     @prize : Int32)
+                     @prize : Int32, @show_type : String?)
       end
 
       def socket_url
+        raise "Show not active" unless @active
+
         @broadcast.try &.socket_url
       end
     end

src/hqtrivia/show_coordinator.cr

@@ -0,0 +1,24 @@
+require "./show_coordinator/coordinator"
+require "./show_coordinator/*"
+
+module HqTrivia
+  class ShowCoordinator
+    def initialize(@coordinator : Coordinator)
+    end
+
+    def on_show(blocking = true, &block : Model::Show ->)
+      while show = @coordinator.current_show
+        HqTrivia.logger.debug("Show: #{show.to_json}")
+
+        if show.active
+          return yield show
+        elsif !blocking
+          break
+        else
+          HqTrivia.logger.debug("#{self.class.name}: No active '#{@coordinator.country}' show")
+          sleep 5
+        end
+      end
+    end
+  end
+end

src/hqtrivia/show_coordinator/coordinator.cr

@@ -0,0 +1,10 @@
+module HqTrivia
+  abstract class Coordinator
+    getter country
+
+    def initialize(@country : String)
+    end
+
+    abstract def current_show
+  end
+end