base_indexer 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbc32b1c7767d03fb0eb45612332901ae0f01586
+  data.tar.gz: adbb902e6efb0304992be7f89c053685fd55e1d2
+SHA512:
+  metadata.gz: 0c0b46a0392eecaa229dd77a2a9361e62fc5eebfcffcf9a8c0724e68ed555bccae09c821e4213e2f8f28292d4b33bfc94c8496fd04a8bf8e22d78d227860a0a4
+  data.tar.gz: 1f71711f0ce3e1fbf56b9aff4d90e3ec154e0ca98fbd193d42d320018882230165a4228b98dbe88629df21ffd5907cc74085684bc4629158d4e1cdcf21c87f9a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= BaseIndexer
+
+This project rocks and uses MIT-LICENSE.
+
+== Steps to hook the base_indexer engine in your app
+* Generate new rails app
+<em>rails new my_indexer_app<em>
+
+*Edit Gemfile and add the base_indexer gem name
+_gem 'base_indexer'_
+
+* Run bundle install to download the gem
+_bundle install_
+
+* Mount the engine in your favorite domain.
+_mount BaseIndexer::Engine, at: '/items'_
+
+== Basic configuration
+The engine is looking for the following values 
+
+_config.solr_config_file_path = "#{config.root}/config/solr.yml"_
+_DiscoveryIndexer::PURL_DEFAULT='http://purl.stanford.edu/'_
+
+
+Advanced features
+The engine gives the developer the ability to extend any of its classes
+
+To extend any of indexer features (purl-reader, mods-reader, mapper, solr-writer)
+
+1. Create a new class that inherits from BaseIndexer::MainIndexerEngine
+2. Create a new file named config/initializers/base_indexer.rb
+3. In this file, add the following line. replace 'MyIndexerClassName' with the fully qualifed actual class name. The name should be between double qoutes
+BaseIndexer.indexer_class = "MyIndexerClassName"
+4. In the new indexer class, you can override any of the functions that you need to change its implementation. For example, if you need to use a new mapper, you will override map function.
+
+To extend mapper functionality.
+1. Create a new class e.g., MyMapper that inherits from GeneralMapper or IndexMapper.
+2. Implement MyMapper.map to converts the input to solr doc hash.
+3. Override MyIndexerClassName.map to call your new class instead of the default one.
+

data/Rakefile

@@ -0,0 +1,39 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BaseIndexer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+#require 'rake/testtask'
+
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << 'lib'
+#  t.libs << 'test'
+#  t.pattern = 'test/**/*_test.rb'
+#  t.verbose = false
+#end
+
+
+#task default: :test
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/app/controllers/base_indexer/application_controller.rb

@@ -0,0 +1,5 @@
+module BaseIndexer
+  class ApplicationController < ActionController::Base
+
+  end
+end

data/app/controllers/base_indexer/items_controller.rb

@@ -0,0 +1,43 @@
+require_dependency "base_indexer/application_controller"
+
+module BaseIndexer
+  class ItemsController < ApplicationController
+    respond_to :json
+
+    def new
+      begin  
+        druid = params[:druid]
+        targets = params[:subtargets]
+        
+        indexer = BaseIndexer.indexer_class.constantize.new
+        indexer.index druid, targets
+        @status = report_success
+        render status: 200
+      rescue Exception => e  
+        @status = report_failure request.method_symbol, params, e
+        render status: 202
+      end
+    end
+    
+    def delete
+      begin
+        druid = params[:druid]
+        indexer = BaseIndexer.indexer_class.constantize.new
+        indexer.delete druid
+        @status= report_success
+        render status: 200
+      rescue Exception => e  
+        @status =  report_failure request.method_symbol, params, e
+        render status: 202
+      end
+    end
+        
+    def report_failure method_symbol, params, e
+      return "#{method_symbol} #{params}\n\n#{e.inspect}\n#{e.cause.inspect }\n#{e.backtrace}"
+    end
+    
+    def report_success
+      return "success"
+    end
+  end
+end

data/app/helpers/base_indexer/application_helper.rb

@@ -0,0 +1,4 @@
+module BaseIndexer
+  module ApplicationHelper
+  end
+end

