authlete 1.35.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1ca2366f1b56a10ee44f96cdda940c49c5b1772
-  data.tar.gz: f7793f1df00f17688dff349ffbba4a179cd83894
+  metadata.gz: 8d2d718ade1062d97b214ec5debb8123396f5c38
+  data.tar.gz: f75fc7fb060845b2b393b6a4138f399560d3036b
 SHA512:
-  metadata.gz: 4fd9b5550e4bc4dc2a71ce17eebb404578bc3dd296891c861f526c5cb3283d905c23c6e06afa6a345c4e0697bf4cb37dee209774756db980496b22822d4eef22
-  data.tar.gz: e7615f6229bdf8ff9134a7d2551ca31c3dc40d5cda5391c7a69d6a82ed7df262c506dc120cf6531ee14f9c2406b6bb39faba2420dcb6f0a84fd21b6e56152329
+  metadata.gz: 5e75dede652c6cfc02c515c92cc967ff8dd0b7a48592d4d5cd60c279aae948490dafb1cd14da0489d7054093a5d3901fbe9ee651fde956a9c884bf225c1fcf97
+  data.tar.gz: 0d29883ffc6278a070d77c0ae86b8ed2c46c4c15be7640de9212805b71a5aa2636926c661e43b015ff55dbf3d02b6eed018e66487f8f9bbb82ab22877cac11e6

data/lib/authlete/api.rb

@@ -217,6 +217,12 @@ module Authlete
       Authlete::Model::Response::TokenFailResponse.new(hash)
     end
 
+    def token_revoke(request)
+      hash = call_api_json_service("/api/auth/token/revoke", to_hash(request))
+
+      Authlete::Model::Response::TokenRevokeResponse.new(hash)
+    end
+
     def service_create(service)
       hash = call_api_json_service_owner("/api/service/create", to_hash(service))
 

data/lib/authlete/model/request/token-revoke-request.rb

@@ -0,0 +1,57 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2024 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    module Request
+      class TokenRevokeRequest < Authlete::Model::Request::Base
+
+        attr_accessor :accessTokenIdentifier
+        alias_method  :access_token_identifier, :accessTokenIdentifier
+        alias_method  :access_token_identifier=, :accessTokenIdentifier=
+
+        attr_accessor :clientIdentifier
+        alias_method  :client_identifier, :clientIdentifier
+        alias_method  :client_identifier=, :clientIdentifier=
+
+        attr_accessor :refreshTokenIdentifier
+        alias_method  :refresh_token_identifier, :refreshTokenIdentifier
+        alias_method  :refresh_token_identifier=, :refreshTokenIdentifier=
+
+        attr_accessor :subject
+
+        private
+
+        def defaults
+          {
+            accessTokenIdentifier: nil,
+            clientIdentifier: nil,
+            refreshTokenIdentifier: nil,
+            subject: nil
+          }
+        end
+
+        def set_params(hash)
+          @accessTokenIdentifier = hash[:accessTokenIdentifier]
+          @clientIdentifier = hash[:clientIdentifier]
+          @refreshTokenIdentifier = hash[:refreshTokenIdentifier]
+          @subject = hash[:subject]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/model/response/token-revoke-response.rb

@@ -0,0 +1,41 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2024 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Authlete
+  module Model
+    module Response
+      class TokenRevokeResponse < Authlete::Model::Result
+
+        attr_accessor :count
+
+        private
+
+        def defaults
+          super.merge(
+            count: nil
+          )
+        end
+
+        def set_params(hash)
+          super(hash)
+
+          @count = hash[:count]
+        end
+      end
+    end
+  end
+end

data/lib/authlete/version.rb

@@ -1,6 +1,6 @@
 # :nodoc:
 #
-# Copyright (C) 2014-2022 Authlete, Inc.
+# Copyright (C) 2014-2024 Authlete, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,5 +16,5 @@
 
 
 module Authlete
-  VERSION = "1.35.0"
+  VERSION = "1.36.0"
 end

data/lib/authlete.rb

@@ -70,6 +70,7 @@ module Authlete
       autoload :TokenFailRequest, 'authlete/model/request/token-fail-request'
       autoload :TokenIssueRequest, 'authlete/model/request/token-issue-request'
       autoload :TokenRequest, 'authlete/model/request/token-request'
+      autoload :TokenRevokeRequest, 'authlete/model/request/token-revoke-request'
       autoload :TokenUpdateRequest, 'authlete/model/request/token-update-request'
       autoload :UserInfoIssueRequest, 'authlete/model/request/user-info-issue-request'
       autoload :UserInfoRequest, 'authlete/model/request/user-info-request'
@@ -106,6 +107,7 @@ module Authlete
       autoload :TokenIssueResponse, 'authlete/model/response/token-issue-response'
       autoload :TokenListResponse, 'authlete/model/response/token-list-response'
       autoload :TokenResponse, 'authlete/model/response/token-response'
+      autoload :TokenRevokeResponse, 'authlete/model/response/token-revoke-response'
       autoload :TokenUpdateResponse, 'authlete/model/response/token-update-response'
       autoload :UserInfoIssueResponse, 'authlete/model/response/user-info-issue-response'
       autoload :UserInfoResponse, 'authlete/model/response/user-info-response'

data/test/authlete/model/request/test_token-revoke-request.rb

@@ -0,0 +1,71 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2024 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'authlete'
+require 'minitest/autorun'
+
+
+class TokenRevokeRequestTest < Minitest::Test
+  ACCESS_TOKEN_IDENTIFIER   = '<access-token-identifier>'
+  CLIENT_IDENTIFIER         = '<client-identifier>'
+  REFRESH_TOKEN_IDENTIFIER  = '<refresh-token-identifier>'
+  SUBJECT                   = '<subject>'
+
+
+  def set_params(obj)
+    obj.access_token_identifier   = ACCESS_TOKEN_IDENTIFIER
+    obj.client_identifier         = CLIENT_IDENTIFIER
+    obj.refresh_token_identifier  = REFRESH_TOKEN_IDENTIFIER
+    obj.subject                   = SUBJECT
+  end
+
+
+  def match(obj)
+    assert_equal ACCESS_TOKEN_IDENTIFIER,   obj.access_token_identifier
+    assert_equal CLIENT_IDENTIFIER,         obj.client_identifier
+    assert_equal REFRESH_TOKEN_IDENTIFIER,  obj.refresh_token_identifier
+    assert_equal SUBJECT,                   obj.subject
+  end
+
+
+  def generate_hash
+    {
+      accessTokenIdentifier:  '<access-token-identifier>',
+      clientIdentifier:       '<client-identifier>',
+      refreshTokenIentifier:  '<refresh-token-identifier>',
+      subject:                '<subject>'
+    }
+  end
+
+
+  def test_setters
+    actual = Authlete::Model::Request::TokenRevokeRequest.new
+    set_params(actual)
+
+    match(actual)
+  end
+
+
+  def test_to_hash
+    obj = Authlete::Model::Request::TokenRevokeRequest.new
+    set_params(obj)
+    actual   = obj.to_hash
+    expected = generate_hash
+
+    assert_equal expected, actual
+  end
+end

data/test/authlete/model/response/test_token-revoke-response.rb

@@ -0,0 +1,63 @@
+# :nodoc:
+#
+# Copyright (C) 2014-2024 Authlete, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require 'authlete'
+require 'json'
+require 'minitest/autorun'
+
+
+class TokenRevokeResponseTest < Minitest::Test
+  RESULT_CODE      = '<result-code>'
+  RESULT_MESSAGE   = '<result-message>'
+  COUNT            = 1
+
+  def generate_json
+    return <<~JSON
+      {
+        "resultCode":     "<result-code>",
+        "resultMessage":  "<result-message>",
+        "count":          1
+      }
+    JSON
+  end
+
+
+  def match(obj)
+    assert_equal RESULT_CODE,     obj.resultCode
+    assert_equal RESULT_MESSAGE,  obj.resultMessage
+    assert_equal COUNT,           obj.count
+  end
+
+
+  def test_from_json
+    jsn    = generate_json
+    hsh    = JSON.parse(jsn)
+    actual = Authlete::Model::Response::TokenRevokeResponse.new(hsh)
+
+    match(actual)
+  end
+
+
+  def test_setters
+    actual                  = Authlete::Model::Response::TokenRevokeResponse.new
+    actual.result_code      = RESULT_CODE
+    actual.result_message   = RESULT_MESSAGE
+    actual.count            = COUNT
+
+    match(actual)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: authlete
 version: !ruby/object:Gem::Version
-  version: 1.35.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Takahiko Kawasaki
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -108,6 +108,7 @@ files:
 - lib/authlete/model/request/token-fail-request.rb
 - lib/authlete/model/request/token-issue-request.rb
 - lib/authlete/model/request/token-request.rb
+- lib/authlete/model/request/token-revoke-request.rb
 - lib/authlete/model/request/token-update-request.rb
 - lib/authlete/model/request/user-info-issue-request.rb
 - lib/authlete/model/request/user-info-request.rb
@@ -140,6 +141,7 @@ files:
 - lib/authlete/model/response/token-issue-response.rb
 - lib/authlete/model/response/token-list-response.rb
 - lib/authlete/model/response/token-response.rb
+- lib/authlete/model/response/token-revoke-response.rb
 - lib/authlete/model/response/token-update-response.rb
 - lib/authlete/model/response/user-info-issue-response.rb
 - lib/authlete/model/response/user-info-response.rb
@@ -186,6 +188,7 @@ files:
 - test/authlete/model/request/test_token-fail-request.rb
 - test/authlete/model/request/test_token-issue-request.rb
 - test/authlete/model/request/test_token-request.rb
+- test/authlete/model/request/test_token-revoke-request.rb
 - test/authlete/model/request/test_token-update-request.rb
 - test/authlete/model/request/test_user-info-issue-request.rb
 - test/authlete/model/request/test_user-info-request.rb
@@ -215,6 +218,7 @@ files:
 - test/authlete/model/response/test_token-issue-response.rb
 - test/authlete/model/response/test_token-list-response.rb
 - test/authlete/model/response/test_token-response.rb
+- test/authlete/model/response/test_token-revoke-response.rb
 - test/authlete/model/response/test_token-update-response.rb
 - test/authlete/model/response/test_user-info-issue-response.rb
 - test/authlete/model/response/test_user-info-response.rb
@@ -290,6 +294,7 @@ test_files:
 - test/authlete/model/request/test_token-fail-request.rb
 - test/authlete/model/request/test_token-issue-request.rb
 - test/authlete/model/request/test_token-request.rb
+- test/authlete/model/request/test_token-revoke-request.rb
 - test/authlete/model/request/test_token-update-request.rb
 - test/authlete/model/request/test_user-info-issue-request.rb
 - test/authlete/model/request/test_user-info-request.rb
@@ -319,6 +324,7 @@ test_files:
 - test/authlete/model/response/test_token-issue-response.rb
 - test/authlete/model/response/test_token-list-response.rb
 - test/authlete/model/response/test_token-response.rb
+- test/authlete/model/response/test_token-revoke-response.rb
 - test/authlete/model/response/test_token-update-response.rb
 - test/authlete/model/response/test_user-info-issue-response.rb
 - test/authlete/model/response/test_user-info-response.rb