omniauth-tropo 1.0.0 → 1.0.1

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store

data/Gemfile

@@ -8,5 +8,7 @@ group :development, :test do
   gem 'guard-rspec'
   gem 'guard-bundler'
   gem 'growl'
+  gem 'fakeweb'
+  gem 'flexmock'
   gem 'rb-fsevent'
 end

data/README.md

@@ -16,6 +16,12 @@ Add :tropo provider to omniauth builder (RAILS_ROOT/config/initializers/omniauth
       # provider ...
     end
 
+If you want to pull roles from the ProvisioningAPI ( Premise only ) you can do so by adding :role_options hash in the builder:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :tropo, "http://yourserver.com:8080/rest", :role_options=>{:admin_username=>'admin',:admin_password=>'admin'}
+    end
+
 ### Example:
 
     cd examples

data/lib/omniauth-tropo/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Tropo
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/omniauth/strategies/tropo.rb

@@ -1,12 +1,18 @@
-require 'omniauth-http-basic'
-require 'multi_json'
+%w(omniauth-http-basic multi_json faraday).each{|lib| require lib}
+
 module OmniAuth
   module Strategies
     class Tropo < OmniAuth::Strategies::HttpBasic
 
       option :title,   "Tropo Login"
 
-      uid { get_value('id') }
+      option :role_options, {
+        :path            =>  'roles',
+        :admin_username  =>  nil,
+        :admin_password  =>  nil
+      }
+
+      uid { get_value(:id) }
 
       credentials { {:username => username, :password => password}}
 
@@ -26,23 +32,43 @@ module OmniAuth
           :job_title  => get_value('jobTitle'),
           :email      => get_value('email'),
           :address    => get_value('address'),
-          :address2   => get_value('address2')
+          :address2   => get_value('address2'),
+          :roles      => roles_enabled ? fetch_roles : nil
         }
       end
 
       protected
 
-        def api_uri
-          "#{options.endpoint}/users/#{username}"
-        end
+      def api_uri
+        "#{options.endpoint}/users/#{username}"
+      end
+
+      def json_response
+        @json_response ||= MultiJson.load(authentication_response.body, :symbolize_keys => true)
+      end
+
+      def get_value(key)
+        json_response[key.to_sym]
+      end
 
-        def json_response
-          @json_response ||= MultiJson.load(authentication_response.body, :symbolize_keys => true)
+      def roles_enabled
+        if options.role_options.admin_username && options.role_options.admin_username
+          true
+        else
+          false
         end
+      end
 
-        def get_value(key)
-          json_response[key.to_sym]
+      def fetch_roles
+        conn = Faraday.new(:url => options.endpoint) do |builder|
+          builder.request  :url_encoded
+          builder.response :logger
+          builder.adapter  :net_http
         end
+        conn.basic_auth(options.role_options.admin_username,options.role_options.admin_password)
+        response = conn.get "/users/#{request['username']}/#{options.role_options.path}"
+        MultiJson.load(response.body).collect{|x| x["roleName"]} if response.status == 200
+      end
     end
   end
 end

data/spec/omniauth/strategies/tropo_spec.rb

@@ -23,31 +23,76 @@ RESPONSE_JSON = <<-EOF
   "status": "active"
 }
 EOF
-
 describe OmniAuth::Strategies::Tropo do
   def app; lambda {|env| [200, {}, ["Hello HttpBasic!"]]}; end
 
   let(:fresh_strategy) { Class.new OmniAuth::Strategies::Tropo }
-  let(:instance) { subject.new(app, "http://www.example.com/rest")}
+  let(:instance) { subject.new(app, "http://www.example.com") }
   subject { fresh_strategy }
 
   it 'should be initialized with API endpoint' do
-    instance.options.endpoint.should == "http://www.example.com/rest"
+    instance.options.endpoint.should == "http://www.example.com"
   end
