soapy_cake 1.10.2 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4c20b31ac88064c0be92df9692c52443ab71f6
-  data.tar.gz: 72be4e6a52cb622aaecd7b00efdac4a19db2347c
+  metadata.gz: 0f638bcf63e5c298c8106c4c71bacdbe8acd6927
+  data.tar.gz: 264608b47a9493bc9d3251339a6ceaf1d303495c
 SHA512:
-  metadata.gz: f29ac1697cef49f1524eeecfde5dabf01cdd6e2f04f328238e91811a2d73239294cd36137d9db4e8bdd21c9dd6a41da2ec1e968334871b6aaf27e6f364507580
-  data.tar.gz: a198049cfd0655e25a277d88bffed80e4766648c5011ca71be3fb14a4bad14845bcaad6918d90ffa27c10b845792a673138683a351ba8d48595fa60c9aab678b
+  metadata.gz: d66e47f6285e02f0e2adde97ee5834d440cb4d67a9f10cd1c36325d73bdacdf2393fa2a29a56e0d4e8ba45af782871467b027f63168051885b7abee9aae02ce3
+  data.tar.gz: aa0d393e775190a19e457406bef37d4b6fd8fe05d41ddc4ab56f767de084f38a1b91c253cd17043bd0a70365f2b3ddde6537c5c82cc9de2a61fc77ef1239ef5b

data/lib/soapy_cake/admin_batched.rb

@@ -0,0 +1,56 @@
+module SoapyCake
+  class AdminBatched
+    class BatchedRequest
+      # Both 0 and 1 return the first element. We need to set it to 1,
+      # otherwise we get an overlap in the next call. This is not documented in the API spec.
+      INITIAL_OFFSET = 1
+
+      # This value depends on the entity size.
+      # When all offers have a lot of info (e.g. geotargeting) we probably need to decrease this.
+      LIMIT = 500
+
+      def initialize(admin, method, opts)
+        if opts.key?(:row_limit) || opts.key?(:start_at_row)
+          fail Error, 'Cannot set row_limit/start_at_row in batched mode!'
+        end
+
+        @admin = admin
+        @method = method
+        @opts = opts
+        @offset = INITIAL_OFFSET
+        @finished = false
+      end
+
+      def to_enum
+        Enumerator.new do |y|
+          next_batch.each { |row| y << row } until finished
+        end
+      end
+
+      private
+
+      attr_reader :admin, :method, :opts, :finished, :offset
+
+      def next_batch
+        result = admin.public_send(method, opts.merge(row_limit: LIMIT, start_at_row: offset))
+        @finished = true if result.count < LIMIT
+        @offset += LIMIT
+        result
+      end
+    end
+
+    ALLOWED_METHODS = %i(advertisers affiliates campaigns offers creatives)
+
+    def method_missing(name, opts = {})
+      fail Error, "Invalid method #{name}" unless ALLOWED_METHODS.include?(name)
+
+      BatchedRequest.new(admin, name, opts).to_enum
+    end
+
+    private
+
+    def admin
+      @admin ||= Admin.new
+    end
+  end
+end

data/lib/soapy_cake/client.rb

@@ -20,7 +20,7 @@ module SoapyCake
 
       response = Response.new(http_response(request), request.short_response?)
       response.time_offset = time_offset
-      response.collection
+      response.to_enum
     end
 
     private

data/lib/soapy_cake/response.rb

@@ -10,13 +10,15 @@ module SoapyCake
       @short_response = short_response
     end
 
-    def collection
+    def to_enum
       check_errors!
 
       return typed_element(sax.at_depth(3).first) if short_response
 
-      sax.at_depth(5).map do |element|
-        typed_element(element)
+      Enumerator.new do |y|
+        sax.at_depth(5).each do |element|
+          y << typed_element(element)
+        end
       end
     end
 

data/lib/soapy_cake/version.rb

@@ -1,3 +1,3 @@
 module SoapyCake
-  VERSION = '1.10.2'
+  VERSION = '1.11.0'
 end

data/lib/soapy_cake.rb

@@ -15,6 +15,7 @@ require 'soapy_cake/response'
 require 'soapy_cake/response_value'
 require 'soapy_cake/client'
 require 'soapy_cake/admin'
+require 'soapy_cake/admin_batched'
 require 'soapy_cake/admin_addedit'
 require 'soapy_cake/admin_track'
 require 'soapy_cake/affiliate'

data/spec/lib/soapy_cake/admin_batched_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe SoapyCake::AdminBatched do
+  let(:admin) { double('admin') }
+
+  before :each do
+    allow(SoapyCake::Admin).to receive(:new).and_return(admin)
+
+    stub_const('SoapyCake::AdminBatched::BatchedRequest::LIMIT', 2)
+  end
+
+  it 'returns an enumerator and uses batched CAKE calls' do
+    expect(admin).to receive(:offers)
+      .with(advertiser: 1, start_at_row: 1, row_limit: 2).and_return(%i(a b))
+    expect(admin).to receive(:offers)
+      .with(advertiser: 1, start_at_row: 3, row_limit: 2).and_return(%i(c))
+
+    result = subject.offers(advertiser: 1)
+
+    expect(result).to be_a(Enumerator)
+    expect(result.to_a).to eq(%i(a b c))
+  end
+
+  context 'errors' do
+    it 'fails with an invalid method' do
+      expect { subject.clicks }.to raise_error(/Invalid method clicks/)
+    end
+
+    it 'fails when row_limit is set' do
+      expect { subject.offers(row_limit: 123) }.to raise_error(/Cannot set .* in batched mode/)
+    end
+
+    it 'fails when start_at_row is set' do
+      expect { subject.offers(start_at_row: 123) }.to raise_error(/Cannot set .* in batched mode/)
+    end
+  end
+end

data/spec/lib/soapy_cake/response_spec.rb

@@ -0,0 +1,38 @@
+RSpec.describe SoapyCake::Response do
+  let(:xml) do
+    <<-EOD
+      <?xml version="1.0" encoding="utf-8"?>
+      <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
+        <soap:Body>
+          <SomeResponse>
+            <SomeResult>
+              <success>true</success>
+              <row_count>2</row_count>
+              <somes>
+                <some>
+                  <id>123</id>
+                </some>
+                <some>
+                  <id>312</id>
+                </some>
+              </somes>
+            </SomeResult>
+          </SomeResponse>
+        </soap:Body>
+      </soap:Envelope>
+    EOD
+  end
+
+  subject { described_class.new(xml.strip, false) }
+
+  it 'returns an enumerator' do
+    expect(subject.to_enum).to be_a(Enumerator)
+  end
+
+  it 'parses the CAKE XML structure properly' do
+    expect(subject.to_enum.to_a).to eq([
+      { id: '123' },
+      { id: '312' }
+    ])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.11.0
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -183,6 +183,7 @@ files:
 - lib/soapy_cake.rb
 - lib/soapy_cake/admin.rb
 - lib/soapy_cake/admin_addedit.rb
+- lib/soapy_cake/admin_batched.rb
 - lib/soapy_cake/admin_track.rb
 - lib/soapy_cake/affiliate.rb
 - lib/soapy_cake/client.rb
@@ -216,10 +217,12 @@ files:
 - spec/integration/soapy_cake/admin_spec.rb
 - spec/integration/soapy_cake/admin_track_spec.rb
 - spec/lib/soapy_cake/admin_addedit_spec.rb
+- spec/lib/soapy_cake/admin_batched_spec.rb
 - spec/lib/soapy_cake/admin_spec.rb
 - spec/lib/soapy_cake/admin_track_spec.rb
 - spec/lib/soapy_cake/affiliate_spec.rb
 - spec/lib/soapy_cake/request_spec.rb
+- spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb
 - spec/spec_helper.rb
 - spec/support/admin_method_example.rb
@@ -270,10 +273,12 @@ test_files:
 - spec/integration/soapy_cake/admin_spec.rb
 - spec/integration/soapy_cake/admin_track_spec.rb
 - spec/lib/soapy_cake/admin_addedit_spec.rb
+- spec/lib/soapy_cake/admin_batched_spec.rb
 - spec/lib/soapy_cake/admin_spec.rb
 - spec/lib/soapy_cake/admin_track_spec.rb
 - spec/lib/soapy_cake/affiliate_spec.rb
 - spec/lib/soapy_cake/request_spec.rb
+- spec/lib/soapy_cake/response_spec.rb
 - spec/lib/soapy_cake/response_value_spec.rb
 - spec/spec_helper.rb
 - spec/support/admin_method_example.rb