cognito_idp 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a9f1c7bb9ed725f35658e0b089125a361fbffd5d173758dd740a6e93b205b5
-  data.tar.gz: 72608701acb079b2b2c7e31db55eefd2f40662e7c7f9e293cd34b76af829c808
+  metadata.gz: 2a0542d8f6932dfe48a2201f58c34d426146e5f2fa4325791d3c2290eee95457
+  data.tar.gz: 9c2f55fc02674b9adfc272bd7a2a9b6f51f8a855996abba8050a7ca016decb60
 SHA512:
-  metadata.gz: 8e0bc41343ca5ea94f72c2f1c46253be9b029f27ba162621fc9b4fe1ff9325c796f2079ec64eada55792059621e001e521f88f3b3f72fb993568a17bc24782a3
-  data.tar.gz: bb1f296f9e860c1ef871ddea30927d1d865812860d58650f36adb9a81a5086fc2134573ae03229581c4eeb6825ca69970325da6f00c956404286386608587d9f
+  metadata.gz: 772766ba67bd2fc1e1c74aa9f0f35e5e26396b0edc144fa427fce85609aff2548f28a33b1ce72d25cfc53c8f5277f2fdb3e024695cc8aa8705973ea201072113
+  data.tar.gz: 38d82779c5724c35ba03cae5a45d7b79ee5c51dac6a6c751cb9032fd8750bb48ff51c19b116d9f5fde72198c4ccbe92e0be951cd20af746f00671072765035db

data/CHANGELOG.md

@@ -1,29 +1,55 @@
-# Changelog
 
-## [0.2.0](https://github.com/appercept/cognito_idp-ruby/tree/0.2.0) (2025-11-19)
+<a name="1.0.0"></a>
+## [1.0.0](https://github.com/appercept/cognito_idp-ruby/compare/v0.2.0...1.0.0)
 
-[Full Changelog](https://github.com/appercept/cognito_idp-ruby/compare/v0.1.1...0.2.0)
+> 2026-03-03
 
-**Merged pull requests:**
+### Feat
 
-- feat: Add CognitoIdp::Token\#refresh\_token [\#3](https://github.com/appercept/cognito_idp-ruby/pull/3) ([rhatherall](https://github.com/rhatherall))
+* Add token revocation support
+* Add Token#expired? convenience method
 
-## [v0.1.1](https://github.com/appercept/cognito_idp-ruby/tree/v0.1.1) (2023-12-07)
+### Fix
 
-[Full Changelog](https://github.com/appercept/cognito_idp-ruby/compare/v0.1.0...v0.1.1)
+* Correct logout_uri test calling wrong method
+* Tighten UserInfo and attr mutability
+* Redact secrets and tokens from #inspect
+* Use standard Base64 encoding for Basic Auth (RFC 7617)
+* Raise Error on non-2xx responses
 
-**Fixed bugs:**
+### BREAKING CHANGE
 
-- NoMethodError: undefined method `key?' for OpenStruct [\#1](https://github.com/appercept/cognito_idp-ruby/issues/1)
 
-**Merged pull requests:**
+Methods now raise CognitoIdp::Error instead of
+returning nil on error responses.
 
-- fix: UserInfo always responds to missing [\#2](https://github.com/appercept/cognito_idp-ruby/pull/2) ([rhatherall](https://github.com/rhatherall))
 
-## [v0.1.0](https://github.com/appercept/cognito_idp-ruby/tree/v0.1.0) (2023-12-02)
+<a name="v0.2.0"></a>
+## [v0.2.0](https://github.com/appercept/cognito_idp-ruby/compare/v0.1.1...v0.2.0)
 
-[Full Changelog](https://github.com/appercept/cognito_idp-ruby/compare/6a859f5b15c9989aded52c92af8b99197ec5860d...v0.1.0)
+> 2025-11-19
 
+### Feat
 
+* Add CognitoIdp::Token#refresh_token
+
+### Fix
+
+* Add `base64` dependency
+
+
+<a name="v0.1.1"></a>
+## [v0.1.1](https://github.com/appercept/cognito_idp-ruby/compare/v0.1.0...v0.1.1)
+
+> 2023-12-07
+
+### Fix
+
+* UserInfo always responds to missing
+
+
+<a name="v0.1.0"></a>
+## v0.1.0
+
+> 2023-12-02
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -14,7 +14,125 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+### Client setup
+
+```ruby
+client = CognitoIdp::Client.new(
+  client_id: "your_client_id",
+  domain: "your-domain.auth.eu-west-1.amazoncognito.com",
+  client_secret: "your_client_secret" # optional, depends on app client config
+)
+```
+
+### Authorization URI
+
+Build a URL to redirect users to the Cognito hosted UI:
+
+```ruby
+url = client.authorization_uri(
+  redirect_uri: "https://example.com/auth/callback",
+  scope: %w[openid email profile],
+  state: SecureRandom.hex
+)
+```
+
+PKCE is supported via `code_challenge` and `code_challenge_method`:
+
+```ruby
+url = client.authorization_uri(
+  redirect_uri: "https://example.com/auth/callback",
+  code_challenge: challenge,
+  code_challenge_method: "S256"
+)
+```
+
+### Exchanging an authorization code for tokens
+
+```ruby
+token = client.get_token(
+  grant_type: "authorization_code",
+  code: params[:code],
+  redirect_uri: "https://example.com/auth/callback"
+)
+
+token.access_token  # => "eyJra..."
+token.id_token      # => "eyJra..."
+token.refresh_token # => "eyJjd..."
+token.expires_in    # => 3600
+token.expired?      # => false
+```
+
+With PKCE, pass the `code_verifier`:
+
+```ruby
+token = client.get_token(
+  grant_type: "authorization_code",
+  code: params[:code],
+  redirect_uri: "https://example.com/auth/callback",
+  code_verifier: stored_verifier
+)
+```
+
+### Client credentials
+
+```ruby
+token = client.get_token(
+  grant_type: "client_credentials",
+  scope: "https://api.example.com/orders.read"
+)
+```
+
+### Refreshing tokens
+
+```ruby
+token = client.get_token(
+  grant_type: "refresh_token",
+  refresh_token: token.refresh_token
+)
+```
+
+### User info
+
+Accepts an access token string or a `Token` object:
+
+```ruby
+user_info = client.get_user_info(token)
+
+user_info.sub      # => "248289761001"
+user_info.email    # => "janedoe@example.com"
+user_info.username # => "j.doe"
+```
+
+### Revoking tokens
+
+Revokes a refresh token. Accepts a token string or a `Token` object (which uses its `refresh_token`):
+
+```ruby
+client.revoke_token(token)
+```
+
+### Logout URI
+
+```ruby
+url = client.logout_uri(
+  logout_uri: "https://example.com/signed-out",
+  redirect_uri: "https://example.com/"
+)
+```
+
+### Error handling
+
+All API calls raise `CognitoIdp::Error` on non-2xx responses:
+
+```ruby
+begin
+  client.get_token(grant_type: "authorization_code", code: "expired_code")
+rescue CognitoIdp::Error => e
+  e.error             # => "invalid_grant"
+  e.error_description # => "Authorization code has expired"
+  e.http_status       # => 400
+end
+```
 
 ## Development
 

data/lib/cognito_idp/authorization_uri.rb

@@ -2,7 +2,7 @@
 
 module CognitoIdp
   class AuthorizationUri
-    attr_accessor :client_id, :code_challenge_method, :code_challenge, :domain,
+    attr_reader :client_id, :code_challenge_method, :code_challenge, :domain,
       :idp_identifier, :identity_provider, :nonce, :redirect_uri, :response_type,
       :scope, :state
 

data/lib/cognito_idp/client.rb

@@ -5,7 +5,7 @@ require "faraday"
 
 module CognitoIdp
   class Client
-    attr_accessor :adapter, :client_id, :client_secret, :domain
+    attr_reader :adapter, :client_id, :client_secret, :domain
 
     def initialize(client_id:, domain:, client_secret: nil, adapter: Faraday.default_adapter, stubs: nil)
       @adapter = adapter
@@ -15,6 +15,14 @@ module CognitoIdp
       @stubs = stubs
     end
 
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} " \
+        "@adapter=#{adapter.inspect}, " \
+        "@client_id=#{client_id.inspect}, " \
+        "@client_secret=#{client_secret.nil? ? "nil" : "[REDACTED]"}, " \
+        "@domain=#{domain.inspect}>"
+    end
+
     def authorization_uri(redirect_uri:, **options)
       AuthorizationUri.new(
         client_id: client_id,
@@ -35,7 +43,7 @@ module CognitoIdp
         scope: options[:scope]
       }.compact
       response = connection.post("/oauth2/token", params, basic_authorization_headers)
-      return unless response.success?
+      handle_error_response(response)
 
       token = Token.new(response.body)
       yield(token) if block_given?
@@ -50,13 +58,26 @@ module CognitoIdp
         token
       end
       response = connection.post("/oauth2/userInfo", nil, {"Authorization" => "Bearer #{access_token}"})
-      return unless response.success?
+      handle_error_response(response)
 
       user_info = UserInfo.new(response.body)
       yield(user_info) if block_given?
       user_info
     end
 
+    def revoke_token(token)
+      refresh_token = case token
+      when Token
+        token.refresh_token
+      else
+        token
+      end
+
+      params = {client_id: client_id, token: refresh_token}
+      response = connection.post("/oauth2/revoke", params, basic_authorization_headers)
+      handle_error_response(response)
+    end
+
     def logout_uri(**options)
       LogoutUri.new(
         client_id: client_id,
@@ -76,11 +97,30 @@ module CognitoIdp
       end
     end
 
+    def handle_error_response(response)
+      return if response.success?
+
+      body = response.body
+      if body.is_a?(Hash) && body["error"]
+        raise Error.new(
+          error: body["error"],
+          error_description: body["error_description"],
+          http_status: response.status
+        )
+      else
+        raise Error.new(
+          error: "http_error",
+          error_description: "the server responded with status #{response.status}",
+          http_status: response.status
+        )
+      end
+    end
+
     def basic_authorization_headers
       return if client_secret.nil?
 
       client_id_and_secret = "#{client_id}:#{client_secret}"
-      {"Authorization" => "Basic #{Base64.urlsafe_encode64(client_id_and_secret)}"}
+      {"Authorization" => "Basic #{Base64.strict_encode64(client_id_and_secret)}"}
     end
   end
 end

data/lib/cognito_idp/error.rb

@@ -1,5 +1,22 @@
 # frozen_string_literal: true
 
 module CognitoIdp
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :error, :error_description, :http_status
+
+    def initialize(error:, error_description: nil, http_status: nil)
+      @error = error
+      @error_description = error_description
+      @http_status = http_status
+      super(build_message)
+    end
+
+    private
+
+    def build_message
+      return error if error_description.nil?
+
+      "#{error}: #{error_description}"
+    end
+  end
 end

data/lib/cognito_idp/logout_uri.rb

@@ -2,7 +2,7 @@
 
 module CognitoIdp
   class LogoutUri
-    attr_accessor :client_id, :domain, :logout_uri, :redirect_uri, :response_type, :scope, :state
+    attr_reader :client_id, :domain, :logout_uri, :redirect_uri, :response_type, :scope, :state
 
     def initialize(client_id:, domain:, **options)
       @client_id = client_id

data/lib/cognito_idp/token.rb

@@ -14,5 +14,21 @@ module CognitoIdp
       end
       @expires_at = Time.now + expires_in unless expires_in.nil?
     end
+
+    def expired?
+      return false if expires_at.nil?
+
+      Time.now >= expires_at
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} " \
+        "@access_token=#{access_token.nil? ? "nil" : "[REDACTED]"}, " \
+        "@id_token=#{id_token.nil? ? "nil" : "[REDACTED]"}, " \
+        "@token_type=#{token_type.inspect}, " \
+        "@expires_in=#{expires_in.inspect}, " \
+        "@expires_at=#{expires_at.inspect}, " \
+        "@refresh_token=#{refresh_token.nil? ? "nil" : "[REDACTED]"}>"
+    end
   end
 end

data/lib/cognito_idp/user_info.rb

@@ -14,7 +14,7 @@ module CognitoIdp
     end
 
     def respond_to_missing?(method, include_private = false)
-      true
+      @attributes.respond_to?(method, include_private) || super
     end
   end
 end

data/lib/cognito_idp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CognitoIdp
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/cognito_idp.rb

@@ -5,6 +5,7 @@ require "cognito_idp/version"
 module CognitoIdp
   autoload :AuthorizationUri, "cognito_idp/authorization_uri"
   autoload :Client, "cognito_idp/client"
+  autoload :Error, "cognito_idp/error"
   autoload :LogoutUri, "cognito_idp/logout_uri"
   autoload :Token, "cognito_idp/token"
   autoload :UserInfo, "cognito_idp/user_info"

data/sig/cognito_idp/authorization_uri.rbs

@@ -0,0 +1,25 @@
+module CognitoIdp
+  class AuthorizationUri
+    attr_reader client_id: String
+    attr_reader code_challenge_method: String?
+    attr_reader code_challenge: String?
+    attr_reader domain: String
+    attr_reader idp_identifier: String?
+    attr_reader identity_provider: String?
+    attr_reader nonce: String?
+    attr_reader redirect_uri: String
+    attr_reader response_type: Symbol
+    attr_reader scope: String | Array[String] | nil
+    attr_reader state: String?
+
+    def initialize: (client_id: String, domain: String, redirect_uri: String, ?response_type: Symbol, **untyped) -> void
+
+    def to_s: () -> String
+
+    private
+
+    def params: () -> Hash[Symbol, untyped]
+
+    def scope_string: () -> String?
+  end
+end

data/sig/cognito_idp/client.rbs

@@ -1,6 +1,32 @@
 module CognitoIdp
-  module Client
-    VERSION: String
-    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  class Client
+    attr_reader adapter: Symbol
+    attr_reader client_id: String
+    attr_reader client_secret: String?
+    attr_reader domain: String
+
+    def initialize: (client_id: String, domain: String, ?client_secret: String?, ?adapter: Symbol, ?stubs: untyped) -> void
+
+    def inspect: () -> String
+
+    def authorization_uri: (redirect_uri: String, **untyped) -> String
+
+    def get_token: (grant_type: String | Symbol, **untyped) -> Token
+                 | (grant_type: String | Symbol, **untyped) { (Token) -> void } -> Token
+
+    def get_user_info: (Token | String) -> UserInfo
+                     | (Token | String) { (UserInfo) -> void } -> UserInfo
+
+    def revoke_token: (Token | String) -> void
+
+    def logout_uri: (**untyped) -> String
+
+    private
+
+    def connection: () -> untyped
+
+    def handle_error_response: (untyped) -> void
+
+    def basic_authorization_headers: () -> Hash[String, String]?
   end
 end

data/sig/cognito_idp/error.rbs

@@ -0,0 +1,13 @@
+module CognitoIdp
+  class Error < StandardError
+    attr_reader error: String
+    attr_reader error_description: String?
+    attr_reader http_status: Integer?
+
+    def initialize: (error: String, ?error_description: String?, ?http_status: Integer?) -> void
+
+    private
+
+    def build_message: () -> String
+  end
+end

data/sig/cognito_idp/logout_uri.rbs

@@ -0,0 +1,21 @@
+module CognitoIdp
+  class LogoutUri
+    attr_reader client_id: String
+    attr_reader domain: String
+    attr_reader logout_uri: String?
+    attr_reader redirect_uri: String?
+    attr_reader response_type: Symbol?
+    attr_reader scope: String | Array[String] | nil
+    attr_reader state: String?
+
+    def initialize: (client_id: String, domain: String, **untyped) -> void
+
+    def to_s: () -> String
+
+    private
+
+    def params: () -> Hash[Symbol, untyped]
+
+    def scope_string: () -> String?
+  end
+end

data/sig/cognito_idp/token.rbs

@@ -0,0 +1,16 @@
+module CognitoIdp
+  class Token
+    attr_reader access_token: String?
+    attr_reader id_token: String?
+    attr_reader token_type: String?
+    attr_reader expires_at: Time?
+    attr_reader expires_in: Integer?
+    attr_reader refresh_token: String?
+
+    def initialize: (Hash[String | Symbol, untyped]) -> void
+
+    def expired?: () -> bool
+
+    def inspect: () -> String
+  end
+end

data/sig/cognito_idp/user_info.rbs

@@ -0,0 +1,11 @@
+module CognitoIdp
+  class UserInfo
+    def initialize: (Hash[String | Symbol, untyped]) -> void
+
+    private
+
+    def method_missing: (Symbol, *untyped) -> untyped
+
+    def respond_to_missing?: (Symbol, ?bool) -> bool
+  end
+end

data/sig/cognito_idp.rbs

@@ -0,0 +1,3 @@
+module CognitoIdp
+  VERSION: String
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cognito_idp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Richard Hatherall
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Client for interacting with Amazon Cognito IdP (User Pools) endpoints.
 email:
 - richard@appercept.com
@@ -44,14 +58,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".rubocop.yml"
-- ".standard.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
-- Rakefile
 - lib/cognito_idp.rb
 - lib/cognito_idp/authorization_uri.rb
 - lib/cognito_idp/client.rb
@@ -60,7 +69,13 @@ files:
 - lib/cognito_idp/token.rb
 - lib/cognito_idp/user_info.rb
 - lib/cognito_idp/version.rb
+- sig/cognito_idp.rbs
+- sig/cognito_idp/authorization_uri.rbs
 - sig/cognito_idp/client.rbs
+- sig/cognito_idp/error.rbs
+- sig/cognito_idp/logout_uri.rbs
+- sig/cognito_idp/token.rbs
+- sig/cognito_idp/user_info.rbs
 homepage: https://github.com/appercept/cognito_idp-ruby
 licenses:
 - MIT
@@ -75,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,6 +0,0 @@
----
-inherit_gem:
-  standard: config/base.yml
-
-require:
-  - standard

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 2.6

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at richard@appercept.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "standard/rake"
-
-task default: %i[spec standard]