triannon-client 0.3.0 → 0.4.0

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

@@ -139,51 +139,76 @@ describe TriannonClient, :vcr do
   end
 
   describe "#delete_annotation" do
-    def test_delete_for_response_code(status, response)
+    def test_delete_for_response_code(anno_id, status, response)
       allow_any_instance_of(RestClient::Response).to receive(:code).and_return(status)
-      expect(tc.delete_annotation('anything_here_is_OK')).to be response
+      expect(tc.delete_annotation(anno_id)).to be response
     end
-    it "returns false for a 500 response to a DELETE request" do
-      test_delete_for_response_code(500, false)
+    it "returns FALSE for a 500 response to a DELETE request" do
+      test_delete_for_response_code('500_is_false', 500, false)
     end
-    it "returns true for a 200 response to a DELETE request" do
-      test_delete_for_response_code(200, true)
+    it "returns TRUE for a 200 response to a DELETE request" do
+      test_delete_for_response_code('200_is_true', 200, true)
     end
-    it "returns true for a 202 response to a DELETE request" do
-      test_delete_for_response_code(202, true)
+    it "returns TRUE for a 202 response to a DELETE request" do
+      test_delete_for_response_code('202_is_true', 202, true)
     end
-    it "returns true for a 204 response to a DELETE request" do
-      test_delete_for_response_code(204, true)
+    it "returns TRUE for a 204 response to a DELETE request" do
+      test_delete_for_response_code('204_is_true', 204, true)
+    end
+    it "returns TRUE for a 404 response to a DELETE request" do
+      test_delete_for_response_code('404_is_true', 404, true)
+    end
+    it "returns TRUE for a 410 response to a DELETE request" do
+      test_delete_for_response_code('410_is_true', 410, true)
     end
     it 'validates the annotation ID' do
       expect(tc).to receive(:check_id)
-      tc.delete_annotation('anything_here_is_OK')
+      tc.delete_annotation('checking_anno_id')
+    end
+    it 'quits after detecting an invalid annotation ID' do
+      expect_any_instance_of(RestClient::Resource).not_to receive(:delete)
+      tc.delete_annotation('') rescue nil
+      tc.delete_annotation(nil) rescue nil
+    end
+    it 'uses RestClient::Resource.delete to DELETE a valid annotation ID' do
+      expect_any_instance_of(RestClient::Resource).to receive(:delete)
+      tc.delete_annotation(SecureRandom.uuid)
     end
-    it 'deletes an open annotation that exists' do
+    it 'returns TRUE when deleting an open annotation that exists' do
       anno = create_annotation
       expect( tc.delete_annotation(anno[:id]) ).to be true
       graph = tc.get_annotation(anno[:id])
       graph_is_empty(graph)
     end
-    it 'fails to delete an open annotation that does NOT exist' do
+    it 'returns TRUE when deleting an open annotation that does NOT exist' do
       id = 'anno_does_not_exist'
       graph = tc.get_annotation(id)
       graph_is_empty(graph)
-      expect( tc.delete_annotation(id) ).to be false
+      expect( tc.delete_annotation(id) ).to be true
     end
     it 'logs exceptions' do
-      allow_any_instance_of(RestClient::Resource).to receive(:delete).and_raise('delete_exception')
-      expect(TriannonClient.configuration.logger).to receive(:error).with(/delete_exception/)
-      tc.delete_annotation('raise_delete_exception')
-    end
-    it 'quits after detecting an invalid annotation ID' do
-      expect_any_instance_of(RestClient::Resource).not_to receive(:delete)
-      tc.delete_annotation('') rescue nil
-      tc.delete_annotation(nil) rescue nil
-    end
-    it 'uses RestClient::Resource.delete to DELETE a valid annotation ID' do
-      expect_any_instance_of(RestClient::Resource).to receive(:delete)
-      tc.delete_annotation(SecureRandom.uuid)
+      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)
+      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)
+      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)
+      expect(TriannonClient.configuration.logger).not_to receive(:error)
+      tc.delete_annotation('delete_does_not_log_410_exceptions')
     end
   end
 
@@ -453,6 +478,22 @@ describe TriannonClient, :vcr do
       expect(r).to respond_to(:headers)
       delete_annotation(anno[:id]) # cleanup after create_annotation
     end
+    it 'logs exceptions for RestClient::Exception' do
+      exception_response = double()
+      allow(exception_response).to receive(:code).and_return(500)
+      allow(exception_response).to receive(:body).and_return('post_logs_exceptions')
+      allow_any_instance_of(RestClient::Exception).to receive(:response).and_return(exception_response)
+      expect(TriannonClient.configuration.logger).to receive(:error).with(/post_logs_exceptions/)
+      tc.post_annotation('post_logs_exceptions')
+    end
+    it 'logs exceptions' do
+      exception_response = double()
+      allow(exception_response).to receive(:code).and_return(500)
+      allow(exception_response).to receive(:body).and_return('post_logs_exceptions')
+      allow_any_instance_of(RestClient::Exception).to receive(:response).and_return(exception_response)
+      expect(TriannonClient.configuration.logger).to receive(:error).with(/post_logs_exceptions/)
+      tc.post_annotation('post_logs_exceptions')
+    end
   end
 
 

data/triannon-client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'triannon-client'
-  s.version     = '0.3.0'
+  s.version     = '0.4.0'
   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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Darren Weber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -252,17 +252,24 @@ files:
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_iiif_annotation/returns_an_RDF_Graph_of_an_open_annotation.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_oa_annotation/requests_an_open_annotation_by_ID_using_an_OA_profile.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_oa_annotation/returns_an_RDF_Graph_of_an_open_annotation.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/deletes_an_open_annotation_that_exists.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/fails_to_delete_an_open_annotation_that_does_NOT_exist.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_false_for_a_500_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_200_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_202_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_204_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/does_not_log_exceptions_for_missing_annotations_404_responses_.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/does_not_log_exceptions_for_missing_annotations_410_responses_.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/logs_exceptions.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_FALSE_for_a_500_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_200_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_202_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_204_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_404_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_410_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_when_deleting_an_open_annotation_that_does_NOT_exist.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_when_deleting_an_open_annotation_that_exists.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/validates_the_annotation_ID.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_RDF_Graph.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_RDF_Graph_that_contains_an_AnnotationList.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_annotation_list_with_an_annotation_created_by_a_prior_POST.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/does_not_raise_an_error_when_submitting_a_valid_open_annotation.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/logs_exceptions.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/logs_exceptions_for_RestClient_Exception.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/returns_a_RestClient_Response_object.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/response_processing_utilities/_annotation_id/returns_a_String_ID_from_the_RDF_URI_of_an_annotation.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/response_processing_utilities/_annotation_id/returns_a_String_ID_that_is_not_empty.yml
@@ -349,17 +356,24 @@ test_files:
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_iiif_annotation/returns_an_RDF_Graph_of_an_open_annotation.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_oa_annotation/requests_an_open_annotation_by_ID_using_an_OA_profile.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/GET_annotation_by_ID_/_get_oa_annotation/returns_an_RDF_Graph_of_an_open_annotation.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/deletes_an_open_annotation_that_exists.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/fails_to_delete_an_open_annotation_that_does_NOT_exist.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_false_for_a_500_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_200_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_202_response_to_a_DELETE_request.yml
-- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_true_for_a_204_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/does_not_log_exceptions_for_missing_annotations_404_responses_.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/does_not_log_exceptions_for_missing_annotations_410_responses_.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/logs_exceptions.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_FALSE_for_a_500_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_200_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_202_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_204_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_404_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_for_a_410_response_to_a_DELETE_request.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_when_deleting_an_open_annotation_that_does_NOT_exist.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/returns_TRUE_when_deleting_an_open_annotation_that_exists.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_delete_annotation/validates_the_annotation_ID.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_RDF_Graph.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_RDF_Graph_that_contains_an_AnnotationList.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_get_annotations/returns_an_annotation_list_with_an_annotation_created_by_a_prior_POST.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/does_not_raise_an_error_when_submitting_a_valid_open_annotation.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/logs_exceptions.yml
+- spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/logs_exceptions_for_RestClient_Exception.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/_post_annotation/returns_a_RestClient_Response_object.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/response_processing_utilities/_annotation_id/returns_a_String_ID_from_the_RDF_URI_of_an_annotation.yml
 - spec/fixtures/vcr_cassettes/TriannonClient/response_processing_utilities/_annotation_id/returns_a_String_ID_that_is_not_empty.yml