supplejack_api 1

data/db/source_authorities.json

@@ -0,0 +1,119 @@
+[
+    {
+        "name": "Colin McCahon",
+        "prefLabel": "Colin McCahon",
+        "altLabel": [],
+        "dateOfBirth": "1919-12-03T00:00:00",
+        "dateOfDeath": "1987-01-27T00:00:00",
+        "biographicalInformation": "Colin McCahon (12 March 1919 – 25 January 1987), known as Colin McKenzie after 1941, was a New Zealand painter. Along with Colin McCahon and Toss Woollaston, she is credited as one of the leading figures in twentieth century New Zealand art.",
+        "source_id": "tepapa",
+        "source_name": "Te Papa - Museum of New Zealand",
+        "url": "http://collections.tepapa.govt.nz/Person/1502",
+        "sameAs": [
+            "http://en.wikipedia.org/wiki/Colin_McCahon"
+        ],
+        "concept_type": "edm:Agent",
+        "givenName": "Colin",
+        "familyName": "McCahon",
+        "_mn_given_name": "KLN",
+        "_mn_family_name": "MKHN",
+        "birthYear": 1919,
+        "deathYear": 1987,
+        "internal_identifier": "tepapa:1502",
+        "concept_id": 1,
+        "concept_score": 50
+    },
+    {
+        "name": "Colin McCahon",
+        "prefLabel": "Colin McCahon",
+        "altLabel": [],
+        "dateOfBirth": "1919-12-03T00:00:00",
+        "dateOfDeath": "1987-01-27T00:00:00",
+        "biographicalInformation": "",
+        "source_id": "aklart",
+        "source_name": "Auckland Art Gallery",
+        "url": "http://www.aucklandartgallery.com/the-collection/browse-artists/461",
+        "sameAs": [],
+        "concept_type": "edm:Agent",
+        "givenName": "Colin",
+        "familyName": "McCahon",
+        "_mn_given_name": "KLN",
+        "_mn_family_name": "MKHN",
+        "birthYear": 1919,
+        "deathYear": 1987,
+        "internal_identifier": "aklart:867",
+        "concept_id": 1,
+        "concept_score": 50
+    },
+    {
+        "name": "Colin McCahon",
+        "prefLabel": "Colin McCahon",
+        "altLabel": [],
+        "dateOfBirth": "1919-12-03T00:00:00",
+        "dateOfDeath": "1987-01-27T00:00:00",
+        "biographicalInformation": "",
+        "source_id": "teara:5m4",
+        "source_name": "Te Ara",
+        "url": "http://www.teara.govt.nz/en/biographies/5m4/mccahon-colin-john",
+        "sameAs": [],
+        "concept_type": "edm:Agent",
+        "givenName": "Colin",
+        "familyName": "McCahon",
+        "_mn_given_name": "KLN",
+        "_mn_family_name": "MKHN",
+        "birthYear": 1919,
+        "deathYear": 1987,
+        "internal_identifier": "teara:5m4",
+        "concept_id": 1,
+        "concept_score": 50
+    },
+    {
+        "name": "Rita Angus",
+        "prefLabel": "Rita Angus",
+        "altLabel": [
+            "Henrietta Catherine Angus",
+            "Rita McKenzie"
+        ],
+        "dateOfBirth": "1908-12-03T00:00:00",
+        "dateOfDeath": "1970-01-27T00:00:00",
+        "biographicalInformation": "Rita Angus (12 March 1908 – 25 January 1970), known as Rita McKenzie after 1941, was a New Zealand painter. Along with Colin McCahon and Toss Woollaston, she is credited as one of the leading figures in twentieth century New Zealand art.",
+        "source_id": "tepapa",
+        "source_name": "Te Papa - Museum of New Zealand",
+        "url": "http://collections.tepapa.govt.nz/Person/74",
+        "sameAs": [
+            "http://en.wikipedia.org/wiki/Rita_Angus"
+        ],
+        "concept_type": "edm:Agent",
+        "givenName": "Rita",
+        "familyName": "Angus",
+        "_mn_given_name": "RT",
+        "_mn_family_name": "ANKS",
+        "birthYear": 1908,
+        "deathYear": 1970,
+        "internal_identifier": "tepapa:74",
+        "concept_id": 2,
+        "concept_score": 50
+    },
+    {
+        "name": "Rita Angus",
+        "prefLabel": "Rita Angus",
+        "altLabel": [],
+        "dateOfBirth": "1908-12-03T00:00:00",
+        "dateOfDeath": "1970-01-27T00:00:00",
+        "biographicalInformation": "Rita Angus (12 March 1908 – 25 January 1970), known as Rita McKenzie after 1941, was a New Zealand painter. Along with Colin McCahon and Toss Woollaston, she is credited as one of the leading figures in twentieth century New Zealand art.",
+        "source_id": "aklart",
+        "source_name": "Auckland Art Gallery",
+        "url": "http://www.aucklandartgallery.com/the-collection/browse-artists/461",
+        "sameAs": [],
+        "concept_type": "edm:Agent",
+        "givenName": "Rita",
+        "familyName": "Angus",
+        "_mn_given_name": "RT",
+        "_mn_family_name": "ANKS",
+        "birthYear": 1908,
+        "deathYear": 1970,
+        "internal_identifier": "aklart:461",
+        "concept_id": 2,
+        "concept_score": 50
+    }
+]

data/lib/generators/supplejack_api/install_generator.rb

@@ -0,0 +1,124 @@
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'rails/generators'
+
+module SupplejackApi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Used to install SupplejackApi'
+      class_option :documentation, type: :boolean, default: true, desc: 'Displays documentation after installation'
+
+      source_root(File.expand_path('../../../../spec/dummy/', __FILE__))
+
+      def config_files
+        puts "\nInstalling config files into config/"
+
+        copy_file('config/application.yml.example', 'config/application.yml')
+        copy_file 'config/mongoid.yml'
+        copy_file 'config/resque-pool.yml'
+        copy_file 'config/resque_schedule.yml'
+        copy_file 'config/sunspot.yml'
+
+        puts "\nGenerating secret token"
+
+        inject_into_file('config/application.yml', before: /^\sdevelopment:/) do
+          "  SECRET_TOKEN: '#{Digest::SHA1.hexdigest([Time.now, rand].join)}'\n"
+        end
+      end
+
+      def workers
+        directory 'app/workers'
+      end
+
+      def initializers
+        puts "\nInstalling initializers into config/initializers/"
+
+        copy_file 'config/initializers/devise.rb'
+        copy_file 'config/initializers/kaminari_config.rb'
+        copy_file 'config/initializers/quiet_logger.rb'
+        copy_file 'config/initializers/resque.rb'
+        copy_file 'config/initializers/simple_form.rb'
+        copy_file 'config/initializers/simple_form_foundation.rb'
+        copy_file 'config/initializers/state_machine.rb'
+        copy_file 'config/initializers/sunspot.rb'
+        copy_file 'config/initializers/mongoid.rb'
+
+        directory 'config/locales'
+      end
+
+      def environment_files
+        puts "\nInstalling environment files into config/environments/"
+
+        copy_file 'config/environments/production.rb'
+        gsub_file('config/environments/production.rb', 'Dummy::Application', Rails.application.class.to_s)
+      end
+
+      def solr_config_files
+        puts "\nInstalling Solr config files into solr/"
+        directory 'solr'
+      end
+
+      def mount_engine
+        puts "\nMounting SupplejackApi::Engine at / in config/routes.rb"
+
+        inject_into_file('config/routes.rb', "\n  mount SupplejackApi::Engine => '/', as: 'supplejack_api'\n\n", :before => /^end/)
+      end
+
+      def update_gemfile
+        puts "\nAdding dependencies into Gemfile"
+
+        inject_into_file('Gemfile', after: /^gem.*supplejack_api.*/) do
+          string = [""]
+          string << "gem 'sunspot_rails', '~> 2.2.0'"
+          string << "gem 'active_model_serializers', git: 'https://github.com/boost/active_model_serializers.git'"
+          string << "gem 'mongoid_auto_inc', git: 'https://github.com/boost/mongoid_auto_inc.git'"
+
+          string.join("\n")
+        end
+      end
+
+      def create_schema
+        puts "\nCreating Schemas in app/supplejack_api/"
+
+        empty_directory 'app/supplejack_api'
+        copy_file 'app/supplejack_api/record_schema.txt', 'app/supplejack_api/record_schema.rb'
+        copy_file 'app/supplejack_api/concept_schema.rb'
+      end
+
+      def add_assets
+        insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highcharts\n", :after => "jquery_ujs\n"
+        insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highcharts-more\n", :after => "jquery_ujs\n"
+        insert_into_file "app/assets/javascripts/application.js", "//= require highcharts/highstock\n", :after => "jquery_ujs\n"
+        insert_into_file "app/assets/stylesheets/application.css", "\n *= require supplejack_api/application", :after => "require_self"
+      end
+
+      def documentation
+        if options.documentation?
+          string = []
+          string << 'Welcome to Supplejack API.'
+          string << "Installation process is complete.\n"
+          string << 'In order to have have a working API, follow the steps below:'
+          string << '1. Implement your data schema in app/supplejack_api/schema.rb. See comments for DSL documentation'
+          string << '2. Edit config/application.yml and set all the keys to the correct values for your environments'
+          string << "3. Start Solr via via `bundle exec rake sunspot:solr:start|stop`. Ensure it's working by going to http://localhost:8983/solr/, you should see the Solr dashboard"
+          string << "4. Start the rails console via `bundle exec rails console`. Perform the next commands in the rails console"
+          string << "5. Use a local Solr session so updates are immediate via `Sunspot.session = Sunspot::Rails.build_session`"
+          string << "6. Create a user via `user = SupplejackApi::User.create(email: 'test@example.com', name: 'Test User')`"
+          string << "7. Create a record via `record = SupplejackApi::Record.create(internal_identifier: 'abc123', status: 'active', source_url: 'http://boost.co.nz/')`"
+          string << "8. Add your custom data (from schema.rb) to the record's primary fragment via `record.primary_fragment.<field_name>=<value>`. Then `record.save!`"
+          string << "9. Start the rails server via `bundle exec rails server -p 3000`"
+          string << "10. Retrieve a specific record by going to http://localhost:3000/records/<record.record_id>.json?api_key=<user.api_key>"
+          string << "11. Perform a search by going to http://localhost:3000/records.json?api_key=<user.api_key>"
+          string << "12. You now have a working API!"
+
+          puts string.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/paperclip.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+#
+# Save this into your `lib/mongoid/paperclip.rb` file
+#
+#
+require 'paperclip'
+
+module Paperclip
+  class << self
+    def logger
+      Rails.logger
+    end
+  end
+end
+
+##
+# the id of mongoid is not integer, correct the id_partitioin.
+Paperclip.interpolates :id_partition do |attachment, _style|
+  attachment.instance.id.to_s.scan(/.{4}/).join('/')
+end
+
+module Mongoid
+  module Paperclip
+    def self.included(base)
+      base.instance_eval do
+        include ::Paperclip
+        include ::Paperclip::Glue
+
+        alias :__mongoid_has_attached_file :has_attached_file
+
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def has_attached_file(field, options = {})
+        field(:"#{field}_file_name",    type: String)
+        field(:"#{field}_content_type", type: String)
+        field(:"#{field}_file_size",    type: Integer)
+        field(:"#{field}_updated_at",   type: DateTime)
+
+        __mongoid_has_attached_file(field, options)
+      end
+    end
+  end
+end

data/lib/mongoid/string.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+# method String#to_a was removed in Mongoid 4
+# reference: https://github.com/mongoid/mongoid/commit/db84c0972bf4f01019cdfc2e9ab647fb814d3224
+
+module Mongoid
+  module Extensions
+    module String
+      def to_a
+        [self]
+      end
+    end
+  end
+end

data/lib/sunspot/mongoid.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+require 'sunspot'
+require 'mongoid'
+require 'sunspot/rails'
+
+# == Examples:
+#
+# class Post
+#   include Mongoid::Document
+#   field :title
+#
+#   include Sunspot::Mongoid
+#   searchable do
+#     text :title
+#   end
+# end
+#
+module Sunspot
+  module Mongoid
+    def self.included(base)
+      base.class_eval do
+        extend Sunspot::Rails::Searchable::ActsAsMethods
+        Sunspot::Adapters::DataAccessor.register(DataAccessor, base)
+        Sunspot::Adapters::InstanceAdapter.register(InstanceAdapter, base)
+      end
+    end
+
+    class InstanceAdapter < Sunspot::Adapters::InstanceAdapter
+      def id
+        @instance.id
+      end
+    end
+
+    class DataAccessor < Sunspot::Adapters::DataAccessor
+      def load(id)
+        @clazz.where(id: id).first
+      end
+
+      def load_all(ids)
+        @clazz.where(:id.in => ids)
+      end
+    end
+  end
+end

data/lib/sunspot/resque_session_proxy.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# This was authored by HeyZap (http://www.heyzap.com/) and is available at http://stdout.heyzap.com/2011/08/17/sunspot-resque-session-proxy/
+
+module Sunspot
+  class ResqueSessionProxy < Sunspot::SessionProxy::AbstractSessionProxy
+    attr_reader :original_session, :batch_size
+
+    delegate :config, :delete_dirty?, :dirty?,
+             :new_search, :search,
+             :new_more_like_this, :more_like_this,
+             :batch, to: :session
+
+    def initialize(session, batch_size = 1000)
+      @original_session = session
+      @batch_size = batch_size
+    end
+
+    alias session original_session
+
+    [:index, :index!, :remove, :remove!].each do |method|
+      define_method(method) do |*objects|
+        @buffer = SupplejackApi::IndexBuffer.new
+        method = method.to_s.delete('!').to_sym
+
+        start = 0
+        objects = objects.flatten.compact
+        object_ids = objects.map { |o| o.id.to_s }.compact
+        total_ids = object_ids + @buffer.pop_record_ids(method)
+
+        if total_ids.size < 100
+          @buffer.send("#{method}_record_ids=", total_ids)
+        else
+          batch_object_ids = total_ids[start..(batch_size - 1)]
+          class_name = objects.first.class.name
+
+          while batch_object_ids do
+            index_worker_args = { class: class_name, id: batch_object_ids }
+            Resque.enqueue(SupplejackApi::IndexWorker, method, index_worker_args) if batch_object_ids.try(:any?)
+            start += batch_size
+            batch_object_ids = total_ids[start..(start + batch_size - 1)]
+          end
+        end
+      end
+    end
+
+    [:remove_by_id, :remove_by_id!].each do |method|
+      define_method(method) do |clazz, id|
+        Resque.enqueue(SupplejackApi::IndexWorker, method, class: clazz, id: id.to_s)
+      end
+    end
+
+    def remove_all(clazz = nil)
+      Resque.enqueue SupplejackApi::IndexWorker, :remove_all, clazz.to_s
+    end
+
+    def remove_all!(clazz = nil)
+      Resque.enqueue SupplejackApi::IndexWorker, :remove_all, clazz.to_s
+    end
+
+    def commit(_soft_commit = false)
+      Resque.enqueue(SupplejackApi::IndexWorker, :commit)
+    end
+
+    def commit_if_dirty(soft_commit = false)
+      # no-op
+    end
+
+    def commit_if_delete_dirty(soft_commit = false)
+      # no-op
+    end
+  end
+end

data/lib/sunspot/sunspot_spellcheck.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module Sunspot
+  module Query
+    class Spellcheck < Connective::Conjunction
+      attr_accessor :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def to_params
+        options = {}
+        @options.each do |key, val|
+          options['spellcheck.' + Sunspot::Util.method_case(key)] = val
+        end
+        { spellcheck: true }.merge(options)
+      end
+    end
+  end
+end
+
+module Sunspot
+  module Query
+    class CommonQuery
+      def spellcheck(options = {})
+        @components << Spellcheck.new(options)
+      end
+    end
+  end
+end
+
+module Sunspot
+  module Search
+    class AbstractSearch
+      attr_accessor :solr_result
+
+      def raw_suggestions
+        %w(spellcheck suggestions).inject(@solr_result) { |h, k| h && h[k] }
+      end
+
+      def suggestions
+        suggestions = %w(spellcheck suggestions).inject(@solr_result) { |h, k| h && h[k] }
+        return nil unless suggestions.is_a?(Array)
+
+        suggestions_hash = {}
+        index = -1
+        suggestions.each do |sug|
+          index += 1
+          next unless sug.is_a?(String)
+          break unless suggestions.count > index + 1
+          suggestions_hash[sug] = suggestions[index + 1].try(:[], 'suggestion') || suggestions[index + 1]
+        end
+        suggestions_hash
+      end
+
+      def all_suggestions
+        suggestions.inject([]) { |all, current| all += current }
+      end
+
+      def collation
+        suggestions.try(:[], 'collation')
+      end
+    end
+  end
+end
+
+module Sunspot
+  module DSL
+    class StandardQuery
+      def spellcheck(options = {})
+        @query.spellcheck(options)
+      end
+    end
+  end
+end
+
+module Sunspot
+  module Util
+    class<<self
+      def method_case(string_or_symbol)
+        string = string_or_symbol.to_s
+        first = true
+        string.split('_').map! do |word|
+          word = first ? word : word.capitalize
+          first = false
+          word
+        end.join
+      end
+    end
+  end
+end