ehbrs_ruby_utils 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a241af9b0a27b447cef66e7d719fbda116547b7cfe5ceac348b9bb1bd5662d9
-  data.tar.gz: b02d61f6840f2a602535c24c655bc6a5655a6daa531995a9d78523165517c066
+  metadata.gz: 90c029952b15c0fa9fd3034c5766583e9f8679c8efd16a005304ede77774b1ee
+  data.tar.gz: 8862eaf9b276fd42e92856ea98fa42e38d991c5e3c825ec1e1474ebaaaddefc6
 SHA512:
-  metadata.gz: 54762c964c78d7335f8efc92b19c29b6b7281a37d473e1b3cdd5515177e3e54492808c84481ce075c6a758c3d5d6ccb1fe1ad07ca5d75512600cb026a605697d
-  data.tar.gz: bf4f9ea658f93e2285735d98f22dde951a921f8d7f271b16c5d91c677119ef4c1f6c5f073427b30a4dc7b8dd207fe3bea2b05b00db0af76558b6e21cd246ec60
+  metadata.gz: fbc869e81f0a95f04cf9a393eb4f6f9b1d79e3d77ac3ff9f720b3115722adf41fbe6478e9c7d9878b297c8c46342686ce79a11fceb2f8b5d52c197044724372b
+  data.tar.gz: aab5320864d3863cc32878679ae7ee7cfa84610ed24bd0ade989c60a20a3285fb0a348efeb2aafc7eed71bf824c1ff6ee7dcc2c12467ab5efbd89722f058474f

