soapy_cake 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48b4062dce12845caf36f528b60327033e63d7a0
-  data.tar.gz: cbcbfe9b1dddceb67984576a63825ff5c19b39ca
+  metadata.gz: e316df7a7a9c2e50db3dec1cda60ec4095d01184
+  data.tar.gz: 6720a6ab9d6aa939ae5360842d11102af473ff9e
 SHA512:
-  metadata.gz: af1c7e864df7ad50faac0d902c7578bf869decef11ff63b9bb6a4f1de6acdf9acf6a35a3666e1fc03385566216d1d5187dca1589e8c51aaa7680b6bccd22ec94
-  data.tar.gz: 79149b70f6e70c92879016ecb054f78d1310c50713142adc7a643ea1f106951edc202e3fa63f582b6878627a5f4612cc23a0fd41d570ec5c989ba9768b99b0d1
+  metadata.gz: 97a4313edc0705a004613b72e89830310621f3eb6a174debe8d35b688126fff9e4ccdda0efdb599e7d5d6e9094c1cdd5a010cfd303e1556d484b386bd6c59b0a
+  data.tar.gz: 951252dab7d028540ed035cb298c0daa7241a88d219b26b24b3eab94dc8a92759fb1dae0205354d8a9d9c46943a0b86ea8e80ee630bfcfc6261709efe44f4cc1

data/api_versions.yml

@@ -15,7 +15,7 @@ admin:
     affiliate: 2
     apply_suppression_list_to_offer: 1
     blacklist: 1
-    campaign: 2
+    campaign: 3
     caps: 1
     contact: 2
     creative: 1

data/lib/soapy_cake/admin.rb

@@ -78,11 +78,11 @@ module SoapyCake
       run Request.new(:admin, :reports, :caps, opts)
     end
 
-    def currencies(*)
+    def currencies
       run Request.new(:admin, :get, :currencies, {})
     end
 
-    def tiers(*)
+    def tiers
       run Request.new(:admin, :get, :affiliate_tiers, {})
     end
 
@@ -102,11 +102,15 @@ module SoapyCake
       run Request.new(:admin, :signup, :affiliate, opts)
     end
 
-    def verticals(*)
+    def media_types
+      run(Request.new(:admin, :signup, :get_media_types, {}))[:MediaType]
+    end
+
+    def verticals
       run Request.new(:admin, :get, :verticals, {})
     end
 
-    def countries(*)
+    def countries
       run Request.new(:admin, :get, :countries, {})
     end
 
@@ -114,7 +118,7 @@ module SoapyCake
       run Request.new(:admin, :get, :payment_types, {})
     end
 
-    def blacklist_reasons(*)
+    def blacklist_reasons
       run Request.new(:admin, :get, :blacklist_reasons, {})
     end
   end

data/lib/soapy_cake/admin_addedit.rb

@@ -151,6 +151,17 @@ module SoapyCake
       run Request.new(:admin, :addedit, :affiliate, opts)
     end
 
+    def add_campaign(opts)
+      addedit_campaign(opts.merge(campaign_id: 0))
+    end
+
+    def edit_campaign(opts)
+      require_params(opts, %i(campaign_id))
+      validate_id(opts, :campaign_id)
+
+      addedit_campaign(opts)
+    end
+
     private
 
     def apply_tag_opts!(opts)
@@ -169,7 +180,7 @@ module SoapyCake
       OFFER_DEFAULT_OPTIONS.merge(
         conversion_cap_behavior: const_lookup(:conversion_behavior_id, :system),
         conversion_behavior_on_redirect: const_lookup(:conversion_behavior_id, :system),
-        expiration_date: Date.today + (365 * 100)
+        expiration_date: future_expiration_date
       )
     end
 
@@ -193,5 +204,18 @@ module SoapyCake
 
       run Request.new(:admin, :addedit, :offer_contract, opts)
     end
+
+    def addedit_campaign(opts)
+      require_params(opts, %i(affiliate_id offer_id media_type_id account_status_id payout))
+
+      translate_values!(opts, %i(account_status_id))
+
+      opts.reverse_merge!(
+        display_link_type_id: 1,
+        expiration_date: future_expiration_date
+      )
+
+      run Request.new(:admin, :addedit, :campaign, opts)
+    end
   end
 end

data/lib/soapy_cake/helper.rb

@@ -41,5 +41,13 @@ module SoapyCake
         fail ArgumentError, "#{key} is not a valid value for #{type}"
       end
     end
+
+    # Some API calls require expiration dates.
+    # The default is to not expire campaigns/offers/etc., so we set this to far in the future.
+    # It cannot be *that* far in the future though because it causes a datetime overflow
+    # in the steam powered rusty black box they call a database server.
+    def future_expiration_date
+      Date.today + (365 * 30)
+    end
   end
 end

data/lib/soapy_cake/response.rb

@@ -38,9 +38,23 @@ module SoapyCake
     def check_errors!
       fault = sax.for_tag(:fault).first
       fail RequestFailed, fault[:reason][:text] if fault
+
+      return if error_check_special_case?
+
       fail RequestFailed, error_message unless sax.for_tag(:success).first == 'true'
     end
 
+    def error_check_special_case?
+      # Don't ask...
+      # As you might imagine, CAKE simply does not return the success element
+      # for this specific request. Also, this is the only request with a tag depth
+      # of 4, not 3 or 5 like ALL OTHER requests.
+      # BTW: There is a 10$ reward if anyone can find a worse designed API.
+      return true if sax.for_tag(:MediaType).count > 0
+
+      false
+    end
+
     def error_message
       sax.for_tag(:message).first || sax.for_tag(:Text).first || 'Unknown error'
     end

data/lib/soapy_cake/version.rb

@@ -1,3 +1,3 @@
 module SoapyCake
-  VERSION = '1.8.1'
+  VERSION = '1.9.0'
 end

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/creates_an_affiliate_and_returns_the_ID.yml

@@ -26,7 +26,7 @@ http_interactions:
               <cake:contact_first_name>Foxy</cake:contact_first_name>
               <cake:contact_last_name>Fox</cake:contact_last_name>
               <cake:contact_email_address>foxy@forrest.com</cake:contact_email_address>
-              <cake:date_added>2015-06-11T01:00:00</cake:date_added>
+              <cake:date_added>2015-06-15T01:00:00</cake:date_added>
             </cake:Affiliate>
           </env:Body>
         </env:Envelope>

data/spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_media_types.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.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 15 Jun 2015 13:08:16 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 13:08:40 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/adds_a_campaign.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://cake-partner-domain.com/api/3/addedit.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/3/">
+          <env:Header/>
+          <env:Body>
+            <cake:Campaign>
+              <cake:api_key>cake-api-key</cake:api_key>
+              <cake:affiliate_id>1</cake:affiliate_id>
+              <cake:offer_id>8910</cake:offer_id>
+              <cake:media_type_id>1</cake:media_type_id>
+              <cake:account_status_id>1</cake:account_status_id>
+              <cake:payout>1.23</cake:payout>
+              <cake:campaign_id>0</cake:campaign_id>
+              <cake:display_link_type_id>1</cake:display_link_type_id>
+              <cake:expiration_date>2045-02-09T01:00:00</cake:expiration_date>
+            </cake:Campaign>
+          </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.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 15 Jun 2015 12:26:41 GMT
+      Content-Length:
+      - '628'
+    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><CampaignResponse
+        xmlns="http://cakemarketing.com/api/3/"><CampaignResult><success>true</success><message>Campaign
+        Created</message><success_info><campaign_id>18243</campaign_id><affiliate_id>1</affiliate_id><offer_id>8910</offer_id><offer_contract_id>1455</offer_contract_id><media_type_id>1</media_type_id><original>true</original></success_info></CampaignResult></CampaignResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Tue, 17 Feb 2015 12:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/edits_a_campaign.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://cake-partner-domain.com/api/3/addedit.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/3/">
+          <env:Header/>
+          <env:Body>
+            <cake:Campaign>
+              <cake:api_key>cake-api-key</cake:api_key>
+              <cake:campaign_id>123</cake:campaign_id>
+              <cake:affiliate_id>1</cake:affiliate_id>
+              <cake:offer_id>8910</cake:offer_id>
+              <cake:media_type_id>1</cake:media_type_id>
+              <cake:account_status_id>1</cake:account_status_id>
+              <cake:payout>1.23</cake:payout>
+              <cake:display_link_type_id>1</cake:display_link_type_id>
+              <cake:expiration_date>2045-02-09T01:00:00</cake:expiration_date>
+            </cake:Campaign>
+          </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.0
+      X-Aspnet-Version:
+      - 4.0.30319
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Mon, 15 Jun 2015 12:27:13 GMT
+      Content-Length:
+      - '626'
+    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><CampaignResponse
+        xmlns="http://cakemarketing.com/api/3/"><CampaignResult><success>true</success><message>Campaign
+        Updated</message><success_info><campaign_id>123</campaign_id><affiliate_id>-1</affiliate_id><offer_id>5078</offer_id><offer_contract_id>123</offer_contract_id><media_type_id>1</media_type_id><original>true</original></success_info></CampaignResult></CampaignResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Tue, 17 Feb 2015 12:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/offers/creates_an_offer.yml

@@ -57,7 +57,7 @@ http_interactions:
               <cake:tags_modification_type>add</cake:tags_modification_type>
               <cake:conversion_cap_behavior>5</cake:conversion_cap_behavior>
               <cake:conversion_behavior_on_redirect>5</cake:conversion_behavior_on_redirect>
-              <cake:expiration_date>2115-01-24T01:00:00</cake:expiration_date>
+              <cake:expiration_date>2045-02-09T01:00:00</cake:expiration_date>
               <cake:offer_type_id>3</cake:offer_type_id>
               <cake:currency_id>2</cake:currency_id>
               <cake:advertiser_id>15886</cake:advertiser_id>

data/spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/offers/updates_an_offer.yml

@@ -57,7 +57,7 @@ http_interactions:
               <cake:tags_modification_type>remove_all</cake:tags_modification_type>
               <cake:conversion_cap_behavior>0</cake:conversion_cap_behavior>
               <cake:conversion_behavior_on_redirect>0</cake:conversion_behavior_on_redirect>
-              <cake:expiration_date>2115-01-24T01:00:00</cake:expiration_date>
+              <cake:expiration_date>2045-02-09T01:00:00</cake:expiration_date>
               <cake:offer_id>8910</cake:offer_id>
               <cake:advertiser_id>15886</cake:advertiser_id>
               <cake:vertical_id>41</cake:vertical_id>

data/spec/integration/soapy_cake/admin_addedit_spec.rb

@@ -1,6 +1,7 @@
 RSpec.describe SoapyCake::AdminAddedit do
   around { |example| Timecop.freeze(Time.utc(2015, 2, 17, 12), &example) }
 
+  let(:affiliate_id) { 1 }
   let(:advertiser_id) { 15886 }
   let(:contact_id) { 8814 }
   let(:vertical_id) { 41 }
@@ -232,4 +233,31 @@ RSpec.describe SoapyCake::AdminAddedit do
       expect(result[:message]).to eq('Offer Tier Added')
     end
   end
+
+  describe 'campaigns' do
+    it 'adds a campaign', :vcr do
+      result = subject.add_campaign(
+        affiliate_id: affiliate_id,
+        offer_id: offer_id,
+        media_type_id: 1,
+        account_status_id: :active,
+        payout: '1.23'
+      )
+
+      expect(result[:message]).to eq('Campaign Created')
+    end
+
+    it 'edits a campaign', :vcr do
+      result = subject.edit_campaign(
+        campaign_id: 123,
+        affiliate_id: affiliate_id,
+        offer_id: offer_id,
+        media_type_id: 1,
+        account_status_id: :active,
+        payout: '1.23'
+      )
+
+      expect(result[:message]).to eq('Campaign Updated')
+    end
+  end
 end

data/spec/integration/soapy_cake/admin_spec.rb

@@ -1,4 +1,6 @@
 RSpec.describe SoapyCake::Admin do
+  around { |example| Timecop.freeze(Time.utc(2015, 6, 15, 12), &example) }
+
   it 'returns an affiliate with correct data types', :vcr do
     result = subject.affiliates(affiliate_id: 16027)
     expect(result.count).to eq(1)
@@ -81,4 +83,13 @@ RSpec.describe SoapyCake::Admin do
       tipalti_iframe_expiration_date: nil
     )
   end
+
+  it 'returns media types', :vcr do
+    result = subject.media_types
+
+    expect(result.first).to eq(
+      media_type_id: 15,
+      type_name: 'Adware'
+    )
+  end
 end

data/spec/lib/soapy_cake/admin_spec.rb

@@ -121,32 +121,32 @@ RSpec.describe SoapyCake::Admin do
 
     describe '#verticals' do
       let(:method) { :verticals }
-      let(:cake_opts) { {} }
+      let(:cake_opts) { nil }
       it_behaves_like 'a cake admin method'
     end
 
     describe '#countries' do
       let(:method) { :countries }
-      let(:cake_opts) { {} }
+      let(:cake_opts) { nil }
       it_behaves_like 'a cake admin method'
     end
 
     describe '#currencies' do
       let(:method) { :currencies }
-      let(:cake_opts) { {} }
+      let(:cake_opts) { nil }
       it_behaves_like 'a cake admin method'
     end
 
     describe '#tiers' do
       let(:method) { :tiers }
       let(:cake_method) { :affiliate_tiers }
-      let(:cake_opts) { {} }
+      let(:cake_opts) { nil }
       it_behaves_like 'a cake admin method'
     end
 
     describe '#blacklist_reasons' do
       let(:method) { :blacklist_reasons }
-      let(:cake_opts) { {} }
+      let(:cake_opts) { nil }
       it_behaves_like 'a cake admin method'
     end
   end

data/spec/support/admin_method_example.rb

@@ -2,9 +2,9 @@ RSpec.shared_examples_for 'a cake admin method' do
   it 'runs the request' do
     request = double('request')
     expect(SoapyCake::Request).to receive(:new)
-      .with(:admin, service, cake_method, cake_opts).and_return(request)
+      .with(:admin, service, cake_method, cake_opts || {}).and_return(request)
     expect(subject).to receive(:run).with(request)
 
-    subject.public_send(method, cake_opts)
+    subject.public_send(method, *[cake_opts].compact)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: soapy_cake
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -199,7 +199,10 @@ files:
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/raises_if_there_is_an_error.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_a_clicks_report_with_a_defined_time_range.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_an_affiliate_with_correct_data_types.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_media_types.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/affiliates/edits_affiliates.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/adds_a_campaign.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/edits_a_campaign.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/contacts/edits_a_contact.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/geo_targeting/creates_geo_targetings.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/offer_/_offer_contract_caps/updates_a_cap_for_an_offer_contract.yml
@@ -249,7 +252,10 @@ test_files:
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/raises_if_there_is_an_error.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_a_clicks_report_with_a_defined_time_range.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_an_affiliate_with_correct_data_types.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_Admin/returns_media_types.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/affiliates/edits_affiliates.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/adds_a_campaign.yml
+- spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/campaigns/edits_a_campaign.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/contacts/edits_a_contact.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/geo_targeting/creates_geo_targetings.yml
 - spec/fixtures/vcr_cassettes/SoapyCake_AdminAddedit/offer_/_offer_contract_caps/updates_a_cap_for_an_offer_contract.yml