triannon-client 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 802b9f76579fab24a550f34599ebdd1cc7c5f0f2
-  data.tar.gz: 1a2a565638e4e2384fd0dd04769115b2b36a886f
+  metadata.gz: 40fc837047b78dbcd2f32c6a0d81ec1a62026d17
+  data.tar.gz: d99bfa05bf980455e7562c388ff4d8fd4f7db552
 SHA512:
-  metadata.gz: 81d538d12dfad2cbc8fdfecfc72bd0ed37d32260bc1375552145df4a466c0e0320f38e05cddbcb4263358403f99c0ea85f4f59810fd6024ee2f4f8c0b3ed1b30
-  data.tar.gz: 018a3e5016569319760d9b279b25974966883525e75ff02d76bc7bccccc8cbd593ead4dac1b3f4bf84089b2b931de02ff1af29e8f61d903645ef57b834ebee3a
+  metadata.gz: b6754fccc7db31f606a505964b682e885a44857adced25fae0452cc083a66ef6e212e7c15e85cbe28ba789d1ae70129d81cfc245f33cbab768e6e17cf4072df2
+  data.tar.gz: ce3b499fdaf82636d202dc580a68eee150e5fd5575d7687e1657f770e35bbda5ce3d56e6132540baa7d140ddb7f390e3b6e85dc9dcf2523576923f1ed21581b4

data/README.md

@@ -3,7 +3,7 @@
 
 # Under construction!
 
-Use at your own risk!
+Any gem released prior to 1.x may have an unstable API.  As the triannon server and this client are in rapid development (as of 2015), expect new gem releases that could break the API.
 
 
 # Triannon Client
@@ -87,17 +87,16 @@ tc.post_annotation(open_annotation_jsonld)
 
 ```ruby
 uri = RDF::URI.new("http://your.triannon-server.com/annotations/45/4a/c0/93/454ac093-b37d-4580-bebd-449f8dabddc9")
-tc.annotation_id(uri) #=> "45%2F4a%2Fc0%2F93%2F454ac093-b37d-4580-bebd-449f8dabddc9"
+id = tc.annotation_id(uri) #=> "45%2F4a%2Fc0%2F93%2F454ac093-b37d-4580-bebd-449f8dabddc9"
 tc.delete_annotation(id)
 ```
 
-Note that the annotation URI contains a pair-tree path that is created by
-the Fedora 4 instance that triannon server works on.  The annotation ID is
-the entire pair-tree path after it is URI escaped.  This makes it easier to
-work with the ID for tc.get_annotation(id) and tc.delete_annotation(id).
-For more information on object storage using pair-trees, see
-http://www.slideshare.net/jakkbl/dcc-pair-posterppt
-https://wiki.ucop.edu/display/Curation/PairTree
+Note: the annotation URI contains a pair-tree path (created by a Fedora 4 repository for 
+triannon annotations).  The annotation ID is the entire pair-tree path, after a URI escape.
+The URI escape makes it easier to work with the ID for tc.get_annotation(id) and 
+tc.delete_annotation(id).  For more information on object storage using pair-trees, see
+  - http://www.slideshare.net/jakkbl/dcc-pair-posterppt
+  - https://wiki.ucop.edu/display/Curation/PairTree
 
 ## Development
 

data/lib/triannon-client/triannon_client.rb

@@ -55,13 +55,18 @@ module TriannonClient
         # 202 (Accepted) if the action has not yet been enacted, or
         # 204 (No Content) if the action has been enacted but the response
         # does not include an entity.
-        [200, 202, 204].include? response.code
+        [200, 202, 204].include?(response.code)
       rescue RestClient::Exception => e
         response = e.response
-        # If an annotation doesn't exist, consider the request a 'success'
-        return true if [404, 410].include? response.code
+        if response.is_a?(RestClient::Response)
+          # If an annotation doesn't exist, consider the request a 'success'
+          return true if [404, 410].include?(response.code)
+          msg = response.body
+        else
+          msg = e.message
+        end
+        @config.logger.error("Failed to DELETE annotation: #{id}, #{msg}")
         binding.pry if @config.debug
-        @config.logger.error("Failed to DELETE annotation: #{id}, #{response.body}")
         false
       rescue => e
         binding.pry if @config.debug
@@ -127,7 +132,6 @@ module TriannonClient
         # TODO: switch yard for different response.code?
         response2graph(response)
       rescue => e
-        # response = e.response
         binding.pry if @config.debug
         @config.logger.error("Failed to GET annotation: #{id}, #{e.message}")
         RDF::Graph.new # return an empty graph

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

@@ -187,26 +187,20 @@ describe TriannonClient, :vcr do
       expect( tc.delete_annotation(id) ).to be true
     end
     it 'logs exceptions' do
-      exception_response = double()
-      allow(exception_response).to receive(:code).and_return(450)
-      allow(exception_response).to receive(:body).and_return('delete_logs_exceptions')
-      allow_any_instance_of(RestClient::Exception).to receive(:response).and_return(exception_response)
+      allow_any_instance_of(RestClient::Response).to receive(:code).and_return(450)
+      allow_any_instance_of(RestClient::Response).to receive(:body).and_return('delete_logs_exceptions')
       expect(TriannonClient.configuration.logger).to receive(:error).with(/delete_logs_exceptions/)
       tc.delete_annotation('delete_logs_exceptions')
     end
     it 'does not log exceptions for missing annotations (404 responses)' do
-      exception_response = double()
-      allow(exception_response).to receive(:code).and_return(404)
-      allow(exception_response).to receive(:body).and_return('delete_does_not_log_404_exceptions')
-      allow_any_instance_of(RestClient::Exception).to receive(:response).and_return(exception_response)
+      allow_any_instance_of(RestClient::Response).to receive(:code).and_return(404)
+      allow_any_instance_of(RestClient::Response).to receive(:body).and_return('delete_does_not_log_404_exceptions')
       expect(TriannonClient.configuration.logger).not_to receive(:error)
       tc.delete_annotation('delete_does_not_log_404_exceptions')
     end
     it 'does not log exceptions for missing annotations (410 responses)' do
-      exception_response = double()
-      allow(exception_response).to receive(:code).and_return(410)
-      allow(exception_response).to receive(:body).and_return('delete_does_not_log_410_exceptions')
-      allow_any_instance_of(RestClient::Exception).to receive(:response).and_return(exception_response)
+      allow_any_instance_of(RestClient::Response).to receive(:code).and_return(410)
+      allow_any_instance_of(RestClient::Response).to receive(:body).and_return('delete_does_not_log_410_exceptions')
       expect(TriannonClient.configuration.logger).not_to receive(:error)
       tc.delete_annotation('delete_does_not_log_410_exceptions')
     end

data/triannon-client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'triannon-client'
-  s.version     = '0.4.0'
+  s.version     = '0.4.1'
   s.licenses    = ['Apache-2.0']
   s.platform    = Gem::Platform::RUBY
 
@@ -34,12 +34,11 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'
 
-  s.files   = `git ls-files`.split($/)
+  git_files = `git ls-files`.split($/)
+  bin_files = %w(bin/console bin/ctags.rb bin/setup.sh bin/test.sh)
+  dot_files = %w(.gitignore .travis.yml log/.gitignore)
+  s.files = git_files - (bin_files + dot_files)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
 
-  dev_files = %w(.gitignore bin/console bin/ctags.rb bin/setup.sh bin/test.sh)
-  dev_files.each {|f| s.files.delete f; s.executables.delete f; }
-
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: triannon-client
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Darren Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -181,30 +181,20 @@ dependencies:
 description: A client for RESTful transactions with a triannon annotation server
 email:
 - triannon-commits@lists.stanford.edu
-executables:
-- console
-- ctags.rb
-- setup.sh
-- test.sh
+executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
 files:
 - ".env_example"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/ctags.rb
-- bin/setup.sh
-- bin/test.sh
 - lib/triannon-client.rb
 - lib/triannon-client/configuration.rb
 - lib/triannon-client/triannon_client.rb
-- log/.gitignore
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_annotation/with_content_type/cannot_get_an_open_annotation_by_ID_with_content_type_application/n-quads_.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_annotation/with_content_type/cannot_get_an_open_annotation_by_ID_with_content_type_application/n-triples_.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_annotation/with_content_type/cannot_get_an_open_annotation_by_ID_with_content_type_application/rdf_json_.yml

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-
-install: ./bin/setup.sh
-
-script: ./bin/test.sh
-
-notifications:
-  email: triannon-commits@lists.stanford.edu
-
-rvm:
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-require 'triannon-client'
-CONFIG = TriannonClient.configuration
-
-tc = TriannonClient::TriannonClient.new
-oa_jsonld = '{"@context":"http://iiif.io/api/presentation/2/context.json","@graph":[{"@id":"_:g70349699654640","@type":["dctypes:Text","cnt:ContentAsText"],"chars":"I love this!","format":"text/plain","language":"en"},{"@type":"oa:Annotation","motivation":"oa:commenting","on":"http://purl.stanford.edu/kq131cs7229","resource":"_:g70349699654640"}]}'
-g = RDF::Graph.new
-format = RDF::Format.for(:jsonld)
-format.reader.new(oa_jsonld) {|r| r.each_statement {|s| g << s }}
-
-binding.pry

data/bin/ctags.rb

@@ -1,8 +0,0 @@
-#!/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/bin/setup.sh

@@ -1,10 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-rm -f .binstubs/*
-bundle install --binstubs .binstubs
-bundle package --all --quiet
-
-# see commentary on this practice at
-# http://blog.howareyou.com/post/66375371138/ruby-apps-best-practices

data/bin/test.sh

@@ -1,15 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-[[ -s .env ]] && mv .env .env_bak
-cp .env_example .env
-
-# The `|| echo ''` enables the bash script to continue after rspec failure
-EXIT=0
-.binstubs/rspec --color || EXIT=1
-#.binstubs/cucumber --strict || EXIT=1
-
-[[ -s .env_bak ]] && mv .env_bak .env
-exit $EXIT
-

data/log/.gitignore

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