wotc 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b0635ac8c0081337f768aa467b607644558c050773cc5953ffcc0ce0e1090cd
-  data.tar.gz: d8a2babb3e7ff987f011f9c303d59e174e30e93218b583ca8908e9ec759e0254
+  metadata.gz: 5e1dc3eee513b938983d7d4068e6886e885f46741067ed4b46ec2a39c3766f09
+  data.tar.gz: 17408d0f062dd9a0a771afcc763af24d031cc08d59f79ae30f827cd03333f3a5
 SHA512:
-  metadata.gz: 4170f8d7b6a117d094edd7eafbc8b69f8c5ca64a4ad723a40ab4db5c67eed93df0ca14f0e8689693dd678ef16df86e998a10d81b8b3a3b08d3b27d0fde0a05e4
-  data.tar.gz: b25ec62029a92c2248bbfac4da3d9571287b3aacaf991b472c2b972817d4455e131ea36465de88ab8d6c4609584e61eb2eef98ed8dcfb59b187aa0cdf3fcb4f7
+  metadata.gz: 6d448a43e5cc6bf75f4d54d9be6e4e8e6e44b45459a8155d1856efb93b26efaa1c68804040a7bdb811d0401b16ef60c8735a044d368e8f10de437cd5014f58e4
+  data.tar.gz: 4aff0246f7f5b6b5d8faca647238b0d86f0448ff71142b4844c448b63c50674d4aa79ce1d54ebc9e701198556dd7ddc7d955b59e9de6b2b16a9511f1d8b6f9a8

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Test
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          # Matches the consuming backend's Ruby.
+          ruby-version: '3.0.4'
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 0.1.15 (unreleased)
+
+- Every 4xx and 5xx from wotc.com now raises. Named statuses get their own
+  class (403 → `WOTC::Forbidden`, 422 → `WOTC::UnprocessableEntity`,
+  429 → `WOTC::TooManyRequests`); anything unnamed raises `WOTC::ClientError`
+  or `WOTC::ServerError`. Previously a 403 — and any status without a `case`
+  arm — passed through as if the request had succeeded, which is how a 403
+  came to look like a revoked token (WS-50887). All new classes subclass
+  `WOTC::Error`, so existing rescues still catch them.
+- New: `WOTC::Client#token_state` → `:valid` / `:revoked` / `:unknown`.
+  Only a 401 means `:revoked`; a 403, a 5xx, a timeout or an unreadable body
+  is `:unknown` and must not be treated as revocation. `token_valid?` is kept
+  for compatibility and now delegates to `token_state`, collapsing `:revoked`
+  and `:unknown` into the same `false`.
+- `WOTC::MissingRequiredArgument` now subclasses `StandardError` and takes a
+  plain message; it previously inherited `Error#initialize(response)` and
+  crashed at the raise site.
+- Auth header set via the `request :authorization` middleware instead of the
+  deprecated `Connection#authorization` (silences the per-request warning;
+  faraday `>= 1.8` now required). Dropped an unused `require 'base64'` that
+  triggered the Ruby 3.4 default-gem warning.
+
+## 0.1.14 (2026-03-16)
+
+- Error middleware handles `Faraday::Response` correctly. Before this, every
+  raise from the middleware crashed with `NoMethodError` on `Faraday::Env`,
+  so no typed `WOTC::*` error had ever reached a caller.
+
+## 0.1.13 and earlier
+
+- Untracked.

data/lib/faraday/raise_http_exception.rb

@@ -7,24 +7,33 @@ module FaradayMiddleWare
     end
 
     def call(env)
-      @app.call(env).on_complete do |response|
-        case response.status.to_i
-        when 400
-          raise WOTC::BadRequest.new(response)
-        when 401
-          raise WOTC::Unauthorized.new(response)
-        when 404
-          raise WOTC::NotFound.new(response)
-        when 500
-          raise WOTC::InternalServerError.new(response)
-        when 502
-          raise WOTC::BadGateway.new(response)
-        when 503
-          raise WOTC::ServiceUnavailable.new(response)
-        when 504
-          raise WOTC::GatewayTimeout.new(response)
-        end
+      response = @app.call(env)
+      response.on_complete do |_env|
+        error = error_class(response.status.to_i)
+        raise error.new(response) if error
+      end
+    end
+
+    private
+
+    # Every 4xx and 5xx raises. The named statuses get their own class; anything
+    # else falls back to ClientError or ServerError, so a status we have not
+    # thought about can never be mistaken for a successful response.
+    def error_class(status)
+      case status
+      when 400 then WOTC::BadRequest
+      when 401 then WOTC::Unauthorized
+      when 403 then WOTC::Forbidden
+      when 404 then WOTC::NotFound
+      when 422 then WOTC::UnprocessableEntity
+      when 429 then WOTC::TooManyRequests
+      when 500 then WOTC::InternalServerError
+      when 502 then WOTC::BadGateway
+      when 503 then WOTC::ServiceUnavailable
+      when 504 then WOTC::GatewayTimeout
+      when 400..499 then WOTC::ClientError
+      when 500..599 then WOTC::ServerError
       end
     end
   end
-end
+end

data/lib/wotc/client/utils.rb

@@ -3,14 +3,30 @@ module WOTC
     # Defines methods related to utils
     module Utils
 
-      # Trigger an api call to verify access_token is valid.
+      # Ask wotc.com whether our access token is still accepted.
+      #
+      # Returns :valid, :revoked or :unknown.
+      #
+      # Only a 401 means revoked. A 403, a 5xx, a timeout or a body we cannot
+      # read means we could not tell, and callers must not treat that as
+      # revocation.
+      def token_state
+        body = get('user').body
+        return :valid if body.is_a?(Hash) && !body['id'].nil?
+
+        :unknown
+      rescue WOTC::Unauthorized
+        :revoked
+      rescue StandardError
+        :unknown
+      end
+
+      # Kept for compatibility. Prefer #token_state: this collapses "revoked"
+      # and "could not tell" into the same false.
       def token_valid?
-        user = get('user').body
-        return true if user&.fetch("id")
-      rescue => e
-        return false
+        token_state == :valid
       end
-      
+
       # Pre-qualify an application of WOTC status
       def wotc_calculator(options={})
         result = post('wotc/calculator', options)
@@ -18,4 +34,4 @@ module WOTC
       end
     end
   end
-end
+end

data/lib/wotc/connection.rb

@@ -17,7 +17,9 @@ module WOTC
       }.merge(connection_options)
 
       Faraday::Connection.new(options) do |conn|
-        conn.authorization :Bearer, access_token
+        # Faraday 1.8+ middleware form; Connection#authorization is deprecated
+        # and removed in Faraday 2.0.
+        conn.request :authorization, :Bearer, access_token
         # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
         conn.options[:timeout] = timeout 
         conn.options[:open_timeout] = open_timeout 

data/lib/wotc/error.rb

@@ -4,21 +4,27 @@ module WOTC
     attr_reader :http_method, :url, :errors
 
     def initialize(response)
-      super
       @response = response.dup
-      @http_method = response.env.method.to_s
-      @url = response.env.url
-      if response.body.is_a?(Hash) && !response.body.empty? && !response.body.fetch("errors", nil).nil?
-        @raw_errors = response.body.fetch("errors")
+      env = response.env
+      # Use hash-style access for :method to avoid calling Kernel#method.
+      # Plain Ruby only: this gem does not depend on ActiveSupport.
+      http_method = env[:method].to_s.upcase
+      @http_method = http_method.empty? ? "UNKNOWN" : http_method
+      @url = env.url.to_s
+      @status = response.status
+      @body = response.body
+      if @body.is_a?(Hash) && !@body.empty? && !@body.fetch("errors", nil).nil?
+        @raw_errors = @body.fetch("errors")
       end
+      super()
     end
 
     def message
       <<-HEREDOC
       URL: #{@url}
       method: #{@http_method}
-      response status: #{@response.status}
-      response body: #{@response.body}
+      response status: #{@status}
+      response body: #{@body}
       HEREDOC
     end
 
@@ -38,27 +44,47 @@ module WOTC
     end
   end
 
+  # Any 4xx we do not name below. Our request was not accepted.
+  class ClientError < Error; end
+
+  # Any 5xx we do not name below. wotc.com could not answer. Retryable.
+  class ServerError < Error; end
+
   # Raised when wotc.com returns the HTTP status code 400
-  class BadRequest < Error; end
+  class BadRequest < ClientError; end
+
+  # Raised when wotc.com returns the HTTP status code 401. This is the only
+  # status that means our access token was rejected.
+  class Unauthorized < ClientError; end
 
-  # Raised when wotc.com returns the HTTP status code 401
-  class Unauthorized < Error; end
+  # Raised when wotc.com returns the HTTP status code 403. Distinct from 401:
+  # the token authenticated, the action was refused, often because the resource
+  # does not exist or does not belong to this account.
+  class Forbidden < ClientError; end
 
   # Raised when wotc.com returns the HTTP status code 404
-  class NotFound < Error; end
+  class NotFound < ClientError; end
+
+  # Raised when wotc.com returns the HTTP status code 422
+  class UnprocessableEntity < ClientError; end
+
+  # Raised when wotc.com returns the HTTP status code 429
+  class TooManyRequests < ClientError; end
 
   # Raised when wotc.com returns the HTTP status code 500
-  class InternalServerError < Error; end
+  class InternalServerError < ServerError; end
 
   # Raised when wotc.com returns the HTTP status code 502
-  class BadGateway < Error; end
+  class BadGateway < ServerError; end
 
   # Raised when wotc.com returns the HTTP status code 503
-  class ServiceUnavailable < Error; end
+  class ServiceUnavailable < ServerError; end
 
   # Raised when wotc.com returns the HTTP status code 504
-  class GatewayTimeout < Error; end
+  class GatewayTimeout < ServerError; end
 
-  # Raised when client fails to provide required parameters.
-  class MissingRequiredArgument < Error; end
+  # Raised when client code fails to provide required parameters — before any
+  # HTTP request exists. Unlike every class above it carries a plain message,
+  # not a Faraday::Response, so it cannot inherit Error#initialize.
+  class MissingRequiredArgument < StandardError; end
 end

data/lib/wotc/request.rb

@@ -1,5 +1,3 @@
-require 'base64'
-
 module WOTC
   # Defines HTTP request methods
   module Request

data/lib/wotc/version.rb

@@ -1,3 +1,3 @@
 module WOTC
-  VERSION = '0.1.13'
+  VERSION = '0.1.15'
 end

data/wotc.gemspec

@@ -40,7 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", ">= 3.9.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "webmock"
-  spec.add_runtime_dependency 'faraday'
+  # >= 1.8 for the unified `request :authorization` middleware.
+  spec.add_runtime_dependency 'faraday', '>= 1.8'
   spec.add_runtime_dependency 'faraday_middleware'
   spec.add_runtime_dependency 'addressable'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wotc
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - workstream.us
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-26 00:00:00.000000000 Z
+date: 2026-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -129,8 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rakeTasks"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -183,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.20
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for wotc.com APIs