omniauth-zimbraadmin 0.0.3.3 → 0.0.3.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdea3f0e3115ccf48af1f2c8f213406f265f1841
-  data.tar.gz: 514fe34e663ecdc0d412b1f0d03ba19cf1184e1c
+  metadata.gz: 6302a7098ae528cdd6e2cc9e24b4faf2f5a9d034
+  data.tar.gz: 80b381e1e2a38b4a25a260fbe46c585f9d92c4cf
 SHA512:
-  metadata.gz: 68fc79a9c4fe862a9c844cc0b1c8c3f1d96f9bcf8d5dc495f842a3d32d5a0b396ab3dfebaf1b4de3491d72b7b4a7d5133c1395caa33fb43115c494a150f9e9be
-  data.tar.gz: e240f2be30df92bd0202eac377d2323277784f437012521a2724b68668f7e483255b8e910184b5d6fdd0fce6d15b7b556e35b628d5712cc880dc91eaa65d9f9b
+  metadata.gz: aed9841d02b29cc6789147dbc9aadb91bb181a7c74f42aee8cba72ac36ab9ec0181cce30d6f85269e79a9f2c3b63928653af6ca7a51d288dc6e63669495eae99
+  data.tar.gz: 77265213f8e7eec8b9ecf35e6f8168f35ad3bc31ce1f71a5e71e175cd16bdcf99b3db523326f353fe517d655d24b4545a31a8f94034cfc1123e42e4a4fd39185

data/README.md

@@ -1,24 +1,54 @@
-# Omniauth::Zimbra
+# Omniauth::ZimbraAdmin
 
-TODO: Write a gem description
+OmniAuth strategy for authenticate against a [Zimbra Server](http://www.zimbra.com) as a `Global` or `Domain` admin using the [SOAP Api](https://wiki.zimbra.com/wiki/SOAP_API_Reference_Material_Beginning_with_ZCS_8).
+
+You'll need access to the Zimbra Admin Port, `7071` or `9071` if using Proxy, for this to work.
+
+By the default this Gem returns the following information after a succesfully login:
+
+* Email address of the logged user as the `request.env["omniauth.auth"].uid`
+* `request.env["omniauth.auth"].credentials.token` with the `ZM_AUTH_TOKEN` given by Zimbra.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this lines to your application's Gemfile:
 
-    gem 'omniauth-zimbra'
+    gem 'zimbra', :github => 'pbruna/ruby-zimbra', :branch => :master
+    gem 'omniauth-zimbraadmin'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install omniauth-zimbra
+**Note:** You will need my version of the [zimbra gem](https://github.com/pbruna/ruby-zimbra) for the moment.
 
 ## Usage
 
-TODO: Write usage instructions here
+Add :zimbraadmin provider to omniauth builder:
+
+```ruby
+use OmniAuth::Builder do
+  provider :zimbraadmin, "https://zimbra.example.com:7071/service/admin/soap"
+end
+```
+
+Example for Rails with complete options:
+
+```ruby
+endpoint = "https://mail.example.com:9071/service/admin/soap"
+
+Rails.application.config.middleware.use OmniAuth::Builder do  
+  provider :zimbraadmin, :endpoint => endpoint, :debug => true, :new_session_path => "/sessions/new",
+  :zimbra_attributes => ["zimbraId", "mail", "displayName", "zimbraMailAlias"]
+end
+
+OmniAuth.config.logger = Rails.logger
+```
+
+About the options:
+
+* `new_session_path`, is the path with the login form
+* `zimbra_attributes`, extra Zimbra information that will be returned in the `extra` element of the Omniauth [Auth Hash Schema](https://github.com/intridea/omniauth/wiki/Auth-Hash-Schema)
 
 ## Contributing
 

data/lib/omniauth-zimbraadmin/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module ZimbraAdmin
-    VERSION = "0.0.3.3"
+    VERSION = "0.0.3.22"
   end
 end

data/lib/omniauth/strategies/zimbra_admin.rb

@@ -9,21 +9,37 @@ module OmniAuth
       args [:endpoint]
 
       option :title,   "Zimbra Admin Auth"
+      option :name, "zimbraadmin"
+      option :fields, [:name, :email]
+      option :zimbra_attributes, %w( displayName )
       option :debug, false
+      option :new_session_path, "/sessions/new"
+      option :uid_field, :email
 
       def request_phase
-        OmniAuth::Form.build(:title => options.title, :url => callback_path) do
-          text_field 'Email', 'email'
-          password_field 'Password', 'password'
-          button "Sign In"
-        end.to_response
+        redirect options[:new_session_path]
       end
-
+      
       def callback_phase
-        return fail!(:invalid_credentials) if !authentication_response
+        return fail!(:invalid_credentials) unless authentication_response
         super
       end
 
+      uid { username }
+      
+      info do { 
+        name: @authentication_response[:account_attrs]["displayName"]
+        } 
+      end
+      
+      credentials do 
+        {  :token => @authentication_response[:token] } 
+      end
+      
+      extra do 
+        @authentication_response[:account_attrs]
+      end
+      
       protected
 
         # by default we use static uri. If dynamic uri is required, override
@@ -31,34 +47,40 @@ module OmniAuth
         def endpoint
           options.endpoint
         end
-        
+
         def debug
           options[:debug]
         end
 
         def username
-          request['email']
+          request[:sessions]['email']
         end
 
         def password
-          request['password']
+          request[:sessions]['password']
         end
 
         def authentication_response
           unless @authentication_response
             return unless username && password
-            
-            Zimbra.debug = debug
-            Zimbra.admin_api_url = endpoint
-            begin
-              @authentication_response = Zimbra.reset_login(username, password)
-            rescue Exception => e
-              @authentication_response = false
-            end
+            @authentication_response = login_and_data(username, password)
+            return unless @authentication_response
           end
-
           @authentication_response
         end
+        
+        def login_and_data(username, password)
+          Zimbra.debug = debug
+          Zimbra.admin_api_url = endpoint
+          begin
+            token = Zimbra.reset_login(username, password)
+            account = Zimbra::Account.find_by_name username
+            account_attrs = account.get_attributes options[:zimbra_attributes]
+            {token: token, account: account, account_attrs: account_attrs}
+          rescue Exception => e
+            false 
+          end
+        end
 
     end
   end

data/test/test_helper.rb

@@ -1,5 +1,5 @@
 require 'omniauth'
-require "omniauth-zimbra"
+require "omniauth-zimbraadmin"
 
 require 'minitest/autorun'
 require 'minitest/reporters' # requires the gem

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-zimbraadmin
 version: !ruby/object:Gem::Version
-  version: 0.0.3.3
+  version: 0.0.3.22
 platform: ruby
 authors:
 - Patricio Bruna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-09 00:00:00.000000000 Z
+date: 2015-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -101,7 +101,7 @@ files:
 - lib/omniauth-zimbraadmin.rb
 - lib/omniauth-zimbraadmin/version.rb
 - lib/omniauth/strategies/zimbra_admin.rb
-- omniauth-zimbra.gemspec
+- omniauth-zimbraadmin.gemspec
 - test/test_helper.rb
 homepage: https://github.com/pbruna/omniauth-zimbra
 licenses: