piplapis-ruby 5.0.2 → 5.0.3

data/lib/pipl/client.rb

@@ -14,6 +14,9 @@ module Pipl
 
     include Pipl::Configurable
 
+    QUERY_PARAMS = %w(minimum_probability minimum_match hide_sponsored live_feeds show_sources match_requirements
+                source_category_requirements infer_persons)
+
     def initialize(options = {})
       Pipl::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || Pipl.instance_variable_get(:"@#{key}"))
@@ -111,6 +114,10 @@ module Pipl
           raise ArgumentError.new('source_category_requirements must be a String')
         end
 
+        if opts[:infer_persons] and not [nil, false, true].include? opts[:infer_persons]
+          raise ArgumentError.new('infer_persons must be true, false or nil')
+        end
+
         unless opts.key? :search_pointer
           unsearchable = opts[:person].unsearchable_fields
           if unsearchable and not unsearchable.empty?
@@ -122,8 +129,8 @@ module Pipl
 
     def create_http_request(opts)
       uri = URI(opts[:api_endpoint])
-      keys = %w(minimum_probability minimum_match hide_sponsored live_feeds show_sources match_requirements source_category_requirements)
-      query_params = ["key=#{opts[:api_key]}"] + keys.map { |k| "#{k}=#{opts[k.to_sym]}" unless opts[k.to_sym].nil? }
+      query_params = ["key=#{opts[:api_key]}"] +
+          QUERY_PARAMS.map { |k| "#{k}=#{opts[k.to_sym]}" unless opts[k.to_sym].nil? }
       query_params << opts[:extra] or []
       query_params << uri.query
       uri.query = URI.escape(query_params.compact.join('&'))
@@ -147,14 +154,9 @@ module Pipl
     def do_send(http, req)
       response = http.request(req)
       if response.is_a? Net::HTTPSuccess
-        SearchResponse.from_json(response.body)
+        SearchResponse.from_http_response(response)
       else
-        begin
-          err = Pipl::Client::APIError.from_json(response.body)
-        rescue
-          err = Pipl::Client::APIError.new response.message, response.code
-        end
-        raise err
+        raise Pipl::Client::APIError.from_http_response(response)
       end
     end
 

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 :match_requirements, :source_category_requirements, :strict_validation, :user_agent
+    attr_accessor :match_requirements, :source_category_requirements, :infer_persons, :strict_validation, :user_agent
     attr_writer :api_endpoint
 
     class << self
@@ -22,6 +22,7 @@ module Pipl
             :show_sources,
             :match_requirements,
             :source_category_requirements,
+            :infer_persons,
             :strict_validation,
             :api_endpoint,
             :user_agent

data/lib/pipl/default.rb

@@ -46,6 +46,10 @@ module Pipl
         ENV['PIPL_SOURCE_CATEGORY_REQUIREMENTS']
       end
 
+      def infer_persons
+        ENV['PIPL_INFER_PERSONS']
+      end
+
       def strict_validation
         ENV['PIPL_USER_STRICT_VALIDATION']
       end

data/lib/pipl/errors.rb

@@ -7,10 +7,16 @@
 
     class APIError < Exception
       attr_reader :status_code
+      attr_reader :qps_allotted, :qps_current, :quota_allotted, :quota_current, :quota_reset
 
-      def initialize(message, status_code)
+      def initialize(message, status_code, params={})
         super message
         @status_code = status_code
+        @qps_allotted = params[:qps_allotted]
+        @qps_current = params[:qps_current]
+        @quota_allotted = params[:quota_allotted]
+        @quota_current = params[:quota_current]
+        @quota_reset = params[:quota_reset]
       end
 
       def is_user_error?
@@ -21,9 +27,31 @@
         not is_user_error?
       end
 
-      def self.from_json(json_str)
+      def self.deserialize(json_str, headers={})
         h = JSON.parse(json_str, symbolize_names: true)
-        self.new(h[:error], h[:@http_status_code])
+
+        # Quota and Throttle headers
+        params = {}
+        params[:qps_allotted] = headers['X-APIKey-QPS-Allotted'].to_i if headers.key? 'X-APIKey-QPS-Allotted'
+        params[:qps_current] = headers['X-APIKey-QPS-Current'].to_i if headers.key? 'X-APIKey-QPS-Current'
+        params[:quota_allotted] = headers['X-APIKey-Quota-Allotted'].to_i if headers.key? 'X-APIKey-Quota-Allotted'
+        params[:quota_current] = headers['X-APIKey-Quota-Current'].to_i if headers.key? 'X-APIKey-Quota-Current'
+        params[:quota_reset] = DateTime.strptime(headers['X-Quota-Reset'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Quota-Reset'
+
+        self.new(h[:error], h[:@http_status_code], params)
+      end
+
+      def self.from_http_response(resp)
+        begin
+          self.deserialize(resp.body, resp)
+        rescue
+          Pipl::Client::APIError.new resp.message, resp.code
+        end
+      end
+
+      # Here for backward compatibility
+      def self.from_json(json_str)
+        self.deserialize(json_str)
       end
 
     end

data/lib/pipl/fields.rb

@@ -253,7 +253,7 @@ module Pipl
 
   class Email < Field
 
-    RE_EMAIL = Regexp.new('^[\w.%\-+]+@[\w.%\-]+\.[a-zA-Z]{2,6}$')
+    RE_EMAIL = Regexp.new('^[a-zA-Z0-9\'._%\-+]+@[a-zA-Z0-9._%\-]+\.[a-zA-Z]{2,24}$')
 
     # @!attribute address
     #   @return [String] Plain email address

data/lib/pipl/response.rb

@@ -10,7 +10,8 @@ module Pipl
 
       attr_reader :query, :person, :sources, :possible_persons, :warnings, :visible_sources, :available_sources
       attr_reader :search_id, :http_status_code, :raw_response, :available_data, :match_requirements
-      attr_reader :source_category_requirements
+      attr_reader :source_category_requirements, :person_count
+      attr_reader :qps_allotted, :qps_current, :quota_allotted, :quota_current, :quota_reset
 
       def initialize(params={})
         @query = params[:query]
@@ -26,9 +27,15 @@ module Pipl
         @available_data = params[:available_data]
         @match_requirements = params[:match_requirements]
         @source_category_requirements = params[:source_category_requirements]
+        @person_count = params[:person_count]
+        @qps_allotted = params[:qps_allotted]
+        @qps_current = params[:qps_current]
+        @quota_allotted = params[:quota_allotted]
+        @quota_current = params[:quota_current]
+        @quota_reset = params[:quota_reset]
       end
 
-      def self.from_json(json_str)
+      def self.deserialize(json_str, headers={})
         h = JSON.parse(json_str, symbolize_names: true)
 
         params = {}
@@ -46,9 +53,36 @@ module Pipl
         params[:source_category_requirements] = h[:source_category_requirements]
         params[:available_data] = AvailableData.from_hash(h[:available_data]) if h.key? :available_data
 
+        # person_count: API v4 doesn't send this in the response so we compute it here
+        if h.key? :@person_count
+          params[:person_count] = h[:@person_count]
+        elsif h.key?(:person)
+          params[:person_count] = 1
+        elsif h.key?(:possible_persons)
+          params[:person_count] = h[:possible_persons].length
+        else
+          params[:person_count] = 0
+        end
+
+        # Quota and Throttle headers
+        params[:qps_allotted] = headers['X-APIKey-QPS-Allotted'].to_i if headers.key? 'X-APIKey-QPS-Allotted'
+        params[:qps_current] = headers['X-APIKey-QPS-Current'].to_i if headers.key? 'X-APIKey-QPS-Current'
+        params[:quota_allotted] = headers['X-APIKey-Quota-Allotted'].to_i if headers.key? 'X-APIKey-Quota-Allotted'
+        params[:quota_current] = headers['X-APIKey-Quota-Current'].to_i if headers.key? 'X-APIKey-Quota-Current'
+        params[:quota_reset] = DateTime.strptime(headers['X-Quota-Reset'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Quota-Reset'
+
         self.new(params)
       end
 
+      def self.from_http_response(resp)
+        self.deserialize(resp.body, resp)
+      end
+
+      # Here for backward compatibility
+      def self.from_json(json_str)
+         self.deserialize(json_str)
+      end
+
       def matching_sources
         @sources.select { |s| s.match == 1.0 } if @sources
       end

data/lib/pipl/version.rb

@@ -1,3 +1,3 @@
 module Pipl
-    VERSION = '5.0.2'.freeze
+    VERSION = '5.0.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: piplapis-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler