rbacan 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32a4086cc1604d5a527177b01562f7b5778cfc99
-  data.tar.gz: 28c63c5abd5efc4fda8c0819e00ccae64c75cdda
+  metadata.gz: 97b996450c3b0f0535a4c1a544c620171a3d1aed
+  data.tar.gz: b5902253a42b4a642a9ebfafbd71d656d9c066c0
 SHA512:
-  metadata.gz: 76a3ef0754d189322539b51cc6db41d6b8e1a5596d91b4f81876d4e4084d1b8d0061f85c900503fc5b3e1c7eaf2718b1e56ba59fdb758abd31bd0a913236ad9a
-  data.tar.gz: 4603cc7e51537b5c79fb704c6f5eac2860628765bbc0e5886e03d2754bf615bf8d781e514ff96336b5887d44fe9b82a6a8ae2d15b344b239549478699ca47caf
+  metadata.gz: 5fe1fd23031ca2b755a306b00402d343fb9663d5e624876ec58a6fcba3927521786c5e7dade0b69d533147ab4878e756f68af61846dd3bbda9a84e13628418bd
+  data.tar.gz: 0f02c3af5bdd077b457cc6c3fe9769b51b44a9d408c7e2751361243c8023629c04bbaa8b6526cf22c89abe371263595a3f6e26c8e3d30c75734a58443024c1eb

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    rbacan (0.1.0)
-      activesupport (~> 5.2, >= 5.2.3)
+    rbacan (0.1.1)
       rails (>= 4.2)
 
 GEM
@@ -75,7 +74,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     nio4r (2.4.0)
-    nokogiri (1.10.3)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     rack (2.0.7)
     rack-test (1.1.0)
@@ -96,7 +95,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
     railties (5.2.3)
       actionpack (= 5.2.3)
@@ -145,4 +144,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Rbacan
 
-a Role-based access control tool to manipulate user access to the functionnalities of your application
+a Role-based access control tool to control user access to the functionnalities of your application
 
 ## Installation
 
@@ -20,11 +20,21 @@ Or install it yourself as:
 
 ## Usage
 
+```ruby
 run rails generate rbacan:install
+```
 
 copy the content in the generated file db/copy_to_seed.rb in your seeds.rb file
 you have there all the tools you need to create you roles and permissions
 
+You might need to configure you user class_name if you're using a different class_name for the user, go to rbacan.rb in your initializers folder and make your change
+
+```ruby
+    Rbacan.configure do |config|
+    config.permittable_class = "YOUR USER CLASS_NAME"
+    end
+```
+
 if you want to assign a role to a user it is simple you just have to do so:
 
     user = current_user
@@ -44,9 +54,14 @@ add this line to your user model:
     include Rbacan::Permittable
 
 run:
+
+```ruby
     rails db:migrate
+    rails db:seed
+```
 
 enjoy :D
+
 ## 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.
@@ -55,7 +70,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hamdi777/rbacan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hamdi777/RBACan. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/app/models/rbacan/role.rb

@@ -8,6 +8,6 @@ module Rbacan
         has_many :permissions, class_name: Rbacan.permission_class, through: :role_permissions
 
         has_many :user_roles, class_name: Rbacan.user_role_class, dependent: :destroy
-        has_many :users, through: :user_roles
+        has_many :users, class_name: Rbacan.permittable_class, through: :user_roles
     end
 end

data/lib/generators/install/templates/rbacan.rb

@@ -0,0 +1,3 @@
+Rbacan.configure do |config|
+  # config.permittable_class = "User"
+end

data/lib/generators/rbacan/install_generator.rb

@@ -23,6 +23,10 @@ module Rbacan
       def copy_seed
         copy_file 'copy_to_seeds.rb', "db/copy_to_seeds.rb"
       end
+
+      def copy_initializer
+        copy_file 'rbacan.rb', 'config/initializers/rbacan.rb'
+      end
     end
   end
 end

data/lib/rbacan/permittable.rb

@@ -9,7 +9,7 @@ module Rbacan
             has_many :user_roles, class_name: Rbacan.user_role_class, dependent: :destroy
             has_many :roles, class_name: Rbacan.role_class, through: :user_roles
 
-            def assign_role_to_user(role_name)
+            def assign_role(role_name)
                 assigned_role = Rbacan::Role.find_by_name(role_name)
                 Rbacan::UserRole.create(user_id: self.id, role_id: assigned_role.id)
             end

data/lib/rbacan/version.rb

@@ -1,3 +1,3 @@
 module Rbacan
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rbacan.rb

@@ -5,9 +5,7 @@ require "rbacan/roles_and_permissions"
 
 module Rbacan
   mattr_accessor :permittable_class
-  # mattr_accessor :permittable_table
   @@permittable_class = 'User'
-  # @@permittable_table = @@permittable_class.tableize
 
   mattr_accessor :role_class
   mattr_accessor :role_table
@@ -43,7 +41,7 @@ module Rbacan
     @@role_permission_class.create(role_id: chosen_role.id, perm_id: given_permission.id)
   end
 
-  def assign_role_to_user(role_name)
+  def assign_role(role_name)
       assigned_role = Role.find_by_name(role_name)
       @@user_role_class.create(user_id: self.id, role_id: assigned_role.id)
   end
@@ -53,6 +51,10 @@ module Rbacan
       @@user_role_class.where(user_id: self.id, role_id: removed_role.id).destroy_all
   end
 
+  def self.configure(&block)
+    yield self
+  end
+
   class Error < StandardError; end
   # Your code goes here...
 end

data/rbacan.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["hamdi_amiche@outlook.fr"]
 
   spec.summary       = %q{a gem to give permission access to users looknig back to their roles}
-  spec.description   = %q{RBACan is a gem that provides security to your application functionnalities by a simple method can()}
+  spec.description   = %q{RBACan is a Role-based access control tool to control user access to the functionnalities of your application}
   spec.homepage      = "https://github.com/hamdi777/RBACan"
   spec.license       = "MIT"
 
@@ -20,8 +20,8 @@ Gem::Specification.new do |spec|
     spec.metadata["allowed_push_host"] = "https://rubygems.org/profiles/hamdi777"
 
     spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "git@github.com:hamdi777/RBACan.git"
-    spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+    spec.metadata["source_code_uri"] = "https://rubygems.org/profiles/hamdi777"
+    spec.metadata["changelog_uri"] = "https://rubygems.org/profiles/hamdi777/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -42,6 +42,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'generator_spec', '~> 0.9.4'
   spec.add_development_dependency 'railties', '~> 5.2', '>= 5.2.3'
-
-  spec.add_dependency 'activesupport', '~> 5.2', '>= 5.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbacan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hamdi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-01 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,28 +100,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.3
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-description: RBACan is a gem that provides security to your application functionnalities
-  by a simple method can()
+description: RBACan is a Role-based access control tool to control user access to
+  the functionnalities of your application
 email:
 - hamdi_amiche@outlook.fr
 executables: []
@@ -149,6 +129,7 @@ files:
 - lib/generators/install/templates/create_role_permissions.rb
 - lib/generators/install/templates/create_roles.rb
 - lib/generators/install/templates/create_user_roles.rb
+- lib/generators/install/templates/rbacan.rb
 - lib/generators/rbacan/install_generator.rb
 - lib/rbacan.rb
 - lib/rbacan/engine.rb
@@ -162,8 +143,8 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org/profiles/hamdi777
   homepage_uri: https://github.com/hamdi777/RBACan
-  source_code_uri: git@github.com:hamdi777/RBACan.git
-  changelog_uri: 'TODO: Put your gem''s CHANGELOG.md URL here.'
+  source_code_uri: https://rubygems.org/profiles/hamdi777
+  changelog_uri: https://rubygems.org/profiles/hamdi777/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: