change_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed505bd1d903e923e9892dd686e0603bf242ffec
+  data.tar.gz: 9f31243477193f69e645c1fddaedc5a2caa96911
+SHA512:
+  metadata.gz: 42acce9e36ad9d556187f9f71d14183ae1bc458c8ca142db0fdaf986b8d6f044ed6ccf4bf5cc83a24c98e28db45fbdb4c0846adfbc9cb31acbc33577f6afefb4
+  data.tar.gz: 46c7e0a4be5e7a6302482f108519c8f840224dbc057f18d867b7faa8ab83290b008e4716c623528ef688e27d7f963e92f1131d2e010ab44009fe2fcfe959469a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 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,3 @@
+= ChangeManager
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'resque/tasks'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChangeManager'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/testapp/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+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/jobs/make_change.rb

@@ -0,0 +1,9 @@
+class MakeChange
+	def self.queue
+		:change
+	end
+
+	def self.perform(change_id)
+	    ChangeManager::Manager.notify(change_id)
+	end
+end

data/app/mailers/change_manager/notification_mailer.rb

@@ -0,0 +1,32 @@
+module ChangeManager
+	class NotificationMailer < ActionMailer::Base
+		
+		def construct_email(changes)
+			@body = prepare_body(changes)
+			mail(
+				to: changes.first.target,
+				from: changes.first.owner,
+				subject: 'Updates from Scholar@UC',
+				)
+		end
+
+		def send_email(constructed_email)
+			constructed_email.deliver
+		end
+
+		def prepare_body(changes)
+			header = '<table><th><td>Change Owner</td><td>Change Context</td><td>Change</td><td>Time</td></th>'
+			body = ''
+			footer = '</table>'
+			changes.each do |change|
+				#may need a look up method from curate here
+				body += '<tr><td>' + 
+				change.owner + '</td><td>' + 
+				change.context + '</td><td>' + 
+				change.change_type + '</td><td>' + 
+				change.created_at.to_s + '</td></tr>'
+			end
+			content = header + body + footer
+		end
+	end
+end

data/app/models/change_manager/change.rb

@@ -0,0 +1,39 @@
+require 'yaml'
+
+module ChangeManager
+  class Change < ActiveRecord::Base
+  	validates :change_type, :owner, :target, :context, presence: true
+
+  	def self.new_change(owner, change_type, context, target, cancelled = false)
+  		# needs a spec
+  		# create object in db
+  		# return object id
+  		foo = self.create({
+        owner: owner, 
+        change_type: change_type, 
+        context: context, 
+        target: target, 
+        cancelled: cancelled
+        })
+  		foo.id
+  	end
+
+    def cancel
+      self.cancelled = true
+      self.save
+    end
+
+    def cancelled?
+      self.cancelled
+    end
+
+    def inverse_of?(possible_inverse_change)
+      is_inverse = false
+      @change_types ||= YAML.load_file(File.join(ChangeManager::Engine.root, 'config/change_types.yaml'))
+      if self.change_type == @change_types[possible_inverse_change.change_type]['inverse']
+        is_inverse = true
+      end
+      return is_inverse
+    end
+  end
+end

data/app/services/change_manager/manager.rb

@@ -0,0 +1,43 @@
+module ChangeManager
+	class Manager
+		def self.queue_change(owner, change_type, context, target)
+			change_id = Change.new_change(owner, change_type, context, target)
+			Resque.enqueue(MakeChange, change_id)
+			# Resque.enqueue_in(
+			# 	30.seconds,
+			# 	MakeChange,
+			# 	change_id
+			# 	)
+		end
+
+		def self.notify(change_id)
+			unless Change.find(change_id).cancelled?
+				change = Change.find(change_id)
+				similar_changes = group_similar_changes(change.owner, change.target)
+				mailer = ChangeManager::NotificationMailer
+				mailer.send_email(mailer.construct_email(similar_changes))
+			end
+		end
+
+		def self.group_similar_changes(owner, target)
+			similar_changes = Change.where(owner: owner, target: target, cancelled: false)
+			if similar_changes.length > 1
+				cancel_inverse_changes(similar_changes)
+			end
+			return similar_changes
+		end
+
+		def self.cancel_inverse_changes(similar_changes)
+			similar_changes.each do |change|
+				similar_changes.each do |next_change|
+					if change.inverse_of?(next_change)
+						change.cancel
+						next_change.cancel
+						similar_changes.delete_if { |change| change.cancelled? }
+					end
+				end
+			end
+			return similar_changes
+		end
+	end
+end

data/app/views/change_manager/notification_mailer/construct_email.html.erb

@@ -0,0 +1,20 @@
+<!-- mailer template here -->
+<div>
+	Dear Scholar@UC User,
+</div>
+<br>
+This email is to inform you that the following changes have been made to your account:
+<br><br>
+<%= @body.html_safe %>
+
+Changes can include:
+<br>
+<ul>
+	<li>Being added/removed as another contributor's delegate</li>
+	<li>Being added/removed as an editor of a work</li>
+	<li>Being added/removed to a group</li>
+</ul>
+
+
+Thanks,
+The Scholar@UC team

