Bump version

Gemfile.lock

@@ -1,14 +1,14 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
+    base64 (0.3.0)
     concurrent-ruby (1.3.5)
     cyberarm_engine (0.24.4)
       gosu (~> 1.1)
     digest-crc (0.7.0)
       rake (>= 12.0.0, < 14.0.0)
     event_emitter (0.2.6)
-    excon (1.2.5)
+    excon (1.2.7)
       logger
     ffi (1.17.2-x64-mingw-ucrt)
     ffi (1.17.2-x86_64-linux-gnu)
@@ -21,7 +21,7 @@ GEM
     libui (0.1.2-x64-mingw)
     logger (1.7.0)
     mutex_m (0.3.0)
-    rake (13.2.1)
+    rake (13.3.0)
     rexml (3.4.1)
     rubyzip (2.4.1)
     sdl2-bindings (0.2.3)
@@ -58,4 +58,4 @@ DEPENDENCIES
   win32-security
 
 BUNDLED WITH
-   2.4.3
+   2.6.7

lib/api.rb

@@ -41,12 +41,26 @@ class W3DHub
     end
 
     #! === W3D Hub API === !#
+    W3DHUB_API_ENDPOINT = "https://secure.w3dhub.com".freeze # "https://example.com" # "http://127.0.0.1:9292".freeze #
+    W3DHUB_API_CONNECTION = Excon.new(W3DHUB_API_ENDPOINT, persistent: true)
 
-    ENDPOINT = "https://w3dhub-api.w3d.cyberarm.dev" # "https://secure.w3dhub.com".freeze # "https://example.com" # "http://127.0.0.1:9292".freeze #
+    ALT_W3DHUB_API_ENDPOINT = "https://w3dhub-api.w3d.cyberarm.dev".freeze # "https://secure.w3dhub.com".freeze # "https://example.com" # "http://127.0.0.1:9292".freeze #
-    API_CONNECTION = Excon.new(ENDPOINT, persistent: true)
+    ALT_W3DHUB_API_API_CONNECTION = Excon.new(ALT_W3DHUB_API_ENDPOINT, persistent: true)
 
-    def self.excon(method, url, headers = DEFAULT_HEADERS, body = nil, api = :api)
+    def self.excon(method, url, headers = DEFAULT_HEADERS, body = nil, backend = :w3dhub)
-      logger.debug(LOG_TAG) { "Fetching #{method.to_s.upcase} \"#{url}\"..." }
+      case backend
+      when :w3dhub
+        connection = W3DHUB_API_CONNECTION
+        endpoint   = W3DHUB_API_ENDPOINT
+      when :alt_w3dhub
+        connection = ALT_W3DHUB_API_API_CONNECTION
+        endpoint   = ALT_W3DHUB_API_ENDPOINT
+      when :gsh
+        connection = GSH_CONNECTION
+        endpoint   = SERVER_LIST_ENDPOINT
+      end
+
+      logger.debug(LOG_TAG) { "Fetching #{method.to_s.upcase} \"#{endpoint}#{url}\"..." }
 
       # Inject Authorization header if account data is populated
       if Store.account
@@ -55,9 +69,6 @@ class W3DHub
         headers["Authorization"] = "Bearer #{Store.account.access_token}"
       end
 
