hydra-batch-edit 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88b816f49539deda36c4029d5fc68148e23436d7
-  data.tar.gz: 138ecb568f0749a34cfa497918004646b6110fd9
+  metadata.gz: 041fb6c8cbceea532367e5b77b7283243abb98f2
+  data.tar.gz: 21100df59111000878aee65687e56d9bd6bde753
 SHA512:
-  metadata.gz: 7a270792034acf9c454750ee27b20a7dbcb159919e8a417d8d8dc99d7987311800bbba87a7a5bc7eb26a968cf25c1234c8b10fa92c5f661b36eafcd2a889ae05
-  data.tar.gz: 9707ec9d4c52ae144f5a27aec51a6c013acfaf326675db7379fd20012acb595fb2e1c98dfa709f73f372a27f968ef0ffa5441bd14a4615843b0ebb753118460b
+  metadata.gz: ab5feb6defd561b0e8224d98253ce8a15c62bb05a8a586294515215195a484a70dff7df0082435ca88b381964259e07cb613e3ba5873d8432c6fbdf840090b96
+  data.tar.gz: ffe4e1e1e4689578978802ddc210675e1c3492df589d2e9f54f524e6c0a613b89f904d82d740f70a5e1b1b78343ebee98e0ae3fdfdea12bc0089e6cc4fdadefa

data/.gitignore

@@ -1,5 +1,10 @@
 *.gem
 Gemfile.lock
+.rvmrc
+.ruby-version
+.ruby-gemset
+ruby-version
+ruby-gemset
 *.rbc
 .bundle
 .config

data/Rakefile

@@ -7,12 +7,17 @@ ENV["RAILS_ROOT"] ||= 'spec/internal'
 desc 'Default: run specs.'
 task :default => :spec
 
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec => :generate) do |t|
-      t.rspec_opts = "--colour"
+
+task :spec => [:generate] do |t|
+  focused_spec = ENV['SPEC'] ? " SPEC=#{File.join(GEM_ROOT, ENV['SPEC'])}" : ''
+  within_test_app do
+    system "rake myspec#{focused_spec}"
+    abort "Error running hydra-batch-edit" unless $?.success?
+  end
 end
 
 
+
 desc "Create the test rails app"
 task :generate do
   unless File.exists?('spec/internal/Rakefile')
@@ -23,15 +28,15 @@ task :generate do
     puts "Copying generator"
     `cp -r spec/support/lib/generators spec/internal/lib`
 
-    FileUtils.cd('spec/internal')
-    puts "Bundle install"
-    `bundle install`
-    puts "running generator"
-    puts `rails generate test_app`
+    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`
-    FileUtils.cd('../..')
+      puts "running migrations"
+      puts `rake db:migrate db:test:prepare`
+    end
   end
   puts "Running specs"
 end
@@ -41,3 +46,11 @@ task :clean do
   puts "Removing sample rails app"
   `rm -rf spec/internal`
 end
+
+def within_test_app
+  FileUtils.cd('spec/internal')
+  Bundler.with_clean_env do
+    yield
+  end
+  FileUtils.cd('../..')
+end

data/lib/hydra/batch_edit/search_service.rb

@@ -4,7 +4,6 @@ module Hydra
       include Blacklight::Configurable
       include Blacklight::SolrHelper
 
-
       def initialize(session, user_key)
         @session = session
         @user_key = user_key
@@ -13,37 +12,46 @@ module Hydra
 
       solr_search_params_logic << :apply_gated_search
 
-      def last_search_documents 
+      def last_search_documents
         return [] if @session[:history].blank?
         last_search_id = @session[:history].first
-        search = Search.find(last_search_id) 
-        result, document_list = get_search_results(search.query_params, :fl=>'id', :rows=>1000)
+        search = Search.find(last_search_id)
+        _, document_list = get_search_results(search.query_params, :fl=>'id', :rows=>1000)
         document_list
       end
 
       # filter that sets up access-controlled lucene query in order to provide gated search behavior
       # @param solr_parameters the current solr parameters
-      # @param user_parameters the current user-subitted parameters
+      # @param user_parameters the current user-submitted parameters
       def apply_gated_search(solr_parameters, user_parameters)
         solr_parameters[:fq] ||= []
+
         # Grant access to public content
         user_access_filters = []
-        
-        user_access_filters << "edit_access_group_t:public"
-        
+        user_access_filters << "#{solr_access_control_suffix(:group)}:public"
+
         # Grant access based on user id & role
-        unless @user_key.nil?
+        unless @user_key.blank?
           # for roles
-          ::RoleMapper.roles(@user_key).each_with_index do |role, i|
-            user_access_filters << "edit_access_group_t:#{role}"
+          ::RoleMapper.roles(@user_key).each do |role|
+            user_access_filters << "#{solr_access_control_suffix(:group)}:#{escape_slashes(role)}"
           end
           # for individual person access
-          user_access_filters << "edit_access_person_t:#{@user_key}"        
+          user_access_filters << "#{solr_access_control_suffix(:individual)}:#{escape_slashes(@user_key)}"
         end
-        solr_parameters[:fq] << user_access_filters.join(" OR ")
-        logger.debug("Solr parameters: #{ solr_parameters.inspect }")
-    end
+        solr_parameters[:fq] << user_access_filters.join(' OR ')
+        solr_parameters
+      end
+
+      def escape_slashes(value)
+        value.gsub('/', '\/')
+      end
 
+      # @param [Symbol] key The permission type to return.  Must be `:group` or `:individual`
+      def solr_access_control_suffix(key)
+        raise ArgumentError, "you must provide :group or :individual" unless [:group, :individual].include?(key)
+        Hydra.config[:permissions][:edit][key]
+      end
     end
   end
 end

data/lib/hydra/batch_edit/version.rb

@@ -1,5 +1,5 @@
 module Hydra
   module BatchEdit
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/controllers/batch_edits_controller_spec.rb

@@ -1,11 +1,6 @@
 require 'spec_helper'
 
 describe BatchEditsController do
-  before :all do
-    module ActiveFedora
-      module Base; end
-    end
-  end
   before(:each) do
     request.env["HTTP_REFERER"] = "/"
   end

data/spec/lib/search_service_spec.rb

@@ -1,17 +1,41 @@
 require 'spec_helper'
 
 describe Hydra::BatchEdit::SearchService do
-
   before do
+    @login = 'vanessa'
     @session = {:history => [17, 14, 12, 9]}
-    @service = Hydra::BatchEdit::SearchService.new(@session, 'vanessa')
+    @service = Hydra::BatchEdit::SearchService.new(@session, @login)
   end
 
   it "should get the documents for the first history entry" do
     Search.should_receive(:find).with(17).and_return(Search.new(:query_params=>{:q=>"World Peace"}))
     @service.should_receive(:get_search_results).and_return([:one, [:doc1, :doc2]])
     @service.last_search_documents.should == [:doc1, :doc2]
-
   end
 
+  describe 'apply_gated_search' do
+    before(:each) do
+      RoleMapper.stub(:roles).with(@login).and_return(['umg/test.group.1'])
+      params = @service.apply_gated_search({}, {})
+      @group_query = params[:fq].first.split(' OR ')[1]
+    end
+    it "should escape slashes in groups" do
+      @group_query.should == 'edit_access_group_ssim:umg\/test.group.1'
+    end
+    it "should allow overriding Solr's access control suffix" do
+      module Hydra
+        module BatchEdit
+          class SearchService
+            def solr_access_control_suffix(key)
+              "edit_#{key}_customfield"
+            end
+          end
+        end
+      end
+      @service = Hydra::BatchEdit::SearchService.new({}, '')
+      params = @service.apply_gated_search({}, {})
+      @public_query = params[:fq].first.split(' OR ')[0]
+      @public_query.should == 'edit_group_customfield:public'
+    end
+  end
 end

data/spec/support/Gemfile

@@ -6,6 +6,7 @@ gem 'rails'
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
 
 gem 'sqlite3'
+gem 'hydra-head'
 
 
 # Gems used only for assets and not required
@@ -15,7 +16,7 @@ group :assets do
   gem 'coffee-rails', '~> 3.2.1'
 
   # See https://github.com/sstephenson/execjs#readme for more supported runtimes
-  gem 'therubyracer', :platforms => :ruby
+  #gem 'therubyracer', :platforms => :ruby
 
   gem 'uglifier', '>= 1.0.3'
 end

data/spec/support/config/initializers/hydra_config.rb

@@ -0,0 +1,28 @@
+# The following lines determine which user attributes your hydrangea app will use
+# This configuration allows you to use the out of the box ActiveRecord associations between users and user_attributes
+# It also allows you to specify your own user attributes
+# The easiest way to override these methods would be to create your own module to include in User
+# For example you could create a module for your local LDAP instance called MyLocalLDAPUserAttributes:
+#   User.send(:include, MyLocalLDAPAttributes)
+# As long as your module includes methods for full_name, affiliation, and photo the personalization_helper should function correctly
+#
+
+# windows doesn't properly require hydra-head (from the gemfile), so we need to require it explicitly here:
+require 'hydra/head' unless defined? Hydra
+
+if Hydra.respond_to?(:configure)
+  Hydra.configure(:shared) do |config|
+    # This specifies the solr field names of permissions-related fields.
+    # You only need to change these values if you've indexed permissions by some means other than the Hydra's built-in tooling.
+    # If you change these, you must also update the permissions request handler in your solrconfig.xml to return those values
+    indexer = Solrizer::Descriptor.new(:string, :stored, :indexed, :multivalued)
+    config[:permissions] = {
+      :discover => {:group =>ActiveFedora::SolrService.solr_name("discover_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("discover_access_person", indexer)},
+      :read => {:group =>ActiveFedora::SolrService.solr_name("read_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("read_access_person", indexer)},
+      :edit => {:group =>ActiveFedora::SolrService.solr_name("edit_access_group", indexer), :individual=>ActiveFedora::SolrService.solr_name("edit_access_person", indexer)},
+      :owner => ActiveFedora::SolrService.solr_name("depositor", indexer),
+      :embargo_release_date => ActiveFedora::SolrService.solr_name("embargo_release_date", Solrizer::Descriptor.new(:date, :stored, :indexed))
+    }
+    
+  end
+end

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

@@ -16,4 +16,12 @@ class TestAppGenerator < Rails::Generators::Base
     copy_file "app/models/solr_document.rb"
     copy_file "db/migrate/20111101221803_create_searches.rb"
   end
+
+  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

data/spec/support/lib/tasks/rspec.rake

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+desc "run the hydra-batch-edit gem spec"
+gem_home = File.expand_path('../../../../..', __FILE__)
+RSpec::Core::RakeTask.new(:myspec) do |t|
+  t.pattern = gem_home + '/spec/**/*_spec.rb'
+  t.rspec_opts = "--colour"
+  t.ruby_opts = "-I#{gem_home}/spec"
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-batch-edit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blacklight
@@ -107,8 +107,10 @@ files:
 - 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/db/migrate/20111101221803_create_searches.rb
 - spec/support/lib/generators/test_app_generator.rb
+- spec/support/lib/tasks/rspec.rake
 homepage: https://github.com/projecthydra/hydra-batch-edit
 licenses: []
 metadata: {}
@@ -128,7 +130,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 batch editing with hydra-head
@@ -142,6 +144,7 @@ test_files:
 - 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/db/migrate/20111101221803_create_searches.rb
 - spec/support/lib/generators/test_app_generator.rb
-has_rdoc: 
+- spec/support/lib/tasks/rspec.rake