qa-ldf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a949f884516d5b051b47a5b14d23c67043a0d3d3
+  data.tar.gz: 50ca4ecf8a10304ac8a2afa38afd38264c537ebe
+SHA512:
+  metadata.gz: 5ef5befc68d69cf514995bdacaea034fdbb1c03b0c4effe9898f91cd57547ae26585414b40bc158171ae7bb3850ca06c42b5157dac15bd581b2ff106e5e59c22
+  data.tar.gz: 5a1d78db92bfc2de9d80b60292cb5dc0c1d3cc72bc210885529bcd56510ec6a455079e3a9d97df5538056d12cd6844a3d40245bba54bb4acabb10b05073a831e

data/.gitignore

@@ -0,0 +1,15 @@
+# Ignore bundler config.
+/.bundle
+
+*~
+*#
+
+.yardoc
+/doc
+
+/log/*.log
+/tmp
+Gemfile.lock
+coverage
+pkg
+*.gem

data/.rubocop.yml

@@ -0,0 +1,21 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+
+Metric/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/qa/ldf/spec/**/*'
+
+# we accept `expect(subject).to receive`
+RSpec/MessageSpies:
+  Enabled: false
+
+# we accept specs in fakes, mocks, &c...
+RSpec/FilePath:
+  Exclude:
+    - 'spec/contracts/**/*'
+    - 'spec/support/**/*'
+    - 'spec/qa/ldf/authorities/**/*'
+    - 'spec/qa/ldf/models/**/*'

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+sudo: false
+
+cache:
+  bundler: true
+
+rvm:
+  - 2.3.3
+  - 2.4.0
+
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+    - "RAILS_VERSION=5.0.0.1"

data/.yardopts

@@ -0,0 +1,9 @@
+--title "Qa::LDF - Linked Data Caching for QuestioningAuthority"
+--protected
+--no-private
+--hide-void-return
+--markup markdown
+--readme README.md
+-
+LICENSE
+VERSION

data/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# How to Contribute
+
+__We want your help to make Project Hydra great.__
+
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+## Hydra Project Intellectual Property Licensing and Ownership
+
+All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
+If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
+
+https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
+
+## Contribution Tasks
+
+* Reporting Issues
+* Making Changes
+* Submitting Changes
+* Merging Changes
+
+### Reporting Issues
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a [Github issue](./issues) by:
+  * Clearly describing the issue
+    * Provide a descriptive summary
+    * Explain the expected behavior
+    * Explain the actual behavior
+    * Provide steps to reproduce the actual behavior
+
+### Making Changes
+
+* Fork the repository on GitHub
+* Create a topic branch from where you want to base your work.
+  * This will usually be based on the master branch.
+  * To quickly create a topic branch based on master; `git branch fix/master/my_contribution master`
+  * Then checkout the new branch with `git checkout fix/master/my_contribution`.
+  * Please avoid working directly on the `master` branch.
+  * You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful.
+* Make commits of logical units.
+  * Your commit should include a high level description of your work.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
+
+```
+    Present tense short summary (50 characters or less)
+
+    More detailed description, if necessary. It should be wrapped to 72
+    characters. Try to be as descriptive as you can, even if you think that
+    the commit content is obvious, it may not be obvious to others. You
+    should add such description also if it's already present in bug tracker,
+    it should not be necessary to visit a webpage to check the history.
+
+    Include Closes #<issue-number> when relavent.
+
+    Description can have multiple paragraphs and you can use code examples
+    inside, just indent it with 4 spaces:
+
+        class PostsController
+          def index
+            respond_with Post.limit(10)
+          end
+        end
+
+    You can also add bullet points:
+
+    - you can use dashes or asterisks for bullets.
+
+    - also, try to indent next line of a point for readability, if it's too
+      long to fit in 72 characters.
+```
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+  * You can run all tests and style checks with `rake ci`.
+* When you are ready, submit a pull request.
+
+### Submitting Changes
+
+[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
+
+* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
+* Make sure your branch is up to date with its parent branch (i.e. master)
+  * `git checkout master`
+  * `git pull --rebase`
+  * `git checkout <your-branch>`
+  * `git rebase master`
+  * It is likely a good idea to run your tests again.
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request from your fork to the project.
+
+### Merging Changes
+
+* It is considered "poor from" to merge your own request.
+* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
+  * Does the commit message explain what is going on?
+  * Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_.
+  * Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
+  * Did the CI tests complete successfully?
+* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
+* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
+* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'pry' unless ENV['CI']
+
+# develop on qa master
+gem 'qa', github: 'projecthydra-labs/questioning_authority', branch: 'master'
+
+gem 'ld_cache_fragment',
+    github: 'ActiveTriples/linked-data-fragments',
+    branch: 'feature/multi-dataset'

data/Guardfile

@@ -0,0 +1,27 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper)  { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch(%r{lib\/qa\/ldf\/spec\/.*\.rb}) { rspec.spec_dir }
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+# Add files and commands to this file, like the example:
+#   watch(%r{file/path}) { `command(s)` }
+#
+guard :shell do
+  watch(/(.*).txt/) { |m| `tail #{m[0]}` }
+end

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright 2017 Data Curation Experts LLC, Chemical Heritage Foundation
+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,42 @@
+QuestioningAuthority::LDF
+=========================
+[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+Providies bindings from [Questioning Authority](https://github.com/projecthydra-labs/questioning_authority) to the [linked data caching fragment server](https://github.com/ActiveTriples/linked-data-fragments) for fast query of RDF-based authorities.
+
+What Does This Do?
+------------------
+
+Provides a caching version of the [Questioning Authority](https://github.com/projecthydra-labs/questioning_authority) interface relying on the ActiveTriples LDF caching service.
+
+[TK] Why use this?
+
+Upcoming features include:
+
+  - Support for `Qa::Authority::Base#all` for all LDF authorities through [Hydra Core Partial Collection View](http://www.hydra-cg.com/spec/latest/core/#hydra:PartialCollectionView) style paging.
+  - A default search, accessing cached items.
+
+How Does it Work?
+-----------------
+
+### [TK] Architecture Overview.
+### [TK] Mounting and configuring the LDF caching server.
+### [TK] LDF caching as an external service.
+### [TK] Configuring authorities.
+#### [TK] Models.
+#### [TK] Forms.
+
+[TK] Authority Sources
+----------------------
+
+### [TK] LCNAF
+### [TK] FAST
+
+[TK] Implementing Custom Authorities
+------------------------------------
+
+
+License
+-------
+
+This software is available under {file:LICENSE the Apache 2.0 license}.

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+require 'yard'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Build YARD documentation'
+YARD::Rake::YardocTask.new do |t|
+  t.files         = ['lib/**/*.rb', 'LICENSE.md']
+  t.stats_options = ['--list-undoc']
+end
+
+desc 'Run continious integration'
+task ci: [:rubocop, :spec]
+
+task default: :ci

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config/ldf.yml

@@ -0,0 +1,15 @@
+development:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/'
+  cache_backend:
+    provider: 'repository'
+test: &TEST_
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/'
+  cache_backend:
+    provider: 'repository'
+production:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/'
+  cache_backend:
+    provider: 'repository'

data/lib/qa/ldf.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'qa/ldf/version'
+
+require 'qa/ldf/configuration'
+require 'qa/ldf/client'
+require 'qa/ldf/json_mapper'
+require 'qa/ldf/model'
+
+require 'qa/ldf/authority'
+require 'qa/ldf/authorities'
+
+##
+# @see https://github.com/projecthydra-labs/questioning_authority Qa
+module Qa
+  ##
+  # Provides bindings from `qa` to a linked data fragment caching service for
+  # fast query of RDF-based authorities.
+  #
+  # @see https://github.com/projecthydra-labs/questioning_authority Qa
+  # @see https://github.com/ActiveTriples/linked-data-fragments Linked Data
+  #   Fragments Cache
+  module LDF
+    ##
+    # @return [Configuration] the singleton configuration instance
+    def self.config
+      @config ||= configure!
+    end
+
+    ##
+    # @example configuring with block syntax
+    #   Qa::LDF.configure
+    # @see Configuration#configure
+    def self.configure!(**options, &block)
+      @config = Configuration.instance.configure!(**options, &block)
+    end
+
+    ##
+    # @see VERSION
+    def self.version
+      VERSION
+    end
+  end
+end

data/lib/qa/ldf/authorities.rb

@@ -0,0 +1 @@
+require 'qa/ldf/authorities/lc_names'

data/lib/qa/ldf/authorities/lc_names.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+module Qa
+  module LDF
+    ##
+    # A caching LCSH authority.
+    #
+    # @note This uses the search logic from the basic Loc authority that ships
+    #   with QA: `Qa::Authorities::Loc::GenericAuthority`.
+    #
+    # @see LinkedDataFragments::CacheServer
+    class LCNames < Authority
+      DEFAULT_DATASET_NAME = :lcnames
+      LC_SUBAUTHORITY      = 'names'.freeze
+
+      ##
+      # Uses the LC names subauthority as the search provider
+      def search_service
+        @search_service ||=
+          Qa::Authorities::Loc.subauthority_for(LC_SUBAUTHORITY)
+      end
+    end
+  end
+
+  ##
+  # Alias to hack Qa's namespaced authority logic.
+  #
+  # @see https://github.com/projecthydra-labs/questioning_authority/issues/137
+  module Authorities
+    Lcnames = LDF::LCNames
+  end
+end

data/lib/qa/ldf/authority.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+require 'qa/authorities'
+require 'qa/ldf/empty_search_service'
+
+module Qa
+  module LDF
+    ##
+    # A Linked Data Fragments-based authority. Access linked data resources
+    # through a caching server.
+    #
+    # @see LinkedDataFragments::CacheServer
+    class Authority < Qa::Authorities::Base
+      ##
+      # The default linked data fragments client
+      DEFAULT_DATASET_NAME = :''
+
+      ##
+      # The default linked data fragments client
+      DEFAULT_CLIENT = Qa::LDF::Client
+
+      ##
+      # The default mapper
+      DEFAULT_MAPPER = Qa::LDF::JsonMapper
+
+      ##
+      # The default search service
+      DEFAULT_SEARCH_SERVICE = Qa::LDF::EmptySearchService
+
+      ##
+      # @!attribute [rw] client
+      #   @return [Client]
+      # @!attribute [rw] dataset
+      #   @return [Symbol] A dataset name (e.g. :lcsh)
+      # @!attribute [rw] mapper
+      #   @return [Mapper]
+      # @!attribute [rw] search_service
+      #   @return [#search]
+      attr_writer :client, :dataset, :mapper, :search_service
+
+      ##
+      # @yieldparam authority [Authority] self
+      def initialize(*)
+        super
+        yield self if block_given?
+      end
+
+      ##
+      # @see Qa::Authorities::Base#all
+      def all
+        []
+      end
+
+      ##
+      # Retrieves the given resource's JSON respresentation from the cache
+      # server.
+      #
+      # The resource is retrieved through the client given by `#client`, and
+      # mapped to JSON using `#mapper`.
+      #
+      # @see Qa::Authorities::Base#find
+      # @see Qa::LDF::Client#get
+      def find(id)
+        graph = client.get(uri: id, dataset: dataset)
+
+        mapper.map_resource(id, graph)
+      end
+
+      ##
+      # Search the vocabulary
+      #
+      # @param _query [String] the query string
+      #
+      # @return [Array<Hash<Symbol, String>>] the response as a JSON friendly
+      #   hash
+      def search(query)
+        search_service.search(query)
+      end
+
+      ##
+      # @return [Qa::LDF::Client]
+      def client
+        @client ||= self.class::DEFAULT_CLIENT.new
+      end
+
+      ##
+      # @return [Symbol]
+      def dataset
+        @dataset ||= self.class::DEFAULT_DATASET_NAME
+      end
+
+      ##
+      # @return [JsonMapper]
+      def mapper
+        @mapper ||= self.class::DEFAULT_MAPPER.new
+      end
+
+      ##
+      # @return [#search]
+      def search_service
+        @search_service ||= self.class::DEFAULT_SEARCH_SERVICE.new
+      end
+    end
+  end
+end