omniauth-owa 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 815d361335614c9a79882212cb02a1ad4da2a59d
-  data.tar.gz: ef1129aca4e8b757031e7c4c7c56f6921d8a6f88
+  metadata.gz: f5878cdb9a86f12f3fadab9ee79d19e66c2f7fd2
+  data.tar.gz: e8897c9397eab34454b259ed0de56c7fe9b097da
 SHA512:
-  metadata.gz: 6961e2cb38bfc73d3e1844f315e714bd2f492c1cb28bf6051e5366a234005f5d232095c6fc17bba0ddec7016dc163d77849798faddf789963020ef0dcf71c25d
-  data.tar.gz: 286d4af7a081abb918de73a825b783743e64694a8d8c803f6963fc78be31cce6bc42520e4ad610a7504bb99d730d6a9b5453cdb17a7b8fac0823bc66cb5aaef5
+  metadata.gz: df10832c1139b9168aa19b84f36dde383201b391bd98e2db9b1b930e9c81eaef5d852d81d9829f8448008731c56d977e5d95a912f03753dfaffdd4ea23915ee5
+  data.tar.gz: e1a93a2386d15d4c31bc66ca9d50a8fcb4fc121a9c9c4805686270357c8a5cb2b2900b3d726e0da1f6dc92e9b7f05f736ee2de9e72665d5130d7cbf72f7cc19b

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kerry Buckley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# OmniAuth-OWA
+
+## About
+
+This is an [OmiAuth](https://github.com/intridea/omniauth) strategy for
+authenticating against an Outlook Web Access server. Might be handy if you want
+to allow people to authenticate against your company's LDAP credentials but the
+only way they're exposed on the Internet is through webmail login.
+
+Currently barely more than a proof of concept, only tested against one specific
+OWA server, and certainly not production quality!
+
+## Installation
+
+    gem install omniauth-owa
+
+Or if you're using bundler, put it in your gemfile:
+
+    gem "omniauth-owa"
+
+## Usage
+
+Rails example:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :owa, base_url: "https://mail.example.com", form: SessionsController.action(:new)
+    end
+
+If you override the form (as in the example above), it should post to
+`/auth/owa/callback` with `uid` and `password` parameters.
+
+The parameters returned in the authentication hash are:
+
+* uid
+* info.name
+* info.first_name
+* info.last_name
+* info.email
+
+## Licence
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Kerry Buckley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require "rspec/core/rake_task"
+
+task :default => [:spec, :build]
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :build do
+  system "gem build omniauth-owa.gemspec"
+end

data/lib/omniauth-owa/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Owa
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/omniauth/strategies/owa.rb

@@ -21,13 +21,17 @@ module OmniAuth
         conn = Faraday.new url: options.base_url
         conn.basic_auth uid, password
 
-        search_results = conn.get("/owa/?ae=Dialog&t=AddressBook&ctx=1&sch=#{uid}").body
+        response = conn.get("/owa/?ae=Dialog&t=AddressBook&ctx=1&sch=#{uid}")
+        return fail!(:invalid_credentials) unless response.success?
+        search_results = response.body
         id = search_results.match(/<h1><a href="#" id="([^"]+)"/)[1]
         details = conn.get("/owa/?ae=Item&t=AD.RecipientType.User&id=#{CGI.escape id}").body
 
-        @first_name = details.match(/<td[^>]*>First name<\/td><td[^>]*>([^<]*)/)[1]
-        @last_name = details.match(/<td[^>]*>Last name<\/td><td[^>]*>([^<]*)/)[1]
-        @name = "#{@first_name} #{@last_name}"
+        @info = {}
+        @info[:first_name] = details.match(/<td[^>]*>First name<\/td><td[^>]*>([^<]*)/)[1]
+        @info[:last_name] = details.match(/<td[^>]*>Last name<\/td><td[^>]*>([^<]*)/)[1]
+        @info[:email] = details.match(/<td[^>]*>E-mail<\/td><td[^>]*>([^<]*)/)[1]
+        @info[:name] = "#{@info[:first_name]} #{@info[:last_name]}"
         super
       end
 
@@ -36,11 +40,7 @@ module OmniAuth
       end
 
       info do
-        {
-          name: @name,
-          first_name: @first_name,
-          last_name: @last_name,
-        }
+        @info
       end
     end
   end

data/spec/omniauth/strategies/owa_spec.rb

@@ -46,43 +46,59 @@ describe OmniAuth::Strategies::OWA do
   describe "callback phase" do
     let(:auth_hash) { last_request.env["omniauth.auth"] }
 
-    before do
-      stub_request(:get, "https://fred:secret@mail.example.com/owa/?ae=Dialog&t=AddressBook&ctx=1&sch=fred").
-        to_return body: <<-EOF
+    context "when authentication succeeds" do
+      before do
+        stub_request(:get, "https://fred:secret@mail.example.com/owa/?ae=Dialog&t=AddressBook&ctx=1&sch=fred").
+          to_return body: <<-EOF
           Blah blah
           <h1><a href=\"#\" id=\"an=id\" onClick=\"return onClkRcpt(this, 1);\">Fred Bloggs</a></h1>
           blah
         EOF
 
-      stub_request(:get, "https://fred:secret@mail.example.com/owa/?ae=Item&t=AD.RecipientType.User&id=an%3Did").
-        to_return body: <<-EOF
+        stub_request(:get, "https://fred:secret@mail.example.com/owa/?ae=Item&t=AD.RecipientType.User&id=an%3Did").
+          to_return body: <<-EOF
           Blah blah
           <tr><td class="lbl lp" nowrap>First name</td><td class="txvl">Fred</td></tr>
           <tr><td class="lbl lp" nowrap>Last name</td><td class="txvl">Bloggs</td></tr>
+          <tr><td class="lbl lp" nowrap>E-mail</td><td class="txvl">fred.bloggs@example.com</td></tr>
           blah
         EOF
 
-      post "/auth/owa/callback", uid: "fred", password: "secret"
-    end
+        post "/auth/owa/callback", uid: "fred", password: "secret"
+      end
 
-    it "sets the uid to the value submitted" do
-      expect(auth_hash.uid).to eq "fred"
-    end
+      it "sets the uid to the value submitted" do
+        expect(auth_hash.uid).to eq "fred"
+      end
 
-    it "sets the name in the auth hash" do
-      expect(auth_hash.info.name).to eq("Fred Bloggs")
-    end
+      it "sets the name in the auth hash" do
+        expect(auth_hash.info.name).to eq("Fred Bloggs")
+      end
 
-    it "sets the first name in the auth hash" do
-      expect(auth_hash.info.first_name).to eq("Fred")
-    end
+      it "sets the first name in the auth hash" do
+        expect(auth_hash.info.first_name).to eq("Fred")
+      end
+
+      it "sets the last name in the auth hash" do
+        expect(auth_hash.info.last_name).to eq("Bloggs")
+      end
 
-    it "sets the last name in the auth hash" do
-      expect(auth_hash.info.last_name).to eq("Bloggs")
+      it "sets the email address in the auth hash" do
+        expect(auth_hash.info.email).to eq("fred.bloggs@example.com")
+      end
     end
 
     context "when authentication fails" do
-      it "does something..."
+      before do
+        stub_request(:get, "https://fred:secret@mail.example.com/owa/?ae=Dialog&t=AddressBook&ctx=1&sch=fred").
+          to_return status: 401
+        post "/auth/owa/callback", uid: "fred", password: "secret"
+      end
+
+      it "fails with 'invalid_credentials'" do
+        expect(last_response).to be_redirect
+        expect(last_response.location).to eq "/auth/failure?message=invalid_credentials&strategy=owa"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-owa
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kerry Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -117,6 +117,9 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- LICENCE
+- README.md
+- Rakefile
 - lib/omniauth-owa.rb
 - lib/omniauth-owa/version.rb
 - lib/omniauth/strategies/owa.rb