soapy_cake 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcc3c764f74e351a63fd14ff47ccf24960fa1682
-  data.tar.gz: 03003ea0a497c6823a25b61f7c9f95b5e63cccc6
+  metadata.gz: d99924dd593a9f0d8fd215d02a44177a7919cb13
+  data.tar.gz: da5d81a7738efdd7cfc4f1dd8372c1f4c7faa5d0
 SHA512:
-  metadata.gz: bea2ce89ada7266e4c9e34c2e3e8c37e76942dbcd9754c7560242ec280541d072cb6a2bfb398b62e5711c21379599be0ba9edcfe9d1d1130ecb27158ab08589e
-  data.tar.gz: 1313bcf0d0a1ffd99ec015cbd82f2812713b2f9c96c6dd16c33d57224d660fb8a62333182d159b38fe554f2657d4af3464016250a4ae3edd015cef7ef333599d
+  metadata.gz: a03fac64800f777a61b8c59969b16d133f252be0f8857b88c419496fc629a1fd639f260c0a87dcab706651e7dfaea7a7ab0c03a6b58e689e2c4fcb84b9095f5e
+  data.tar.gz: 470188fc1c53c5f2c798f32edc8a438ee7aae6f585798f1a585f72b248125a113f5be268d8b6de852cb33af91ff53c95aa910969d5a27251471ad5b6fc03c12b

data/lib/soapy_cake/admin.rb

@@ -113,8 +113,9 @@ module SoapyCake
       run Request.new(:admin, :signup, :affiliate, opts)
     end
 
-    def media_types
-      run(Request.new(:admin, :signup, :get_media_types, {}))[:MediaType]
+    def media_types(opts = {})
+      result = run(Request.new(:admin, :signup, :get_media_types, opts))
+      xml_response? ? result : result.try(:[], :MediaType)
     end
 
     def verticals

data/lib/soapy_cake/admin_batched.rb

@@ -4,6 +4,10 @@ module SoapyCake
       advertisers affiliates campaigns offers creatives clicks conversions events
     )
 
+    def initialize(opts = {})
+      @opts = opts
+    end
+
     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.
@@ -29,13 +33,12 @@ module SoapyCake
         Enumerator.new do |y|
           loop do
             result = next_batch
-            @offset += limit
+            # raises StopIteration when less than `limit` elements are present
+            # which is then rescued by `loop`
             limit.times { y << result.next }
+            @offset += limit
           end
         end
-        # we know we received less than limit objects when we see a stop iteration exception from
-        # the underlying result enumerator and therefore know that we're done.
-      rescue StopIteration # rubocop:disable Lint/HandleExceptions
       end
 
       private
@@ -47,16 +50,18 @@ module SoapyCake
       attr_reader :admin, :method, :opts, :offset, :limit
     end
 
-    def method_missing(name, opts = {}, limit = nil)
+    def method_missing(name, method_opts = {}, limit = nil)
       fail Error, "Invalid method #{name}" unless ALLOWED_METHODS.include?(name)
 
-      BatchedRequest.new(admin, name, opts, limit).to_enum
+      BatchedRequest.new(admin, name, method_opts, limit).to_enum
     end
 
     private
 
+    attr_reader :opts
+
     def admin
-      @admin ||= Admin.new
+      @admin ||= Admin.new(opts)
     end
   end
 end

data/lib/soapy_cake/client.rb

@@ -18,16 +18,33 @@ module SoapyCake
       request.api_key = api_key
       request.time_offset = time_offset
 
-      response = Response.new(http_response(request), request.short_response?)
-      response.time_offset = time_offset
-      response.to_enum
+      Response
+        .new(response_body(request), request.short_response?, time_offset)
+        .public_send(:"to_#{xml_response? ? 'xml' : 'enum'}")
     end
 
     private
 
+    def xml_response?
+      opts[:xml_response] == true
+    end
+
+    def response_body(request)
+      if request.opts[:response].present?
+        request.opts[:response]
+      else
+        http_response(request)
+      end
+    end
+
     def http_response(request)
       url = "https://#{domain}#{request.path}"
-      HTTParty.post(url, headers: headers, body: request.xml, timeout: NET_TIMEOUT).body
+      http_response = HTTParty.post(url, headers: headers, body: request.xml, timeout: NET_TIMEOUT)
+
+      fail RequestFailed, "Request failed with HTTP #{http_response.code}: " \
+        "#{http_response.body}" unless http_response.success?
+
+      http_response
     end
 
     def headers

data/lib/soapy_cake/response.rb

@@ -2,28 +2,39 @@ module SoapyCake
   class Response
     include Helper
 
