whos_got_dirt 0.0.2 → 0.0.3

data/spec/cassettes/little_sis_entity_error.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.littlesis.org/entities.xml?q=bar
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      server:
+      - cloudflare-nginx
+      date:
+      - Sun, 10 Jan 2016 23:54:18 GMT
+      content-type:
+      - text/html; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - __cfduid=d0a1f180fbcab07f10a20a0e51d9152601452470058; expires=Mon, 09-Jan-17
+        23:54:18 GMT; path=/; domain=.littlesis.org; HttpOnly, symfony=rjsiompvljpg9goqudp16ina83;
+        path=/
+      x-powered-by:
+      - PHP/5.5.9-1ubuntu4.6
+      expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma:
+      - no-cache
+      www-authenticate:
+      - Your request must include a query parameter named "_key" with a valid API
+        key value. To obtain an API key, visit http://api.littlesis.org/register
+      vary:
+      - Accept-Encoding
+      access-control-allow-origin:
+      - "*"
+      cf-ray:
+      - 262c4e69e5463fa7-YUL
+    body:
+      encoding: UTF-8
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <Response>
+        Your request must include a query parameter named "_key" with a valid API key value. To obtain an API key, visit http://api.littlesis.org/register.
+        </Response>
+    http_version: 
+  recorded_at: Sun, 10 Jan 2016 23:54:18 GMT
+recorded_with: VCR 3.0.1

data/spec/cassettes/little_sis_list_error.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.littlesis.org/lists.xml?q=united
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+  response:
+    status:
+      code: 401
+      message: 
+    headers:
+      server:
+      - cloudflare-nginx
+      date:
+      - Sun, 10 Jan 2016 23:54:54 GMT
+      content-type:
+      - text/html; charset=utf-8
+      transfer-encoding:
+      - chunked
+      connection:
+      - close
+      set-cookie:
+      - __cfduid=df94c524808fd39878295eeaf1d4bd7c81452470094; expires=Mon, 09-Jan-17
+        23:54:54 GMT; path=/; domain=.littlesis.org; HttpOnly, symfony=q9culrvo85c6qrk56or8vo0eq3;
+        path=/
+      x-powered-by:
+      - PHP/5.5.9-1ubuntu4.6
+      expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      cache-control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      pragma:
+      - no-cache
+      www-authenticate:
+      - Your request must include a query parameter named "_key" with a valid API
+        key value. To obtain an API key, visit http://api.littlesis.org/register
+      vary:
+      - Accept-Encoding
+      access-control-allow-origin:
+      - "*"
+      cf-ray:
+      - 262c4f4b1d493fa1-YUL
+    body:
+      encoding: UTF-8
+      string: |-
+        <?xml version="1.0" encoding="UTF-8"?>
+        <Response>
+        Your request must include a query parameter named "_key" with a valid API key value. To obtain an API key, visit http://api.littlesis.org/register.
+        </Response>
+    http_version: 
+  recorded_at: Sun, 10 Jan 2016 23:54:54 GMT
+recorded_with: VCR 3.0.1

data/spec/cassettes/open_duka_entity_error.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://www.openduka.org/index.php/api/search?term=the
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      date:
+      - Mon, 11 Jan 2016 01:50:10 GMT
+      server:
+      - Apache
+      set-cookie:
+      - ci_session=a%3A5%3A%7Bs%3A10%3A%22session_id%22%3Bs%3A32%3A%225ee5f19c568590f29ec547cf0cbb15fc%22%3Bs%3A10%3A%22ip_address%22%3Bs%3A14%3A%22198.48.204.118%22%3Bs%3A10%3A%22user_agent%22%3Bs%3A14%3A%22Faraday+v0.9.1%22%3Bs%3A13%3A%22last_activity%22%3Bi%3A1452477010%3Bs%3A9%3A%22user_data%22%3Bs%3A0%3A%22%22%3B%7Da4e6d71e7310fa2b434a1efda6aa9267;
+        expires=Mon, 11-Jan-2016 03:50:10 GMT; Max-Age=7200; path=/
+      vary:
+      - Accept-Encoding
+      content-length:
+      - '62'
+      connection:
+      - close
+      content-type:
+      - text/html
+    body:
+      encoding: ASCII-8BIT
+      string: '{"error":"missing key and or search term"}'
+    http_version: 
+  recorded_at: Mon, 11 Jan 2016 01:50:11 GMT
+recorded_with: VCR 3.0.1

data/spec/response_spec.rb

