guachiman-rails 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ff0bc3ea49cd25fa5316275c91f4294ecd2a204
+  data.tar.gz: 587e98a3eebbb0bc1c0bc3e5053e83a93e77626b
+SHA512:
+  metadata.gz: 7a45afbcae201def6c8e3292fa4d16d65d6e42179b2550041d191af5757ca62ae34e8a2572020efd2800c146c081b7c9ec203598635dd20b082c71b80e97a9fb
+  data.tar.gz: c66a6871dfbabf18fff46c89b4dca4fd3150b2e7b7c91c1a19ccbc9db82ed77183bb4f2541861c5f723142f3904b37df5d4a62226b2d5f132d3a49c09b95756a

data/.gitignore

@@ -0,0 +1,17 @@
+*.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 guachiman.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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,128 @@
+Guachiman for Rails
+===================
+
+Basic Authorization gem for rails based on [RailsCast #385 Authorization from Scratch][1] by Ryan Bates.
+Built on top of [guachiman][2].
+
+[![Codeship Status for goddamnhippie/guachiman-rails][3]][4]
+
+[1]: http://railscasts.com/episodes/385-authorization-from-scratch-part-1
+[2]: https://github.com/goddamnhippie/guachiman
+[3]: https://www.codeship.io/projects/06034ef0-f456-0131-65bd-5a054a318c0e/status
+[4]: https://www.codeship.io/projects/28084
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guachiman-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it directly:
+
+```bash
+$ gem install guachiman-rails
+```
+
+Usage
+-----
+
+Run `rails g guachiman:install`
+
+This will generate a `authorization.rb` file in `app/models`.
+
+Include `Guachiman::Authorizable` in `ApplicationController` and implement a `current_user` method there.
+
+```ruby
+# app/controllers/application_controller.rb
+
+include Guachiman::Authorizable
+
+def current_user
+  @current_user ||= User.find_by_auth_token(cookies[:auth_token]) if cookies[:auth_token]
+end
+```
+
+You can also override these methods to change the behaviour, for example:
+
+### To skip authorization for admins
+
+Defaults to `false`.
+
+```ruby
+def skip_authorization?
+  current_user.admin?
+end
+```
+
+### To handle what happens after the authorization takes place
+
+This is the default implementation.
+
+```ruby
+def after_authorization(authorized)
+  return true if authorized
+
+  if request.get? && !request.xhr?
+    redirect_to root_path, alert: t(:not_authorized)
+  else
+    render nothing: true, status: :unauthorized
+  end
+end
+```
+
+That's it, now you can describe your authorization object in this way:
+
+```ruby
+class Authorization
+  include Guachiman
+
+  def initialize(user)
+    if @current_user = user
+      user_authorization
+    else
+      guest_authorization
+    end
+  end
+
+private
+
+  def guest_authorization
+    allow :sessions, [:new, :create]
+    allow :users,    [:new, :create]
+  end
+
+  def user_authorization
+    guest_authorization
+
+    allow :users, [:show, :edit, :update] do |user|
+      @current_user.id == user.id
+    end
+  end
+end
+```
+
+The method `#current_resource` will default to nil but you can override in the controllers:
+
+```ruby
+class UsersController < ApplicationController
+  # ...
+
+  def current_resource
+    @user ||= params[:id].present? ? User.find(params[:id]) : User.new
+  end
+end
+```
+
+License
+-------
+
+MIT

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+  task.pattern = 'test/**/*_test.rb'
+  task.warning = true
+  task.verbose = true
+end
+
+task default: :test

data/guachiman-rails.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'guachiman/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'guachiman-rails'
+  spec.version       = Guachiman::Rails::VERSION
+  spec.authors       = ['Francesco Rodriguez', 'Gustavo Beathyate']
+  spec.email         = ['lrodriguezsanc@gmail.com', 'gustavo.bt@me.com']
+  spec.summary       = 'Rails specific implementation of the Guachiman gem'
+  spec.description   = "#{ spec.summary } for authorization in ActionController"
+  spec.homepage      = 'https://github.com/goddamnhippie/guachiman-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'guachiman', '~> 1.0', '>= 1.0.2'
+  spec.add_dependency 'railties',  '~> 4.0', '>= 4.0.0'
+
+  spec.add_development_dependency 'rake',     '~> 10.3', '>= 10.3.0'
+  spec.add_development_dependency 'minitest', '~>  5.3', '>=  5.3.3'
+  spec.add_development_dependency 'bundler',  '~>  1.6', '>=  1.6.0'
+end

data/lib/generators/guachiman/rails/install/install_generator.rb

@@ -0,0 +1,14 @@
+module Guachiman
+  module Rails
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc 'Create Authorization model'
+        source_root File.expand_path '../templates', __FILE__
+
+        def copy_authorization_model
+          template 'authorization.rb', 'app/models/authorization.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/guachiman/rails/install/templates/authorization.rb

@@ -0,0 +1,25 @@
+class Authorization
+  include Guachiman
+
+  def initialize(user)
+    if @current_user = user
+      user_authorization
+    else
+      guest_authorization
+    end
+  end
+
+private
+
+  def guest_authorization
+    # allow :sessions, [:new, :create]
+  end
+
+  def user_authorization
+    guest_authorization
+
+    # allow :users, [:show, :edit, :update] do |user_id|
+    #   @current_user.id == user_id
+    # end
+  end
+end

data/lib/guachiman/rails/authorizable.rb

@@ -0,0 +1,41 @@
+module Guachiman
+  module Authorizable
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :authorize, unless: :skip_authorization?
+    end
+
+    def authorization
+      @authorization ||= Authorization.new(current_user)
+    end
+
+    def current_user
+      raise NotImplementedError
+    end
+
+    def current_resource
+      nil
+    end
+
+    def skip_authorization?
+      false
+    end
+
+    def authorize
+      authorized = authorization.allow?(controller_name, action_name, current_resource)
+
+      after_authorization(authorized)
+    end
+
+    def after_authorization(authorized)
+      return true if authorized
+
+      if request.get? && !request.xhr?
+        redirect_to root_path, alert: t(:not_authorized)
+      else
+        render nothing: true, status: :unauthorized
+      end
+    end
+  end
+end

data/lib/guachiman/rails/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+require 'authorizable'
+
+module Guachiman
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/guachiman/rails/version.rb

@@ -0,0 +1,5 @@
+module Guachiman
+  module Rails
+    VERSION = '1.0.0.pre'
+  end
+end

data/lib/guachiman-rails.rb

@@ -0,0 +1,2 @@
+require 'guachiman/rails/version'
+require 'guachiman/rails/railtie'

data/test/generators/install_generator_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+require 'rails/generators/test_case'
+require 'generators/guachiman/rails/install/install_generator'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  DESTINATION = File.expand_path File.join(File.dirname(__FILE__), '..', '..', 'tmp')
+  FileUtils.mkdir_p DESTINATION unless Dir.exist? DESTINATION
+
+  destination DESTINATION
+
+  tests Guachiman::Rails::Generators::InstallGenerator
+  setup :prepare_destination
+
+  def prepare_destination
+    if Dir.exists? "#{ DESTINATION }/app"
+      FileUtils.rm_r "#{ DESTINATION }/app"
+    end
+
+    FileUtils.mkdir_p "#{ DESTINATION }/app/models"
+  end
+
+  test 'create permission' do
+    run_generator
+
+    assert_file 'app/models/authorization.rb' do |f|
+      assert_match /include Guachiman/, f
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'guachiman'

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: guachiman-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Francesco Rodriguez
+- Gustavo Beathyate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guachiman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: Rails specific implementation of the Guachiman gem for authorization
+  in ActionController
+email:
+- lrodriguezsanc@gmail.com
+- gustavo.bt@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- guachiman-rails.gemspec
+- lib/generators/guachiman/rails/install/install_generator.rb
+- lib/generators/guachiman/rails/install/templates/authorization.rb
+- lib/guachiman-rails.rb
+- lib/guachiman/rails/authorizable.rb
+- lib/guachiman/rails/railtie.rb
+- lib/guachiman/rails/version.rb
+- test/generators/install_generator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/goddamnhippie/guachiman-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Rails specific implementation of the Guachiman gem
+test_files:
+- test/generators/install_generator_test.rb
+- test/test_helper.rb