omniauth-aleph 0.1.2 → 0.1.3

data/Gemfile

@@ -12,5 +12,5 @@ platforms :rbx do
 end
 
 # XML parsing
-gem 'ox', '~> 2.0.0', platform: :ruby
+gem 'ox', '~> 2.1.0', platform: :ruby
 gem 'nokogiri', '~> 1.6.1', platform: :jruby

data/README.md

@@ -23,3 +23,151 @@ Use the Aleph strategy as a middleware in your application:
     use OmniAuth::Strategies::Aleph, title: 'My Library's Aleph', 
       host: 'aleph.library.edu', port: 80, library: 'ADM50', sub_library: 'SUB'
 
+## Configuring
+You can configure several options, which you pass in to the `provider` method via a `Hash`:
+
+- `title`: title for the `request_phase` form; defaults to `Aleph Authentication`
+- `scheme`: scheme for your Aleph X-Server as a String; defaults to `http`
+- `host`: host name for your Aleph X-Server as a String; required
+- `port`: port for your Aleph X-Server as an Integer; defaults to `80`
+- `library`: Aleph administrative library for authentication; required
+- `sub_library`: Aleph sub library for authentication; required
+
+## Auth Hash
+Here's an example _Auth Hash_ available in `request.env['omniauth.auth']`:
+
+    {
+      :provider => 'aleph',
+      :uid => 'USERNAME',
+      :info => {
+        :name => "USERNAME, TEST-RECORD",
+        :nickname => "USERNAME",
+        :email => "username@library.edu",
+        :phone => nil
+      },
+      :credentials => {},
+      :extra => {
+        :raw_info => {
+          :bor_auth => {
+            :z303 => {
+              :z303_id => "USERNAME",
+              :z303_proxy_for_id => nil,
+              :z303_primary_id => nil,
+              :z303_name_key => "username test record                     USERNAME",
+              :z303_user_type => nil,
+              :z303_user_library => nil,
+              :z303_open_date => "09/30/2013",
+              :z303_update_date => "10/26/2013",
+              :z303_con_lng => "ENG",
+              :z303_alpha => "L",
+              :z303_name => "USERNAME, TEST-RECORD",
+              :z303_title => nil,
+              :z303_delinq_1 => "00",
+              :z303_delinq_n_1 => nil,
+              :z303_delinq_1_update_date => "00000000",
+              :z303_delinq_1_cat_name => nil,
+              :z303_delinq_2 => "00",
+              :z303_delinq_n_2 => nil,
+              :z303_delinq_2_update_date => "00000000",
+              :z303_delinq_2_cat_name => nil,
+              :z303_delinq_3 => "00",
+              :z303_delinq_n_3 => nil,
+              :z303_delinq_3_update_date => "00000000",
+              :z303_delinq_3_cat_name => nil,
+              :z303_budget => nil,
+              :z303_profile_id => nil,
+              :z303_ill_library => nil,
+              :z303_home_library => "Home Library",
+              :z303_field_1 => nil,
+              :z303_field_2 => nil,
+              :z303_field_3 => nil,
+              :z303_note_1 => nil,
+              :z303_note_2 => nil,
+              :z303_salutation => nil,
+              :z303_ill_total_limit => "0000",
+              :z303_ill_active_limit => "0000",
+              :z303_dispatch_library => nil,
+              :z303_birth_date => nil,
+              :z303_export_consent => "Y",
+              :z303_proxy_id_type => "00",
+              :z303_send_all_letters => "Y",
+              :z303_plain_html => "P",
+              :z303_want_sms => nil,
+              :z303_plif_modification => nil,
+              :z303_title_req_limit => "0000",
+              :z303_gender => nil,
+              :z303_birthplace => nil},
+            :z304 => {
+              :z304_id => "USERNAME",
+              :z304_sequence => "02",
+              :z304_address_0 => "USERNAME, TEST-RECORD",
+              :z304_address_1 => "100 Testing Lane",
+              :z304_address_2 => "Testing Town",
+              :z304_address_3 => "NY",
+              :z304_zip => "10012",
+              :z304_email_address => "username@library.edu",
+              :z304_telephone => nil,
+              :z304_date_from => "20100101",
+              :z304_date_to => "20201231",
+              :z304_address_type => "02",
+              :z304_telephone_2 => nil,
+              :z304_telephone_3 => nil,
+              :z304_telephone_4 => nil,
+              :z304_sms_number => nil,
+              :z304_update_date => "20131026",
+              :z304_cat_name => "BATCH"
+            },
+            :z305 => {
+              :z305_id => "USERNAME",
+              :z305_sub_library => "SUB",
+              :z305_open_date => "09/30/2013",
+              :z305_update_date => "10/26/2013",
+              :z305_bor_type => nil,
+              :z305_bor_status => "Adjunct Faculty",
+              :z305_registration_date => "00000000",
+              :z305_expiry_date => "12/31/2020",
+              :z305_note => nil,
+              :z305_loan_permission => "Y",
+              :z305_photo_permission => "N",
+              :z305_over_permission => "Y",
+              :z305_multi_hold => "N",
+              :z305_loan_check => "Y",
+              :z305_hold_permission => "Y",
+              :z305_renew_permission => "Y",
+              :z305_rr_permission => "N",
+              :z305_ignore_late_return => "N",
+              :z305_last_activity_date => nil,
+              :z305_photo_charge => "F",
+              :z305_no_loan => "0000",
+              :z305_no_hold => "0000",
+              :z305_no_photo => "0000",
+              :z305_no_cash => "0000",
+              :z305_cash_limit => "5.00",
+              :z305_credit_debit => nil,
+              :z305_sum => "0.00",
+              :z305_delinq_1 => "00",
+              :z305_delinq_n_1 => nil,
+              :z305_delinq_1_update_date => "00000000",
+              :z305_delinq_1_cat_name => nil,
+              :z305_delinq_2 => "00",
+              :z305_delinq_n_2 => nil,
+              :z305_delinq_2_update_date => "00000000",
+              :z305_delinq_2_cat_name => nil,
+              :z305_delinq_3 => "00",
+              :z305_delinq_n_3 => nil,
+              :z305_delinq_3_update_date => "00000000",
+              :z305_delinq_3_cat_name => nil,
+              :z305_field_1 => nil,
+              :z305_field_2 => nil,
+              :z305_field_3 => nil,
+              :z305_hold_on_shelf => "N",
+              :z305_end_block_date => nil,
+              :z305_booking_permission => "N",
+              :z305_booking_ignore_hours => "N",
+              :z305_rush_cat_request => "N"
+            },
+            :session_id => "B3S4C6Y7DLQCA41NAYH1BQHLU6F24AKJRRSPRTF99FXECEUMIS"
+          }
+        }
+      }
+    }

data/lib/omniauth/aleph/adaptor.rb

@@ -31,7 +31,7 @@ module OmniAuth
         url = bor_auth_url + "&bor_id=#{username}&verification=#{password}"
         response = Faraday.get url
         # If we get a successful response AND we are looking at XML and we have a body
-        if response.status == 200 && response.headers["content-type"] == 'text/xml' && response.body
+        if response.status == 200 && response.headers["content-type"].include?('text/xml') && response.body
           json = MultiXml.parse(response.body)
           if json["bor_auth"] && (error = json["bor_auth"]["error"]).nil?
             return json

data/lib/omniauth/aleph/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Aleph
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
-end
+end

data/spec/omniauth/strategies/aleph_spec.rb

@@ -43,52 +43,50 @@ describe "OmniAuth::Strategies::Aleph" do
     end
 
     describe '#options' do
-      it 'should not error' do
-        expect{ strategy.options }.not_to raise_error
-      end
-
       subject(:options) { strategy.options }
 
+      it { should_not raise_error }
+
       describe'#name' do
-        it 'should equal "Aleph"' do
-          expect(options.name).to eq("aleph")
-        end
+        subject { options.name }
+        it { should_not be_nil }
+        it { should eq("aleph") }
       end
 
       describe '#title' do
-        it 'should equal "Aleph Authentication"' do
-          expect(options.title).to eq("Aleph Authentication")
-        end
+        subject { options.title }
+        it { should_not be_nil }
+        it { should eq("Aleph Authentication") }
       end
 
       describe '#scheme' do
-        it 'should equal "http"' do
-          expect(options.scheme).to eq("http")
-        end
+        subject { options.scheme }
+        it { should_not be_nil }
+        it { should eq("http") }
       end
 
       describe '#host' do
-        it 'should be the aleph host' do
-          expect(options.host).to eq(aleph_host)
-        end
+        subject { options.host }
+        it { should_not be_nil }
+        it { should eq(aleph_host) }
       end
 
       describe '#port' do
-        it 'should be 80' do
-          expect(options.port).to be(80)
-        end
+        subject { options.port }
+        it { should_not be_nil }
+        it { should be(80) }
       end
 
       describe '#library' do
-        it 'should be the aleph library' do
-          expect(options.library).to eq(aleph_library)
-        end
+        subject { options.library }
+        it { should_not be_nil }
+        it { should eq(aleph_library) }
       end
 
       describe '#sub_library' do
-        it 'should be the aleph sub_library' do
-          expect(options.sub_library).to eq(aleph_sub_library)
-        end
+        subject { options.sub_library }
+        it { should_not be_nil }
+        it { should eq(aleph_sub_library) }
       end
     end
 
@@ -239,6 +237,7 @@ describe "OmniAuth::Strategies::Aleph" do
           expect(auth_hash.info.nickname).to eq('USERNAME')
           expect(auth_hash.info.email).to eq('username@library.edu')
           expect(auth_hash.info.phone).to be_nil
+          expect(auth_hash.extra.raw_info.bor_auth.z303.z303_id).to eq('USERNAME')
         end
       end
     end

data/spec/vcr_cassettes/valid.yml

@@ -36,11 +36,10 @@ http_interactions:
       encoding: US-ASCII
       string: ! "<?xml version = \"1.0\" encoding = \"UTF-8\"?>\n<bor-auth>\n<z303>\n<z303-id>USERNAME</z303-id>\n<z303-proxy-for-id></z303-proxy-for-id>\n<z303-primary-id></z303-primary-id>\n<z303-name-key>username
         test record                     USERNAME</z303-name-key>\n<z303-user-type></z303-user-type>\n<z303-user-library></z303-user-library>\n<z303-open-date>09/30/2013</z303-open-date>\n<z303-update-date>10/26/2013</z303-update-date>\n<z303-con-lng>ENG</z303-con-lng>\n<z303-alpha>L</z303-alpha>\n<z303-name>USERNAME,
-        TEST-RECORD</z303-name>\n<z303-title></z303-title>\n<z303-delinq-1>00</z303-delinq-1>\n<z303-delinq-n-1></z303-delinq-n-1>\n<z303-delinq-1-update-date>00000000</z303-delinq-1-update-date>\n<z303-delinq-1-cat-name></z303-delinq-1-cat-name>\n<z303-delinq-2>00</z303-delinq-2>\n<z303-delinq-n-2></z303-delinq-n-2>\n<z303-delinq-2-update-date>00000000</z303-delinq-2-update-date>\n<z303-delinq-2-cat-name></z303-delinq-2-cat-name>\n<z303-delinq-3>00</z303-delinq-3>\n<z303-delinq-n-3></z303-delinq-n-3>\n<z303-delinq-3-update-date>00000000</z303-delinq-3-update-date>\n<z303-delinq-3-cat-name></z303-delinq-3-cat-name>\n<z303-budget></z303-budget>\n<z303-profile-id></z303-profile-id>\n<z303-ill-library></z303-ill-library>\n<z303-home-library>NYU
-        Bobst Library</z303-home-library>\n<z303-field-1></z303-field-1>\n<z303-field-2></z303-field-2>\n<z303-field-3></z303-field-3>\n<z303-note-1></z303-note-1>\n<z303-note-2></z303-note-2>\n<z303-salutation></z303-salutation>\n<z303-ill-total-limit>0000</z303-ill-total-limit>\n<z303-ill-active-limit>0000</z303-ill-active-limit>\n<z303-dispatch-library></z303-dispatch-library>\n<z303-birth-date></z303-birth-date>\n<z303-export-consent>Y</z303-export-consent>\n<z303-proxy-id-type>00</z303-proxy-id-type>\n<z303-send-all-letters>Y</z303-send-all-letters>\n<z303-plain-html>P</z303-plain-html>\n<z303-want-sms></z303-want-sms>\n<z303-plif-modification></z303-plif-modification>\n<z303-title-req-limit>0000</z303-title-req-limit>\n<z303-gender></z303-gender>\n<z303-birthplace>PLIF
-        LOADED</z303-birthplace>\n</z303>\n<z304>\n<z304-id>USERNAME</z304-id>\n<z304-sequence>02</z304-sequence>\n<z304-address-0>USERNAME,
+        TEST-RECORD</z303-name>\n<z303-title></z303-title>\n<z303-delinq-1>00</z303-delinq-1>\n<z303-delinq-n-1></z303-delinq-n-1>\n<z303-delinq-1-update-date>00000000</z303-delinq-1-update-date>\n<z303-delinq-1-cat-name></z303-delinq-1-cat-name>\n<z303-delinq-2>00</z303-delinq-2>\n<z303-delinq-n-2></z303-delinq-n-2>\n<z303-delinq-2-update-date>00000000</z303-delinq-2-update-date>\n<z303-delinq-2-cat-name></z303-delinq-2-cat-name>\n<z303-delinq-3>00</z303-delinq-3>\n<z303-delinq-n-3></z303-delinq-n-3>\n<z303-delinq-3-update-date>00000000</z303-delinq-3-update-date>\n<z303-delinq-3-cat-name></z303-delinq-3-cat-name>\n<z303-budget></z303-budget>\n<z303-profile-id></z303-profile-id>\n<z303-ill-library></z303-ill-library>\n<z303-home-library>Home
+        Library</z303-home-library>\n<z303-field-1></z303-field-1>\n<z303-field-2></z303-field-2>\n<z303-field-3></z303-field-3>\n<z303-note-1></z303-note-1>\n<z303-note-2></z303-note-2>\n<z303-salutation></z303-salutation>\n<z303-ill-total-limit>0000</z303-ill-total-limit>\n<z303-ill-active-limit>0000</z303-ill-active-limit>\n<z303-dispatch-library></z303-dispatch-library>\n<z303-birth-date></z303-birth-date>\n<z303-export-consent>Y</z303-export-consent>\n<z303-proxy-id-type>00</z303-proxy-id-type>\n<z303-send-all-letters>Y</z303-send-all-letters>\n<z303-plain-html>P</z303-plain-html>\n<z303-want-sms></z303-want-sms>\n<z303-plif-modification></z303-plif-modification>\n<z303-title-req-limit>0000</z303-title-req-limit>\n<z303-gender></z303-gender>\n<z303-birthplace></z303-birthplace>\n</z303>\n<z304>\n<z304-id>USERNAME</z304-id>\n<z304-sequence>02</z304-sequence>\n<z304-address-0>USERNAME,
         TEST-RECORD</z304-address-0>\n<z304-address-1>100 Testing Lane</z304-address-1>\n<z304-address-2>Testing
-        Town</z304-address-2>\n<z304-address-3>NY</z304-address-3>\n<z304-zip>10012</z304-zip>\n<z304-email-address>username@library.edu</z304-email-address>\n<z304-telephone></z304-telephone>\n<z304-date-from>20100101</z304-date-from>\n<z304-date-to>20201231</z304-date-to>\n<z304-address-type>02</z304-address-type>\n<z304-telephone-2></z304-telephone-2>\n<z304-telephone-3></z304-telephone-3>\n<z304-telephone-4></z304-telephone-4>\n<z304-sms-number></z304-sms-number>\n<z304-update-date>20131026</z304-update-date>\n<z304-cat-name>BATCH</z304-cat-name>\n</z304>\n<z305>\n<z305-id>USERNAME</z305-id>\n<z305-sub-library>SUB</z305-sub-library>\n<z305-open-date>09/30/2013</z305-open-date>\n<z305-update-date>10/26/2013</z305-update-date>\n<z305-bor-type></z305-bor-type>\n<z305-bor-status>Palmer
+        Town</z304-address-2>\n<z304-address-3>NY</z304-address-3>\n<z304-zip>10012</z304-zip>\n<z304-email-address>username@library.edu</z304-email-address>\n<z304-telephone></z304-telephone>\n<z304-date-from>20100101</z304-date-from>\n<z304-date-to>20201231</z304-date-to>\n<z304-address-type>02</z304-address-type>\n<z304-telephone-2></z304-telephone-2>\n<z304-telephone-3></z304-telephone-3>\n<z304-telephone-4></z304-telephone-4>\n<z304-sms-number></z304-sms-number>\n<z304-update-date>20131026</z304-update-date>\n<z304-cat-name>BATCH</z304-cat-name>\n</z304>\n<z305>\n<z305-id>USERNAME</z305-id>\n<z305-sub-library>SUB</z305-sub-library>\n<z305-open-date>09/30/2013</z305-open-date>\n<z305-update-date>10/26/2013</z305-update-date>\n<z305-bor-type></z305-bor-type>\n<z305-bor-status>Adjunct
         Faculty</z305-bor-status>\n<z305-registration-date>00000000</z305-registration-date>\n<z305-expiry-date>12/31/2020</z305-expiry-date>\n<z305-note></z305-note>\n<z305-loan-permission>Y</z305-loan-permission>\n<z305-photo-permission>N</z305-photo-permission>\n<z305-over-permission>Y</z305-over-permission>\n<z305-multi-hold>N</z305-multi-hold>\n<z305-loan-check>Y</z305-loan-check>\n<z305-hold-permission>Y</z305-hold-permission>\n<z305-renew-permission>Y</z305-renew-permission>\n<z305-rr-permission>N</z305-rr-permission>\n<z305-ignore-late-return>N</z305-ignore-late-return>\n<z305-last-activity-date></z305-last-activity-date>\n<z305-photo-charge>F</z305-photo-charge>\n<z305-no-loan>0000</z305-no-loan>\n<z305-no-hold>0000</z305-no-hold>\n<z305-no-photo>0000</z305-no-photo>\n<z305-no-cash>0000</z305-no-cash>\n<z305-cash-limit>5.00</z305-cash-limit>\n<z305-credit-debit></z305-credit-debit>\n<z305-sum>0.00</z305-sum>\n<z305-delinq-1>00</z305-delinq-1>\n<z305-delinq-n-1></z305-delinq-n-1>\n<z305-delinq-1-update-date>00000000</z305-delinq-1-update-date>\n<z305-delinq-1-cat-name></z305-delinq-1-cat-name>\n<z305-delinq-2>00</z305-delinq-2>\n<z305-delinq-n-2></z305-delinq-n-2>\n<z305-delinq-2-update-date>00000000</z305-delinq-2-update-date>\n<z305-delinq-2-cat-name></z305-delinq-2-cat-name>\n<z305-delinq-3>00</z305-delinq-3>\n<z305-delinq-n-3></z305-delinq-n-3>\n<z305-delinq-3-update-date>00000000</z305-delinq-3-update-date>\n<z305-delinq-3-cat-name></z305-delinq-3-cat-name>\n<z305-field-1></z305-field-1>\n<z305-field-2></z305-field-2>\n<z305-field-3></z305-field-3>\n<z305-hold-on-shelf>N</z305-hold-on-shelf>\n<z305-end-block-date></z305-end-block-date>\n<z305-booking-permission>N</z305-booking-permission>\n<z305-booking-ignore-hours>N</z305-booking-ignore-hours>\n<z305-rush-cat-request>N</z305-rush-cat-request>\n</z305>\n<session-id>B3S4C6Y7DLQCA41NAYH1BQHLU6F24AKJRRSPRTF99FXECEUMIS</session-id>\n</bor-auth>\n "
     http_version: 
   recorded_at: Wed, 22 Jan 2014 15:53:06 GMT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-aleph
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2081205909347291238
+      hash: 563932762752653555
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2081205909347291238
+      hash: 563932762752653555
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23