devise_roles 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37bf4908a7d5be4f9c695a836196de32617e6c68
-  data.tar.gz: 98c1bfa18b44b9261319398263ec441fb998fb7e
+  metadata.gz: 1ee934be745830ccdb2797e52e08f214bfd5329b
+  data.tar.gz: 0606df0512ef6877454127c77fd938652bb8700b
 SHA512:
-  metadata.gz: 3878ad96f29d50953048bc77df2def2cf7237d57e659d689569697dc7d9328a50ee09f6f05cb114aec41fb30ee03acdc7a5631a21590fdb7ce188faffc1c02b4
-  data.tar.gz: 9ecb83aa6be49613fb26e9489d8f3b6d94146dc80c571585de65ea1ce1de842f95f94b97ee1b9ec955253487bb80b3ef6a6ff7d03a1446bf966d0bca570c843b
+  metadata.gz: eb2b5999126147a1450fe31f09b623f3d9c8fa129d39f9783cef771e24029efdee34c2787868f4aa8e29a5bb947ba30c3daa5c088f21f0dd4e732802a9bd6fa0
+  data.tar.gz: 62fc6f4944e5fa37d972573b4db0cb0c1c9fcd83ce5d75da325e58c28b2d353c637d9fc4d70bc208674db6f5032bc96b113ee5056f6883f12f90e0da9b2de3b8

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/gem_test/

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
+cache: bundler
+
 rvm:
   - 2.1.6
-before_install: gem install bundler -v 1.10.6
+
+# script: 'bundle exec rake'

data/README.md

@@ -1,5 +1,11 @@
 # DeviseRoles::Gem
 
+Gem that helps you to organaize your users with roles and manipulate them.
+
+And you are on its HOMEPAGE.
+
+This gem is currently in development, so if you find any issues please report.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,18 +24,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use this gem features, you should create table **Roles** and add roles to it.
+
+Generate User model if you haven't yet:
+
+    $ rails generate devise User
+
+### Set up Role and User models
+
+To do so, run:
+
+    $ rails g model Role name:string
+    $ rails g migration addRoleIdToUser role:references
+    $ rake db:migrate
+
+Then in your app's models:
+
+```ruby
+class User < ActiveRecord::Base
+  belongs_to :role
+end
+```
+for **User** model and also
+```ruby
+class Role < ActiveRecord::Base
+  has_many :users
+end
+```
+for **Role** model.
+
+### Set up seeds.rb with roles and add to db
 
-## Development
+```ruby
+['registered', 'banned', 'moderator', 'admin'].each do |role|
+  Role.find_or_create_by({name: role})
+end
+```
+These are required, you can also add your custom roles on your own.
+Then you must add them to *db*
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ rake db:seed
 
-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).
+And this is all for setting up.
 
-## Contributing
+Now you can go to learn methods for this *gem*.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/devise_roles.
+## Devise Roles methods
 
+#### Enable only for Role
+
+If you want to enable some page for exact Role only, use this method
+```ruby
+    available_for_user_role(user_role_name, user_redirect_path)
+```
+Here is some example how to use it
+```ruby
+def some_controller_method_name
+  # Implement it at the top
+  # In this example, current view would be available for admins only
+  available_for_user_role('admin', root_path)
+
+  # Some other code ...
+  # That would be run if user is not **admin**
+end
+```
 
 ## License
 

data/devise_roles.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["benovskym@gmail.com"]
 
   spec.summary       = %q{A simple gem for devise roles.}
-  spec.description   = %q{Gem that helps you to organaize your users with roles and manipulate them.}
+  spec.description   = %q{Gem that helps you to organaize your users with roles and manipulate them. Visit HOMEPAGE for more information how to use this gem.}
   spec.homepage      = "https://github.com/MarkusBansky/devise_roles"
   spec.license       = "MIT"
 
@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "devise", "~> 3.5.2"
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/devise_roles.rb

@@ -1,5 +1,11 @@
 require "devise_roles/version"
 
 module DeviseRoles
-  # Your code goes here...
+  def available_for_user_role(user_role_name, user_redirect_path)
+    if current_user.role.name != user_role_name
+      redirect_to admin_path, alert: "You should be #{user_role_name} to view that page!"
+    end
+  end
+
+  
 end

data/lib/devise_roles/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_roles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - MarkusBansky
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Gem that helps you to organaize your users with roles and manipulate
-  them.
+  them. Visit HOMEPAGE for more information how to use this gem.
 email:
 - benovskym@gmail.com
 executables: []
@@ -55,6 +69,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- devise_roles-0.1.0.gem
 - devise_roles.gemspec
 - lib/devise_roles.rb
 - lib/devise_roles/version.rb