editstore 1.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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,182 @@
+= Editstore
+
+This project uses MIT-LICENSE.
+
+It provides models that allow your client web application to cache descriptive metadata updates in a special database.
+
+== Installation
+
+1. Add the following to your application's 'Gemfile':
+
+	source 'http://sul-gems.stanford.edu'  # only if you don't already have it
+	gem 'editstore'
+
+2. Install the gem
+
+	bundle install
+
+3. Add the migrations to your app
+
+	rake editstore:install:migrations
+
+4. Add development and test database connection stings to the 'database.yml' file in your app for development/test:
+
+	editstore_development:
+	  adapter: sqlite3
+	  database: db/editstore_development.sqlite3
+	  pool: 5
+	  timeout: 5000
+    
+	editstore_test:
+	  adapter: sqlite3
+	  database: db/editstore_test.sqlite3
+	  pool: 5
+	  timeout: 5000
+
+	editstore_production:
+	  adapter: mysql2
+	  database: # GET IT FROM FRIENDLY SYSADMIN IF YOU NEED IT FOR PRODUCTION
+
+5. Generate a migration to store your project specific name and fields in your own test/dev databases:
+
+	rails g migration editstore_myproject
+
+6. Edit your migration to add your project name and fields.  Be sure to have the migration use the correct Editstore database
+connection string as shown below.  For servers (e.g. staging, production), these changes be done after your creating your template and running the 
+rake editstore:update_editstore_config RAILS_ENV=environment task.
+
+By default, migrations such as this should only run in development and test mode.  By adding the "if Editstore.run_migrations?" qualifier, you will
+ensure you will not get the migrations except in development and test.  The reason is that in staging and production the actual editstore database
+will already be properly configured when you setup the project and do not want these migrations run again on the production servers during
+deployment.  However, since locally you are not running an actual correctly configured instance of the editstore system, these migrations give you
+enough information to make the app work in development.
+
+An example of this migration you need to add is shown below:
+
+	def up
+	  if Editstore.run_migrations?
+  	  @connection=Editstore::Connection.connection
+  	  project=Editstore::Project.create(:name=>'Revs',:template=>'revs')
+  	  Editstore::Field.create(:name=>'title_tsi',:project_id=>project.id)
+  	  Editstore::Field.create(:name=>'pub_year_isim',:project_id=>project.id)
+    end
+	end
+
+7. Run the migrations
+
+	rake db:migrate 
+
+== Usage
+
+1. [Optional] If you define the constant "EDITSTORE_PROJECT" in your ruby/rails project as a string that matches a known project in the
+editstore database , the gem will automatically associated all updates with your project.  A good spot to set this
+constant in a Rails app is at the bottom of the 'config/application.rb' file, e.g.
+
+	EDITSTORE_PROJECT='Revs'  
+
+2. In the application, to apply an update to DOR, you just need to create a new "Editstore::Change" object and save it.
+If your application needs to update a local SOLR or MySQL, you will need to do this yourself.  This object just saves
+the changes to the editstore database for later propagation to DOR using a project specific template.
+
+The properties you need to set are:
+
+	old_value  : for an update or delete operation, this specifies the current value and is required
+	new_value  : for an update or create operation, this species the new value and is required
+	operation  : set to a symbol with one of three possible values of :update, :delete or :create
+	project_id : set to the project_id of the editstore project, this is set automatically if you followed step 1 above
+	state      : set to Editstore::State.ready OR Editstore::State.wait
+								setting to the 'ready' state means the change can be propagated to DOR immediately
+								setting to the 'wait' state means you do NOT want the change to be propagated to DOR immediately
+								  -- if you set to 'wait', you will need to keep track of the change yourself (probably using the object ID once it is saved)
+								     so you can come and update the state later to 'ready' when you want the change propagated.  This might happen if you
+								     have curated changes
+								
+  field       : a valid field name defined in your project template and listed in the 'fields' table of the editstore database for your project
+	druid       : the druid of the object you want to update (can include or not include the 'druid:' prefix)
+	client_note : an optional note you can set for your application purposes only
+
+Some examples are below:
+
+	a. Add a new value:
+	
+		add=Editstore::Change.new
+		add.new_value='new value'
+		add.operation=:create
+		add.state=Editstore::State.ready 
+		#add.project_id=1 # you can leave this off if you set the EDITSTORE_PROJECT constant as describe above
+		add.field='title'
+		add.druid='druid:oo000oo0001'
+		add.client_note='some note' 
+		add.save
+		
+	b. Change an existing value:
+
+	  change=Editstore::Change.new
+		change.new_value='new value' 
+		change.old_value='previous value' 
+		change.operation=:update
+		change.state=Editstore::State.ready 
+		#change.project_id=1 # you can leave this off if you set the EDITSTORE_PROJECT constant as describe above
+		change.field='title' 
+		change.druid='druid:oo000oo0001'
+		change.client_note='some note' 
+		change.save
+		
+	c. Delete an existing value (useful to delete just value in a multivalued field):
+
+	  delete=Editstore::Change.new
+		delete.old_value='value to delete'
+		delete.operation=:delete
+		delete.state=Editstore::State.ready 
+		#delete.project_id=1 # you can leave this off if you set the EDITSTORE_PROJECT constant as describe above
+		delete.field='title' 
+		delete.druid='druid:oo000oo0001'
+		delete.client_note='some note' 
+		delete.save		
+
+	d. Delete all existing values (can be used for either a single valued field or can be used to delete *all* values in a multivalued field):
+	
+		# just leave off the 'old_value' attribute to delete any values associated with this field
+		delete=Editstore::Change.new
+		delete.operation=:delete
+		delete.state=Editstore::State.ready 
+		#delete.project_id=1 # you can leave this off if you set the EDITSTORE_PROJECT constant as describe above
+		delete.field='title' 
+		delete.druid='druid:oo000oo0001'
+		delete.client_note='some note' 
+		delete.save
+					
+== Useful Cleanup Tasks
+
+When running in development mode, you will get a lot of unprocessed changes building up in the development
+editstore database (since you won't have the back-end system processing them and cleaning them out).  To clean out
+entries from the editstore database:
+
+	rake editstore:remove_pending
+	
+In production, you can also use this task to clean out any rows that have been marked as completed:
+
+	rake editstore:remove_complete
+	
+Use this task to clear out the unlocked druids from the object lock table.  Should be safe to run at any time.
+
+  rake editstore:prune_locks
+  
+Use this task to clear out the locked druids from the object lock table.  Should only be run if you are sure locks have hung and 
+there are no other processes running.
+
+  rake editstore:clear_locks  
+
+Use this task to clear out the any log run entries older than one month. Should be safe to run at any time if you don't need more than 1 month of run log history
+
+  rake editstore:prune_run_log
+    	
+== Running Tests
+
+There is a "dummy" rails app in "spec/dummy" that is used for testing.  To run the tests, run the migrations and then
+run the standard rspec tests:
+
+	cd ./spec/dummy && rake editstore:install:migrations && rake db:migrate RAILS_ENV=test && cd ../..
+	bundle exec rspec
+	
+	

data/Rakefile

@@ -0,0 +1,44 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Editstore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/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
+
+# DLSS specific stuff
+require 'dlss/rake/dlss_release'
+Dlss::Release.new

data/app/assets/javascripts/editstore/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/editstore/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/editstore/application_controller.rb

@@ -0,0 +1,4 @@
+module Editstore
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/editstore/application_helper.rb

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

data/app/models/editstore/change.rb

@@ -0,0 +1,119 @@
+module Editstore
+  require 'druid-tools'
+  
+  class Change < Connection
+    belongs_to :state
+    belongs_to :project
+    belongs_to :object_lock, :primary_key=>:druid, :foreign_key=>:druid
+    attr_accessible :field,:project_id,:old_value,:new_value,:operation,:client_note,:druid,:state_id,:error,:pending
+
+    OPERATIONS=%w{create update delete}
+    
+    validates :field, presence: true
+    validates :operation, presence: true
+    validates :new_value, presence: true, :if => "%w{update create}.include? self.operation.to_s"
+    validates :old_value, presence: true, :if => "%w{update}.include? self.operation.to_s"
+    validates :project_id, presence: true, numericality: { only_integer: true }
+    validates :state_id, presence: true, numericality: { only_integer: true }
+    validate :valid_state_id
+    validate :valid_project_id
+    validate :valid_field_name
+    validate :valid_druid
+    validate :valid_operation
+    
+    before_validation :set_default_project, :if => "defined?(EDITSTORE_PROJECT) && !EDITSTORE_PROJECT.nil?" # this allows the user to set this in their project so it will set automatically for each change
+    
+    def self.prune
+      self.destroy_all(:state_id=>Editstore::State.complete)  
+    end
+    
+    def self.by_project_id(project_id)
+      if project_id.to_s.empty?
+        scoped
+      else
+        where(:project_id=>project_id)
+      end
+    end
+
+    def self.by_state_id(state_id)
+      if state_id.to_s.empty?
+        scoped
+      else
+        where(:state_id=>state_id)
+      end
+    end
+
+    # get the latest changes to process for a specific state (defaults to ready) and an optional limit
+    # if not restricted by druid, will group by druid
+    def self.latest(params={})
+
+      state_id=params[:state_id] || Editstore::State.ready.id
+      limit=params[:limit]
+      project_id=params[:project_id]
+      druid=params[:druid]
+       
+      changes = scoped
+      changes = changes.includes(:project)
+      changes = changes.where(:state_id=>state_id) if state_id != '*'
+      changes = changes.where(:project_id=>project_id) if project_id
+      changes = changes.where(:druid=>druid) if druid
+      changes = changes.order('created_at,id asc')
+      changes = changes.limit(limit) unless limit.blank?
+      druid ? changes : changes.group_by {|c| c.druid}
+     
+    end
+    
+    # get the latest list of unique druids to process for a specific state (defaults to ready) and an optional limit, return an array
+    def self.latest_druids(params={})
+
+      state_id=params[:state_id] || Editstore::State.ready.id
+      limit=params[:limit]
+      project_id=params[:project_id]
+      
+      changes = scoped
+      changes = changes.includes(:project)
+      changes = changes.where(:state_id=>state_id) if state_id != '*'
+      changes = changes.where(:project_id=>project_id) if project_id
+      changes = changes.order('editstore_changes.created_at,editstore_changes.id asc')
+      changes = changes.limit(limit) unless limit.blank?
+      changes.uniq.pluck(:druid)
+
+    end
+    
+    private
+    def valid_operation
+      errors.add(:operation, "is not valid") unless OPERATIONS.include? operation.to_s  
+    end
+    
+    # project name is case insensitive
+    def set_default_project
+      default_project = Editstore::Project.where('lower(name)=?',EDITSTORE_PROJECT.downcase).limit(1)
+      self.project_id = default_project.first.id if (default_project.size == 1 && !self.project_id)
+    end
+    
+    def valid_druid
+      if !DruidTools::Druid.valid?(self.druid)
+        errors.add(:druid,"is invalid")
+      end
+    end
+    
+    def valid_field_name
+      if Editstore::Field.where(:name=>self.field,:project_id=>self.project_id).count == 0
+        errors.add(:field, "is invalid")
+      end      
+    end
+    
+    def valid_state_id
+      if !Editstore::State.exists?(self.state_id)
+        errors.add(:state_id, "is invalid")
+      end
+    end
+
+    def valid_project_id
+      if !Editstore::Project.exists?(self.project_id)
+        errors.add(:project_id, "is invalid")
+      end
+    end
+        
+  end
+end

data/app/models/editstore/connection.rb

@@ -0,0 +1,6 @@
+module Editstore
+  class Connection < ActiveRecord::Base
+    self.abstract_class = true
+    establish_connection "editstore_#{Rails.env}"
+  end
+end

data/app/models/editstore/field.rb

@@ -0,0 +1,6 @@
+module Editstore
+  class Field < Connection
+    belongs_to :project
+    attr_accessible :project_id,:name
+  end
+end

data/app/models/editstore/object_lock.rb

@@ -0,0 +1,83 @@
+module Editstore
+  class ObjectLock < Connection
+    attr_accessible :locked, :druid
+  
+    def self.prune
+      self.destroy_all(:locked=>nil)
+    end  
+    
+    def self.unlock_all
+      self.all_locked.each {|obj| obj.unlock}
+    end
+    
+    def self.get_pid(pid)
+      pid.start_with?('druid:') ? pid : "druid:#{pid}"
+    end
+    
+    def self.all_locked
+      self.where('locked IS NOT NULL')
+    end
+
+    def self.all_unlocked
+      self.where(:locked=>nil)
+    end
+  
+    # some convenience class level methods for operating on a specific druid
+    def self.lock(pid)
+      status=self.find_by_druid(self.get_pid(pid))
+      if status # this druid already exists in the table
+        return status.lock
+      else # this druid does not exist in the table, create it and lock
+         self.create(:druid=>self.get_pid(pid),:locked=>Time.now)
+         return true
+      end
+    end
+  
+    def self.unlock(pid)
+     status=self.find_by_druid(self.get_pid(pid))
+     if status # this druid already exists in the table
+         return status.unlock
+      else
+        return false # druid doesn't exist, can't unlock
+      end
+    end
+  
+    # check to see if this druid is locked
+    def self.locked?(pid)
+      status=self.find_by_druid(self.get_pid(pid))
+      status.nil? ? false : status.locked?
+    end
+    
+    # object level methods for performing actions  
+    def locked?
+      !unlocked?
+    end
+  
+    def unlocked?
+      locked == nil
+    end
+        
+    # lock this object
+    def lock
+       if unlocked?
+         self.locked = Time.now
+         save
+         return true # lock at the current time
+      else
+        return false # already locked
+      end
+    end
+    
+    # unlock this object
+    def unlock
+      if locked?
+         self.locked = nil
+         save
+         return true # unlock it    
+      else
+        return false # already unlocked
+      end
+    end
+  
+ end
+end

data/app/models/editstore/project.rb

@@ -0,0 +1,9 @@
+module Editstore
+  class Project < Connection
+     has_many :changes, :dependent => :destroy
+     has_many :fields, :dependent => :destroy
+     attr_accessible :name, :template
+     validates :name, presence: true
+     validates :template, presence: true
+  end
+end

data/app/models/editstore/run_log.rb

@@ -0,0 +1,10 @@
+module Editstore
+  class RunLog < Connection
+    attr_accessible :total_druids,:total_changes,:num_errors,:num_pending,:note
+    def self.prune
+      self.where('updated_at < ?',1.month.ago).each {|obj| obj.destroy}
+    end
+  end
+end                 
+                    
+                    

data/app/models/editstore/state.rb

@@ -0,0 +1,36 @@
+module Editstore
+  class State < Connection
+     has_many :changes
+     attr_accessible :name
+     validates :name, presence: true
+
+     # these helper methods allow you to easily refer to a particular state like this, with the query cached in the object:
+     # Editstore::State.wait
+     # Editstore::State.ready
+     
+     def self.wait
+       @@wait ||= self.find_by_name('wait')
+     end
+
+     def self.ready
+       @@ready ||= self.find_by_name('ready')
+     end
+
+     def self.in_process
+       @@in_process ||= self.find_by_name('in process')
+     end
+
+     def self.error
+       @@error ||= self.find_by_name('error')
+     end
+     
+     def self.applied
+       @@applied ||= self.find_by_name('applied')
+     end
+
+     def self.complete
+       @@complete ||= self.find_by_name('complete')
+     end
+          
+  end
+end

data/app/views/layouts/editstore/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Editstore</title>
+  <%= stylesheet_link_tag    "editstore/application", :media => "all" %>
+  <%= javascript_include_tag "editstore/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Editstore::Engine.routes.draw do
+end

data/db/migrate/20130710234514_create_editstore_projects.rb

@@ -0,0 +1,15 @@
+class CreateEditstoreProjects < ActiveRecord::Migration
+    
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_projects do |t|
+        t.string :name, :null=>false
+        t.string :template, :null=>false
+        t.timestamps
+      end
+      Editstore::Project.create(:id=>1,:name=>'Generic',:template=>'generic')
+    end
+  end
+  
+end

data/db/migrate/20130711172833_create_editstore_changes.rb

@@ -0,0 +1,18 @@
+class CreateEditstoreChanges < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_changes do |t|
+        t.integer :project_id, :null=>false
+        t.string  :field, :null=>false
+        t.string  :druid, :null=>false
+        t.text    :old_value
+        t.text    :new_value
+        t.string  :operation, :null=>false
+        t.integer :state_id, :null=>false
+        t.text    :client_note
+        t.timestamps
+      end
+    end
+  end
+end

data/db/migrate/20130711173100_create_editstore_states.rb

@@ -0,0 +1,17 @@
+class CreateEditstoreStates < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_states do |t|
+        t.string  :name, :null=>false
+        t.timestamps
+      end
+      Editstore::State.create(:id=>1,:name=>'wait')
+      Editstore::State.create(:id=>2,:name=>'ready')
+      Editstore::State.create(:id=>3,:name=>'in process')
+      Editstore::State.create(:id=>4,:name=>'error')
+      Editstore::State.create(:id=>5,:name=>'applied')
+      Editstore::State.create(:id=>6,:name=>'complete')    
+    end
+  end
+end

data/db/migrate/20130711211606_create_editstore_fields.rb

@@ -0,0 +1,14 @@
+class CreateEditstoreFields < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_fields do |t|
+        t.integer :project_id,:null=>false
+        t.string  :name,:null=>false
+        t.timestamps
+      end
+      Editstore::Field.create(:id=>1,:name=>'title',:project_id=>'1')
+      Editstore::Field.create(:id=>1,:name=>'description',:project_id=>'1')    
+    end
+  end
+end

data/db/migrate/20130814221827_add_error_to_change.rb

@@ -0,0 +1,8 @@
+class AddErrorToChange < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      add_column :editstore_changes, :error, :string
+    end
+  end
+end

data/db/migrate/20131004224346_add_pending_to_change.rb

@@ -0,0 +1,8 @@
+class AddPendingToChange < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      add_column :editstore_changes, :pending, :boolean, :default=>false
+    end
+  end
+end

data/db/migrate/20131015203809_create_object_lock.rb

@@ -0,0 +1,12 @@
+class CreateObjectLock < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_object_locks do |t|
+        t.string :druid, :null=>false
+        t.datetime :locked
+        t.timestamps
+      end
+    end
+  end
+end

data/db/migrate/20131015205757_add_indices.rb

@@ -0,0 +1,16 @@
+class AddIndices < ActiveRecord::Migration
+  def up
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      add_index(:editstore_changes, :project_id)
+      add_index(:editstore_changes, :druid)
+      add_index(:editstore_changes, :state_id)
+      add_index(:editstore_fields, :project_id)
+      add_index(:editstore_object_locks, :druid)
+      add_index(:editstore_object_locks, :locked)
+    end
+  end
+
+  def down
+  end
+end

data/db/migrate/20131016183057_create_run_log.rb

@@ -0,0 +1,17 @@
+class CreateRunLog < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      create_table :editstore_run_logs do |t|
+        t.integer :total_druids
+        t.integer :total_changes
+        t.integer :num_errors
+        t.integer :num_pending
+        t.string :note
+        t.datetime :started
+        t.datetime :ended
+        t.timestamps
+      end
+    end
+  end
+end

data/db/migrate/20131017165120_add_locking_version.rb

@@ -0,0 +1,8 @@
+class AddLockingVersion < ActiveRecord::Migration
+  def change
+    if Editstore.run_migrations?
+      @connection=Editstore::Connection.connection
+      add_column :editstore_object_locks, :lock_version, :string
+    end
+  end
+end

data/lib/editstore.rb

@@ -0,0 +1,7 @@
+require "editstore/engine"
+
+module Editstore
+  def self.run_migrations?
+    %w{development test}.include? Rails.env
+  end
+end

data/lib/editstore/engine.rb

@@ -0,0 +1,8 @@
+module Editstore
+  class Engine < ::Rails::Engine
+    isolate_namespace Editstore
+    config.generators do |g|
+      g.test_framework :rspec, :view_specs => false
+    end
+  end
+end

data/lib/editstore/version.rb

@@ -0,0 +1,3 @@
+module Editstore
+  VERSION = "1.1.5"
+end

data/lib/tasks/editstore_tasks.rake

@@ -0,0 +1,33 @@
+namespace :editstore do
+
+  desc "Remove completed updates"
+  task :remove_complete => :environment do
+    Editstore::Change.prune
+  end
+
+  desc "Prune run log to remove entries over 1 month old"
+  task :prune_run_log => :environment do
+    Editstore::RunLog.prune
+  end
+  
+  desc "Prune locked object tables to remove any unlocked druids"
+  task :prune_locks => :environment do
+    Editstore::ObjectLock.prune
+  end
+
+  desc "Remove all object locks for any druids"
+  task :clear_locks => :environment do
+    Editstore::ObjectLock.unlock_all
+  end
+    
+  desc "Remove unprocessed updates"
+  task :remove_pending => :environment do
+    unless Rails.env.production?
+      Editstore::Change.destroy_all(:state_id=>Editstore::State.wait)
+      Editstore::Change.destroy_all(:state_id=>Editstore::State.ready)    
+    else
+      puts "Refusing to delete since we're running under the #{Rails.env} environment. You know, for safety."
+    end
+  end
+
+end

data/lib/validators/is_druid_validator.rb

@@ -0,0 +1,8 @@
+class IsDruidValidator < ActiveModel::EachValidator
+
+  def validate_each(record, attribute, value)
+    return if DruidTools::Druid.valid?(value)
+    record.errors[attribute] << (options[:message] || "is not a valid druid")
+  end
+
+end

data/test/editstore_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class EditstoreTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Editstore
+  end
+end

data/test/fixtures/editstore/editstore_fields.yml

@@ -0,0 +1,23 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+title:
+  name: title
+  project_id: 1 # generic
+  created_at: <%=Time.now%>
+  updated_at: <%=Time.now%>
+      
+description:
+  name: description
+  project_id: 1 # generic
+  created_at: <%=Time.now%>
+  updated_at: <%=Time.now%>
+
+title_revs:
+  name: title
+  project_id: 2 # revs
+  created_at: <%=Time.now%>
+  updated_at: <%=Time.now%>  

data/test/fixtures/editstore/editstore_projects.yml

@@ -0,0 +1,20 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+# This model initially had no columns defined.  If you add columns to the
+# model remove the '{}' from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+generic: 
+  id: 1
+  name: generic
+  template: generic
+  created_at: <%=Time.now%>
+  updated_at: <%=Time.now%>
+    
+revs: 
+  id: 2
+  name: revs
+  template: revs
+  created_at: <%=Time.now%>
+  updated_at: <%=Time.now%>
+  

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../spec/dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end

data/test/unit/editstore/change_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module Editstore
+  class ChangeTest < ActiveSupport::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/unit/editstore/field_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module Editstore
+  class FieldTest < ActiveSupport::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/unit/editstore/project_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module Editstore
+  class ProjectTest < ActiveSupport::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/unit/editstore/state_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module Editstore
+  class StateTest < ActiveSupport::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: editstore
+version: !ruby/object:Gem::Version
+  version: 1.1.5
+  prerelease: 
+platform: ruby
+authors:
+- Peter Mangiafico
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: druid-tools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lyberteam-devel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: lyberteam-gems-devel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The editstore gem is a Rails engine, including all models and migrations
+  needed to connect to the editstore database for caching descriptive metadata edits.
+email:
+- pmangiafico@stanford.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/editstore/application.js
+- app/assets/stylesheets/editstore/application.css
+- app/controllers/editstore/application_controller.rb
+- app/helpers/editstore/application_helper.rb
+- app/models/editstore/change.rb
+- app/models/editstore/connection.rb
+- app/models/editstore/field.rb
+- app/models/editstore/object_lock.rb
+- app/models/editstore/project.rb
+- app/models/editstore/run_log.rb
+- app/models/editstore/state.rb
+- app/views/layouts/editstore/application.html.erb
+- config/routes.rb
+- db/migrate/20130710234514_create_editstore_projects.rb
+- db/migrate/20130711172833_create_editstore_changes.rb
+- db/migrate/20130711173100_create_editstore_states.rb
+- db/migrate/20130711211606_create_editstore_fields.rb
+- db/migrate/20130814221827_add_error_to_change.rb
+- db/migrate/20131004224346_add_pending_to_change.rb
+- db/migrate/20131015203809_create_object_lock.rb
+- db/migrate/20131015205757_add_indices.rb
+- db/migrate/20131016183057_create_run_log.rb
+- db/migrate/20131017165120_add_locking_version.rb
+- lib/editstore/engine.rb
+- lib/editstore/version.rb
+- lib/editstore.rb
+- lib/tasks/editstore_tasks.rake
+- lib/validators/is_druid_validator.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/editstore_test.rb
+- test/fixtures/editstore/editstore_fields.yml
+- test/fixtures/editstore/editstore_projects.yml
+- test/test_helper.rb
+- test/unit/editstore/change_test.rb
+- test/unit/editstore/field_test.rb
+- test/unit/editstore/project_test.rb
+- test/unit/editstore/state_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4522800769409732582
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4522800769409732582
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: The editstore gem is used by client web applications (like Revs Digital Library)
+  to stage changes to descriptive metadata in DOR
+test_files:
+- test/editstore_test.rb
+- test/fixtures/editstore/editstore_fields.yml
+- test/fixtures/editstore/editstore_projects.yml
+- test/test_helper.rb
+- test/unit/editstore/change_test.rb
+- test/unit/editstore/field_test.rb
+- test/unit/editstore/project_test.rb
+- test/unit/editstore/state_test.rb