omniauth-cronofy 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0e963beee307e1ef87bf7bc57d9000a8e25ee4d
-  data.tar.gz: 7dd00cee896904e6b896579381ddf9f85d1e56a9
+  metadata.gz: f67090a55b55a905567850c52f637d06f517e6de
+  data.tar.gz: 7adb93310c05dcba6cdd1427fd1dcd327d2cf5d5
 SHA512:
-  metadata.gz: 342d5d5108bf4c42773f87a03c06200d44b9c64859a9d018a545e9b1a587122d9b9964d290eab9940662d7ecd106123d81d76f428702380190bea2752c20d9fa
-  data.tar.gz: 8875413cdd2af311049dc9d9c1aeb4beb2f5811c62250b89fadfc95b8e1c2d30c3a71277ba0a7c94d2fbbd4a0af58fcabc4e0a267497a958f2bafc61002f1675
+  metadata.gz: a9cf471c625f7179b1ef10caeb209f902557e8ceea357c8964d76e8fae35ccedc14ac3855bfc6f6dd82b003fb217f839137ce566335e7ee16da602f2f891d3fe
+  data.tar.gz: 9fbdd4d4d945104b0a7c30944235a09ebf53d2b3d6db2a0bf16628987ba682281fd20223b4418c940f397803fb6de67f9dbfcc4707aeaba85df7e37db751657f

data/.editorconfig

@@ -0,0 +1,15 @@
+# http://EditorConfig.org
+
+# Top-most EditorConfig file
+root = true
+
+# Defaults
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+
+# Ruby files
+[{Gemfile,*.{rake,rb}]
+indent_size = 2

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in omniauth-cronofy.gemspec
 gemspec
+
+gem 'rack', '~> 1.0'

data/README.md

@@ -2,7 +2,10 @@
 
 Strategy to authenticate with Cronofy via OAuth2 in OmniAuth.
 
-Get your API accesss at: http://www.cronofy.com/developers
+Contains strategies for both [End User authorization](#end-user-authorization)
+and [Service Account authorization](#service-account-authorization).
+
+Get your API accesss at: https://www.cronofy.com/developers
 
 ## Installation
 
@@ -20,7 +23,9 @@ Or install it yourself as:
 
     $ gem install omniauth-cronofy
 
-## Usage
+## End User Authorization
+
+### Usage
 
 Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
 
@@ -34,15 +39,16 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-Then to auth with Cronofy you would navigate to `/auth/cronofy`
+Then to auth with Cronofy you would navigate to `/auth/cronofy`.
 
-## Configuration
+### Configuration
 
 Configurable options
 
-* `scope`: A space-separated list of permissions you want to request from the user. See the [API Authorization documentation](http://www.cronofy.com/developers/api#authorization) for a full list of available permissions.
+* `scope`: A space-separated list of permissions you want to request for the end-user. See the [API Authorization documentation](http://www.cronofy.com/developers/api#authorization) for a full list of available permissions.
+
 
-## Auth Hash
+### Auth Hash
 
 ```ruby
   {
@@ -68,6 +74,65 @@ Configurable options
   }
 ```
 
+
+## Service Account Authorization
+
+### Usage
+
+Service Accounts allow you to use one set of credentials to access an entire organizations calendar service. This works with Google Apps, Office 365 and Exchange.
+
+This can be used alongside standard end-user auth.
+
+Typical configuration.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+
+  provider :cronofy_service_account, ENV["CRONOFY_CLIENT_ID"], ENV["CRONOFY_CLIENT_SECRET"], {
+    scope: "service_account/manage_accounts",
+    delegated_scope: "read_account read_events create_event delete_event"
+  }
+
+end
+```
+
+Then to auth with Cronofy you would navigate to `/auth/cronofy_service_account`.
+
+More information in Service Accounts documentation (link to follow).
+
+### Configuration
+
+Configurable options
+
+* `scope`: A space-separated list of permissions you want to request for the service account. Doc link to follow.
+
+* `delegated_scope` : A space-separated list of permissions you wish to request on the end-user accounts controlled by the Service Account. See the [API Authorization documentation](http://www.cronofy.com/developers/api#authorization) for a full list of available permissions.
+
+### Auth Hash
+
+```ruby
+  {
+    :provider => "cronofy_service_account",
+    :uid => "ser_382374827234",
+    :info => {
+      :domain => "company.com"
+    },
+    :credentials => {
+      :token => "token",
+      :refresh_token => "another_token",
+      :expires_at => 1424884727,
+      :expires => true
+    },
+    :extra => {
+      :raw_info => {
+        :sub = "ser_9324872847",
+        :cronofy.service_account.domain => "company.com",
+        :cronofy.type => "service_account"
+      }
+    }
+  }
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/omniauth-cronofy/fork )

data/lib/omniauth-cronofy.rb

@@ -1,3 +1,5 @@
-require 'omniauth'
+require "omniauth"
+require "omniauth-oauth2"
 require "omniauth-cronofy/version"
-require "omniauth/strategies/cronofy"
+require "omniauth/strategies/cronofy"
+require "omniauth/strategies/cronofy_service_account"

data/lib/omniauth-cronofy/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Cronofy
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'.freeze
   end
 end

data/lib/omniauth/strategies/cronofy.rb

@@ -1,5 +1,3 @@
-require 'omniauth-oauth2'
-
 module OmniAuth
   module Strategies
     class Cronofy < OmniAuth::Strategies::OAuth2

data/lib/omniauth/strategies/cronofy_service_account.rb

@@ -0,0 +1,39 @@
+module OmniAuth
+  module Strategies
+    class CronofyServiceAccount < OmniAuth::Strategies::OAuth2
+      option :name, "cronofy_service_account"
+
+      option :client_options, {
+        :site => ::OmniAuth::Strategies::Cronofy.app_url,
+        :authorize_url => "#{::OmniAuth::Strategies::Cronofy.app_url}/service_accounts/oauth/authorize",
+      }
+
+      def request_phase
+        options[:authorize_params] = { delegated_scope: options[:delegated_scope]} if options[:delegated_scope]
+        super
+      end
+
+      uid{ raw_info['sub'] }
+
+      info do
+        {
+          :domain => raw_info['cronofy.service_account.domain'],
+        }
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info,
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("#{::OmniAuth::Strategies::Cronofy.api_url}/v1/userinfo").parsed
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-cronofy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Adam Bird
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-11 00:00:00.000000000 Z
+date: 2016-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .editorconfig
 - .gitignore
 - .rspec
 - .travis.yml
@@ -87,6 +88,7 @@ files:
 - lib/omniauth-cronofy/version.rb
 - lib/omniauth/.DS_Store
 - lib/omniauth/strategies/cronofy.rb
+- lib/omniauth/strategies/cronofy_service_account.rb
 - omniauth-cronofy.gemspec
 homepage: https://github.com/cronofy/omniauth-cronofy
 licenses: