common_indexer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bf05a42fb84387c676ec66151e7521157a318f57415d212d03e715794bf7179
+  data.tar.gz: 6f6d6a1bd2d3b73fb880d1a4da047c0008428e4f6262d252b9e5fb1342fadac7
+SHA512:
+  metadata.gz: f7900c1a950f4cc0b45b2d93468d4f082f7aa7dc52106a3381d43afac16344eb2c45892e204806d7c062e13819e7c49e8ee2dea59fb063a147017a7b88670541
+  data.tar.gz: 119b0bd45cef5f97c1c249ccd7650cc2f797380668088032f69a4a7d2350d23cd8002ea78bfd9f69525674080ad5da92676ea0ec1fc51170092102efedc85b9b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.5.1
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2
+cache: bundler
+env:
+  global:
+    - environment=test
+script:
+  - 'bundle exec rake'

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in common_indexer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+##########################################################################
+# Copyright 2017 Northwestern University Libraries
+# Additional copyright may be held by others, as reflected in the commit log
+#
+# 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,79 @@
+# CommonIndexer
+[![Build Status](https://travis-ci.com/nulib/common-indexer.svg?branch=master)](https://travis-ci.com/nulib/common-indexer)
+
+Indexes metadata into a central AWS Elasticsearch instance. The gem indexes based on a hash returned by the method `#to_common_index` defined in your model using an `after_save` hook. The indexer also sanitizes the input by only allowing pre-configured hash keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'common_indexer', github: 'nulib/common-indexer', branch: 'master'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install common_indexer
+    
+## Configuration
+
+Add `common_indexer` to the appropriate Rails config file (e.g. `config/settings.yml`, `config/settings/development.yml`):
+
+```yml
+# config/settings/development.yml
+common_indexer:
+  endpoint: http://localhost:9201/ # default 'http://localhost:9200'
+  index_name: new-index # default 'common'
+  allowed_keys: # default ['title']
+    - title
+    - creator
+```
+
+Add an initializer to configure the CommonIndexer gem with the app settings:
+
+```ruby
+# config/initializers/common_indexer_config.rb
+::CommonIndexer.config do |config|
+  config.endpoint = Settings.common_indexer.endpoint
+  config.index_name = Settings.common_indexer.index_name
+  config.allowed_keys = Settings.common_indexer.allowed_keys
+end
+```
+
+## Usage
+
+Include the CommonIndexer into your model that you want to index with `include ::CommonIndexer::Base`, and define a `#to_common_index` method in that model. `#to_common_index` should return a hash with metadata key/values that conform to the allowed keys defined in the local configuration or fall back to the defaults.
+
+```ruby
+class Example < ActiveFedora::Base
+  include ::CommonIndexer::Base
+  
+  property :title,   ::RDF::URI('http://example.org/ns#title')
+  property :creator, ::RDF::URI('http://example.org/ns#creator')
+  
+  def to_common_index
+    { 
+      title: title, 
+      creator: creator
+    }
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/common_indexer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+task :ci do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:spec].invoke
+end
+
+task default: :ci

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'common_indexer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/common_indexer.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'common_indexer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'common_indexer'
+  spec.version       = CommonIndexer::VERSION
+  spec.authors       = ['Michael Klein', 'Brendan Quinn']
+  spec.email         = ['mbklein@gmail.com', 'brendan-quinn@northwestern.edu']
+
+  spec.summary       = 'Common Indexing mixin for NUL Digital Collections'
+  spec.description   = 'Common Indexing mixin for NUL Digital Collections'
+  spec.homepage      = 'https://github.com/nulib/common-indexer'
+  spec.license       = 'Apache2'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'active-fedora'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'typhoeus'
+  spec.add_dependency 'elasticsearch'
+  spec.add_development_dependency 'bixby'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/common_indexer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+require 'elasticsearch'
+require 'common_indexer/version'
+require 'common_indexer/base'
+require 'common_indexer/config'
+
+module CommonIndexer # :nodoc:
+  class Error < StandardError; end
+
+  def self.client
+    @client ||= Elasticsearch::Client.new(hosts: config.endpoint)
+  end
+
+  def self.index_name
+    config.index_name
+  end
+
+  def self.sanitize(input)
+    input.select do |key, _value|
+      config.allowed_keys.include?(key.to_s)
+    end
+  end
+
+  def self.config
+    (@config ||= Config.new).tap { |c| yield c if block_given? }
+  end
+end

data/lib/common_indexer/base.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'active_support/concern'
+
+module CommonIndexer # :nodoc:
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      after_save :update_common_index
+    end
+
+    # Override to_common_index in the including model and return a hash of common index attributes
+    def to_common_index
+      raise CommonIndexer::Error, "Index Error: #{self.class.name} does not implement #to_common_index!"
+    end
+
+    def update_common_index
+      CommonIndexer.client.index index: CommonIndexer.index_name,
+                                 id: id,
+                                 type: self.class.name.underscore,
+                                 body: CommonIndexer.sanitize(to_common_index)
+    end
+  end
+end

data/lib/common_indexer/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CommonIndexer
+  DEFAULT_KEYS       = ['title'].freeze
+  DEFAULT_ENDPOINT   = 'http://localhost:9200/'
+  DEFAULT_INDEX_NAME = 'common'
+
+  Config = Struct.new(:endpoint, :index_name, :allowed_keys) do
+    def initialize(endpoint = DEFAULT_ENDPOINT, index_name = DEFAULT_INDEX_NAME, allowed_keys = DEFAULT_KEYS)
+      super
+    end
+  end
+end

data/lib/common_indexer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CommonIndexer
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: common_indexer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Klein
+- Brendan Quinn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active-fedora
+  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: activesupport
+  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: typhoeus
+  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: elasticsearch
+  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: bixby
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Common Indexing mixin for NUL Digital Collections
+email:
+- mbklein@gmail.com
+- brendan-quinn@northwestern.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- common_indexer.gemspec
+- lib/common_indexer.rb
+- lib/common_indexer/base.rb
+- lib/common_indexer/config.rb
+- lib/common_indexer/version.rb
+homepage: https://github.com/nulib/common-indexer
+licenses:
+- Apache2
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Common Indexing mixin for NUL Digital Collections
+test_files: []