quick_search-contentdm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b2c4541c32202ee5b4a3fec7ace453100b1dcc0
+  data.tar.gz: 0bcfff752a0859359db6a326f060c076020f956c
+SHA512:
+  metadata.gz: 2337c25a7f3b4aeb8b815699a844a5806d27c41e5d4b1306f33a2783ba09442860bc93223b1d2e9cf6df13632ba20fe1bbf634f12cfa4620a93e2d8a29873828
+  data.tar.gz: e2575d4a3faa49c5e8278975051cbc131b5c84d966dbc1e310315005c2a975a5e293a1a98875ef9739789eee9b0b1c882d6254dc38f5995df8ea52176eb26e38

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Chad Nelson
+
+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.md

@@ -0,0 +1,66 @@
+# Quick Search Contentdm Plugin
+A plugin for [Quick Search](http://www.lib.ncsu.edu/reports/quicksearch) that allows you to search a ContentDM. The ContentDM instance's API must be publicly available.
+
+## Usage
+Add the gem to your quick search application's `Gemfile` a then follow the instructions outlined in the Quick Search [Configuring Searchers](https://github.com/NCSU-Libraries/quick_search/blob/master/docs/configuration.md#configuring-searchers) docs.
+
+### Configuration options
+This plugin provides a few configuration points.
+
+`api_url`: _Required_ Base URL to your contentDM backend server where your ContentDM Api is publicly available.
+
+`records_url`: _Required_ Base URL to your public facing ContentDM site.
+
+`custom_sort`: _Optional_ Field you want records sorted by. Defaults to 'relevance'
+
+`collections`: _Optional_ A list of collectinos you would lke the search limited to. By default it searches all colelctions except unpublished colelctions.
+
+_Example Config_
+```yaml
+defaults: &defaults
+  api_url: "http://backend.contentdm.org"
+  records_url: "http://frontend.contentdm.org"
+  sort: title
+  collections:
+    - collection1
+    - collection2
+    - collections3
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+
+
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quick_search-contentdm'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install quick_search-contentdm
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuickSearchContentdm'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_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

data/app/searchers/quick_search/contentdm_searcher.rb

@@ -0,0 +1,91 @@
+module QuickSearch
+  class ContentdmSearcher < QuickSearch::Searcher
+
+    def search
+      url = base_url + parameters.to_query
+			Rails.logger.info "ContenDM query url: #{url}"
+      raw_response = @http.get(url)
+      @response = JSON.parse(raw_response.body)
+    end
+
+    def results
+      if results_list
+        results_list
+      else
+        @results_list = []
+        @response['records'].each do |record|
+          result = OpenStruct.new
+
+          result.title = title(record)
+          result.link = link(record)
+          result.description = description(record)
+					result.thumbnail = thumbnail(record)
+
+
+          @results_list << result
+        end
+        @results_list
+      end
+    end
+
+
+    private
+
+    def base_url
+      config['api_url'] + "/dmwebservices/index.php?"
+    end
+
+    def parameters
+      {
+          'q' => "dmQuery/#{collections_to_search}/CISOSEARCHALL^#{http_request_queries['not_escaped']}^all^and/" + 
+					"title!descri/#{sort}/#{@per_page}/#{@offset}/1/0/0/0/0/0/json",
+      }
+    end
+
+    def title(record)
+      record['title']
+
+    end
+
+    def link(record)
+      "#{config['records_url']}/cdm/#{object_type(record)}/collection#{record['collection']}/id/#{record['pointer']}"
+
+    end
+
+    def description(record)
+      record['description']
+    end
+
+    def object_type(record)
+      if record['filetype'] == 'cpd'
+        'compoundobject'
+      else
+        'singleitem'
+      end
+    end
+
+    def thumbnail(record)
+      "#{config['records_url']}/utils/getthumbnail/collection#{record['collection']}/id/#{record['pointer']}"
+    end		
+
+		def sort
+			if config.has_key? 'custom_sort'
+				"#{config['custom_sort']}"
+			else 
+				"nosort"
+			end
+		end
+
+	  def collections_to_search
+		  if config.has_key? 'collections'
+			  config['collections'].join('!')
+			else
+				'all'
+			end
+		end
+
+		def config
+			QuickSearch::Engine::CONTENTDM_CONFIG
+		end
+  end
+end

data/config/contentdm_config.yml

@@ -0,0 +1,16 @@
+defaults: &defaults
+  api_url: "http://backend.contentdm.org"
+  records_url: "http://frontend.contentdm.org"
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+

data/config/initializers/contentdm_searcher_config.rb

@@ -0,0 +1,9 @@
+#Try to load a local version of the config file if it exists - expected to be in quicksearch_root/config/searchers/contentdm_config.yml
+
+if File.exists?(File.join(Rails.root, "/config/searchers/contentdm_config.yml"))
+  config_file = File.join Rails.root, "/config/searchers/contentdm_config.yml"
+else
+  # otherwise load the default config file
+  config_file = File.expand_path("../../contentdm_config.yml", __FILE__)
+end
+QuickSearch::Engine::CONTENTDM_CONFIG = YAML.load_file(config_file)[Rails.env]

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  contentdm_search:
+    display_name: "Temple Digital Collections"
+    short_display_name: "Digital Collections"
+    see_all_message: "Find more Temple Digital Collections"
+    search_form_placeholder: "Search for collections"
+    module_callout: "Search for collections"
+    error_service_message: "searching Temple Digital Collections"
+    no_results_service_message: "a different search for digital collections"
+

data/config/routes.rb

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

data/lib/quick_search-contentdm.rb

@@ -0,0 +1,5 @@
+require "quick_search-contentdm/engine"
+
+module QuickSearchContentdm
+  # Your code goes here...
+end

data/lib/quick_search-contentdm/engine.rb

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

data/lib/quick_search-contentdm/version.rb

@@ -0,0 +1,3 @@
+module QuickSearchContentdm
+  VERSION = '0.1.0'
+end

data/lib/tasks/quick_search_contentdm_tasks.rake

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

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: quick_search-contentdm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chad Nelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: quick_search-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin for NCSU Quicksearch to search contentDM
+email:
+- chad.nelson@temple.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/searchers/quick_search/contentdm_searcher.rb
+- config/contentdm_config.yml
+- config/initializers/contentdm_searcher_config.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/quick_search-contentdm.rb
+- lib/quick_search-contentdm/engine.rb
+- lib/quick_search-contentdm/version.rb
+- lib/tasks/quick_search_contentdm_tasks.rake
+homepage: https://github.com/tulibraries/quick_search-contentdm
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Plugin for NCSU Quicksearch to search contentDM
+test_files: []