triviacrack 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac625736e1fdbe91e229596d95e3af90c22ea6b7b2de6373717994301bfe3b9
-  data.tar.gz: 37afe95e8d8aa72297e85236c00af489bc6a8502c9f8b3d079062ed7157fec02
+  metadata.gz: 1655be2ef856891d2287a9c944212121c44c42dddc89a67d8f447c2bd7f7651d
+  data.tar.gz: 24495ecb87e3ab8f32938d5d60aadccb20f94836fee016548f18450f205f76ec
 SHA512:
-  metadata.gz: d5f407ab7c8f5ca194efe7bdea42f90943b5f41c80fc5e2485f8d891afc076bbca76a0b016b75c9da96d598e436371ee8db7763b3771fd21942052e76825ba0e
-  data.tar.gz: 28d4d34fb76d0fdaaa9c81b00fdf53bc7422406e701cf343275b0a81aebe0faabdb516dcdd1186309fba94bedfe33328111a70e03842c6f5acd17ea5af400fb9
+  metadata.gz: 35aaf68a6492fdaa6859cac4c79d0be62b38bd99e5b537a953581a206777b0c791dc22417e74c06df6a34f7eb9f35d4ef8d6bc88f4de7f1e5e3711dba5d4da77
+  data.tar.gz: 3ff4f392bc6d16b7f8f2113e791893859ec61f26ba11944b3129898f288cacbc4a06019efe8a8b3a1d144cc8c0583029ad66c3277493bd9fefc18645d4548b14

data/.github/workflows/ci.yml

@@ -15,15 +15,20 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.2
+          ruby-version: 3.1.2
 
       - name: Bundle Install
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
 
+      - name: RuboCop Linter Action
+        uses: andrewmcodes/rubocop-linter-action@v3.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Run RSpec and Code Coverage
         uses: paambaati/codeclimate-action@v2.4.0
         env:

data/.github/workflows/publish.yml

@@ -3,7 +3,7 @@ name: Publish
 on:
   push:
     tags:
-      - 'v*'
+      - "v*"
 
 jobs:
   build:
@@ -12,15 +12,20 @@ jobs:
     steps:
       - uses: actions/checkout@v1
 
-      - uses: actions/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.2
+          ruby-version: 3.1.2
 
       - name: Bundle Install
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
 
+      - name: RuboCop Linter Action
+        uses: andrewmcodes/rubocop-linter-action@v3.3.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Run RSpec and Code Coverage
         uses: paambaati/codeclimate-action@v2.4.0
         env:

data/.rubocop.yml

@@ -0,0 +1,23 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.2

data/Gemfile

@@ -1,5 +1,4 @@
-#ruby=ruby-3.0.2
-#ruby-gemset=triviacrack
+# frozen_string_literal: true
 
 source 'https://rubygems.org'
 

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    triviacrack (0.6.0)
+    triviacrack (0.7.0)
       faraday (~> 1.7.2)
       json (~> 2.5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.4.4)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     faraday (1.7.2)
       faraday-em_http (~> 1.0)
@@ -33,24 +34,42 @@ GEM
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
     json (2.5.1)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
+    rspec-core (3.10.2)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.10.2)
+    rspec-mocks (3.10.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
+    rubocop (1.31.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
     simplecov (0.21.2)
@@ -58,19 +77,21 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.2.27)
+  bundler (~> 2.3.18)
   fuubar (~> 2.5.1)
   rake (~> 13.0.6)
   rspec (~> 3.10.0)
   rspec-its (~> 1.3.0)
+  rubocop (~> 1.31.2)
   simplecov (~> 0.21.2)
   triviacrack!
 
 BUNDLED WITH
-   2.2.27
+   2.3.18

data/Rakefile

@@ -1,7 +1,9 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/SuppressedException
 end

data/lib/triviacrack/api/client.rb

@@ -1,14 +1,15 @@
-require "triviacrack/api/game"
-require "triviacrack/api/login"
-require "triviacrack/api/profile"
-require "triviacrack/api/question"
-require "triviacrack/api/user"
+# frozen_string_literal: true
+
+require 'triviacrack/api/game'
+require 'triviacrack/api/login'
+require 'triviacrack/api/profile'
+require 'triviacrack/api/question'
+require 'triviacrack/api/user'
 
 # Public: Interface for interacting with the Trivia Crack API.
 module TriviaCrack
   module API
     class Client
-
       include TriviaCrack::API::Game
       include TriviaCrack::API::Login
       include TriviaCrack::API::User
@@ -25,7 +26,6 @@ module TriviaCrack
         @session = TriviaCrack::Session.new session_id: session_id,
                                             user_id: user_id
       end
-
     end
   end
 end

data/lib/triviacrack/api/common.rb

@@ -1,13 +1,14 @@
-require "json"
-require "faraday"
+# frozen_string_literal: true
 
-require "triviacrack/errors/request_error"
+require 'json'
+require 'faraday'
+
+require 'triviacrack/errors/request_error'
 
 # Internal: Common methods used for the Trivia Crack API.
 module TriviaCrack
   module API
     module Common
-
       # Internal: Makes a GET request to the Trivia Crack API using the set of
       # default headers.
       #
@@ -39,18 +40,16 @@ module TriviaCrack
       private
 
       # Internal: The host name of the Trivia Crack API.
-      API_HOST = "https://api.preguntados.com"
+      API_HOST = 'https://api.preguntados.com'
 
       # Internal: Constructs the set of headers needed to make requests to the
       # Trivia Crack API.
       #
       # Returns a hash of headers.
       def default_headers
-        headers = { "Content-Type": "application/json; charset=utf-8" }
+        headers = { 'Content-Type': 'application/json; charset=utf-8' }
 
-        if @session
-          headers["Cookie"] = "ap_session=#{@session.session_id}"
-        end
+        headers['Cookie'] = "ap_session=#{@session.session_id}" if @session
 
         headers
       end
@@ -63,9 +62,9 @@ module TriviaCrack
       # Returns the response body parsed from JSON
       # Raises TriviaCrack:Errors::RequestError if the request failed.
       def check_response(url, response)
-        if not response.status.between? 200, 299
+        unless response.status.between? 200, 299
           raise TriviaCrack::Errors::RequestError.new(response.status, url, response.body),
-            "Request to #{API_HOST}#{url} failed with code #{response.status}."
+                "Request to #{API_HOST}#{url} failed with code #{response.status}."
         end
 
         JSON.parse(response.body)

data/lib/triviacrack/api/game.rb

@@ -1,13 +1,14 @@
-require "json"
-require "triviacrack/api/common"
-require "triviacrack/parsers/game_parser"
+# frozen_string_literal: true
+
+require 'json'
+require 'triviacrack/api/common'
+require 'triviacrack/parsers/game_parser'
 
 # Public: All methods in this module make requests to the Trivia Crack games
 # API.
 module TriviaCrack
   module API
     module Game
-
       include TriviaCrack::API::Common
 
       # Public: Uses the Trivia Crack API to fetch the list of games for the
@@ -19,17 +20,15 @@ module TriviaCrack
       #
       # Returns a list of TriviaCrack::Game.
       # Raises TriviaCrack:Errors::RequestError if the request fails.
-      def get_games
+      def get_games # rubocop:disable Naming/AccessorMethodName
         response = get "/api/users/#{@session.user_id}/dashboard"
 
-        games_data = response["list"]
+        games_data = response['list']
 
         games = []
-        if games_data
-          games_data.each do |game_data|
-            game = TriviaCrack::Parsers::GameParser.parse game_data
-            games << game
-          end
+        games_data&.each do |game_data|
+          game = TriviaCrack::Parsers::GameParser.parse game_data
+          games << game
         end
 
         games
@@ -63,11 +62,10 @@ module TriviaCrack
       # Raises TriviaCrack::Errors::RequestError if the request fails
       def start_new_game
         response = post "/api/users/#{@session.user_id}/games",
-                        parameters: { language: "EN" }.to_json
+                        parameters: { language: 'EN' }.to_json
 
         TriviaCrack::Parsers::GameParser.parse response
       end
-
     end
   end
 end

data/lib/triviacrack/api/login.rb

@@ -1,13 +1,14 @@
-require "json"
-require "triviacrack/api/common"
-require "triviacrack/parsers/session_parser"
+# frozen_string_literal: true
+
+require 'json'
+require 'triviacrack/api/common'
+require 'triviacrack/parsers/session_parser'
 
 # Public: All methods in this module make requests to the Trivia Crack login
 # API.
 module TriviaCrack
   module API
     module Login
-
       include TriviaCrack::API::Common
 
       # Public: Uses the given email and password to log in to Trivia Crack
@@ -23,14 +24,12 @@ module TriviaCrack
       # Returns the user_id and username of the user that has logged in.
       # Raises TriviaCrack::Errors::RequestError if the request fails.
       def login(email, password)
-        response = post "/api/login", parameters: { email: email,
+        response = post '/api/login', parameters: { email: email,
                                                     password: password,
-                                                    language: "en"
-                                                  }.to_json
+                                                    language: 'en' }.to_json
 
         @session = TriviaCrack::Parsers::SessionParser.parse response
       end
-
     end
   end
 end

data/lib/triviacrack/api/profile.rb

@@ -1,10 +1,11 @@
-require "triviacrack/api/common"
+# frozen_string_literal: true
+
+require 'triviacrack/api/common'
 
 # Public: Interface to the Trivia Crack Profile API.
 module TriviaCrack
   module API
     module Profile
-
       include TriviaCrack::API::Common
 
       # Public: Uses the Trivia Crack API to get the profile of the user with
@@ -32,13 +33,12 @@ module TriviaCrack
       #
       # Returns the TriviaCrack::Profile for the current user.
       # Raises TriviaCrack::Errors::RequestError if the request fails.
-      def get_my_profile
+      def get_my_profile # rubocop:disable Naming/AccessorMethodName
         response =
           get "/api/users/#{@session.user_id}/profiles/#{@session.user_id}"
 
         TriviaCrack::Parsers::ProfileParser.parse response
       end
-
     end
   end
 end

data/lib/triviacrack/api/question.rb

@@ -1,13 +1,14 @@
-require "json"
-require "triviacrack/api/common"
-require "triviacrack/parsers/game_parser"
+# frozen_string_literal: true
+
+require 'json'
+require 'triviacrack/api/common'
+require 'triviacrack/parsers/game_parser'
 
 # Public: All methods in this module make requests to the Trivia Crack answers
 # API.
 module TriviaCrack
   module API
     module Question
-
       include TriviaCrack::API::Common
 
       # Public: Uses the Trivia Crack API to answer the given question.
@@ -26,13 +27,12 @@ module TriviaCrack
       def answer_question(game_id, question, answer)
         response =
           post "/api/users/#{@session.user_id}/games/#{game_id}/answers",
-                parameters: { type: question.type.upcase,
-                              answers: [{
-                                id: question.id,
-                                answer: answer,
-                                category: question.category.upcase
-                                }]
-                            }.to_json
+               parameters: { type: question.type.upcase,
+                             answers: [{
+                               id: question.id,
+                               answer: answer,
+                               category: question.category.upcase
+                             }] }.to_json
 
         game = TriviaCrack::Parsers::GameParser.parse response
 
@@ -57,11 +57,11 @@ module TriviaCrack
       # with an entry for each question ID and a boolean indicating if
       # the question was answered successfully.
       # Raises TriviaCrack::Errors::RequestError if the request fails
-      def answer_questions(game_id, questions, answer_map)
+      def answer_questions(game_id, questions, answer_map) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         answers = []
         correct_answers = {}
 
-        for question in questions do
+        questions.each do |question|
           answer = {
             id: question.id,
             answer: answer_map[question.id],
@@ -73,13 +73,12 @@ module TriviaCrack
 
         response =
           post "/api/users/#{@session.user_id}/games/#{game_id}/answers",
-                parameters: { type: questions.first.type.upcase, answers: answers }.to_json
+               parameters: { type: questions.first.type.upcase, answers: answers }.to_json
 
         game = TriviaCrack::Parsers::GameParser.parse response
 
         [game, correct_answers]
       end
-
     end
   end
 end

data/lib/triviacrack/api/user.rb

@@ -1,12 +1,13 @@
-require "triviacrack/api/common"
-require "triviacrack/parsers/user_parser"
+# frozen_string_literal: true
+
+require 'triviacrack/api/common'
+require 'triviacrack/parsers/user_parser'
 
 # Public: All methods in this module make requests to the Trivia Crack users
 # API.
 module TriviaCrack
   module API
     module User
-
       include TriviaCrack::API::Common
 
       # Public: Uses the Trivia Crack Search API to find the numeric user id of
@@ -22,16 +23,14 @@ module TriviaCrack
       # Raises TriviaCrack:Errors::RequestError if the request fails.
       def get_user_id(username)
         # Trim the @ character from the start of the username
-        if username.start_with? "@"
-          username = username[1..-1]
-        end
+        username = username[1..-1] if username.start_with? '@'
 
         body = get "/api/search?username=#{username}"
 
         user_id = false
-        body["list"].each do |user|
-          if user["username"] == username
-            user_id = user["id"]
+        body['list'].each do |user|
+          if user['username'] == username
+            user_id = user['id']
             break
           end
         end
@@ -43,12 +42,11 @@ module TriviaCrack
       #
       # Returns a TriviaCrack::User representing the current user.
       # Raises TriviaCrack::Errors::RequestError if the request fails
-      def get_user
+      def get_user # rubocop:disable Naming/AccessorMethodName
         response = get "/api/users/#{@session.user_id}"
 
         TriviaCrack::Parsers::UserParser.parse response
       end
-
     end
   end
 end

data/lib/triviacrack/category_statistics.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 # Public: An object representing category statistics for a player within a
 # single Trivia Crack game.
 module TriviaCrack
   class CategoryStatistics
-
     # Public: The category for these statistics (:arts, :geography, etc).
     attr_reader :category
 
@@ -22,6 +23,5 @@ module TriviaCrack
       @incorrect = incorrect
       @worst     = worst
     end
-
   end
 end

data/lib/triviacrack/errors/parse_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Public: This error is raised when a block of data cannot be correctly parsed.
 module TriviaCrack
   module Errors

data/lib/triviacrack/errors/request_error.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 # Public: This error is raised when a web request to the Trivia Crack API is
 # unsuccessful.
 module TriviaCrack
   module Errors
     class RequestError < StandardError
-
       # Public: The HTTP status code returned by the Trivia Crack server.
       attr_reader :code
 
-      #Public: The URL that was requested.
+      # Public: The URL that was requested.
       attr_reader :url
 
-      #Public: The response body that was returned by the Trivia Crack server.
+      # Public: The response body that was returned by the Trivia Crack server.
       attr_reader :body
 
       # Public: Initializes a RequestError.
@@ -19,6 +20,7 @@ module TriviaCrack
       # url - The URL that was requested.
       # body - The response body that was returned by the Trivia Crack server.
       def initialize(code, url, body)
+        super()
         @code = code
         @url = url
         @body = body

data/lib/triviacrack/game.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # Public: An object representing a Trivia Crack Game, including information
 # about the questions to be asked in the game, the state of the game, opponent
 # information, and more.
 module TriviaCrack
   class Game
-
     # Public: The unique identifier of the game.
     attr_reader :id
 
@@ -58,7 +59,7 @@ module TriviaCrack
     # Public: TriviaCrack::GameStatistics for the opponent.
     attr_reader :opponent_statistics
 
-    def initialize(id:, opponent: nil, game_status: nil, language: nil,
+    def initialize(id:, opponent: nil, game_status: nil, language: nil, # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
                    created: nil, last_turn: nil, type: nil,
                    expiration_date: nil, my_turn: nil, round_number: nil,
                    is_random: nil, unread_messages: nil, status_version: nil,
@@ -95,6 +96,5 @@ module TriviaCrack
     def playable?
       @my_turn && @game_status != :ended
     end
-
   end
 end

data/lib/triviacrack/game_statistics.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 # Public: An object representing player statistics for a Trivia Crack game.
 module TriviaCrack
   class GameStatistics
-
     # Public: The number of questions answered correctly.
     attr_reader :correct_answers
 
@@ -20,7 +21,7 @@ module TriviaCrack
     # Public: A hash of category statistics.
     attr_reader :categories
 
-    def initialize(correct_answers: nil, incorrect_answers: nil,
+    def initialize(correct_answers: nil, incorrect_answers: nil, # rubocop:disable Metrics/ParameterLists
                    questions_answered: nil, challenges_won: nil,
                    crowns: nil, categories: nil)
       @correct_answers    = correct_answers
@@ -30,6 +31,5 @@ module TriviaCrack
       @crowns             = crowns
       @categories         = categories
     end
-
   end
 end