whos_got_dirt 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1deb94dc54c2ea9e2f8b61d0b92b772b6a1319cf
-  data.tar.gz: 9c699bef6687a839ec92aebfc24d16f8f9b65f85
+  metadata.gz: 84ee304532b79d4d989aeae5085c700d4e19ea84
+  data.tar.gz: 5c1a6022426e70affa41c335f7f2c8bbef978cb8
 SHA512:
-  metadata.gz: 17e0533d244d23aa69dd1459a4c1d8d8cede94f5e793d700c5f36d10fd24c5e3d1b9d7c6cba38fd23a946e7eb57e55ef00175224ca8b2cae0171dbdd272d2fe1
-  data.tar.gz: 28673a6d11fa8982803a02a148f9f3f9136005c31548af3dbda1b4083f40091bf842ab41f1ab5a80e4f29aa6bd22ed28b0f0f6dcd485706698cc9d28734a2a3b
+  metadata.gz: 4576f8a93268f16d22fd3bb717e6e6f2ecbdf10cde62b4955db5bbc1e737aee68b575b79ddbe37609bb3558def5a8046b6a6991fb777428444b8abf22d1a924a
+  data.tar.gz: 324bae3a7234a301cd920d3e3745f735d266b4f2c823b089199c9295bb1b3e236dbacf279cd800ea5baa0170960621075d4bfa35c6f4b3aa00aeac68af703ae2

data/lib/whos_got_dirt/requests/entity.rb

@@ -48,6 +48,9 @@ module WhosGotDirt
     #
     # @example Limit the number of results.
     #   "limit": 5
+    #
+    # @example Paginate the results.
+    #   "page": 2
     module Entity
     end
   end

data/lib/whos_got_dirt/requests/entity/corp_watch.rb

@@ -81,7 +81,8 @@ module WhosGotDirt
         # @see http://api.corpwatch.org/documentation/api_examples.html#A17
         def convert
           match('company_name', 'name')
-          equal('limit', 'limit')
+          equal('limit', 'limit') # default 100, maximum 5000
+          equal('index', 'page', transform: lambda{|v| (v - 1) * (input['limit'] || 100)})
 
           input['identifiers'] && input['identifiers'].each do |identifier|
             case identifier['scheme']

data/lib/whos_got_dirt/requests/entity/little_sis.rb

@@ -38,7 +38,8 @@ module WhosGotDirt
         def convert
           match('q', 'name')
           one_of('type_ids', 'classification')
-          equal('num', 'limit')
+          equal('num', 'limit') # default 20, maximum 1000?
+          equal('page', 'page')
 
           # API-specific parameters.
           equal('_key', 'little_sis_api_key')

data/lib/whos_got_dirt/requests/entity/open_corporates.rb

@@ -78,7 +78,8 @@ module WhosGotDirt
           equal('created_since', 'created_at>=')
           date_range('incorporation_date', 'founding_date')
           date_range('dissolution_date', 'dissolution_date')
-          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100)
+          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100) # default 30, maximum 100
+          equal('page', 'page')
 
           input['contact_details'] && input['contact_details'].each do |contact_detail|
             if contact_detail['type'] == 'address' && (contact_detail['value'] || contact_detail['value~='])

data/lib/whos_got_dirt/requests/list.rb

@@ -10,6 +10,9 @@ module WhosGotDirt
     #
     # @example Limit the number of results.
     #   "limit": 5
+    #
+    # @example Paginate the results.
+    #   "page": 2
     module List
     end
   end

data/lib/whos_got_dirt/requests/list/little_sis.rb

@@ -24,7 +24,8 @@ module WhosGotDirt
         # @see http://api.littlesis.org/documentation#lists
         def convert
           match('q', 'name')
-          equal('num', 'limit')
+          equal('num', 'limit') # default 100, maximum 100
+          equal('page', 'page')
 
           # API-specific parameters.
           equal('_key', 'little_sis_api_key')

data/lib/whos_got_dirt/requests/list/open_corporates.rb

@@ -23,7 +23,8 @@ module WhosGotDirt
         # @see https://api.opencorporates.com/documentation/API-Reference
         def convert
           match('q', 'name')
-          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100)
+          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100) # default 30, maximum 100
+          equal('page', 'page')
 
           # API-specific parameters.
           equal('api_token', 'open_corporates_api_key')

data/lib/whos_got_dirt/requests/relation.rb

@@ -45,6 +45,9 @@ module WhosGotDirt
     #
     # @example Limit the number of results.
     #   "limit": 5
+    #
+    # @example Paginate the results.
+    #   "page": 2
     module Relation
     end
   end

data/lib/whos_got_dirt/requests/relation/open_corporates.rb

@@ -45,7 +45,8 @@ module WhosGotDirt
         # @return [Hash] API-specific parameters
         # @see https://api.opencorporates.com/documentation/API-Reference
         def convert
-          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100)
+          equal('per_page', 'limit', default: input['open_corporates_api_key'] && 100) # default 30, maximum 100
+          equal('page', 'page')
 
           input['subject'] && input['subject'].each do |subject|
             match('q', 'name', input: subject)

data/lib/whos_got_dirt/requests/relation/open_oil.rb

@@ -29,7 +29,8 @@ module WhosGotDirt
         # @return [Hash] API-specific parameters
         # @see http://openoil.net/openoil-api/
         def convert
-          equal('per_page', 'limit')
+          equal('per_page', 'limit') # default 100, no maximum
+          equal('page', 'page')
 
           input['subject'] && input['subject'].each do |subject|
             equal('licensee', 'name', input: subject) # doesn't work, upstream bug

data/lib/whos_got_dirt/responses/entity/corp_watch.rb

@@ -62,8 +62,12 @@ module WhosGotDirt
         #
         # @return [Array<Hash>] the results
         def to_a
-          parsed_body['result']['companies'].map do |_,data|
-            Result.new('Entity', renderer.result(data), self).finalize!
+          if parsed_body['result']['companies']
+            parsed_body['result']['companies'].map do |_,data|
+              Result.new('Entity', renderer.result(data), self).finalize!
+            end
+          else
+            []
           end
         end
 
@@ -74,7 +78,7 @@ module WhosGotDirt
         def item_url(result)
           query = CGI.parse(env.url.query.to_s)
           url = "#{env.url.scheme}://#{env.url.host}#{env.url.path.sub(/\.json\z/, '')}/#{result['identifiers'][0]['identifier']}.json"
-          if query['key']
+          if query['key'].any?
             url += "?key=#{CGI.escape(query['key'][0].to_s)}"
           end
           url

data/lib/whos_got_dirt/responses/entity/little_sis.rb

@@ -56,7 +56,11 @@ module WhosGotDirt
         #
         # @return [Array<Hash>] the results
         def to_a
-          parsed_body['Data']['Entities']['Entity'].map do |data|
+          list = parsed_body['Data']['Entities']['Entity']
+          if Hash === list
+            list = [list]
+          end
+          list.map do |data|
             Result.new('Entity', renderer.result(data), self).finalize!
           end
         end

data/lib/whos_got_dirt/responses/entity/open_corporates.rb

@@ -12,10 +12,10 @@ module WhosGotDirt
           'founding_date' => '/incorporation_date',
           'dissolution_date' => '/dissolution_date',
           'other_names' => [{
-            'name' => '/previous_names/company_name',
-            'start_date' => '/previous_names/start_date',
-            'end_date' => '/previous_names/end_date',
-            'note' => '/previous_names/type',
+            'name' => '/previous_names/0/company_name',
+            'start_date' => '/previous_names/0/start_date',
+            'end_date' => '/previous_names/0/end_date',
+            'note' => '/previous_names/0/type',
           }],
           'identifiers' => [{
             'identifier' => '/company_number',
@@ -64,7 +64,7 @@ module WhosGotDirt
         def item_url(result)
           query = CGI.parse(env.url.query.to_s)
           url = "#{env.url.scheme}://#{env.url.host}/companies/#{result['jurisdiction_code']}/#{result['identifiers'][0]['identifier']}"
-          if query['api_token']
+          if query['api_token'].any?
             url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
           end
           url

data/lib/whos_got_dirt/responses/list/little_sis.rb

@@ -32,7 +32,11 @@ module WhosGotDirt
         #
         # @return [Array<Hash>] the results
         def to_a
-          parsed_body['Data']['Lists']['List'].map do |data|
+          list = parsed_body['Data']['Lists']['List']
+          if Hash === list
+            list = [list]
+          end
+          list.map do |data|
             Result.new('List', renderer.result(data), self).finalize!
           end
         end

data/lib/whos_got_dirt/responses/list/open_corporates.rb

@@ -36,7 +36,7 @@ module WhosGotDirt
         def item_url(result)
           query = CGI.parse(env.url.query.to_s)
           url = "#{env.url.scheme}://#{env.url.host}/corporate_groupings/#{CGI.escape(result['name'].to_s)}"
-          if query['api_token']
+          if query['api_token'].any?
             url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
           end
           url

data/lib/whos_got_dirt/responses/relation/open_corporates.rb

@@ -68,7 +68,7 @@ module WhosGotDirt
         def item_url(result)
           query = CGI.parse(env.url.query.to_s)
           url = "#{env.url.scheme}://#{env.url.host}/officers/#{result['identifiers'][0]['identifier']}"
-          if query['api_token']
+          if query['api_token'].any?
             url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
           end
           url

data/lib/whos_got_dirt/version.rb

@@ -1,3 +1,3 @@
 module WhosGotDirt
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/requests/entity/corp_watch_spec.rb

@@ -17,6 +17,10 @@ module WhosGotDirt::Requests::Entity
         include_examples 'equal', 'limit', 'limit', 5
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'index', 'page', 2, transformed: 100
+      end
+
       context 'when given an IRS identifier' do
         it 'should return a criterion' do
           expect(CorpWatch.new({

data/spec/requests/entity/little_sis_spec.rb

@@ -21,6 +21,10 @@ module WhosGotDirt::Requests::Entity
         include_examples 'equal', 'num', 'limit', 5
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         include_examples 'equal', '_key', 'little_sis_api_key', 123
       end

data/spec/requests/entity/open_corporates_spec.rb

@@ -43,6 +43,10 @@ module WhosGotDirt::Requests::Entity
         end
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         it 'should return an API key parameter' do
           expect(OpenCorporates.new('open_corporates_api_key' => 123).convert).to eq('api_token' => 123, 'per_page' => 100)

data/spec/requests/list/little_sis_spec.rb

@@ -17,6 +17,10 @@ module WhosGotDirt::Requests::List
         include_examples 'equal', 'num', 'limit', 5
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         include_examples 'equal', '_key', 'little_sis_api_key', 123
       end

data/spec/requests/list/open_corporates_spec.rb

@@ -23,6 +23,10 @@ module WhosGotDirt::Requests::List
         end
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         it 'should return an API key parameter' do
           expect(OpenCorporates.new('open_corporates_api_key' => 123).convert).to eq('api_token' => 123, 'per_page' => 100)

data/spec/requests/relation/open_corporates_spec.rb

@@ -31,6 +31,10 @@ module WhosGotDirt::Requests::Relation
         end
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         it 'should return an API key parameter' do
           expect(OpenCorporates.new('open_corporates_api_key' => 123).convert).to eq('api_token' => 123, 'per_page' => 100)

data/spec/requests/relation/open_oil_spec.rb

@@ -17,6 +17,10 @@ module WhosGotDirt::Requests::Relation
         include_examples 'equal', 'per_page', 'limit', 5
       end
 
+      context 'when given a page' do
+        include_examples 'equal', 'page', 'page', 2
+      end
+
       context 'when given an API key' do
         include_examples 'equal', 'apikey', 'open_oil_api_key', 123
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whos_got_dirt
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - James McKinney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport