arpa 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 931f0491ce2453cff1606cdc0f2cd5991a7921c6
-  data.tar.gz: 6ed81530f8cc41943e1b9683c4676e60db6d697e
+  metadata.gz: 8ac4029644c373b6a7478a913a4e165eca5145ef
+  data.tar.gz: f4f47a1444f7cf74d61b09579816bafead29e91c
 SHA512:
-  metadata.gz: 3a7cf1f28d58a0406abe0ff35ae3ab121bc8e209b5f807f287f2ca3e5309bbb5fc446a4799be6f034a7e6a80d61939c99b224ead2784a3d8dd26dbe5a7314068
-  data.tar.gz: f0481f9001e29f74fa20db57c016270de9b4538a430691d67bfe727adda6190458d7216f691a169f78d2d84f8fd4b6ee14c8b9073fdea9e7234e12157bd7a822
+  metadata.gz: a6f282c6b5d8fff2b6ef47c6a16bcfb18ba7f53648de5119ceb06c35ed7baeeabfdfdc57c454fcaa6bc8457a199fc6dc047f8af3da41a0874760342907cea8c3
+  data.tar.gz: 0a3e5b3c15a7199bcda8a0188312b548cc8ceec87521e1ee28e8d39f2ff43f1e4a2d88b5b948b80fb1a47d2791ac0ae029deb3c3c7ae8456bcf221104f5c509a

data/.gitignore

@@ -12,6 +12,7 @@
 *.so
 *.o
 *.a
+*.gem
 mkmf.log
 
 # scm revert files

data/README.md

@@ -1,6 +1,6 @@
 #Arpa
 
-Authorization Gem for Ruby and Ruby on Rails projects.
+Arpa is an authorization library for Ruby or Ruby on Rails which restricts the accesses in controller and actions. Arpa  will help you to customize all permissions you need dynamically.
 
 ## Installation
 
@@ -28,26 +28,55 @@ This command will create some files that are needed to run the Gem.
 |----------|:-------------:|
 | db/migrate/20140120201010_create_arpa_tables.rb |  Migration to create the all **Arpa** tables in your database (your name will include a different timestamp) |
 | config/locales/arpa.en.yml |  Locales to use in Arpa classes |
+
+**Obs.:** The migration file will create a associate table between **Arpa::Profile** and **SomeModel**. By **default** the model is **User** as **users** table. The model to associate must exist in your Application before run that generate.
+
+If you want a different Model to associate with Arpa::Profile you can pass some arguments:  
+
+    $ rails generate arpa:install [ASSOCIATE_TABLE] [ASSOCIATE_PRIMARY_KEY]
+
+####Eg. 1:
+
+    $ rails generate arpa:install admins
+    
+That command will create the association with **admins** table with **admin_id** as foreign key.
+
+####Eg. 2:
+
+    $ rails generate arpa:install admins admin_custom_id
+    
+That command will create the association with **admins** table with **admin_custom_id** as foreign key.
+
+
+After run the generate command, you need to run the migration to create all Arpa tables:
+
+    $ rake db:migrate
+
+---
+
+Arpa can generate the *Controllers*, *Views*, *Stylesheet* and *Routes* to a basic CRUD for *resources*, *roles* and *profiles*. To do that you can run:
+
+    $ rails generate arpa:controllers
+    
+This command will create some files.
+
+|    File  |     Purpose   |
+|----------|:-------------:|
 | app/assets/stylesheets/arpa/arpa_accordion.scss |  Basic stylesheet to use with Arpa views |
 | app/controllers/arpa/resources_controller.rb  app/controllers/arpa/roles_controller.rb  app/controllers/arpa/profiles_controller.rb | Controllers to use the CRUD actions for each one |
 | app/views/arpa/resources/  app/controllers/arpa/roles/  app/controllers/arpa/profiles/ | All views to use the CRUD actions for each controller above |
 | config/routes.rb |  Will add all routes into this file with all resources of Arpa |
 
-After generate, you need to run the migration to create all Arpa tables:
-
-    $ rake db:migrate
-
-**Obs.:** The migration file will create a associate table between **Profiles** and **Users** (the Users must exist in your Application before adding the Gem)
 
 ## Usage
 
-First of all you must create the Resources, Roles and Profiles (each is avaliable in the paths listed in a section bellow). After that you need associate **Profiles** with **User** (to do this, you need create by your own the associate form view, saving some profiles in some user). Done that you can use some Helpers generated by Arpa.
+First of all you must create the Resources, Roles and Profiles (each is avaliable in the paths listed in a section bellow). After that you need associate **Arpa::Profile** with **SomeModel** (to do this, you need create by your own the associate form view, saving some profiles in some model). Done that you can use some Helpers generated by Arpa.
 
-### Association between Profiles and Users
+### Association between Arpa::Profile and SomeModel
 
-You just need have a method called **:profile_ids** inside the User model. This method should return a list of ids from profiles associated in the user.
+You just need have a method called **:profile_ids** inside the **SomeModel** model. This method should return a list of ids from profiles associated in the model.
 
-You just add a HBTM association in User model:
+You just add a HBTM association in SomeModel model:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -56,6 +85,16 @@ end
 ```
 With this you will be able to use the :profile_ids method.
 
+If the Model name is different on database you need add the **foreign_key** option:
+
+```ruby
+class User < ActiveRecord::Base
+	self.table_name = 'admins'
+
+	has_and_belongs_to_many :profiles, class_name: 'Arpa::Repositories::Profiles::RepositoryProfile', foreign_key: 'admin_id'
+end
+```
+
 ### Controller helpers
 
 Arpa will create some helpers to use inside your controllers and views.
@@ -96,20 +135,62 @@ class ApplicationController < ActionController::Base
 	before_filter :authorize_user  
 	
 	 def authorize_user
-    	controller = params[:controller]
-    	action     = params[:action]		
-      redirect_to some_url unless has_access?(controller, action
+      controller = params[:controller]
+      action     = params[:action]		
+      redirect_to some_url unless has_access?(controller, action)
 	 end
 
 end  
 ```
 
-**Obs.:** The **has_access?** method come from Controller Helper method which Arpa gem has been created.
+**Obs. 1:** The **has_access?** method come from Controller Helper method which Arpa gem has been created.
+
+**Obs. 2:** When you create the **before_filter** you probably wanna skip that callback in somes **controllers** (like login or devise controllers). To do this you need set the **skip_before_action** passing as parameter the name of before_filter method as you can see bellow:
+
+```ruby
+  skip_before_action :authorize_user
+```
+
+
+## Descriptions Locales for Arpa::Entities::Action
 
+Arpa will use on **description** method from Arpa::Entities::Action a specific Locale.
+
+You should create a locale file to print correctly the descriptions of the actions.
+
+####Eg.:
+
+```ruby
+en:
+  entities:
+    resources:
+      users: #Here is the name of controller
+        actions:
+          description:
+            #Here is each action of the controller
+            index:   'List of Users'
+            show:    'Show of User'
+            new:     'Access to registration form of User'
+            edit:    'Access to change form of User'
+            create:  'Perform action registering of User'
+            update:  'Perform action update of User'
+            destroy: 'Perform action destroy of User'
+
+```
 
 ## Information
 
-After generate, you will be able to access some paths for each Controller created:
+Arpa will add a new column called **is_arpa_admin** as boolean in the associate table with value **false** as default. You must set some user (creating a migration for example), with *is_arpa_admin* as **true** to navigate between the views without be catched by the filter verification.
+
+If you want a **action** of some **Controller** pass without permission on *before_filter* callback. You just need start the name of action with underscode ('_'). For example:
+
+```ruby
+  def _some_free_action_which_not_need_permission
+  end
+```
+
+
+The routes created by **arpa:controllers** generator will be able to access some paths for each Controller created:
 
 ```ruby
 generate_resources_and_actions_resources GET    /resources/generate_resources_and_actions(.:format) arpa/resources#generate_resources_and_actions

data/lib/arpa/additions/resource.rb

@@ -22,12 +22,12 @@ module Arpa
       private
 
       def has_session_or_current_user?
-        sess   = try(:session)
-        c_user = try(:current_user)
-        return true if sess && c_user
+        verified_session      = try(:session)
+        verified_current_user = try(:current_user)
+        return true if verified_session && verified_current_user
         log = Logger.new(STDOUT)
-        log.warn("The ApplicationController must has a attribute or method 'session'") unless sess
-        log.warn("The ApplicationController must has a attribute or method 'current_user'") unless c_user
+        log.warn("The ApplicationController must has a attribute or method 'session'") unless verified_session
+        log.warn("The ApplicationController must has a attribute or method 'current_user'") unless verified_current_user
         false
       end
 

data/lib/arpa/entities/action.rb

@@ -16,7 +16,8 @@ module Arpa
       end
 
       def resource_name
-        resource.name
+        return resource.name if resource
+        ''
       end
 
       def description

data/lib/arpa/entities/permissions.rb

@@ -5,7 +5,7 @@ module Arpa
       attr_reader :permissions
 
       def initialize(actions)
-        @actions   = actions
+        @actions     = actions
         @permissions = Array.new
         build_permissions
       end

data/lib/arpa/entities/profile.rb

@@ -10,11 +10,17 @@ module Arpa
         @id          = attrs[:id]
         @name        = attrs[:name]
         @description = attrs[:description]
-        @role_ids    = attrs[:role_ids] || []
-        @roles       = attrs[:roles] || []
+        @role_ids    = default_value_to_nil_or_empty(attrs[:role_ids], [])
+        @roles       = default_value_to_nil_or_empty(attrs[:roles], [])
         @created_at  = attrs[:created_at]
         @updated_at  = attrs[:updated_at]
-        @removed     = attrs[:removed] || false
+        @removed     = default_value_to_nil_or_empty(attrs[:removed], false)
+      end
+
+      private
+      def default_value_to_nil_or_empty(attr_value, default_value)
+        return attr_value if attr_value.present?
+        default_value
       end
 
     end

data/lib/arpa/entities/resource.rb

@@ -12,7 +12,7 @@ module Arpa
         @name       = attrs[:name]
         @created_at = attrs[:created_at]
         @updated_at = attrs[:updated_at]
-        @actions    = attrs[:actions] || []
+        @actions    = attrs[:actions].present? ? attrs[:actions] : []
       end
 
       def build_correct_name

data/lib/arpa/entities/role.rb

@@ -11,18 +11,24 @@ module Arpa
         @id          = attrs[:id]
         @name        = attrs[:name]
         @description = attrs[:description]
-        @action_ids  = attrs[:action_ids] || []
-        @actions     = attrs[:actions] || []
-        @profiles    = attrs[:profiles] || []
+        @action_ids  = default_value_to_nil_or_empty(attrs[:action_ids], [])
+        @actions     = default_value_to_nil_or_empty(attrs[:actions], [])
+        @profiles    = default_value_to_nil_or_empty(attrs[:profiles], [])
         @created_at  = attrs[:created_at]
         @updated_at  = attrs[:updated_at]
-        @removed     = attrs[:removed] || false
+        @removed     = default_value_to_nil_or_empty(attrs[:removed], false)
       end
 
       def has_profile?
         profiles.present?
       end
 
+      private
+      def default_value_to_nil_or_empty(attr_value, default_value)
+        return attr_value if attr_value.present?
+        default_value
+      end
+
     end
   end
 end

data/lib/arpa/version.rb

@@ -1,3 +1,3 @@
 module Arpa
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/config/locales/arpa.en.yml

@@ -1,17 +1,4 @@
 en:
-  entities:
-    resources:
-      users:
-        actions:
-          description:
-            index:   'List of Users'
-            show:    'Show of User'
-            new:     'Access to registration form of User'
-            edit:    'Access to change form of User'
-            create:  'Perform action registering of User'
-            update:  'Perform action update of User'
-            destroy: 'Perform action destroy of User'
-
   errors:
     format: ! '%{attribute} %{message}'
     messages:

data/spec/lib/ar/entities/action_spec.rb

@@ -1,18 +1,38 @@
 require 'spec_helper'
 
 describe Arpa::Entities::Action, type: :entity, fast: true do
-  let(:resource) { double(name: 'users') }
-
   subject { Arpa::Entities::Action.new resource: resource, name: 'index'}
 
   describe 'getting description by action name and resource name' do
+    before do
+      I18n.backend.store_translations(:en, entities: { resources: { users: { actions: { description: { index: 'List of Users' } } } } } )
+    end
 
     context 'when resource.name is "users" and action.name is "index"' do
+      let(:resource) { double(name: 'users') }
 
       it 'description should be "List of Users"' do
         expect(subject.description).to eql "List of Users"
       end
     end
+  end
+
+  describe 'getting the resource name' do
+
+    context 'when resource is not nil' do
+      let(:resource) { double(name: 'users') }
+
+      it 'resource name should be the same of the attribute' do
+        expect(subject.resource_name).to eql 'users'
+      end
+    end
+
+    context 'when resource is nil' do
+      let(:resource) { nil }
+      it 'resource name should be empty' do
+        expect(subject.resource_name).to be_empty
+      end
+    end
 
   end
 

data/spec/lib/ar/entities/permissions_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Arpa::Entities::Permissions, type: :presenter, fast: true do
+describe Arpa::Entities::Permissions, type: :entity, fast: true do
   let(:action_001) { double name: 'index', resource_name: 'users' }
   let(:action_002) { double name: 'show', resource_name: 'users' }
   let(:action_003) { double name: 'show', resource_name: 'users' }
@@ -34,26 +34,40 @@ describe Arpa::Entities::Permissions, type: :presenter, fast: true do
   end
 
   describe '#has_permission?' do
-    let(:resource_name) { 'users' }
     let(:result) { subject.has_permission?(resource_name, action_name) }
 
-    context 'when has' do
-      let(:action_name) { 'index' }
+    context 'when pass a resource name with permission' do
+      let(:resource_name) { 'users' }
 
-      it 'should return true' do
-        expect(result).to be_truthy
+      context 'when pass an action with permission' do
+        let(:action_name) { 'index' }
+
+        it 'should return true' do
+          expect(result).to be_truthy
+        end
       end
 
+      context 'when pass an action with no permission' do
+        let(:action_name) { 'index_old' }
+
+        it 'should return false' do
+          expect(result).to be_falsey
+        end
+      end
     end
 
-    context 'when has not' do
-      let(:action_name) { 'index_old' }
+    context 'when pass a resource name with no permission' do
+      let(:resource_name) { 'users_2' }
 
-      it 'should return false' do
-        expect(result).to be_falsey
-      end
+      context 'when pass some action' do
+        let(:action_name) { 'index' }
 
+        it 'should return false' do
+          expect(result).to be_falsey
+        end
+      end
     end
+
   end
 
 end

data/spec/lib/ar/entities/profile_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Arpa::Entities::Profile, type: :entity, fast: true do
+
+  describe 'initializing' do
+
+    describe 'setting default values' do
+
+      context 'when pass some parameters as nil' do
+
+        it 'attribute :role_ids should be an empty Array' do
+          expect(subject.role_ids).to eq []
+        end
+
+        it 'attribute :role should be an empty Array' do
+          expect(subject.roles).to eq []
+        end
+
+        it 'attribute :removed should be false' do
+          expect(subject.removed).to be_falsey
+        end
+      end
+    end
+
+    context 'when pass some parameters as empty' do
+      let(:attrs) { {role_ids: '', roles: '', removed: ''} }
+      subject { Arpa::Entities::Profile.new attrs }
+
+      it 'attribute :role_ids should be an empty Array' do
+        expect(subject.role_ids).to eq []
+      end
+
+      it 'attribute :role should be an empty Array' do
+        expect(subject.roles).to eq []
+      end
+
+      it 'attribute :removed should be false' do
+        expect(subject.removed).to be_falsey
+      end
+    end
+
+  end
+
+end

data/spec/lib/ar/entities/resource_spec.rb

@@ -2,6 +2,29 @@ require 'spec_helper'
 
 describe Arpa::Entities::Resource, type: :entity, fast: true do
 
+  describe 'initializing' do
+
+    describe 'setting default values' do
+
+      context 'when pass :actions as nil' do
+
+        it 'attribute :actions should be an empty Array' do
+          expect(subject.actions).to eq []
+        end
+      end
+    end
+
+    context 'when pass :actions as empty' do
+      let(:attrs) { {actions: ''} }
+      subject { Arpa::Entities::Resource.new attrs }
+
+      it 'attribute :actions should be an empty Array' do
+        expect(subject.actions).to eq []
+      end
+    end
+
+  end
+
   describe '#build_correct_name' do
 
     before { subject.build_correct_name }

data/spec/lib/ar/entities/role_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Arpa::Entities::Role, type: :entity, fast: true do
+
+  describe 'initializing' do
+
+    describe 'setting default values' do
+
+      context 'when pass some parameters as nil' do
+
+        it 'attribute :action_ids should be an empty Array' do
+          expect(subject.action_ids).to eq []
+        end
+
+        it 'attribute :actions should be an empty Array' do
+          expect(subject.actions).to eq []
+        end
+
+        it 'attribute :profiles should be an empty Array' do
+          expect(subject.profiles).to eq []
+        end
+
+        it 'attribute :removed should be false' do
+          expect(subject.removed).to be_falsey
+        end
+      end
+    end
+
+    context 'when pass some parameters as empty' do
+      let(:attrs) { {action_ids: '', actions: '', profiles: '', removed: ''} }
+      subject { Arpa::Entities::Role.new attrs }
+
+      it 'attribute :action_ids should be an empty Array' do
+        expect(subject.action_ids).to eq []
+      end
+
+      it 'attribute :actions should be an empty Array' do
+        expect(subject.actions).to eq []
+      end
+
+      it 'attribute :profiles should be an empty Array' do
+        expect(subject.profiles).to eq []
+      end
+
+      it 'attribute :removed should be false' do
+        expect(subject.removed).to be_falsey
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arpa
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Rachid Calazans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2016-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,9 +156,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- arpa-0.0.2.gem
-- arpa-0.0.3.gem
-- arpa-0.0.4.gem
 - arpa.gemspec
 - lib/arpa.rb
 - lib/arpa/additions/resource.rb
@@ -249,7 +246,9 @@ files:
 - spec/lib/ar/data_mappers/role_mapper_spec.rb
 - spec/lib/ar/entities/action_spec.rb
 - spec/lib/ar/entities/permissions_spec.rb
+- spec/lib/ar/entities/profile_spec.rb
 - spec/lib/ar/entities/resource_spec.rb
+- spec/lib/ar/entities/role_spec.rb
 - spec/lib/ar/repositories/actions/finder_spec.rb
 - spec/lib/ar/repositories/base_spec.rb
 - spec/lib/ar/repositories/profiles/finder_spec.rb
@@ -310,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Authorization Gem for Ruby and Ruby on Rails projects
@@ -327,7 +326,9 @@ test_files:
 - spec/lib/ar/data_mappers/role_mapper_spec.rb
 - spec/lib/ar/entities/action_spec.rb
 - spec/lib/ar/entities/permissions_spec.rb
+- spec/lib/ar/entities/profile_spec.rb
 - spec/lib/ar/entities/resource_spec.rb
+- spec/lib/ar/entities/role_spec.rb
 - spec/lib/ar/repositories/actions/finder_spec.rb
 - spec/lib/ar/repositories/base_spec.rb
 - spec/lib/ar/repositories/profiles/finder_spec.rb