omniauth-broadworks 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'growl'
+  gem 'rb-fsevent'
+end

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011-2012 Jan Xie <jan.h.xie@gmail.com>
+
+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.rdoc

@@ -0,0 +1,17 @@
+= OmniAuth::Broadworks
+
+OmniAuth stratgies to pull user profile from Broadworks through XSI api.
+
+== Usage
+
+Install manually or using Bundler:
+
+    gem 'omniauth-broadworks'
+
+Add :broadworks provider to omniauth builder:
+
+    # configuration for xdp sandbox
+    use OmniAuth::Builder do
+      provider :broadworks, "http://xsp1.xdp.broadsoft.com/com.broadsoft.xsi-actions/v2.0", domain: 'xdp.broadsoft.com'
+      # provider ...
+    end

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new

data/lib/omniauth-broadworks.rb

@@ -0,0 +1,2 @@
+require 'omniauth-broadworks/version'
+require 'omniauth/strategies/broadworks'

data/lib/omniauth-broadworks/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Broadworks
+    VERSION = "1.0.0"
+  end
+end

data/lib/omniauth/strategies/broadworks.rb

@@ -0,0 +1,45 @@
+require 'nokogiri'
+require 'omniauth-http-basic'
+
+module OmniAuth
+  module Strategies
+    class Broadworks < OmniAuth::Strategies::HttpBasic
+
+      option :title,    "Broadworks Login"
+
+      uid { content_of('Profile/details/userId') }
+
+      credentials { {:username => username, :password => password, :expires_days => content_of('Profile/passwordExpiresDays')} }
+
+      info do
+        { :name => "#{content_of('Profile/details/firstName')} #{content_of('Profile/details/lastName')}",
+          :nickname => request['username'] }
+      end
+
+      extra do
+        { :number => content_of('Profile/details/number'),
+          :extension => content_of('Profile/details/extension'),
+          :group     => content_of('Profile/details/groupId'),
+          :provider  => content_of('Profile/details/serviceProvider') }
+      end
+
+      protected
+
+        def api_uri
+          "#{options.endpoint}/user/#{username}/profile"
+        end
+
+        def username
+          "#{request['username']}@#{options.domain}" if request['username']
+        end
+
+        def xml_response
+          @xml_response ||= Nokogiri.XML(authentication_response.body)
+        end
+
+        def content_of(path)
+          xml_response.search(path).first.content
+        end
+    end
+  end
+end

data/omniauth-broadworks.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require File.expand_path('../lib/omniauth-broadworks/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth', '~> 1.0'
+  gem.add_dependency 'omniauth-http-basic', '~> 1.0'
+  gem.add_dependency 'nokogiri'
+
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yard'
+
+  gem.authors = ['Jan Xie']
+  gem.email = ['jan.h.xie@gmail.com']
+  gem.description = %q{Broadworks strategy for OmniAuth.}
+  gem.summary = gem.description
+  gem.homepage = 'http://github.com/janx/omniauth-broadworks'
+
+  gem.name = 'omniauth-broadworks'
+  gem.require_paths = ['lib']
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = OmniAuth::Broadworks::VERSION
+end

data/spec/omniauth/strategies/broadworks_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RESPONSE_XML = <<EOF
+<?xml version="1.0" encoding="iso-8859-1"?>
+<Profile xmlns="http://schema.broadsoft.com/xsi">
+  <details>
+    <userId>Test1234User1@xdp.broadsoft.com</userId>
+    <firstName>Test1234</firstName>
+    <lastName>User1</lastName>
+    <groupId>Test1234Group</groupId>
+    <serviceProvider isEnterprise="true">Test1234Ent</serviceProvider>
+    <number>1234567890</number>
+    <extension>1234</extension>
+  </details>
+  <additionalDetails />
+  <passwordExpiresDays>2147483647</passwordExpiresDays>
+  <fac>/v2.0/user/Test1234User1@xdp.broadsoft.com/profile/Fac</fac>
+  <registrations>
+  /v2.0/user/Test1234User1@xdp.broadsoft.com/profile/Registrations</registrations>
+  <scheduleList>
+  /v2.0/user/Test1234User1@xdp.broadsoft.com/profile/Schedule</scheduleList>
+  <portalPasswordChange>
+  /v2.0/user/Test1234User1@xdp.broadsoft.com/profile/Password/Portal</portalPasswordChange>
+  <countryCode>1</countryCode>
+</Profile>
+EOF
+
+describe OmniAuth::Strategies::Broadworks do
+  def app; lambda {|env| [200, {}, ["Hello HttpBasic!"]]}; end
+
+  let(:fresh_strategy) { Class.new OmniAuth::Strategies::Broadworks }
+  let(:instance) { subject.new(app, "http://www.example.com/xsi", :domain => "xdp.broadsoft.com") }
+  subject { fresh_strategy }
+
+  it 'should be initialized with XSI endpoint and sip domain' do
+    instance.options.endpoint.should == "http://www.example.com/xsi"
+    instance.options.domain.should   == "xdp.broadsoft.com"
+  end
+
+  it 'should set auth hash' do
+    xml = Nokogiri.XML(RESPONSE_XML)
+    instance.stub!(:request).and_return({'username' => 'test1234', 'password' => '1234'})
+    instance.stub!(:xml_response).and_return(xml)
+    instance.uid.should == "Test1234User1@xdp.broadsoft.com"
+    instance.credentials[:username].should == 'test1234@xdp.broadsoft.com'
+    instance.info[:name].should == 'Test1234 User1'
+    instance.extra[:number].should == '1234567890'
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-broadworks
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jan Xie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: &14544300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14544300
+- !ruby/object:Gem::Dependency
+  name: omniauth-http-basic
+  requirement: &14543800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14543800
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &14543420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14543420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14542880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *14542880
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &14542460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14542460
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &14542000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14542000
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &14541580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14541580
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &14541160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14541160
+description: Broadworks strategy for OmniAuth.
+email:
+- jan.h.xie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/omniauth-broadworks.rb
+- lib/omniauth-broadworks/version.rb
+- lib/omniauth/strategies/broadworks.rb
+- omniauth-broadworks.gemspec
+- spec/omniauth/strategies/broadworks_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/janx/omniauth-broadworks
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Broadworks strategy for OmniAuth.
+test_files:
+- spec/omniauth/strategies/broadworks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: