bing_ads_ruby_sdk 1.0.0 → 1.3.2

data/spec/bing_ads_ruby_sdk/errors/errors_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+RSpec.describe BingAdsRubySdk::Errors::ApplicationFault do
+  describe '#fault_hash' do
+    context 'when creating an instance' do
+      subject(:create_instance) { described_class.new({ details: nil }) }
+
+      it 'instantiates without raising an exception' do
+        expect { create_instance }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/bing_ads_ruby_sdk/header_spec.rb

@@ -0,0 +1,60 @@
+RSpec.describe BingAdsRubySdk::Header do
+  let(:oauth_store) { double(:oauth_store) }
+  let(:client_secret) { 'pa$$w0rd' }
+  let(:subject) do
+    described_class.new(
+      developer_token: '123abc',
+      client_id: '1a-2b-3c',
+      client_secret: client_secret,
+      store: oauth_store,
+    )
+  end
+  let(:auth_handler) do
+    double(:auth_handler, fetch_or_refresh: 'yes/we/can')
+  end
+
+  before do
+    expect(::BingAdsRubySdk::OAuth2::AuthorizationHandler).to receive(:new).with(
+      developer_token: '123abc',
+      client_id: '1a-2b-3c',
+      client_secret: client_secret,
+      store: oauth_store
+    ).and_return auth_handler
+  end
+
+  describe '.content' do
+    it do
+      expect(subject.content).to eq(
+        "AuthenticationToken" => 'yes/we/can',
+        "DeveloperToken" =>      '123abc',
+        "CustomerId" =>          nil,
+        "CustomerAccountId" =>   nil,
+        "ClientSecret" => client_secret
+      )
+    end
+
+    context "without client_secret" do
+      let(:client_secret) { nil }
+      it do
+        expect(subject.content).to eq(
+          "AuthenticationToken" => 'yes/we/can',
+          "DeveloperToken" =>      '123abc',
+          "CustomerId" =>          nil,
+          "CustomerAccountId" =>   nil
+        )
+      end
+    end
+
+    it 'sets customer' do
+      subject.set_customer(customer_id: 777, account_id: 666 )
+
+      expect(subject.content).to eq(
+        "AuthenticationToken" => 'yes/we/can',
+        "DeveloperToken" =>      '123abc',
+        "CustomerId" =>          777,
+        "CustomerAccountId" =>   666,
+        "ClientSecret" => client_secret
+      )
+    end
+  end
+end

data/spec/bing_ads_ruby_sdk/http_client_spec.rb

@@ -0,0 +1,44 @@
+RSpec.describe BingAdsRubySdk::HttpClient do
+
+  describe ".post" do
+    let(:request) do
+      double(:request,
+        url: "http://bing_url.com/foo",
+        content: "body",
+        headers: "headers"
+      )
+    end
+    let(:excon) { double(:excon) }
+
+    before do
+      expect(::Excon).to receive(:new).and_return(excon)
+      expect(excon).to receive(:post).with(
+        path: "/foo",
+        body: "body",
+        headers: "headers"
+      ).and_return(response)
+    end
+
+    context "successful request" do
+      let(:response) { double(:response, body: "soap xml") }
+      it "returns response's body" do
+        expect(described_class.post(request)).to eq("soap xml")
+      end
+    end
+  end
+
+  describe ".close_http_connections" do
+    let(:connection1) { double("connection1") }
+    let(:connection2) { double("connection2") }
+    it "closes existing connections" do
+      expect(described_class).to receive(:http_connections).and_return({
+        "url1" => connection1,
+        "url2" => connection2,
+      })
+      expect(connection1).to receive :reset
+      expect(connection2).to receive :reset
+
+      described_class.close_http_connections
+    end
+  end
+end

data/spec/bing_ads_ruby_sdk/oauth2/fs_store_spec.rb

@@ -0,0 +1,20 @@
+
+RSpec.describe BingAdsRubySdk::OAuth2::FsStore do
+  after do
+    File.unlink('./.abc') if File.file?('./.abc')
+  end
+  let(:store) { described_class.new('.abc') }
+
+  context "when not empty" do
+    before { store.write(a: 1, b: "2") }
+    it "writes and read properly" do
+      expect(store.read).to eq("a" => 1, "b" => "2")
+    end
+  end
+
+  context "when empty" do
+    it "reads properly" do
+      expect(store.read).to be nil
+    end
+  end
+end

data/spec/bing_ads_ruby_sdk/postprocessors/cast_long_arrays_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.describe BingAdsRubySdk::Postprocessors::CastLongArrays do
+
+  def action(params)
+    described_class.new(params).call
+  end
+
+  it "casts and simplifies long arrays" do
+    expect(action({
+      long: "foo",
+      bar_bar: {
+        long: ['1', '2']
+      },
+      foos: [
+        {
+          bar: {
+            long: ['3', '4']
+          }
+        }
+      ]
+    })).to eq({
+      long: "foo",
+      bar_bar: [1, 2],
+      foos: [
+        { bar: [3, 4] }
+      ]
+    })
+  end
+end

data/spec/bing_ads_ruby_sdk/postprocessors/snakize_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+RSpec.describe BingAdsRubySdk::Postprocessors::Snakize do
+
+  def action(params)
+    described_class.new(params).call
+  end
+
+  it "changes keys to snake version" do
+    expect(action({
+      "Foo" => "foo",
+      "BarBar" => {
+        "BazBaz" => "baz"
+      },
+      "Coucou" => [
+        {
+          "Bisou" => 1
+        }
+      ]
+    })).to eq({
+      foo: "foo",
+      bar_bar: {
+        baz_baz: "baz"
+      },
+      coucou: [
+        {
+          bisou: 1
+        }
+      ]
+    })
+  end
+
+  it "handles properly 'long' tag name" do
+    expect(action({
+      "long" => "1"
+    })).to eq({
+      long: "1"
+    })
+  end
+end

data/spec/bing_ads_ruby_sdk/preprocessors/camelize_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+RSpec.describe BingAdsRubySdk::Preprocessors::Camelize do
+
+  def action(params)
+    described_class.new(params).call
+  end
+
+  it "changes keys to camelize version" do
+    expect(action({
+      foo: "foo",
+      bar_bar: {
+        baz_baz: "baz"
+      },
+      coucou: [
+        {
+          bisou: 1
+        }
+      ]
+    })).to eq({
+      "Foo" => "foo",
+      "BarBar" => {
+        "BazBaz" => "baz"
+      },
+      "Coucou" => [
+        {
+          "Bisou" => 1
+        }
+      ]
+    })
+  end
+
+  it "doesnt camelize 'long' tag name" do
+    expect(action({
+      long: "1"
+    })).to eq({
+      "long" => "1"
+    })
+  end
+end

data/spec/bing_ads_ruby_sdk/preprocessors/order_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+RSpec.describe BingAdsRubySdk::Preprocessors::Order do
+
+  def action
+    new_params = described_class.new(wrapper, unordered_params).call
+    expect(new_params.to_json).to eq(ordered_params.to_json)
+  end
+
+  context "nested hashes" do
+    let(:wrapper) do
+      SpecHelpers.wrapper(:customer_management, "SignupCustomer")
+    end
+
+    let(:unordered_params) {{
+      "Account" => {
+        "Name" => "test account",
+        "CurrencyCode" => "EUR",
+        "ParentCustomerId" => "1234"
+      },
+      "Customer" => {
+        "CustomerAddress" => "address",
+        "Industry" => "industry",
+        "MarketCountry" => "country"
+      },
+      "ParentCustomerId" => "1234"
+    }}
+
+    let(:ordered_params) {{
+      "Customer" => {
+        "Industry" => "industry",
+        "MarketCountry" => "country",
+        "CustomerAddress" => "address"
+      },
+      "Account" => {
+        "CurrencyCode" => "EUR",
+        "Name" => "test account",
+        "ParentCustomerId" => "1234"
+      },
+      "ParentCustomerId" => "1234"
+    }}
+
+    it("orders") { action }
+  end
+
+  context "arrays" do
+    let(:wrapper) do
+      SpecHelpers.wrapper(:campaign_management, "UpdateUetTags")
+    end
+
+    let(:unordered_params) {{
+      "UetTags" => [
+        {
+          "UetTag" => {
+            "Name" => 'mofo2',
+            "Description" => nil,
+            "Id" => '26034398'
+          }
+        }
+      ]
+    }}
+
+    let(:ordered_params) {{
+      "UetTags" => [
+        {
+          "UetTag" => {
+            "Description" => nil,
+            "Id" => '26034398',
+            "Name" => 'mofo2'
+          }
+        }
+      ]
+    }}
+
+    it("orders") { action }
+  end
+
+  context "abstract types" do
+    let(:wrapper) do
+      SpecHelpers.wrapper(:campaign_management, "AddConversionGoals")
+    end
+
+    let(:unordered_params) {{
+      "ConversionGoals" => [
+        {
+          "EventGoal" => {
+            "ActionExpression" => 'contact_form',
+            "ActionOperator" => 'Equals',
+            "ConversionWindowInMinutes" => 43200,
+            "CountType" => "Unique",
+            "Name" => "contact_form",
+            "Revenue" => { "Type" => "NoValue" },
+            "Type" => "Event",
+            "TagId" => 26003317
+          }
+        }
+      ]
+    }}
+
+    let(:ordered_params) {{
+      "ConversionGoals" => [
+        {
+          "EventGoal" => {
+            "ConversionWindowInMinutes" => 43200,
+            "CountType" => "Unique",
+            "Name" => "contact_form",
+            "Revenue" => { "Type" => "NoValue" },
+            "TagId" => 26003317,
+            "Type" => "Event",
+            "ActionExpression" => 'contact_form',
+            "ActionOperator" => 'Equals',
+          }
+        }
+      ]
+    }}
+
+    it("orders") { action }
+  end
+end

data/spec/bing_ads_ruby_sdk/services/bulk_spec.rb

@@ -0,0 +1,56 @@
+RSpec.describe BingAdsRubySdk::Services::Bulk 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 "download_campaigns_by_account_ids" do
+    let(:action) { 'download_campaigns_by_account_ids' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.download_campaigns_by_account_ids(
+          account_ids: [{ long: 150168726 }],
+          data_scope: "EntityData",
+          download_file_type: "Csv",
+          compression_type: "Zip",
+          download_entities: [
+            { download_entity: "Campaigns" }
+          ],
+          format_version: "6.0"
+        )
+      ).to eq({
+        download_request_id: "618504973441"
+      })
+    end
+  end
+
+  describe "get_bulk_download_status" do
+    let(:action) { 'get_bulk_download_status' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_bulk_download_status(request_id: 618504973441)
+      ).to include(
+        request_status: 'Completed',
+        result_file_url: "cool_url"
+      )
+    end
+  end
+end
+
+
+
+

data/spec/bing_ads_ruby_sdk/services/campaign_management_spec.rb

@@ -0,0 +1,307 @@
+RSpec.describe BingAdsRubySdk::Services::CampaignManagement 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 "get_campaigns_by_account_id" do
+    let(:action) { 'get_campaigns_by_account_id' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_campaigns_by_account_id(account_id: 150168726)
+      ).to contain_exactly(
+        a_hash_including(name: "20200015 - 20200015 - SN - B - Activité - Stations_Service - Geoloc - ETA"),
+        a_hash_including(name: "20200015 - 20200015 - SN - E - Produits - Stations_Service - Geoloc - ETA"),
+        a_hash_including(name: "20200015 - SN - X - Station Service #1 - Geozone_custom - 5KW - V3 - ETA")
+      )
+    end
+  end
+
+  describe "get_budgets_by_ids" do
+    let(:action) { 'get_budgets_by_ids' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_budgets_by_ids
+      ).to contain_exactly(
+        a_hash_including(name: "budget_DEFAULT"),
+      )
+    end
+  end
+
+  describe "add_uet_tags" do
+    let(:action) { 'add_uet_tags' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.add_uet_tags({ uet_tags: [ { uet_tag: { name: 'SDK-test', description: nil }}]})
+      ).to include({
+        uet_tags: a_hash_including({
+          uet_tag: a_collection_containing_exactly(
+            a_hash_including(name: "SDK-test")
+          )
+        }),
+        partial_errors: ""
+      })
+    end
+  end
+
+  describe "update_uet_tags" do
+    let(:action) { 'update_uet_tags' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.update_uet_tags({ uet_tags: [ { uet_tag: { name: 'updated SDK-test', id: 96031109, description: nil}}]})
+      ).to eq({
+        partial_errors: ""
+      })
+    end
+  end
+
+  describe "get_uet_tags_by_ids" do
+    let(:action) { 'get_uet_tags_by_ids' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_uet_tags_by_ids(tag_ids: [{ long: 96031109 }])
+      ).to contain_exactly(
+        a_hash_including(name: "updated SDK-test")
+      )
+    end
+  end
+
+  describe "add_conversion_goals" do
+    let(:action) { 'add_conversion_goals' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.add_conversion_goals(conversion_goals: [{
+          event_goal: {
+            action_expression: 'contact_form',
+            action_operator: 'Equals',
+            conversion_window_in_minutes: 43200,
+            count_type: "Unique",
+            name: "sdk test",
+            revenue: { "type": "NoValue" },
+            type: "Event",
+            tag_id: 96031109
+          }
+      }])).to eq({
+        conversion_goal_ids: [46068449],
+        partial_errors: ""
+      })
+    end
+  end
+
+  describe "update_conversion_goals" do
+    let(:action) { 'update_conversion_goals' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.update_conversion_goals(conversion_goals: [{
+          event_goal: {
+            id: 46068449,
+            action_expression: 'contact_form',
+            action_operator: 'Equals',
+            conversion_window_in_minutes: 43200,
+            count_type: "Unique",
+            name: "updated sdk test",
+            revenue: { "type": "NoValue" },
+            tag_id: 96031109
+          }
+      }])).to eq({
+        partial_errors: ""
+      })
+    end
+  end
+
+  describe "get_conversion_goals_by_ids" do
+    let(:action) { 'get_conversion_goals_by_ids' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_conversion_goals_by_ids(
+          conversion_goal_types: "Event",
+          conversion_goal_ids: [{ long: 46068449 }, { long: 46068448 }]
+        )
+      ).to contain_exactly(
+        a_hash_including(name: "updated sdk test"),
+        a_hash_including(name: "random")
+      )
+    end
+  end
+
+  describe "add_ad_extensions" do
+    let(:action) { 'add_ad_extensions' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.add_ad_extensions(
+          account_id: 150168726,
+          ad_extensions: [
+            {
+              call_ad_extension: {
+                scheduling: {},
+                country_code: "NZ",
+                phone_number: "0123456699",
+              }
+            }
+          ]
+      )).to include({
+        ad_extension_identities: a_hash_including({
+          ad_extension_identity: a_collection_containing_exactly(
+            a_hash_including(id: "8177660966625")
+          )
+        }),
+        nested_partial_errors: ""
+      })
+    end
+  end
+
+  describe "get_ad_extension_ids_by_account_id" do
+    let(:action) { 'get_ad_extension_ids_by_account_id' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_ad_extension_ids_by_account_id(
+          account_id: 150168726,
+          ad_extension_type: "CallAdExtension SitelinkAdExtension CalloutAdExtension"
+        )
+      ).to eq([
+        8177660966625
+      ])
+    end
+  end
+
+  describe "set_ad_extensions_associations" do
+    let(:action) { 'set_ad_extensions_associations' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.set_ad_extensions_associations(
+          account_id: 150168726,
+          ad_extension_id_to_entity_id_associations: [{
+            ad_extension_id_to_entity_id_association: {
+              ad_extension_id: 8177660966942,
+              entity_id: 349704437
+            }
+          }],
+          association_type: "Campaign"
+      )).to eq({
+        partial_errors: ""
+      })
+    end
+  end
+
+  describe "get_ad_extensions_associations" do
+    let(:action) { 'get_ad_extensions_associations' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_ad_extensions_associations(
+          account_id: 150168726,
+          association_type: "Campaign",
+          ad_extension_type: "CalloutAdExtension",
+          entity_ids: [ { long: 349704437 }]
+        )
+      ).to contain_exactly(
+        a_hash_including(
+          ad_extension: a_hash_including(id: '8177650858590', text: "Informations Et Contact")
+        ),
+        a_hash_including(
+          ad_extension: a_hash_including(id: '8177660966942', text: "CalloutText")
+        )
+      )
+    end
+  end
+
+  describe "add_shared_entity" do
+    let(:action) { 'add_shared_entity' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.add_shared_entity(
+          negative_keyword_list: {
+            name: 'sdk list'
+          }
+      )).to eq({
+        list_item_ids: "",
+        partial_errors: "",
+        shared_entity_id: "229798145242911"
+      })
+    end
+  end
+
+  describe "get_shared_entities_by_account_id" do
+    let(:action) { 'get_shared_entities_by_account_id' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_shared_entities_by_account_id(
+          shared_entity_type: "NegativeKeywordList"
+      )).to contain_exactly(
+        a_hash_including(id: '229798145242911', name: "sdk list")
+      )
+    end
+  end
+
+  describe "get_shared_entity_associations_by_entity_ids" do
+    let(:action) { 'get_shared_entity_associations_by_entity_ids' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.get_shared_entity_associations_by_entity_ids({
+          entity_ids: [{ long: 349704435 }],
+          entity_type: "Campaign",
+          shared_entity_type: "NegativeKeywordList"
+      })).to eq([
+        { entity_id: "349704435", entity_type: "Campaign", shared_entity_id: "223200992903993", shared_entity_type: "NegativeKeywordList" }
+      ])
+    end
+  end
+
+  describe "set_shared_entity_associations" do
+    let(:action) { 'set_shared_entity_associations' }
+    let(:filename) { 'standard' }
+
+    it "returns expected result" do
+      expect(
+        service.set_shared_entity_associations(
+          associations: [{
+                           shared_entity_association: {
+                             entity_id: "349704435",
+                             entity_type: "Account",
+                             shared_entity_id: "223200992903993",
+                             shared_entity_type: "PlacementExclusionList"
+                           },
+                         }]
+      )).to eq({ partial_errors: "" })
+    end
+  end
+end