can_camel 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19f8ade41da75b5b9b3beb17bc729b62fae529e3
-  data.tar.gz: 44fd15e4109320bc9143dd4acb992bed642955b3
+  metadata.gz: 6cd2a7e24ff8c42df996b7255ecfc0710ae5b011
+  data.tar.gz: 97d7813911fdbbcc34c765243df8f047fceef026
 SHA512:
-  metadata.gz: f02195d10717ac041a2e64df9b893d8f2d14a91051bdaa87a3b5e4cc668dda8f4e8dc932744330d982905e8a2b216fbebc7ec7d033b02549dd3287b88e6638c2
-  data.tar.gz: 590a5bd7ec97794d11638630d45561b496f3279428ab8dadb83078b12b65437d6ca859de64694fe0a3ce30c7b2c6a869116f6f5c0de87bdd1e607e4b76878504
+  metadata.gz: 89e48cc509dfe2269a5f308e3234fbcbe2400642b22c916b44937b72f32fcbfb57eaa28de6d4162b23e4d69f37cd4a6a222ca79270994faf6a29d0ff01ba5338
+  data.tar.gz: c765a6da93ea8aa404105b405a22a8598348a5c4a42b54c36655f6c471c61d46228eeb3c077962f88c933457aa4a641ec09e641dc4d3fd3d4faf16e1b86e18e2

data/README.md

@@ -0,0 +1,65 @@
+CanCamel
+========
+This project uses WTFPL license, requires postgresql db adapter and rocks <br>
+Upstream have not been tested in production, take a lot of care
+What is CanCamel?
+=================
+CanCamel is a ruby gem for access control. For example, we can want to know
+`can camel write a poem?` We can write it as `can?(camel, :write, :poem)`
+This code calls function with 3 arguments: user (actor), action and subject and returns hash or nil
+For example, we can grant camel full poem access (but only for actions that exists).
+We can let camel write poems only in fridays midnight, why not? Any optional params
+can be passed to a filter. Any custom filters could be made and any additional data
+(e.g. maximal poem length allowed) can be passed back
+
+Step 1. Installation
+====================
+run rails g can_camel:install <br>
+Then visit generated initializer at config/initializers/can_camel.rb
+<pre>
+# CanCamel::Filters.include AbilityFilters
+CanCamel::TABLE_NAME = "can_camel_nodes"
+CanCamel::GROUP_METHOD = :group
+</pre>
+First line describes how to use you own filters. You may prefer `prepend` over `include`
+here. You can also specify table name, if you want. Third line describes a symbol, which references for
+user model method, returning user group. Group should be a symbol. Visit spec/dummy/app/models/user.rb
+for example. When you sure with this file, run generated migration.
+Remember, that migration installs 'hstore' plugin, on which relies,
+but does not remove it. If you want to revert it, you may want to remove plugin too
+
+Step 2. Database structure
+==========================
+Database consists of nodes. Primary nodes (WHERE parent_id IS NULL) are called subjects,
+Their children are called actions, and actions' children are called groups. Groups' children
+are called garbage and never used. Any node can have conditions and results. Conditions' syntax is
+<pre>
+[
+  { method: :day_of_week, allow: %w(saturday sunday) }
+]
+</pre>
+It means, that :day_of_week will be called with `allow: {"saturday", "sunday}"` argument
+
+Step 3. Linting
+===============
+If you are working primary with database (e.g. in migration), you can call
+`CanCamel.lint` to check is database correct. Best way is to call `CanCamel.lint!` in transaction
+with all changes done and enjoy your exception if need
+
+Step 4. Constrains (Incomplete)
+===============================
+Filters have great powers, and with big power big responsibility comes. For example, you are managing
+statistics access on Users, and your filter scoping them. What if your filter would be called for Blog?
+I think, nothing good. To prevent it, you can write a constraint
+<pre>
+validate :filter_name, subject: :user
+def filter_name
+  #TODO: do something
+end
+</pre>
+
+Step 5. Human interface (NIY)
+============================
+Nodes supports some usefull methods to work with them
+* `Node#aviable_filters` returns all filters available
+* `Node#handling_params` returns list of all results available

data/lib/can_camel.rb

@@ -1,7 +1,7 @@
 module CanCamel
   extend ActiveSupport::Autoload
   %i(Base Node SubjectNode ActionNode GroupNode ConcernNode Linter Filters
-     Validators Cache FilterHelper)
+     Validators Cache)
     .each { |x| autoload(x) }
 
   extend CanCamel::Base

data/lib/can_camel/base.rb

@@ -3,8 +3,8 @@ module CanCamel
     # don't delegate all, because lint_node designed to be run on same instances of linter
     delegate :lint, :lint!, to: :new_linter
 
-    def can?(group, action, subject, **args)
-      Cache[[group, action, subject]].try(:can?, args)
+    def can?(user, action, subject, **args)
+      Cache[[user.send(GROUP_METHOD), action, subject]].try(:can?, args)
     end
 
     private

data/lib/can_camel/filters.rb

@@ -1,21 +1,19 @@
 require 'can_camel/validators'
 module CanCamel::Filters
   include CanCamel::Validators
-  extend CanCamel::FilterHelper
   ArgSyntaxError = Class.new(StandardError)
 
   module_function
 
   validates :at_time, :hours, presence: {}
   def at_time(hours:, **_)
-    hours = from_int_array hours
     hours.include?(Time.now.hour) && {}
   end
 
   validates :at_day, presence_of: { fields: [:days, :wdays], any: true }
   def at_day(days: nil, wdays: nil, **_)
-    return if days && !from_int_array(days).include?(Time.now.day)
-    return if wdays && !from_int_array(wdays).include?(Time.now.wday)
+    return if days && !days.include?(Time.now.day)
+    return if wdays && !wdays.include?(Time.now.wday)
     {}
   end
 end

data/lib/can_camel/group_node.rb

@@ -5,10 +5,9 @@ module CanCamel
     validates_presence_of :parent_id
 
     def can?(**additional_params)
-      condition.each_with_object(result.dup) do |hash, result|
-        hash.symbolize_keys!
-        raise Linter::LintingError unless hash[:method]
-        filtered = Filters.send(hash[:method], **hash.merge(additional_params))
+      condition.each_with_object(result.dup) do |(method, args), result|
+        args = args.symbolize_keys
+        filtered = Filters.send(method, **args.merge(additional_params))
         return unless filtered
         result.merge! filtered
       end || result

data/lib/can_camel/linter.rb

@@ -19,10 +19,8 @@ module CanCamel
     private
 
     def validate_node(node)
-      node.condition.each do |hash|
-        hash.symbolize_keys!
-        raise LintingError unless hash[:method]
-        Validators.validate!(filter: hash[:method], args: hash)
+      node.condition.each do |method, args|
+        Validators.validate!(filter: method, args: args.symbolize_keys)
       end
       true
     rescue Validators::ValidationError, LintingError

data/lib/can_camel/node.rb

@@ -19,12 +19,14 @@ module CanCamel
 
     validates! :inherited, absence: { message: "You should not save inherited nodes!" }
 
-    # accessors
-
     def name
       super.to_sym
     end
 
+    def condition
+      super.symbolize_keys
+    end
+
     private
 
     attr_reader :inherited
@@ -36,13 +38,7 @@ module CanCamel
 
       inherit_field(source, :description) { |x| self.description ||= x }
       inherit_field(source, :result) { |x| result.merge!(x) { |_k, l, _r| l } }
-
-      inherit_field(source, :condition) do |new|
-        methods = condition.map { |c| c['method'] }
-        new.each do |x|
-          condition.push(x) unless methods.include? x['method']
-        end
-      end
+      inherit_field(source, :condition) { |x| self.condition = x.merge(condition) }
     end
 
     def inherit_field(source, field)

data/lib/can_camel/version.rb

@@ -1,3 +1,3 @@
 module CanCamel
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/generators/can_camel/config/initializers/can_camel.rb

@@ -2,3 +2,4 @@
 # require 'can_camel/filters'
 # CanCamel::Filters.include AbilityFilters
 CanCamel::TABLE_NAME = "can_camel_nodes"
+CanCamel::GROUP_METHOD = :group

data/lib/generators/can_camel/db/migrate/00000000000002_hstore_to_json.rb

@@ -0,0 +1,14 @@
+class HstoreToJson < ActiveRecord::Migration
+  def change
+    unless ENV['RAILS_ENV'] == 'test' || ENV['FORCE_CAN_CAMEL_WIPE'] == 'true'
+      puts "Attention! This migration will wipe can_camel data. Continue? (Y/n)"
+      puts "Set FORCE_CAN_CAMEL_WIPE=true to automaticaly accept"
+      res = STDIN.gets
+      raise unless res =~ /\A[Yy]/
+    end
+    CanCamel::Node.delete_all
+    remove_column CanCamel::TABLE_NAME, :condition, :hstore, array: true, default: []
+    add_column CanCamel::TABLE_NAME, :condition, :json, default: {}
+    CanCamel::Node.delete_all
+  end
+end

data/lib/generators/can_camel/install_generator.rb

@@ -4,5 +4,6 @@ class CanCamel::InstallGenerator < Rails::Generators::Base
   def install
     copy_file 'config/initializers/can_camel.rb'
     copy_file 'db/migrate/00000000000001_create_can_camel_nodes.rb'
+    copy_file 'db/migrate/00000000000002_hstore_to_json.rb'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: can_camel
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alexander Smirnov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-08 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -47,13 +47,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - Rakefile
 - lib/can_camel.rb
 - lib/can_camel/action_node.rb
 - lib/can_camel/base.rb
 - lib/can_camel/cache.rb
 - lib/can_camel/concern_node.rb
-- lib/can_camel/filter_helper.rb
 - lib/can_camel/filters.rb
 - lib/can_camel/group_node.rb
 - lib/can_camel/linter.rb
@@ -63,6 +63,7 @@ files:
 - lib/can_camel/version.rb
 - lib/generators/can_camel/config/initializers/can_camel.rb
 - lib/generators/can_camel/db/migrate/00000000000001_create_can_camel_nodes.rb
+- lib/generators/can_camel/db/migrate/00000000000002_hstore_to_json.rb
 - lib/generators/can_camel/install_generator.rb
 - lib/tasks/can_camel_tasks.rake
 homepage: https://github.com/JelF/can_camel
@@ -75,9 +76,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/can_camel/filter_helper.rb

@@ -1,15 +0,0 @@
-# Holds functions to parse params from strings
-module CanCamel
-  module FilterHelper
-    def from_int_array(str)
-      from_array(str).map(&:to_i)
-    rescue
-      raise Filters::ArgSyntaxError
-    end
-
-    def from_array(str)
-      raise Filters::ArgSyntaxError unless /\A\[(?<els>.+)\]\z/ =~ str
-      els.split ','
-    end
-  end
-end