data-com-api 0.0.1 → 0.1.0

data/lib/data-com-api/responses/company_contact_count.rb

@@ -0,0 +1,96 @@
+require 'data-com-api/responses/base'
+require 'data-com-api/company_contact_count/level'
+require 'data-com-api/company_contact_count/department'
+
+module DataComApi
+  module Responses
+    class CompanyContactCount < Base
+
+      attr_reader :id
+      
+      def initialize(api_client, company_id, received_options)
+        @options     = received_options
+        @id          = company_id
+        @levels      = []
+        @departments = []
+        @url         = nil
+        @size        = nil
+        @requested   = false
+        super(api_client)
+      end
+
+      def size
+        return @size if requested?
+
+        perform_request_if_not_requested!
+        @size
+      end
+
+      def url
+        return @url if requested?
+
+        perform_request_if_not_requested!
+        @url
+      end
+
+      def levels
+        return @levels if requested?
+
+        perform_request_if_not_requested!
+        @levels
+      end
+
+      def departments
+        return @departments if requested?
+
+        perform_request_if_not_requested!
+        @departments
+      end
+
+      protected
+
+        def options
+          @options
+        end
+
+        def transform_request(request)
+          @size = request['totalCount'].to_i
+          @url  = request['url'] if request.include? 'url'
+
+          if request.include? 'levels'
+            request['levels'].each do |level|
+              @levels << DataComApi::CompanyContactCount::Level.new(level)
+            end
+          end
+
+          if request.include? 'departments'
+            request['departments'].each do |department|
+              @departments << DataComApi::CompanyContactCount::Department.new(
+                department
+              )
+            end
+          end
+        end
+
+        def perform_request(received_options)
+          include_graveyard = !!received_options[:includeGraveyard]
+          client.company_contact_count_raw_json(id, include_graveyard)
+        end
+
+      private
+
+        def perform_request_if_not_requested!
+          return if requested?
+
+          transform_request perform_request(options)
+
+          @requested = true
+        end
+
+        def requested?
+          @requested
+        end
+
+    end
+  end
+end

data/lib/data-com-api/responses/contacts.rb

@@ -0,0 +1,97 @@
+require 'data-com-api/responses/base'
+require 'data-com-api/contact'
+
+module DataComApi
+  module Responses
+    class Contacts < Base
+      
+      def initialize(api_client, contact_ids, username, password, purchase_flag)
+        @contact_ids        = contact_ids
+        @username           = username
+        @password           = password
+        @purchase_flag      = purchase_flag
+
+        @used_points        = nil
+        @size               = nil
+        @purchased_contacts = nil
+        @point_balance      = nil
+        @contacts           = []
+        super(api_client)
+      end
+
+      def size
+        return @size if requested?
+
+        perform_request_if_not_requested!
+        @size
+      end
+
+      def used_points
+        return @used_points if requested?
+
+        perform_request_if_not_requested!
+        @used_points
+      end
+
+      def purchased_contacts
+        return @purchased_contacts if requested?
+
+        perform_request_if_not_requested!
+        @purchased_contacts
+      end
+
+      def point_balance
+        return @point_balance if requested?
+
+        perform_request_if_not_requested!
+        @point_balance
+      end
+
+      def contacts
+        return @contacts if requested?
+
+        perform_request_if_not_requested!
+        @contacts
+      end
+
+      protected
+
+        def transform_request(request)
+          @used_points        = request['pointsUsed'].to_i
+          @size               = request['totalHits'].to_i
+          @purchased_contacts = request['numberOfContactsPurchased'].to_i
+          @point_balance      = request['pointBalance'].to_i
+
+          if request.include? 'contacts'
+            request['contacts'].each do |contact|
+              @contacts << DataComApi::Contact.new(contact)
+            end
+          end
+        end
+
+        def perform_request
+          client.contacts_raw_json(
+            @contact_ids,
+            @username,
+            @password,
+            @purchase_flag
+          )
+        end
+
+      private
+
+        def perform_request_if_not_requested!
+          return if requested?
+
+          transform_request perform_request
+
+          @requested = true
+        end
+
+        def requested?
+          @requested
+        end
+
+    end
+  end
+end

data/lib/data-com-api/responses/search_base.rb

@@ -0,0 +1,112 @@
+require 'data-com-api/responses/base'
+
+module DataComApi
+  module Responses
+    # Abstract class
+    class SearchBase < Base
+
+      
+      def initialize(api_client, received_options)
+        @options = received_options
+        super(api_client)
+
+        # Cache pagesize, MUST NOT change between requests
+        @page_size = client.page_size
+      end
+
+      def size
+        return @size if @size
+
+        size_options = options.merge(
+          offset:    0,
+          page_size: client.size_only_page_size
+        )
+        
+        calculate_size_from_request! self.perform_request(size_options)
+      end
+
+      def max_size
+        self.real_max_offset + page_size
+      end
+
+      def real_size
+        self.size > self.real_max_offset ? self.max_size : self.size
+      end
+
+      def at_offset(offset)
+        page_options = options.merge(
+          offset:    offset,
+          page_size: page_size
+        )
+
+        request = self.perform_request(page_options)
+        calculate_size_from_request! request
+
+        self.transform_request request
+      end
+
+      # Be careful, this will load all records in memory, check total_records
+      # before doing such a thing
+      def all
+        all_records = Array.new(self.real_size)
+
+        self.each_with_index { |record, index| all_records[index] = record }
+
+        all_records
+      end
+
+      def each_with_index
+        total_records             = 0
+        records_per_previous_page = page_size
+        current_offset            = 0
+
+        loop do
+          break if current_offset > self.real_max_offset
+
+          records = at_offset(current_offset)
+
+          records.each_with_index do |record, index|
+            yield(record, index + current_offset)
+          end
+
+          records_per_previous_page  = records.size
+          current_offset            += page_size
+          total_records             += records_per_previous_page
+
+          if records_per_previous_page != page_size || total_records == self.size
+            break
+          end
+        end
+      end
+
+      def real_max_offset
+        return @real_max_offset if @real_max_offset
+
+        @real_max_offset = client.max_offset
+        @real_max_offset = @real_max_offset - (@real_max_offset % page_size)
+      end
+
+      alias_method :to_a, :all
+      alias_method :each, :each_with_index
+
+      protected
+
+        def page_size
+          @page_size
+        end
+
+        def options
+          @options
+        end
+
+      private
+
+        def calculate_size_from_request!(request)
+          return if @size
+
+          @size = request['totalHits'].to_i
+        end
+
+    end
+  end
+end

data/lib/data-com-api/responses/search_company.rb

@@ -0,0 +1,23 @@
+require 'data-com-api/company'
+require 'data-com-api/responses/search_base'
+require 'data-com-api/responses/base'
+
+module DataComApi
+  module Responses
+    class SearchCompany < SearchBase
+
+      protected
+
+        def transform_request(request)
+          request['companies'].map do |contact_attributes|
+            DataComApi::Company.new(contact_attributes)
+          end
+        end
+
+        def perform_request(received_options)
+          client.search_company_raw_json(received_options)
+        end
+      
+    end
+  end
+end

data/lib/data-com-api/responses/search_contact.rb

@@ -0,0 +1,23 @@
+require 'data-com-api/contact'
+require 'data-com-api/responses/search_base'
+require 'data-com-api/responses/base'
+
+module DataComApi
+  module Responses
+    class SearchContact < SearchBase
+
+      protected
+
+        def transform_request(request)
+          request['contacts'].map do |contact_attributes|
+            DataComApi::Contact.new(contact_attributes)
+          end
+        end
+
+        def perform_request(received_options)
+          client.search_contact_raw_json(received_options)
+        end
+      
+    end
+  end
+end

data/lib/data-com-api/version.rb

@@ -1,3 +1,3 @@
 module DataComApi
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/data-com-api.rb

@@ -1,4 +1,17 @@
-require "data_com_api/version"
+require 'data-com-api/version'
+require 'data-com-api/errors'
+require 'data-com-api/query_parameters'
+require 'data-com-api/company'
+require 'data-com-api/contact'
+require 'data-com-api/company_contact_count/level'
+require 'data-com-api/company_contact_count/department'
+require 'data-com-api/responses/base'
+require 'data-com-api/responses/search_base'
+require 'data-com-api/responses/search_contact'
+require 'data-com-api/responses/search_company'
+require 'data-com-api/responses/company_contact_count'
+require 'data-com-api/responses/contacts'
+require 'data-com-api/client'
 
 module DataComApi
 end

data/spec/factories/client_factory.rb

@@ -0,0 +1,12 @@
+require 'faker'
+require 'data-com-api/client'
+
+FactoryGirl.define do
+
+  factory :client, class: DataComApi::Client do
+    token { Faker::Internet.password }
+
+    initialize_with { new(token) }
+  end
+
+end

data/spec/factories/data-com/company_contact_count/department_factory.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+require 'faker'
+
+FactoryGirl.define do
+
+  factory :data_com_company_contact_count_department, class: Hashie::Mash do
+    count { Faker::Number.number(2).to_i }
+    name  { Faker::Lorem.word            }
+    url   { Faker::Internet.url          }
+
+    initialize_with { new(attributes) }
+  end
+
+end

data/spec/factories/data-com/company_contact_count/level_factory.rb

@@ -0,0 +1,14 @@
+require 'hashie'
+require 'faker'
+
+FactoryGirl.define do
+
+  factory :data_com_company_contact_count_level, class: Hashie::Mash do
+    count { Faker::Number.number(2).to_i }
+    name  { Faker::Lorem.word            }
+    url   { Faker::Internet.url          }
+
+    initialize_with { new(attributes) }
+  end
+
+end

data/spec/factories/data-com/company_contact_count_response_factory.rb

@@ -0,0 +1,39 @@
+require 'hashie'
+require 'faker'
+
+FactoryGirl.define do
+
+  # Notice that in factory I didn't care about total contacts in levels +
+  # departments = totalCount
+  factory :data_com_company_contact_count_response, class: Hashie::Mash do
+    id          { Faker::Number.number(6).to_i }
+    totalCount  { Faker::Number.number(2).to_i }
+    url         { Faker::Internet.url          }
+    levels      nil
+    departments nil
+
+    ignore do
+      levels_size      5
+      departments_size 9
+    end
+
+    initialize_with { new(attributes) }
+
+    after(:build) do |data_com_company_contact_count_response, evaluator|
+      unless data_com_company_contact_count_response[:levels]
+        data_com_company_contact_count_response[:levels] = FactoryGirl.build_list(
+          :data_com_company_contact_count_level,
+          evaluator.levels_size
+        )
+      end
+
+      unless data_com_company_contact_count_response[:departments]
+        data_com_company_contact_count_response[:departments] = FactoryGirl.build_list(
+          :data_com_company_contact_count_department,
+          evaluator.departments_size
+        )
+      end
+    end
+  end
+
+end

data/spec/factories/data-com/contact_factory.rb

@@ -0,0 +1,35 @@
+require 'hashie'
+require 'faker'
+require 'active_support/time'
+require 'active_support/hash_with_indifferent_access'
+require 'data-com-api/client'
+
+FactoryGirl.define do
+
+  factory :data_com_contact, class: Hashie::Mash do
+    zip             { Faker::Address.zip.to_s                                  }
+    phone           { Faker::PhoneNumber.phone_number                          }
+    areaCode        { Faker::Number.number(3)                                  }
+    updatedDate     { Time.now.utc.in_time_zone(DataComApi::Client::TIME_ZONE) }
+    seoContactURL   { Faker::Internet.url                                      }
+    state           { Faker::Address.state_abbr                                }
+    lastname        { Faker::Name.last_name                                    }
+    firstname       { Faker::Name.first_name                                   }
+    companyName     { Faker::Company.name                                      }
+    contactURL      { Faker::Internet.url                                      }
+    contactSales    { Faker::Number.number(2).to_i                             }
+    country         { Faker::Address.country                                   }
+    owned           false
+    city            { Faker::Address.city                                      }
+    title           { Faker::Lorem.sentence                                    }
+    contactId       { Faker::Number.number(6).to_i                             }
+    email           { Faker::Internet.email                                    }
+    address         { Faker::Address.street_address                            }
+    graveyardStatus false
+    ownedType       ""
+    companyId       { Faker::Number.number(4)                                  }
+
+    initialize_with { new(attributes) }
+  end
+
+end

data/spec/factories/data-com/contacts_response_factory.rb

@@ -0,0 +1,30 @@
+require 'hashie'
+require 'faker'
+
+FactoryGirl.define do
+
+  factory :data_com_contacts_response, class: Hashie::Mash do
+    unrecognized              { Hashie::Mash.new('contactId' => []) }
+    pointsUsed                { Faker::Number.number(2).to_i        }
+    totalHits                 { Faker::Number.number(2).to_i        }
+    numberOfContactsPurchased { Faker::Number.number(2).to_i        }
+    pointBalance              { Faker::Number.number(4).to_i        }
+    contacts                  nil
+
+    ignore do
+      contacts_size 2
+    end
+
+    initialize_with { new(attributes) }
+
+    after(:build) do |data_com_contacts_response, evaluator|
+      unless data_com_contacts_response[:contacts]
+        data_com_contacts_response[:contacts] = FactoryGirl.build_list(
+          :data_com_contact,
+          evaluator.contacts_size
+        )
+      end
+    end
+  end
+
+end

data/spec/factories/data-com/search_contact_response_factory.rb

@@ -0,0 +1,30 @@
+require 'hashie'
+require 'faker'
+require 'active_support/hash_with_indifferent_access'
+require 'data-com-api/client'
+
+FactoryGirl.define do
+
+  factory :data_com_search_contact_response, class: Hashie::Mash do
+    totalHits 0
+    contacts  nil
+
+    ignore do
+      page_size 3
+    end
+
+    initialize_with { new(attributes) }
+
+    after(:build) do |data_com_search_contact_response, evaluator|
+      if evaluator.page_size > 0 && data_com_search_contact_response[:contacts].nil?
+        data_com_search_contact_response[:contacts] = FactoryGirl.build_list(
+          :data_com_contact,
+          evaluator.page_size
+        )
+      elsif evaluator.page_size == 0 && data_com_search_contact_response[:contacts].nil?
+        data_com_search_contact_response[:contacts] = []
+      end
+    end
+  end
+
+end

data/spec/factories/query_parameters_factory.rb

@@ -0,0 +1,11 @@
+require 'data-com-api/query_parameters'
+
+FactoryGirl.define do
+
+  factory :query_parameters, class: DataComApi::QueryParameters do
+    # Yes, no data required
+
+    initialize_with { new(attributes) }
+  end
+
+end

data/spec/factories/responses/search_contact_factory.rb

@@ -0,0 +1,13 @@
+require 'data-com-api/responses/search_contact'
+
+FactoryGirl.define do
+
+  factory :responses_search_contact, class: DataComApi::Responses::SearchContact do
+    ignore do
+      client { FactoryGirl.build(:client) }
+    end
+
+    initialize_with { new(client, attributes) }
+  end
+
+end