twitchrb 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6774429fbfacd30d1308f5240f54d31bddfc9e5511ca11a5318317d8ecd426fe
-  data.tar.gz: 8483a2e2a75269d40a6fcc56e1206dfc59a4033ef6d4d8bb679aaca6ab1e72dc
+  metadata.gz: 1a745f6e1fdd82794a6bc9b3aeb7e4f374efa7e50b8751f357fd23aa48ef7912
+  data.tar.gz: 7f08650f12bfb36269f359653ecfa23011f8d595ab6c84a2d284f87157ea5b17
 SHA512:
-  metadata.gz: 36c6bea9d2c2e8e1ff5eab8d3daf2edc0b2edc1047bb65f5d38c77b78b9fcba7333dc628593c5d5e9aa6cc2a0543115738f7a437200867a4d7186c0edd5e01c6
-  data.tar.gz: f775ef2e85b39651f8c4fcea07791badce94086b3129f52dab6d44bf08456a1083d2b805bb3b6ef2c3eb965ae1178190623af7f243109042dc7ae0b10b0dd1a9
+  metadata.gz: 566698cf2d321eadd523abf2777ff808fbce5f6d896b0a7e7db65af24f5643b38bc21be87a846f507b51d551f4f34f0ddfe2b85ab3d608585ac5914c7b4cecdf
+  data.tar.gz: d7ee4125e0cfb8f523a9b4bf3ada19f477fdd8d5865ac8801246864eb99ad5118481814ac8f5d44d1f8922bb578848d8033228156c91f2d83ce768e1171d7d37

data/.github/workflows/ci.yml

@@ -1,5 +1,11 @@
 name: CI
-on: push
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 jobs:
   lint:
     runs-on: ubuntu-latest

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitchrb (1.3.0)
+    twitchrb (1.4.0)
       faraday (~> 2.0)
 
 GEM
@@ -22,51 +22,53 @@ GEM
     bigdecimal (3.1.8)
     concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
-    dotenv (2.7.6)
+    dotenv (3.1.2)
     drb (2.2.1)
-    faraday (2.9.2)
+    faraday (2.10.1)
       faraday-net_http (>= 2.0, < 3.2)
-    faraday-net_http (3.1.0)
+      logger
+    faraday-net_http (3.1.1)
       net-http
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    minitest (5.15.0)
+    logger (1.6.0)
+    minitest (5.24.1)
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
     parallel (1.25.1)
-    parser (3.3.3.0)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    racc (1.8.0)
-    rack (3.1.3)
+    racc (1.8.1)
+    rack (3.1.7)
     rainbow (3.1.1)
     rake (12.3.3)
     regexp_parser (2.9.2)
-    rexml (3.3.0)
+    rexml (3.3.4)
       strscan
-    rubocop (1.64.1)
+    rubocop (1.65.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-minitest (0.35.0)
+    rubocop-minitest (0.35.1)
       rubocop (>= 1.61, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-performance (1.21.0)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.25.0)
+    rubocop-rails (2.25.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
@@ -96,4 +98,4 @@ DEPENDENCIES
   vcr
 
 BUNDLED WITH
-   2.3.21
+   2.5.17

data/lib/twitch/error_generator.rb

@@ -0,0 +1,128 @@
+module Twitch
+  class ErrorGenerator < StandardError
+    attr_reader :http_status_code
+    attr_reader :twitch_error_code
+    attr_reader :twitch_error_message
+
+    def initialize(response_body, http_status_code)
+      @response_body = response_body
+      @http_status_code = http_status_code
+      set_twitch_error_values
+      super(build_message)
+    end
+
+    private
+
+    def set_twitch_error_values
+      @twitch_error_code = @response_body.dig("error")
+      @twitch_error_message = @response_body.dig("message")
+    end
+
+    def error_message
+      @twitch_error_message || @response_body.dig("error")
+    rescue NoMethodError
+      "An unknown error occurred."
+    end
+
+    def build_message
+      if twitch_error_code.nil?
+        return "Error #{@http_status_code}: #{error_message}"
+      end
+      "Error #{@http_status_code}: #{error_message} '#{twitch_error_message}'"
+    end
+  end
+
+  module Errors
+    class BadRequestError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was malformed."
+      end
+    end
+
+    class AuthenticationMissingError < ErrorGenerator
+      private
+
+      def error_message
+        "You did not supply valid authentication credentials."
+      end
+    end
+
+    class ForbiddenError < ErrorGenerator
+      private
+
+      def error_message
+        "You are not allowed to perform that action."
+      end
+    end
+
+    class EntityNotFoundError < ErrorGenerator
+      private
+
+      def error_message
+        "No results were found for your request."
+      end
+    end
+
+    class ConflictError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request was a conflict."
+      end
+    end
+
+    class TooManyRequestsError < ErrorGenerator
+      private
+
+      def error_message
+        "Your request exceeded the API rate limit."
+      end
+    end
+
+    class InternalError < ErrorGenerator
+      private
+
+      def error_message
+        "We were unable to perform the request due to server-side problems."
+      end
+    end
+
+    class ServiceUnavailableError < ErrorGenerator
+      private
+
+      def error_message
+        "You have been rate limited for sending more than 20 requests per second."
+      end
+    end
+
+    class NotImplementedError < ErrorGenerator
+      private
+
+      def error_message
+        "This resource has not been implemented."
+      end
+    end
+  end
+
+  class ErrorFactory
+    HTTP_ERROR_MAP = {
+      400 => Errors::BadRequestError,
+      401 => Errors::AuthenticationMissingError,
+      403 => Errors::ForbiddenError,
+      404 => Errors::EntityNotFoundError,
+      409 => Errors::ConflictError,
+      429 => Errors::TooManyRequestsError,
+      500 => Errors::InternalError,
+      503 => Errors::ServiceUnavailableError,
+      501 => Errors::NotImplementedError
+    }.freeze
+
+    def self.create(response_body, http_status_code)
+      status = http_status_code
+      error_class = HTTP_ERROR_MAP[status] || ErrorGenerator
+      error_class.new(response_body, http_status_code) if error_class
+    end
+  end
+end

data/lib/twitch/resource.rb

@@ -29,31 +29,20 @@ module Twitch
     end
 
     def handle_response(response)
-      case response.status
-      when 400
-        raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
-      when 401
-        raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["error"]}'"
-      when 403
-        raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["error"]}'"
-      when 404
-        raise Error, "Error 404: No results were found for your request. '#{response.body["error"]}'"
-      when 409
-        raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
-      when 422
-        raise Error, "Error 422: Unprocessable Entity. '#{response.body["message"]}"
-      when 429
-        raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["error"]}'"
-      when 500
-        raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["error"]}'"
-      when 503
-        raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["error"]}'"
-      when 204
-        # 204 is a response for success on Twitch's API
-        return true
-      end
-
-      response
+      return true if response.status == 204
+      return response unless error?(response)
+
+      raise_error(response)
+    end
+
+    def error?(response)
+      [ 400, 401, 403, 404, 409, 429, 500, 501, 503 ].include?(response.status) ||
+        response.body&.key?("error")
+    end
+
+    def raise_error(response)
+      error = Twitch::ErrorFactory.create(response.body, response.status)
+      raise error if error
     end
   end
 end

data/lib/twitch/version.rb

@@ -1,3 +1,3 @@
 module Twitch
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/twitch.rb

@@ -1,11 +1,16 @@
 require "faraday"
 require "json"
+require "ostruct"
 require "twitch/version"
 
 module Twitch
+  autoload :Error, "twitch/error"
+  autoload :Errors, "twitch/error_generator"
+  autoload :ErrorGenerator, "twitch/error_generator"
+  autoload :ErrorFactory, "twitch/error_generator"
+
   autoload :Client, "twitch/client"
   autoload :Collection, "twitch/collection"
-  autoload :Error, "twitch/error"
   autoload :Resource, "twitch/resource"
   autoload :Object, "twitch/object"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitchrb
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Dean Perry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -47,6 +47,7 @@ files:
 - lib/twitch/client.rb
 - lib/twitch/collection.rb
 - lib/twitch/error.rb
+- lib/twitch/error_generator.rb
 - lib/twitch/oauth.rb
 - lib/twitch/object.rb
 - lib/twitch/objects/automod_setting.rb
@@ -154,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A Ruby library for interacting with the Twitch Helix API