squash_matrix 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7f3c73a85e406636213cedf77e71fbce5d4c76c7
-  data.tar.gz: 24f57ca32dcb19c25d4effa0b248279770c42ea5
+SHA256:
+  metadata.gz: 88789ae3eee0e457e795db28cc4243a48567d325e9e89e206bad10fb35db0bab
+  data.tar.gz: 9164726d86ae99d833080ecacf7c0ce0ddb948af81cd29ad985a99790741bcaa
 SHA512:
-  metadata.gz: 24be0f0f3c6cbd4df937c61861a0990666a16812ee84bfbd51564db31bbaa28f4daa0cc8b60edf935a85a680e39adc04642298ec6162dd547cc31fcf60692b65
-  data.tar.gz: 73dd1e9747fb354bdc84344099c6a87bbe7b23f27222a7768b89b0a72629616fae6b150a9fde531f55438d7b74fa49d84b14fc050ef7b87ce8b8b12599182c4d
+  metadata.gz: 1c6699aaa0333a24a262f53990e2dabe0a4058e990b7a386f4c5e6ed2dd7a749582afb24fc38cb15775349342bf8b62e1255985f7904a25080dc0bab5843d27b
+  data.tar.gz: '09153a6dc3e3ff96f0afaa4ff6ae522caff6af637f6871cda0724997481bbb8a9dc8f09fbae76ef66846af302e36c7a058c099895206aa1c9024b3d99b546238'

data/.gitignore

@@ -9,3 +9,5 @@
 **/*.gem
 # rspec failure tracking
 .rspec_status
+# Rubocop
+**/*.rubocop.yml

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    squash_matrix (0.1.1)
+    squash_matrix (1.0.0)
       http-cookie (~> 1.0, >= 1.0.3)
       nokogiri (~> 1.8, >= 1.8.4)
       user-agent-randomizer (~> 0.2)
@@ -54,4 +54,4 @@ DEPENDENCIES
   squash_matrix!
 
 BUNDLED WITH
-   1.16.2
+   1.16.4

data/README.md

@@ -21,9 +21,9 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-client = SquashMatrix::Client.new # initialize client
+client = SquashMatrix::Client.new(player: 42547, password: "foo")# initialize client
 => SquashMatrix::Client
-client.player_info(42547) # retrieve player results for joshua wilkosz #42547
+client.get_player_info(42547) # retrieve player info for joshua wilkosz #42547
 => {
   :rating=>"250.202",
   :clubs=>[
@@ -39,7 +39,7 @@ client.player_info(42547) # retrieve player results for joshua wilkosz #42547
     }
   ]
 }
-client.player_results(42547) # retrieve player results for joshua wilkosz #42547
+client.get_player_results(42547) # retrieve player results for joshua wilkosz #42547
 => [
   {
     :event=>"2017 Melbourne Autumn  State Open Pennant",
@@ -57,7 +57,7 @@ client.player_results(42547) # retrieve player results for joshua wilkosz #42547
     :match_id=>1003302
   }
 ]
-client.club_info(336) # retrieve club info for melbourne university #336
+client.get_club_info(336) # retrieve club info for melbourne university #336
 => {
   :name=>"Melbourne University Squash Club",
   :players=>[
@@ -77,7 +77,7 @@ client.club_info(336) # retrieve club info for melbourne university #336
     }
   ]
 }
-client.search("joshua") # search for 'joshua'
+client.get_search_results("joshua") # search results for 'joshua'
 => {
   :players=>[
     {
@@ -97,7 +97,7 @@ client.search("joshua") # search for 'joshua'
   ],
   :clubs=>[]
 }
-client.search("melbourne") # search for 'melbourne'
+client.get_search_results("melbourne") # search results for 'melbourne'
 => {
   :players=>[
     {
@@ -123,7 +123,20 @@ client.search("melbourne") # search for 'melbourne'
     }
   ]
 }
+# saving authentication state or using multiple clients
+p = client.get_save_params
+p => {
+  :player=>42547,
+  :password=>"Foo",
+  :suppress_errors=>false,  
+  :user_agent=>"Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.13) Gecko/20101213 Opera/9.80 (Windows NT 6.1; U; zh-tw) Presto/2.7.62 Version/11.01",
+  :cookie=>".ASPXAUTH=CDA48BC54FCEB4F164D6AC464EFB3414866040FF085915F32BA18EFD5CF995DC59889B5E2124567CBE1B53DE66D6318E6510C5B884EAB5216457092AC079999C3E63BDDA45C94CCA1CD82E485A30D698BA426F4AA9C94301125966DB5D05FD4D; ASP.NET_SessionId=tx02u3xp51js1s3mgwwxhgq1; GroupId=0",
+  :expires=>"2018-08-25 17:05:04 UTC"
+}
+replica_client = SquashMatrix::Client.new(p)
+=> SquashMatrix::Client
 ```
+*Note: in previous example `client` and `replica_client` authentication will expire at `2018-08-25 17:05:04 UTC` and make separate calls for re-authentication and thereafter will have separate instance states*
 
 ## Development
 
@@ -135,7 +148,7 @@ To run tests, run `bundle exec rspec`
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/wilkosz/squash_matrix. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/wilkosz/squash_matrix>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/squash_matrix/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'date'
 require 'timeout'
@@ -8,30 +10,57 @@ require_relative 'nokogiri-parser'
 require_relative 'errors'
 
 module SquashMatrix
-
   # Client for retrieving player and club information from squashmatrix.com.
   # If authentication credentials are provided squash matrix will allow
   # considerably more requests for an IP address and allow forbidden conent
   # to be requested.
 
   class Client
+    # Returns params to create existing authenticated client
+    # @return [Hash]
+
+    def get_save_params
+      {
+        player: @player,
+        email: @email,
+        password: @password,
+        suppress_errors: @suppress_errors,
+        timeout: @timeout,
+        user_agent: @user_agent,
+        cookie: get_cookie_string,
+        expires: @expires.to_s
+      }.delete_if { |_k, v| v.nil? }
+    end
 
     # Returns newly created Client
     # @note If suppress_errors == false SquashMatrix::Errors::AuthorizationError will be raised if specified credentials are incorrect and squash matrix authentication returns forbidden
     # @param [Hash] opts the options to create client
     # @return [Client]
 
-    def initialize(player: nil, email: nil, password: nil, suppress_errors: false, timeout: 60)
-      @user_agent =  UserAgentRandomizer::UserAgent.fetch(type: "desktop_browser").string
-      @squash_matrix_home_uri = URI::HTTP.build({ host: SquashMatrix::Constants::SQUASH_MATRIX_URL })
+    def initialize(player: nil,
+                   email: nil,
+                   password: nil,
+                   suppress_errors: false,
+                   timeout: 60,
+                   user_agent: nil,
+                   cookie: nil,
+                   expires: nil)
+      @user_agent = user_agent || UserAgentRandomizer::UserAgent.fetch(type: 'desktop_browser').string
+      @squash_matrix_home_uri = URI::HTTP.build(host: SquashMatrix::Constants::SQUASH_MATRIX_URL)
       @suppress_errors = suppress_errors
       @timeout = timeout
-      if ![player || email, password].any?(&:nil?)
-        @cookie_jar = HTTP::CookieJar.new()
-        @player = player
-        @email = email
-        @password = password
-        authenticate
+      return unless [player || email, password].none?(&:nil?)
+      @cookie_jar = HTTP::CookieJar.new
+      @player = player
+      @email = email
+      @password = password
+      @expires = expires && Time.parse(expires).utc
+      if cookie && @expires > Time.now.utc
+        cookie.split('; ').each do |v|
+          @cookie_jar.parse(v, @squash_matrix_home_uri)
+        end
+      else
+        setup_authentication
       end
     end
 
@@ -40,13 +69,15 @@ module SquashMatrix
     # @param id [Fixnum] club id found on squash matrix
     # @return [Hash] hash object containing club information
 
-    def club_info(id=nil)
+    def get_club_info(id = nil)
       return if id.nil?
-      uri = URI::HTTP.build({
+      uri = URI::HTTP.build(
         host: SquashMatrix::Constants::SQUASH_MATRIX_URL,
         path: SquashMatrix::Constants::CLUB_PATH.gsub(':id', id.to_s)
-        })
-      success_proc = lambda {|res| SquashMatrix::NokogiriParser.club_info(res.body)}
+      )
+      success_proc = lambda do |res|
+        SquashMatrix::NokogiriParser.get_club_info(res.body)
+      end
       handle_http_request(uri, success_proc)
     end
 
@@ -55,14 +86,16 @@ module SquashMatrix
     # @param id [Fixnum] played id found on squash matrix
     # @return [Array<Hash>] Array of player match results
 
-    def player_results(id=nil)
+    def get_player_results(id = nil)
       return if id.nil?
-      uri = URI::HTTP.build({
+      uri = URI::HTTP.build(
         host: SquashMatrix::Constants::SQUASH_MATRIX_URL,
         path: SquashMatrix::Constants::PLAYER_RESULTS_PATH.gsub(':id', id.to_s),
         query: SquashMatrix::Constants::PLAYER_RSULTS_QUERY
-        })
-      success_proc = lambda {|res| SquashMatrix::NokogiriParser.player_results(res.body)}
+      )
+      success_proc = lambda do |res|
+        SquashMatrix::NokogiriParser.get_player_results(res.body)
+      end
       handle_http_request(uri, success_proc)
     end
 
@@ -71,124 +104,149 @@ module SquashMatrix
     # @param id [Fixnum] played id found on squash matrix
     # @return [Hash] hash object containing player information
 
-    def player_info(id=nil)
+    def get_player_info(id = nil)
       return if id.nil?
-      uri = URI::HTTP.build({
+      uri = URI::HTTP.build(
         host: SquashMatrix::Constants::SQUASH_MATRIX_URL,
         path: SquashMatrix::Constants::PLAYER_HOME_PATH.gsub(':id', id.to_s)
-        })
-      success_proc = lambda {|res| SquashMatrix::NokogiriParser.player_info(res.body)}
+      )
+      success_proc = lambda do |res|
+        SquashMatrix::NokogiriParser.get_player_info(res.body)
+      end
       handle_http_request(uri, success_proc)
     end
 
-    # Returns search results
+    # Returns get_search_results results
     # @note If suppress_errors == false SquashMatrix Errors will be raised upon HttpNotFound, HttpConflict, Timeout::Error, etc...
-    # @param query [String] search query
-    # @return [Hash] hash object containing search results
-
-    def search(query=nil, squash_only: false, racquetball_only: false)
-      return if query.nil? || query.empty?
-      uri = URI::HTTP.build({
+    # @param query [String] get_search_results query
+    # @return [Hash] hash object containing get_search_results results
+
+    def get_search_results(query = nil,
+                           squash_only: false,
+                           racquetball_only: false)
+      return if query.blank?
+      uri = URI::HTTP.build(
         host: SquashMatrix::Constants::SQUASH_MATRIX_URL,
-        path: SquashMatrix::Constants::SEARCH_PATH})
+        path: SquashMatrix::Constants::SEARCH_RESULTS_PATH
+      )
       query_params = {
         Criteria: query,
         SquashOnly: squash_only,
-        RacquetballOnly: racquetball_only}
-      success_proc = lambda {|res| SquashMatrix::NokogiriParser.search_results(res.body)}
+        RacquetballOnly: racquetball_only
+      }
+      success_proc = lambda do |res|
+        SquashMatrix::NokogiriParser.get_search_results(res.body)
+      end
       handle_http_request(uri, success_proc,
-        {
-          is_get_request: false,
-          query_params: query_params
-        })
+                          is_get_request: false,
+                          query_params: query_params)
     end
 
     private
 
-    def handle_http_request(uri, success_proc, is_get_request: true, query_params: nil, headers: nil)
-      begin
-        Timeout.timeout(@timeout) do
-          if is_get_request
-            req = Net::HTTP::Get.new(uri)
-            set_headers(req, headers: headers)
-          else
-            req = Net::HTTP::Post.new(uri)
-            set_headers(req)
-            form_data = []
-            query_params.each {|key, value| form_data.push([key.to_s, value.to_s])}
-            set_headers(req, headers: headers)
-            req.set_form(form_data, SquashMatrix::Constants::MULTIPART_FORM_DATA)
+    def check_authentication
+      return unless @expires && @cookie_jar && @expires <= Time.now.utc
+      @cookie_jar = HTTP::CookieJar.new
+      setup_authentication && sleep(5)
+    end
+
+    def handle_http_request(uri, success_proc,
+                            is_get_request: true,
+                            query_params: nil,
+                            headers: nil,
+                            is_authentication_request: false)
+      Timeout.timeout(@timeout) do
+        check_authentication unless is_authentication_request
+        if is_get_request
+          req = Net::HTTP::Get.new(uri)
+          set_headers(req, headers: headers)
+        else
+          req = Net::HTTP::Post.new(uri)
+          set_headers(req)
+          form_data = []
+          query_params.each do |key, value|
+            form_data.push([key.to_s, value.to_s])
           end
-          res = Net::HTTP.start(uri.hostname, uri.port, {use_ssl: uri.scheme == 'https'}) {|http| http.request(req)}
-          case res
-          when Net::HTTPSuccess, Net::HTTPFound
-            return success_proc && success_proc.call(res) || res
-          when Net::HTTPConflict
-            unless @suppress_errors
-              raise SquashMatrix::Errors::ForbiddenError.new(res.body) if SquashMatrix::Constants::FORBIDDEN_ERROR_REGEX.match(res.body)
-              raise SquashMatrix::Errors::TooManyRequestsError.new(res.body) if SquashMatrix::Constants::TOO_MANY_REQUESTS_ERROR_REGEX.match(res.body)
-            end
-          else
-            raise SquashMatrix::Errors::UnknownError.new(res) unless @suppress_errors
+          set_headers(req, headers: headers)
+          req.set_form(form_data, SquashMatrix::Constants::MULTIPART_FORM_DATA)
+        end
+        res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(req) }
+        case res
+        when Net::HTTPSuccess, Net::HTTPFound
+          return success_proc&.call(res) || res
+        when Net::HTTPConflict
+          unless @suppress_errors
+            raise SquashMatrix::Errors::ForbiddenError, res.body if SquashMatrix::Constants::FORBIDDEN_ERROR_REGEX.match(res.body)
+            raise SquashMatrix::Errors::TooManyRequestsError, res.body if SquashMatrix::Constants::TOO_MANY_REQUESTS_ERROR_REGEX.match(res.body)
           end
+        else
+          raise SquashMatrix::Errors::UnknownError, res unless @suppress_errors
         end
-      rescue Timeout::Error => e
-        raise e unless @suppress_errors
       end
+    rescue Timeout::Error => e
+      raise e unless @suppress_errors
     end
 
-    def authenticate
-      uri = URI::HTTPS.build({
+    def setup_authentication
+      uri = URI::HTTPS.build(
         host: SquashMatrix::Constants::SQUASH_MATRIX_URL,
-        path: SquashMatrix::Constants::LOGIN_PATH})
+        path: SquashMatrix::Constants::LOGIN_PATH
+      )
       query_params = {
         UserName: @player&.to_s || @email,
         Password: @password,
-        RememberMe: false
+        RememberMe: true
       }
       headers = {
         SquashMatrix::Constants::CONTENT_TYPE_HEADER => SquashMatrix::Constants::MULTIPART_FORM_DATA
       }
       # need to retrieve the asp.net session id
-      home_page_res = handle_http_request(@squash_matrix_home_uri, nil)
-      raise SquashMatrix::Errors::AuthorizationError.new(SquashMatrix::Constants::ERROR_RETRIEVING_ASPNET_SESSION) unless home_page_res
+      home_page_res = handle_http_request(@squash_matrix_home_uri,
+                                          nil,
+                                          is_authentication_request: true)
+      raise SquashMatrix::Errors::AuthorizationError, SquashMatrix::Constants::ERROR_RETRIEVING_ASPNET_SESSION unless home_page_res
       home_page_res[SquashMatrix::Constants::SET_COOKIE_HEADER].split('; ').each do |v|
         @cookie_jar.parse(v, @squash_matrix_home_uri)
       end
       res = handle_http_request(uri, nil,
-        {
-          is_get_request: false,
-          query_params: query_params,
-          headers: headers
-        })
-      raise SquashMatrix::Errors::AuthorizationError.new(SquashMatrix::Constants::ERROR_RETRIEVING_ASPAUX_TOKEN) unless res
-      res[SquashMatrix::Constants::SET_COOKIE_HEADER].split('; ').each do |v|
+                                is_get_request: false,
+                                query_params: query_params,
+                                headers: headers,
+                                is_authentication_request: true)
+      raise SquashMatrix::Errors::AuthorizationError, SquashMatrix::Constants::ERROR_RETRIEVING_ASPAUX_TOKEN unless res
+      res[SquashMatrix::Constants::SET_COOKIE_HEADER]&.split('; ')&.each do |v|
+        parts = SquashMatrix::Constants::EXPIRES_FROM_COOKIE_REGEX.match(v)
+        @expires = Time.parse(parts[1]).utc if parts
         @cookie_jar.parse(v, @squash_matrix_home_uri)
       end
-      @player = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(res[SquashMatrix::Constants::LOCATION_HEADER])[1] if @player.nil? && res[SquashMatrix::Constants::LOCATION_HEADER]
-      unless !@suppress_errors && @cookie_jar.cookies(@squash_matrix_home_uri).find {|c| c.name == SquashMatrix::Constants::ASPXAUTH_COOKIE_NAME && !c.value.empty?}
-        error_string = SquashMatrix::NokogiriParser.log_on_error(res.body).join(', ')
-        raise SquashMatrix::Errors::AuthorizationError.new(error_string)
-      end
+      @expires ||= Time.now.utc + 60 * 60 * 24 * 2 # default expires in two days (usually 52 hours)
+      @player = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(res[SquashMatrix::Constants::LOCATION_HEADER])[1] if @player.nil? && !res[SquashMatrix::Constants::LOCATION_HEADER].empty?
+      return unless !@suppress_errors && !@cookie_jar&.cookies(@squash_matrix_home_uri)&.find { |c| c.name == SquashMatrix::Constants::ASPXAUTH_COOKIE_NAME && !c.value.empty? }
+      error_string = SquashMatrix::NokogiriParser.get_log_on_error(res.body).join(', ')
+      raise SquashMatrix::Errors::AuthorizationError, error_string
     end
 
-    def set_headers(req=nil, headers: nil)
+    def set_headers(req = nil, headers: nil)
       return unless req
       headers_to_add = {
         SquashMatrix::Constants::USER_AGENT_HEADER => @user_agent,
-        SquashMatrix::Constants::HOST_HEADER => SquashMatrix::Constants::SQUASH_MATRIX_URL}
+        SquashMatrix::Constants::HOST_HEADER => SquashMatrix::Constants::SQUASH_MATRIX_URL
+      }
       headers_to_add = headers_to_add.merge(headers) if headers
-      if @cookie_jar
-        cookies = @cookie_jar.cookies(@squash_matrix_home_uri).select do |c|
-          [
-            SquashMatrix::Constants::ASP_NET_SESSION_ID_COOKIE_NAME,
-            SquashMatrix::Constants::GROUP_ID_COOKIE_NAME,
-            SquashMatrix::Constants::ASPXAUTH_COOKIE_NAME
-          ].include?(c.name)
-        end
-        headers_to_add = headers_to_add.merge({SquashMatrix::Constants::COOKIE_HEADER => HTTP::Cookie.cookie_value(cookies)})
+      headers_to_add = headers_to_add.merge(SquashMatrix::Constants::COOKIE_HEADER => get_cookie_string) if @cookie_jar
+      headers_to_add.each { |key, val| req[key.to_s] = val }
+    end
+
+    def get_cookie_string
+      return unless @cookie_jar
+      cookies = @cookie_jar.cookies(@squash_matrix_home_uri).select do |c|
+        [
+          SquashMatrix::Constants::ASP_NET_SESSION_ID_COOKIE_NAME,
+          SquashMatrix::Constants::GROUP_ID_COOKIE_NAME,
+          SquashMatrix::Constants::ASPXAUTH_COOKIE_NAME
+        ].include?(c.name)
       end
-      headers_to_add.each {|key, val| req[key.to_s] = val}
+      HTTP::Cookie.cookie_value(cookies)
     end
   end
 end

data/lib/squash_matrix/constants.rb

@@ -1,34 +1,37 @@
+# frozen_string_literal: true
 
 module SquashMatrix
   module Constants
-    SQUASH_MATRIX_URL = "www.squashmatrix.com"
-    LOGIN_PATH = "/Account/LogOn"
-    PLAYER_RESULTS_PATH = "/Home/PlayerResults/:id"
-    PLAYER_HOME_PATH = "/Home/Player/:id"
-    CLUB_PATH = "/Home/Club/:id"
-    SEARCH_PATH = "/Home/Search"
-    PLAYER_RSULTS_QUERY = "max=0&X-Requested-With=XMLHttpRequest"
+    SQUASH_MATRIX_URL = 'www.squashmatrix.com'
+    LOGIN_PATH = '/Account/LogOn'
+    PLAYER_RESULTS_PATH = '/Home/PlayerResults/:id'
+    PLAYER_HOME_PATH = '/Home/Player/:id'
+    CLUB_PATH = '/Home/Club/:id'
+    SEARCH_RESULTS_PATH = '/Home/get_search_results'
+    PLAYER_RSULTS_QUERY = 'max=0&X-Requested-With=XMLHttpRequest'
     SET_COOKIE_HEADER = 'set-cookie'
     COOKIE_HEADER = 'cookie'
     LOCATION_HEADER = 'location'
     X_WWW__FROM_URL_ENCODED = 'application/x-www-form-urlencoded'
     MULTIPART_FORM_DATA = 'multipart/form-data'
     CONTENT_TYPE_HEADER = 'content-type'
-    REFERER = "Home/Player/:id"
-    ASPXAUTH_COOKIE_NAME = ".ASPXAUTH"
-    ASP_NET_SESSION_ID_COOKIE_NAME = "ASP.NET_SessionId"
-    GROUP_ID_COOKIE_NAME = "GroupId"
+    REFERER = 'Home/Player/:id'
+    ASPXAUTH_COOKIE_NAME = '.ASPXAUTH'
+    ASP_NET_SESSION_ID_COOKIE_NAME = 'ASP.NET_SessionId'
+    GROUP_ID_COOKIE_NAME = 'GroupId'
     HOST_HEADER = 'host'
     USER_AGENT_HEADER = 'user-agent'
+    EXPIRES_COOKIE_NAME = 'expires'
 
     PLAYER_FROM_PATH_REGEX = /\/Home\/Player\/(.*)/
     TEAM_FROM_PATH_REGEX = /\/Home\/Team\/(.*)/
     CLUB_FROM_PATH_REGEX = /\/Home\/Club\/(.*)/
     MATCH_FROM_PATH_REGEX = /\/Home\/Match\/(.*)/
     CLUB_FROM_TITLE_REGEX = /Club - (.*)/
+    EXPIRES_FROM_COOKIE_REGEX = /expires=(.*)/
 
-    ERROR_RETRIEVING_ASPNET_SESSION = "Error retrieving ASP.NET_SessionId"
-    ERROR_RETRIEVING_ASPAUX_TOKEN = "Error retrieving .ASPXAUTH_TOKEN"
+    ERROR_RETRIEVING_ASPNET_SESSION = 'Error retrieving ASP.NET_SessionId'
+    ERROR_RETRIEVING_ASPAUX_TOKEN = 'Error retrieving .ASPXAUTH_TOKEN'
 
     TOO_MANY_REQUESTS_ERROR_REGEX = /Request made too soon. This is to prevent abuse to the site. We apologise for the inconvenience/
     FORBIDDEN_ERROR_REGEX = /Forbidden/

data/lib/squash_matrix/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SquashMatrix
   module Errors
     class TooManyRequestsError < StandardError; end

data/lib/squash_matrix/nokogiri-parser.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 require_relative 'constants'
 
 module SquashMatrix
   class NokogiriParser
     class << self
-      def player_rsults(body)
-        Nokogiri::HTML(body)&.xpath('//table[@id="results"]//tbody//tr')&.map do |r|
+      def get_player_rsults(body)
+        rtn = Nokogiri::HTML(body)&.xpath('//table[@id="results"]//tbody//tr')&.map do |r|
           date = r.at_css('td[1]')&.content
           opponent_id = r.at_css('td[10]//a')&.attribute('href')&.content
           match_id = r.at_css('td[12]//a')&.attribute('href')&.content
@@ -25,10 +27,11 @@ module SquashMatrix
           rtn[:opponent_id] = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(opponent_id)[1].to_i if opponent_id
           rtn[:match_id] = SquashMatrix::Constants::MATCH_FROM_PATH_REGEX.match(match_id)[1].to_i if match_id
           rtn.values.any?(&:nil?) ? nil : rtn
-        end.compact
+        end
+        rtn.compact
       end
 
-      def player_info(body)
+      def get_player_info(body)
         rows = Nokogiri::HTML(body)&.xpath('//table[@id="profile"]//tbody//tr')
         rating = rows[1]&.css('td[2]')&.text
         clubs = rows[2]&.css('td[2]')&.css('ul//li')&.map do |c|
@@ -54,7 +57,7 @@ module SquashMatrix
         }
       end
 
-      def club_info(body)
+      def get_club_info(body)
         html = Nokogiri::HTML(body)
         name = SquashMatrix::Constants::CLUB_FROM_TITLE_REGEX.match(html.css('title').text)[1]
         players = html.xpath('//div[@id="Rankings"]//div[@class="columnmain"]//table[@class="alternaterows"]//tbody//tr')&.map do |r|
@@ -67,7 +70,7 @@ module SquashMatrix
           rtn[:rank] = rank.to_i if rank
           rtn[:id] = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(player_path)[1].to_i if player_path
           rtn
-        end.compact
+        end
         juniors = html.xpath('//div[@id="Rankings"]//div[@class="columnside"]//table[@class="alternaterows"]//tbody//tr')&.map do |r|
           player_path = r.css('td[2]//a').attribute('href').value
           rank = r.css('td[1]').text
@@ -78,40 +81,40 @@ module SquashMatrix
           rtn[:rank] = rank.to_i if rank
           rtn[:id] = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(player_path)[1].to_i if player_path
           rtn
-        end.compact
+        end
         {
           name: name,
-          players: players,
-          juniors: juniors
+          players: players.compact,
+          juniors: juniors.compact
         }
       end
 
-      def search_results(body)
+      def get_search_results(body)
         bc = Nokogiri::HTML.parse(body).at_xpath('//div[@id="bodycontent"]')&.children
         return unless bc&.length
         rtn = {}
         bc&.each_with_index do |c, i|
-          if c.name == "h2"
+          if c.name == 'h2'
             case c.text
-            when "Players"
-              rtn[:players] = players_from_search(bc[i+2]) if bc[i+2].children.length
-            when "Teams"
-              rtn[:teams] = teams_from_search(bc[i+2]) if bc[i+2].children.length
-            when "Clubs"
-              rtn[:clubs] = clubs_from_search(bc[i+2]) if bc[i+2].children.length
+            when 'Players'
+              rtn[:players] = get_players_from_search_results(bc[i + 2]) if bc[i + 2].children.length
+            when 'Teams'
+              rtn[:teams] = get_teams_from_search_results(bc[i + 2]) if bc[i + 2].children.length
+            when 'Clubs'
+              rtn[:clubs] = get_clubs_from_search_results(bc[i + 2]) if bc[i + 2].children.length
             end
           end
         end
         rtn
       end
 
-      def log_on_error(body)
+      def get_log_on_error(body)
         Nokogiri::HTML(body)&.xpath('//div[@class="validation-summary-errors"]//ul//li')&.map(&:content)
       end
 
       private
 
-      def players_from_search(node)
+      def get_players_from_search_results(node)
         node.css('tbody//tr')&.map do |tr|
           id = tr.css('td[1]//a')&.attribute('href')&.value
           rating = tr.css('td[3]')&.text
@@ -119,13 +122,13 @@ module SquashMatrix
             name: tr.css('td[1]')&.text,
             club_name: tr.css('td[2]')&.text
           }
-          rtn[:id] = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(id)[1].to_i if id && !id.empty?
+          rtn[:id] = SquashMatrix::Constants::PLAYER_FROM_PATH_REGEX.match(id)[1].to_i if id.present?
           rtn[:rating] = rating.to_f if rating
           rtn
         end
       end
 
-      def teams_from_search(node)
+      def get_teams_from_search_results(node)
         node.css('tbody//tr')&.map do |tr|
           id = tr.css('td[1]//a')&.attribute('href')&.value
           rtn = {
@@ -138,7 +141,7 @@ module SquashMatrix
         end
       end
 
-      def clubs_from_search(node)
+      def get_clubs_from_search_results(node)
         node.css('tbody//tr')&.map do |tr|
           id = tr.css('td[1]//a')&.attribute('href')&.value
           rtn = {
@@ -149,10 +152,6 @@ module SquashMatrix
           rtn
         end
       end
-
-      def requests_made_to_soon?(body)
-        Nokogiri::HTML(body)&.xpath('//body')
-      end
     end
   end
 end

data/lib/squash_matrix/version.rb

@@ -1,3 +1,3 @@
 module SquashMatrix
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squash_matrix
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Joshua Wilkosz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for www.squashmatrix.com