banken 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b535c2ea0ee44062ee539386142447ab1db0054
+  data.tar.gz: 74d457b467b4ec2c8a4d39899732aad37ff90d36
+SHA512:
+  metadata.gz: 0aa2d9fd1a1eb732252d0093fa407f654fc6d47396b16888771d35c719226ebb9c151d51650354856959dc90b3ddd2987508c8f02a8ce90ed883ed697aae3133
+  data.tar.gz: e081bc1f541fe7476cd46170a72dcac38fc12c01ef4709c7d1c6da27dc20154242dbedccfeb0cd60550507daba95ba2b7a737659ba16a3ce8c7d70ffeec74d59

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in banken.gemspec
+gem "rspec", ENV["RSPEC_VERSION"] unless ENV["RSPEC_VERSION"].to_s.empty?
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kyuden
+
+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,41 @@
+# Banken
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/banken`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'banken'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banken
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/banken. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/banken.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'banken/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banken"
+  spec.version       = Banken::VERSION
+  spec.authors       = ["kyuden"]
+  spec.email         = ["msmsms.um@gmail.com"]
+
+  spec.summary       = %q{OO authorization for Rails.}
+  spec.description   = %q{Object oriented authorization like pundit for Rails applications.}
+  spec.homepage      = "https://github.com/kyuden/banken"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
+
+  spec.add_development_dependency "activemodel", ">= 3.0.0"
+  spec.add_development_dependency "actionpack", ">= 3.0.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec", ">=2.0.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+end

data/lib/banken.rb

@@ -0,0 +1,119 @@
+require "active_support/concern"
+require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/module/introspection"
+require "banken/version"
+require "banken/error"
+require "banken/helper"
+require "banken/policy_finder"
+
+module Banken
+  extend ActiveSupport::Concern
+
+  included do
+    # TODO
+    # helper Helper if respond_to?(:helper)
+    if respond_to?(:helper_method)
+      # TODO
+      # helper_method :banken_policy_scope
+      helper_method :banken_user
+    end
+    if respond_to?(:hide_action)
+      hide_action :policy_scope
+      hide_action :permitted_attributes
+      hide_action :policy
+      hide_action :banken_user
+      hide_action :skip_authorization
+      hide_action :skip_policy_scope
+      hide_action :verify_authorized
+      hide_action :verify_policy_scoped
+      hide_action :policies
+      hide_action :policy_scopes
+    end
+  end
+
+  class << self
+    def policy_scope!(controller, user, scope)
+      PolicyFinder.new(controller).scope!.new(user, scope).resolve
+    end
+
+    def policy!(controller, user, record)
+      PolicyFinder.new(controller).policy!.new(user, record)
+    end
+  end
+
+  def authorize!(record=nil)
+    @_banken_policy_authorized = true
+
+    policy = policy(record)
+    unless policy.public_send("#{banken_action_name}?")
+      raise NotAuthorizedError.new(controller: banken_controller_name, action: banken_action_name, policy: policy)
+    end
+
+    true
+  end
+
+  def policy_scope(scope)
+    @_banken_policy_scoped = true
+    banken_policy_scope(scope)
+  end
+
+  def permitted_attributes(record)
+    name = record.class.to_s.demodulize.underscore
+    params.require(name).permit(policy(record).permitted_attributes)
+  end
+
+  def policy(record)
+    policies[banken_action_name] ||= Banken.policy!(banken_controller_name, banken_user, record)
+  end
+
+  def banken_user
+    current_user
+  end
+
+  def skip_authorization
+    @_banken_policy_authorized = true
+  end
+
+  def skip_policy_scope
+    @_banken_policy_scoped = true
+  end
+
+  def verify_authorized
+    raise AuthorizationNotPerformedError unless banken_policy_authorized?
+  end
+
+  def verify_policy_scoped
+    raise PolicyScopingNotPerformedError unless banken_policy_scoped?
+  end
+
+  def banken_policy_authorized?
+    !!@_banken_policy_authorized
+  end
+
+  def banken_policy_scoped?
+    !!@_banken_policy_scoped
+  end
+
+  def policies
+    @_banken_policies ||= {}
+  end
+
+  def policy_scopes
+    @_banken_policy_scopes ||= {}
+  end
+
+  private
+
+    def banken_policy_scope(scope)
+      policy_scopes[scope] ||= Banken.policy_scope!(banken_controller_name, banken_user, scope)
+    end
+
+    def banken_action_name
+      params[:action].to_s
+    end
+
+    def banken_controller_name
+      params[:controller].to_s
+    end
+end

data/lib/banken/error.rb

@@ -0,0 +1,26 @@
+module Banken
+  class Error < StandardError; end
+
+  class NotAuthorizedError < Error
+    attr_reader :controller, :action, :policy
+
+    def initialize(options={})
+      if options.is_a? String
+        message = options
+      else
+        @controller = options[:controller]
+        @action     = options[:action]
+        @policy     = options[:policy]
+
+        message = options.fetch(:message) { "not allowed to #{action} of #{controller} by #{policy.inspect}" }
+      end
+
+      super(message)
+    end
+  end
+
+  class NotDefinedError < Error; end
+  class AuthorizationNotPerformedError < Error; end
+
+  class PolicyScopingNotPerformedError < AuthorizationNotPerformedError; end
+end

data/lib/banken/helper.rb

@@ -0,0 +1,8 @@
+module Banken
+  module Helper
+    # TODO
+    # def policy_scope(scope)
+    #   banken_policy_scope(scope)
+    # end
+  end
+end

data/lib/banken/policy_finder.rb

@@ -0,0 +1,41 @@
+module Banken
+  class PolicyFinder
+    SUFFIX = "Policy"
+
+    attr_reader :controller
+
+    def initialize(controller)
+      @controller = controller
+    end
+
+    def scope
+      policy::Scope if policy
+    rescue NameError
+      nil
+    end
+
+    def policy
+      klass = find
+      klass = klass.constantize if klass.is_a?(String)
+      klass
+    rescue NameError
+      nil
+    end
+
+    def scope!
+      raise NotDefinedError, "unable to find policy scope of nil" unless controller
+      scope || raise(NotDefinedError, "unable to find scope `#{find}::Scope` for `#{controller}`")
+    end
+
+    def policy!
+      raise NotDefinedError, "unable to find policy of nil" unless controller
+      policy || raise(NotDefinedError, "unable to find policy `#{find}` for `#{controller}`")
+    end
+
+    private
+
+      def find
+        "#{controller.camelize}#{SUFFIX}"
+      end
+  end
+end

data/lib/banken/version.rb

@@ -0,0 +1,3 @@
+module Banken
+  VERSION = "0.0.1"
+end

data/lib/generators/banken/install/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Generates an application policy as a starting point for your application.

data/lib/generators/banken/install/install_generator.rb

@@ -0,0 +1,11 @@
+module Banken
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def copy_application_policy
+        template 'application_policy.rb', 'app/policies/application_policy.rb'
+      end
+    end
+  end
+end

data/lib/generators/banken/install/templates/application_policy.rb

@@ -0,0 +1,53 @@
+class ApplicationPolicy
+  attr_reader :user, :record
+
+  def initialize(user, record)
+    @user = user
+    @record = record
+  end
+
+  def index?
+    false
+  end
+
+  def show?
+    scope.where(:id => record.id).exists?
+  end
+
+  def create?
+    false
+  end
+
+  def new?
+    create?
+  end
+
+  def update?
+    false
+  end
+
+  def edit?
+    update?
+  end
+
+  def destroy?
+    false
+  end
+
+  def scope
+    Scope.new(user, record.class).resolve
+  end
+
+  class Scope
+    attr_reader :user, :scope
+
+    def initialize(user, scope)
+      @user = user
+      @scope = scope
+    end
+
+    def resolve
+      scope
+    end
+  end
+end

data/lib/generators/banken/policy/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a policy for a controller with the given name.
+
+Example:
+    rails generate banken:policy users
+
+    This will create:
+        app/policies/users_policy.rb

data/lib/generators/banken/policy/policy_generator.rb

@@ -0,0 +1,13 @@
+module Banken
+  module Generators
+    class PolicyGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_policy
+        template 'policy.rb', File.join('app/policies', class_path, "#{file_name}_policy.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/banken/policy/templates/policy.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>Policy < ApplicationPolicy
+  class Scope < Scope
+    def resolve
+      scope
+    end
+  end
+end
+<% end -%>

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: banken
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kyuden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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'
+description: Object oriented authorization like pundit for Rails applications.
+email:
+- msmsms.um@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banken.gemspec
+- lib/banken.rb
+- lib/banken/error.rb
+- lib/banken/helper.rb
+- lib/banken/policy_finder.rb
+- lib/banken/version.rb
+- lib/generators/banken/install/USAGE
+- lib/generators/banken/install/install_generator.rb
+- lib/generators/banken/install/templates/application_policy.rb
+- lib/generators/banken/policy/USAGE
+- lib/generators/banken/policy/policy_generator.rb
+- lib/generators/banken/policy/templates/policy.rb
+homepage: https://github.com/kyuden/banken
+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.4.8
+signing_key: 
+specification_version: 4
+summary: OO authorization for Rails.
+test_files: []