@@ -11,9 +11,9 @@ module WhosGotDirt
         end
 
         @template = {
-          '@type' => 'Person',
-          'id' => 123,
+          '@type' => 'Entity',
           'name' => '/fn',
+          'birth_date' => 2015,
           'identifiers' => [{
             'identifier' => '/id',
             'scheme' => 'ACME',
@@ -26,16 +26,20 @@ module WhosGotDirt
 
         def to_a
           parsed_body.map do |data|
-            Result.new('Person', renderer.result(data), self).finalize!
+            Result.new('Entity', renderer.result(data), self).finalize!
           end
         end
       end
     end
 
+    let :body do
+      '[{"fn":"John Smith","id":"john-smith"},{"fn":"John Aaron Smith","id":"john-aaron-smith"}]'
+    end
+
     let :response do
       env = Faraday::Env.new
       env.url = 'https://api.example.com/endpoint?name~=John+Smith'
-      env.body = '[{"fn":"John Smith","id":"john-smith"},{"fn":"John Aaron Smith","id":"john-aaron-smith"}]'
+      env.body = body
       Faraday::Response.new(env)
     end
 
@@ -45,9 +49,9 @@ module WhosGotDirt
 
     let :template do
       {
-        '@type' => 'Person',
-        'id' => 123,
+        '@type' => 'Entity',
         'name' => '/fn',
+        'birth_date' => 2015,
         'identifiers' => [{
           'identifier' => '/id',
           'scheme' => 'ACME',
@@ -89,9 +93,9 @@ module WhosGotDirt
     describe '#to_a' do
       it 'should return the results' do
         expect(instance.to_a).to eq([{
-          '@type' => 'Person',
-          'id' => '123',
+          '@type' => 'Entity',
           'name' => 'John Smith',
+          'birth_date' => '2015',
           'identifiers' => [{
             'identifier' => 'john-smith',
             'scheme' => 'ACME',
@@ -101,9 +105,9 @@ module WhosGotDirt
             'note' => 'MyResponse',
           }],
         }, {
-          '@type' => 'Person',
-          'id' => '123',
+          '@type' => 'Entity',
           'name' => 'John Aaron Smith',
+          'birth_date' => '2015',
           'identifiers' => [{
             'identifier' => 'john-aaron-smith',
             'scheme' => 'ACME',
@@ -115,5 +119,11 @@ module WhosGotDirt
         }])
       end
     end
+
+    describe '#error_message' do
+      it 'should return the parsed response body' do
+        expect(instance.error_message).to eq(body)
+      end
+    end
   end
 end

data/spec/responses/entity/little_sis_spec.rb

@@ -1,30 +1,48 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 module WhosGotDirt::Responses::Entity
-  RSpec.describe LittleSis, vcr: {cassette_name: 'little_sis_entity'} do
-    let :response do
-      Faraday.get("https://api.littlesis.org/entities.xml?q=bar&_key=#{ENV['LITTLE_SIS_API_KEY']}")
-    end
+  RSpec.describe LittleSis do
+    context 'when successful', vcr: {cassette_name: 'little_sis_entity'} do
+      let :response do
+        Faraday.get("https://api.littlesis.org/entities.xml?q=bar&_key=#{ENV['LITTLE_SIS_API_KEY']}")
+      end
 
-    let :instance do
-      LittleSis.new(response)
-    end
+      let :instance do
+        LittleSis.new(response)
+      end
 
-    describe '#to_a' do
-      it 'should return the results' do
-        expect{instance.to_a}.to_not raise_error
+      describe '#to_a' do
+        it 'should return the results' do
+          expect{instance.to_a}.to_not raise_error
+        end
       end
-    end
 
-    describe '#count' do
-      it 'should return the number of results' do
-        expect(instance.count).to be > 1_000
+      describe '#count' do
+        it 'should return the number of results' do
+          expect(instance.count).to be > 1_000
+        end
+      end
+
+      describe '#page' do
+        it 'should return the current page number' do
+          expect(instance.page).to eq(1)
+        end
       end
     end
 
-    describe '#page' do
-      it 'should return the current page number' do
-        expect(instance.page).to eq(1)
+    context 'when unsuccessful', vcr: {cassette_name: 'little_sis_entity_error'} do
+      let :response do
+        Faraday.get("https://api.littlesis.org/entities.xml?q=bar")
+      end
+
+      let :instance do
+        LittleSis.new(response)
+      end
+
+      describe '#error_message' do
+        it 'should return the error message' do
+         expect(instance.error_message).to eq('Your request must include a query parameter named "_key" with a valid API key value. To obtain an API key, visit http://api.littlesis.org/register.')
+       end
       end
     end
   end

data/spec/responses/entity/open_duka_spec.rb

@@ -1,24 +1,42 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 module WhosGotDirt::Responses::Entity
-  RSpec.describe OpenDuka, vcr: {cassette_name: 'open_duka_entity'} do
-    let :response do
-      Faraday.get("http://www.openduka.org/index.php/api/search?term=the&key=#{ENV['OPEN_DUKA_API_KEY']}")
-    end
+  RSpec.describe OpenDuka do
+    context 'when successful', vcr: {cassette_name: 'open_duka_entity'} do
+      let :response do
+        Faraday.get("http://www.openduka.org/index.php/api/search?term=the&key=#{ENV['OPEN_DUKA_API_KEY']}")
+      end
 
-    let :instance do
-      OpenDuka.new(response)
-    end
+      let :instance do
+        OpenDuka.new(response)
+      end
+
+      describe '#to_a' do
+        it 'should return the results' do
+          expect{instance.to_a}.to_not raise_error
+        end
+      end
 
-    describe '#to_a' do
-      it 'should return the results' do
-        expect{instance.to_a}.to_not raise_error
+      describe '#count' do
+        it 'should return the number of results' do
+          expect(instance.count).to be > 1_000
+        end
       end
     end
 
-    describe '#count' do
-      it 'should return the number of results' do
-        expect(instance.count).to be > 1_000
+    context 'when unsuccessful', vcr: {cassette_name: 'open_duka_entity_error'} do
+      let :response do
+        Faraday.get("http://www.openduka.org/index.php/api/search?term=the")
+      end
+
+      let :instance do
+        OpenDuka.new(response)
+      end
+
+      describe '#error_message' do
+        it 'should return the error message' do
+         expect(instance.error_message).to eq('missing key and or search term')
+       end
       end
     end
   end

data/spec/responses/list/little_sis_spec.rb

@@ -1,30 +1,48 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
 module WhosGotDirt::Responses::List
-  RSpec.describe LittleSis, vcr: {cassette_name: 'little_sis_list'} do
-    let :response do
-      Faraday.get("https://api.littlesis.org/lists.xml?q=united&_key=#{ENV['LITTLE_SIS_API_KEY']}")
-    end
+  RSpec.describe LittleSis do
+    context 'when successful', vcr: {cassette_name: 'little_sis_list'} do
+      let :response do
+        Faraday.get("https://api.littlesis.org/lists.xml?q=united&_key=#{ENV['LITTLE_SIS_API_KEY']}")
+      end
 
-    let :instance do
-      LittleSis.new(response)
-    end
+      let :instance do
+        LittleSis.new(response)
+      end
 
-    describe '#to_a' do
-      it 'should return the results' do
-        expect{instance.to_a}.to_not raise_error
+      describe '#to_a' do
+        it 'should return the results' do
+          expect{instance.to_a}.to_not raise_error
+        end
       end
-    end
 
-    describe '#count' do
-      it 'should return the number of results' do
-        expect(instance.count).to be > 10
+      describe '#count' do
+        it 'should return the number of results' do
+          expect(instance.count).to be > 10
+        end
+      end
+
+      describe '#page' do
+        it 'should return the current page number' do
+          expect(instance.page).to eq(1)
+        end
       end
     end
 
-    describe '#page' do
-      it 'should return the current page number' do
-        expect(instance.page).to eq(1)
+    context 'when unsuccessful', vcr: {cassette_name: 'little_sis_list_error'} do
+      let :response do
+        Faraday.get("https://api.littlesis.org/lists.xml?q=united")
+      end
+
+      let :instance do
+        LittleSis.new(response)
+      end
+
+      describe '#error_message' do
+        it 'should return the error message' do
+         expect(instance.error_message).to eq('Your request must include a query parameter named "_key" with a valid API key value. To obtain an API key, visit http://api.littlesis.org/register.')
+       end
       end
     end
   end

data/spec/result_spec.rb

@@ -4,8 +4,8 @@ module WhosGotDirt
   RSpec.describe Result do
     let :result do
       {
-        'id' => 123,
         'name' => 'John Smith',
+        'birth_date' => 2015,
         'identifiers' => [{
           'scheme' => 'ACME',
         }, {
@@ -24,12 +24,12 @@ module WhosGotDirt
     end
 
     let :instance do
-      Result.new('Person', result, response)
+      Result.new('Entity', result, response)
     end
 
     describe '#initialize' do
       it 'should set the type, result and response' do
-        expect(instance.type).to eq('Person')
+        expect(instance.type).to eq('Entity')
         expect(instance.result).to eq(result)
         expect(instance.response).to eq(response)
       end
@@ -38,8 +38,8 @@ module WhosGotDirt
     describe '#add_source!' do
       it 'should add a source to a result' do
         expect(instance.add_source!).to eq({
-          'id' => 123,
           'name' => 'John Smith',
+          'birth_date' => 2015,
           'identifiers' => [{
             'scheme' => 'ACME',
           }, {
@@ -58,8 +58,8 @@ module WhosGotDirt
     describe 'validate!' do
       it 'should validate the result' do
         expect(instance.validate!).to eq({
-          'id' => '123',
           'name' => 'John Smith',
+          'birth_date' => '2015',
           'identifiers' => [{
             'identifier' => 'john-smith',
           }],
@@ -74,8 +74,8 @@ module WhosGotDirt
     describe '#finalize!' do
       it 'should finalize the result' do
         expect(instance.finalize!).to eq({
-          'id' => '123',
           'name' => 'John Smith',
+          'birth_date' => '2015',
           'identifiers' => [{
             'identifier' => 'john-smith',
           }],