requirement_authorization 0.0.0 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a034f7d906176f135e97942a859d5cde20a6d7f
+  data.tar.gz: d46ced5f2d6fcdfd4bbb7e5a5d80fb473932825a
+SHA512:
+  metadata.gz: 00ba9c4129d193637a0be456b9824ff499ea6ebe11ae37500ace6c4c812d6c8f2b366c039bdef79edf2f797a4e8cb973fb00951556d6520d8cc8ee2bd9288c01
+  data.tar.gz: 03a1bd45f1748a38358b3e1b6a3ecd9130119e02a99a14f19b26b9ea0a1a7faaed46038e16633c4dfe39aced2b28ab3ff3ce713f48ca2b372391447e266a3a23

data/.gitignore

@@ -1,2 +1,18 @@
 .DS_Store
-pkg/*.gem
+*.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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in requirement_authorization.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Gessler
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# Requirement Authorization
+
+Requirement authorization is a lightweight DSL designed to separate the concerns of resource access from gathering information required to access an action. It also lets you pass arguments into Rails before_filters for more control over what may or may not be accessed.
+
+WARNING: This puppy isn't tested yet, but its the very next thing I plan on doing. I wanted to get this up on github first so that we could gemify this into our own project and build out tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'requirement_authorization'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install requirement_authorization
+
+Then include it in your Rails application:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include RequirementAuthorization
+
+  # Your requirements here..
+
+  # Your code here...
+end
+```
+
+## Examples
+
+A more interesting example may be to protect a paid feature from being accessed by users who did not pay for that feature:
+
+    requirement :feature do |r|
+      r.guard_unless  { |feature| current_user.account.send("#{feature}_enabled?") }
+      r.resolution    { |feature| redirect_to upgrade_path(feature) }
+    end
+
+In the controller just add
+
+    class AwesomeSauceController < ActionController::Base
+      feature_required :awesome_sauce
+    end
+
+A more trivial example for SSL
+
+    requirement :ssl do |r|
+      r.guard_unless  { request.ssl? }
+      r.resolution    { redirect_to "https://" + request.host + request.request_uri }
+    end
+  
+Then in the controller:
+
+    class PaymentMethodsController << ActionController::Base
+      ssl_required
+    end

data/Rakefile

@@ -1,38 +1 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-desc 'Default: run specs.'
-task :default => :spec
-
-require 'rake'
-require 'spec/rake/spectask'
-
-desc "Run all examples"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/*.rb']
-  t.fail_on_error = false
-end
-
-desc 'Generate documentation for the has_default plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'HasDefault'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "requirement_authorization"
-    gemspec.summary = "A lightweight authorization framework that separates the concern of resource access from gathering information necessary to fulfill a request, like singing in with a username and password."
-    gemspec.description = ""
-    gemspec.email = "brad@conden.se"
-    gemspec.homepage = "http://github.com/bradgessler/requirement_authorization"
-    gemspec.authors = ["Brad Gessler"]
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+require "bundler/gem_tasks"

data/lib/requirement_authorization.rb

@@ -1,18 +1,19 @@
-# TODO release this as a plugin as it matures
+require "requirement_authorization/version"
+
 module RequirementAuthorization
   METHOD_SUFIX = '_required'
-  
+
   def self.included(base)
     base.send :extend, ClassMethods
   end
-  
+
   class Requirement
     CONTROLLER_OPTIONS = [:only, :except, :if, :unless]
 
     def initialize(opts={},&block)
       yield self if block_given?
     end
-    
+
     # A proc or method that must return a true for the requirement to be satisified
     def guard(proc=nil, &block)
       @guard = controller_filter_proc(proc, &block)
@@ -23,24 +24,26 @@ module RequirementAuthorization
       # Lazily invert the return of the controller proc.
       @guard = Proc.new{|c, args| not controller_filter_proc(proc, &block).call(c, *args)}
     end
-    
+
     # This is the method that we'll call if the guard fails. The resolution should take the user
     # through a flow where they can satisify the requirements for the requirement and pass on through.
     def resolution(proc=nil, &block)
       @resolution = controller_filter_proc(proc, &block)
     end
-    
+
     # Sets up the filter for the controller by wrapping this requirement up in a proc.
     def filter(controller, *args)
       args, controller_options = extract_filter_args!(args)
-      controller.before_filter Proc.new{|c| self.call(c, *args)}, controller_options
+      # Capture the Method object here in case the scope of the block changes
+      resolve_method = method(:resolve)
+      controller.before_filter(controller_options){ |c| resolve_method.call(c, *args) }
     end
-    
+
     # The gaurd, resolution process. This is where the magic happens.
-    def call(controller_instance, *args)
+    def resolve(controller_instance, *args)
       @resolution.call(controller_instance, *args) if @guard.call(controller_instance, *args)
     end
-    
+
   protected
     # Packages up a proc or a block into something that a controller can deal with
     def controller_filter_proc(proc=nil, &block)
@@ -71,32 +74,35 @@ module RequirementAuthorization
       [ args, controller_options ]
     end
   end
-  
+
   module ClassMethods
     # Setups a hash table of requirements that may be used by class methods from
     # other sub-classed controllers
     def requirement(requirement, opts={}, &block)
       self.requirements.merge! requirement.to_s => Requirement.new(opts, &block)
-      
+
       # Build out the class method for this requirement. This is primarly used towards the
       # top of a controller.
-      self.class.class_eval %{
+      instance_eval %{
         def #{requirement}#{METHOD_SUFIX}(*args)
           requirements['#{requirement}'].filter(self, *args)
         end}
-      
+
       # Build out the instance method so that this requirement can be called from other
-      # instance methods. This proves to be insanely useful for composing requirements 
+      # instance methods. This proves to be insanely useful for composing requirements
       # together or reusing them from other methods.
-      self.class_eval %{
+      class_eval %{
         def #{requirement}#{METHOD_SUFIX}(*args)
-          self.class.send(:requirements)['#{requirement}'].call(self, *args)
+          req = '#{requirement}'
+          self.class.send(:requirements).
+            fetch(req).
+            resolve(self, *args)
         end}
     end
-        
+
   protected
     def requirements
       @@requirements ||= {}
     end
   end
-end
+end

data/lib/requirement_authorization/version.rb

@@ -0,0 +1,3 @@
+module RequirementAuthorization
+  VERSION = "0.0.2"
+end

data/requirement_authorization.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'requirement_authorization/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "requirement_authorization"
+  spec.version       = RequirementAuthorization::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["brad@polleverywhere.com"]
+  spec.summary       = %q{Quickly create before_filters in Rails that protect resources.}
+  spec.homepage      = "https://github.com/bradgessler/requirement_authorization"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/requirement_authorization_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../lib/requirement_authorization'
 
 describe RequirementAuthorization do
-  it "should have tests"
+  it "is tested in a production web application"
 end

metadata

@@ -1,61 +1,97 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: requirement_authorization
-version: !ruby/object:Gem::Version 
-  version: 0.0.0
+version: !ruby/object:Gem::Version
+  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Brad Gessler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-10-20 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
-description: ""
-email: brad@conden.se
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- brad@polleverywhere.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.markdown
-files: 
-- .gitignore
-- README.markdown
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
 - Rakefile
 - VERSION
 - lib/requirement_authorization.rb
-- rails/init.rb
+- lib/requirement_authorization/version.rb
+- requirement_authorization.gemspec
 - spec/requirement_authorization_spec.rb
-has_rdoc: true
-homepage: http://github.com/bradgessler/requirement_authorization
-licenses: []
-
+homepage: https://github.com/bradgessler/requirement_authorization
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
-summary: A lightweight authorization framework that separates the concern of resource access from gathering information necessary to fulfill a request, like singing in with a username and password.
-test_files: 
+specification_version: 4
+summary: Quickly create before_filters in Rails that protect resources.
+test_files:
 - spec/requirement_authorization_spec.rb

data/README.markdown

@@ -1,64 +0,0 @@
-# Requirement Authorization
-
-Requirement authorization is a lightweight DSL designed to separate the concerns of resource access from gathering information required to access the resource.
-
-WARNING: This puppy isn't tested yet, but its the very next thing I plan on doing. I wanted to get this up on github first so that we could gemify this into our own project and build out tests.
-
-## Installation
-
-In your rails config/environment.rb file, just add
-
-    config.gem 'requirement_authorization', :source => 'http://gemcutter.org'
-
-## Examples
-
-A more interesting example may be to protect a paid feature from being accessed by users who did not pay for that feature:
-
-    requirement :feature do |r|
-      r.guard_unless  { |feature| current_user.account.send("#{feature}_enabled?") }
-      r.resolution    { |feature| redirect_to upgrade_path(feature) }
-    end
-
-In the controller just add
-
-    class AwesomeSauceController < ActionController::Base
-      feature_required :awesome_sauce
-    end
-
-A more trivial example for SSL
-
-    requirement :ssl do |r|
-      r.guard_unless  { request.ssl? }
-      r.resolution    { redirect_to "https://" + request.host + request.request_uri }
-    end
-  
-Then in the controller:
-
-    class PaymentMethodsController << ActionController::Base
-      ssl_required
-    end
-  
-## License
-
-Copyright (c) 2009 Brad Gessler
-
-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/rails/init.rb

@@ -1,3 +0,0 @@
-require File.dirname(__FILE__) + '/../lib/requirement_authorization.rb'
-
-ActionController::Base.send(:include, RequirementAuthorization)