+  describe "request" do
+    describe "role_options-defaults" do
+      it 'should use default options for role features' do
+        instance.options.role_options.admin_username.should == nil
+        instance.options.role_options.admin_password.should == nil
+        instance.options.role_options.path.should           == "roles"
+      end
+    end
+
+    describe "role_options-overrides" do
+      let(:instance) { subject.new(app, "http://www.example.com", :role_options=>{:admin_username=> 'blah',:admin_password=>'blah',:path=>'blah'}) }
+      it 'should take options for roles features' do
+        instance.options.role_options.admin_username.should == "blah"
+        instance.options.role_options.admin_password.should == "blah"
+        instance.options.role_options.path.should           == "blah"
+      end
+
+      it "should return roles when role_options is provided" do
+        json = MultiJson.load(RESPONSE_JSON, :symbolize_keys => true)
 
-  it 'should set an expected auth hash' do
-    json = MultiJson.load(RESPONSE_JSON, :symbolize_keys => true)
-    instance.stub!(:request).and_return({'username' => 'jdyer', 'password' => '1234'})
-    instance.stub!(:json_response).and_return(json)
-    instance.uid.should                     == '12345'
-    instance.credentials[:username].should  == 'jdyer'
-    instance.info[:name].should             == 'John Dyer'
-    instance.extra[:job_title].should       == 'System Engineer'
-    instance.extra[:state].should           == 'FL'
-    instance.extra[:zip_code].should        == '32801'
-    instance.extra[:number].should          == '1234567890'
-    instance.extra[:email].should           == 'user@test.com'
-    instance.extra[:address].should         == '189 South Orange Avenue'
-    instance.extra[:address2].should        == '#1000'
+        FakeWeb.register_uri(:get,
+          "http://blah:blah@www.example.com/users/jdyer/roles",
+          :body=>'',
+          :content_type=>'application/json',
+          :status => ["200","OK"]
+        )
+
+        instance.stub!(:request).and_return({'username' => 'jdyer', 'password' => '1234'})
+        instance.stub!(:json_response).and_return(json)
+        instance.stub!(:fetch_roles).and_return(["VOXEO_EMPLOYEE", "TROPO_PRODUCTION_CUSTOMER"])
+        instance.extra[:roles].should include('VOXEO_EMPLOYEE')
+      end
+    end
   end
+
+  describe "response" do
+    let(:instance) { subject.new(app, "http://www.example.com")}
+    it 'should set an expected auth hash' do
+      json = MultiJson.load(RESPONSE_JSON, :symbolize_keys => true)
+      instance.stub!(:request).and_return({'username' => 'jdyer', 'password' => '1234'})
+      instance.stub!(:json_response).and_return(json)
+      instance.uid.should                     == '12345'
+      instance.credentials[:username].should  == 'jdyer'
+      instance.info[:name].should             == 'John Dyer'
+      instance.extra[:job_title].should       == 'System Engineer'
+      instance.extra[:state].should           == 'FL'
+      instance.extra[:zip_code].should        == '32801'
+      instance.extra[:number].should          == '1234567890'
+      instance.extra[:email].should           == 'user@test.com'
+      instance.extra[:address].should         == '189 South Orange Avenue'
+      instance.extra[:address2].should        == '#1000'
+    end
+
+    it "should return empty roles by default" do
+      json = MultiJson.load(RESPONSE_JSON, :symbolize_keys => true)
+      instance.stub!(:request).and_return({'username' => 'jdyer', 'password' => '1234'})
+      instance.stub!(:json_response).and_return(json)
+      instance.extra[:roles].should == nil
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -4,13 +4,16 @@ $:.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 SimpleCov.start
 require 'rspec'
+require 'faraday'
 require 'rack/test'
 require 'webmock/rspec'
 require 'omniauth'
+require 'fakeweb'
 require 'omniauth-tropo'
 
+FakeWeb.allow_net_connect = false
+
 RSpec.configure do |config|
-  config.include WebMock::API
   config.include Rack::Test::Methods
   config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-tropo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -175,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2352945515170662331
+      hash: 4379067423480031072
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2352945515170662331
+      hash: 4379067423480031072
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24