cronofy 0.36.1 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f05693cffaf2848f4ff1d8dbc874ca832a04a13670ab5c30219a4927e04d0d4b
-  data.tar.gz: cdbd7c8463b2ae594d7fce826343e453c1099d2f603fd267c0e2b9e1cb98e145
+  metadata.gz: 308d390e34e9ed071119e343cc32f18121ddcff2328fbc945b3a785e64550676
+  data.tar.gz: 2ab98066dd1c8eeef0d44a4ddef32f49945edd2d4b84c16d7f5607bbbb54220a
 SHA512:
-  metadata.gz: 44018884d14fe47332fe1e5fca9754ef1357005d9643fb91960886a04d20afec8670a8e340a36ed19b5fb4e04a6e7e02454b48a959474d46f9985998e7079d77
-  data.tar.gz: eca3eb5a85e980ebd72d3416b48b945d6f0dfb832cf63ad8baf7c0cecf3b4429b5682ea69ea9a41b93ad08f498228f7e901f84941a2e6f0e784cfdc444b2b192
+  metadata.gz: c61c10c546d52fee5d4af2ed2030f33a477d0b79cce98c89eb977e76cb9a1918250a00cf4fa1d74b2a35eb044da6ba338f504d6427b07173386c542dae48af97
+  data.tar.gz: 844a546be5ef240ebb964e72926363eedf023bc05ce05bfa95e5af7b1adc8bfbef18a53b1415cec348b370367ec322e5513b7330622753b29b350c1ec046fa67

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## [0.37.0]
+
+ * Add `revoke_by_token` and `revoke_by_sub` to the Client [#86] 
+
 ## [0.36.1]
 
-* Loosen the version requirement on Hashie to allow 4.X
+ * Loosen the version requirement on Hashie to allow 4.X
 
 ## [0.36.0]
 
@@ -172,6 +176,7 @@
 [0.35.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.35.0
 [0.36.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.36.0
 [0.36.1]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.36.1
+[0.37.0]: https://github.com/cronofy/cronofy-ruby/releases/tag/v0.37.0
 
 [#13]: https://github.com/cronofy/cronofy-ruby/pull/13
 [#16]: https://github.com/cronofy/cronofy-ruby/pull/16
@@ -213,3 +218,4 @@
 [#77]: https://github.com/cronofy/cronofy-ruby/pull/77
 [#81]: https://github.com/cronofy/cronofy-ruby/pull/81
 [#85]: https://github.com/cronofy/cronofy-ruby/pull/85
+[#86]: https://github.com/cronofy/cronofy-ruby/pull/86

data/lib/cronofy/auth.rb

@@ -118,20 +118,50 @@ module Cronofy
     def revoke!
       raise CredentialsMissingError.new("No credentials to revoke") unless access_token
 
+      token = access_token.refresh_token || access_token.token
+      revoke_by_token(token)
+      @access_token = nil
+    end
+
+    # Internal: Revokes an authorization by the sub
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    def revoke_by_sub(sub)
+      do_revoke(sub: sub)
+    end
+
+    # Internal: Revokes an authorization via the token
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    def revoke_by_token(token)
+      do_revoke(token: token)
+    end
+
+    private
+
+    def do_revoke(token: nil, sub: nil)
+      raise CredentialsMissingError.new("No credentials to revoke") unless token || sub
+
       do_request do
         body = {
           client_id: @api_client.id,
           client_secret: @api_client.secret,
-          token: access_token.refresh_token || access_token.token,
         }
 
+        if token
+          body.merge!(token: token)
+        else
+          body.merge!(sub: sub)
+        end
+
         @api_client.request(:post, "/oauth/token/revoke", body: body)
-        @access_token = nil
       end
     end
 
-    private
-
     def do_request(&block)
       if @client_credentials_missing
         raise CredentialsMissingError.new("OAuth client_id and client_secret must be set")

data/lib/cronofy/client.rb

@@ -737,6 +737,14 @@ module Cronofy
       @auth.revoke!
     end
 
+    def revoke_by_sub(sub)
+      @auth.revoke_by_sub(sub)
+    end
+
+    def revoke_by_token(token)
+      @auth.revoke_by_token(token)
+    end
+
     # Public: Requests elevated permissions for a set of calendars.
     #
     # args - A Hash of options used to initialize the request (default: {}):

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.36.1".freeze
+  VERSION = "0.37.0".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -476,4 +476,84 @@ describe Cronofy::Auth do
       end
     end
   end
+
+  describe "#revoke_by_sub" do
+    let(:auth) do
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token,
+        refresh_token: refresh_token,
+      )
+    end
+
+    let!(:revocation_request) do
+      stub_request(:post, "https://api.cronofy.com/oauth/token/revoke")
+        .with(
+          body: {
+            client_id: client_id,
+            client_secret: client_secret,
+            sub: sub,
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'User-Agent' => "Cronofy Ruby #{Cronofy::VERSION}",
+          }
+        ).to_return(status: response_status)
+    end
+
+    let(:sub) { "random_sub_value" }
+
+    before do
+      auth.revoke_by_sub(sub)
+    end
+
+    it "does not unset the access token for the current auth" do
+      expect(auth.access_token).not_to be_nil
+    end
+
+    it "makes the revocation request" do
+      expect(revocation_request).to have_been_requested
+    end
+  end
+
+  describe "#revoke_by_token" do
+    let(:auth) do
+      Cronofy::Auth.new(
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token,
+        refresh_token: refresh_token,
+      )
+    end
+
+    let!(:revocation_request) do
+      stub_request(:post, "https://api.cronofy.com/oauth/token/revoke")
+        .with(
+          body: {
+            client_id: client_id,
+            client_secret: client_secret,
+            token: token,
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'User-Agent' => "Cronofy Ruby #{Cronofy::VERSION}",
+          }
+        ).to_return(status: response_status)
+    end
+
+    let(:token) { "random_token_value" }
+
+    before do
+      auth.revoke_by_token(token)
+    end
+
+    it "does not unset the access token for the current auth" do
+      expect(auth.access_token).not_to be_nil
+    end
+
+    it "makes the revocation request" do
+      expect(revocation_request).to have_been_requested
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.36.1
+  version: 0.37.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: Cronofy - one API for all the calendars