cronofy 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f76631baac972077d554c5fff801c154f8900a8
-  data.tar.gz: 37b92d85fd99a99f3c1dd3f3415c1a710e9068bf
+  metadata.gz: 45bf57c6a8beff0b87cba2a4f20ce39f2d346c08
+  data.tar.gz: b44a0e902fdce56a5235777245da5401732c7e06
 SHA512:
-  metadata.gz: 4772a5a044101e1bd461ca0c72b893faa0a5b32f19f0a6f1c1291fb1f5f205f6831aee20f4aca2dab175b4dfa942e2d5e11e66668b0be0a4079c1cf75e86ac06
-  data.tar.gz: 7b0c9c0e2b33f13c99526a325546f25a0f0735bba2a739f3b827e7a3655a1d17b7d756f72c0a08df4be9a973a4bab3c3fe6849f6e7bedd72258d9038ca2cd675
+  metadata.gz: 1c9b7b89e732c1d5f2549e7490cdee7868fd8843b1fbe52dcda029452efad15aa201ed18a7fd2b3b21359a10e3d8beaa5e32754e530356264ded15bede98c491
+  data.tar.gz: 27595f37ddb805069debcd433fa7c72aac23d6914dea8ccc57260b8ea4af28bfdcf44b4ff08d1d59bfddb60c38f9d0831ce9e308f87749c287b1108449559f8e

data/lib/cronofy/auth.rb

@@ -12,7 +12,7 @@ module Cronofy
       set_access_token(token, refresh_token) if token
     end
 
-    # Public: generate a URL for authorizing the application with Cronofy
+    # Internal: generate a URL for authorizing the application with Cronofy
     #
     # redirect_uri    String, the URI to return to after authorization
     # scope           Array of String, the scope requested
@@ -31,7 +31,7 @@ module Cronofy
       end
     end
 
-    # Public: Refreshes the access token
+    # Internal: Refreshes the access token
     # Returns Hash of token elements to allow client to update in local store for user
     def refresh!
       do_request do
@@ -48,6 +48,22 @@ module Cronofy
       @access_token = OAuth2::AccessToken.new(@api_client, token, refresh_token: refresh_token)
     end
 
+    # Internal: Revokes the refresh token and corresponding access tokens.
+    #
+    # Returns nothing.
+    def revoke!
+      do_request do
+        body = {
+          client_id: @api_client.id,
+          client_secret: @api_client.secret,
+          token: access_token.refresh_token,
+        }
+
+        @api_client.request(:post, "/oauth/token/revoke", body: body)
+        @access_token = nil
+      end
+    end
+
     private
 
     def do_request(&block)

data/lib/cronofy/client.rb

@@ -133,6 +133,9 @@ module Cronofy
     #           :last_modified   - The Time that events must be modified on or
     #                              after in order to be returned (optional).
     #
+    # The first page will be retrieved eagerly so that common errors will happen
+    # inline. However, subsequent pages (if any) will be requested lazily.
+    #
     # See http://www.cronofy.com/developers/api#read-events for reference.
     #
     # Returns a lazily-evaluated Enumerable of Events
@@ -187,8 +190,7 @@ module Cronofy
     #
     # callback_url - A String specifing the callback URL for the channel.
     #
-    # See http://www.cronofy.com/developers/api/alpha#create-channel for
-    # reference.
+    # See http://www.cronofy.com/developers/api#create-channel for reference.
     #
     # Returns a Channel.
     #
@@ -208,8 +210,7 @@ module Cronofy
 
     # Public: Lists all the notification channels for the account.
     #
-    # See http://www.cronofy.com/developers/api/alpha#list-channels for
-    # reference.
+    # See http://www.cronofy.com/developers/api#list-channels for reference.
     #
     # Returns an Array of Channels.
     #
@@ -229,6 +230,8 @@ module Cronofy
     #
     # channel_id - The String Cronofy ID for the channel to close.
     #
+    # See http://www.cronofy.com/developers/api#close-channel for reference.
+    #
     # Returns nothing.
     #
     # Raises Cronofy::CredentialsMissingError if no credentials available.
@@ -315,6 +318,22 @@ module Cronofy
       @auth.refresh!
     end
 
+    # Public: Revokes the account's refresh token and access token.
+    #
+    # After making this call the Client will become unusable. You should also
+    # delete the stored credentials used to create this instance.
+    #
+    # See http://www.cronofy.com/developers/api#revoke-authorization for
+    # reference.
+    #
+    # Returns nothing.
+    #
+    # Raises Cronofy::AuthenticationFailureError if the client ID and secret are
+    # not valid.
+    def revoke_authorization
+      @auth.revoke!
+    end
+
     private
 
     READ_EVENTS_DEFAULT_PARAMS = { tzid: "Etc/UTC" }.freeze
@@ -385,10 +404,11 @@ module Cronofy
         @access_token = access_token
         @url = url
         @params = params
+        @first_page = get_page(url, params)
       end
 
       def each
-        page = get_page(url, params)
+        page = @first_page
 
         page.events.each do |event|
           yield event

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/spec/lib/cronofy/auth_spec.rb

@@ -120,4 +120,40 @@ describe Cronofy::Auth do
 
     it_behaves_like 'an authorization request'
   end
+
+  describe "#revoke!" do
+    let(:auth) do
+      Cronofy::Auth.new(client_id, client_secret, access_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: refresh_token,
+          },
+          headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded',
+            'User-Agent' => "Cronofy Ruby #{Cronofy::VERSION}",
+          }
+        )
+        .to_return(
+          status: response_status,
+        )
+    end
+
+    before do
+      auth.revoke!
+    end
+
+    it "unsets the access token" do
+      expect(auth.access_token).to be_nil
+    end
+
+    it "makes the revocation request" do
+      expect(revocation_request).to have_been_requested
+    end
+  end
 end

data/spec/lib/cronofy/client_spec.rb

@@ -396,6 +396,17 @@ describe Cronofy::Client do
           expect(subject).to eq(first_event)
         end
       end
+
+      context "without calling #to_a to force full evaluation" do
+        subject { client.read_events(params) }
+
+        it_behaves_like 'a Cronofy request'
+
+        # We expect it to behave like a Cronofy request as the first page is
+        # requested eagerly so that the majority of errors will happen inline
+        # rather than lazily happening wherever the iterator may have been
+        # passed.
+      end
     end
 
     describe '#delete_event' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2