soapy_bing 0.3.1 → 0.4.0

data/spec/integration/soapy_bing/campaign_management_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyBing::CampaignManagement do
+  subject(:campaign_management) { described_class.new }
+
+  describe '#get_geo_locations', :vcr do
+    it 'returns a list of geo_locations hashes' do
+      rows = campaign_management.get_geo_locations
+      expect(rows.size).to eq(5)
+      expect(rows.first).to eq(
+        'ID' => '1',
+        'Code' => 'AL',
+        'Display Name' => 'Albania',
+        'Descriptor' => 'country/region',
+        'Target Type' => 'Country',
+        'Replaces' => nil,
+        'Status' => 'Active',
+        'AdWords Location ID' => '2008'
+      )
+    end
+  end
+end

data/spec/integration/soapy_bing/oauth_credentials_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe SoapyBing::OauthCredentials do
   subject(:oauth_credentials) { described_class.new }
 

data/spec/simplecov_setup.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 if ENV['CI'] || ENV['COVERAGE']
   require 'simplecov'
 

data/spec/soapy_bing/account_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe SoapyBing::Account do
   describe '#initialize' do
     subject(:account_obj) { described_class.new(account) }
@@ -7,6 +8,7 @@ RSpec.describe SoapyBing::Account do
       let(:account) do
         { developer_token: 'foo', account_id: 'baz', customer_id: 'qux' }
       end
+
       before do
         allow(ENV).to receive(:[]).with('BING_ADS_DEVELOPER_TOKEN').and_return('foo_env')
         allow(ENV).to receive(:[]).with('BING_ADS_ACCOUNT_ID').and_return('baz_env')
@@ -28,6 +30,7 @@ RSpec.describe SoapyBing::Account do
 
     context 'when account credentials passed via Enviromenment variables' do
       let(:account) { {} }
+
       before do
         allow(ENV).to receive(:[]).with('BING_ADS_DEVELOPER_TOKEN').and_return('foo_env')
         allow(ENV).to receive(:[]).with('BING_ADS_ACCOUNT_ID').and_return('baz_env')
@@ -51,10 +54,11 @@ RSpec.describe SoapyBing::Account do
       let(:account) do
         { developer_token: 'foo', account_id: 'baz', customer_id: 'qux' }
       end
+
       before do
-        %w( BING_ADS_DEVELOPER_TOKEN
+        %w[ BING_ADS_DEVELOPER_TOKEN
             BING_ADS_ACCOUNT_ID
-            BING_ADS_CUSTOMER_ID ).each do |var|
+            BING_ADS_CUSTOMER_ID ].each do |var|
           allow(ENV).to receive(:[]).with(var).and_return(nil)
         end
       end

data/spec/soapy_bing/accounts_spec.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyBing::Accounts do
+  describe '#customer_management' do
+    subject(:accounts) { described_class.new }
+
+    let(:accounts_list_response) do
+      {
+        accounts_info: {
+          account_info: [
+            { id: '123' },
+            { id: '456' }
+          ]
+        }
+      }
+    end
+
+    before do
+      allow(accounts.service).to receive(:get_accounts_info).and_return(accounts_list_response)
+    end
+
+    it 'returns accounts list' do
+      result = accounts.list
+
+      expect(result.size).to eq(2)
+      expect(result.first.account_id).to eq('123')
+      expect(result.last.account_id).to eq('456')
+    end
+
+    context 'without BING_ADS_ACCOUNT_ID' do
+      around do |example|
+        original_bing_ads_account_id = ENV['BING_ADS_ACCOUNT_ID']
+        ENV.delete('BING_ADS_ACCOUNT_ID')
+        example.run
+        ENV['BING_ADS_ACCOUNT_ID'] = original_bing_ads_account_id
+      end
+
+      it 'returns accounts list' do
+        result = accounts.list
+
+        expect(result.size).to eq(2)
+        expect(result.first.account_id).to eq('123')
+        expect(result.last.account_id).to eq('456')
+      end
+    end
+  end
+end

data/spec/soapy_bing/ads/campaign_performance_report_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'date'
+
+RSpec.describe SoapyBing::Ads::CampaignPerformanceReport do
+  subject(:report) { described_class.new(report_options) }
+
+  let(:report_options) do
+    {
+      service_options: {},
+      date_start: date_start,
+      date_end: date_end,
+      polling_settings: polling_settings
+    }
+  end
+  let(:polling_settings) { {} }
+  let(:service_double) { double }
+
+  describe '#initialize' do
+    context 'when there is a wrong date format' do
+      let(:date_start) { 'wrong_date' }
+      let(:date_end) { 'today' }
+
+      it 'throws exception' do
+        expect { report }.to raise_error(ArgumentError, 'invalid date')
+      end
+    end
+
+    context 'with valid dates' do
+      let(:date_start) { '2017-06-20' }
+      let(:date_end) { '2017-06-21' }
+
+      it 'sets default pooling settings' do
+        polling_settings = report.polling_settings
+        expect(polling_settings[:tries]).to eq(20)
+        expect(polling_settings[:sleep].call(6)).to eq(64)
+        expect(polling_settings[:sleep].call(7)).to eq(120)
+      end
+    end
+  end
+
+  describe '#rows' do
+    let(:date_start) { '2016-09-15' }
+    let(:date_end) { '2016-09-15' }
+
+    before do
+      allow(SoapyBing::Service).to receive(:reporting).and_return(service_double)
+      allow(service_double).to receive(:submit_generate_report) do
+        { report_request_id: '123' }
+      end
+      allow(service_double).to receive(:poll_generate_report) do
+        {
+          report_request_status: { status: status }
+        }
+      end
+    end
+
+    context 'with pending response' do
+      let(:polling_settings) { { tries: 3, sleep: 0 } }
+      let(:status) { 'Pending' }
+
+      it 'raises NotCompleted' do
+        expect { report.rows }.to raise_error SoapyBing::Ads::NotCompleted
+        expect(service_double).to have_received(:submit_generate_report).once
+        expect(service_double).to have_received(:poll_generate_report).exactly(3).times
+      end
+    end
+
+    context 'with failed response' do
+      let(:status) { 'Error' }
+
+      it 'raises StatusFailed' do
+        expect { report.rows }.to raise_error SoapyBing::Ads::StatusFailed
+        expect(service_double).to have_received(:submit_generate_report).once
+        expect(service_double).to have_received(:poll_generate_report).once
+      end
+    end
+  end
+end

data/spec/soapy_bing/ads/campaigns_spec.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyBing::Ads::Campaigns do
+  subject(:campaigns) do
+    described_class.new(
+      service_options: {},
+      polling_settings: polling_settings
+    )
+  end
+
+  let(:service_double) { double }
+  let(:account_double) { instance_double(SoapyBing::Account) }
+  let(:zip_downloader_double) { instance_double(SoapyBing::Helpers::ZipDownloader) }
+  let(:polling_settings) { {} }
+
+  describe '#rows' do
+    let(:completed_response) do
+      {
+        request_status: 'Completed',
+        result_file_url: 'http://example.com/result_file'
+      }
+    end
+
+    let(:pending_response) do
+      {
+        request_status: 'Pending'
+      }
+    end
+
+    before do
+      allow(SoapyBing::Service).to receive(:bulk).and_return(service_double)
+
+      allow(SoapyBing::Helpers::ZipDownloader).to receive(:new)
+        .with('http://example.com/result_file')
+        .and_return(zip_downloader_double)
+
+      allow(zip_downloader_double).to receive(:read)
+        .and_return("a,b\nc,d\ne,f")
+
+      allow(service_double).to receive(:download_campaigns_by_account_ids)
+        .and_return(download_request_id: '123')
+
+      allow(service_double).to receive(:account)
+        .and_return(account_double)
+
+      allow(account_double).to receive(:account_id).and_return(1)
+
+      call_count = 0
+      allow(service_double).to receive(:get_bulk_download_status) do
+        call_count += 1
+        call_count == 3 ? completed_response : pending_response
+      end
+    end
+
+    it 'polls until successful response' do
+      expect(campaigns.rows).to eq(
+        [
+          { 'a' => 'c', 'b' => 'd' },
+          { 'a' => 'e', 'b' => 'f' }
+        ]
+      )
+      expect(service_double).to have_received(:download_campaigns_by_account_ids).once
+      expect(service_double).to have_received(:get_bulk_download_status).exactly(3).times
+    end
+
+    context 'with polling_tries = 1' do
+      let(:polling_settings) { { tries: 1 } }
+
+      it 'raises NotCompleted error after exceeded polling tries' do
+        expect { campaigns.rows }.to raise_error described_class::NotCompleted
+        expect(service_double).to have_received(:get_bulk_download_status).once
+      end
+    end
+
+    context 'with failed response' do
+      before do
+        allow(service_double).to receive(:get_bulk_download_status) do
+          {
+            request_status: 'Failed',
+            errors: {
+              operation_error: {
+                code: '0',
+                error_code: 'InternalError',
+                message: 'An internal error has occurred'
+              }
+            }
+          }
+        end
+      end
+
+      it 'raises StatusFailed with error message' do
+        expect { campaigns.rows }.to raise_error described_class::StatusFailed do |error|
+          expect(error.message).to match(/An internal error has occurred/)
+        end
+        expect(service_double).to have_received(:get_bulk_download_status).once
+      end
+    end
+  end
+end

data/spec/soapy_bing/ads/{bulk/parsers/csv_parser_spec.rb → parsers/bulk_csv_parser_spec.rb}

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
+
 require 'json'
 
-RSpec.describe SoapyBing::Ads::Bulk::Parsers::CSVParser do
+RSpec.describe SoapyBing::Ads::Parsers::BulkCsvParser do
   describe '#rows' do
     subject(:rows) { described_class.new(csv_data).rows }
 
     let(:csv_fixture_path) do
-      File.join('spec', 'fixtures', 'bulk', 'campaigns.csv')
+      File.join('spec', 'fixtures', 'ads', 'campaigns_by_account_id.csv')
     end
     let(:csv_data) { File.read(csv_fixture_path) }
 
     let(:json_fixture_path) do
-      File.join('spec', 'fixtures', 'bulk', 'campaigns.json')
+      File.join('spec', 'fixtures', 'ads', 'campaigns_by_account_id.json')
     end
-    let(:json_data) { JSON.load(File.read(json_fixture_path)) }
+    let(:json_data) { JSON.parse(File.read(json_fixture_path)) }
 
     it 'responds with array of Hashes' do
       expect(rows).to eq json_data

data/spec/soapy_bing/ads/{reports/parsers/csv_parser_spec.rb → parsers/report_csv_parser_spec.rb}

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
+
 require 'json'
 require 'csv'
 
-RSpec.describe SoapyBing::Ads::Reports::Parsers::CSVParser do
+RSpec.describe SoapyBing::Ads::Parsers::ReportCsvParser do
   describe '#rows' do
     subject(:rows) { described_class.new(csv_data).rows }
+
     context 'on valid CSV data' do
       let(:csv_fixture_path) do
-        File.join('spec', 'fixtures', 'reports', 'campaign_performance_report.csv')
+        File.join('spec', 'fixtures', 'ads', 'campaign_performance_report.csv')
       end
       let(:csv_data) { File.read(csv_fixture_path) }
 
       let(:json_fixture_path) do
-        File.join('spec', 'fixtures', 'reports', 'campaign_performance_report.json')
+        File.join('spec', 'fixtures', 'ads', 'campaign_performance_report.json')
       end
-      let(:json_data) { JSON.load(File.read(json_fixture_path)) }
+      let(:json_data) { JSON.parse(File.read(json_fixture_path)) }
 
       it 'responds with array of Hashes' do
         expect(rows).to eq json_data

data/spec/soapy_bing/country_codes_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyBing::CountryCodes do
+  subject(:country_codes) { described_class.new }
+
+  describe '#code' do
+    context 'valid country id' do
+      let(:id) { 20 }
+
+      it 'returns contry code' do
+        expect(country_codes.code(id)).to eq('BR')
+      end
+    end
+
+    context 'valid country id as string' do
+      let(:id) { '20' }
+
+      it 'returns contry code' do
+        expect(country_codes.code(id)).to eq('BR')
+      end
+    end
+
+    context 'valid state id' do
+      let(:id) { 685 }
+
+      it 'returns contry code' do
+        expect(country_codes.code(id)).to eq('BR-RS')
+      end
+    end
+
+    context 'invalid id' do
+      let(:id) { 0 }
+
+      it 'raises error' do
+        expect { country_codes.code(id) }.to raise_error(KeyError)
+      end
+    end
+  end
+end

data/spec/soapy_bing/helpers/zip_downloader_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe SoapyBing::Helpers::ZipDownloader do
   describe '#read' do
     let(:hello_zip_file_path) { File.join('spec', 'fixtures', 'helpers', 'hello.zip') }
@@ -6,6 +7,7 @@ RSpec.describe SoapyBing::Helpers::ZipDownloader do
       instance_double(HTTParty::Response, body: File.read(hello_zip_file_path))
     end
     let(:download_url) { 'https://example.com/file.zip' }
+
     subject(:instance) { described_class.new(download_url) }
 
     it 'unzips and reads file content' do

data/spec/soapy_bing/oauth_credentials_spec.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 RSpec.describe SoapyBing::OauthCredentials do
   subject(:oauth_credentials) { described_class.new(credentials) }
 
   describe '#initialize' do
     context 'when oauth credentials passed explicitly' do
       let(:credentials) { { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' } }
+
       before do
         allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_ID').and_return('foo_env')
         allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_SECRET').and_return('bar_env')
@@ -27,6 +29,7 @@ RSpec.describe SoapyBing::OauthCredentials do
 
     context 'when oauth credentials passed via Enviromenment variables' do
       let(:credentials) { {} }
+
       before do
         allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_ID').and_return('foo_env')
         allow(ENV).to receive(:[]).with('BING_ADS_OAUTH_CLIENT_SECRET').and_return('bar_env')
@@ -49,10 +52,11 @@ RSpec.describe SoapyBing::OauthCredentials do
 
     context 'when no oauth credentials passed' do
       let(:credentials) { { client_id: 'foo', client_secret: 'bar', refresh_token: 'baz' } }
+
       before do
-        %w( BING_ADS_OAUTH_CLIENT_ID
+        %w[ BING_ADS_OAUTH_CLIENT_ID
             BING_ADS_OAUTH_CLIENT_SECRET
-            BING_ADS_OAUTH_REFRESH_TOKEN ).each do |var|
+            BING_ADS_OAUTH_REFRESH_TOKEN ].each do |var|
           allow(ENV).to receive(:[]).with(var).and_return(nil)
         end
       end

data/spec/soapy_bing/param_guard_spec.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 RSpec.describe SoapyBing::ParamGuard do
   describe '#require!' do
     let(:param_guard) { described_class.new(options, env_namespace: 'MY') }
+
     subject(:require_foo) { param_guard.require!(:foo) }
 
     context 'when option is empty' do