omniauth-dice 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f393f95195efb18da624ef331288b3f4876c997
-  data.tar.gz: 0b45003f60b7d5b42132bfaafeb692ccf7f36a5b
+  metadata.gz: bcc625a7b838b312fb211a4aa76ffa8bd9c4ccc3
+  data.tar.gz: 17b2c9a77c4d26fe27e489ac6eaeb48fbd918d63
 SHA512:
-  metadata.gz: 332406fca56a0c52f8885a5741c3957d12c53820ffcaab8aaace6528f143f2884befe841c27c05e48ee9b456d87f72ef1f5515493857404942209392e531d557
-  data.tar.gz: 99604306f8bec41d99577182d0ebedfa93625b5d0ce27d602b4baeb46f654f498861b945b1711fe7ce74aadb30afdc4521c5f797c94471cd1dc6e7e06b47c362
+  metadata.gz: a8ab0e5c280d041f0b3499542bc1144151b4c8bc0ecf6833eee10cd05aeb82b94fd1a29d59430ae7842cd84d7ba4a813e729678ffa2b38572faae4cfe3dbb21f
+  data.tar.gz: 3301e4f10c98985c9fec9f84c426f90d963e55444fc8d42b9b5253bca5bd2d02a8b1570e89663aa2480feb3ad388d2f7db176c930c41a19106585f42b04a3484

data/lib/omniauth/dice/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Dice
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/omniauth/strategies/dice.rb

@@ -30,17 +30,10 @@ module OmniAuth
     # @option name_format [Symbol] Format for auth_hash['info']['name']
     #   Defaults to attempting DN common name -> full name -> first & last name
     #   Valid options are: :cn, :full_name, :first_last_name to override
-    # @option primary_visa_str [String] String to trigger primary visa boolean
+    # @option primary_visa [String] String to trigger primary visa boolean
     class Dice
       include OmniAuth::Strategy
       attr_accessor :dn, :raw_dn, :data
-      args [:cas_server, :authentication_path]
-
-      def initialize(app, *args, &block)
-        required_params_defined?(args)
-
-        super
-      end
 
       option :dnc_options, {}
       option :cas_server, nil
@@ -53,31 +46,32 @@ module OmniAuth
       option :subject_dn_header,  'HTTP_SSL_CLIENT_S_DN'
       option :issuer_dn_header,   'HTTP_SSL_CLIENT_I_DN'
       option :name_format
-      option :primary_visa_str
+      option :primary_visa
 
       # Reformat DN to expected element order for CAS DN server (via dnc gem).
       def format_dn(dn_str)
         get_dn(dn_str).to_s
       end
 
-      protected
-
-      # Change Hashie indifferent access keys back to symbols
-      def unhashie(hash)
-        tmp_hash = {}
-        hash.each do |key, value|
-          tmp_hash[key.to_sym] = value
-        end
-
-        tmp_hash
+      # Specifies which attributes are required arguments to initialize
+      def required_params
+        [:cas_server, :authentication_path]
       end
 
-      def setup_phase(*args)
-        log :debug, 'setup_phase'
-        super
+      # Determine if required arguments are present or fail hard
+      # NOTE: CANNOT call "log" method from within init block methods
+      def validate_required_params
+        log :error, '.validate_required_params'
+        required_params.each do |param|
+          unless options.send(param)
+            error_msg = "omniauth-dice error: #{param} is required"
+            fail RequiredCustomParamError, error_msg
+          end
+        end
       end
 
       def request_phase
+        validate_required_params
         subject_dn = get_dn_by_type('subject')
         return fail!('You need a valid DN to authenticate.') unless subject_dn
         user_dn = format_dn(subject_dn)
@@ -103,72 +97,65 @@ module OmniAuth
           log :error, response.inspect
           return fail!(:invalid_credentials)
         end
-        @data = response.body
-        create_auth_hash
+        @raw_data = response.body
+        @data = parse_response_data
+        session['omniauth.auth'] ||= auth_hash
 
         redirect request.env['omniauth.origin'] || '/'
       end
 