data/lib/ehbrs_ruby_utils/bga/parsers/game_stats/players.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/html/item_list'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Parsers
+      class GameStats < ::Aranha::Parsers::Html::ItemList
+        class Players < ::Aranha::Parsers::Html::ItemList
+          ITEMS_XPATH = '//div[@class = "simple-score-entry"]'
+
+          field :rank, :integer, './div[@class = "rank"]'
+          field :id, :integer, './div[@class = "name"]/a/@href'
+          field :name, :string, './div[@class = "name"]/a/text()'
+          field :score, :integer, './div[@class = "score"]'
+
+          def items_xpath
+            ITEMS_XPATH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/parsers/game_stats.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/html/item_list'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Parsers
+      class GameStats < ::Aranha::Parsers::Html::ItemList
+        ITEMS_XPATH = '//table[@id = "gamelist_inner"]/tr'
+
+        field :game_name, :string, './td[1]/a[1]/text()'
+        field :table_name, :string, './td[1]/a[2]/text()'
+        field :time_string, :string, './td[2]/div[1]/text()'
+        field :leave_penalty, :integer, './td[4]/span[1]/text()'
+        field :rank_increment, :integer, './td[4]/span[2]/text()'
+        field :rank_after, :integer, './td[4]//*[@class = "gamerank_value"]/text()'
+        field :players, :node, './td[3]'
+
+        def items_xpath
+          ITEMS_XPATH
+        end
+
+        def item_data(item)
+          r = super
+          r[:table_id] = table_name_to_id(r.delete(:table_name))
+          r[:players] = players_data(r.delete(:players))
+          r
+        end
+
+        private
+
+        def players_data(players_node)
+          ::EhbrsRubyUtils::Bga::Parsers::GameStats::Players.from_node(
+            players_node
+          ).data
+        end
+
+        def table_name_to_id(name)
+          name.gsub(/\A\#/, '')
+        end
+
+        require_sub __FILE__
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/parsers/table/options.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/html/item'
+require 'aranha/parsers/html/item_list'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Parsers
+      class Table < ::Aranha::Parsers::Html::Item
+        class Options < ::Aranha::Parsers::Html::ItemList
+          ITEMS_XPATH = '//div[starts-with(@id, "gameoption_")' \
+            ' and not(contains(@style, "none"))]'
+
+          field :label, :string, './div[@class = "row-label"]/text()'
+          field :value, :string, './div[@class = "row-value"]' \
+            "//*[#{xpath_ends_with('@id', "'_displayed_value'")}]/text()"
+          field :description, :string, './div[@class = "gameoption_description"]/text()'
+
+          def items_xpath
+            ITEMS_XPATH
+          end
+
+          def data
+            super.reject { |item| item.fetch(:label).blank? }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/parsers/table/players.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/html/item'
+require 'aranha/parsers/html/item_list'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Parsers
+      class Table < ::Aranha::Parsers::Html::Item
+        class Players < ::Aranha::Parsers::Html::ItemList
+          ITEMS_XPATH = '//div[starts-with(@id, "score_entry_")]'
+
+          field :table_rank, :integer, './div[@class = "rank"]'
+          field :id, :integer, './div[@class = "name"]/a/@href'
+          field :name, :string, './div[@class = "name"]/a/text()'
+          field :score, :integer, './div[@class = "score"]'
+          field :win_points, :string, './/*[starts-with(@id, "winpoints_value_")]/text()'
+          field :game_rank, :integer, './/*[@class = "gamerank_value"]/text()'
+
+          def items_xpath
+            ITEMS_XPATH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/parsers/table.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/html/item'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Parsers
+      class Table < ::Aranha::Parsers::Html::Item
+        ITEM_XPATH = '/'
+
+        field :game_name, :string, './/*[@id = "table_name"]/text()'
+        field :creation_time, :string, './/*[@id = "creationtime"]/text()'
+        field :estimated_duration, :string, './/*[@id = "estimated_duration"]/text()'
+        field :options, :node, './/*[@id = "gameoptions"]'
+        field :players, :node, './/*[@id = "game_result"]'
+
+        def item_xpath
+          ITEM_XPATH
+        end
+
+        def data
+          r = super
+          %i[options players].each do |key|
+            r[key] = self.class.const_get(key.to_s.camelize).from_node(r.fetch(key)).data
+          end
+          r[:creation_time] = process_creation_time(r[:creation_time])
+          r
+        end
+
+        private
+
+        def process_creation_time(creation_time)
+          creation_time.gsub('Criado:', '').strip
+        end
+
+        require_sub __FILE__
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/session/login.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Session < ::SimpleDelegator
+      module Login
+        LOGIN_PATH = 'account'
+        USERNAME_INPUT_ID = 'username_input'
+        PASSWORD_INPUT_ID = 'password_input'
+        SUBMIT_ID = 'login_button'
+        LOGGED_MESSAGE_PATTERNS = [
+          /Page not found/ # Page not found: join.js
+        ].freeze
+        UNLOGGED_MESSAGE_PATTERSN = [
+          /Recover my password/ # Oops, we don't recognize your username or password. Don't panic.
+          # (Recover my password)
+        ].freeze
+
+        # @return [Boolean]
+        def login
+          navigate_to_login_page
+          input_username
+          input_password
+          submit_login
+          logged_by_message?(message_info)
+        end
+
+        def login_url
+          build_url(LOGIN_PATH)
+        end
+
+        private
+
+        def navigate_to_login_page
+          navigate.to(login_url)
+        end
+
+        def input_username
+          wait_for_element(id: USERNAME_INPUT_ID).send_keys(username)
+        end
+
+        def input_password
+          wait_for_element(id: PASSWORD_INPUT_ID).send_keys(password)
+        end
+
+        def submit_login
+          wait_for_click(id: SUBMIT_ID)
+        end
+
+        # @return [Boolean]
+        def logged_by_message?(message_info)
+          return true if LOGGED_MESSAGE_PATTERNS.any? { |p| p.match?(message_info) }
+          return false if UNLOGGED_MESSAGE_PATTERNS.any? { |p| p.match?(message_info) }
+
+          raise("Unmapped login message: \"#{message_info}\"")
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/session/player.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/game_stats'
+require 'ehbrs_ruby_utils/bga/urls'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Session < ::SimpleDelegator
+      class Player
+        include ::EhbrsRubyUtils::Bga::Urls
+        GAME_HISTORY_XPATH = '//h3[text() = "Games history"]'
+        common_constructor :session, :player_id
+
+        def tables
+          session.navigate.to game_stats_url
+          session.wait_for_element(xpath: GAME_HISTORY_XPATH)
+          ::EhbrsRubyUtils::Bga::Parsers::GameStats.from_content(session.current_source).data
+        end
+
+        # @return [Addressable::URI]
+        def game_stats_url
+          session.url("/gamestats?player=#{player_id}")
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/session/table.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/table'
+require 'ehbrs_ruby_utils/bga/table'
+require 'ehbrs_ruby_utils/bga/urls'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Session < ::SimpleDelegator
+      class Table
+        include ::EhbrsRubyUtils::Bga::Urls
+        enable_method_class
+        enable_simple_cache
+        common_constructor :session, :table_id
+
+        def result
+          ::EhbrsRubyUtils::Bga::Table.new(
+            fetch_data
+          )
+        end
+
+        # @return [Addressable::URI]
+        def url
+          table_url(table_id)
+        end
+
+        private
+
+        def fetch_data
+          session.navigate.to url
+          { id: table_id }.merge(
+            ::EhbrsRubyUtils::Bga::Parsers::Table.from_content(session.current_source).data
+          )
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/session.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'aranha/selenium/session'
+require 'eac_ruby_utils/core_ext'
+require 'ehbrs_ruby_utils/bga/urls'
+
+module EhbrsRubyUtils
+  module Bga
+    class Session < ::SimpleDelegator
+      include ::EhbrsRubyUtils::Bga::Urls
+      MESSAGE_ID = 'head_infomsg_1'
+
+      common_constructor :username, :password, super_args: -> { [::Aranha::Selenium::Session.new] }
+
+      # @return [String]
+      def message_info
+        wait_for_click(id: MESSAGE_ID).text
+      end
+
+      # @return [EhbrsRubyUtils::Bga::Session::Player]
+      def player(id)
+        ::EhbrsRubyUtils::Bga::Session::Player.new(self, id)
+      end
+
+      require_sub __FILE__, include_modules: true, require_mode: :kernel
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/table/option.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/table/options'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Table
+      class Option
+        common_constructor :table, :data
+
+        ::EhbrsRubyUtils::Bga::Parsers::Table::Options.fields.each do |field|
+          define_method field.name do
+            data.fetch(field.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/table/player.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/table/players'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Table
+      class Player
+        common_constructor :table, :data
+
+        ::EhbrsRubyUtils::Bga::Parsers::Table::Players.fields.each do |field|
+          define_method field.name do
+            data.fetch(field.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/table.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/table/options'
+require 'ehbrs_ruby_utils/bga/urls'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    class Table
+      include ::EhbrsRubyUtils::Bga::Urls
+      enable_simple_cache
+      common_constructor :data
+
+      SET_ITEMS = %i[options players].freeze
+
+      ([:id] + ::EhbrsRubyUtils::Bga::Parsers::Table.fields.map(&:name) - SET_ITEMS)
+        .each do |field|
+        define_method field do
+          data.fetch(field)
+        end
+      end
+
+      # @return [Addressable::URI]
+      def url
+        table_url(id)
+      end
+
+      private
+
+      SET_ITEMS.each do |item|
+        define_method "#{item}_uncached" do
+          data.fetch(item).map do |item_data|
+            self.class.const_get(item.to_s.singularize.camelize).new(self, item_data)
+          end
+        end
+      end
+
+      require_sub __FILE__
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/bga/urls.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'aranha/selenium/session'
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Bga
+    module Urls
+      common_concern
+
+      module InstanceMethods
+        ROOT_URL = 'https://en.boardgamearena.com'
+
+        # @param suffix [String]
+        # @return [Addressable::URI]
+        def build_url(suffix)
+          root_url + suffix
+        end
+
+        # @return [Addressable::URI]
+        def root_url
+          ROOT_URL.to_uri
+        end
+
+        # @return [Addressable::URI]
+        def table_url(table_id)
+          build_url("/table?table=#{table_id}")
+        end
+      end
+
+      extend InstanceMethods
+    end
+  end
+end

data/lib/ehbrs_ruby_utils/executables.rb

@@ -23,6 +23,11 @@ module EhbrsRubyUtils
           end
         end
       end
+
+      # @return [EacRubyUtils::Envs::Executable]
+      def mudslide_uncached
+        env.executable('mudslide', exec_args: %w[npx mudslide@latest], check_args: %w[--version])
+      end
     end
   end
 end

data/lib/ehbrs_ruby_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EhbrsRubyUtils
-  VERSION = '0.22.0'
+  VERSION = '0.23.0'
 end

data/spec/lib/ehbrs_ruby_utils/bga/parsers/game_stats_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/bga/parsers/game_stats'
+
+::RSpec.describe ::EhbrsRubyUtils::Bga::Parsers::GameStats do
+  include_examples 'source_target_fixtures', __FILE__
+end