-      connection = api == :api ? API_CONNECTION : GSH_CONNECTION
-      endpoint = api == :api ? ENDPOINT : SERVER_LIST_ENDPOINT
-
       begin
         connection.send(
           method,
@@ -86,8 +97,48 @@ class W3DHub
       end
     end
 
-    def self.post(url, headers = DEFAULT_HEADERS, body = nil, api = :api)
+    def self.post(url, headers = DEFAULT_HEADERS, body = nil, backend = :w3dhub)
-      excon(:post, url, headers, body, api)
+      excon(:post, url, headers, body, backend)
+    end
+
+    def self.get(url, headers = DEFAULT_HEADERS, body = nil, backend = :w3dhub)
+      excon(:get, url, headers, body, backend)
+    end
+
+    # Api.get but handles any URL instead of known hosts
+    def self.fetch(url, headers = DEFAULT_HEADERS, body = nil, backend = nil)
+      uri = URI(url)
+
+      # Use Api.get for `W3DHUB_API_ENDPOINT` URL's to exploit keep alive and connection reuse (faster responses)
+      return excon(:get, url, headers, body, backend) if "#{uri.scheme}://#{uri.host}" == W3DHUB_API_ENDPOINT
+
+      logger.debug(LOG_TAG) { "Fetching GET \"#{url}\"..." }
+
+      begin
+        Excon.get(
+          url,
+          headers: headers,
+          body: body,
+          nonblock: true,
+          tcp_nodelay: true,
+          write_timeout: API_TIMEOUT,
+          read_timeout: API_TIMEOUT,
+          connect_timeout: API_TIMEOUT,
+          idempotent: true,
+          retry_limit: 3,
+          retry_interval: 1,
+          retry_errors: [Excon::Error::Socket, Excon::Error::HTTPStatus] # Don't retry on timeout
+        )
+      rescue Excon::Errors::Timeout => e
+        logger.error(LOG_TAG) { "Connection to \"#{url}\" timed out after: #{API_TIMEOUT} seconds" }
+
+        DummyResponse.new(e)
+      rescue Excon::Error => e
+        logger.error(LOG_TAG) { "Connection to \"#{url}\" errored:" }
+        logger.error(LOG_TAG) { e }
+
+        DummyResponse.new(e)
+      end
     end
 
     # Method: POST
@@ -105,24 +156,16 @@ class W3DHub
     #
     # On a failed login the service responds with:
     # {"error":"login-failed"}
-    def self.refresh_user_login(refresh_token)
+    def self.refresh_user_login(refresh_token, backend = :w3dhub)
       body = "data=#{JSON.dump({refreshToken: refresh_token})}"
-      response = post("#{ENDPOINT}/apis/launcher/1/user-login", FORM_ENCODED_HEADERS, body)
+      response = post("/apis/launcher/1/user-login", FORM_ENCODED_HEADERS, body, backend)
 
       if response.status == 200
         user_data = JSON.parse(response.body, symbolize_names: true)
 
         return false if user_data[:error]
 
-        body = "data=#{JSON.dump({ id: user_data[:userid] })}"
+        user_details_data = user_details(user_data[:userid]) || {}
-        user_details = post("#{ENDPOINT}/apis/w3dhub/1/get-user-details", FORM_ENCODED_HEADERS, body)
-
-        if user_details.status == 200
-          user_details_data = JSON.parse(user_details.body, symbolize_names: true)
-        else
-          logger.error(LOG_TAG) { "Failed to fetch refresh user details:" }
-          logger.error(LOG_TAG) { user_details }
-        end
 
         Account.new(user_data, user_details_data)
       else
@@ -133,24 +176,16 @@ class W3DHub
     end
 
     # See #user_refresh_token
-    def self.user_login(username, password)
+    def self.user_login(username, password, backend = :w3dhub)
       body = "data=#{JSON.dump({username: username, password: password})}"
-      response = post("#{ENDPOINT}/apis/launcher/1/user-login", FORM_ENCODED_HEADERS, body)
+      response = post("/apis/launcher/1/user-login", FORM_ENCODED_HEADERS, body, backend)
 
       if response.status == 200
         user_data = JSON.parse(response.body, symbolize_names: true)
 
         return false if user_data[:error]
 
-        body = "data=#{JSON.dump({ id: user_data[:userid] })}"
+        user_details_data = user_details(user_data[:userid]) || {}
-        user_details = post("#{ENDPOINT}/apis/w3dhub/1/get-user-details", FORM_ENCODED_HEADERS, body)
-
-        if user_details.status == 200
-          user_details_data = JSON.parse(user_details.body, symbolize_names: true)
-        else
-          logger.error(LOG_TAG) { "Failed to fetch user details:" }
-          logger.error(LOG_TAG) { user_details }
-        end
 
         Account.new(user_data, user_details_data)
       else
@@ -160,18 +195,27 @@ class W3DHub
       end
     end
 
-    # /apis/launcher/1/user-login
+    # /apis/w3dhub/1/get-user-details
-    # Client sends an Authorization header bearer token which is received from logging in (Required?)
     #
     # Response: avatar-uri (Image download uri), id, username
-    def self.user_details(id)
+    def self.user_details(id, backend = :w3dhub)
+      body = "data=#{JSON.dump({ id: id })}"
+      user_details = post("/apis/w3dhub/1/get-user-details", FORM_ENCODED_HEADERS, body, backend)
+
+      if user_details.status == 200
+        JSON.parse(user_details.body, symbolize_names: true)
+      else
+        logger.error(LOG_TAG) { "Failed to fetch user details:" }
+        logger.error(LOG_TAG) { user_details }
+        false
+      end
     end
 
     # /apis/w3dhub/1/get-service-status
     # Service response:
     # {"services":{"authentication":true,"packageDownload":true}}
-    def self.service_status
+    def self.service_status(backend = :w3dhub)
-      response = post("#{ENDPOINT}/apis/w3dhub/1/get-service-status", DEFAULT_HEADERS)
+      response = post("/apis/w3dhub/1/get-service-status", DEFAULT_HEADERS, nil, backend)
 
       if response.status == 200
         ServiceStatus.new(response.body)
@@ -186,8 +230,8 @@ class W3DHub
     # Client sends an Authorization header bearer token which is received from logging in (Optional)
     # Launcher sends an empty data request: data={}
     # Response is a list of applications/games
-    def self.applications
+    def self.applications(backend = :w3dhub)
-      response = post("#{ENDPOINT}/apis/launcher/1/get-applications")
+      response = post("/apis/launcher/1/get-applications", DEFAULT_HEADERS, nil, backend)
 
       if response.status == 200
         Applications.new(response.body)
@@ -198,13 +242,82 @@ class W3DHub
       end
     end
 
+    # Populate applications list from primary and alternate backends
+    # (alternate only has latest public builds of _most_ games)
+    def self._applications
+      applications_primary = Store.account ? Api.applications(:w3dhub) : false
+      applications_alternate = Api.applications(:alt_w3dhub)
+
+      # Fail if we fail to fetch applications list from either backend
+      return false unless applications_primary || applications_alternate
+
+      return applications_alternate unless applications_primary
+
+      # Merge the two app lists together
+      apps = applications_alternate
+      if applications_primary
+        applications_primary.games.each do |game|
+          # Check if game exists in alternate list
+          _game = apps.games.find { |g| g.id == game.id }
+          unless _game
+            apps.games << game
+
+            # App didn't exist in alternates list
+            # comparing channels isn't useful
+            next
+          end
+
+          # If it does, check that all of its channels also exist in alternate list
+          # and that the primary versions are the same as the alternates list
+          game.channels.each do |channel|
+            _channel = _game.channels.find { |c| c.id == channel.id }
+
+            unless _channel
+              _game.channels << channel
+
+              # App didn't have channel in alternates list
+              # comparing channel isn't useful
+              next
+            end
+
+            # If channel versions and access levels match then all's well
+            if channel.current_version == _channel.current_version && 
+              channel.user_level == _channel.user_level
+
+              # All's Well!
+              next
+            end
+
+            # If the access levels doen't match then overwrite alternate's channel with primary's channel
+            if channel.user_level != _channel.user_level
+              # Replace alternate's channel with primary's channel
+              _game.channels[_game.channels.index(_channel)] = channel
+
+              # Replaced, continue.
+              next
+            end
+            
+            # If versions doen't match then pick whichever one is higher
+            if Gem::Version.new(channel.current_version) > Gem::Version.new(_channel.current_version)
+              # Replace alternate's channel with primary's channel
+              _game.channels[_game.channels.index(_channel)] = channel
+            else
+              # Do nothing, alternate backend version is greater.
+            end
+          end
+        end
+      end
+
+      apps
+    end
+
     # /apis/w3dhub/1/get-news
     # Client sends an Authorization header bearer token which is received from logging in (Optional)
     # Client requests news for a specific application/game e.g.: data={"category":"ia"} ("launcher-home" retrieves the weekly hub updates)
     # Response is a JSON hash with a "highlighted" and "news" keys; the "news" one seems to be the desired one
-    def self.news(category)
+    def self.news(category, backend = :w3dhub)
       body = "data=#{JSON.dump({category: category})}"
-      response = post("#{ENDPOINT}/apis/w3dhub/1/get-news", FORM_ENCODED_HEADERS, body)
+      response = post("/apis/w3dhub/1/get-news", FORM_ENCODED_HEADERS, body, backend)
 
       if response.status == 200
         News.new(response.body)
@@ -220,9 +333,9 @@ class W3DHub
 
     # /apis/launcher/1/get-package-details
     # client requests package details: data={"packages":[{"category":"games","name":"apb.ico","subcategory":"apb","version":""}]}
-    def self.package_details(packages)
+    def self.package_details(packages, backend = :w3dhub)
       body = URI.encode_www_form("data": JSON.dump({ packages: packages }))
-      response = post("#{ENDPOINT}/apis/launcher/1/get-package-details", FORM_ENCODED_HEADERS, body)
+      response = post("/apis/launcher/1/get-package-details", FORM_ENCODED_HEADERS, body, backend)
 
       if response.status == 200
         hash = JSON.parse(response.body, symbolize_names: true)
@@ -247,9 +360,9 @@ class W3DHub
     # /apis/w3dhub/1/get-events
     #
     # clients requests events: data={"serverPath":"apb"}
-    def self.events(app_id)
+    def self.events(app_id, backend = :w3dhub)
       body = URI.encode_www_form("data": JSON.dump({ serverPath: app_id }))
-      response = post("#{ENDPOINT}/apis/w3dhub/1/get-server-events", FORM_ENCODED_HEADERS, body)
+      response = post("/apis/w3dhub/1/get-server-events", FORM_ENCODED_HEADERS, body, backend)
 
       if response.status == 200
         array = JSON.parse(response.body, symbolize_names: true)
@@ -266,10 +379,6 @@ class W3DHub
     # SERVER_LIST_ENDPOINT = "http://127.0.0.1:9292".freeze
     GSH_CONNECTION = Excon.new(SERVER_LIST_ENDPOINT, persistent: true)
 
-    def self.get(url, headers = DEFAULT_HEADERS, body = nil, api = :api)
-      excon(:get, url, headers, body, api)
-    end
-
     # Method: GET
     # FORMAT: JSON
 
@@ -287,8 +396,8 @@ class W3DHub
     #     id, name, score, kills, deaths
     #   ...players[]:
     #     nick, team (index of teams array), score, kills, deaths
-    def self.server_list(level = 1)
+    def self.server_list(level = 1, backend = :gsh)
-      response = get("#{SERVER_LIST_ENDPOINT}/listings/getAll/v2?statusLevel=#{level}", DEFAULT_HEADERS, nil, :gsh)
+      response = get("/listings/getAll/v2?statusLevel=#{level}", DEFAULT_HEADERS, nil, backend)
 
       if response.status == 200
         data = JSON.parse(response.body, symbolize_names: true)
@@ -309,10 +418,10 @@ class W3DHub
     #     id, name, score, kills, deaths
     #   ...players[]:
     #     nick, team (index of teams array), score, kills, deaths
-    def self.server_details(id, level)
+    def self.server_details(id, level, backend = :gsh)
       return false unless id && level
 
-      response = get("#{SERVER_LIST_ENDPOINT}/listings/getStatus/v2/#{id}?statusLevel=#{level}", DEFAULT_HEADERS, nil, :gsh)
+      response = get("/listings/getStatus/v2/#{id}?statusLevel=#{level}", DEFAULT_HEADERS, nil, backend)
 
       if response.status == 200
         hash = JSON.parse(response.body, symbolize_names: true)

lib/api/server_list_updater.rb

@@ -48,7 +48,7 @@ class W3DHub
         @auto_reconnect = false
 
         logger.debug(LOG_TAG) { "Requesting connection token..." }
-        response = Api.post("#{Api::SERVER_LIST_ENDPOINT}/listings/push/v2/negotiate?negotiateVersion=1", Api::DEFAULT_HEADERS, "", :gsh)
+        response = Api.post("/listings/push/v2/negotiate?negotiateVersion=1", Api::DEFAULT_HEADERS, "", :gsh)
 
         if response.status != 200
           @auto_reconnect = true

lib/cache.rb

@@ -9,18 +9,18 @@ class W3DHub
     end
 
     # Fetch a generic uri
-    def self.fetch(uri:, force_fetch: false, async: true)
+    def self.fetch(uri:, force_fetch: false, async: true, backend: :w3dhub)
       path = path(uri)
 
       if !force_fetch && File.exist?(path)
         path
       elsif async
         BackgroundWorker.job(
-          -> { Api.get(uri, W3DHub::Api::DEFAULT_HEADERS) },
+          -> { Api.fetch(uri, W3DHub::Api::DEFAULT_HEADERS, nil, backend) },
           ->(response) { File.open(path, "wb") { |f| f.write response.body } if response.status == 200 }
         )
       else
-        response = Api.get(uri, W3DHub::Api::DEFAULT_HEADERS)
+        response = Api.fetch(uri, W3DHub::Api::DEFAULT_HEADERS, nil, backend)
         File.open(path, "wb") { |f| f.write response.body } if response.status == 200
       end
     end
@@ -69,7 +69,7 @@ class W3DHub
 
       body = "data=#{JSON.dump({ category: package.category, subcategory: package.subcategory, name: package.name, version: package.version })}"
 
-      response = Api.post("#{Api::ENDPOINT}/apis/launcher/1/get-package", headers, body)
+      response = Api.post("/apis/launcher/1/get-package", headers, body)
 
       total_bytes = package.size
       remaining_bytes = total_bytes - start_from_bytes
@@ -89,7 +89,7 @@ class W3DHub
 
     # Download a W3D Hub package
     def self.fetch_package(package, block)
-      endpoint_download_url = package.download_url || "#{Api::ENDPOINT}/apis/launcher/1/get-package"
+      endpoint_download_url = package.download_url || "#{Api::W3DHUB_API_ENDPOINT}/apis/launcher/1/get-package"
       path = package_path(package.category, package.subcategory, package.name, package.version)
       headers = { "Content-Type": "application/x-www-form-urlencoded", "User-Agent": Api::USER_AGENT }
       headers["Authorization"] = "Bearer #{Store.account.access_token}" if Store.account && !package.download_url

lib/pages/community.rb

@@ -111,7 +111,7 @@ class W3DHub
         return unless news
 
         news.items[0..15].each do |item|
-          Cache.fetch(uri: item.image, async: false)
+          Cache.fetch(uri: item.image, async: false, backend: :w3dhub)
         end
 
         @w3dhub_news = news

lib/pages/games.rb

@@ -425,7 +425,7 @@ class W3DHub
         return false unless news
 
         news.items[0..15].each do |item|
-          Cache.fetch(uri: item.image, async: false)
+          Cache.fetch(uri: item.image, async: false, backend: :w3dhub)
         end
 
         @game_news[game.id] = news

lib/pages/login.rb

@@ -44,8 +44,10 @@ class W3DHub
                         Store.settings[:account][:data] = account
                         Store.settings.save_settings
 
-                        Cache.fetch(uri: account.avatar_uri, force_fetch: true, async: false) if account
+                        if account
-                        applications = Api.applications if account
+                          Cache.fetch(uri: account.avatar_uri, force_fetch: true, async: false, backend: :w3dhub)
+                          applications = Api._applications
+                        end
                       end
 
                       [account, applications]
@@ -79,7 +81,7 @@ class W3DHub
 
         if Store.account
           BackgroundWorker.foreground_job(
-            -> { Cache.fetch(uri: Store.account.avatar_uri, async: false) },
+            -> { Cache.fetch(uri: Store.account.avatar_uri, async: false, backend: :w3dhub) },
             ->(result) {
               populate_account_info
               page(W3DHub::Pages::Games)
@@ -152,7 +154,7 @@ class W3DHub
         Store.account = nil
 
         BackgroundWorker.foreground_job(
-          -> { Api.applications },
+          -> { Api._applications },
           lambda do |applications|
             if applications
               Store.applications = applications

lib/states/boot.rb

@@ -127,7 +127,7 @@ class W3DHub
 
           Store.settings[:account][:data] = account
 
-          Cache.fetch(uri: account.avatar_uri, force_fetch: true, async: false)
+          Cache.fetch(uri: account.avatar_uri, force_fetch: true, async: false, backend: :w3dhub)
         else
           Store.settings[:account] = {}
         end
@@ -162,7 +162,7 @@ class W3DHub
       def applications
         @status_label.value = I18n.t(:"boot.checking_for_updates")
 
-        Api.on_thread(:applications) do |applications|
+        Api.on_thread(:_applications) do |applications|
           if applications
             Store.applications = applications
             Store.settings.save_application_cache(applications.data.to_json)
@@ -185,7 +185,7 @@ class W3DHub
           packages << { category: app.category, subcategory: app.id, name: "#{app.id}.ico", version: "" }
         end
 
-        Api.on_thread(:package_details, packages) do |package_details|
+        Api.on_thread(:package_details, packages, :alt_w3dhub) do |package_details|
           package_details ||= nil
 
           package_details&.each do |package|

lib/states/interface.rb

@@ -138,7 +138,7 @@ class W3DHub
         if Gosu.milliseconds >= @applications_expire
           @applications_expire = Gosu.milliseconds + 30_000
 
-          Api.on_thread(:applications) do |applications|
+          Api.on_thread(:_applications) do |applications|
             if applications
               @applications_expire = Gosu.milliseconds + APPLICATIONS_UPDATE_INTERVAL # ten minutes
 

lib/version.rb

@@ -1,4 +1,4 @@
 class W3DHub
   DIR_NAME = "W3DHubAlt"
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end