soapy_cake 2.1.0 → 2.1.1

data/spec/fixtures/vcr_cassettes/SoapyCake_Campaigns/_update/raises_an_error_if_the_update_was_unsuccessful.yml

@@ -0,0 +1,82 @@
+---
+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:account_status_id>0</cake:account_status_id>
+              <cake:expiration_date_modification_type>remove</cake:expiration_date_modification_type>
+              <cake:currency_id>0</cake:currency_id>
+              <cake:use_offer_contract_payout>no_change</cake:use_offer_contract_payout>
+              <cake:payout_update_option>change</cake:payout_update_option>
+              <cake:paid>no_change</cake:paid>
+              <cake:paid_redirects>no_change</cake:paid_redirects>
+              <cake:paid_upsells>no_change</cake:paid_upsells>
+              <cake:review>no_change</cake:review>
+              <cake:auto_disposition_delay_hours>0</cake:auto_disposition_delay_hours>
+              <cake:redirect_offer_contract_id>0</cake:redirect_offer_contract_id>
+              <cake:redirect_404>no_change</cake:redirect_404>
+              <cake:clear_session_on_conversion>no_change</cake:clear_session_on_conversion>
+              <cake:postback_delay_ms>-1</cake:postback_delay_ms>
+              <cake:affiliate_id>9643</cake:affiliate_id>
+              <cake:display_link_type_id>1</cake:display_link_type_id>
+              <cake:media_type_id>1</cake:media_type_id>
+              <cake:offer_contract_id>10338</cake:offer_contract_id>
+              <cake:offer_id>11390</cake:offer_id>
+              <cake:payout>1.23</cake:payout>
+              <cake:pixel_html>&lt;img src="https://example.com/pixel.png"&gt;</cake:pixel_html>
+              <cake:postback_url>http://example.com/postback</cake:postback_url>
+              <cake:redirect_domain>trk_ad2games.cakemarketing.net</cake:redirect_domain>
+              <cake:test_link>http://example.com/test</cake:test_link>
+              <cake:third_party_name>Max</cake:third_party_name>
+              <cake:unique_key_hash>sha1</cake:unique_key_hash>
+              <cake:campaign_id>9999999</cake:campaign_id>
+              <cake:expiration_date>1970-01-01T01:00:00</cake:expiration_date>
+            </cake:Campaign>
+          </env:Body>
+        </env:Envelope>
+    headers:
+      Content-Type:
+      - application/soap+xml;charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  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:
+      - Fri, 11 Nov 2016 15:57:24 GMT
+      Content-Length:
+      - '416'
+    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>false</success><message>Invalid
+        Campaign ID</message></CampaignResult></CampaignResponse></soap:Body></soap:Envelope>
+    http_version: 
+  recorded_at: Fri, 11 Nov 2016 15:57:47 GMT
+recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/SoapyCake_Campaigns/_update/updates_campaigns.yml

@@ -0,0 +1,82 @@
+---
+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:account_status_id>0</cake:account_status_id>
+              <cake:expiration_date_modification_type>remove</cake:expiration_date_modification_type>
+              <cake:currency_id>0</cake:currency_id>
+              <cake:use_offer_contract_payout>no_change</cake:use_offer_contract_payout>
+              <cake:payout_update_option>change</cake:payout_update_option>
+              <cake:paid>no_change</cake:paid>
+              <cake:paid_redirects>no_change</cake:paid_redirects>
+              <cake:paid_upsells>no_change</cake:paid_upsells>
+              <cake:review>no_change</cake:review>
+              <cake:auto_disposition_delay_hours>0</cake:auto_disposition_delay_hours>
+              <cake:redirect_offer_contract_id>0</cake:redirect_offer_contract_id>
+              <cake:redirect_404>no_change</cake:redirect_404>
+              <cake:clear_session_on_conversion>no_change</cake:clear_session_on_conversion>
+              <cake:postback_delay_ms>-1</cake:postback_delay_ms>
+              <cake:affiliate_id>9643</cake:affiliate_id>
+              <cake:display_link_type_id>1</cake:display_link_type_id>
+              <cake:media_type_id>1</cake:media_type_id>
+              <cake:offer_contract_id>10338</cake:offer_contract_id>
+              <cake:offer_id>11390</cake:offer_id>
+              <cake:payout>1.23</cake:payout>
+              <cake:pixel_html>&lt;img src="https://example.com/pixel.png"&gt;</cake:pixel_html>
+              <cake:postback_url>http://example.com/postback</cake:postback_url>
+              <cake:redirect_domain>trk_ad2games.cakemarketing.net</cake:redirect_domain>
+              <cake:test_link>http://example.com/test</cake:test_link>
+              <cake:third_party_name>Max</cake:third_party_name>
+              <cake:unique_key_hash>sha1</cake:unique_key_hash>
+              <cake:campaign_id>23602</cake:campaign_id>
+              <cake:expiration_date>1970-01-01T01:00:00</cake:expiration_date>
+            </cake:Campaign>
+          </env:Body>
+        </env:Envelope>
+    headers:
+      Content-Type:
+      - application/soap+xml;charset=UTF-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  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:
+      - Fri, 11 Nov 2016 15:57:24 GMT
+      Content-Length:
+      - '633'
+    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>23602</campaign_id><affiliate_id>9643</affiliate_id><offer_id>11390</offer_id><offer_contract_id>10338</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: Fri, 11 Nov 2016 15:57:47 GMT
+recorded_with: VCR 3.0.3

data/spec/integration/soapy_cake/admin_addedit_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 RSpec.describe SoapyCake::AdminAddedit do
-  # rubocop:disable RSpec/NestedGroups
   subject(:admin_addedit) { described_class.new }
 
   around { |example| Timecop.freeze(Time.utc(2015, 2, 17, 12), &example) }
@@ -284,34 +283,4 @@ RSpec.describe SoapyCake::AdminAddedit do
       expect(result[:message]).to eq('Offer Tier Replaced')
     end
   end
-
-  describe 'campaigns' do
-    it 'adds a campaign', :vcr do
-      result = admin_addedit.add_campaign(
-        affiliate_id: affiliate_id,
-        offer_id: offer_id,
-        media_type_id: 1,
-        account_status_id: :active,
-        payout: '1.23',
-        redirect_404: false,
-        clear_session_on_conversion: false,
-        paid_upsells: false
-      )
-
-      expect(result[:message]).to eq('Campaign Created')
-    end
-
-    it 'edits a campaign', :vcr do
-      result = admin_addedit.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/campaigns_spec.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+RSpec.describe SoapyCake::Campaigns, :vcr do
+  let(:offer_id) { 11390 }
+  let(:affiliate_id) { 9643 }
+  let(:redirect_domain) { 'trk_ad2games.cakemarketing.net' }
+
+  subject(:client) { described_class.new }
+
+  describe '#get' do
+    it 'gets campaigns' do
+      campaigns = client.get(offer_id: offer_id)
+      expect(campaigns.first.dig(:offer, :offer_id)).to eq(offer_id)
+    end
+  end
+
+  describe '#create' do
+    it 'creates campaigns' do
+      campaign_id = client.create(
+        account_status_id: 1,
+        affiliate_id: affiliate_id,
+        display_link_type_id: 1,
+        media_type_id: 1,
+        offer_id: offer_id
+      )
+      expect(campaign_id).to be_a(Integer)
+    end
+
+    it 'raises an error if the creation was unsuccessful' do
+      expect do
+        client.create(
+          account_status_id: 1,
+          affiliate_id: 0,
+          display_link_type_id: 1,
+          media_type_id: 1,
+          offer_id: offer_id
+        )
+      end.to raise_error(SoapyCake::RequestFailed, 'Invalid Affiliate')
+    end
+  end
+
+  describe '#update' do
+    it 'updates campaigns' do
+      response = client.update(
+        23602,
+        affiliate_id: affiliate_id,
+        display_link_type_id: 1,
+        media_type_id: 1,
+        offer_contract_id: 10338,
+        offer_id: 11390,
+        payout: 1.23,
+        pixel_html: '<img src="https://example.com/pixel.png">',
+        postback_url: 'http://example.com/postback',
+        redirect_domain: redirect_domain,
+        test_link: 'http://example.com/test',
+        third_party_name: 'Max',
+        unique_key_hash: 'sha1'
+      )
+      expect(response).to be(nil)
+    end
+
+    it 'raises an error if the update was unsuccessful' do
+      expect do
+        client.update(
+          9999999,
+          affiliate_id: affiliate_id,
+          display_link_type_id: 1,
+          media_type_id: 1,
+          offer_contract_id: 10338,
+          offer_id: 11390,
+          payout: 1.23,
+          pixel_html: '<img src="https://example.com/pixel.png">',
+          postback_url: 'http://example.com/postback',
+          redirect_domain: redirect_domain,
+          test_link: 'http://example.com/test',
+          third_party_name: 'Max',
+          unique_key_hash: 'sha1'
+        )
+      end.to raise_error(SoapyCake::RequestFailed, 'Invalid Campaign ID')
+    end
+  end
+
+  describe '#patch' do
+    let(:admin) { SoapyCake::Admin.new }
+    let(:campaign_id) { 23733 }
+
+    it 'updates a campaign' do
+      %w(foo bar).each do |name|
+        client.patch(campaign_id, third_party_name: name)
+        campaign = client.get(campaign_id: campaign_id).first
+        expect(campaign.fetch(:third_party_name)).to eq(name)
+      end
+    end
+
+    context 'different pre-existing values' do
+      let(:attribute_sets) do
+        [
+          {
+            affiliate_id: affiliate_id,
+            campaign_id: campaign_id,
+            offer_id: offer_id,
+
+            account_status_id: 1,
+            auto_disposition_delay_hours: 0,
+            clear_session_on_conversion: true,
+            currency_id: 1,
+            display_link_type_id: 1,
+            expiration_date: Time.utc(2016, 11, 9),
+            expiration_date_modification_type: 'change',
+            media_type_id: 1,
+            offer_contract_id: 10338,
+            paid: true,
+            paid_redirects: true,
+            paid_upsells: true,
+            payout: 0,
+            payout_update_option: 'remove',
+            pixel_html: '',
+            postback_delay_ms: -1,
+            postback_url: '',
+            redirect_404: true,
+            redirect_domain: redirect_domain,
+            redirect_offer_contract_id: 10337,
+            review: true,
+            test_link: '',
+            unique_key_hash: 'none',
+            use_offer_contract_payout: true,
+            third_party_name: ''
+          },
+          {
+            affiliate_id: affiliate_id,
+            campaign_id: campaign_id,
+            offer_id: offer_id,
+
+            account_status_id: 2,
+            auto_disposition_delay_hours: 1,
+            clear_session_on_conversion: false,
+            currency_id: 2,
+            display_link_type_id: 1,
+            expiration_date: Time.utc(1970, 1, 1),
+            expiration_date_modification_type: 'remove',
+            media_type_id: 2,
+            offer_contract_id: 10342,
+            paid: false,
+            paid_redirects: false,
+            paid_upsells: false,
+            payout: 1,
+            payout_update_option: 'change',
+            pixel_html: 'pixelpixelpixel',
+            postback_delay_ms: 100,
+            postback_url: 'https://example.com/postback',
+            redirect_404: false,
+            redirect_domain: redirect_domain,
+            redirect_offer_contract_id: 10339,
+            review: false,
+            test_link: 'https://example.com/test',
+            unique_key_hash: 'sha1',
+            use_offer_contract_payout: false,
+            third_party_name: 'Best Campaign Ever'
+          }
+        ]
+      end
+
+      2.times do |i|
+        it "does not change anything unintentionally (attribute set: #{i})" do
+          client.update(campaign_id, attribute_sets[i])
+
+          campaign_before = client.get(campaign_id: campaign_id).first
+          client.patch(campaign_id)
+          campaign_after = client.get(campaign_id: campaign_id).first
+
+          expect(campaign_after).to eq(campaign_before)
+        end
+      end
+    end
+  end
+end

data/spec/lib/soapy_cake/admin_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 RSpec.describe SoapyCake::Admin do
-  # rubocop:disable RSpec/NestedGroups
   subject(:admin) { described_class.new }
   let(:opts) { nil }
   let(:cake_opts) { opts }

data/spec/lib/soapy_cake/campaigns_spec.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+RSpec.describe SoapyCake::Campaigns do
+  let(:campaigns) { described_class.new }
+  let(:client) { instance_double(SoapyCake::Client) }
+  let(:campaign_id) { 1 }
+
+  before do
+    allow(SoapyCake::Client).to receive(:new).and_return(client)
+    allow(client).to receive(:run).with(an_instance_of(SoapyCake::Request))
+  end
+
+  let(:default_params) do
+    {
+      affiliate_id: 1,
+      display_link_type_id: 2,
+      media_type_id: 3,
+      offer_contract_id: 4,
+      offer_id: 5,
+      payout: 6.0,
+      pixel_html: '<img src="https://example.com/pixel.png">',
+      postback_url: 'http://example.com/postback',
+      redirect_domain: 'example.com',
+      test_link: 'http://example.com/test',
+      third_party_name: 'Max',
+      unique_key_hash: 'foo'
+    }
+  end
+
+  def expect_request_to_be_built_with(opts)
+    expect(SoapyCake::Request).to receive(:new).with(
+      :admin,
+      :addedit,
+      :campaign,
+      a_hash_including(opts)
+    ).and_call_original
+  end
+
+  context 'setting an expiration date' do
+    let(:expiration_date) { Time.new(2016, 11, 10) }
+
+    context 'without an `expiration_date_modification_type`' do
+      it 'changes the expiration date if an `expiration_date` is provided' do
+        expect_request_to_be_built_with(
+          expiration_date: expiration_date,
+          expiration_date_modification_type: 'change'
+        )
+
+        campaigns.update(
+          campaign_id,
+          default_params.merge(expiration_date: expiration_date)
+        )
+      end
+
+      it 'removes the expiration date if no `expiration_date` is provided' do
+        expect_request_to_be_built_with(
+          expiration_date: Time.utc(1970, 1, 1),
+          expiration_date_modification_type: 'remove'
+        )
+
+        campaigns.update(campaign_id, default_params)
+      end
+    end
+
+    context 'with an `expiration_date_modification_type` provided' do
+      it 'passes along both, the `expiration_date` and `expiration_date_modification_type`' do
+        expect_request_to_be_built_with(
+          expiration_date: expiration_date,
+          expiration_date_modification_type: 'change'
+        )
+
+        campaigns.update(
+          campaign_id,
+          default_params.merge(expiration_date: expiration_date,
+                               expiration_date_modification_type: 'change')
+        )
+      end
+
+      it 'sets the expiration_date to something if the modification type is `remove`' do
+        expect_request_to_be_built_with(
+          expiration_date: Time.utc(1970, 1, 1),
+          expiration_date_modification_type: 'remove'
+        )
+
+        campaigns.update(
+          campaign_id,
+          default_params.merge(expiration_date_modification_type: 'remove')
+        )
+      end
+    end
+  end
+
+  context 'setting a payout' do
+    context '`payout_update_option` is not provided' do
+      it 'changes the payout if a payout is provided' do
+        expect_request_to_be_built_with(payout: 1.23, payout_update_option: 'change')
+
+        campaigns.update(
+          campaign_id,
+          default_params.merge(payout: 1.23)
+        )
+      end
+    end
+  end
+
+  describe 'translating values' do
+    it 'translates values that have a translation' do
+      expect_request_to_be_built_with(account_status_id: 3)
+
+      campaigns.update(
+        campaign_id,
+        default_params.merge(account_status: :pending)
+      )
+    end
+
+    it 'raises an exception, if the value cannot be translated' do
+      expect do
+        campaigns.update(
+          campaign_id,
+          default_params.merge(account_status: :misbehaved)
+        )
+      end.to raise_error(
+        ArgumentError,
+        'misbehaved is not a valid value for account_status_id'
+      )
+    end
+  end
+end