whos_got_dirt 0.0.2

data/spec/requests/relation/open_oil_spec.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Requests::Relation
+  RSpec.describe OpenOil do
+    describe '#to_s' do
+      it 'should return the URL to request' do
+        expect(OpenOil.new(subject: [name: 'Petrobras']).to_s).to eq('https://api.openoil.net/concession/search?licensee=Petrobras')
+      end
+    end
+
+    describe '#convert' do
+      context 'when given a name' do
+        include_examples 'equal', 'licensee', 'name', 'Petrobras', scope: 'subject'
+      end
+
+      context 'when given a limit' do
+        include_examples 'equal', 'per_page', 'limit', 5
+      end
+
+      context 'when given an API key' do
+        include_examples 'equal', 'apikey', 'open_oil_api_key', 123
+      end
+
+      context 'when given a country' do
+        include_examples 'equal', 'country', 'country_code', 'br', transformed: 'BR'
+      end
+
+      context 'when given a status' do
+        include_examples 'equal', 'status', 'status', 'licensed', valid: ['licensed', 'unlicensed']
+      end
+
+      context 'when given a type' do
+        include_examples 'equal', 'type', 'type', 'offshore', valid: ['offshore', 'onshore']
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,119 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module WhosGotDirt
+  RSpec.describe Response do
+    let :klass do
+      Class.new(Response) do
+        class << self
+          def name
+            'MyResponse'
+          end
+        end
+
+        @template = {
+          '@type' => 'Person',
+          'id' => 123,
+          'name' => '/fn',
+          'identifiers' => [{
+            'identifier' => '/id',
+            'scheme' => 'ACME',
+          }]
+        }
+
+        def parse_body
+          JSON.load(body)
+        end
+
+        def to_a
+          parsed_body.map do |data|
+            Result.new('Person', renderer.result(data), self).finalize!
+          end
+        end
+      end
+    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"}]'
+      Faraday::Response.new(env)
+    end
+
+    let :instance do
+      klass.new(response)
+    end
+
+    let :template do
+      {
+        '@type' => 'Person',
+        'id' => 123,
+        'name' => '/fn',
+        'identifiers' => [{
+          'identifier' => '/id',
+          'scheme' => 'ACME',
+        }]
+      }
+    end
+
+    let :parsed_body do
+      [
+        {'fn' => 'John Smith', 'id' => 'john-smith'},
+        {'fn' => 'John Aaron Smith', 'id' => 'john-aaron-smith'},
+      ]
+    end
+
+    describe '.template' do
+      it 'should return the template' do
+        expect(klass.template).to eq(template)
+      end
+    end
+
+    describe '#renderer' do
+      it 'should return the renderer' do
+        expect(instance.renderer.template).to eq(template)
+      end
+    end
+
+    describe '#parsed_body' do
+      it 'should return the parsed response body' do
+        expect(instance.parsed_body).to eq(parsed_body)
+      end
+    end
+
+    describe '#parse_body' do
+      it 'should return the parsed response body' do
+        expect(instance.parse_body).to eq(parsed_body)
+      end
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect(instance.to_a).to eq([{
+          '@type' => 'Person',
+          'id' => '123',
+          'name' => 'John Smith',
+          'identifiers' => [{
+            'identifier' => 'john-smith',
+            'scheme' => 'ACME',
+          }],
+          'sources' => [{
+            'url' => 'https://api.example.com/endpoint?name~=John+Smith',
+            'note' => 'MyResponse',
+          }],
+        }, {
+          '@type' => 'Person',
+          'id' => '123',
+          'name' => 'John Aaron Smith',
+          'identifiers' => [{
+            'identifier' => 'john-aaron-smith',
+            'scheme' => 'ACME',
+          }],
+          'sources' => [{
+            'url' => 'https://api.example.com/endpoint?name~=John+Smith',
+            'note' => 'MyResponse',
+          }],
+        }])
+      end
+    end
+  end
+end

data/spec/responses/entity/corp_watch_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::Entity
+  RSpec.describe CorpWatch, vcr: {cassette_name: 'corp_watch_entity'} do
+    let :response do
+      Faraday.get("http://api.corpwatch.org/companies.json?company_name=bank&key=#{ENV['CORP_WATCH_API_KEY']}")
+    end
+
+    let :instance do
+      CorpWatch.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 3_000
+      end
+    end
+
+    describe '#index' do
+      it 'should return the current index' do
+        expect(instance.index).to eq(0)
+      end
+    end
+  end
+end

data/spec/responses/entity/little_sis_spec.rb

@@ -0,0 +1,31 @@
+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
+
+    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
+      end
+    end
+
+    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
+end

data/spec/responses/entity/open_corporates_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::Entity
+  RSpec.describe OpenCorporates, vcr: {cassette_name: 'open_corporates_entity'} do
+    let :response do
+      Faraday.get('https://api.opencorporates.com/companies/search')
+    end
+
+    let :instance do
+      OpenCorporates.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 80_000_000
+      end
+    end
+
+    describe '#page' do
+      it 'should return the current page number' do
+        expect(instance.page).to eq(1)
+      end
+    end
+  end
+end

data/spec/responses/entity/open_duka_spec.rb

@@ -0,0 +1,25 @@
+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
+
+    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 '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 1_000
+      end
+    end
+  end
+end

data/spec/responses/entity/poderopedia_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::Entity
+  RSpec.describe Poderopedia, vcr: {cassette_name: 'poderopedia_entity'} do
+    let :response do
+      Faraday.get("http://api.poderopedia.org/visualizacion/search?alias=juan&entity=persona&user_key=#{ENV['PODEROPEDIA_API_KEY']}")
+    end
+
+    let :instance do
+      Poderopedia.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to eq(10)
+      end
+    end
+  end
+end

data/spec/responses/list/little_sis_spec.rb

@@ -0,0 +1,31 @@
+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
+
+    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
+      end
+    end
+
+    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
+end

data/spec/responses/list/open_corporates_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::List
+  RSpec.describe OpenCorporates, vcr: {cassette_name: 'open_corporates_list'} do
+    let :response do
+      Faraday.get('https://api.opencorporates.com/corporate_groupings/search')
+    end
+
+    let :instance do
+      OpenCorporates.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 800
+      end
+    end
+
+    describe '#page' do
+      it 'should return the current page number' do
+        expect(instance.page).to eq(1)
+      end
+    end
+  end
+end

data/spec/responses/relation/open_corporates_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::Relation
+  RSpec.describe OpenCorporates, vcr: {cassette_name: 'open_corporates_relation'} do
+    let :response do
+      Faraday.get('https://api.opencorporates.com/officers/search')
+    end
+
+    let :instance do
+      OpenCorporates.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 100_000_000
+      end
+    end
+
+    describe '#page' do
+      it 'should return the current page number' do
+        expect(instance.page).to eq(1)
+      end
+    end
+  end
+end

data/spec/responses/relation/open_oil_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+module WhosGotDirt::Responses::Relation
+  RSpec.describe OpenOil, vcr: {cassette_name: 'open_oil_relation'} do
+    let :response do
+      Faraday.get("https://api.openoil.net/concession/search?apikey=#{ENV['OPEN_OIL_API_KEY']}")
+    end
+
+    let :instance do
+      OpenOil.new(response)
+    end
+
+    describe '#to_a' do
+      it 'should return the results' do
+        expect{instance.to_a}.to_not raise_error
+      end
+    end
+
+    describe '#count' do
+      it 'should return the number of results' do
+        expect(instance.count).to be > 10_000
+      end
+    end
+
+    describe '#page' do
+      it 'should return the current page number' do
+        expect(instance.page).to eq(1)
+      end
+    end
+  end
+end

data/spec/result_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module WhosGotDirt
+  RSpec.describe Result do
+    let :result do
+      {
+        'id' => 123,
+        'name' => 'John Smith',
+        'identifiers' => [{
+          'scheme' => 'ACME',
+        }, {
+          'identifier' => 'john-smith',
+        }, {
+          'scheme' => 'ACME',
+        }],
+      }
+    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"}]'
+      Faraday::Response.new(env)
+    end
+
+    let :instance do
+      Result.new('Person', result, response)
+    end
+
+    describe '#initialize' do
+      it 'should set the type, result and response' do
+        expect(instance.type).to eq('Person')
+        expect(instance.result).to eq(result)
+        expect(instance.response).to eq(response)
+      end
+    end
+
+    describe '#add_source!' do
+      it 'should add a source to a result' do
+        expect(instance.add_source!).to eq({
+          'id' => 123,
+          'name' => 'John Smith',
+          'identifiers' => [{
+            'scheme' => 'ACME',
+          }, {
+            'identifier' => 'john-smith',
+          }, {
+            'scheme' => 'ACME',
+          }],
+          'sources' => [{
+            'url' => 'https://api.example.com/endpoint?name~=John+Smith',
+            'note' => 'Response',
+          }],
+        })
+      end
+    end
+
+    describe 'validate!' do
+      it 'should validate the result' do
+        expect(instance.validate!).to eq({
+          'id' => '123',
+          'name' => 'John Smith',
+          'identifiers' => [{
+            'identifier' => 'john-smith',
+          }],
+        })
+      end
+
+      it 'should raise an error if validation is strict' do
+        expect{instance.validate!(strict: true)}.to raise_error(ValidationError)
+      end
+    end
+
+    describe '#finalize!' do
+      it 'should finalize the result' do
+        expect(instance.finalize!).to eq({
+          'id' => '123',
+          'name' => 'John Smith',
+          'identifiers' => [{
+            'identifier' => 'john-smith',
+          }],
+          'sources' => [{
+            'url' => 'https://api.example.com/endpoint?name~=John+Smith',
+            'note' => 'Response',
+          }],
+        })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :faraday
+  c.configure_rspec_metadata!
+end
+
+require 'rspec'
+require 'faraday'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f}
+require File.dirname(__FILE__) + '/../lib/whos_got_dirt'