triannon-client 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa133f38dd35b61695e30ed8efec553ea53711dd
-  data.tar.gz: 751821968feed148b466c6e88686ec2aa2f8b6a5
+  metadata.gz: 2fe0f7bdd55fdabe693e858e8eac8237f1260edf
+  data.tar.gz: 3d54efa60a69ea4a16d947fa3fead12bdbf5de1e
 SHA512:
-  metadata.gz: 1d13a81a4e7f7931ab25acd7b722ed22631d8f07b2ca4f31010ef4b925a7c219540f55f0e4a477baa8861fc6da0eeff3ac13da0f6977c7bc2d8c705eea69aedf
-  data.tar.gz: 93179351efed9e2f834f69c81fcf872e658960263ba2a38f87d828d8f4c7053832a4efaf12bbf634c3989c8ff14c5c10bae4c7faace3a04f42870c478ebc6e4f
+  metadata.gz: 2901c4382bbfa9d52960d968b0c9af8ba21d385824ebca5229d328530e0f1e6f5e07bd688037a3305e5f43ebe0ccdcecfa276f0196cd95e0eaa82481210fa4c9
+  data.tar.gz: 07a790cde3dc8078be217cd6bdfded6385825db047850148b979acc58617b2e9a8c06b7b2aa99ee7e8333c6faf4895337e1abf3a2e56c421c4376d58acb1b0c0

data/README.md

@@ -32,8 +32,11 @@ bundle
 
 Edit a `.env` file to configure the triannon server address etc.
 (see .env_example); or use a configure block.  The configuration
-for authentication depends on prior triannon server configuration.
-This example configuration may work with a triannon server running on localhost in the development environment (see below for details).
+for authentication depends on prior triannon server configuration, see
+ - https://github.com/sul-dlss/triannon#configuration
+
+This example configuration may work with a triannon server running
+on localhost in the development environment (see below for details).
 
 ```ruby
 require 'triannon-client'

data/lib/triannon-client.rb

@@ -1,13 +1,6 @@
 require 'dotenv'
 Dotenv.load
 
-# pry must be available when the client is configured to run in debug mode,
-# where it will fall into a pry console for rescue blocks.
-if ENV['DEBUG']
-  require 'pry'
-  require 'pry-doc'
-end
-
 # require rest client prior to linkeddata, so the latter can use it.
 require 'rest-client'
 # If a proxy is present, RestClient needs explicit configuration to use it.

data/lib/triannon-client/configuration.rb

@@ -22,7 +22,7 @@ module TriannonClient
     attr_accessor :client_pass
 
     def initialize
-      @debug = env_boolean('DEBUG')
+      self.debug = env_boolean('DEBUG')
 
       @host = ENV['TRIANNON_HOST'] || 'http://localhost:3000'
       # @user = ENV['TRIANNON_USER'] || '' # triannon doesn't support basic auth
@@ -58,7 +58,17 @@ module TriannonClient
       ENV[var].to_s.upcase == 'TRUE' rescue false
     end
 
+    def debug=(bool)
+      raise ArgumentError unless [true, false].include?(bool)
+      @debug = bool
+      if @debug
+        # pry must be available when the client is configured to run in debug
+        # mode, where it will fall into a pry console for rescue blocks.
+        require 'pry'
+        require 'pry-doc'
+      end
+    end
+
   end
 
 end
-

data/lib/triannon-client/triannon_client.rb

@@ -3,7 +3,6 @@ module TriannonClient
     # Triannon may not support all content types in RDF::Format.content_types,
     # but the client code is more generic using this as a reasonable set; this
     # allows triannon to evolve support for anything supported by RDF::Format.
-    CONTENT_ERROR = 'content_type not found in RDF::Format.content_types'
     CONTENT_TYPES = RDF::Format.content_types.keys
 
     JSONLD_TYPE = 'application/ld+json'
@@ -90,10 +89,10 @@ module TriannonClient
     # @param id [String] an annotation ID
     # @response [true|false] true when successful
     def delete_annotation(id)
-      check_id(id)
       tries = 0
       begin
         tries += 1
+        check_id(id) if tries == 1
         authenticate if tries == 2
         response = @container[id].delete
         # HTTP DELETE response codes: A successful response SHOULD be
@@ -165,9 +164,9 @@ module TriannonClient
     # @param content_type [String] HTTP mime type (defaults to 'application/ld+json')
     # @response [RDF::Graph] RDF::Graph of open annotations (can be empty on failure)
     def get_annotations(content_type=JSONLD_TYPE)
-      content_type = check_content_type(content_type)
       g = RDF::Graph.new
       begin
+        content_type = check_content_type(content_type)
         response = @container.get({:accept => content_type})
         g = response2graph(response)
       rescue => e
@@ -192,10 +191,10 @@ module TriannonClient
     # @param content_type [String] HTTP mime type (defaults to 'application/ld+json')
     # @response [RDF::Graph] RDF::Graph of the annotation (can be empty on failure)
     def get_annotation(id, content_type=JSONLD_TYPE)
-      check_id(id)
-      content_type = check_content_type(content_type)
       g = RDF::Graph.new
       begin
+        check_id(id)
+        content_type = check_content_type(content_type)
         response = @container[id].get({:accept => content_type})
         g = response2graph(response)
       rescue => e
@@ -238,10 +237,10 @@ module TriannonClient
       unless response.is_a? RestClient::Response
         raise ArgumentError, 'response2graph only accepts a RestClient::Response'
       end
-      content_type = response.headers[:content_type]
-      content_type = check_content_type(content_type)
       g = RDF::Graph.new
       begin
+        content_type = response.headers[:content_type]
+        content_type = check_content_type(content_type)
         case content_type
         when /ld\+json/
           g = RDF::Graph.new.from_jsonld(response.body)
@@ -283,13 +282,16 @@ module TriannonClient
 
     def check_content_type(content_type)
       type = content_type.split(';').first # strip off any parameters
-      raise ArgumentError, CONTENT_ERROR unless CONTENT_TYPES.include? type
+      unless CONTENT_TYPES.include? type
+        msg = "#{type} not found in RDF::Format.content_types"
+        raise ArgumentError, msg
+      end
       type
     end
 
     def check_id(id)
-      raise ArgumentError, 'ID must be a String' unless id.instance_of? String
-      raise ArgumentError, 'Invalid ID' if id.nil? || id.empty?
+      invalid =  ! id.instance_of?(String) || id.empty?
+      raise ArgumentError, "Invalid ID: #{id}" if invalid
     end
 
     def json_payloads

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

@@ -21,10 +21,23 @@ module TriannonClient
     end
 
     describe '#debug=' do
-      it 'can set value' do
+      it 'can set boolean value' do
         config.debug = true
         expect(config.debug).to be_truthy
       end
+      it 'loads pry in debug mode' do
+        config.debug = true
+        defined?(Pry) == true
+      end
+      it 'does not load pry outside debug mode' do
+        config.debug = false
+        defined?(Pry) == false
+      end
+      it 'raises ArgumentError for non-boolean values' do
+        expect{config.debug='abc'}.to raise_error(ArgumentError)
+        expect{config.debug=nil}.to raise_error(ArgumentError)
+        expect{config.debug=0}.to raise_error(ArgumentError)
+      end
     end
 
     describe '#host' do

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

@@ -65,10 +65,12 @@ RSpec.shared_examples "delete annotations" do |auth_required|
     expect(tc).to receive(:check_id)
     tc.delete_annotation('checking_anno_id')
   end
-  it 'raises ArgumentError for an invalid annotation ID' do
+  it 'logs ArgumentError for an invalid annotation ID' do
     expect_any_instance_of(RestClient::Resource).not_to receive(:delete)
-    expect { tc.delete_annotation('')  }.to raise_error(ArgumentError)
-    expect { tc.delete_annotation(nil) }.to raise_error(ArgumentError)
+    expect(tc.config.logger).to receive(:error).with(/Invalid ID/).exactly(3).times
+    expect(tc.delete_annotation('')).to be false
+    expect(tc.delete_annotation(0)).to be false
+    expect(tc.delete_annotation(nil)).to be false
   end
   it 'uses RestClient::Resource.delete to DELETE a valid annotation ID' do
     expect_any_instance_of(RestClient::Resource).to receive(:delete)

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

@@ -30,6 +30,8 @@ describe 'TriannonClientREAD', :vcr do
   end
 
   def cannot_get_anno_with_content_type(content_type)
+    expect(tc).to receive(:check_content_type)
+    expect(tc).not_to receive(:response2graph)
     graph = tc.get_annotation(@anno[:id], content_type)
     graph_is_empty(graph)
   end
@@ -199,6 +201,12 @@ describe 'TriannonClientREAD', :vcr do
 
     describe "annotation by ID" do
 
+      def invalid_annotation_id(id)
+        expect(tc.config.logger).to receive(:error).with(/Invalid ID/)
+        g = tc.get_annotation(id)
+        graph_is_empty(g)
+      end
+
       context 'using default content type' do
 
         it 'checks the annotation ID' do
@@ -206,14 +214,14 @@ describe 'TriannonClientREAD', :vcr do
           graph = tc.get_annotation(@anno[:id])
           graph_contains_statements(graph)
         end
-        it 'raises an argument error with a nil ID' do
-          expect{tc.get_annotation(nil)}.to raise_error(ArgumentError)
+        it 'returns empty graph and logs exception with a nil ID' do
+          invalid_annotation_id(nil)
         end
-        it 'raises an argument error with an integer ID' do
-          expect{tc.get_annotation(0)}.to raise_error(ArgumentError)
+        it 'returns empty graph and logs exception with an integer ID' do
+          invalid_annotation_id(0)
         end
-        it 'raises an argument error with an empty string ID' do
-          expect{tc.get_annotation('')}.to raise_error(ArgumentError)
+        it 'returns empty graph and logs exception with an empty string ID' do
+          invalid_annotation_id('')
         end
         it 'requests an open annotation by ID, using JSON-LD content' do
           jsonld = TriannonClient::TriannonClient::JSONLD_TYPE
@@ -254,6 +262,10 @@ describe 'TriannonClientREAD', :vcr do
       end # using default content type
 
       context 'using custom content type' do
+        it 'raises ArgumentError for unsupported content types' do
+          expect{tc.send(:check_content_type,'abc')}.to raise_error(ArgumentError)
+        end
+
         # Content types could be supported for RDF::Format.content_types.keys,
         # but not all of them are supported.  The supported content types for
         # triannon are defined in
@@ -268,6 +280,7 @@ describe 'TriannonClientREAD', :vcr do
         # xml as:     ["application/xml", "text/xml", "application/x-xml"]
         # html
 
+
         # The client supports any format in RDF::Format.content_types, so the
         # following are not included (as of July 2015):
         # "application/json"        => true,

data/triannon-client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'triannon-client'
-  s.version     = '0.5.0'
+  s.version     = '0.5.1'
   s.licenses    = ['Apache-2.0']
   s.platform    = Gem::Platform::RUBY
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: triannon-client
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Darren Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv