artk 0.0.1

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,66 @@
+# ARTK
+*A rails engine for Archivists' Toolkit*
+
+Provides a minimal RESTful interface to some of the tables in the Archivist's Toolkit database
+
+## Usage
+
+You can access finding aids, their components and accessions via URLs such as
+
+    /artk/resources
+
+which returns a list of all finding aids, something like
+
+    [[{"ARC-0030":"Terry Stewart Collection"},{"ARC-0001":"Art Collins Papers"},{"ARC-0003":"Milt Gabler Papers"}]
+
+or you can access a single finding aid in the `Resources` table by using    
+
+    /artk/resources/ARC-0001
+
+which will return json for the `ARC-0001` record in the `Resources` table of the AT database.  You may also
+get a listing of all the non-item level components of a finding aid by going to
+
+    /artk/resources/ARC-0001/components
+
+which will return something like
+
+    [{"ref1":"Series I: Iggy Pop [RESTRICTED]"},{"ref4":"Series II: Marianne Faithfull [RESTRICTED]"}]
+
+or an identifier and title for each component in the collection.
+
+## Installation
+
+Add the gem to your Rails gemfile
+
+    gem 'artk'
+
+And then add the engine to your application
+
+    mount Artk::Engine => '/artk'
+
+Configure the gem to connect to your database by adding a `config/initializers/at_connect.rb` file:
+
+    ActiveRecord::Base.establish_connection(
+      :adapter  => 'mysql2',
+      :encoding => 'utf8',
+      :database => 'at_database_name',
+      :host     => 'host_of_the_at_database',
+      :username => 'username',
+      :password => 'password'
+    )
+
+
+## Contributing
+
+This was written to meet our own local needs, but I welcome patches, feature requests, etc.  At the moment, testing is based
+on our own AT database, which prevents continuous integration testing.  Please submit issues as you see fit.
+
+## TODO
+
+* Use test that don't require a local AT install
+* Sanitize query parameters
+* Better searching
+
+## Copyright
+
+(c) 2013 Adam Wead

data/Rakefile

@@ -0,0 +1,15 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+Dir.glob('tasks/*.rake').each { |r| import r }
+
+ENV["RAILS_ROOT"] ||= 'spec/internal'
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]

data/app/assets/javascripts/artk/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/app/assets/stylesheets/artk/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/artk/accessions_controller.rb

@@ -0,0 +1,14 @@
+module Artk
+class AccessionsController < Artk::ApplicationController
+
+  def index
+    @accessions = Accession.find(:all)
+    respond_to do |format|
+      format.html { render :layout => false, :text => @accessions.to_json }
+      format.json { render :layout => false, :text => @accessions.to_json }
+      format.js   { render :layout => false, :text => @accessions.to_json }
+    end
+  end
+
+end
+end

data/app/controllers/artk/application_controller.rb

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

data/app/controllers/artk/components_controller.rb

@@ -0,0 +1,14 @@
+module Artk
+class ComponentsController < Artk::ApplicationController
+
+  def index
+    @results = Resource.find_by_ead_id(params[:resource_id]).all_series.collect { |s| s.pid_and_title }
+    respond_to do |format|
+      format.html { render :layout => false, :text => @results.to_json }
+      format.json { render :layout => false, :text => @results.to_json }
+      format.js   { render :layout => false, :text => @results.to_json }
+    end
+  end
+
+end
+end

data/app/controllers/artk/resources_controller.rb

@@ -0,0 +1,28 @@
+module Artk
+class ResourcesController < Artk::ApplicationController
+
+  def index
+    @results = Resource.finding_aids.collect { |fa| fa.pid_and_title }
+    respond_to do |format|
+      format.html { render :layout => false, :text => @results.to_json }
+      format.json { render :layout => false, :text => @results.to_json }
+      format.js   { render :layout => false, :text => @results.to_json }
+    end
+  end
+
+  def show
+    @resource = Resource.find_by_ead_id(params[:id])
+    if @resource.nil?
+      redirect_to :status => 404 
+    else
+      respond_to do |format|
+        format.html { render :layout => false, :text => @resource.to_json }
+        format.json { render :layout => false, :text => @resource.to_json }
+        format.js   { render :layout => false, :text => @resource.to_json }
+      end
+    end
+
+  end
+
+end
+end

data/app/helpers/artk/application_helper.rb

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

data/app/models/artk/accession.rb

@@ -0,0 +1,11 @@
+class Artk::Accession < ActiveRecord::Base
+  
+  def self.table_name
+    "Accessions"
+  end
+
+  def self.primary_key
+    "accessionId"
+  end
+
+end

data/app/models/artk/component.rb

@@ -0,0 +1,24 @@
+module Artk
+class Component < ActiveRecord::Base
+
+  belongs_to :resource, :foreign_key => "resourceId"
+  has_many :sub_components, :class_name => "Component", :foreign_key => "parentResourceComponentId"
+
+  def self.table_name
+    "ResourcesComponents"
+  end
+
+  def self.primary_key
+    "resourceComponentId"
+  end
+
+  def has_child?
+    self.sub_components.count > 0 ? true : false
+  end 
+
+  def pid_and_title
+    { self.persistentId => self.title }
+  end 
+
+end
+end

data/app/models/artk/resource.rb

@@ -0,0 +1,58 @@
+module Artk
+class Resource < ActiveRecord::Base
+
+  has_many :components, :foreign_key => "resourceId"
+
+  def self.table_name
+    "Resources"
+  end
+
+  def self.primary_key
+    "resourceId"
+  end
+
+  def self.finding_aids
+    self.where('eadFaUniqueIdentifier != "" and findingAidTitle !=""')
+  end
+
+  # TODO: sanitize params?
+  def self.find_by_ead_id id
+    self.where("eadFaUniqueIdentifier = '#{id}'").first
+  end
+
+  # Returns all Artk::Components that have children components attached to them
+  # and are not just the first level of <c> nodes in the finding aid
+  def all_series
+    first   = retrieve_initial_series
+    second  = []
+    third   = []
+    fourth  = []
+    fifth   = []
+    sixth   = []
+    
+    # Get additional series, second through sixth
+    second  = first.collect { |r| retrieve_additional_series(r) }.flatten unless first.empty?
+    third   = second.collect { |r| retrieve_additional_series(r) }.flatten unless second.empty?
+    fourth  = third.collect { |r| retrieve_additional_series(r) }.flatten unless third.empty?
+    fifth   = fourth.collect { |r| retrieve_additional_series(r) }.flatten unless fourth.empty?
+    sixth   = fifth.collect { |r| retrieve_additional_series(r) }.flatten unless fifth.empty?
+
+    return first + second + third + fourth + fifth + sixth
+  end
+
+  def pid_and_title
+    {self.eadFaUniqueIdentifier => self.findingAidTitle}
+  end
+
+  private
+
+  def retrieve_initial_series
+    self.components.keep_if{ |c| c.has_child? }
+  end
+
+  def retrieve_additional_series component
+    component.sub_components.keep_if{ |c| c.has_child? }
+  end
+
+end
+end

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

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

data/config/initializers/at_connect.rb

@@ -0,0 +1,11 @@
+# sample connection configuration.  Rename to at_connect.rb 
+#
+# We override ActiveRecord to connect to our AT Database
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'mysql2',
+  :encoding => 'utf8',
+  :database => 'atk',
+  :host     => 'localhost',
+  :username => 'root',
+  :password => 'password'
+)

data/config/routes.rb

@@ -0,0 +1,13 @@
+Artk::Engine.routes.draw do
+
+  # /resources
+  # /resources/ARC-0001
+  # /resources/ARC-0001/components
+
+  resources :resources, :only => [:index, :show] do
+    resources :components, :only => [:index]
+  end
+
+  resources :accessions, :only => [:index]
+
+end

data/lib/artk.rb

@@ -0,0 +1,4 @@
+require "artk/engine"
+
+module Artk
+end

data/lib/artk/engine.rb

@@ -0,0 +1,5 @@
+module Artk
+  class Engine < ::Rails::Engine
+    isolate_namespace Artk
+  end
+end

data/lib/artk/version.rb

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

data/lib/tasks/artk_tasks.rake

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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: artk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Wead
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 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: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.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: 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'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: debugger
+  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: Provides a Rails interface to Archivist's Toolkit
+email:
+- amsterdamos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/artk/application.js
+- app/assets/stylesheets/artk/application.css
+- app/controllers/artk/accessions_controller.rb
+- app/controllers/artk/application_controller.rb
+- app/controllers/artk/components_controller.rb
+- app/controllers/artk/resources_controller.rb
+- app/helpers/artk/application_helper.rb
+- app/models/artk/accession.rb
+- app/models/artk/component.rb
+- app/models/artk/resource.rb
+- app/views/layouts/artk/application.html.erb
+- config/initializers/at_connect.rb
+- config/routes.rb
+- lib/artk/engine.rb
+- lib/artk/version.rb
+- lib/artk.rb
+- lib/tasks/artk_tasks.rake
+- LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/awead/artk
+licenses:
+- Apache-2
+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: -2761099062751207607
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2761099062751207607
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides a Rails interface to Archivist's Toolkit
+test_files: []