rails_authorize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 027d91ec6d457200114228f09d8f8e17022c8eee
+  data.tar.gz: 71413e8ae25c57b7e93f7c1132a47b7afe680237
+SHA512:
+  metadata.gz: 37dfd217674de5eafea89bf6a6c1b1548a958e0e9c1115b758e6c70d438adb403f0a5a95e696f09b9d10d31f7805ed2008e9cbf61ac0774739507b7cd617c751
+  data.tar.gz: a2aabe9427a0748094f9bf81ff8ec7b7b425a90cc829b9db57290630e4596ba2e7c29f2698e17913e4fb1d6a41a38c6abd9b70da52098cdfc7d3a41a4bf2ab5f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_authorize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    rails_authorize (0.1.0)
+      activesupport (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.8.6)
+    minitest (5.10.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15.4)
+  rails_authorize!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 rjurado
+
+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,101 @@
+# RailsAuthorize
+![Build Status](https://travis-ci.org/rjurado01/rails_authorize.svg?branch=master)
+
+Simple and flexible authorization Rails system inspired by Pundit.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_authorize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_authorize
+
+## Example
+
+```
+# app/models/post.rb
+
+class Post
+  def published?
+    return published == true
+  end
+end
+```
+
+```
+# app/authorizations/application_authorization.rb
+
+class ApplicationAuthorization
+  attr_reader :user, :target, :context
+
+  def initialize(user, target, context)
+    @user = user
+    @target = target
+    @context = context
+  end
+end
+```
+
+```
+# app/authorizations/post_authorization.rb
+
+class PostAuthorization < ApplicationAuthorization
+  def index?
+    true
+  end
+
+  def show?
+    user.is_admin? and target.published?
+  end
+
+  def scope
+    target.where(published: true)
+  end
+end
+```
+
+```
+# app/controllers/application_controller.rb
+
+class ApplicationController < ActionController::Base
+  include RailsAuthorization
+end
+```
+
+```
+# app/controllers/posts_controller.rb
+
+class PostController
+  def index
+    @posts = authorized_scope(Post)
+  end
+
+  def show
+    @post = Post.find(params[:id])
+    authorize @post
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rjurado01/rails_authorize.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_authorize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_authorize/version.rb

@@ -0,0 +1,3 @@
+module RailsAuthorize
+  VERSION = "0.1.0"
+end

data/lib/rails_authorize.rb

@@ -0,0 +1,74 @@
+require 'rails_authorize/version'
+
+module RailsAuthorize
+  # Error that will be raised when authorization has failed
+  class NotAuthorizedError < StandardError; end
+
+  ##
+  # Finds authorization class for given target and returns new instance
+  #
+  # @param target [any] the target to load authorization
+  # @param options [Hash] key/value options (user, authorization, context)
+  # @param options[:user] [Object] the user that initiated the action
+  # @param options[:authorization] [Class] Authorization class to use for authenticate
+  # @param options[:context] [Hash] other key/value options to use in the authorization methods
+  #
+  # @return [Object] new authorization instance
+  #
+  def authorization(target, options={})
+    user = options[:user] || current_user
+    klass = options[:authorization] || "#{target.model_name.name}Authorization".constantize
+
+    klass.new(user, target, options[:context])
+  end
+
+  ##
+  # Throwing an error if the user is not authorized to perform the given action
+  #
+  # @param target [Object] the target we're checking permissions of
+  # @param options [Hash] key/value options (action, user, authorization, context)
+  # @param options[:action] [String] the method to check on the authorization (e.g. `:show?`)
+  #
+  # @raise [NotAuthorizedError] if the given action method returned false
+  # @return [Object] the passed target
+  #
+  def authorize(target, options={})
+    action = options.delete(:action) || "#{action_name}?"
+    authorization = authorization(target, options)
+
+    raise(NotAuthorizedError) unless authorization.public_send(action)
+
+    target
+  end
+
+  ##
+  # Retrieves the authorization scope for the given target
+  #
+  # @param target [Object] the target we're retrieving the policy scope for
+  # @param options [Hash] key/value options (user, authorization, context)
+  #
+  # @return [Scope] authorized scope
+  #
+  def authorization_scope(target, options={})
+    authorization(target, options).scope
+  end
+
+  ##
+  # Throwing an error if the user is not authorized to perform the given action
+  #
+  # @param target [Object] the target we're retrieving the policy scope for
+  # @param options [Hash] key/value options (action, user, authorization, context)
+  # @param options[:action] [String] the method to check on the authorization (e.g. `:show?`)
+  #
+  # @raise [NotAuthorizedError] if the given action method returned false
+  # @return [Scope] authorization scope
+  #
+  def authorized_scope(target, options={})
+    action = options.delete(:action) || "#{action_name}?"
+    authorization = authorization(target, options)
+
+    raise(NotAuthorizedError) unless authorization.public_send(action)
+
+    authorization.scope
+  end
+end

data/rails_authorize.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_authorize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rails_authorize'
+  spec.version       = RailsAuthorize::VERSION
+  spec.authors       = ['rjurado01']
+  spec.email         = ['rjurado01@gmail.com']
+
+  spec.summary       = 'Simple and flexible authorization Rails system'
+  spec.description   = 'Authorization system for Rails with only few helpers and regular Ruby classes.'
+  spec.homepage      = 'https://github.com/rjurado01/rails_authorize'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'activesupport', '~> 3.0', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rails_authorize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rjurado01
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Authorization system for Rails with only few helpers and regular Ruby
+  classes.
+email:
+- rjurado01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_authorize.rb
+- lib/rails_authorize/version.rb
+- rails_authorize.gemspec
+homepage: https://github.com/rjurado01/rails_authorize
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Simple and flexible authorization Rails system
+test_files: []