oai_repository 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Intersect Australia Ltd.
+
+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,5 @@
+= OAI Repository
+
+A Rails (3.1+) engine that allows you to expose your models through an OAI-PHM Data Provider interface.
+
+See http://www.oaforum.org/tutorial/ and http://www.openarchives.org/OAI/openarchivesprotocol.html#Repository

data/Rakefile

@@ -0,0 +1,29 @@
+#!/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    = 'OaiRepository'
+  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
+

data/app/assets/javascripts/oai_repository/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/javascripts/oai_repository/services.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/oai_repository/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/assets/stylesheets/oai_repository/services.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/oai_repository/application_controller.rb

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

data/app/controllers/oai_repository/services_controller.rb

@@ -0,0 +1,18 @@
+module OaiRepository
+  class ServicesController < ApplicationController
+    require 'oai_provider'
+
+    def show
+
+      options = params.delete_if { |k,v| %w{controller action}.include?(k) }
+      response = get_provider.process_request(options)
+      render :xml => response
+      
+    end
+
+    def get_provider
+      @provider ||= OAIProvider::provider.new
+    end
+
+  end
+end

data/app/helpers/oai_repository/application_helper.rb

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

data/app/helpers/oai_repository/services_helper.rb

@@ -0,0 +1,4 @@
+module OaiRepository
+  module ServicesHelper
+  end
+end

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

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

data/app/views/oai_repository/services/show.html.erb

@@ -0,0 +1,2 @@
+<h1>Services#show</h1>
+<p>Find me in app/views/oai_repository/services/show.html.erb</p>

data/config/routes.rb

@@ -0,0 +1,7 @@
+OaiRepository::Engine.routes.draw do
+
+  get "services/show"
+
+  root :to => "services#show"
+
+end

data/lib/ar_wrapper_model.rb

@@ -0,0 +1,156 @@
+include OAI::Provider
+class ARWrapperModel < OAI::Provider::Model
+
+  def initialize(options={})
+    @timestamp_field = options.delete(:timestamp_field) || 'updated_at'
+    @limit = options.delete(:limit)
+    @sets_map = options.delete(:sets)
+    @oai_dc_mapping = {}
+
+    unless options.empty?
+      raise ArgumentError.new(
+        "Unsupported options [#{options.keys.join(', ')}]"
+      )
+    end
+
+  end
+
+  def map_oai_dc
+    if @oai_dc_mapping.empty?
+      dc = OAI::Provider::Metadata::DublinCore.instance
+      dc.fields.map do |field|
+        @oai_dc_mapping[field.to_sym] = "oai_dc_#{field}".to_sym
+      end
+    end
+    @oai_dc_mapping
+  end
+
+  def sets
+    @sets_map.map {|set_obj|
+      OAI::Set.new(
+        {
+          name: set_obj[:name],
+          spec: set_obj[:spec],
+          description: set_obj[:description]
+        }
+      )
+    }
+  end
+
+  def earliest
+    record_end(:asc)
+  end
+
+  def latest
+    record_end(:desc)
+  end
+
+  # selector can be id or :all
+  def find(selector, options={})
+    token = nil
+    if options[:resumption_token]
+      raise OAI::ResumptionTokenException.new unless @limit
+      token = ResumptionToken.parse(options[:resumption_token])
+    end
+
+    from   = token ? token.from   : options[:from]
+    to     = token ? token.until  : options[:until]
+    last   = token ? token.last   : 0
+    prefix = token ? token.prefix : options[:metadata_prefix]
+    set    = token ? token.set    : options[:set]
+
+    conditions = sql_conditions(:from => from, :until => to)
+    record_rows = get_record_rows(get_models(set), conditions)
+
+    return get_specific_record(record_rows, selector) if selector != :all
+
+    if @limit and record_rows.size > @limit
+      get_paged_records(record_rows, :from => from, :until => to, :set => set, :last => last, :metadata_prefix => prefix)
+    else
+      get_record_objects(record_rows)
+    end
+  end
+
+  private
+
+  def get_specific_record(records, id)
+    # TODO: optimise somehow
+    # This is terribly intensive :-(
+    records.each do |record|
+      obj = Object.const_get(record["type"]).find(record["id"])
+      return obj if obj.oai_dc_identifier.eql?(id)
+    end
+    raise OAI::IdException.new
+  end
+
+  def get_paged_records(record_rows, options)
+
+    if record_rows.size < options[:last]
+      raise OAI::ResumptionTokenException.new
+    end
+
+    list = get_record_objects(record_rows[options[:last], @limit])
+
+    if list.size < @limit
+      list
+    else
+      options[:last] += @limit
+      PartialResult.new(list, ResumptionToken.new(options))
+    end
+  end
+
+  def sql_conditions(opts)
+    from = Time.parse(opts[:from].to_s).localtime
+    to   = Time.parse(opts[:until].to_s).localtime.to_s
+    return "#{timestamp_field} >= #{ActiveRecord::Base.sanitize(from)} AND #{timestamp_field} <= #{ActiveRecord::Base.sanitize(to)}"
+  end
+
+  def get_models(set)
+    models =
+      if set.nil?
+        @sets_map.map{|s| s[:model]}
+      else
+        @sets_map.select{|s| s[:spec] == set}.map{|s| s[:model]}
+      end
+
+    if models.empty?
+      raise OAI::NoMatchException.new
+    end
+    models
+  end
+
+  def get_record_rows(models, conditions)
+    record_sql = models.map do |m|
+      "select id, '#{m.name}' as type, #{timestamp_field} from #{m.table_name} where #{conditions}"
+    end.join(" UNION ")
+
+    sorted_list_sql = "select t.id as id, t.type as type, t.updated_at as updated_at from (#{record_sql}) t order by t.updated_at desc"
+    records = ActiveRecord::Base.connection.execute(sorted_list_sql).to_a
+  end
+
+  def get_record_objects(records)
+    records.map do |record|
+      Object.const_get(record["type"]).find(record["id"])
+    end
+  end
+
+  def record_end(order)
+    record = nil
+    @sets_map.each do |s|
+      r = s[:model].first(:order => "#{@timestamp_field} #{order.to_s}")
+      next if r.nil?
+
+      if record.nil?
+        record = r
+      elsif order == :asc and r.send(@timestamp_field) < record.send(@timestamp_field)
+        record = r
+      elsif order == :desc and r.send(@timestamp_field) > record.send(@timestamp_field)
+        record = r
+      end
+    end
+    raise OAI::NoMatchException if record.nil?
+    record.send(@timestamp_field)
+  end
+
+end
+

data/lib/generators/oai_repository/install_generator.rb

@@ -0,0 +1,12 @@
+module OaiRepository
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates an OAI Repository initializer."
+      def copy_initializer
+        template "oai_repository.rb", "config/initializers/oai_repository.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/oai_repository.rb

@@ -0,0 +1,45 @@
+require 'rifcs_format'
+OaiRepository.setup do |config|
+
+  config.repository_name = 'NAME YOUR REPOSITORY'
+
+  # The URL from which this OAI Repository is served.
+  # If you're deploying to different hostnames (e.g. development, QA and
+  # production environments, each with different hostnames), you could
+  # conditionally set this.
+  config.repository_url = 'URL OF THE REPOSITORY'
+
+  # By default the (unique) identifier of each record will be composed as
+  # #{record_prefix}/#{record.id}
+  # This is probably not want you want, especially if you have multiple record
+  # sets (i.e. this provider serves multiple ActiveRecord models)
+  #
+  # Most probably you'll create an oai_dc_identifier attribute or method in
+  # the AR models you intend to serve. That value will supplant the default.
+  config.record_prefix = 'http://localhost:3000/'
+
+  config.admin_email = 'change_me@example.com'
+
+  # Map the name of the set to the ActiveRecord (or other) class name that
+  # will provide (at a minimum) the required oai_dc attributes/methods.
+  # E.g.
+  # config.sets = [
+  #   {
+  #     spec: 'class:party',
+  #     name: 'Parties',
+  #     model: Person
+  #   },
+  #   {
+  #     spec: 'class:service',
+  #     name: 'Services',
+  #     description: 'Things that are services',
+  #     model: Instrument
+  #   }
+  # ]
+  config.sets = []
+
+  config.additional_formats = [
+    OAI::Provider::Metadata::RIFCS
+  ]
+
+end

data/lib/oai_provider.rb

@@ -0,0 +1,34 @@
+require 'oai'
+require 'patched_record_response'
+require 'ar_wrapper_model'
+module OAIProvider
+
+  @@provider = nil
+
+  def self.provider
+    @@provider ||= build_set_provider 
+  end
+
+  private
+
+  def self.build_set_provider
+
+    provider_name = "ARProvider"
+    provider_class = Object.const_set(provider_name, Class.new(OAI::Provider::Base))
+    provider_class.repository_name OaiRepository.repository_name
+    provider_class.repository_url OaiRepository.repository_url
+    provider_class.record_prefix OaiRepository.record_prefix
+    provider_class.admin_email OaiRepository.admin_email
+    provider_class.source_model ARWrapperModel.new(
+      sets: OaiRepository.sets,
+      limit: OaiRepository.limit,
+      timestamp_field: OaiRepository.timestamp_field
+    )
+    OaiRepository.additional_formats.each do |format|
+      provider_class.register_format(format.instance)
+    end
+    provider_class
+
+  end
+
+end

data/lib/oai_repository/engine.rb

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

data/lib/oai_repository/version.rb

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

data/lib/oai_repository.rb

@@ -0,0 +1,33 @@
+require "oai_repository/engine"
+
+module OaiRepository
+
+  def self.setup
+    yield self
+  end
+
+  mattr_accessor :repository_name
+  @@repository_name = 'Unspecified'
+
+  mattr_accessor :repository_url
+  @@repository_url = nil
+
+  mattr_accessor :record_prefix
+  @@record_prefix = 'PREFIX'
+
+  mattr_accessor :admin_email
+  @@admin_email = 'root@localhost'
+
+  mattr_accessor :sets
+  @@sets = {}
+
+  mattr_accessor :additional_formats
+  @@formats = []
+  ##OAI::Provider::Metadata::RIFCS.instance
+
+  mattr_accessor :limit
+  @@limit = 100
+
+  mattr_accessor :timestamp_field
+  @@timestamp_field = 'updated_at'
+end

data/lib/patched_record_response.rb

@@ -0,0 +1,16 @@
+module OAI::Provider::Response
+  class RecordResponse < Base
+
+  private
+
+    def identifier_for(record)
+      if record.respond_to?(:oai_dc_identifier)
+        record.oai_dc_identifier
+      else
+        "#{provider.prefix}/#{record.id}"
+      end
+    end
+
+  end
+
+end

data/lib/rifcs_format.rb

@@ -0,0 +1,22 @@
+require 'oai'
+module OAI::Provider::Metadata
+
+  class RIFCS < Format
+    def initialize
+      @prefix = 'rif'
+      @schema = 'http://services.ands.org.au/documentation/rifcs/1.3/schema/registryObjects.xsd'
+      @namespace = 'http://ands.org.au/standards/rif-cs/registryObjects'
+      @element_namespace = 'rif-cs'
+    end
+
+    def header_specification
+      {
+        'xmlns' => "http://ands.org.au/standards/rif-cs/registryObjects" ,
+        'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance" ,
+        'xsi:schemaLocation' => "http://ands.org.au/standards/rif-cs/registryObjects http://services.ands.org.au/documentation/rifcs/1.3/schema/registryObjects.xsd"
+      }
+    end
+
+  end
+
+end

data/lib/tasks/oai_repository_tasks.rake

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

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: oai_repository
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean McCarthy
+- Diego Alonso de Marcos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &77154580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77154580
+- !ruby/object:Gem::Dependency
+  name: oai
+  requirement: &77154060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *77154060
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &77153150 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77153150
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &77202670 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77202670
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &77200990 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *77200990
+description: An Engine for Rails (3.1+) that allows you to make your application an
+  OAI-PMH Data Provider. See http://www.openarchives.org/pmh/ and http://www.openarchives.org/OAI/openarchivesprotocol.html#Repository
+email:
+- sean@intersect.org.au
+- diego@intersect.org.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/oai_repository/application_controller.rb
+- app/controllers/oai_repository/services_controller.rb
+- app/assets/stylesheets/oai_repository/services.css
+- app/assets/stylesheets/oai_repository/application.css
+- app/assets/javascripts/oai_repository/application.js
+- app/assets/javascripts/oai_repository/services.js
+- app/helpers/oai_repository/services_helper.rb
+- app/helpers/oai_repository/application_helper.rb
+- app/views/oai_repository/services/show.html.erb
+- app/views/layouts/oai_repository/application.html.erb
+- config/routes.rb
+- lib/patched_record_response.rb
+- lib/rifcs_format.rb
+- lib/oai_repository.rb
+- lib/oai_repository/engine.rb
+- lib/oai_repository/version.rb
+- lib/tasks/oai_repository_tasks.rake
+- lib/oai_provider.rb
+- lib/generators/oai_repository/install_generator.rb
+- lib/generators/templates/oai_repository.rb
+- lib/ar_wrapper_model.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/IntersectAustralia/oai_repository
+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: -625295055
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -625295055
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Rails (3.1+) Engine to provide an OAI repository
+test_files: []