cassette 1.0.2 → 1.0.17

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzhkMGM0Mzc3OTk4ODhjMTc5N2JiNzU4NWY5NzI0NGUyYzEzZTZiMA==
-  data.tar.gz: !binary |-
-    NDE0YzllMWRjN2E0M2RlNGJiN2JjY2MzYTdkZGRmNGMwOTYyZDljNQ==
+SHA1:
+  metadata.gz: 544f24bd7aba263a362e116e0b478bc0096ca5ef
+  data.tar.gz: c07059b72cc076c904880bcbb2e22a6eb8347952
 SHA512:
-  metadata.gz: !binary |-
-    NThmZDg2MmI5OTQ1OTUwYTliYmRmZjlkZGFlMjM1MGU5ODIwNzQ1NjFmOTk2
-    OTQyNDdhN2I4MjE0ODE0ZTZjZmUyNjQ1NzgzMDM1NjJiOGUzYTQ3MDZmZDBm
-    Y2QyZDRjMWQ3MTZkNjBkMGIxMzExMmZjOThlNzk5OGU1OGI4Mzk=
-  data.tar.gz: !binary |-
-    M2QxMzhjOTJlNzUwNDk1NDE0ZWM1YjBjNDY0MTI2MmVhYTY3NTkzMjcwYjM4
-    YTYwZmM0NTQ5NzcxYzc3NGIwYWMyZjRhYjY1NTQwMzhlMmU1Nzg0N2JmNGJk
-    MjU4MjZlNDBjZTBmNWVmODI1MDIwZmQzZmU0MGU3YmE2YTRiZWQ=
+  metadata.gz: 7af98b5bc6c3070704b139b0cab9cbc8da25d646955036adc2335ea225ea241708ef7aa998440d233d0b4bd58ba4c5e5df9c2a5c788e17d9c55f700577feef31
+  data.tar.gz: fe36aae7cdbb1ddaf2ed77504181eb53885ab7aed58467cee87ca474932ea0541e0c7b96feb7839e4884d81f58140d6e5a84635f5267b0a4e71b0d12caf1ff93

data/README.md

@@ -1,106 +1,125 @@
-# Cassette::Client
-
-Library to generate and validate STs and TGTs
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'cassette'
-
-And then execute:
-
-    $ bundle
-
-## Usage
-
-Require this library and create an intializer to set its configuration:
-
-
-    Cassette.config = config
-
-
-where config is an object that responds to the methods #base for the base CAS uri, #username and #password
-if you are authenticating on other systems and #service and #base\_authority if you are using the authentication filter
-to authenticate your app
-
-
-You may also set the caching backend using the .backend= module method:
-
-
-    Cassette::Cache.backend = ActiveSupport::Cache::MemcacheStorage.new
-
-
-By default, Cassette::Cache will check if you have Rails.cache defined or instantiate a new ActiveSupport::Cache::MemoryStore
-
-
-To authenticate your Rails app, add to your ApplicationController (or any authenticated controller):
-
-
-    class ApplicationController < ActionController::Base
-      include Cassette::Authentication::Filter
-
-
-      (...)
-
-    end
-
-
-You should also rescue from Cassette::Errors::Forbidden with more friendly errors
-
-If you wish to have actions that skip the authentication filter, add to your controller:
-
-
-    skip_authentication [options]
-
-
-Where options are the same options you can pass to Rails' __skip_before_filter__ method
-
-## RubyCAS client helpers
-
-
-If you are authenticating users with RubyCAS and want role checking, in your rubycas initializer:
-
-
-    require "cas/rubycas"
-
-
-And in your ApplicationController (or any authenticated controller):
-
-
-    include Cassette::Rubycas::Helper
-
-    # - Allow only employees:
-    #
-    # before_filter :employee_only_filter
-    #
-    # rescue_from Cassette::Errors::NotAnEmployee d
-    #   redirect_to '/403.html'
-    # end
-
-    # - Allow only customers:
-    #
-    # before_filter :customer_only_filter
-    #
-    # rescue_from Cassette::Errors::NotACustomer do
-    #   redirect_to '/403.html'
-    # end
-
-
-## Instantiating Cassette::Client and Cassette::Authentication
-
-You can create your own instances of __Cassette::Client__ (st/tgt generator) and __Cassette::Authentication__ (st validator).
-
-The constructor accepts a hash with keys (as symbols) for the values of cache, logger, http_client and configuration.
-
-All values default to the same values used when accessing the class methods directly.
-
-Please check the constructors or integration specs for details.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Cassette::Client
+
+Library to generate and validate STs and TGTs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cassette'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+## Usage
+
+Require this library and create an intializer to set its configuration:
+
+```ruby
+Cassette.config = config
+```
+
+where config is an object that responds to the methods #base for the base CAS uri, #username and #password
+if you are authenticating on other systems and #service and #base\_authority if you are using the authentication filter
+to authenticate your app
+
+
+You may also set the caching backend using the .backend= module method:
+
+```ruby
+Cassette::Cache.backend = ActiveSupport::Cache::MemcacheStorage.new
+```
+
+By default, Cassette::Cache will check if you have Rails.cache defined or instantiate a new ActiveSupport::Cache::MemoryStore
+
+
+To authenticate your Rails app, add to your ApplicationController (or any authenticated controller):
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Cassette::Authentication::Filter
+
+  # ...
+end
+```
+
+You should also rescue from Cassette::Errors::Forbidden with more friendly errors
+
+If you wish to have actions that skip the authentication filter, add to your controller:
+
+```ruby
+class SomeController < ApplicationController
+    skip_authentication # [*options]
+
+    # skip_authentication only: "index"
+end
+```
+
+Where options are the same options you can pass to Rails' __skip_before_filter__ method
+
+## RubyCAS client helpers
+
+
+If you are authenticating users with RubyCAS and want role checking, in your rubycas initializer:
+
+```ruby
+require "cas/rubycas"
+```
+
+And in your ApplicationController (or any authenticated controller):
+
+```ruby
+class SomeController < ApplicationController
+    include Cassette::Rubycas::Helper
+
+    # - Allow only employees:
+    #
+    # before_filter :employee_only_filter
+    #
+    # rescue_from Cassette::Errors::NotAnEmployee do
+    #   redirect_to '/403.html'
+    # end
+
+    # - Allow only customers:
+    #
+    # before_filter :customer_only_filter
+    #
+    # rescue_from Cassette::Errors::NotACustomer do
+    #   redirect_to '/403.html'
+    # end
+end
+```
+
+## Instantiating Cassette::Client and Cassette::Authentication
+
+You can create your own instances of __Cassette::Client__ (st/tgt generator) and __Cassette::Authentication__ (st validator).
+
+The constructor accepts a hash with keys (as symbols) for the values of cache, logger, http_client and configuration.
+
+All values default to the same values used when accessing the class methods directly.
+
+Please check the constructors or integration specs for details.
+
+## About caching and tests
+
+It is a good idea to always clear the cache between tests, specially if you're
+using VCR. You can do it by using the invoking the `#clear` method of the cache
+backend in use. The following excerpt will clear the cache of the default client
+`Cassette::Client` instance:
+
+```
+Cassette::Client.cache.backend.clear
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/cassette/authentication/authorities.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require "cassette/authentication"
+require 'cassette/authentication'
 
 class Cassette::Authentication::Authorities
   def self.parse(authorities, base_authority = nil)
@@ -12,20 +12,20 @@ class Cassette::Authentication::Authorities
   end
 
   def has_raw_role?(role)
-    return true if ENV["NOAUTH"]
+    return true if ENV['NOAUTH']
     @authorities.include?(role)
   end
 
   def has_role?(role)
-    return true if ENV["NOAUTH"]
-    has_raw_role?("#{base}_#{role.to_s.upcase.gsub("_", "-")}")
+    return true if ENV['NOAUTH']
+    has_raw_role?("#{base}_#{role.to_s.upcase.gsub('_', '-')}")
   end
 
   def initialize(authorities, base_authority = nil)
     @base_authority = base_authority || Cassette.config.base_authority
 
     if authorities.is_a?(String)
-      @authorities = authorities.gsub(/^\[(.*)\]$/, "\\1").split(",").map(&:strip)
+      @authorities = authorities.gsub(/^\[(.*)\]$/, '\\1').split(',').map(&:strip)
     else
       @authorities = Array(authorities).map(&:strip)
     end

data/lib/cassette/authentication/cache.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
-require "cassette/authentication"
-require "cassette/cache"
+require 'cassette/authentication'
+require 'cassette/cache'
 
 class Cassette::Authentication::Cache
   include Cassette::Cache
@@ -11,7 +11,7 @@ class Cassette::Authentication::Cache
   end
 
   def fetch_authentication(ticket, options = {}, &block)
-    options = {expires_in: 5 * 60, max_uses: 5000, force: false}.merge(options)
+    options = { expires_in: 5 * 60, max_uses: 5000, force: false }.merge(options)
     fetch("Cassette::Authentication.validate_ticket(#{ticket})", options) do
       logger.info("Authentication for #{ticket} is not cached")
       block.call
@@ -19,12 +19,11 @@ class Cassette::Authentication::Cache
   end
 
   def clear_authentication_cache!
-    backend.delete_matched("Cassette::Authentication.validate_ticket*")
-    backend.delete_matched("#{uses_key("Cassette::Authentication.validate_ticket")}*")
+    backend.delete_matched('Cassette::Authentication.validate_ticket*')
+    backend.delete_matched("#{uses_key('Cassette::Authentication.validate_ticket')}*")
   end
 
   protected
 
   attr_accessor :logger
 end
-

data/lib/cassette/authentication/filter.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
-require "active_support/concern"
-require "cassette/authentication/user"
+require 'active_support/concern'
+require 'cassette/authentication/user'
 
 module Cassette::Authentication::Filter
   extend ActiveSupport::Concern
@@ -18,10 +18,10 @@ module Cassette::Authentication::Filter
   end
 
   def validate_authentication_ticket(service = Cassette.config.service)
-    ticket = request.headers["Service-Ticket"] || params[:ticket]
+    ticket = request.headers['Service-Ticket'] || params[:ticket]
 
-    if ENV["NOAUTH"] && !ticket
-      Cassette.logger.debug "NOAUTH set and no Service Ticket, skipping authentication"
+    if ENV['NOAUTH']
+      Cassette.logger.debug 'NOAUTH set and no Service Ticket, skipping authentication'
       self.current_user = Cassette::Authentication::User.new
       return
     end
@@ -30,12 +30,12 @@ module Cassette::Authentication::Filter
   end
 
   def validate_role!(role)
-    return if ENV["NOAUTH"]
-    raise Cassette::Errors::Forbidden unless current_user.has_role?(role)
+    return if ENV['NOAUTH']
+    fail Cassette::Errors::Forbidden unless current_user.has_role?(role)
   end
 
   def validate_raw_role!(role)
-    return if ENV["NOAUTH"]
-    raise Cassette::Errors::Forbidden unless current_user.has_raw_role?(role)
+    return if ENV['NOAUTH']
+    fail Cassette::Errors::Forbidden unless current_user.has_raw_role?(role)
   end
 end

data/lib/cassette/authentication/user.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-require "cassette/authentication"
-require "cassette/authentication/authorities"
-require "delegate"
+require 'cassette/authentication'
+require 'cassette/authentication/authorities'
+require 'delegate'
 
 class Cassette::Authentication::User
   attr_accessor :login, :name, :authorities, :email, :ticket
@@ -16,7 +16,7 @@ class Cassette::Authentication::User
     @email       = attrs[:email]
     @ticket      = attrs[:ticket]
     @authorities = Cassette::Authentication::Authorities
-      .parse(attrs.fetch(:authorities, "[]"), config && config.base_authority)
+                   .parse(attrs.fetch(:authorities, '[]'), config && config.base_authority)
   end
 
   %w(customer employee).each do |type|

data/lib/cassette/authentication.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require "active_support/xml_mini"
+require 'active_support/xml_mini'
 ActiveSupport::XmlMini.backend = 'LibXML'
 
 module Cassette
@@ -19,12 +19,12 @@ module Cassette
 
     def validate_ticket(ticket, service = config.service)
       logger.debug "Cassette::Authentication validating ticket: #{ticket}"
-      raise Cassette::Errors::AuthorizationRequired if ticket.nil? || ticket.blank?
+      fail Cassette::Errors::AuthorizationRequired if ticket.nil? || ticket.blank?
 
       user = ticket_user(ticket, service)
       logger.info "Cassette::Authentication user: #{user.inspect}"
 
-      raise Cassette::Errors::Forbidden unless user
+      fail Cassette::Errors::Forbidden unless user
 
       user
     end
@@ -39,15 +39,15 @@ module Cassette
 
           user = nil
 
-          ActiveSupport::XmlMini.with_backend("LibXML") do
+          ActiveSupport::XmlMini.with_backend('LibXML') do
             result = ActiveSupport::XmlMini.parse(response)
 
-            login = result.try(:[], "serviceResponse").try(:[], "authenticationSuccess").try(:[], "user").try(:[], "__content__")
+            login = result.try(:[], 'serviceResponse').try(:[], 'authenticationSuccess').try(:[], 'user').try(:[], '__content__')
 
             if login
-              attributes = result["serviceResponse"]["authenticationSuccess"]["attributes"]
-              name = attributes.try(:[], "cn").try(:[], "__content__")
-              authorities = attributes.try(:[], "authorities").try(:[], "__content__")
+              attributes = result['serviceResponse']['authenticationSuccess']['attributes']
+              name = attributes.try(:[], 'cn').try(:[], '__content__')
+              authorities = attributes.try(:[], 'authorities').try(:[], '__content__')
 
               user = Cassette::Authentication::User.new(login: login, name: name, authorities: authorities, ticket: ticket, config: config)
             end
@@ -66,7 +66,7 @@ module Cassette
     attr_accessor :cache, :logger, :http, :config
 
     def validate_uri
-      "#{config.base.gsub(/\/?$/, "")}/serviceValidate"
+      "#{config.base.gsub(/\/?$/, '')}/serviceValidate"
     end
   end
 end

data/lib/cassette/cache.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require "active_support/cache"
+require 'active_support/cache'
 
 module Cassette
   module Cache
@@ -14,9 +14,7 @@ module Cassette
       end
     end
 
-    def backend=(backend)
-      @backend = backend
-    end
+    attr_writer :backend
 
     def uses_key(key)
       "uses:#{key}"

data/lib/cassette/client/cache.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
-require "cassette/client"
-require "cassette/cache"
+require 'cassette/client'
+require 'cassette/cache'
 
 class Cassette::Client::Cache
   include Cassette::Cache
@@ -10,17 +10,17 @@ class Cassette::Client::Cache
     self.logger = logger
   end
 
-  def fetch_tgt(options = {}, &block)
-    options = {expires_in: 4 * 3600, max_uses: 5000, force: false}.merge(options)
-    fetch("Cassette::Client.tgt", options) do
+  def fetch_tgt(options = {}, &_block)
+    options = { expires_in: 4 * 3600, max_uses: 5000, force: false }.merge(options)
+    fetch('Cassette::Client.tgt', options) do
       self.clear_st_cache!
-      logger.info "TGT is not cached"
+      logger.info 'TGT is not cached'
       yield
     end
   end
 
-  def fetch_st(service, options = {}, &block)
-    options = {max_uses: 2000, expires_in: 252, force: false}.merge(options)
+  def fetch_st(service, options = {}, &_block)
+    options = { max_uses: 2000, expires_in: 252, force: false }.merge(options)
     fetch("Cassette::Client.st(#{service})", options) do
       logger.info "ST for #{service} is not cached"
       yield
@@ -28,13 +28,13 @@ class Cassette::Client::Cache
   end
 
   def clear_tgt_cache!
-    backend.delete("Cassette::Client.tgt")
-    backend.delete("#{uses_key("Cassette::Client.tgt")}")
+    backend.delete('Cassette::Client.tgt')
+    backend.delete("#{uses_key('Cassette::Client.tgt')}")
   end
 
   def clear_st_cache!
-    backend.delete_matched("Cassette::Client.st*")
-    backend.delete_matched("#{uses_key("Cassette::Client.st")}*")
+    backend.delete_matched('Cassette::Client.st*')
+    backend.delete_matched("#{uses_key('Cassette::Client.st')}*")
   end
 
   protected

data/lib/cassette/client.rb

@@ -15,14 +15,14 @@ module Cassette
     end
 
     def health_check
-      st_for("monitoring")
+      st_for('monitoring')
     end
 
     def tgt(usr, pwd, force = false)
-      logger.info "Requesting TGT"
+      logger.info 'Requesting TGT'
       cache.fetch_tgt(force: force) do
         response = http.post(tickets_uri, username: usr, password: pwd)
-        tgt = $1 if response.headers["Location"] =~ /tickets\/(.*)/
+        tgt = Regexp.last_match(1) if response.headers['Location'] =~ /tickets\/(.*)/
         logger.info "TGT is #{tgt}"
         tgt
       end
@@ -46,23 +46,18 @@ module Cassette
 
     attr_accessor :cache, :logger, :http, :config
 
-    def st_with_retry(user, pass, service)
+    def st_with_retry(user, pass, service, retrying = true)
+      st(tgt(user, pass, retrying), service)
+    rescue Cassette::Errors::NotFound => e
+      raise e unless retrying
+
+      logger.info 'Got 404 response, regenerating TGT'
       retrying = false
-      begin
-        st(tgt(user, pass, retrying), service)
-      rescue Cassette::Errors::NotFound => e
-        unless retrying
-          logger.info "Got 404 response, regenerating TGT"
-          retrying = true
-          retry
-        end
-        raise e
-      end
+      retry
     end
 
     def tickets_uri
-      "#{config.base.gsub(/\/?$/, "")}/v1/tickets"
+      "#{config.base.gsub(/\/?$/, '')}/v1/tickets"
     end
   end
 end
-

data/lib/cassette/errors/not_a_customer.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "cassette/errors"
+require 'cassette/errors'
 
 module Cassette
   module Errors
@@ -11,4 +11,3 @@ module Cassette
     end
   end
 end
-

data/lib/cassette/errors/not_an_employee.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require "cassette/errors"
+require 'cassette/errors'
 
 module Cassette
   module Errors
@@ -11,4 +11,3 @@ module Cassette
     end
   end
 end
-

data/lib/cassette/errors.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require "active_support/inflector"
+require 'active_support/inflector'
 
 module Cassette
   module Errors
@@ -10,16 +10,16 @@ module Cassette
       403 => :forbidden,
       500 => :internal_server_error,
       404 => :not_found,
-      412 => :precondition_failed,
+      412 => :precondition_failed
     }
 
     def self.raise_by_code(code)
       name = TYPES[code.to_i]
 
       if name
-        raise error_class(name)
+        fail error_class(name)
       else
-        raise error_class(:internal_server_error)
+        fail error_class(:internal_server_error)
       end
     end
 
@@ -29,16 +29,16 @@ module Cassette
 
     class Base < StandardError
       def code
-        self.class.const_get("CODE")
+        self.class.const_get('CODE')
       end
     end
 
     TYPES.each do |status, name|
       const_set(name.to_s.camelize, Class.new(Errors::Base))
-      error_class(name).const_set("CODE", status)
+      error_class(name).const_set('CODE', status)
     end
   end
 end
 
-require "cassette/errors/not_an_employee"
-require "cassette/errors/not_a_customer"
+require 'cassette/errors/not_an_employee'
+require 'cassette/errors/not_a_customer'