data/config/change_types.yaml

@@ -0,0 +1,71 @@
+added_as_delegate:
+ print: added_as_delegate
+ inverse: removed_as_delegate
+ human_readable: Added as a delegate
+removed_as_delegate:
+ print: removed_as_delegate
+ inverse: added_as_delegate
+ human_readable: Removed as a delegate
+added_as_editor:
+ print: added_as_editor
+ inverse: removed_as_editor
+ human_readable: Added as an editor
+removed_as_editor:
+ print: removed_as_editor
+ inverse: added_as_editor
+ human_readable: Removed as an editor
+added_to_group:
+ print: added_to_group
+ inverse: removed_from_group
+ human_readable: Added to a group
+removed_from_group:
+ print: removed_from_group
+ inverse: added_to_group
+ human_readable: Removed from a group
+
+# added_as_delegate:
+#  - added_as_delegate
+#  - inverse: removed_as_delegate
+#  - Added as a delegate
+# removed_as_delegate:
+#  - removed_as_delegate
+#  - inverse: added_as_delegate
+#  - Removed as a delegate
+# added_as_editor:
+#  - added_as_editor
+#  - inverse: removed_as_editor
+#  - Added as an editor
+# removed_as_editor:
+#  - removed_as_editor
+#  - inverse: added_as_editor
+#  - Removed as an editor
+# added_to_group:
+#  - added_to_group
+#  - inverse: removed_from_group
+#  - Added to a group
+# removed_from_group:
+#  - removed_from_group
+#  - inverse: added_to_group
+#  - Removed from a group
+
+
+
+
+ # - added_as_delegate
+ # - removed_as_delegate
+ # - added_as_editor
+ # - removed_as_editor
+ # - added_to_group
+ # - removed_from_group
+
+
+
+ # delegates:
+ #  - added_as_delegate
+ #  - removed_as_delegate
+ # editors:
+ #  - added_as_editor
+ #  - removed_as_delegate
+ # groups:
+ #  - added_to_group
+ #  - removed_from_group

data/db/migrate/20160420192850_create_change_manager_changes.rb

@@ -0,0 +1,14 @@
+class CreateChangeManageChanges < ActiveRecord::Migration
+  def change
+    create_table :change_manager_changes do |t|
+      t.string :change_type
+      t.boolean :change_cancelled
+      t.datetime :change_notified
+      t.string :change_owner
+      t.string :change_target
+      t.string :change_context
+      
+      t.timestamps
+    end
+  end
+end

data/lib/change_manager/engine.rb

@@ -0,0 +1,12 @@
+module ChangeManager
+  class Engine < ::Rails::Engine
+    isolate_namespace ChangeManager
+
+    config.generators do |g|
+		g.test_framework :rspec, :fixture => false
+		g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+		g.assets false
+		g.helper false
+ 	end
+  end
+end

data/lib/change_manager/version.rb

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

data/lib/change_manager.rb

@@ -0,0 +1,4 @@
+require "change_manager/engine"
+
+module ChangeManager
+end

data/lib/tasks/change_manager_tasks.rake

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

data/lib/tasks/resque.rake

@@ -0,0 +1,9 @@
+# Resque tasks
+require 'resque/tasks'
+require 'resque/scheduler/tasks'
+
+# Rails.application.initialize!
+
+namespace :resque do
+	task ":setup" => :environment
+end

data/spec/factories/change_manager_changes.rb

@@ -0,0 +1,11 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+
+FactoryGirl.define do
+  factory :change, :class => 'ChangeManager::Change' do
+  	owner "email@test.com"
+  	change_type "added_as_delegate"
+  	context "1"
+  	target "spec@test.com"
+  	cancelled false
+  end
+end

data/spec/mailers/change_manager/notification_mailer_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+module ChangeManager
+  describe NotificationMailer do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

data/spec/models/change_manager/change_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module ChangeManager
+    describe Change do
+
+        it 'has a valid factory' do
+        	FactoryGirl.create(:change).should be_valid
+        end
+
+        it 'should have a change_owner' do
+        	FactoryGirl.build(:change, owner: nil).should_not be_valid
+        end
+
+        it 'should have a change_target' do
+        	FactoryGirl.build(:change, target: nil).should_not be_valid
+        end
+
+        it 'should have a change_type' do
+        	FactoryGirl.build(:change, change_type: nil).should_not be_valid
+        end
+
+        it 'should be initialized as false' do
+            FactoryGirl.build(:change).cancelled.should be_false
+        end
+
+        # seperate describe blocks, wrap in context
+        context 'instance method' do
+            let(:cancelled_change) { FactoryGirl.build(:change, cancelled: true) }
+            let(:change) { FactoryGirl.build(:change) }
+            describe '#cancel' do
+                after { change.cancelled = false }
+            	it 'should cancel a notification' do
+                    change.cancel
+            		change.cancelled.should be_true
+            	end
+            end
+
+            describe '#cancelled?' do
+            	it 'should return whether a notification is cancelled' do
+            		change.cancelled.should be_false
+            		cancelled_change.cancelled?.should be_true
+            	end
+            end
+
+            describe '#inverse_of?' do
+                let(:inverse_change) { FactoryGirl.build(:change, change_type: 'removed_as_delegate')}
+                let(:noninverse_change) { FactoryGirl.build(:change, change_type: 'added_as_editor')}
+                
+                it 'should accurately detect inverse changes' do
+                    change.inverse_of?(inverse_change).should be_true
+                end
+
+                it 'should not detect non-inverse changes' do
+                    change.inverse_of?(noninverse_change).should be_false
+                end
+            end
+        end
+    end
+end

data/spec/services/change_manager/manager_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+module ChangeManager
+	describe Manager do
+		describe '#queue_change' do
+			let(:queued_change) { Manager.queue_change('test', 'removed_as_delegate', 'work_id1', 'testemail@gmail.com') }
+			it 'should spawn a background worker' do
+				queued_change.should be_true
+			end
+		end
+		describe '#notify' do
+			let(:cancelled_change) { FactoryGirl.create(:change, cancelled: true)}
+			let(:change) { FactoryGirl.create(:change) }
+			it 'should do nothing if initial change is cancelled' do
+				Manager.notify(cancelled_change.id).should be_nil
+			end
+			it 'should execute if initial change isn\'t cancelled' do
+				Manager.notify(change.id).should_not be_nil
+			end
+		end
+		describe '#group_similar_changes:' do
+			let!(:initial_change) { Change.find(Change.new_change('owner', 'added_as_editor', 'work_id1', 'target'))}
+			let(:possible_similar_changes) { Manager.group_similar_changes(initial_change.owner, initial_change.target) }
+		# describe the different changes
+			# unrelated changes (owner and target aren't the same as initial - cancelled doesnt matter)
+			context 'unrelated changes' do
+				# same owner & target
+				let!(:related_change) { Change.find(Change.new_change('owner', 'added_as_delegate', 'work_id1', 'target')) }
+				# same owner, different target
+				let!(:so_change) { Change.find(Change.new_change('owner', 'added_to_group', 'work_id2', 'target2')) }
+				# different owner, same target
+				let!(:st_change) { Change.find(Change.new_change('owner1', 'added_to_group', 'work_id2', 'target')) }
+				# load everything into array, give length for comparison (there should only be 2: initial change and related_notification)
+				
+				it 'should not be loaded into the array' do
+					expect(possible_similar_changes).to include(initial_change)
+					expect(possible_similar_changes).to include(related_change)
+					expect(possible_similar_changes).not_to include(so_change)
+					expect(possible_similar_changes).not_to include(st_change)
+				end
+			end
+
+			# cancelled related changes (owner and target are the same as initial - shouldn't be loaded into similar_changes)
+			context 'cancelled related changes' do 
+				let!(:cancelled_change) { Change.find(Change.new_change('owner', 'added_to_group', 'work_id4', 'target')) }
+				let!(:noncancelled_change) { Change.find(Change.new_change('owner', 'added_as_delegate', 'work_id1', 'target')) }
+				before { cancelled_change.cancel }
+				it 'should not be loaded into the array' do
+					expect(possible_similar_changes).to include(initial_change)
+					expect(possible_similar_changes).to include(noncancelled_change)
+					expect(possible_similar_changes).not_to include(cancelled_change)
+				end
+			end
+			# non-cancelled (related) inverse changes (neither should be loaded into similar changes)
+			context 'inverse changes' do
+				let!(:initial_change) { Change.find(Change.new_change('owner', 'added_to_group', 'work_id1', 'target'))}
+				let!(:noninverse_change) { Change.find(Change.new_change('owner', 'added_to_group', 'work_id4', 'target')) }
+				let!(:first_inverse_change) { Change.find(Change.new_change('owner', 'added_as_delegate', 'work_id1', 'target')) }
+				let!(:next_inverse_change) { Change.find(Change.new_change('owner', 'removed_as_delegate', 'work_id1', 'target')) }
+				after {
+					first_inverse_change.cancelled = false
+					next_inverse_change.cancelled = false
+				}
+				it 'should not be loaded into the array' do
+					expect(possible_similar_changes).to include(initial_change)
+					expect(possible_similar_changes).to include(noninverse_change)
+					expect(possible_similar_changes).not_to include(first_inverse_change)
+					expect(possible_similar_changes).not_to include(next_inverse_change)
+				end
+				context 'with three or more inverse changes' do
+					let!(:third_inverse_change) { Change.find(Change.new_change('owner', 'added_as_delegate', 'work_id1', 'target')) }
+					it 'should only remove n - 1 changes' do
+						expect(possible_similar_changes).to include(third_inverse_change)
+					end
+				end
+			end			
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require File.expand_path("../testapp/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

data/spec/testapp/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/testapp/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Testapp::Application.load_tasks

data/spec/testapp/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/testapp/app/assets/stylesheets/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/spec/testapp/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/testapp/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/testapp/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Testapp</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/testapp/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/testapp/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/testapp/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/testapp/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "change_manager"
+
+module Testapp
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+