triannon-client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6311cba677a659f924697ca9eea30c52455b4583
+  data.tar.gz: 57c001638b992be5f97d526bda85ddaea20b79c6
+SHA512:
+  metadata.gz: cf40229f17bde5ca917b659325540c04cb09ce72da0a80b88c200720833d857291446cd0ab44305963e671d53b9aea45d873cec3f76f54b8c051798a1a96c844
+  data.tar.gz: a7c2edbc95b69ca045df19336ef62a7e30c1ff3a6fd4a6a0961c708300143380591ad878c83561c97bd9975ba0d122bcf32e793ad840177529aa1ec6f5d740f4

data/.env_example

@@ -0,0 +1,17 @@
+# https://github.com/bkeepers/dotenv is used for
+# default configuration options.  The values in
+# this file do not replace existing values in
+# the shell ENV.
+
+# Uncomment and set values as required.  See used settings in
+# lib/*/configuration.rb
+
+export DEBUG=false
+
+export TRIANNON_LOG_FILE='log/triannon_client.log'
+
+# Configure the triannon service
+export TRIANNON_HOST='triannon.example.org'
+export TRIANNON_USER=''
+export TRIANNON_PASS=''
+

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+install: ./bin/setup.sh
+
+script: ./bin/test.sh
+
+notifications:
+  email: false
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Dependencies are defined in *.gemspec
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,203 @@
+PATH
+  remote: .
+  specs:
+    triannon-client (0.0.0)
+      dotenv
+      linkeddata (~> 1.0)
+      pry
+      pry-doc
+      rest-client (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    coveralls (0.7.12)
+      multi_json (~> 1.10)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.9.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.23)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.0.0)
+    ebnf (0.3.7)
+      haml (~> 4.0)
+      rdf (~> 1.1)
+      sxp (~> 0.1, >= 0.1.3)
+    equivalent-xml (0.5.1)
+      nokogiri (>= 1.4.3)
+    ffi (1.9.8)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-ctags-bundler (1.4.0)
+      guard (>= 2.0)
+      guard-compat (>= 0.1.0)
+    haml (4.0.6)
+      tilt
+    hitimes (1.2.2)
+    htmlentities (4.3.3)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json-ld (1.1.8)
+      rdf (~> 1.1, >= 1.1.7)
+    link_header (0.0.8)
+    linkeddata (1.1.2)
+      equivalent-xml (~> 0.4)
+      json-ld (~> 1.1, >= 1.1.7)
+      nokogiri (~> 1.6)
+      rdf (~> 1.1, >= 1.1.7)
+      rdf-aggregate-repo (~> 1.1)
+      rdf-isomorphic (~> 1.1)
+      rdf-json (~> 1.1)
+      rdf-microdata (~> 2.0)
+      rdf-n3 (~> 1.1)
+      rdf-rdfa (~> 1.1, >= 1.1.5)
+      rdf-rdfxml (~> 1.1, >= 1.1.3)
+      rdf-reasoner (~> 0.2, >= 0.2.1)
+      rdf-trig (~> 1.1, >= 1.1.3)
+      rdf-trix (~> 1.1)
+      rdf-turtle (~> 1.1, >= 1.1.5)
+      sparql (~> 1.1, >= 1.1.4)
+      sparql-client (~> 1.1, >= 1.1.3)
+    listen (2.9.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    multi_json (1.11.0)
+    nenv (0.2.0)
+    net-http-persistent (2.9.4)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-doc (0.6.0)
+      pry (~> 0.9)
+      yard (~> 0.8)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rdf (1.1.10)
+      link_header (~> 0.0, >= 0.0.8)
+    rdf-aggregate-repo (1.1.0)
+      rdf (>= 1.1)
+    rdf-isomorphic (1.1.0)
+      rdf (>= 1.1)
+    rdf-json (1.1.1)
+      rdf (~> 1.1)
+    rdf-microdata (2.0)
+      htmlentities (~> 4.3)
+      nokogiri (~> 1.6)
+      rdf (~> 1.1)
+      rdf-xsd (~> 1.1)
+    rdf-n3 (1.1.2)
+      rdf (~> 1.1, >= 1.1.5)
+    rdf-rdfa (1.1.5)
+      haml (~> 4.0)
+      htmlentities (~> 4.3)
+      rdf (~> 1.1, >= 1.1.6)
+      rdf-aggregate-repo
+      rdf-xsd (~> 1.1)
+    rdf-rdfxml (1.1.3)
+      htmlentities (~> 4.3)
+      rdf (~> 1.1, >= 1.1.6)
+      rdf-rdfa (~> 1.1, >= 1.1.4.1)
+      rdf-xsd (~> 1.1)
+    rdf-reasoner (0.2.1)
+      rdf (~> 1.1, >= 1.1.4.2)
+      rdf-turtle (~> 1.1)
+      rdf-xsd (~> 1.1)
+    rdf-trig (1.1.3.1)
+      ebnf (~> 0.3, >= 0.3.5)
+      rdf (~> 1.1, >= 1.1.2.1)
+      rdf-turtle (~> 1.1, >= 1.1.3)
+    rdf-trix (1.1.0)
+      rdf (>= 1.1)
+    rdf-turtle (1.1.5)
+      ebnf (~> 0.3, >= 0.3.6)
+      rdf (~> 1.1, >= 1.1.4)
+    rdf-xsd (1.1.3)
+      rdf (~> 1.1, >= 1.1.9)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    shellany (0.0.1)
+    simplecov (0.9.2)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.9.0)
+    simplecov-html (0.9.0)
+    slop (3.6.0)
+    sparql (1.1.4)
+      builder (~> 3.0)
+      ebnf (~> 0.3, >= 0.3.5)
+      rdf (~> 1.1, >= 1.1.4)
+      rdf-aggregate-repo (~> 1.1, >= 1.1.0)
+      rdf-xsd (~> 1.1)
+      sparql-client (~> 1.1)
+      sxp (~> 0.1)
+    sparql-client (1.1.4)
+      net-http-persistent (~> 2.9)
+      rdf (~> 1.1)
+    sxp (0.1.5)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tilt (2.0.1)
+    timers (4.0.1)
+      hitimes
+    tins (1.3.5)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.6)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  guard
+  guard-ctags-bundler
+  rake
+  rspec
+  triannon-client!

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   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,95 @@
+[![Build Status](https://travis-ci.org/sul-dlss/triannon-client.svg?branch=master)](https://travis-ci.org/sul-dlss/triannon-client) [![Coverage Status](https://coveralls.io/repos/sul-dlss/triannon-client/badge.png)](https://coveralls.io/r/sul-dlss/triannon-client) [![Dependency Status](https://gemnasium.com/sul-dlss/triannon-client.svg)](https://gemnasium.com/sul-dlss/triannon-client) [![Gem Version](https://badge.fury.io/rb/triannon-client.svg)](http://badge.fury.io/rb/triannon-client)
+
+# Triannon Client
+
+A client for the triannon service, see also
+- https://github.com/sul-dlss/triannon
+- https://github.com/sul-dlss/triannon-service
+
+
+## Installation into ruby projects
+
+```ruby
+gem 'triannon-client'
+```
+
+Then execute:
+
+```console
+bundle
+```
+
+
+## Using the client
+
+### Configuration
+
+Edit a `.env` file to configure the triannon server address etc.
+(see .env_example); or use a configure block, e.g.
+
+```ruby
+require 'triannon-client'
+::TriannonClient.configure do |config|
+  config.debug = true
+  config.host = 'http://triannon.example.org:8080'
+  config.user = 'authUser'
+  config.pass = 'secret'
+end
+```
+
+### Get a client instance
+
+```ruby
+tc = TriannonClient::TriannonClient.new
+```
+
+### Get a list of annotations
+
+```ruby
+# return an RDF::Graph
+graph = tc.get_annoations
+```
+
+### Get a particular annotation
+
+```ruby
+# the default response is an open annotation in an RDF::Graph
+oa_anno = tc.get_annotation(id)
+```
+
+For specific response formats, specify an HTTP `Accept` header, e.g.
+
+```ruby
+# explicitly request jsonld with an open annotation or a IIIF context
+anno_oa   = tc.get_annotation(id, `application/ld+json; profile="http://www.w3.org/ns/oa-context-20130208.json"`)
+anno_iiif = tc.get_annotation(id, `application/ld+json; profile="http://iiif.io/api/presentation/2/context.json"`)
+# convenience methods to do the above
+anno_oa   = tc.get_oa_annotation(id)
+anno_iiif = tc.get_iiif_annotation(id)
+```
+
+### Create an annotation
+
+```ruby
+tc.post_annotation(open_annotation_jsonld)
+```
+
+### Delete an annotation
+
+#### TODO
+
+
+## Development
+
+Clone and install:
+
+```console
+./bin/setup.sh
+```
+
+Run tests:
+
+```console
+./bin/test.sh
+```
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec
+task :specs => :spec

data/bin/ctags.rb

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+system "find . -name '*.rb' | ctags -f .tags --languages=Ruby -L -"
+
+if File.exist? './Gemfile'
+  require 'bundler'
+  paths = Bundler.load.specs.map(&:full_gem_path).join(' ')
+  system "ctags -R -f .gemtags --languages=Ruby #{paths}"
+end

data/lib/triannon-client.rb

@@ -0,0 +1,37 @@
+require 'dotenv'
+Dotenv.load
+
+require 'pry'
+require 'pry-doc'
+
+# require rest client prior to linkeddata, so the latter can use it.
+require 'rest-client'
+require 'linkeddata'
+RestClient.proxy = ENV['http_proxy'] unless ENV['http_proxy'].nil?
+RestClient.proxy = ENV['HTTP_PROXY'] unless ENV['HTTP_PROXY'].nil?
+
+require_relative 'triannon-client/configuration'
+require_relative 'triannon-client/triannon-client'
+
+module TriannonClient
+
+  # configuration at the module level, see
+  # http://brandonhilkert.com/blog/ruby-gem-configuration-patterns/
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+end

data/lib/triannon-client/configuration.rb

@@ -0,0 +1,49 @@
+
+module TriannonClient
+
+  class Configuration
+
+    attr_accessor :debug
+    attr_accessor :logger
+
+    attr_accessor :host
+    attr_accessor :user
+    attr_accessor :pass
+
+    def initialize
+      @debug = env_boolean('DEBUG')
+
+      @host = ENV['TRIANNON_HOST'] || 'http://localhost:3000'
+      @user = ENV['TRIANNON_USER'] || ''
+      @pass = ENV['TRIANNON_PASS'] || ''
+
+      # logger
+      log_file = ENV['TRIANNON_LOG_FILE'] || 'triannon_client.log'
+      log_file = File.absolute_path log_file
+      @log_file = log_file
+      log_path = File.dirname log_file
+      unless File.directory? log_path
+        # try to create the log directory
+        Dir.mkdir log_path rescue nil
+      end
+      begin
+        log_dev = File.new(@log_file, 'w+')
+      rescue
+        log_dev = $stderr
+        @log_file = 'STDERR'
+      end
+      log_dev.sync = true if @debug # skip IO buffering in debug mode
+      @logger = Logger.new(log_dev, 'monthly')
+      @logger.level = @debug ? Logger::DEBUG : Logger::INFO
+
+    end
+
+    def env_boolean(var)
+      # check if an ENV variable is true, use false as default
+      ENV[var].to_s.upcase == 'TRUE' rescue false
+    end
+
+  end
+
+end
+

data/lib/triannon-client/triannon-client.rb

@@ -0,0 +1,126 @@
+
+module TriannonClient
+
+  class TriannonClient
+
+    @@config = nil
+
+    attr_accessor :site
+
+    def initialize
+      # Configure triannon-app service
+      @@config ||= ::TriannonClient.configuration
+      @site = RestClient::Resource.new(
+        @@config.host,
+        :user => @@config.user,
+        :password => @@config.pass,
+        :open_timeout => 5,  #seconds
+        :read_timeout => 20, #seconds
+      )
+    end
+
+    # @param oa [JSON-LD] a json-ld object with an open annotation context
+    # @return response [RestClient::Response|nil]
+    def post_annotation(oa)
+      post_data = {
+        "commit" => "Create Annotation",
+        "annotation" => {"data" => oa}
+      }
+      response = nil
+      tries = 0
+      begin
+        tries += 1
+        response = @site["/annotations/"].post post_data, :content_type => :json
+      rescue => e
+        sleep 1*tries
+        retry if tries < 3
+        binding.pry if @@config.debug
+        @@config.logger.error("Failed to POST annotation: #{e.message}")
+      end
+      return response
+    end
+
+    # Get a list of annotations
+    # @param content_type [String] HTTP accept header value for content type negotiation
+    # @response [RDF::Graph|RestClient::Response] RDF::Graph when content_type is not specified
+    def get_annotations(content_type=nil)
+      if content_type.nil?
+        get("#{@site.url}/annotations")
+      else
+        get("/annotations", content_type)
+      end
+    end
+
+    # Get an annotation (with a default annotation context)
+    # @param id [String] String representation of an annotation URI
+    # @param content_type [String] HTTP accept header value for content type negotiation
+    # @response [RDF::Graph|RestClient::Response] RDF::Graph when content_type is not specified
+    def get_annotation(id, content_type=nil)
+      if content_type.nil?
+        get("#{@site.url}/annotations/#{id}")
+      else
+        get("/annotations/#{id}", content_type)
+      end
+    end
+
+    # Get an annotation with a IIIF context
+    # @param id [String] String representation of an annotation URI
+    # @param content_type [String] HTTP accept header value for content type negotiation
+    # @response [RDF::Graph|RestClient::Response] RDF::Graph when content_type is not specified
+    def get_iiif_annotation(id, content_type=nil)
+      if content_type.nil?
+        get("#{@site.url}/annotations/iiif/#{id}")
+      else
+        get("/annotations/iiif/#{id}", content_type)
+      end
+    end
+
+    # Get an annotation with an open annotation context
+    # @param id [String] String representation of an annotation URI
+    # @param content_type [String] HTTP accept header value for content type negotiation
+    # @response [RDF::Graph|RestClient::Response] RDF::Graph when content_type is not specified
+    def get_oa_annotation(id, content_type=nil)
+      if content_type.nil?
+        get("#{@site.url}/annotations/oa/#{id}")
+      else
+        get("/annotations/oa/#{id}", content_type)
+      end
+    end
+
+
+    private
+
+    # GET annotations and annotation
+    #
+    # use HTTP Accept header with mime type to indicate desired
+    # format ** default: jsonld ** also supports turtle, rdfxml, html
+    # ** see https://github.com/sul-dlss/triannon/blob/master/app/controllers/triannon/annotations_controller.rb #show method for mime formats accepted
+    #
+    # JSON-LD context
+    #
+    # You can request IIIF or OA context for jsonld. You can use either of
+    # these methods (with the correct HTTP Accept header):
+    #
+    # GET: http://(host)/annotations/iiif/(anno_id)
+    # GET: http://(host)/annotations/(anno_id)?jsonld_context=iiif
+    #
+    # GET: http://(host)/annotations/oa/(anno_id)
+    # GET: http://(host)/annotations/(anno_id)?jsonld_context=oa
+    #
+    # Note that OA (Open Annotation) is the default context if none is specified.
+
+    def get(uri, content_type=nil)
+      if content_type.nil?
+        # try to get an RDF graph, let RDF.rb do content negotiation
+        RDF::Graph.load(uri)
+      else
+        # content_type options should include: :html, :xml, :rdf, :json
+        content_type = content_type.to_sym
+        @site[uri].get({:accept => content_type})
+      end
+    end
+
+  end
+
+end
+

data/log/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

data/spec/lib/triannon-client/configuration_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+module TriannonClient
+
+  describe Configuration do
+
+    describe '#debug' do
+      it 'default value is false' do
+        ENV['DEBUG'] = nil
+        config = Configuration.new
+        expect(config.debug).to be_falsey
+      end
+    end
+
+    describe '#debug=' do
+      it 'can set value' do
+        config = Configuration.new
+        config.debug = true
+        expect(config.debug).to be_truthy
+      end
+    end
+
+    describe '#host' do
+      it 'default value is http://localhost:3000' do
+        ENV['TRIANNON_HOST'] = nil
+        config = Configuration.new
+        expect(config.host).to eql('http://localhost:3000')
+      end
+    end
+
+    describe '#host=' do
+      it 'can set value' do
+        config = Configuration.new
+        config.host = 'triannon.example.org'
+        expect(config.host).to eql('triannon.example.org')
+      end
+    end
+
+    describe '#user' do
+      it 'default value is an empty string' do
+        ENV['TRIANNON_USER'] = nil
+        config = Configuration.new
+        expect(config.user.empty?).to be_truthy
+      end
+    end
+
+    describe '#user=' do
+      it 'can set value' do
+        config = Configuration.new
+        config.user = 'fred'
+        expect(config.user).to eql('fred')
+      end
+    end
+
+    describe '#pass' do
+      it 'default value is an empty string' do
+        ENV['TRIANNON_PASS'] = nil
+        config = Configuration.new
+        expect(config.pass.empty?).to be_truthy
+      end
+    end
+
+    describe '#pass=' do
+      it 'can set value' do
+        config = Configuration.new
+        config.pass = 'secret'
+        expect(config.pass).to eql('secret')
+      end
+    end
+
+  end
+end

data/spec/lib/triannon-client/triannon-client_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+# ::TriannonClient::TriannonClient class specs
+
+describe TriannonClient do
+
+  describe "#get_annotations" do
+    it 'should get a list of open annotations' do
+      #TODO
+    end
+  end
+
+  describe "#get_annotation" do
+    it 'should get an open annotation by URI' do
+      #TODO
+    end
+  end
+
+  describe "#get_iiif_annotation" do
+    it 'should get an open annotation by URI, with IIIF context' do
+      #TODO
+    end
+  end
+
+  describe "#get_oa_annotation" do
+    it 'should get an open annotation by URI, with OA context' do
+      #TODO
+    end
+  end
+
+  describe "#post_annotation" do
+    it 'should POST an open annotation' do
+      #TODO
+    end
+  end
+
+end
+

data/spec/lib/triannon-client_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+# ::TriannonClient module specs
+
+describe ::TriannonClient do
+
+  describe ".configuration" do
+    it "should be a configuration object" do
+      expect(described_class.configuration).to be_a_kind_of ::TriannonClient::Configuration
+    end
+  end
+
+  describe "#configure" do
+    before :each do
+      ::TriannonClient.configure do |config|
+        config.debug = true
+      end
+    end
+    it "returns a hash of options" do
+      config = ::TriannonClient.configuration
+      expect(config).to be_instance_of ::TriannonClient::Configuration
+      expect(config.debug).to be_truthy
+    end
+    after :each do
+      ::TriannonClient.reset
+    end
+  end
+
+  describe ".reset" do
+    before :each do
+      ::TriannonClient.configure do |config|
+        config.debug = true
+      end
+    end
+    it "resets the configuration" do
+      ::TriannonClient.reset
+      config = ::TriannonClient.configuration
+      expect(config).to be_instance_of ::TriannonClient::Configuration
+      expect(config.debug).to be_falsey
+    end
+    after :each do
+      ::TriannonClient.reset
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'triannon-client'
+require 'rspec'
+RSpec.configure do |config|
+
+end
+

data/triannon-client.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = 'triannon-client'
+  s.version     = '0.0.0'
+  s.licenses    = ['Apache-2.0']
+  s.platform    = Gem::Platform::RUBY
+
+  s.authors     = ['Darren Weber',]
+  s.email       = ['darren.weber@stanford.edu']
+
+  s.homepage    = 'https://github.com/sul-dlss/triannon-client'
+  s.summary     = 'A client for RESTful transactions with a triannon annotation server'
+  s.description = 'A client for RESTful transactions with a triannon annotation server'
+
+  s.required_rubygems_version = '>= 1.3.6'
+
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+
+  # Use ENV for config
+  s.add_dependency 'dotenv'
+  # HTTP and RDF clients
+  s.add_dependency 'rest-client', '~> 1.0'
+  s.add_dependency 'linkeddata', '~> 1.0'
+  # Use pry for console and debugging
+  s.add_dependency 'pry'
+  s.add_dependency 'pry-doc'
+
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-ctags-bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  s.files   = `git ls-files`.split($/)
+  dev_files = %w(.gitignore bin/console bin/setup.sh bin/test.sh)
+  dev_files.each {|f| s.files.delete f }
+
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+
+end
+

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: triannon-client
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Darren Weber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: linkeddata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-doc
+  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: coveralls
+  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: guard
+  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: guard-ctags-bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: A client for RESTful transactions with a triannon annotation server
+email:
+- darren.weber@stanford.edu
+executables:
+- ctags.rb
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".env_example"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/ctags.rb
+- lib/triannon-client.rb
+- lib/triannon-client/configuration.rb
+- lib/triannon-client/triannon-client.rb
+- log/.gitignore
+- spec/lib/triannon-client/configuration_spec.rb
+- spec/lib/triannon-client/triannon-client_spec.rb
+- spec/lib/triannon-client_spec.rb
+- spec/spec_helper.rb
+- triannon-client.gemspec
+homepage: https://github.com/sul-dlss/triannon-client
+licenses:
+- Apache-2.0
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A client for RESTful transactions with a triannon annotation server
+test_files:
+- spec/lib/triannon-client/configuration_spec.rb
+- spec/lib/triannon-client/triannon-client_spec.rb
+- spec/lib/triannon-client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: