cas-client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dec8e7b15d53fc005cf9b9d4d3f5bf39e1e0cf7c5df64387dd2e2615bb89bcc
-  data.tar.gz: 305516439c3dadc49a90cd02c27a8d65868ea8ae1b020e23c7306e10cbf165c8
+  metadata.gz: cd0f12781655ef893c92fb9b5275ccc32e42b1304d82eb8f13cab07b4a458fb8
+  data.tar.gz: 92277075f6dc6fc4a1507a36baf5ea0a8e1d3380ce940fdaad3abc14dc138a85
 SHA512:
-  metadata.gz: 46b9c8224cc102f852bb2f7aded2810b4701ed662b6477812095612acd28921c3d25d2a28e452af210702b6d80e035674f4fabbc5f626572f4bd522d8ea9c9ce
-  data.tar.gz: ad0f99174aa6ceeea27ee2b60f756539cef7db143f5f3cd133b72d602ae9090645c7fc9ae3ebc28352466f3d8ce64b9067fd5c5cb4bb692ac98869cee46e3c9c
+  metadata.gz: 2e003ef0e3ccdcf50de97fbf30abdc0aba1a2d267fac0ab393191b0faa4a680313920eb304a5dd6d3fb7700ae6f787e3e906368d6e0345113952228480d5bb97
+  data.tar.gz: d6d0a79b004c54ad886660efa7618f89e576802b0a79ccc201cc2ed77f19f58a7a05016c81bf702c4e320e6e01bf84f652b9e4bc6930c34a5d2206a57a8c5911

data/README.md

@@ -9,7 +9,7 @@ TODO: Delete this and the text above, and describe your gem
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cas_client'
+gem 'cas-client'
 ```
 
 And then execute:
@@ -18,17 +18,25 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install cas_client
+    $ gem install cas-client
 
 ## Usage
 
 Configure middleware from the specific environment file
 
 ```ruby
-config.middleware.insert_after ActionDispatch::Session::CookieStore, Cas::Client::Middleware, {
-  server_url: "https://idpqa.americanfinancing.net",
-  extra_attributes: [:first_name, :last_name, :email, :external_id]
-}
+config.middleware.insert_after ActionDispatch::Session::CookieStore, Cas::Client::Middleware do |config|
+  config.server_url = "https://staging.cas-server"
+  config.extra_attributes = [:first_name, :last_name, :email]
+end
+```
+
+Configure global/non-environment specific options
+
+```ruby
+Cas::Client.configure do |config|
+  config.extra_attributes = [:first_name, :last_name, :email]
+end
 ```
 
 ## Development

data/lib/cas-client.rb

@@ -4,8 +4,17 @@ require 'cas/client/response'
 require 'cas/client/server'
 require 'cas/client/url'
 require 'cas/client/version'
+require 'cas/client/configuration'
 
 module Cas
   module Client
+    class << self
+      attr_accessor :configuration
+
+      def configure
+        self.configuration ||= Configuration.new
+        yield configuration
+      end
+    end
   end
 end

data/lib/cas/client/configuration.rb

@@ -0,0 +1,12 @@
+module Cas
+  module Client
+    class Configuration
+      attr_accessor :cas_namespace, :extra_attributes, :server_url
+
+      def initialize
+        @extra_attributes = []
+        @cas_namespace = 'cas'
+      end
+    end
+  end
+end

data/lib/cas/client/middleware.rb

@@ -3,25 +3,25 @@ require 'net/http'
 module Cas
   module Client
     class Middleware
-      def initialize(app, config={})
+      def initialize(app, &block)
         @app = app
-        @config = config
-        @config[:extra_attributes] = [] if config[:extra_attributes].nil?
-        @request = nil
+
+        Cas::Client.configure(&block) if block_given?
       end
 
       def call(env)
         @request = Rack::Request.new(env)
-        server = Cas::Client::Server.new(@config[:server_url])
         status, headers, rack_body = @app.call(env)
-        log(env, "Middleware called. Status: #{status}, Headers: #{headers}")
 
         if ticket_validation?
-          attributes = server.validate_service(self_url(@request), ticket_param, {extra_attributes: @config[:extra_attributes]})
-          set_session(@request, attributes)
-          return redirect_to(self_url(@request))
+          attributes = server.validate_service(self_url, ticket_param)
+          set_session(attributes)
+
+          return redirect_to(self_url)
         elsif status == 401
-          return redirect_to(server.login_url({service_url: self_url(@request)}))
+          log(env, "Cas::Client::Middleware detected 401, Status: #{status}, Headers: #{headers}\n")
+
+          return redirect_to(server.login_url({ service_url: self_url }))
         else
           return [status, headers, rack_body]
         end
@@ -29,28 +29,32 @@ module Cas
 
       private
 
-      def set_session(req, attributes)
-        req.session['cas'] = attributes
+      def server
+        @_server ||= Cas::Client::Server.new
+      end
+
+      def set_session(attributes)
+        @request.session['cas'] = attributes
       end
 
       def redirect_to(url, status=302)
         [ status, { 'Location' => url, 'Content-Type' => 'text/plain' }, ["Redirecting you to #{url}"] ]
       end
 
-      def self_url(req)
-        req.url.split('?')[0]
+      def self_url
+        @request.url.split('?')[0]
       end
 
       def ticket_validation?
-        !!(@request.get? && ticket_param && ticket_param.to_s =~ /\AST\-[^\s]{1,253}\Z/)
+        @request.get? && param_service_ticket?
       end
 
       def ticket_param
         @request.params['ticket']
       end
 
-      def xml_namespace
-        @config[:cas_namespace] || 'cas'
+      def param_service_ticket?
+        ticket_param.to_s =~ /\AST\-[^\s]{1,253}\Z/
       end
 
       def log(env, message, level = :info)

data/lib/cas/client/response.rb

@@ -11,21 +11,21 @@ module Cas
       end
 
       def success?
-        @response.to_s.match(/<cas:authenticationSuccess>/).captures.length > 0
+        @response.to_s.match(/<#{xml_namespace}:authenticationSuccess>/)
       end
 
-      def all_attributes(extra_attributes)
-        {}.merge!(get_user(@response)).merge!(get_extra_attributes(@response, extra_attributes))
+      def all_attributes
+        get_user.merge!(get_extra_attributes)
       end
 
       protected
 
       def xml_namespace
-        "cas"
+        Cas::Client.configuration.cas_namespace
       end
 
-      def get_user(res)
-        match = res.match(/<#{xml_namespace}:user>(.*)<\/#{xml_namespace}:user>/)
+      def get_user
+        match = @response.match(/<#{xml_namespace}:user>(.*)<\/#{xml_namespace}:user>/)
         if match
           { user: match.captures.first }
         else # Failed login
@@ -33,15 +33,18 @@ module Cas
         end
       end
 
-      def get_extra_attributes(res, extra_attributes)
-        attributes = {}
-        extra_attributes.each do |ea|
-          match = res.match(/<#{xml_namespace}:#{ea}>(.*)<\/#{xml_namespace}:#{ea}>/)
-          if match
-            attributes[ea] = match.captures.first
+      def get_extra_attributes
+        {}.tap do |attributes|
+          Cas::Client.configuration.extra_attributes.each do |ea|
+            match = @response.match(/<#{xml_namespace}:#{ea}>(.*)<\/#{xml_namespace}:#{ea}>/)
+
+            if match
+              attributes[ea] = match.captures.first
+            else
+              attributes
+            end
           end
         end
-        attributes
       end
     end
   end

data/lib/cas/client/server.rb

@@ -1,7 +1,7 @@
 module Cas
   module Client
     class Server
-      def initialize(server_url)
+      def initialize
         @url = Cas::Client::URL.new(server_url)
       end
 
@@ -21,15 +21,23 @@ module Cas
         end
       end
 
-      def validate_service(service_url, ticket, option={})
+      def self.logout_url(options={})
+        new.logout_url(options).to_s
+      end
+
+      def validate_service(service_url, ticket)
         uri = Cas::Client::URL.new(validate_service_url(service_url, ticket)).to_uri
         res = Cas::Client::Response.new(uri)
         res.validate_service_response
-        res.all_attributes(option[:extra_attributes]||[])
+        res.all_attributes
       end
 
       protected
 
+      def server_url
+        Cas::Client.configuration.server_url
+      end
+
       def validate_service_url(service_url, ticket)
         protocol_path = "p3"
         server_url = @url

data/lib/cas/client/version.rb

@@ -1,5 +1,5 @@
 module Cas
   module Client
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cas-client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Donavan White
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-29 00:00:00.000000000 Z
+date: 2018-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -86,6 +86,7 @@ files:
 - bin/setup
 - cas-client.gemspec
 - lib/cas-client.rb
+- lib/cas/client/configuration.rb
 - lib/cas/client/middleware.rb
 - lib/cas/client/response.rb
 - lib/cas/client/server.rb