cronofy 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e337b294d628d5677d58763c49dd46441d66edcf
-  data.tar.gz: 7ad6ea54a3fd5cba4b43f7f2533368574fa1639e
+  metadata.gz: e0de9ce12744013f0db7eb1dccbe156fc28451b1
+  data.tar.gz: 63f12bd7138884230847c5fb9797f135ca01232d
 SHA512:
-  metadata.gz: ae50423467418330fbe878fbf70fbb2e8547c69e17b94858b0d66e1c9e700d0e54d1c827fbdb2abb16f7aa796f5ad5c8d81d3878d742266858051918c508dd76
-  data.tar.gz: 747e9ef78b0da42569496a3ff48ebdce4213be8848dc1a8332cd1c4d507e419fd23c5c8c057f49b08b6a055cae017a22d31ee7f7407422abefea714edb3d8dca
+  metadata.gz: 4f0e9d054650efa325932f5986cff49bd00b91b56edcd38bb2428675b097ce1278e53e4d7ed8f91848a59677ae1e459a2f146b40561f8cb341ae31abe87cda37
+  data.tar.gz: 870cf96a3fca25d8da9d73d3da16363e1f52d1a9b09a84c4bdc490557abe8bf60277f0fb3b74ffe568abc09595db87d63231af208cde2bb06849712ed1f24f6f

data/lib/cronofy/client.rb

@@ -401,6 +401,54 @@ module Cronofy
       parse_collection(Profile, "profiles", response)
     end
 
+    # Public: Retrieves the userinfo for the account
+    #
+    # See  http://openid.net/specs/openid-connect-core-1_0.html#UserInfo for
+    # reference.
+    #
+    # Returns an UserInfo.
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::AuthenticationFailureError if the access token is no
+    # longer valid.
+    # Raises Cronofy::AuthorizationFailureError if the access token does not
+    # include the required scope.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def userinfo
+      response = get("/v1/userinfo")
+      parse_json(UserInfo, nil, response)
+    end
+
+    # Public: Attempts to authorize the email with impersonation from a service
+    # account
+    #
+    # email - the email address to impersonate
+    # scope - Array or String of scopes describing the access to
+    #         request from the user to the users calendars (required).
+    # callback_url - the url to callback to
+    #
+    # Returns nothing
+    #
+    # Raises Cronofy::CredentialsMissingError if no credentials available.
+    # Raises Cronofy::AuthenticationFailureError if the access token is no
+    # longer valid.
+    # Raises Cronofy::TooManyRequestsError if the request exceeds the rate
+    # limits for the application.
+    def authorize_with_service_account(email, scope, callback_url)
+      if scope.respond_to?(:join)
+        scope = scope.join(' ')
+      end
+
+      params = {
+        email: email,
+        scope: scope,
+        callback_url: callback_url
+      }
+      post("/v1/service_account_authorizations", params)
+      nil
+    end
+
     # Public: Generates a URL to send the user to in order to perform the OAuth
     # 2.0 authorization process.
     #
@@ -477,6 +525,40 @@ module Cronofy
       @auth.revoke!
     end
 
+    # Public: Requests elevated permissions for a set of calendars.
+    #
+    # args - A Hash of options used to initialize the request (default: {}):
+    #        :permissions  - An Array of calendar permission hashes to set on
+    #                        the each hash must contain symbols for both
+    #                        `calendar_id` and `permission_level`
+    #        :redirect_uri - A uri to redirect the end user back to after they
+    #                        have either granted or rejected the request for
+    #                        elevated permission.
+    #
+    # In the case of normal accounts:
+    # After making this call the end user will have to grant the extended
+    # permissions to their calendar via rhe url returned from the response.
+    #
+    # In the case of service accounts:
+    # After making this call the exteneded permissions will be granted provided
+    # the relevant scope has been granted to the account
+    #
+    # Returns a extended permissions response.
+    #
+    # Raises Cronofy::AuthenticationFailureError if the client ID and secret are
+    # not valid.
+    def elevated_permissions(args = {})
+      filtered_permissions = args[:permissions].map do |permission|
+        { calendar_id: permission[:calendar_id], permission_level: permission[:permission_level] }
+      end
+
+      body = { permissions: filtered_permissions }
+      body[:redirect_uri] = args[:redirect_uri] if args[:redirect_uri]
+
+      response = post("/v1/permissions", body)
+      parse_json(PermissionsResponse, "permissions_request", response)
+    end
+
     private
 
     FREE_BUSY_DEFAULT_PARAMS = { tzid: "Etc/UTC" }.freeze

data/lib/cronofy/types.rb

@@ -187,6 +187,9 @@ module Cronofy
   class Account < Hashie::Mash
   end
 
+  class UserInfo < Hashie::Mash
+  end
+
   class Calendar < Hashie::Mash
   end
 
@@ -269,4 +272,7 @@ module Cronofy
 
   class Profile < Hashie::Mash
   end
+
+  class PermissionsResponse < Hashie::Mash
+  end
 end

data/lib/cronofy/version.rb

@@ -1,3 +1,3 @@
 module Cronofy
-  VERSION = "0.10.0".freeze
+  VERSION = "0.11.0".freeze
 end

data/spec/lib/cronofy/client_spec.rb

@@ -541,6 +541,23 @@ describe Cronofy::Client do
     end
   end
 
+  describe 'Service Account impersonation' do
+    let(:calendar_id) { 'calendar_id_123'}
+    let(:request_url) { "https://api.cronofy.com/v1/service_account_authorizations" }
+    let(:method) { :post }
+    let(:request_headers) { json_request_headers }
+    let(:request_body) { { email: email, scope: scope.join(' '), callback_url: callback_url } }
+    let(:correct_response_code) { 202 }
+    let(:correct_response_body) { nil }
+    let(:email) { "foo@example.com" }
+    let(:scope) { ['foo', 'bar'] }
+    let(:callback_url) { "http://example.com/not_found" }
+
+    subject { client.authorize_with_service_account(email, scope, callback_url) }
+
+    it_behaves_like 'a Cronofy request'
+  end
+
   describe 'Channels' do
     let(:request_url) { 'https://api.cronofy.com/v1/channels' }
 
@@ -645,6 +662,71 @@ describe Cronofy::Client do
     end
   end
 
+  describe "ElevatedPermissions" do
+
+    describe '#elevated_permissions' do
+      let(:method) { :post }
+      let(:request_url) { "https://api.cronofy.com/v1/permissions" }
+
+      let(:correct_response_code) { 202 }
+
+      let(:redirect_uri) { "http://www.example.com/redirect" }
+      let(:permissions) do
+        [
+          {
+            calendar_id: "cal_1234567",
+            permission_level: "unrestricted"
+          },
+          {
+            calendar_id: "cal_1234453",
+            permission_level: "sandbox"
+          }
+        ]
+      end
+
+      let(:request_body) do
+        {
+          permissions: permissions,
+          redirect_uri: redirect_uri,
+        }
+      end
+
+      let(:correct_mapped_result) do
+        Cronofy::PermissionsResponse.new(correct_response_body[:permissions_request])
+      end
+
+      describe "with uri supplied" do
+        let(:correct_response_body) do
+          {
+            permissions_request: {
+              url: "http://app.cronofy.com/permissions/"
+            }
+          }
+        end
+
+        subject { client.elevated_permissions(permissions: permissions, redirect_uri: redirect_uri) }
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+
+      describe "without uri supplied" do
+        let(:correct_response_body) do
+          {
+            permissions_request: {
+              accepted: true
+            }
+          }
+        end
+
+        subject { client.elevated_permissions(permissions: permissions, redirect_uri: redirect_uri) }
+
+        it_behaves_like 'a Cronofy request'
+        it_behaves_like 'a Cronofy request with mapped return value'
+      end
+    end
+  end
+
   describe "Account" do
     let(:request_url) { "https://api.cronofy.com/v1/account" }
 
@@ -672,6 +754,32 @@ describe Cronofy::Client do
     end
   end
 
+  describe "Userinfo" do
+    let(:request_url) { "https://api.cronofy.com/v1/userinfo" }
+
+    describe "#userinfo" do
+      let(:method) { :get }
+
+      let(:correct_response_code) { 200 }
+      let(:correct_response_body) do
+        {
+          "sub" => "ser_5700a00eb0ccd07000000000",
+          "cronofy.type" => "service_account",
+          "cronofy.service_account.domain" => "example.com"
+        }
+      end
+
+      let(:correct_mapped_result) do
+        Cronofy::UserInfo.new(correct_response_body)
+      end
+
+      subject { client.userinfo }
+
+      it_behaves_like "a Cronofy request"
+      it_behaves_like "a Cronofy request with mapped return value"
+    end
+  end
+
   describe 'Profiles' do
     let(:request_url) { 'https://api.cronofy.com/v1/profiles' }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cronofy
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Sergii Paryzhskyi
@@ -15,90 +15,90 @@ dependencies:
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
 description: Ruby wrapper for Cronofy's unified calendar API
@@ -138,17 +138,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: Cronofy - one API for all the calendars
@@ -160,3 +160,4 @@ test_files:
 - spec/lib/cronofy/event_spec.rb
 - spec/response_parser_spec.rb
 - spec/spec_helper.rb
+has_rdoc: