data-com-api 0.1.5 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWY4NzZiOGVlYjg0MDJkM2ZjNjMyZDIxMzM5Zjg2ZWVlN2RiY2Y0ZA==
+    MzFkNTgyOTc3YjczMzc2MWZiYzE3ODliZGI2YzJkN2I4YWRiNmQxNA==
   data.tar.gz: !binary |-
-    ZGE3NGQ3NGRmNWYwYjFlYjU0ODgwYjkwNDhkODY2NzJlNjgxMjIzZQ==
+    ZDI0ZGVjYmNkODgyNTgyYWFhYjY5Y2QyMGM1ZWIzNzdhMGFhOWE1Mw==
 SHA512:
   metadata.gz: !binary |-
-    OGQ5YmQ0NTgyNDYxN2QwMDhjMTY1ZDE3MDdlNzJlNWIwMmY1YmNlZTMzZGY5
-    YmQ3ZDQ5ZThjN2M1NjhjNDBiYzJiMzRiYmE1YjViMDZkNmUyMzkxMDY1MGVj
-    ZmIwODAwNGQ1ZDUzMWZhNWEwMmYzMTNmODNiNDU3NjQxNzFkZDU=
+    M2YzY2M3NDUxNjhhYjg1MjAxNGZhZWI0N2U0MTg3NzgyZTAwMWM1ZjMyZDE4
+    YTcwYWNlYmVhZTg1MDc2ZjY3YzljZDdjOGU2MDY5YTRlMjBlYTg0YWI0MzQ4
+    ZTM2ZWEyNDdmYTM5Y2ZkNDc1OThkMjI3NmMxYTkyZjEzYzNhMWU=
   data.tar.gz: !binary |-
-    MzU5NzYxYzAwZDkyMGQ3OGZhNTIxZTVjZmU4ZDAzMWNjZGU4YWIxZGVhYjIy
-    MzJkNDU0NzE1NjAxZDhhMTE4MjY2ZjU1NDE0MzIwY2UxNmFmY2NjODRhOGRm
-    YzVjMjQyMDcyYTgxZjliZGIzMGU5MzNhZWM0OTY3NjcyZWVjOWI=
+    NjlhNjgzMWQzYjUzODZjNmI2Mjg3Zjg2M2Q3NDE4MWMzZjNkMmFlMDcyNWIw
+    NTY0NzY4NWY5OTM4YmNhYTkwMDA0ZTQwOWRlZmIxNDk3NWE5NTAwMDBhMDEz
+    OTI1ZjdiOTcxM2M1NzFkY2EwOTNkYzdjZGYzMGRkNmQyYjEwY2M=

data/README.md

@@ -6,7 +6,7 @@ Ruby bindings for Data.com API ( Salesforce, ex Jigsaw ).
 
 Add this line to your application's Gemfile:
 
-    gem 'data-com-api', '~> 0.1.3'
+    gem 'data-com-api', '~> 0.2.0'
 
 And then execute:
 
@@ -55,6 +55,9 @@ requesting `size`, `all`, `each` and such (keep reading).
 The parameters accepted by this method are the keys of the [DataComApi::QueryParameters](https://github.com/Fire-Dragon-DoL/data-com-api/blob/master/lib/data-com-api/query_parameters.rb). Notice that you can use the key specified as `:from` for a more ruby-like
 syntax.
 
+**start_at_offset** and **end_at_offset**: This two new parameters allow your response to start fetching data at specified offset or end earlier (if
+`end_at_offset` is bigger than max fetchable records, it will be ignored and code will handle things in standard way).
+
 The returned object is a `DataComApi::SearchContact` which is mostly a [DataComApi::SearchBase](https://github.com/Fire-Dragon-DoL/data-com-api/blob/master/lib/data-com-api/responses/search_base.rb) instance with the following main methods:
 - `size` which returns the `totalHits` field from the response
   (it will perform a request only if none performed)

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

@@ -5,9 +5,22 @@ module DataComApi
     # Abstract class
     class SearchBase < Base
 
+      OFFSET_KEYS = [:start_at_offset, :end_at_offset].freeze
       
+      # Options accept 2 special params: :start_at_offset and :end_at_offset
+      # which is where the records will be start being fetched from
       def initialize(api_client, received_options)
-        @options = received_options
+        @start_at_offset = 0
+        @end_at_offset   = nil
+
+        unless received_options[OFFSET_KEYS[0]].nil?
+          @start_at_offset = received_options[OFFSET_KEYS[0]].to_i
+        end
+        unless received_options[OFFSET_KEYS[1]].nil?
+          @end_at_offset = received_options[OFFSET_KEYS[1]].to_i
+        end
+
+        @options = received_options.reject { |key| OFFSET_KEYS.include? key.to_sym }
         super(api_client)
 
         # Cache pagesize, MUST NOT change between requests
@@ -56,9 +69,9 @@ module DataComApi
       end
 
       def each_with_index
-        total_records             = 0
         records_per_previous_page = page_size
-        current_offset            = 0
+        current_offset            = @start_at_offset
+        total_records             = current_offset
 
         loop do
           break if current_offset > self.real_max_offset
@@ -84,6 +97,11 @@ module DataComApi
 
         @real_max_offset = client.max_offset
         @real_max_offset = @real_max_offset - (@real_max_offset % page_size)
+        unless @end_at_offset.nil? || @real_max_offset < @end_at_offset
+          @real_max_offset = @end_at_offset
+        end
+
+        @real_max_offset
       end
 
       alias_method :to_a, :all

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

@@ -1,3 +1,3 @@
 module DataComApi
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/spec/models/client_spec.rb

@@ -159,6 +159,68 @@ describe DataComApi::Client do
 
     end
 
+    context "when starting at different offset" do
+
+      describe "#each" do
+        before do
+          DataComApiStubRequests.stub_search_contact(
+            page_size:  client.page_size,
+            total_hits: total_contacts_count
+          )
+          stub_request(
+            :get,
+            URI.join(
+              DataComApi::Client.base_uri, DataComApi::ApiURI.search_contact
+            ).to_s
+          ).with(
+            query: hash_including({
+              'offset'   => '10',
+              'pageSize' => client.page_size.to_s
+            })
+          ).to_return(
+            body: FactoryGirl.build(
+              :data_com_search_contact_response,
+              page_size: client.page_size,
+              totalHits: total_contacts_count
+            ).to_json
+          )
+        end
+
+        let!(:total_contacts_count) { 10 }
+
+        it "is an array containing all records possible for request" do
+          start_at_offset = 2
+          response        = client.search_contact(start_at_offset: start_at_offset)
+          contacts_count  = 0
+
+          response.each { contacts_count += 1 }
+          expect(contacts_count).to eq(total_contacts_count - start_at_offset)
+        end
+
+        context "when ending at different offset" do
+
+          it "is an array containing all records possible for request" do
+            start_at_offset = 2
+            # XXX: BE EXTREMELY CAREFUL, use an odd number (0 counting as 1 record)
+            # otherwise test will fail because of the way I mocked web requests
+            # which are returning always 2 records, even if less are returned
+            end_at_offset   = 7
+            contacts_count  = 0
+            response        = client.search_contact(
+              start_at_offset: start_at_offset,
+              end_at_offset:   end_at_offset
+            )
+
+            response.each { contacts_count += 1 }
+            expect(contacts_count).to eq((end_at_offset + 1) - start_at_offset)
+          end
+
+        end
+
+      end
+
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data-com-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Fire-Dragon-DoL