-      private
-
-      # Coordinate building out the auth_hash
-      def create_auth_hash
-        log :debug, '.create_auth_hash'
-        init_auth_hash
-        set_auth_uid
-        parse_response_data
-        create_auth_info
-      end
-
-      # Initialize the auth_hash expected fields
-      def init_auth_hash
-        log :debug, '.init_auth_hash'
-        session['omniauth.auth'] ||= {
-          'provider' => 'Dice',
-          'uid'      => nil,
-          'info'     => nil,
-          'extra'    => {
-            'raw_info' => nil
-          }
+      def auth_hash
+        log :debug, '.auth_hash'
+        {
+          'provider' => name,
+          'uid'      => uid,
+          'info'     => info,
+          'extra'    => extra
         }
       end
 
       # Set the user's uid field for the auth_hash
-      def set_auth_uid
-        log :debug, '.set_auth_uid'
-        session['omniauth.auth']['uid'] = env['omniauth.params']['user_dn']
+      uid do
+        log :debug, '.uid'
+        env['omniauth.params']['user_dn']
       end
 
       # Detect data format, parse with appropriate library
-      def parse_response_data
-        log :debug, '.parse_response_data'
-        session['omniauth.auth']['extra']['raw_info'] = @data
-        log :debug, "cas_server response.body:\r\n#{@data}"
-        unless @data.class == Hash # Webmock hack
-          case options.format.to_sym
-          when :json
-            @data = JSON.parse(@data, symbolize_names: true)
-          when :xml
-            @data = MultiXml.parse(@data)['userinfo']
-          end
-          log :debug, "Formatted response.body data: #{@data}"
-        end
-
-        @data
+      extra do
+        log :debug, '.extra'
+        { 'raw_info' => @raw_data }
       end
 
-
       # Parse CAS server response and assign values as appropriate
-      def create_auth_info
-        log :debug, '.create_auth_info'
+      info do
+        log :debug, '.info'
         info = {}
+        log :debug, info.inspect
         info = auth_info_defaults(info)
+        log :debug, info.inspect
         info = auth_info_dynamic(info)
+        log :debug, info.inspect
         info = auth_info_custom(info)
+        log :debug, info.inspect
 
-        session['omniauth.auth']['info'] = info
+        #session['omniauth.auth']['info'] = info
+        log :error, info.inspect
+        info
       end
 
+      private
+
+      # Change Hashie indifferent access keys back to symbols
+      def unhashie(hash)
+        tmp_hash = {}
+        hash.each do |key, value|
+          tmp_hash[key.to_sym] = value
+        end
+
+        tmp_hash
+      end
+
+      # Default ['omniauth.auth']['info'] field names
       def info_defaults
         [:dn, :email, :firstName, :lastName, :fullName, :citizenshipStatus,
          :country, :grantBy, :organizations, :uid, :dutyorg, :visas,
@@ -221,8 +208,8 @@ module OmniAuth
 
       # Determine if client has the primary visa
       def has_primary_visa?(info)
-        return info['primary_visa?'] = nil unless info['visas']
-        return info['primary_visa?'] = nil unless options.primary_visa
+        return info['primary_visa?'] = false unless info['visas']
+        return info['primary_visa?'] = false unless options.primary_visa
         info['primary_visa?'] = info['visas'].include?(options.primary_visa)
       end
 
@@ -333,37 +320,21 @@ module OmniAuth
         URI::encode(build_query)
       end
 
-      # Specifies which attributes are required arguments to initialize
-      def required_params
-        [:cas_server, :authentication_path]
-      end
-
-      # Determine if required arguments are present or fail hard
-      # NOTE: CANNOT call "log" method from within init block methods
-      def required_params_defined?(args)
-        required_hash = {}
-        required_params.each do |key|
-          required_hash[key] = false
-        end
-        args.each do |arg|
-          if arg.class == Hash
-            arg.each do |sub_arg, value|
-              required_hash[sub_arg] = true if required_hash[sub_arg] == false
-            end
-          else
-            required_hash[arg.to_sym] = true if required_hash[sub_arg] == false
+      # Detect data format, parse with appropriate library
+      def parse_response_data
+        log :debug, '.parse_response_data'
+        log :debug, "cas_server response.body:\r\n#{@raw_data}"
+        unless @raw_data.class == Hash # Webmock hack
+          case options.format.to_sym
+          when :json
+            formatted_data = JSON.parse(@raw_data, symbolize_names: true)
+          when :xml
+            formatted_data = MultiXml.parse(@raw_data)['userinfo']
           end
+          log :debug, "Formatted response.body data: #{formatted_data}"
         end
-        required_hash.reject!{ |arg, val| arg if val == true }
-        fail_on_invalid_params(required_hash.keys) unless required_hash.empty?
-      end
 
-      def fail_on_invalid_params(missing_params)
-        error_msg = ""
-        missing_params.each do |param|
-          error_msg += "omniauth-dice error: #{param} is required\r\n"
-        end
-        fail RequiredCustomParamError, error_msg
+        formatted_data
       end
 
       def set_session_dn(dn_string, type='subject')

data/spec/omniauth/strategies/dice_integrations_spec.rb

@@ -15,7 +15,7 @@ describe OmniAuth::Strategies::Dice, type: :strategy do
 
   def full_auth_hash
     {
-      "provider"=>"Dice",
+      "provider"=>"dice",
       "uid"=>"cn=ruby certificate rbcert,dc=ruby-lang,dc=org",
       "extra" => {
         "raw_info" => valid_user_json
@@ -62,7 +62,6 @@ describe OmniAuth::Strategies::Dice, type: :strategy do
     self.app = Rack::Builder.app do
       use Rack::Session::Cookie, :secret => '1337geeks'
       use RackSessionAccess::Middleware
-      ap '-'*80
       ap dice_options
       use OmniAuth::Strategies::Dice, dice_options
       run lambda{|env| [404, {'env' => env}, ["HELLO!"]]}
@@ -144,6 +143,7 @@ describe OmniAuth::Strategies::Dice, type: :strategy do
         get '/auth/dice'
         follow_redirect!
         expect(last_response.location).to eq('/')
+        ap last_request.env['rack.session']['omniauth.auth'].inspect
         raw_info = last_request.env['rack.session']['omniauth.auth']['extra']['raw_info']
         expect(raw_info).to eq(valid_user_json)
       end
@@ -155,10 +155,6 @@ describe OmniAuth::Strategies::Dice, type: :strategy do
         expect(last_response.location).to eq('/')
         raw_info = last_request.env['rack.session']['omniauth.auth']['extra']['raw_info']
         expect(last_request.env['rack.session']['omniauth.auth']).to be_kind_of(Hash)
-        ap '>'*40
-        ap last_request.env['rack.session']['omniauth.auth'].sort
-        ap '<'*40
-        ap auth_hash.sort
         expect(last_request.env['rack.session']['omniauth.auth'].sort).to eq(auth_hash.sort)
       end
 

data/spec/omniauth/strategies/dice_spec.rb

@@ -25,11 +25,11 @@ describe OmniAuth::Strategies::Dice do
     let(:subject_without_authentication_path) { OmniAuth::Strategies::Dice.new(app, cas_server: 'https://dice.dev') }
 
     it 'should require a cas server url' do
-      expect{ subject }.to raise_error(RequiredCustomParamError)
+      expect{ subject.request_phase }.to raise_error(RequiredCustomParamError, "omniauth-dice error: cas_server is required")
     end
 
     it 'should require an authentication path' do
-      expect{ subject_without_authentication_path }.to raise_error(RequiredCustomParamError)
+      expect{ subject_without_authentication_path.request_phase }.to raise_error(RequiredCustomParamError, "omniauth-dice error: authentication_path is required")
     end
   end
 
@@ -158,4 +158,25 @@ describe OmniAuth::Strategies::Dice do
       end
     end
   end
+
+  context ".primary_visa?" do
+    it 'should return false if no visas are defined' do
+      dice = OmniAuth::Strategies::Dice.new( app, dice_default_opts.merge({primary_visa: 'EQUESTRIA'}) )
+      visa_present = dice.send( :has_primary_visa?, { } )
+      expect(visa_present).to eq(false)
+    end
+
+    it "should return false if the visa is not present in ['info']['visas']" do
+      dice = OmniAuth::Strategies::Dice.new( app, dice_default_opts.merge({primary_visa: 'EQUESTRIA'}) )
+      visa_present = dice.send( :has_primary_visa?, {'visas' => ['CLOUDSDALE','PONYVILLE']} )
+      expect(visa_present).to eq(false)
+    end
+
+    it "should return true if the visa is present in ['info']['visas']" do
+      dice = OmniAuth::Strategies::Dice.new( app, dice_default_opts.merge({primary_visa: 'EQUESTRIA'}) )
+      visa_present = dice.send( :has_primary_visa?, {'visas' => ['CLOUDSDALE','EQUESTRIA'] } )
+      expect(visa_present).to eq(true)
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-dice
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Steven Haddox
@@ -30,7 +30,7 @@ cert_chain:
   42qdwEXvvkODZAD6KAIXPdmbMfBgPbcd+B/4eUA0PyKo+4dgL1NuqX4MPWToevIZ
   O8EKLF2X7NmC6FY1bOsSj/J8r1SOkx0rxgF+geRvY1P+hfNjDfxTsjU=
   -----END CERTIFICATE-----
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print