bing_ads_ruby_sdk 1.0.0 → 1.3.2

data/spec/bing_ads_ruby_sdk/services/customer_management_spec.rb

@@ -0,0 +1,97 @@
+RSpec.describe BingAdsRubySdk::Services::CustomerManagement do
+
+  let(:service_name) { described_class.service }
+  let(:soap_client) { SpecHelpers.soap_client(service_name) }
+  let(:expected_xml) { SpecHelpers.request_xml_for(service_name, action, filename) }
+  let(:mocked_response) { SpecHelpers.response_xml_for(service_name, action, filename) }
+
+  let(:service) { described_class.new(soap_client) }
+
+  before do
+    expect(BingAdsRubySdk::HttpClient).to receive(:post) do |req|
+      expect(Nokogiri::XML(req.content).to_xml).to eq expected_xml.to_xml
+      mocked_response
+    end
+  end
+
+  describe "signup_customer" do
+    let(:action) { 'signup_customer' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.signup_customer(
+          parent_customer_id: 9876,
+          customer: {
+            industry: "NA",
+            market_country: 'FR',
+            market_language: 'French',
+            name: 'sdk customer',
+            customer_address: {
+              city: "Nice",
+              country_code: "FR",
+              line1: "127 bd risso",
+              postal_code: "06000"
+            }
+          },
+          # Note that the structure of this type is slightly different to other types, in accord with the Bing WSDL
+          account: {
+            '@type' => 'AdvertiserAccount',
+            currency_code: "EUR",
+            name: 'SDK account'
+          }
+        )
+      ).to include(
+        customer_id: "1234",
+        account_id: "5678"
+      )
+    end
+  end
+
+  describe "get_account" do
+    let(:action) { 'get_account' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_account(account_id: 5678)
+      ).to include(
+        account: a_hash_including( id: "5678", name: "SDKTEST")
+      )
+    end
+  end
+
+  describe "update_account" do
+    let(:action) { 'update_account' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.update_account(
+          account: {
+            '@type' => 'AdvertiserAccount',
+            id: 5678,
+            time_stamp: "AAAAAE496a4=",
+            currency_code: "EUR",
+            name: "SDKTEST updated"
+          }
+        )
+      ).to eq(
+        last_modified_time: "2019-01-18T13:16:38.827"
+      )
+    end
+  end
+
+  describe "find_accounts_or_customers_info" do
+    let(:action) { 'find_accounts_or_customers_info' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.find_accounts_or_customers_info(filter: 'SDKTEST', top_n: 1)
+      ).to contain_exactly(
+        a_hash_including(customer_name: "SDKTEST updated", account_id: "5678")
+      )
+    end
+  end
+end

data/spec/bing_ads_ruby_sdk_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe BingAdsRubySdk do
+  it "has a version number" do
+    expect(BingAdsRubySdk::VERSION).not_to be nil
+  end
+end

data/spec/examples/1_customer_creation/customer_spec.rb

@@ -0,0 +1,35 @@
+require_relative '../examples'
+
+RSpec.describe 'CustomerManagement service' do
+  include_context 'use api'
+
+  it "creates customer" do
+    created_customer = api.customer_management.signup_customer(
+      customer: {
+        customer_address: {
+          city: 'Paris',
+          postal_code: 75_001,
+          line1: '1 rue de Rivoli',
+          country_code: 'FR',
+        },
+        industry: 'Entertainment',
+        name: "Test Customer #{random}",
+      },
+      account: {
+        '@type' => 'AdvertiserAccount',
+        name: "Test Account #{random}",
+        currency_code: 'USD',
+      },
+      parent_customer_id: Examples.parent_customer_id
+    )
+    expect(created_customer).to include(
+      customer_id: a_kind_of(String),
+      customer_number: a_kind_of(String),
+      account_id: a_kind_of(String),
+      account_number: a_kind_of(String),
+      create_time: a_kind_of(String)
+    )
+
+    puts "You can now fill in examples.rb with customer_id: #{created_customer[:customer_id]} and account_id: #{created_customer[:account_id]}"
+  end
+end

data/spec/examples/2_with_customer/budget_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../examples'
+
+RSpec.describe 'Budget methods' do
+  include_context 'use api'
+
+  let(:budget_id) { add_budget[:budget_ids].first }
+
+  let(:add_budget) do
+    api.campaign_management.call(:add_budgets,
+      budgets: [
+        budget: {
+          amount: '10',
+          budget_type: 'DailyBudgetStandard',
+          name: "test_budget #{random}",
+        }
+      ]
+    )
+  end
+
+  describe '#add_budget' do
+    it 'returns budget ids for created Budgets' do
+      expect(add_budget).to include(
+        budget_ids: [a_kind_of(Integer)],
+        partial_errors: ''
+      )
+    end
+  end
+
+  describe '#get_budgets_by_ids' do
+    before { add_budget }
+
+    it 'returns a list of budgets' do
+      expect(api.campaign_management.get_budgets_by_ids(
+        budget_ids: [long: budget_id]
+      )).to include({
+        amount: '10.00',
+        association_count: '0',
+        budget_type: 'DailyBudgetStandard',
+        id: a_kind_of(String),
+        name: a_string_starting_with('test_budget'),
+      })
+    end
+  end
+
+  describe '#delete_budgets' do
+    before { add_budget }
+
+    it 'returns no errors' do
+      expect(api.campaign_management.call(:delete_budgets,
+        budget_ids: [ { long: budget_id } ]
+      )).to eq(partial_errors: '')
+    end
+  end
+end

data/spec/examples/2_with_customer/campaigns_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../examples'
+
+RSpec.describe 'CampaignManagement service' do
+  include_context 'use api'
+
+  describe 'Campaign methods' do
+    it 'returns campaign ids' do
+      campaigns = api.campaign_management.call(:add_campaigns,
+        account_id: Examples.account_id,
+        campaigns: {
+          campaign:
+            {
+              name: "Acceptance Test Campaign #{random}",
+              daily_budget: 10,
+              budget_type: 'DailyBudgetStandard',
+              time_zone: 'BrusselsCopenhagenMadridParis'
+            }
+        }
+      )
+      expect(campaigns).to include(
+        partial_errors: '',
+        campaign_ids: [a_kind_of(Integer)]
+      )
+      puts "You can now fill in examples.rb with campaign_id: #{campaigns[:campaign_ids].first}"
+    end
+  end
+end

data/spec/examples/2_with_customer/customer_management_spec.rb

