piplapis-ruby 5.0.4 → 5.0.5

data/lib/pipl/response.rb

@@ -1,220 +1,220 @@
-require 'json'
-
-require_relative 'containers'
-
-module Pipl
-
-  class Client
-
-    class SearchResponse
-
-      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, :person_count
-      attr_reader :qps_allotted, :qps_current, :qps_live_allotted, :qps_live_current, :qps_demo_allotted,
-                  :qps_demo_current, :quota_allotted, :quota_current, :quota_reset, :demo_usage_allotted,
-                  :demo_usage_current, :demo_usage_expiry
-
-
-      def initialize(params={})
-        @query = params[:query]
-        @person = params[:person]
-        @sources = params[:sources]
-        @possible_persons = params[:possible_persons]
-        @warnings = params[:warnings]
-        @visible_sources = params[:visible_sources]
-        @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]
-        @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]
-        @qps_live_allotted = params[:qps_live_allotted]
-        @qps_live_current = params[:qps_live_current]
-        @qps_demo_allotted = params[:qps_demo_allotted]
-        @qps_demo_current = params[:qps_demo_current]
-        @quota_allotted = params[:quota_allotted]
-        @quota_current = params[:quota_current]
-        @quota_reset = params[:quota_reset]
-        @demo_usage_allotted = params[:demo_usage_allotted]
-        @demo_usage_current = params[:demo_usage_current]
-        @demo_usage_expiry = params[:demo_usage_expiry]
-      end
-
-      def self.deserialize(json_str, headers={})
-        h = JSON.parse(json_str, symbolize_names: true)
-
-        params = {}
-        params[:query] = Pipl::Person.from_hash(h[:query]) if h.key? :query
-        params[:person] = Pipl::Person.from_hash(h[:person]) if h.key? :person
-        params[:sources] = h[:sources].map { |s| Pipl::Source.from_hash(s) } if h.key? :sources
-        params[:possible_persons] = h[:possible_persons].map { |p| Pipl::Person.from_hash(p) } if h.key? :possible_persons
-        params[:warnings] = h[:warnings]
-        params[:visible_sources] = h[:@visible_sources]
-        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[:match_requirements] = h[:match_requirements]
-        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
-
-        params.merge! Utils::extract_rate_limits(headers)
-
-        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
-
-      def group_sources_by_domain
-        @sources.group_by { |s| s.domain } if @sources
-      end
-
-      def group_sources_by_category
-        @sources.group_by { |s| s.category } if @sources
-      end
-
-      def group_sources_by_match
-        @sources.group_by { |s| s.match } if @sources
-      end
-
-      def gender
-        @person.gender if @person
-      end
-
-      def age
-        @person.age if @person
-      end
-
-      def job
-        @person.job if @person
-      end
-
-      def address
-        @person.address if @person
-      end
-
-      def education
-        @person.education if @person
-      end
-
-      def language
-        @person.language if @person
-      end
-
-      def ethnicity
-        @person.ethnicity if @person
-      end
-
-      def origin_country
-        @person.origin_country if @person
-      end
-
-      def phone
-        @person.phone if @person
-      end
-
-      def email
-        @person.email if @person
-      end
-
-      def name
-        @person.name if @person
-      end
-
-      def image
-        @person.image if @person
-      end
-
-      def url
-        @person.url if @person
-      end
-
-      def username
-        @person.username if @person
-      end
-
-      def user_id
-        @person.user_id if @person
-      end
-
-      def relationship
-        @person.relationship if @person
-      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, :mobile_phones, :landline_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
-        @mobile_phones = params[:mobile_phones] || 0
-        @landline_phones = params[:landline_phones] || 0
-        @relationships = params[:relationships] || 0
-        @usernames = params[:usernames] || 0
-      end
-
-    end
-
-  end
-
-end
+require 'json'
+
+require_relative 'containers'
+
+module Pipl
+
+  class Client
+
+    class SearchResponse
+
+      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, :person_count
+      attr_reader :qps_allotted, :qps_current, :qps_live_allotted, :qps_live_current, :qps_demo_allotted,
+                  :qps_demo_current, :quota_allotted, :quota_current, :quota_reset, :demo_usage_allotted,
+                  :demo_usage_current, :demo_usage_expiry
+
+
+      def initialize(params={})
+        @query = params[:query]
+        @person = params[:person]
+        @sources = params[:sources]
+        @possible_persons = params[:possible_persons]
+        @warnings = params[:warnings]
+        @visible_sources = params[:visible_sources]
+        @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]
+        @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]
+        @qps_live_allotted = params[:qps_live_allotted]
+        @qps_live_current = params[:qps_live_current]
+        @qps_demo_allotted = params[:qps_demo_allotted]
+        @qps_demo_current = params[:qps_demo_current]
+        @quota_allotted = params[:quota_allotted]
+        @quota_current = params[:quota_current]
+        @quota_reset = params[:quota_reset]
+        @demo_usage_allotted = params[:demo_usage_allotted]
+        @demo_usage_current = params[:demo_usage_current]
+        @demo_usage_expiry = params[:demo_usage_expiry]
+      end
+
+      def self.deserialize(json_str, headers={})
+        h = JSON.parse(json_str, symbolize_names: true)
+
+        params = {}
+        params[:query] = Pipl::Person.from_hash(h[:query]) if h.key? :query
+        params[:person] = Pipl::Person.from_hash(h[:person]) if h.key? :person
+        params[:sources] = h[:sources].map { |s| Pipl::Source.from_hash(s) } if h.key? :sources
+        params[:possible_persons] = h[:possible_persons].map { |p| Pipl::Person.from_hash(p) } if h.key? :possible_persons
+        params[:warnings] = h[:warnings]
+        params[:visible_sources] = h[:@visible_sources]
+        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[:match_requirements] = h[:match_requirements]
+        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
+
+        params.merge! Utils::extract_rate_limits(headers)
+
+        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
+
+      def group_sources_by_domain
+        @sources.group_by { |s| s.domain } if @sources
+      end
+
+      def group_sources_by_category
+        @sources.group_by { |s| s.category } if @sources
+      end
+
+      def group_sources_by_match
+        @sources.group_by { |s| s.match } if @sources
+      end
+
+      def gender
+        @person.gender if @person
+      end
+
+      def age
+        @person.age if @person
+      end
+
+      def job
+        @person.job if @person
+      end
+
+      def address
+        @person.address if @person
+      end
+
+      def education
+        @person.education if @person
+      end
+
+      def language
+        @person.language if @person
+      end
+
+      def ethnicity
+        @person.ethnicity if @person
+      end
+
+      def origin_country
+        @person.origin_country if @person
+      end
+
+      def phone
+        @person.phone if @person
+      end
+
+      def email
+        @person.email if @person
+      end
+
+      def name
+        @person.name if @person
+      end
+
+      def image
+        @person.image if @person
+      end
+
+      def url
+        @person.url if @person
+      end
+
+      def username
+        @person.username if @person
+      end
+
+      def user_id
+        @person.user_id if @person
+      end
+
+      def relationship
+        @person.relationship if @person
+      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, :mobile_phones, :landline_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
+        @mobile_phones = params[:mobile_phones] || 0
+        @landline_phones = params[:landline_phones] || 0
+        @relationships = params[:relationships] || 0
+        @usernames = params[:usernames] || 0
+      end
+
+    end
+
+  end
+
+end

data/lib/pipl/utils.rb

@@ -1,68 +1,68 @@
-require 'date'
-require 'uri'
-
-module Pipl
-
-  module Utils
-
-    class << self
-
-      def str_to_date(s)
-        Date.strptime(s, DATE_FORMAT)
-      end
-
-      def date_to_str(d)
-        d.strftime(DATE_FORMAT)
-      end
-
-      def is_valid_url?(url)
-        not ((url =~ URI::ABS_URI).nil?)
-      end
-
-      def alpha_chars(s)
-        s.gsub(/[^\p{Alpha}]/, '')
-      end
-
-      def alnum_chars(s)
-        s.gsub(/[^\p{Alnum}]/, '')
-      end
-
-      def titleize(s)
-        s.gsub(/\w+/) { |x| x.capitalize }
-      end
-
-      def to_utf8(obj)
-        if obj.respond_to?(:encode)
-          begin
-            obj.encode('UTF-8')
-          rescue Exception
-            puts "Could not convert #{obj} to UTF-8"
-            raise
-          end
-        else
-          obj
-        end
-      end
-
-      def extract_rate_limits(headers={})
-        res = {}
-        res[:qps_allotted] = headers['X-QPS-Allotted'].to_i if headers.key? 'X-QPS-Allotted'
-        res[:qps_current] = headers['X-QPS-Current'].to_i if headers.key? 'X-QPS-Current'
-        res[:qps_live_allotted] = headers['X-QPS-Live-Allotted'].to_i if headers.key? 'X-QPS-Live-Allotted'
-        res[:qps_live_current] = headers['X-QPS-Live-Current'].to_i if headers.key? 'X-QPS-Live-Current'
-        res[:qps_demo_allotted] = headers['X-QPS-Demo-Allotted'].to_i if headers.key? 'X-QPS-Demo-Allotted'
-        res[:qps_demo_current] = headers['X-QPS-Demo-Current'].to_i if headers.key? 'X-QPS-Demo-Current'
-        res[:quota_allotted] = headers['X-APIKey-Quota-Allotted'].to_i if headers.key? 'X-APIKey-Quota-Allotted'
-        res[:quota_current] = headers['X-APIKey-Quota-Current'].to_i if headers.key? 'X-APIKey-Quota-Current'
-        res[:quota_reset] = DateTime.strptime(headers['X-Quota-Reset'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Quota-Reset'
-        res[:demo_usage_allotted] = headers['X-Demo-Usage-Allotted'].to_i if headers.key? 'X-Demo-Usage-Allotted'
-        res[:demo_usage_current] = headers['X-Demo-Usage-Current'].to_i if headers.key? 'X-Demo-Usage-Current'
-        res[:demo_usage_expiry] = DateTime.strptime(headers['X-Demo-Usage-Expiry'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Demo-Usage-Expiry'
-        res
-      end
-
-    end
-
-  end
-
-end
+require 'date'
+require 'uri'
+
+module Pipl
+
+  module Utils
+
+    class << self
+
+      def str_to_date(s)
+        Date.strptime(s, DATE_FORMAT)
+      end
+
+      def date_to_str(d)
+        d.strftime(DATE_FORMAT)
+      end
+
+      def is_valid_url?(url)
+        not ((url =~ URI::ABS_URI).nil?)
+      end
+
+      def alpha_chars(s)
+        s.gsub(/[^\p{Alpha}]/, '')
+      end
+
+      def alnum_chars(s)
+        s.gsub(/[^\p{Alnum}]/, '')
+      end
+
+      def titleize(s)
+        s.gsub(/\w+/) { |x| x.capitalize }
+      end
+
+      def to_utf8(obj)
+        if obj.respond_to?(:encode)
+          begin
+            obj.encode('UTF-8')
+          rescue Exception
+            puts "Could not convert #{obj} to UTF-8"
+            raise
+          end
+        else
+          obj
+        end
+      end
+
+      def extract_rate_limits(headers={})
+        res = {}
+        res[:qps_allotted] = headers['X-QPS-Allotted'].to_i if headers.key? 'X-QPS-Allotted'
+        res[:qps_current] = headers['X-QPS-Current'].to_i if headers.key? 'X-QPS-Current'
+        res[:qps_live_allotted] = headers['X-QPS-Live-Allotted'].to_i if headers.key? 'X-QPS-Live-Allotted'
+        res[:qps_live_current] = headers['X-QPS-Live-Current'].to_i if headers.key? 'X-QPS-Live-Current'
+        res[:qps_demo_allotted] = headers['X-QPS-Demo-Allotted'].to_i if headers.key? 'X-QPS-Demo-Allotted'
+        res[:qps_demo_current] = headers['X-QPS-Demo-Current'].to_i if headers.key? 'X-QPS-Demo-Current'
+        res[:quota_allotted] = headers['X-APIKey-Quota-Allotted'].to_i if headers.key? 'X-APIKey-Quota-Allotted'
+        res[:quota_current] = headers['X-APIKey-Quota-Current'].to_i if headers.key? 'X-APIKey-Quota-Current'
+        res[:quota_reset] = DateTime.strptime(headers['X-Quota-Reset'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Quota-Reset'
+        res[:demo_usage_allotted] = headers['X-Demo-Usage-Allotted'].to_i if headers.key? 'X-Demo-Usage-Allotted'
+        res[:demo_usage_current] = headers['X-Demo-Usage-Current'].to_i if headers.key? 'X-Demo-Usage-Current'
+        res[:demo_usage_expiry] = DateTime.strptime(headers['X-Demo-Usage-Expiry'], '%A, %B %d, %Y %I:%M:%S %p %Z') if headers.key? 'X-Demo-Usage-Expiry'
+        res
+      end
+
+    end
+
+  end
+
+end