-    attr_accessor :time_offset
-    attr_reader :body, :short_response
+    SHORT_ELEMENT_DEPTH = 3
+    ELEMENTS_DEPTH = 5
 
-    def initialize(body, short_response)
+    attr_reader :body, :short_response, :time_offset
+
+    def initialize(body, short_response, time_offset)
       @body = body
       @short_response = short_response
+      @time_offset = time_offset
     end
 
     def to_enum
       check_errors!
 
-      return typed_element(sax.at_depth(3).first) if short_response
+      return typed_element(sax.at_depth(SHORT_ELEMENT_DEPTH).first) if short_response
 
       Enumerator.new do |y|
-        sax.at_depth(5).each do |element|
+        sax.at_depth(ELEMENTS_DEPTH).each do |element|
           y << typed_element(element)
         end
       end
     end
 
+    def to_xml
+      (empty? ? [] : [body.to_s]).to_enum
+    end
+
     private
 
+    def empty?
+      sax.at_depth(ELEMENTS_DEPTH).first.nil?
+    end
+
     def typed_element(element)
       walk_tree(element) do |value, key|
         ResponseValue.new(key, value, time_offset: time_offset).parse

data/lib/soapy_cake/version.rb

@@ -1,3 +1,3 @@
 module SoapyCake
-  VERSION = '1.13.1'
+  VERSION = '1.14.0'
 end

data/spec/fixtures/raw_response.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetMediaTypesResponse xmlns="http://cakemarketing.com/api/1/"><GetMediaTypesResult><MediaType><media_type_id>15</media_type_id><type_name>Adware</type_name></MediaType><MediaType><media_type_id>7</media_type_id><type_name>Banner</type_name></MediaType><MediaType><media_type_id>17</media_type_id><type_name>Content</type_name></MediaType><MediaType><media_type_id>6</media_type_id><type_name>Co-Reg</type_name></MediaType><MediaType><media_type_id>3</media_type_id><type_name>Email</type_name></MediaType><MediaType><media_type_id>12</media_type_id><type_name>Incentivized</type_name></MediaType><MediaType><media_type_id>2</media_type_id><type_name>Network</type_name></MediaType><MediaType><media_type_id>13</media_type_id><type_name>Other</type_name></MediaType><MediaType><media_type_id>8</media_type_id><type_name>PopUnder</type_name></MediaType><MediaType><media_type_id>4</media_type_id><type_name>PPC</type_name></MediaType><MediaType><media_type_id>9</media_type_id><type_name>Radio</type_name></MediaType><MediaType><media_type_id>5</media_type_id><type_name>SEO</type_name></MediaType><MediaType><media_type_id>16</media_type_id><type_name>Social Media</type_name></MediaType><MediaType><media_type_id>10</media_type_id><type_name>TV</type_name></MediaType><MediaType><media_type_id>11</media_type_id><type_name>Upsell</type_name></MediaType><MediaType><media_type_id>1</media_type_id><type_name>YouTube_Twitch</type_name></MediaType></GetMediaTypesResult></GetMediaTypesResponse></soap:Body></soap:Envelope>

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/XML_responses/returns_an_XML_string.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://cake-partner-domain.com/api/1/signup.asmx
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0"?>
+        <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:cake="http://cakemarketing.com/api/1/">
+          <env:Header/>
+          <env:Body>
+            <cake:GetMediaTypes>
+              <cake:api_key>cake-api-key</cake:api_key>
+            </cake:GetMediaTypes>
+          </env:Body>
+        </env:Envelope>
+    headers:
+      Content-Type:
+      - application/soap+xml;charset=UTF-8
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - private, max-age=0
+      Content-Type:
+      - application/soap+xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/8.5
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 24 Aug 2015 12:29:10 GMT
+      Content-Length:
+      - '1736'
+    body:
+      encoding: UTF-8
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><GetMediaTypesResponse
+        xmlns="http://cakemarketing.com/api/1/"><GetMediaTypesResult><MediaType><media_type_id>15</media_type_id><type_name>Adware</type_name></MediaType><MediaType><media_type_id>7</media_type_id><type_name>Banner</type_name></MediaType><MediaType><media_type_id>17</media_type_id><type_name>Content</type_name></MediaType><MediaType><media_type_id>6</media_type_id><type_name>Co-Reg</type_name></MediaType><MediaType><media_type_id>3</media_type_id><type_name>Email</type_name></MediaType><MediaType><media_type_id>12</media_type_id><type_name>Incentivized</type_name></MediaType><MediaType><media_type_id>2</media_type_id><type_name>Network</type_name></MediaType><MediaType><media_type_id>13</media_type_id><type_name>Other</type_name></MediaType><MediaType><media_type_id>8</media_type_id><type_name>PopUnder</type_name></MediaType><MediaType><media_type_id>4</media_type_id><type_name>PPC</type_name></MediaType><MediaType><media_type_id>9</media_type_id><type_name>Radio</type_name></MediaType><MediaType><media_type_id>5</media_type_id><type_name>SEO</type_name></MediaType><MediaType><media_type_id>16</media_type_id><type_name>Social
+        Media</type_name></MediaType><MediaType><media_type_id>10</media_type_id><type_name>TV</type_name></MediaType><MediaType><media_type_id>11</media_type_id><type_name>Upsell</type_name></MediaType><MediaType><media_type_id>1</media_type_id><type_name>YouTube_Twitch</type_name></MediaType></GetMediaTypesResult></GetMediaTypesResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Mon, 15 Jun 2015 12:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/integration/soapy_cake/admin_spec.rb

@@ -92,4 +92,14 @@ RSpec.describe SoapyCake::Admin do
       type_name: 'Adware'
     )
   end
+
+  context 'XML responses' do
+    subject { described_class.new(xml_response: true) }
+
+    it 'returns an XML string', :vcr do
+      result = subject.media_types
+
+      expect(result.next).to eq(File.read('spec/fixtures/raw_response.xml').strip)
+    end
+  end
 end

data/spec/lib/soapy_cake/admin_spec.rb

@@ -188,5 +188,34 @@ RSpec.describe SoapyCake::Admin do
       let(:cake_method) { :affiliate }
       it_behaves_like 'a cake admin method'
     end
+
+    describe '#media_types' do
+      let(:method) { :media_types }
+      let(:cake_method) { :get_media_types }
+      it_behaves_like 'a cake admin method'
+
+      it 'uses a local response' do
+        expect(subject.media_types(response: File.read('spec/fixtures/raw_response.xml'))).to eq(
+          [
+            { media_type_id: 15, type_name: 'Adware' },
+            { media_type_id: 7, type_name: 'Banner' },
+            { media_type_id: 17, type_name: 'Content' },
+            { media_type_id: 6, type_name: 'Co-Reg' },
+            { media_type_id: 3, type_name: 'Email' },
+            { media_type_id: 12, type_name: 'Incentivized' },
+            { media_type_id: 2, type_name: 'Network' },
+            { media_type_id: 13, type_name: 'Other' },
+            { media_type_id: 8, type_name: 'PopUnder' },
+            { media_type_id: 4, type_name: 'PPC' },
+            { media_type_id: 9, type_name: 'Radio' },
+            { media_type_id: 5, type_name: 'SEO' },
+            { media_type_id: 16, type_name: 'Social Media' },
+            { media_type_id: 10, type_name: 'TV' },
+            { media_type_id: 11, type_name: 'Upsell' },
+            { media_type_id: 1, type_name: 'YouTube_Twitch' }
+          ]
+        )
+      end
+    end
   end
 end

data/spec/lib/soapy_cake/response_spec.rb

@@ -23,7 +23,7 @@ RSpec.describe SoapyCake::Response do
     EOD
   end
 
-  subject { described_class.new(xml.strip, false) }
+  subject { described_class.new(xml.strip, false, 0) }
 
   it 'returns an enumerator' do
     expect(subject.to_enum).to be_a(Enumerator)

data/spec/support/admin_method_example.rb

@@ -1,6 +1,7 @@
 RSpec.shared_examples_for 'a cake admin method' do
+  let(:request) { double('request') }
+
   it 'runs the request' do
-    request = double('request')
     expect(SoapyCake::Request).to receive(:new)
       .with(:admin, service, cake_method, cake_opts || {}).and_return(request)
     expect(subject).to receive(:run).with(request)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -195,6 +195,8 @@ files:
 - lib/soapy_cake/response_value.rb
 - lib/soapy_cake/version.rb
 - soapy_cake.gemspec
+- spec/fixtures/raw_response.xml
+- spec/fixtures/vcr_cassettes/SoapyCake_Admin/XML_responses/returns_an_XML_string.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/creates_an_affiliate_and_returns_the_ID.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/does_not_parse_a_transaction_id_as_an_integer.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/raises_if_there_is_an_error.yml
@@ -253,6 +255,8 @@ signing_key:
 specification_version: 4
 summary: Simple client for the CAKE API
 test_files:
+- spec/fixtures/raw_response.xml
+- spec/fixtures/vcr_cassettes/SoapyCake_Admin/XML_responses/returns_an_XML_string.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/creates_an_affiliate_and_returns_the_ID.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/does_not_parse_a_transaction_id_as_an_integer.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/raises_if_there_is_an_error.yml