Contents

module WhosGotDirt
  module Responses
    module Relation
      # Converts concessions from the OpenOil API to Popolo format.
      #
      # @see http://openoil.net/openoil-api/
      class OpenOil < Response
        @template = {
          '@type' => 'Relation',
          'subject' => lambda{|data|
            v = JsonPointer.new(data, '/licensees').value
            ['subject', v.map{|licensee| {'name' => licensee}}]
          },
          'identifiers' => [{
            'identifier' => '/identifier',
            'scheme' => 'OpenOil',
          }],
          'links' => [{
            'url' => '/url_api',
            'note' => 'OpenOil API detail',
          }, {
            'url' => '/url_wiki',
            'note' => 'OpenOil wiki page',
          }],
          'name' => '/name',
          'created_at' => '/source_date',
          'updated_at' => '/retrieved_date',
          'sources' => [{
            'url' => '/source_document',
          }],
          # API-specific.
          'additional_properties' => '/details',
          'country_code' => '/country',
          'status' => '/status',
          'type' => '/type',
        }

        # Parses the response body.
        #
        # @return [Array<Hash>] the parsed response body
        def parse_body
          JSON.load(body)
        end

        # Returns the total number of matching results.
        #
        # @return [Fixnum] the total number of matching results
        def count
          parsed_body['result_count']
        end

        # Returns the current page number.
        #
        # @return [Fixnum] the current page number
        def page
          parsed_body['page']
        end

        # Transforms the parsed response body into results.
        #
        # @return [Array<Hash>] the results
        def to_a
          parsed_body['results'].map do |data|
            Result.new('Relation', renderer.result(data), self).finalize!
          end
        end
      end
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
whos_got_dirt-0.0.2	lib/whos_got_dirt/responses/relation/open_oil.rb