soapy_bing 0.3.1 → 0.4.0

data/spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_status.yml

@@ -1,284 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://login.live.com/oauth20_token.srf
-    body:
-      encoding: UTF-8
-      string: client_id=bing-ads-oauth-client-id&client_secret=bing-ads-oauth-client-secret&grant_type=refresh_token&refresh_token=bing-ads-oauth-refresh-token
-    headers:
-      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:
-      - no-store
-      Pragma:
-      - no-cache
-      Content-Length:
-      - '1317'
-      Content-Type:
-      - application/json
-      Server:
-      - Microsoft-IIS/8.5
-      X-Content-Type-Options:
-      - nosniff
-      Date:
-      - Fri, 13 Nov 2015 14:23:33 GMT
-      Connection:
-      - close
-    body:
-      encoding: UTF-8
-      string: '{"token_type":"bearer","expires_in":3600,"scope":"bingads.manage","access_token":"bing-ads-oauth-authentication-token","refresh_token":"bing-ads-oauth-refresh-token","user_id":"bing-ads-oauth-user-id"}'
-    http_version: 
-  recorded_at: Fri, 13 Nov 2015 14:23:34 GMT
-- request:
-    method: post
-    uri: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc
-    body:
-      encoding: UTF-8
-      string: |
-        <?xml version="1.0" encoding="UTF-8"?>
-        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                      xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
-                      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
-                      xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
-            <env:Header>
-                <tns:CustomerAccountId>bing-ads-account-id</tns:CustomerAccountId>
-                <tns:CustomerId>bing-ads-customer-id</tns:CustomerId>
-                <tns:DeveloperToken>bing-ads-developer-token</tns:DeveloperToken>
-                <tns:AuthenticationToken>bing-ads-oauth-authentication-token</tns:AuthenticationToken>
-            </env:Header>
-            <env:Body>
-                <tns:SubmitGenerateReportRequest>
-                    <tns:ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="tns:CampaignPerformanceReportRequest">
-                        <tns:Format>Csv</tns:Format>
-                        <tns:Language>English</tns:Language>
-                        <tns:ReportName>MyReport</tns:ReportName>
-                        <tns:ReturnOnlyCompleteData>false</tns:ReturnOnlyCompleteData>
-                        <tns:Aggregation>HourOfDay</tns:Aggregation>
-                        <tns:Columns>
-                                <tns:CampaignPerformanceReportColumn>TimePeriod</tns:CampaignPerformanceReportColumn>
-                                <tns:CampaignPerformanceReportColumn>Impressions</tns:CampaignPerformanceReportColumn>
-                                <tns:CampaignPerformanceReportColumn>Clicks</tns:CampaignPerformanceReportColumn>
-                                <tns:CampaignPerformanceReportColumn>Spend</tns:CampaignPerformanceReportColumn>
-                        </tns:Columns>
-                        <tns:Scope>
-                            <tns:AccountIds>
-                                <arr:long>bing-ads-account-id</arr:long>
-                            </tns:AccountIds>
-                        </tns:Scope>
-                        <tns:Time>
-                            <tns:CustomDateRangeEnd>
-                                <tns:Day>14</tns:Day>
-                                <tns:Month>10</tns:Month>
-                                <tns:Year>2015</tns:Year>
-                            </tns:CustomDateRangeEnd>
-                            <tns:CustomDateRangeStart>
-                                <tns:Day>14</tns:Day>
-                                <tns:Month>10</tns:Month>
-                                <tns:Year>2015</tns:Year>
-                            </tns:CustomDateRangeStart>
-                        </tns:Time>
-                    </tns:ReportRequest>
-                </tns:SubmitGenerateReportRequest>
-            </env:Body>
-        </env:Envelope>
-    headers:
-      Content-Type:
-      - text/xml;charset=UTF-8
-      Soapaction:
-      - SubmitGenerateReport
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Length:
-      - '396'
-      Content-Type:
-      - text/xml; charset=utf-8
-      Server:
-      - Microsoft-IIS/8.0
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Fri, 13 Nov 2015 14:23:35 GMT
-    body:
-      encoding: UTF-8
-      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Header><h:TrackingId
-        xmlns:h="https://bingads.microsoft.com/Reporting/v9">bing-ads-report-tracking-id</h:TrackingId></s:Header><s:Body><SubmitGenerateReportResponse
-        xmlns="https://bingads.microsoft.com/Reporting/v9"><ReportRequestId>bing-ads-report-request-id</ReportRequestId></SubmitGenerateReportResponse></s:Body></s:Envelope>
-    http_version: 
-  recorded_at: Fri, 13 Nov 2015 14:23:35 GMT
-- request:
-    method: post
-    uri: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc
-    body:
-      encoding: UTF-8
-      string: |
-        <?xml version="1.0" encoding="UTF-8"?>
-        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                      xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
-                      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
-                      xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
-            <env:Header>
-                <tns:CustomerAccountId>bing-ads-account-id</tns:CustomerAccountId>
-                <tns:CustomerId>bing-ads-customer-id</tns:CustomerId>
-                <tns:DeveloperToken>bing-ads-developer-token</tns:DeveloperToken>
-                <tns:AuthenticationToken>bing-ads-oauth-authentication-token</tns:AuthenticationToken>
-            </env:Header>
-            <env:Body>
-                <tns:PollGenerateReportRequest>
-                    <tns:ReportRequestId xsi:nil="false">bing-ads-report-request-id</tns:ReportRequestId>
-                </tns:PollGenerateReportRequest>
-            </env:Body>
-        </env:Envelope>
-    headers:
-      Content-Type:
-      - text/xml;charset=UTF-8
-      Soapaction:
-      - PollGenerateReport
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Length:
-      - '493'
-      Content-Type:
-      - text/xml; charset=utf-8
-      Server:
-      - Microsoft-IIS/8.0
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Fri, 13 Nov 2015 14:23:36 GMT
-    body:
-      encoding: UTF-8
-      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Header><h:TrackingId
-        xmlns:h="https://bingads.microsoft.com/Reporting/v9">bing-ads-report-tracking-id</h:TrackingId></s:Header><s:Body><PollGenerateReportResponse
-        xmlns="https://bingads.microsoft.com/Reporting/v9"><ReportRequestStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ReportDownloadUrl
-        i:nil="true"/><Status>Pending</Status></ReportRequestStatus></PollGenerateReportResponse></s:Body></s:Envelope>
-    http_version: 
-  recorded_at: Fri, 13 Nov 2015 14:23:36 GMT
-- request:
-    method: post
-    uri: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc
-    body:
-      encoding: UTF-8
-      string: |
-        <?xml version="1.0" encoding="UTF-8"?>
-        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
-                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                      xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
-                      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
-                      xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
-            <env:Header>
-                <tns:CustomerAccountId>bing-ads-account-id</tns:CustomerAccountId>
-                <tns:CustomerId>bing-ads-customer-id</tns:CustomerId>
-                <tns:DeveloperToken>bing-ads-developer-token</tns:DeveloperToken>
-                <tns:AuthenticationToken>bing-ads-oauth-authentication-token</tns:AuthenticationToken>
-            </env:Header>
-            <env:Body>
-                <tns:PollGenerateReportRequest>
-                    <tns:ReportRequestId xsi:nil="false">bing-ads-report-request-id</tns:ReportRequestId>
-                </tns:PollGenerateReportRequest>
-            </env:Body>
-        </env:Envelope>
-    headers:
-      Content-Type:
-      - text/xml;charset=UTF-8
-      Soapaction:
-      - PollGenerateReport
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Content-Length:
-      - '937'
-      Content-Type:
-      - text/xml; charset=utf-8
-      Server:
-      - Microsoft-IIS/8.0
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Fri, 13 Nov 2015 14:23:42 GMT
-    body:
-      encoding: UTF-8
-      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Header><h:TrackingId
-        xmlns:h="https://bingads.microsoft.com/Reporting/v9">bing-ads-report-tracking-id</h:TrackingId></s:Header><s:Body><PollGenerateReportResponse
-        xmlns="https://bingads.microsoft.com/Reporting/v9"><ReportRequestStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ReportDownloadUrl>https://download.api.bingads.microsoft.com/ReportDownload/Download.aspx?q=bing-ads-report-download-id</ReportDownloadUrl><Status>Success</Status></ReportRequestStatus></PollGenerateReportResponse></s:Body></s:Envelope>
-    http_version: 
-  recorded_at: Fri, 13 Nov 2015 14:23:42 GMT
-- request:
-    method: get
-    uri: https://download.api.bingads.microsoft.com/ReportDownload/Download.aspx?q=bing-ads-report-download-id
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      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
-      Content-Length:
-      - '875'
-      Content-Type:
-      - application/x-zip-compressed
-      Server:
-      - Microsoft-IIS/8.0
-      Content-Disposition:
-      - attachment; filename="MyReport.zip"
-      X-Aspnet-Version:
-      - 4.0.30319
-      X-Powered-By:
-      - ASP.NET
-      Date:
-      - Fri, 13 Nov 2015 14:23:43 GMT
-    body:
-      encoding: ASCII-8BIT
-      string: !binary |-
-        UEsDBBQAAAAIAPCYb0c2Z8CWHQIAAPkDAAAUAE8AMzAwMDAwMDYyNjA5ODY2
-        Ny5jc3ZOVS4ATlVDWBQAMwAwADAAMAAwADAAMAA2ADIANgAwADkAOAA2ADYA
-        NwAuAGMAcwB2AHVwGQABF2t/LTMwMDAwMDA2MjYwOTg2NjcuY3N2hFNLjtQw
-        EN0jcQcrK5CQ21X+JrvWIGAkGhCMWLAL3e4mIt1uJelBvUNwC24wZ2CBxNyE
-        C3AFXOWMxAoWieP3/F69sp3f339Ur+MxDZN40e5jI1bnMq3u37sjrjoiQC3A
-        LFCBJYow8S4dMvG2Hbp0Ggl93o6TuEj7Yx+nuBHL67br2/d9FI/bc3aABTh2
-        ENgY1Sgllivx4Onq6uE/xc/Safives663O2GuGunLh0aFoq0FZv2/NeSJ10/
-        xWxI0Ks0xcPUtb24PKzn0jns1DZiGk6RVenT2Ag0+TvPyPLlNrdTPaou98ch
-        jmMuNebZRd+tP9LHm2M8bEip8kT7WucBbF3nwaN0vH1AlHW0AgwS5azUgSgk
-        CrwnCr3Ng/WyRqLICaE2eQiGRDpIxyKCQHMpq8kcjQSKXJGBd5Yh9gSpPBGO
-        9CWcIYWTWZhxXmQphWWVNI7gQEVJg4SCBE5EIYBQepREdgY1A5pB0AzCDCKD
-        qmaQmyUUAsNBMcypgHsPnMFyl0BtektvrZGTy1CMaG2tiTH8hlq6Upfdy35a
-        zo76jir7gYUKhZoTBKYUU4q6RJShhOCeMXA/XBe99Nw48nl6FvvAB2Sl5e3D
-        ciieU2PxNRI5B5ZdKLfB8UqvpSq3QfMxG96R0rqvpZ1v4+3XX5+/3X75ecO/
-        xapbD2lMW/qLhnzV+S+QYtn3Yuh2H6ZR5Osah+u4kaL6AwAA//8DAFBLAQIt
-        ABQAAAAIAPCYb0c2Z8CWHQIAAPkDAAAUAHUAAAAAAAAAAAAAAAAAAAAzMDAw
-        MDAwNjI2MDk4NjY3LmNzdk5VMABOVUNYFAAAADMAMAAwADAAMAAwADAANgAy
-        ADYAMAA5ADgANgA2ADcALgBjAHMAdgAKACAAAAAAAAEAGAD8qUTvGyDRAfyp
-        RO8bINEBN3BD7xsg0QF1cBkAARdrfy0zMDAwMDAwNjI2MDk4NjY3LmNzdlBL
-        BQYAAAAAAQABALcAAACeAgAAAAA=
-    http_version: 
-  recorded_at: Fri, 13 Nov 2015 14:23:43 GMT
-recorded_with: VCR 3.0.0

data/spec/integration/soapy_bing/ads/bulk/campaigns_spec.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-RSpec.describe SoapyBing::Ads::Bulk::Campaigns do
-  let(:service) { SoapyBing::Ads.new }
-  subject(:bulk_campaigns) { service.bulk_campaigns }
-
-  describe '#rows' do
-    let(:test_csv) { <<~CSV }
-      a,b,c
-      1,2,3
-      x,,z
-    CSV
-    let(:zip_downloader) do
-      instance_double(SoapyBing::Helpers::ZipDownloader, read: test_csv)
-    end
-    it 'returns an array of rows as hashes' do
-      expect(SoapyBing::Helpers::ZipDownloader).to receive(:new).and_return(zip_downloader)
-      expect(bulk_campaigns).to receive(:result_file_url)
-      expect(bulk_campaigns.rows).to eq(
-        [
-          { 'a' => '1', 'b' => '2', 'c' => '3' },
-          { 'a' => 'x', 'b' => nil, 'c' => 'z' }
-        ]
-      )
-    end
-  end
-
-  describe '#result_file_url', :vcr do
-    let(:result_file_url_template) do
-      %r{https://bingadsappsstorageprod\.blob\.core\.windows\.net/bulkdownloadresultfiles/DownloadHierarchy.*\.zip\?.*} # rubocop:disable Metrics/LineLength
-    end
-    it 'returns result file url' do
-      expect(bulk_campaigns.result_file_url).to match(result_file_url_template)
-    end
-  end
-end

data/spec/integration/soapy_bing/ads/reports/campaign_performance_report_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-require 'json'
-
-RSpec.describe SoapyBing::Ads::Reports::CampaignPerformanceReport do
-  let(:service) { SoapyBing::Ads.new }
-  let(:report) do
-    service.campaign_performance_report(
-      date_start: '2015-10-14',
-      date_end: '2015-10-14',
-      # CampaignName is considered to be a sensitive data, lets not record it
-      settings: { columns: %w(TimePeriod Impressions Clicks Spend) }
-    )
-  end
-  let(:payload_fixture_path) do
-    File.join('spec', 'fixtures', 'reports', 'campaign_performance_report.json')
-  end
-  let(:fixtured_payload) { JSON.load(File.read(payload_fixture_path)) }
-
-  describe '#rows' do
-    subject(:rows) { report.rows }
-
-    context 'when there is a successfull response during polling', :integration do
-      it 'responds with report rows',
-        vcr: { cassette_name: 'campaign_performance_report/with_successful_status' } do
-        expect(rows).to eq fixtured_payload
-      end
-    end
-
-    context 'when there is only pending responses during polling', :integration do
-      before { stub_const('SoapyBing::Soap::Request::PollGenerateReportRequest::POLLING_TRIES', 1) }
-
-      it 'throws exception PollingTimeoutError',
-        vcr: { cassette_name: 'campaign_performance_report/with_pending_status' } do
-        expect { rows }.to raise_error(
-          SoapyBing::Soap::Request::PollGenerateReportRequest::PollingTimeoutError
-        )
-      end
-    end
-  end
-end

data/spec/integration/soapy_bing/ads_spec.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-RSpec.describe SoapyBing::Ads do
-  let(:campaign_id) { 91834220 }
-  let(:ad_group_id) { 4464286758 }
-  let(:fixture_payload) { JSON.load(File.read(File.join('spec', 'fixtures', fixture_file))) }
-
-  subject(:instance) { described_class.new }
-
-  describe '#get_ad_groups_by_campaign_id', :vcr do
-    let(:fixture_file) { 'get_ad_groups_by_campaign_id.json' }
-
-    subject(:ad_groups) { instance.get_ad_groups_by_campaign_id(campaign_id) }
-
-    it { expect(ad_groups).to eq(fixture_payload) }
-  end
-
-  describe '#get_ads_by_ad_group_id', :vcr do
-    let(:fixture_file) { 'get_ads_by_ad_group_id.json' }
-
-    subject(:ads) { instance.get_ads_by_ad_group_id(ad_group_id) }
-
-    it { expect(ads).to eq(fixture_payload) }
-  end
-
-  describe '#get_targets_by_campaign_ids', :vcr do
-    let(:fixture_file) { 'get_targets_by_campaign_ids.json' }
-
-    subject(:targets) { instance.get_targets_by_campaign_ids([campaign_id]) }
-
-    it { expect(targets).to eq(fixture_payload) }
-  end
-end

data/spec/soapy_bing/ads/reports/campaign_performance_report_spec.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'date'
-
-RSpec.describe SoapyBing::Ads::Reports::CampaignPerformanceReport do
-  let(:report_options) { { oauth_credentials: nil, account: nil } }
-  subject(:report) { described_class.new report_options }
-
-  describe '#initialize' do
-    let(:wrong_date) { 'wrong_date' }
-
-    context 'when there is a wrong date format' do
-      before { report_options.merge!(date_start: wrong_date) }
-
-      let(:start_date) { 'wrong_date' }
-      it 'throws exception' do
-        expect { report }.to raise_error(ArgumentError, 'invalid date')
-      end
-    end
-  end
-
-  describe '#date_range' do
-    let(:date_start) { '2011-01-01' }
-    let(:date_end) { '2015-12-31' }
-    before { report_options.merge!(date_start: date_start, date_end: date_end) }
-
-    it 'is instance of Range' do
-      expect(report.date_range).to be_an_instance_of Range
-    end
-
-    context 'begin' do
-      it 'keeps initialized value' do
-        expect(report.date_range.begin).to eq Date.parse(date_start)
-      end
-    end
-
-    context 'end' do
-      it 'keeps initialized value' do
-        expect(report.date_range.end).to eq Date.parse(date_end)
-      end
-    end
-  end
-end

data/spec/soapy_bing/ads_spec.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-RSpec.describe SoapyBing::Ads do
-  let(:oauth) do
-    { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' }
-  end
-  let(:account) do
-    { developer_token: 'foo', account_id: 'baz', customer_id: 'qux' }
-  end
-  subject(:ads) { described_class.new(oauth: oauth, account: account) }
-
-  describe '#oauth_credentials' do
-    it 'is instance of SoapyBing::OauthCredentials' do
-      expect(ads.oauth_credentials).to be_an_instance_of SoapyBing::OauthCredentials
-    end
-  end
-
-  describe '#account' do
-    it 'is instance of SoapyBing::Account' do
-      expect(ads.account).to be_an_instance_of SoapyBing::Account
-    end
-  end
-
-  describe '#campaign_performance_report' do
-    subject(:report) do
-      described_class
-        .new(oauth: oauth, account: account)
-        .campaign_performance_report(date_start: '2015-01-01', date_end: '2015-01-01')
-    end
-    it 'is instance of SoapyBing::Ads::Reports::CampaignPerformanceReport' do
-      expect(report).to be_an_instance_of SoapyBing::Ads::Reports::CampaignPerformanceReport
-    end
-  end
-end