piplapis-ruby 4.0.3 → 5.0.0

data/lib/pipl/client.rb

@@ -99,8 +99,12 @@ module Pipl
 
         unless [Pipl::Configurable::SHOW_SOURCES_ALL,
                 Pipl::Configurable::SHOW_SOURCES_MATCHING,
-                Pipl::Configurable::SHOW_SOURCES_NONE, nil].include? opts[:show_sources]
-          raise ArgumentError.new('show_sources must be one of all, matching or false')
+                Pipl::Configurable::SHOW_SOURCES_NONE, nil, true, false].include? opts[:show_sources]
+          raise ArgumentError.new('show_sources must be one of all, matching, false or a boolean value')
+        end
+
+        if opts[:match_requirements] and not opts[:match_requirements].is_a? String
+          raise ArgumentError.new('match_requirements must be a String')
         end
 
         unless opts.key? :search_pointer
@@ -114,10 +118,11 @@ module Pipl
 
     def create_http_request(opts)
       uri = URI(opts[:api_endpoint])
-      keys = %w(minimum_probability minimum_match hide_sponsored live_feeds show_sources)
+      keys = %w(minimum_probability minimum_match hide_sponsored live_feeds show_sources match_requirements)
       query_params = ["key=#{opts[:api_key]}"] + keys.map { |k| "#{k}=#{opts[k.to_sym]}" unless opts[k.to_sym].nil? }
       query_params << opts[:extra] or []
-      uri.query = query_params.compact.join('&')
+      query_params << uri.query
+      uri.query = URI.escape(query_params.compact.join('&'))
 
       req = Net::HTTP::Post.new(uri.request_uri)
       req['User-Agent'] = opts[:user_agent]

data/lib/pipl/configurable.rb

@@ -7,7 +7,7 @@ module Pipl
     SHOW_SOURCES_NONE = 'false'
 
     attr_accessor :api_key, :minimum_probability, :minimum_match, :hide_sponsored, :live_feeds, :show_sources
-    attr_accessor :strict_validation, :user_agent
+    attr_accessor :match_requirements, :strict_validation, :user_agent
     attr_writer :api_endpoint
 
     class << self
@@ -20,6 +20,7 @@ module Pipl
             :hide_sponsored,
             :live_feeds,
             :show_sources,
+            :match_requirements,
             :strict_validation,
             :api_endpoint,
             :user_agent

data/lib/pipl/consts.rb

@@ -69,6 +69,8 @@ module Pipl
                VI: 'Virgin Islands, U.s.', IS: 'Iceland', IR: 'Iran', AM: 'Armenia', AL: 'Albania', VN: 'Vietnam',
                AN: 'Netherlands Antilles', AQ: 'Antarctica', AS: 'American Samoa', AR: 'Argentina', AU: 'Australia',
                VU: 'Vanuat', IO: 'British Indian Ocean Territory', IN: 'India', LB: 'Lebanon', AZ: 'Azerbaijan',
-               IE: 'Ireland', ID: 'Indonesia', PA: 'Panama', UA: 'Ukraine', QA: 'Qatar', MZ: 'Mozambique'}
+               IE: 'Ireland', ID: 'Indonesia', PA: 'Panama', UA: 'Ukraine', QA: 'Qatar', MZ: 'Mozambique',
+               BL: 'Saint Barthélemy', BQ: 'Caribbean Netherlands', MF: 'Saint Martin', SS: 'South Sudan',
+               SX: 'Sint Maarten', XK: 'Kosovo', CW: 'Curaçao', RS: 'Serbia'}
 
 end

data/lib/pipl/containers.rb

@@ -231,7 +231,7 @@ module Pipl
           category: h[:@category],
           origin_url: h[:@origin_url],
           domain: h[:@domain],
-          source_id: h[:@source_id],
+          source_id: h[:@id],
           person_id: h[:@person_id],
           match: h[:@match],
           sponsored: h[:@sponsored],
@@ -246,13 +246,14 @@ module Pipl
 
   class Person < FieldsContainer
 
-    attr_reader :id, :match, :search_pointer
+    attr_reader :id, :match, :search_pointer, :inferred
 
     def initialize(params={})
       super params
       @id = params[:id]
       @match = params[:match]
       @search_pointer = params[:search_pointer]
+      @inferred = params[:inferred] || false
     end
 
     def self.from_hash(h)
@@ -260,6 +261,7 @@ module Pipl
           id: h[:@id],
           match: h[:@match],
           search_pointer: h[:@search_pointer],
+          inferred: h[:@inferred],
       }
       params[:fields] = fields_from_hash(h)
       self.new(params)

data/lib/pipl/default.rb

@@ -4,7 +4,7 @@ module Pipl
 
   module Default
 
-    API_ENDPOINT = 'https://api.pipl.com/search/v4/'.freeze
+    API_ENDPOINT = 'https://api.pipl.com/search/'.freeze
     API_KEY = 'sample_key'.freeze
     USER_AGENT   = "piplapis/ruby/#{Pipl::VERSION}".freeze
 
@@ -38,6 +38,10 @@ module Pipl
         ENV['PIPL_SHOW_SOURCES']
       end
 
+      def match_requirements
+        ENV['PIPL_MATCH_REQUIREMENTS']
+      end
+
       def strict_validation
         ENV['PIPL_USER_STRICT_VALIDATION']
       end

data/lib/pipl/fields.rb

@@ -9,11 +9,13 @@ module Pipl
 
     include Pipl::Utils
 
-    attr_accessor :valid_since, :inferred
+    attr_accessor :valid_since, :last_seen, :inferred, :current
 
     def initialize(params={})
       @valid_since = params[:valid_since]
+      @last_seen = params[:last_seen]
       @inferred = params[:inferred]
+      @current = params[:current]
     end
 
     def self.from_hash(h)
@@ -26,10 +28,12 @@ module Pipl
     def self.base_params_from_hash(h)
       params = {
           inferred: h[:@inferred],
+          current: h[:@current],
           type: h[:@type],
           display: h[:display]
       }
       params[:valid_since] = Date.strptime(h[:@valid_since], Pipl::DATE_FORMAT) if h.key? :@valid_since
+      params[:last_seen] = Date.strptime(h[:@last_seen], Pipl::DATE_FORMAT) if h.key? :@last_seen
       params[:date_range] = Pipl::DateRange.from_hash(h[:date_range]) if h.key? :date_range
       params
     end
@@ -397,7 +401,9 @@ module Pipl
 
       opts = {width: 100, height: 100, favicon: true, zoom_face: true, use_https: false}.merge(params)
       schema = opts.delete(:use_https) ? 'https': 'http'
-      query_params = ["token=#{@thumbnail_token}"] + opts.map { |k, v| "#{k}=#{v}" unless v.nil? }
+      tokens = @thumbnail_token.gsub(/&dsid=.*/,'')
+      tokens += ',' + opts.delete(:fallback).thumbnail_token.gsub(/&dsid=.*/,'') if opts[:fallback]
+      query_params = ["tokens=#{tokens}"] + opts.map { |k, v| "#{k}=#{v}" unless v.nil? }
       "#{schema}://thumb.pipl.com/image?#{query_params.compact.join('&')}"
     end
 
@@ -557,8 +563,6 @@ module Pipl
 
     def initialize(params={})
       super params
-      raise ArgumentError.new("#{params[:content]} is not a valid gender") \
-      unless %w(male female).include? params[:content]
       @content = params[:content]
     end
 

data/lib/pipl/response.rb

@@ -9,7 +9,7 @@ module Pipl
     class SearchResponse
 
       attr_reader :query, :person, :sources, :possible_persons, :warnings, :visible_sources, :available_sources
-      attr_reader :search_id, :http_status_code
+      attr_reader :search_id, :http_status_code, :raw_response, :available_data
 
       def initialize(params={})
         @query = params[:query]
@@ -21,6 +21,8 @@ module Pipl
         @available_sources = params[:available_sources]
         @search_id = params[:search_id]
         @http_status_code = params[:http_status_code]
+        @raw_response = params[:raw_response]
+        @available_data = params[:available_data]
       end
 
       def self.from_json(json_str)
@@ -36,6 +38,8 @@ module Pipl
         params[:available_sources] = h[:@available_sources]
         params[:search_id] = h[:@search_id]
         params[:http_status_code] = h[:@http_status_code]
+        params[:raw_response] = json_str
+        params[:available_data] = AvailableData.from_hash(h[:available_data]) if h.key? :available_data
 
         self.new(params)
       end
@@ -121,6 +125,49 @@ module Pipl
       end
 
     end
+
+    class AvailableData
+      attr_reader :basic, :premium
+
+      def initialize(params={})
+        @basic = params[:basic]
+        @premium = params[:premium]
+      end
+
+      def self.from_hash(h)
+        params = {}
+        params[:basic] = FieldCount.new(h[:basic]) if h.key? :basic
+        params[:premium] = FieldCount.new(h[:premium]) if h.key? :premium
+        self.new(params)
+      end
+
+    end
+
+    class FieldCount
+      attr_reader :addresses, :ethnicities, :emails, :dobs, :genders, :user_ids, :social_profiles, :educations, :jobs, 
+                  :images, :languages, :origin_countries, :names, :phones, :relationships, :usernames
+
+      def initialize(params={})
+        @addresses = params[:addresses] || 0
+        @ethnicities = params[:ethnicities] || 0
+        @emails = params[:emails] || 0
+        @dobs = params[:dobs] || 0
+        @genders = params[:genders] || 0
+        @user_ids = params[:user_ids] || 0
+        @social_profiles = params[:social_profiles] || 0
+        @educations = params[:educations] || 0
+        @jobs = params[:jobs] || 0
+        @images = params[:images] || 0
+        @languages = params[:languages] || 0
+        @origin_countries = params[:origin_countries] || 0
+        @names = params[:names] || 0
+        @phones = params[:phones] || 0
+        @relationships = params[:relationships] || 0
+        @usernames = params[:usernames] || 0
+      end
+
+    end
+
   end
 
 end

data/lib/pipl/version.rb

@@ -1,3 +1,3 @@
 module Pipl
-    VERSION = '4.0.3'.freeze
+    VERSION = '5.0.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piplapis-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 5.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler