hydra-role-management 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537099217532b0c9052e381ab038792132c5d626
-  data.tar.gz: 39610d432d77f9cb8737113a0975aec0f03a7eb1
+  metadata.gz: 22f2db430fe451abf8fc22c7dcff9d57621e040d
+  data.tar.gz: 10ad448cc0bb012ab357447db7e019b1a00867d7
 SHA512:
-  metadata.gz: ac34bad6a006a8a5c3591ff21d28538df68b72c8d49f48e8e76784ccd3cfb92c2fd28fb4b0439be42929e22003ced55b0ef3e5e249783bf590999c9f30014e11
-  data.tar.gz: 0be8e150b7b7aa6c346e790baf29d7e180be096838aba3ab0605eaa29fd5080712ec04233f4f1aa446942455204714cc9b3730f410c3220184aa4fcdf55623ef
+  metadata.gz: 4e90822000a247d01e3d4c658b143ec16b7beecd9a3d694351bb41b87d3b2e1afa17c02ee40823d55676f5a0510ee6876b347f6e9d26379ae9c36a8f5fad91e6
+  data.tar.gz: e756a1be05ec233ec7ccfd61597fcbdb964d8b0c5f67a023162e210c998444108c0bc6fef1f24c6a81e718c68e929f9a6a8c351dc405ead4c45072add3b457ac

data/CONTRIBUTING.md

@@ -0,0 +1,113 @@
+# How to Contribute
+
+We want your help to make Project Hydra great.
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
+* Make commits of logical units.
+  * Your commit should include a high level description of your work in HISTORY.textile 
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+* When you are ready to submit a pull request
+
+### Submitting Changes
+
+[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* Squash the commits for your branch into one commit
+  * `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
+  * To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
+  * Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Did the Travis tests complete successfully?
+* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -1,4 +1,16 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in hydra-batch-edit.gemspec
-gemspec
+# Parameterize the Rails version for flexible testing.
+rails_version = ENV["RAILS_VERSION"] || "default"
+rails = case rails_version
+when "master"
+  {:github => "rails/rails"}
+when "default"
+  ">= 3.2.13"
+else
+  "~> #{rails_version}"
+end
+
+gem "rails", rails
+gem "rake"
+gem 'rspec-rails'

data/README.md

@@ -1,9 +1,27 @@
 An engine gem to provide a RDBMS backed list of roles and their associated user.  This replaces the hydra default role mapper.
 
+This gem supports both Rails 3 and 4.
 
-Installing:
+##Installing:
 
 * Add: ```gem 'hydra-role-management'``` to your Gemfile and then ```bundle install```
 * ```rails generate roles```
 * ```rake db:migrate```
+* Add the following [cancan](https://github.com/ryanb/cancan) abilities:
 
+```
+  # app/models/ability.rb
+  if current_user.admin?
+    can [:create, :show, :add_user, :remove_user, :index], Role
+  end
+```
+
+##Testing:
+Given the need to support both Rails 3 and 4, the test suite has been parameterized to test against any version of Rails.
+
+* Install a system javascript runtime or uncomment therubyracer in spec/support/Gemfile
+* Ensure that the testing app does not exist: ```bundle exec rake clean```
+* Set Rails version you want to test against.  For example:
+	* ```RAILS_VERSION=3.2.13``` or ```RAILS_VERSION=4.0.0```
+* Ensure that the correct version of Rails is installed:  ```bundle update```
+* Build test app and run tests: ```bundle exec rake spec```

data/Rakefile

@@ -8,7 +8,7 @@ desc 'Default: run specs.'
 task :default => :spec
 
 
-task :spec => [:generate] do |t|
+task :spec => [:clean, :generate] do |t|
   focused_spec = ENV['SPEC'] ? " SPEC=#{File.join(GEM_ROOT, ENV['SPEC'])}" : ''
   within_test_app do
     system "rake myspec#{focused_spec}"
@@ -22,23 +22,18 @@ desc "Create the test rails app"
 task :generate do
   unless File.exists?('spec/internal/Rakefile')
     puts "Generating rails app"
-    `rails new spec/internal`
-    puts "Copying gemfile"
-    `cp spec/support/Gemfile spec/internal`
+    `rails _ENV["RAILS_VERSION"]_ new spec/internal`
+    puts "Adding hydra gems to gemfile"
+    `cat spec/support/gemfile_stub >> spec/internal/Gemfile`
     puts "Copying generator"
     `cp -r spec/support/lib/generators spec/internal/lib`
 
     within_test_app do
-      puts "Bundle install"
-      puts `bundle install`
-      puts "running generator"
-      puts `rails generate test_app`
-
-      puts "running migrations"
-      puts `rake db:migrate db:test:prepare`
+      `bundle install`
+      system "rails generate test_app"
+      `rake db:migrate db:test:prepare`
     end
   end
-  puts "Running specs"
 end
 
 desc "Clean out the test rails app"

data/app/controllers/concerns/hydra/role_management/roles_behavior.rb

@@ -11,20 +11,50 @@ module Hydra
       end
 
       def show
+        redirect_to role_management.edit_role_path(@role) if can? :edit, @role
       end
 
       def new
       end
 
+      def edit
+      end
+
       def create
-        @role.name = params[:role][:name]
-        if (@role.save)
-          redirect_to role_management.roles_path, notice: 'Role was successfully created.'
+        @role = Role.new(role_params)
+        if @role.save
+          redirect_to role_management.edit_role_path(@role), notice: 'Role was successfully created.'
         else
           render action: "new"
         end
       end
 
+      def update
+        @role = Role.find(params[:id])
+        if @role.update_attributes(role_params)
+          redirect_to role_management.edit_role_path(@role), notice: 'Role was successfully updated.'
+        else
+          render action: "edit"
+        end
+      end
+
+      def destroy
+        if (@role.destroy)
+          redirect_to role_management.roles_path, notice: 'Role was successfully deleted.'
+        else
+          redirect_to role_management.roles_path
+        end
+      end
+
+      private
+
+      def role_params
+        if !ActionController.const_defined? :StrongParameters
+          params[:role]
+        else
+          params.require(:role).permit(:name)
+        end
+      end
     end
   end
 end

data/app/models/concerns/hydra/role_management/legacy_attribute_handling.rb

@@ -0,0 +1,10 @@
+module Hydra
+  module RoleManagement
+    module LegacyAttributeHandling
+      extend ActiveSupport::Concern
+      included do
+        attr_accessible :name
+      end
+    end
+  end
+end

data/app/models/role.rb

@@ -1,8 +1,6 @@
 class Role < ActiveRecord::Base
   has_and_belongs_to_many :users
 
-  attr_accessible :name
-
   validates :name, 
     uniqueness: true,
     format: { with: /\A[a-zA-Z0-9._-]+\z/,

data/app/views/roles/edit.html.erb

@@ -0,0 +1,28 @@
+<h2>Role:</h2>
+<%= bootstrap_form_for @role, :url=>role_management.role_path(@role) do |f| %>
+  <%= f.text_field :name, :label=> 'Role name' %>
+  <%= f.actions do %>
+    <%= f.submit "Update" %>
+  <% end %>
+<% end %>
+<% if can? :destroy, Role %>
+  <%= button_to "Delete", role_management.role_path(@role), :method=>:delete, :class=>'btn btn-danger' %>
+<% end %>
+<h3>Accounts:</h3>
+<ul>
+  <% @role.users.each do |user| %>
+    <li><%= user.user_key %>
+      <% if can? :remove_user, Role %>
+        <%= button_to "Remove User", role_management.role_user_path(@role, user), :method=>:delete, :class=>'btn btn-danger' %>
+      <% end %>
+    </li>
+  <% end %>
+</ul>
+<h3>Add a new account:</h3>
+<%= bootstrap_form_tag role_management.role_users_path(@role) do %>
+  <%= bootstrap_text_field_tag 'user_key', '', :label=>'User' %>
+  <%= bootstrap_actions do %>
+    <%= bootstrap_submit_tag "Add" %>
+    <%= bootstrap_cancel_tag %>
+  <% end %>
+<% end %>

data/config/routes.rb

@@ -1,6 +1,6 @@
 Hydra::RoleManagement::Engine.routes.draw do
   # Generic file routes
-  resources :roles, :only => [:index, :show, :new, :create] do
+  resources :roles do
     resources :users, :only=>[:create, :destroy], :controller => "user_roles"
   end
 end

data/hydra-role-management.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'cancan'
   gem.add_dependency 'bootstrap_forms'
-
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rails'
   gem.add_development_dependency 'rspec-rails'

data/lib/generators/roles/roles_generator.rb

@@ -37,22 +37,49 @@ This generator makes the following changes to your application:
   # Add behaviors to the user model
   def inject_user_roles_behavior
     file_path = "app/models/#{model_name.underscore}.rb"
-    if File.exists?(file_path) 
-      code = "# Connects this user object to Role-management behaviors. " +
-        "\n include Hydra::RoleManagement::UserRoles\n"        
-      inject_into_file file_path, code, { :after => /include Hydra::User/ }
+    if File.exists?(file_path)
+      if File.read(file_path).match(/include Hydra::User/)
+        code = "\n # Connects this user object to Role-management behaviors. " +
+          "\n include Hydra::RoleManagement::UserRoles\n"        
+        inject_into_file file_path, code, { :after => /include Hydra::User/ }
+      else
+        puts "     \e[31mFailure\e[0m  Hydra::User is not included in #{file_path}.  Add 'include Hydra::User' and rerun."
+      end
     else
       puts "     \e[31mFailure\e[0m  hydra-role-management requires a user object. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g roles client" 
     end    
   end
 
-
   # The engine routes have to come after the devise routes so that /users/sign_in will work
   def inject_routes
     routing_code = "mount Hydra::RoleManagement::Engine => '/'"
     sentinel = /devise_for :users/
     inject_into_file 'config/routes.rb', "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
-    
+  end
+
+  # As of 7.23.2013 cancan support for Rails 4 is weak and requires monkey-patching.
+  # More information can be found at https://github.com/ryanb/cancan/issues/835
+  def rails4_application_controller_patch
+    if Rails::VERSION::MAJOR == 4
+      puts "Adding before_filter to application_controller to help Cancan work with Rails 4."
+      file_path = "app/controllers/application_controller.rb"
+      code = "\n  before_filter do" +
+        "\n    resource = controller_path.singularize.gsub('/', '_').to_sym \n" + 
+        '    method = "#{resource}_params"'+ 
+        "\n    params[resource] &&= send(method) if respond_to?(method, true)" + 
+        "\n  end"
+
+      inject_into_file file_path, code, {after: 'class ApplicationController < ActionController::Base'}
+    end
+  end
+
+  # If this gem is installed under Rails 3, an attr_accessible method is required for the Role model.  This
+  # file will be added to config/initializers and the correct code will be added to the model at runtime.
+  def rails3_attr_accessible
+    if !ActionController.const_defined? :StrongParameters
+      puts "Role model will include attr_accessible :name because you are installing this gem in a Rails 3 app."
+      copy_file "hydra_role_management_rails3.rb", "config/initializers/hydra_role_management_rails3.rb"
+    end
   end
 
   private  

data/lib/generators/roles/templates/hydra_role_management_rails3.rb

@@ -0,0 +1 @@
+Role.send :include, Hydra::RoleManagement::LegacyAttributeHandling

data/lib/hydra/role_management/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module RoleManagement
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/lib/hydra-role-management.rb

@@ -1,3 +1,2 @@
-#require "bundler/setup"
 require "hydra/role_management"
-#require "blacklight"
+require 'bootstrap_forms'

data/spec/controllers/roles_controller_spec.rb

@@ -12,17 +12,32 @@ describe RolesController do
     Role.create(name: 'foo')
   end
 
-
-  describe "with a user who cannot edit users" do
-    it "should redirect to the homepage" do
+  before(:each) do 
+    @routes = Hydra::RoleManagement::Engine.routes
+  end
+  
+  describe "with a user who cannot edit roles" do
+    it "should not be able to view role index" do
       lambda { get :index }.should raise_error CanCan::AccessDenied
     end
-    it "should redirect to the homepage" do
+    it "should not be able to view role" do
       lambda { get :show, id: role }.should raise_error CanCan::AccessDenied
     end
+    it "should not be able to view new role form" do
+      lambda { get :new }.should raise_error CanCan::AccessDenied
+    end
+    it "should not be able to create a role" do
+      lambda { post :create, :role=>{name: 'my_role'}}.should raise_error CanCan::AccessDenied
+    end
+    it "should not be able to update a role" do
+      lambda { put :update, id: role}.should raise_error CanCan::AccessDenied
+    end
+    it "should not be able to remove a role" do
+      lambda { delete :destroy, id: role}.should raise_error CanCan::AccessDenied
+    end
   end
 
-  describe "with a user who can edit users" do
+  describe "with a user who can read roles" do
     before do
       ability.can :read, Role
     end
@@ -39,6 +54,15 @@ describe RolesController do
     end
   end
 
+  describe "with a user who can only update role 'foo'" do
+    it "should be redirected to edit" do
+      ability.can :read, Role
+      ability.can :update, Role, id: role.id
+      get :show, id: role
+      response.should redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
+    end
+  end
+  
   describe "with a user who can create roles" do
     before do
       ability.can :create, Role
@@ -51,7 +75,7 @@ describe RolesController do
 
     it "should be able to create a new role" do
       post :create, :role=>{name: 'my_role'} 
-      response.should redirect_to @routes.url_helpers.roles_path
+      response.should redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
       assigns[:role].should_not be_new_record
       assigns[:role].name.should == 'my_role'
     end
@@ -63,4 +87,34 @@ describe RolesController do
     end
   end
 
+  describe "with a user who can update roles" do
+    before do
+      ability.can :update, Role
+    end
+
+    it "should be able to update a role" do
+      put :update, id: role, :role=>{name: 'my_role'} 
+      response.should redirect_to @routes.url_helpers.edit_role_path(assigns[:role])
+      assigns[:role].should_not be_new_record
+      assigns[:role].name.should == 'my_role'
+    end
+    it "should not update role with an error" do
+      put :update,  id: role, :role=>{name: 'my role'} 
+      assigns[:role].name.should == 'my role'
+      assigns[:role].errors[:name].should == ['Only letters, numbers, hyphens, underscores and periods are allowed']
+      response.should be_successful
+    end
+  end
+
+  describe "with a user who can remove roles" do
+    before do
+      ability.can :destroy, Role
+    end
+
+    it "should be able to destroy a role" do
+      delete :destroy, id: role 
+      response.should redirect_to @routes.url_helpers.roles_path
+    end
+  end
+
 end

data/spec/controllers/user_roles_controller_spec.rb

@@ -12,6 +12,10 @@ describe UserRolesController do
     Role.create(name: 'foo')
   end
 
+  before(:each) do 
+    @routes = Hydra::RoleManagement::Engine.routes
+  end
+
   describe "with a user who cannot edit users" do
     it "should not be able to add a user" do
       lambda { post :create, role_id: role, user_key: 'foo@example.com'}.should raise_error CanCan::AccessDenied

data/spec/support/gemfile_stub

@@ -0,0 +1,4 @@
+gem 'blacklight'
+gem 'hydra-head'
+gem 'hydra-role-management', :path=>'../../'
+gem 'bootstrap-forms'

data/spec/support/lib/generators/test_app_generator.rb

@@ -40,8 +40,4 @@ class TestAppGenerator < Rails::Generators::Base
   def copy_rspec_rake_task
     copy_file "lib/tasks/rspec.rake"
   end
-
-  def copy_hydra_config
-    copy_file "config/initializers/hydra_config.rb"
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hydra-role-management
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancan
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CONTRIBUTING.md
 - Gemfile
 - README.md
 - Rakefile
@@ -95,14 +96,17 @@ files:
 - app/controllers/concerns/hydra/role_management/user_roles_behavior.rb
 - app/controllers/roles_controller.rb
 - app/controllers/user_roles_controller.rb
+- app/models/concerns/hydra/role_management/legacy_attribute_handling.rb
 - app/models/concerns/hydra/role_management/user_roles.rb
 - app/models/role.rb
+- app/views/roles/edit.html.erb
 - app/views/roles/index.html.erb
 - app/views/roles/new.html.erb
 - app/views/roles/show.html.erb
 - config/routes.rb
 - hydra-role-management.gemspec
 - lib/generators/roles/roles_generator.rb
+- lib/generators/roles/templates/hydra_role_management_rails3.rb
 - lib/generators/roles/templates/migrations/user_roles.rb
 - lib/hydra-role-management.rb
 - lib/hydra/role_management.rb
@@ -114,10 +118,10 @@ files:
 - spec/models/role_spec.rb
 - spec/routing/role_management_routes_spec.rb
 - spec/spec_helper.rb
-- spec/support/Gemfile
 - spec/support/app/models/sample.rb
 - spec/support/app/models/solr_document.rb
 - spec/support/config/initializers/hydra_config.rb
+- spec/support/gemfile_stub
 - spec/support/lib/generators/test_app_generator.rb
 - spec/support/lib/tasks/rspec.rake
 homepage: https://github.com/projecthydra/hydra-role-management
@@ -139,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Rails engine to do user roles in an RDBMS for hydra-head
@@ -151,10 +155,9 @@ test_files:
 - spec/models/role_spec.rb
 - spec/routing/role_management_routes_spec.rb
 - spec/spec_helper.rb
-- spec/support/Gemfile
 - spec/support/app/models/sample.rb
 - spec/support/app/models/solr_document.rb
 - spec/support/config/initializers/hydra_config.rb
+- spec/support/gemfile_stub
 - spec/support/lib/generators/test_app_generator.rb
 - spec/support/lib/tasks/rspec.rake
-has_rdoc: 

data/spec/support/Gemfile

@@ -1,28 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'rails'
-
-# Bundle edge Rails instead:
-# gem 'rails', :git => 'git://github.com/rails/rails.git'
-
-gem 'sqlite3'
-gem 'blacklight'
-gem 'hydra-head'
-
-
-# Gems used only for assets and not required
-# in production environments by default.
-group :assets do
-  gem 'sass-rails',   '~> 3.2.3'
-  gem 'coffee-rails', '~> 3.2.1'
-
-  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  #gem 'therubyracer', :platforms => :ruby
-
-  gem 'uglifier', '>= 1.0.3'
-end
-
-gem 'jquery-rails'
-
-gem 'hydra-role-management', :path=>'../../'
-gem 'rspec-rails'