@@ -0,0 +1,190 @@
+require_relative '../examples'
+
+RSpec.describe 'CustomerManagement service' do
+  include_context 'use api'
+
+  let(:get_customer) do
+    api.customer_management.call(:get_customer, customer_id: Examples.customer_id)
+  end
+
+  let(:get_account) do
+    api.customer_management.get_account(account_id: Examples.account_id)
+  end
+
+  describe 'Account methods' do
+    describe '#find_accounts' do
+      subject do
+        api.customer_management.call(:find_accounts,
+          account_filter: '',
+          customer_id: Examples.customer_id,
+          top_n: 1
+        )
+      end
+
+      it 'returns a list of basic account information' do
+        is_expected.to include(
+          accounts_info: {
+            account_info: [
+              {
+                id: a_kind_of(String),
+                name: a_kind_of(String),
+                number: a_kind_of(String),
+                account_life_cycle_status: a_kind_of(String),
+                pause_reason: nil,
+              },
+            ],
+          }
+        )
+      end
+    end
+
+    describe '#find_accounts_or_customers_info' do
+      subject do
+        api.customer_management.find_accounts_or_customers_info(
+          filter: '',
+          top_n: 1
+        )
+      end
+
+      it 'returns a list of records containing account / customer pairs' do
+        is_expected.to contain_exactly(
+          {
+            customer_id: a_kind_of(String),
+            customer_name: a_kind_of(String),
+            account_id: a_kind_of(String),
+            account_name: a_kind_of(String),
+            account_number: a_kind_of(String),
+            account_life_cycle_status: a_kind_of(String), # e.g. 'Active'
+            pause_reason: nil,
+          }
+        )
+      end
+    end
+
+    describe '#get_account' do
+      it 'returns information about the current account' do
+        expect(get_account).to include(
+          account: {
+            bill_to_customer_id: a_kind_of(String),
+            currency_code: "USD",
+            account_financial_status: "ClearFinancialStatus",
+            id: a_kind_of(String),
+            language: "English",
+            last_modified_by_user_id: a_kind_of(String),
+            last_modified_time: a_kind_of(String),
+            name: a_string_starting_with("Test Account"),
+            number: a_kind_of(String),
+            parent_customer_id: a_kind_of(String),
+            payment_method_id: a_kind_of(String),
+            payment_method_type: nil,
+            primary_user_id: a_kind_of(String),
+            account_life_cycle_status: "Active",
+            time_stamp: a_kind_of(String),
+            time_zone: a_kind_of(String),
+            pause_reason: nil,
+            forward_compatibility_map: nil,
+            linked_agencies: {
+              customer_info: [
+                {
+                  id: a_kind_of(String),
+                  name: a_kind_of(String),
+                }
+              ],
+            },
+            sales_house_customer_id: nil,
+            tax_information: "",
+            back_up_payment_instrument_id: nil,
+            billing_threshold_amount: nil,
+            business_address: nil,
+            auto_tag_type: "Inactive",
+            sold_to_payment_instrument_id: nil
+          }
+        )
+      end
+    end
+
+    describe '#update_account' do
+      let(:account) { get_account[:account] }
+      subject do
+        api.customer_management.update_account(
+          account: {
+            '@type' => 'AdvertiserAccount',
+            id: account[:id],
+            time_stamp: account[:time_stamp],
+            name: "Test Account #{Time.now} - updated",
+          }
+        )
+      end
+
+      it 'returns the last modified time' do
+        is_expected.to include(last_modified_time: a_kind_of(String))
+      end
+    end
+  end
+
+  describe 'Customer methods' do
+    describe 'get_customer' do
+      it 'returns customer data' do
+        expect(get_customer).to include(
+          customer: {
+            customer_financial_status: "ClearFinancialStatus",
+            id: a_kind_of(String),
+            industry: "Entertainment",
+            last_modified_by_user_id: a_kind_of(String),
+            last_modified_time: a_kind_of(String),
+            market_country: "US",
+            forward_compatibility_map: a_kind_of(Hash),
+            market_language: "English",
+            name: a_string_starting_with("Test Customer"),
+            service_level: "SelfServe",
+            customer_life_cycle_status: "Active",
+            time_stamp: a_kind_of(String),
+            number: a_kind_of(String),
+            customer_address: a_kind_of(Hash),
+          }
+        )
+      end
+    end
+
+    describe '#get_customers_info' do
+      subject do
+        api.customer_management.call(:get_customers_info,
+          customer_name_filter: '',
+          top_n: 1
+        )
+      end
+
+      it 'returns a list of simple customer information' do
+        is_expected.to include(
+          customers_info: {
+            customer_info: a_collection_including(
+              {
+                id: a_kind_of(String),
+                name: a_kind_of(String),
+              }
+            )
+          }
+        )
+      end
+    end
+
+    describe '#update_customer' do
+      let(:original_customer) { get_customer }
+
+      subject do
+        api.customer_management.call(:update_customer, {
+          customer: {
+            name: "Test Customer - #{Time.now}",
+            id: Examples.customer_id,
+            time_stamp: original_customer[:customer][:time_stamp],
+            industry: original_customer[:customer][:industry]
+          }
+        })
+      end
+
+      it 'returns the update timestamp' do
+        is_expected.to include(last_modified_time: a_kind_of(String))
+      end
+    end
+  end
+end

data/spec/examples/2_with_customer/uet_tags_spec.rb

@@ -0,0 +1,42 @@
+require_relative '../examples'
+
+RSpec.describe 'CampaignManagement service' do
+  include_context 'use api'
+
+  describe 'UET methods' do
+    subject(:add_uet_tags) do
+      api.campaign_management.add_uet_tags(
+        uet_tags: [
+          uet_tag: {
+            description: 'UET Tag Description',
+            name: "Acceptance Test UET Tag #{random}",
+          }
+        ]
+      )
+    end
+
+    describe '#add_uet_tags' do
+      it 'returns a list of newly created UET tags' do
+        uet_tags = add_uet_tags
+        expect(uet_tags).to include(
+          uet_tags: {
+            uet_tag: [
+              {
+                description: 'UET Tag Description',
+                id: a_kind_of(String),
+                name: a_string_starting_with('Acceptance Test UET Tag'),
+                tracking_no_script: a_string_starting_with("<img src=\"//bat.bing.com/action/"),
+                tracking_script: a_string_starting_with('<script>(function(w,d,t,r,u)'),
+                tracking_status: 'Unverified',
+                customer_share: nil
+              }
+            ]
+          },
+          partial_errors: ''
+        )
+
+        puts "Please fill in examples.rb with uet_tag_id: #{uet_tags[:uet_tags][:uet_tag].first[:id]}"
+      end
+    end
+  end
+end