whos_got_dirt 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 063529b54e6a2c0acb0ab21f1eb44bce5683afe8
-  data.tar.gz: 428acf538ee358d701565695ca601078ba6db10b
+  metadata.gz: 1deb94dc54c2ea9e2f8b61d0b92b772b6a1319cf
+  data.tar.gz: 9c699bef6687a839ec92aebfc24d16f8f9b65f85
 SHA512:
-  metadata.gz: 79d13ce720b98a1e70f7adabab7ad6797faeb304edaca55400a40ed9c3b679376be61d1b303cb75bdc4b67538c20be89c5d6ae149c49dc055c9c2d1563e31d3f
-  data.tar.gz: 1d8433a1cf7d0b01784ddf2840baba3b93c3d515b0ce99e280eb74f54d25eee6d4db194cb230283f03a6bf3563c33590b520e4e072c1135458922b22e5feba85
+  metadata.gz: 17e0533d244d23aa69dd1459a4c1d8d8cede94f5e793d700c5f36d10fd24c5e3d1b9d7c6cba38fd23a946e7eb57e55ef00175224ca8b2cae0171dbdd272d2fe1
+  data.tar.gz: 28673a6d11fa8982803a02a148f9f3f9136005c31548af3dbda1b4083f40091bf842ab41f1ab5a80e4f29aa6bd22ed28b0f0f6dcd485706698cc9d28734a2a3b

data/lib/whos_got_dirt/response.rb

@@ -56,6 +56,12 @@ module WhosGotDirt
       raise NotImplementedError
     end
 
+    # @abstract Subclass and override {#item_url} to return an item's URL when
+    #   given a result
+    def item_url(result)
+      raise NotImplementedError
+    end
+
     # Returns the error message in the response body.
     #
     # @return [String] the error message in the response body

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

@@ -62,10 +62,23 @@ module WhosGotDirt
         #
         # @return [Array<Hash>] the results
         def to_a
-          parsed_body['result'].map do |data|
+          parsed_body['result']['companies'].map do |_,data|
             Result.new('Entity', renderer.result(data), self).finalize!
           end
         end
+
+        # Returns an entity's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the entity's URL
+        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']
+            url += "?key=#{CGI.escape(query['key'][0].to_s)}"
+          end
+          url
+        end
       end
     end
   end

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

@@ -60,6 +60,15 @@ module WhosGotDirt
             Result.new('Entity', renderer.result(data), self).finalize!
           end
         end
+
+        # Returns an entity's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the entity's URL
+        def item_url(result)
+          query = CGI.parse(env.url.query.to_s)
+          "#{env.url.scheme}://#{env.url.host}/entity/#{result['identifiers'][0]['identifier']}.xml?_key=#{CGI.escape(query['_key'][0].to_s)}"
+        end
       end
     end
   end

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

@@ -56,6 +56,19 @@ module WhosGotDirt
             Result.new('Entity', renderer.result(data['company']), self).finalize!
           end
         end
+
+        # Returns an entity's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the entity's URL
+        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']
+            url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
+          end
+          url
+        end
       end
     end
   end

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

@@ -37,6 +37,15 @@ module WhosGotDirt
           end
         end
 
+        # Returns an entity's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the entity's URL
+        def item_url(result)
+          query = CGI.parse(env.url.query.to_s)
+          "#{env.url.scheme}://#{env.url.host}/index.php/api/entity?id=#{CGI.escape(result['identifiers'][0]['identifier'].to_s)}&key=#{CGI.escape(query['key'][0].to_s)}"
+        end
+
         def success?
           super && Array === parsed_body
         end

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

@@ -38,6 +38,15 @@ module WhosGotDirt
             Result.new('Entity', renderer.result(data), self).finalize!
           end
         end
+
+        # Returns an entity's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the entity's URL
+        def item_url(result)
+          query = CGI.parse(env.url.query.to_s)
+          "#{env.url.scheme}://#{env.url.host}/visualizacion/getEntityById?id=#{CGI.escape(result['identifiers'][0]['identifier'].to_s)}&entity=#{CGI.escape(query['entity'][0].to_s)}&user_key=#{CGI.escape(query['user_key'][0].to_s)}"
+        end
       end
     end
   end

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

@@ -36,6 +36,15 @@ module WhosGotDirt
             Result.new('List', renderer.result(data), self).finalize!
           end
         end
+
+        # Returns a list's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the list's URL
+        def item_url(result)
+          query = CGI.parse(env.url.query.to_s)
+          "#{env.url.scheme}://#{env.url.host}/list/#{result['identifiers'][0]['identifier']}.xml?_key=#{CGI.escape(query['_key'][0].to_s)}"
+        end
       end
     end
   end

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

@@ -28,6 +28,19 @@ module WhosGotDirt
             Result.new('List', renderer.result(data['corporate_grouping']), self).finalize!
           end
         end
+
+        # Returns a list's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the list's URL
+        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']
+            url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
+          end
+          url
+        end
       end
     end
   end

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

@@ -60,6 +60,19 @@ module WhosGotDirt
             Result.new('Relation', renderer.result(data['officer']), self).finalize!
           end
         end
+
+        # Returns a relation's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the relation's URL
+        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']
+            url += "?api_token=#{CGI.escape(query['api_token'][0].to_s)}"
+          end
+          url
+        end
       end
     end
   end

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

@@ -74,6 +74,15 @@ module WhosGotDirt
             Result.new('Relation', renderer.result(data), self).finalize!
           end
         end
+
+        # Returns a relation's URL.
+        #
+        # @param [Hash] result the rendered result
+        # @return [String] the relation's URL
+        def item_url(result)
+          query = CGI.parse(env.url.query.to_s)
+          "#{env.url.scheme}://#{env.url.host}/concession/#{result['identifiers'][0]['identifier']}?apikey=#{CGI.escape(query['apikey'][0].to_s)}"
+        end
       end
     end
   end

data/lib/whos_got_dirt/result.rb

@@ -24,6 +24,17 @@ module WhosGotDirt
       @response = response
     end
 
+    # Adds an API URL for the result.
+    #
+    # @return [Hash] the result
+    def add_link!
+      result['links'] ||= []
+      result['links'] << {
+        'url' => response.item_url(result),
+        'note' => response.class.name.rpartition('::')[2],
+      }
+    end
+
     # Adds the requested URL as a source.
     #
     # @return [Hash] the result
@@ -98,6 +109,7 @@ module WhosGotDirt
     #
     # @return [Hash] the result
     def finalize!
+      add_link!
       add_source!
       validate!
       result

data/lib/whos_got_dirt/version.rb

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

data/spec/response_spec.rb

@@ -29,6 +29,10 @@ module WhosGotDirt
             Result.new('Entity', renderer.result(data), self).finalize!
           end
         end
+
+        def item_url(result)
+          "https://api.example.com/item/#{result['identifiers'][0]['identifier']}"
+        end
       end
     end
 
@@ -100,6 +104,10 @@ module WhosGotDirt
             'identifier' => 'john-smith',
             'scheme' => 'ACME',
           }],
+          'links' => [{
+            'url' => 'https://api.example.com/item/john-smith',
+            'note' => 'MyResponse',
+          }],
           'sources' => [{
             'url' => 'https://api.example.com/endpoint?name~=John+Smith',
             'note' => 'MyResponse',
@@ -112,6 +120,10 @@ module WhosGotDirt
             'identifier' => 'john-aaron-smith',
             'scheme' => 'ACME',
           }],
+          'links' => [{
+            'url' => 'https://api.example.com/item/john-aaron-smith',
+            'note' => 'MyResponse',
+          }],
           'sources' => [{
             'url' => 'https://api.example.com/endpoint?name~=John+Smith',
             'note' => 'MyResponse',

data/spec/result_spec.rb

@@ -20,7 +20,11 @@ module WhosGotDirt
       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)
+      response = Faraday::Response.new(env)
+      def response.item_url(result)
+        "https://api.example.com/item/#{result['identifiers'][1]['identifier']}"
+      end
+      response
     end
 
     let :instance do
@@ -79,6 +83,10 @@ module WhosGotDirt
           'identifiers' => [{
             'identifier' => 'john-smith',
           }],
+          'links' => [{
+            'url' => 'https://api.example.com/item/john-smith',
+            'note' => 'Response',
+          }],
           'sources' => [{
             'url' => 'https://api.example.com/endpoint?name~=John+Smith',
             'note' => 'Response',

metadata

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