strong-permitter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d99ce8089a7014eb095030a03317bc42e9849c19
+  data.tar.gz: d22a533b2d42676459a9745269931e3a9b1ebf87
+SHA512:
+  metadata.gz: e8205fe8c40eb001221101a8c8f17e3febd844eb83a3ffecb7387ab59af457e03077950c97b53278f11f8bc6a9ca915e1ae1390fd9db636212ed3eb67b812d67
+  data.tar.gz: d87b412d995e6471da806b5a6a7582ca9e2d440655dac743a93459d75f26da249474de6a1047ec676829b967a4403237ac794209c375c8c55d2db8a44228ffb9

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+.ruby-version
+.ruby-gemset
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 evg2108
+
+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,87 @@
+# StrongPermitter
+
+This gem allows move params permissions from controllers to separated permission-objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strong-permitter'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Before you start using permission-objects, you need integrate StrongPermitter::Manager to your controllers.
+For this, you may execute console command, which create file strong_permitter.rb in initializers directory:
+
+    $ strong_permitter install
+
+Or you may include StrongPermitter::Manager into ApplicationController:
+
+```ruby
+class ApplicationController < ActionController::Base
+    include StrongPermitter::Manager
+end
+```
+
+For define permission-object you should create ruby file in `app/controllers/permissions` directory.
+File name should match with controller. For `ArticlesController` permission-object file name should be `articles_permission.rb`.
+
+Permission-object code:
+
+```ruby
+class ArticlesPermission < StrongPermitter::Permission::Base
+
+    # standard actions permission
+    create_params :title, :content, :author_name
+    update_params :content
+
+    # for non-standard actions permissions use:
+    # allowed_params_for :action_name, :param1, :param2, ...
+    allowed_params_for :activate_article, :activation_status
+end
+```
+
+After that, you may use `permitted_params` method for your action methods:
+
+```ruby
+class ArticlesController < ApplicationController
+    def update
+        @article = Article.find(params[:id])
+        if @article.update_attributes(permitted_params)
+            # ...
+        else
+            # ...
+        end
+    end
+
+    def create
+        @article = Article.new(permitted_params)
+        if @article.save
+            # ...
+        else
+            # ...
+        end
+    end
+
+    # non-standard action
+    def activate_article
+        @article = Article.find(params[:id])
+        @article.update_attributes(permitted_params)
+        # ...
+    end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/evg2108/strong-permitter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/bin/strong_permitter

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+require 'strong_permitter'
+require 'strong_permitter/cli'
+
+StrongPermitter::Cli.start(*ARGV)

data/lib/strong-permitter.rb

@@ -0,0 +1,13 @@
+require 'strong_permitter/version'
+require 'strong_permitter/manager'
+require 'strong_permitter/permission/base'
+
+if defined? Rails
+  module StrongPermitter
+    class Railtie < ::Rails::Railtie
+      initializer 'strong-permitter.autoload', :before => :set_autoload_paths do |app|
+        app.config.autoload_paths += %W(#{Rails.root}/app/controllers/permissions)
+      end
+    end
+  end
+end

data/lib/strong_permitter/cli.rb

@@ -0,0 +1,34 @@
+module StrongPermitter
+  class Cli
+    def self.start(*args)
+      if args.length != 1
+        puts "Unknown command format. Please use 'strong_permitter -h' for more information."
+        return
+      end
+
+      case args.first
+        when '--help', '-h'
+          puts 'Commands format: strong_permitter <command>'
+          puts 'Available commands:'
+          puts "\tinstall\t- Create initializer for Rails application"
+        when 'install'
+          print 'Creating config/initializers/strong_permitter.rb'
+          if File.exist?('config/initializers/strong_permitter.rb')
+            puts "\t(already exist - skipped)"
+          else
+            FileUtils.cp(File.expand_path('../templates/initializer.rb', __FILE__), 'config/initializers/strong_permitter.rb')
+            puts "\t(ok)"
+          end
+
+          print 'Making directory app/controllers/permissions'
+          if Dir.exist?('app/controllers/permissions')
+            puts "\t\t(already exist - skipped)"
+          else
+            FileUtils.mkpath 'app/controllers/permissions'
+            puts "\t\t(ok)"
+          end
+
+      end
+    end
+  end
+end

data/lib/strong_permitter/manager.rb

@@ -0,0 +1,13 @@
+module StrongPermitter
+  module Manager
+    def permitted_params
+      permission_class = "#{self.class.name.sub('Controller', '')}Permission".camelcase.safe_constantize
+      return nil unless permission_class
+
+      resource_name = permission_class.resource_name || controller_name.singularize
+      allowed_attributes = permission_class.actions[action_name]
+
+      params.require(resource_name).permit(allowed_attributes)
+    end
+  end
+end

data/lib/strong_permitter/permission/base.rb

@@ -0,0 +1,31 @@
+module StrongPermitter
+  module Permission
+    class Base
+      class << self
+        def actions
+          @actions ||= HashWithIndifferentAccess.new { |hash,val| hash[val] = [] }
+        end
+
+        def create_params(*param_names)
+          allowed_params_for :create, *param_names
+        end
+
+        def update_params(*param_names)
+          allowed_params_for :update, *param_names
+        end
+
+        def allowed_params_for(action_name, *param_names)
+          actions[action_name] = param_names
+        end
+
+        def resource_name=(name)
+          @resource_name ||= name
+        end
+
+        def resource_name
+          @resource_name
+        end
+      end
+    end
+  end
+end

data/lib/strong_permitter/templates/initializer.rb

@@ -0,0 +1,3 @@
+class ActionController::Base
+  include StrongPermitter::Manager
+end

data/lib/strong_permitter/version.rb

@@ -0,0 +1,3 @@
+module StrongPermitter
+  VERSION = '0.0.1'
+end

data/strong-permitter.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'strong_permitter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'strong-permitter'
+  spec.version       = StrongPermitter::VERSION
+  spec.authors       = %w(evg2108)
+  spec.email         = %w(evg2108@yandex.ru)
+  spec.summary       = %q{It allows move params permissions from controllers to separated permission-objects}
+  spec.description   = %q{It allows move params permissions from controllers to separated permission-objects}
+  spec.homepage      = 'https://github.com/evg2108/strong-permitter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'actionpack', '~> 4.0'
+  spec.add_dependency 'railties', '~> 4.0'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: strong-permitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- evg2108
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: It allows move params permissions from controllers to separated permission-objects
+email:
+- evg2108@yandex.ru
+executables:
+- strong_permitter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/strong_permitter
+- lib/strong-permitter.rb
+- lib/strong_permitter/cli.rb
+- lib/strong_permitter/manager.rb
+- lib/strong_permitter/permission/base.rb
+- lib/strong_permitter/templates/initializer.rb
+- lib/strong_permitter/version.rb
+- strong-permitter.gemspec
+homepage: https://github.com/evg2108/strong-permitter
+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.2.2
+signing_key: 
+specification_version: 4
+summary: It allows move params permissions from controllers to separated permission-objects
+test_files: []