data/app/helpers/base_indexer/items_helper.rb

@@ -0,0 +1,4 @@
+module BaseIndexer
+  module ItemsHelper
+  end
+end

data/app/views/base_indexer/items/new.json.erb

@@ -0,0 +1 @@
+<%=@status%>

data/config/initializers/base_indexer.rb

@@ -0,0 +1,6 @@
+
+# Define the indexer class that will be used by the engine. 
+# The engine consumer app should override this class
+BaseIndexer.indexer_class = "BaseIndexer::MainIndexerEngine"
+BaseIndexer.solr_configuration_class = "BaseIndexer::SolrConfigurationFromFile"
+#BaseIndexer.solr_configuration_class.constantize.new(Rails.configuration.solr_config_file_path)

data/config/routes.rb

@@ -0,0 +1,4 @@
+BaseIndexer::Engine.routes.draw do
+  get '/items/:druid', to: 'items#new'
+  delete '/items/:druid', to: 'items#destroy'
+end

data/lib/base_indexer/collection.rb

@@ -0,0 +1,29 @@
+module BaseIndexer
+  class Collection
+    def self.get_collection_name(collection_druid)
+      
+      collection_name = get_from_cahce(collection_druid)
+      if collection_name.nil?
+        collection_name = get_from_purl(collection_druid)
+      end
+      collection_name
+    end
+    
+    def self.get_from_cahce(collection_druid)
+      Rails.cache.read(collection_druid)
+    end
+    
+    def self.get_from_purl(collection_druid)
+      begin
+        purl_model =DiscoveryIndexer::InputXml::Purlxml.new(collection_druid).load()
+        unless purl_model.nil? or purl_model.label.nil? 
+          Rails.cache.write(collection_druid, purl_model.label, expires_in: 1.hours)
+          purl_model.label
+        end
+      rescue Exception => e
+        puts e
+        return nil
+      end
+    end
+  end
+end

data/lib/base_indexer/engine.rb

@@ -0,0 +1,14 @@
+require 'active_support/core_ext/numeric/bytes'
+
+module BaseIndexer
+  class Engine < ::Rails::Engine
+    isolate_namespace BaseIndexer
+    # Initialize memory store cache with 50 MB size
+    config.cache_store = [:memory_store, {:size => 64.megabytes }]
+    config.after_initialize do 
+          BaseIndexer.solr_configuration_class.constantize.instance.read(Rails.configuration.solr_config_file_path ||= 'test')
+          DiscoveryIndexer::Logging.logger = Rails.logger
+    end
+  end
+end
+

data/lib/base_indexer/main_indexer_engine.rb

@@ -0,0 +1,75 @@
+require 'discovery-indexer'
+module BaseIndexer
+  class MainIndexerEngine
+    include DiscoveryIndexer
+    
+    def index druid, targets
+      purl_model =  read_purl(druid)
+      mods_model =  read_mods(druid)
+      collection_names = get_collection_names(purl_model.collection_druids)
+      solr_doc = map(druid, mods_model, purl_model, collection_names)
+      
+      targets_hash={}
+      if targets.nil? or targets.length == 0
+        targets_hash = purl_model.release_tags_hash
+      else
+        targets_hash = get_targets_hash_from_param(targets)
+      end
+      
+      write(druid, solr_doc, targets_hash, get_solr_targets_configs())
+    end
+    
+    def delete druid
+      solr_writer = DiscoveryIndexer::Writer::SolrWriter.new
+      solr_writer.solr_delete_from_all( druid,  get_solr_targets_configs())
+    end
+    
+    def read_purl druid
+      return DiscoveryIndexer::InputXml::Purlxml.new(druid).load()
+    end
+    
+    def read_mods druid
+      return DiscoveryIndexer::InputXml::Modsxml.new(druid).load()
+    end
+    
+    def map druid, mods_model, purl_model, collection_names
+      return DiscoveryIndexer::Mapper::IndexerlMapper.new(druid, mods_model, purl_model, collection_name).map 
+    end
+    
+    def write druid, solr_doc, targets, solr_targets_configs
+      solr_writer = DiscoveryIndexer::Writer::SolrWriter.new
+      solr_writer.process( druid, solr_doc, targets, solr_targets_configs)
+      #DiscoveryIndexer::Writer::SolrClient.add(solr_doc, solr_connector)
+    end
+    
+    def get_targets_hash_from_param(targets)
+      targets_hash = {}
+      targets.each do |target|
+        targets_hash[target] = true
+      end
+      return targets_hash
+    end
+    
+#    def get_targets_hash_from_release_tags release_tags
+#      indexer_target_name = "Robot_Testing_Feb_5_2015"
+#      return DiscoveryIndexer::Utilities::ExtractSubTargets.by_name(indexer_target_name,release_tags ) 
+#    end
+    
+    def get_solr_targets_configs
+      return BaseIndexer.solr_configuration_class.constantize.instance.get_configuration_hash
+    end
+    
+    def get_collection_names collection_druids
+      collection_names = {}
+      
+      unless collection_druids.nil? then
+        collection_druids.each do |cdruid|
+          cname = BaseIndexer::Collection.get_collection_name(cdruid)
+          collection_names[cdruid] = cname unless cname.nil? 
+        end
+      end
+      collection_names
+    end
+    
+  end
+end

data/lib/base_indexer/message.rb

@@ -0,0 +1,6 @@
+module BaseIndexer
+  class Message
+    attr_accessor :status
+    attr_accessor :text_message
+  end
+end

data/lib/base_indexer/solr/solr_configuration.rb

@@ -0,0 +1,10 @@
+module BaseIndexer
+  class SolrConfiguration
+    
+    def read(default_arg=nil)
+    end
+    
+    def get_configuration_hash
+    end
+  end
+end

data/lib/base_indexer/solr/solr_configuration_from_file.rb

@@ -0,0 +1,16 @@
+require 'singleton'
+require 'yaml'
+
+module BaseIndexer
+  class SolrConfigurationFromFile < SolrConfiguration
+    include Singleton
+    
+    def read(yaml_file=nil)
+      @solr_config_hash = YAML.load_file(yaml_file)
+    end
+    
+    def get_configuration_hash
+      @solr_config_hash
+    end
+  end
+end

data/lib/base_indexer/version.rb

@@ -0,0 +1,3 @@
+module BaseIndexer
+  VERSION = "0.0.1"
+end

data/lib/base_indexer.rb

@@ -0,0 +1,12 @@
+require "base_indexer/engine"
+
+require "base_indexer/main_indexer_engine"
+require "base_indexer/solr/solr_configuration"
+require "base_indexer/solr/solr_configuration_from_file"
+require "base_indexer/collection"
+require 'discovery-indexer'
+module BaseIndexer
+  mattr_accessor :indexer_class
+  mattr_accessor :solr_configuration_class
+end
+

data/lib/tasks/base_indexer_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :base_indexer do
+#   # Task goes here
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'factory_girl_rails'
+Rails.backtrace_cleaner.remove_silencers!
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.use_transactional_fixtures = true
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: base_indexer
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ahmed Alsum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.1.9
+- !ruby/object:Gem::Dependency
+  name: discovery-indexer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Description of BaseIndexer.
+email:
+- aalsum@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- app/controllers/base_indexer/application_controller.rb
+- app/controllers/base_indexer/items_controller.rb
+- app/helpers/base_indexer/application_helper.rb
+- app/helpers/base_indexer/items_helper.rb
+- app/views/base_indexer/items/new.json.erb
+- config/initializers/base_indexer.rb
+- config/routes.rb
+- lib/base_indexer.rb
+- lib/base_indexer/collection.rb
+- lib/base_indexer/engine.rb
+- lib/base_indexer/main_indexer_engine.rb
+- lib/base_indexer/message.rb
+- lib/base_indexer/solr/solr_configuration.rb
+- lib/base_indexer/solr/solr_configuration_from_file.rb
+- lib/base_indexer/version.rb
+- lib/tasks/base_indexer_tasks.rake
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Summary of BaseIndexer.
+test_files:
+- spec/spec_helper.rb
+has_rdoc: