soapy_bing 0.3.1 → 0.4.0

data/spec/soapy_bing/service_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+RSpec.describe SoapyBing::Service do
+  subject(:service) { described_class.campaign_management }
+
+  describe '#build' do
+    context 'without options' do
+      it 'creates service with default savon globals' do
+        globals = service.savon_client.globals
+        expect(globals[:element_form_default]).to eq(:qualified)
+        expect(globals[:convert_request_keys_to]).to eq(:camelcase)
+        expect(globals[:wsdl]).to end_with('campaign_management.wsdl')
+        expect(globals[:namespaces]).to eq({})
+      end
+    end
+
+    context 'with custom options' do
+      subject(:service) { described_class.campaign_management(options) }
+
+      let(:options) do
+        {
+          savon_globals: {
+            namespaces: { 'this_is_a' => 'test' }
+          }
+        }
+      end
+
+      it 'creates service with default savon globals and user options' do
+        globals = service.savon_client.globals
+        expect(globals[:element_form_default]).to eq(:qualified)
+        expect(globals[:convert_request_keys_to]).to eq(:camelcase)
+        expect(globals[:wsdl]).to end_with('campaign_management.wsdl')
+        expect(globals[:namespaces]).to eq('this_is_a' => 'test')
+      end
+
+      it 'doesnt modify options hash' do
+        service.savon_client.globals
+        expect(options).to eq(
+          savon_globals: {
+            namespaces: { 'this_is_a' => 'test' }
+          }
+        )
+      end
+    end
+  end
+
+  describe '#respond_to?' do
+    it 'responds to service operations' do
+      expect(service.respond_to?(:get_ads_by_ids)).to be_truthy
+    end
+
+    it 'doest respond to anything' do
+      expect(service.respond_to?(:answer_to_life_universe_and_everything)).to be_falsey
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'simplecov_setup'
 
 require 'bundler/setup'

data/spec/support/dotenv.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'dotenv'
 
 Dotenv.load('.env.local', '.env')

data/spec/support/vcr.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'cgi'
 require 'vcr'
 require 'active_support/core_ext/hash/conversions'
@@ -7,7 +8,7 @@ VCR.configure do |c|
   c.configure_rspec_metadata!
   c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   c.hook_into :webmock
-  c.default_cassette_options = { match_requests_on: %i(method uri body) }
+  c.default_cassette_options = { match_requests_on: %i[method uri body] }
 
   c.filter_sensitive_data('bing-ads-oauth-client-id') { ENV['BING_ADS_OAUTH_CLIENT_ID'] }
   c.filter_sensitive_data('bing-ads-oauth-client-secret') { ENV['BING_ADS_OAUTH_CLIENT_SECRET'] }
@@ -77,9 +78,10 @@ VCR.configure do |c|
   end
 
   c.before_record do |interaction|
-    # auto-generate report payload fixtures
-    # spec/fixtures/reports/campaign_performance_report.json
-    # spec/fixtures/reports/campaing_performance_report.csv
+    # auto-generate campaign_performance_report payload fixtures
+    # spec/fixtures/ads/campaign_performance_report.json
+    # spec/fixtures/ads/campaing_performance_report.csv
+    next unless interaction.request.uri =~ /ReportDownload/
     if interaction.response.headers['Content-Type'].first == 'application/x-zip-compressed'
       # refactor zip into module
       csv_data = Zip::InputStream.open(StringIO.new(interaction.response.body)) do |archive_io|
@@ -87,9 +89,9 @@ VCR.configure do |c|
         file_io.read
       end
 
-      fixtures_dir = File.join('spec', 'fixtures', 'reports')
+      fixtures_dir = File.join('spec', 'fixtures', 'ads')
       File.open(File.join(fixtures_dir, 'campaign_performance_report.json'), 'wb') do |file|
-        parser = SoapyBing::Ads::Reports::Parsers::CSVParser.new(csv_data)
+        parser = SoapyBing::Ads::Parsers::ReportCsvParser.new(csv_data)
         file.write(JSON.pretty_generate(parser.rows))
       end
       File.open(File.join(fixtures_dir, 'campaign_performance_report.csv'), 'wb') do |file|
@@ -98,5 +100,72 @@ VCR.configure do |c|
     end
   end
 
+  c.before_record do |interaction, cassette|
+    # auto-generate campaigns payload fixtures
+    # spec/fixtures/ads/campaigns_by_account_id.json
+    # spec/fixtures/ads/campaings_by_account_id.csv
+    # spec/fixtures/ads/campaigns_by_campaign_ids.json
+    # spec/fixtures/ads/campaings_by_campaign_ids.csv
+    next unless interaction.request.uri =~ /bulkdownloadresultfiles/
+
+    campaigns_ids = cassette.name =~ /by campaign_ids/
+    fixture_name = "campaigns_by_#{campaigns_ids ? 'campaign_ids' : 'account_id'}"
+
+    body_zip_entry_name = nil
+    unzipped_body = Zip::InputStream.open(StringIO.new(interaction.response.body)) do |archive_io|
+      entry = archive_io.get_next_entry
+      body_zip_entry_name = entry.name
+      entry.get_input_stream.read
+    end
+
+    unzipped_body.gsub!(ENV['BING_ADS_ACCOUNT_ID'], '123456')
+
+    rows = SoapyBing::Ads::Parsers::BulkCsvParser.new(unzipped_body).rows[0..5]
+
+    # Replace campaign names because it is sensitive data
+    rows.map do |row|
+      next unless row['Type'] == 'Campaign'
+      row['Campaign'] = "Campaign #{row['Id']}"
+    end
+
+    modified_csv = CSV.generate do |csv|
+      csv << rows.first.keys
+      rows.each do |row|
+        csv << row.values
+      end
+    end
+
+    fixtures_dir = File.join('spec', 'fixtures', 'ads')
+    File.open(File.join(fixtures_dir, "#{fixture_name}.csv"), 'wb') do |file|
+      file.write(modified_csv)
+    end
+
+    File.open(File.join(fixtures_dir, "#{fixture_name}.json"), 'wb') do |file|
+      file.write(JSON.pretty_generate(rows))
+    end
+
+    zipped_body = StringIO.new
+    Zip::OutputStream.write_buffer(zipped_body) do |io|
+      io.put_next_entry(body_zip_entry_name)
+      io.write(modified_csv)
+    end
+    interaction.response.body = String.new(zipped_body.string, encoding: 'ASCII-8BIT')
+  end
+
+  # reduce response size for get_geo_locations vcr file
+  c.before_record do |interaction|
+    next unless interaction.request.uri =~ /GeoLocations\.csv/
+
+    rows = CSV.parse(interaction.response.body)[0..5]
+
+    modified_csv = CSV.generate do |csv|
+      rows.each do |row|
+        csv << row
+      end
+    end
+
+    interaction.response.body = modified_csv
+  end
+
   c.ignore_hosts 'codeclimate.com' # allow codeclimate-test-reporter to phone home
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: soapy_bing
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ad2games GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-19 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: erubis
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,47 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: retryable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: retryable
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -197,99 +197,65 @@ files:
 - lib/soapy_bing/account.rb
 - lib/soapy_bing/accounts.rb
 - lib/soapy_bing/ads.rb
-- lib/soapy_bing/ads/bulk.rb
-- lib/soapy_bing/ads/bulk/campaigns.rb
-- lib/soapy_bing/ads/bulk/parsers.rb
-- lib/soapy_bing/ads/bulk/parsers/csv_parser.rb
-- lib/soapy_bing/ads/reports.rb
-- lib/soapy_bing/ads/reports/base.rb
-- lib/soapy_bing/ads/reports/campaign_performance_report.rb
-- lib/soapy_bing/ads/reports/parsers.rb
-- lib/soapy_bing/ads/reports/parsers/csv_parser.rb
+- lib/soapy_bing/ads/campaign_performance_report.rb
+- lib/soapy_bing/ads/campaigns.rb
+- lib/soapy_bing/ads/parsers/bulk_csv_parser.rb
+- lib/soapy_bing/ads/parsers/report_csv_parser.rb
+- lib/soapy_bing/ads/report.rb
+- lib/soapy_bing/campaign_management.rb
+- lib/soapy_bing/country_codes.rb
+- lib/soapy_bing/country_codes.yml
 - lib/soapy_bing/customer.rb
 - lib/soapy_bing/helpers.rb
-- lib/soapy_bing/helpers/class_name.rb
 - lib/soapy_bing/helpers/zip_downloader.rb
 - lib/soapy_bing/oauth_credentials.rb
 - lib/soapy_bing/param_guard.rb
-- lib/soapy_bing/soap.rb
-- lib/soapy_bing/soap/request.rb
-- lib/soapy_bing/soap/request/base.rb
-- lib/soapy_bing/soap/request/download_campaigns_by_account_ids_request.rb
-- lib/soapy_bing/soap/request/get_accounts_info_request.rb
-- lib/soapy_bing/soap/request/get_ad_groups_by_campaign_id_request.rb
-- lib/soapy_bing/soap/request/get_ads_by_ad_group_id_request.rb
-- lib/soapy_bing/soap/request/get_bulk_download_status_request.rb
-- lib/soapy_bing/soap/request/get_targets_by_campaign_ids_request.rb
-- lib/soapy_bing/soap/request/poll_generate_report_request.rb
-- lib/soapy_bing/soap/request/submit_generate_report_request.rb
-- lib/soapy_bing/soap/response.rb
-- lib/soapy_bing/soap/response/base.rb
-- lib/soapy_bing/soap/response/download_campaigns_by_account_ids_response.rb
-- lib/soapy_bing/soap/response/get_accounts_info_response.rb
-- lib/soapy_bing/soap/response/get_ad_groups_by_campaign_id_response.rb
-- lib/soapy_bing/soap/response/get_ads_by_ad_group_id_response.rb
-- lib/soapy_bing/soap/response/get_bulk_download_status_response.rb
-- lib/soapy_bing/soap/response/get_targets_by_campaign_ids_response.rb
-- lib/soapy_bing/soap/response/payload.rb
-- lib/soapy_bing/soap/response/poll_generate_report_response.rb
-- lib/soapy_bing/soap/response/report_status.rb
-- lib/soapy_bing/soap/response/submit_generate_report_response.rb
-- lib/soapy_bing/soap/template_renderer.rb
-- lib/soapy_bing/soap/templates/download_campaigns_by_account_ids.xml.erb
-- lib/soapy_bing/soap/templates/get_accounts_info.xml.erb
-- lib/soapy_bing/soap/templates/get_ad_groups_by_campaign_id.xml.erb
-- lib/soapy_bing/soap/templates/get_ads_by_ad_group_id.xml.erb
-- lib/soapy_bing/soap/templates/get_bulk_download_status.xml.erb
-- lib/soapy_bing/soap/templates/get_targets_by_campaign_ids.xml.erb
-- lib/soapy_bing/soap/templates/poll_generate_report.xml.erb
-- lib/soapy_bing/soap/templates/submit_generate_report.xml.erb
+- lib/soapy_bing/service.rb
+- lib/soapy_bing/service_operation.rb
 - lib/soapy_bing/version.rb
+- lib/soapy_bing/wsdl/ad_insight.wsdl
+- lib/soapy_bing/wsdl/bulk.wsdl
+- lib/soapy_bing/wsdl/campaign_management.wsdl
+- lib/soapy_bing/wsdl/customer_billing.wsdl
+- lib/soapy_bing/wsdl/customer_management.wsdl
+- lib/soapy_bing/wsdl/reporting.wsdl
 - lib/tasks/console.rake
 - lib/tasks/coverage.rake
 - lib/tasks/spec.rake
+- lib/tasks/upate_wsdl_files.rake
+- lib/tasks/update_country_codes.rake
 - soapy_bing.gemspec
-- spec/fixtures/bulk/campaigns.csv
-- spec/fixtures/bulk/campaigns.json
-- spec/fixtures/get_ad_groups_by_campaign_id.json
-- spec/fixtures/get_ads_by_ad_group_id.json
-- spec/fixtures/get_targets_by_campaign_ids.json
+- spec/fixtures/ads/campaign_performance_report.csv
+- spec/fixtures/ads/campaign_performance_report.json
+- spec/fixtures/ads/campaigns_by_account_id.csv
+- spec/fixtures/ads/campaigns_by_account_id.json
+- spec/fixtures/ads/campaigns_by_campaign_ids.csv
+- spec/fixtures/ads/campaigns_by_campaign_ids.json
 - spec/fixtures/helpers/hello.zip
-- spec/fixtures/reports/campaign_performance_report.csv
-- spec/fixtures/reports/campaign_performance_report.json
-- spec/fixtures/soap_templates/simple.xml.erb
 - spec/fixtures/vcr_cassettes/SoapyBing_Accounts/_list/returns_a_list_of_SoapyBing_Account_objects.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_ad_groups_by_campaign_id/1_1_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_ads_by_ad_group_id/1_2_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_targets_by_campaign_ids/1_3_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads_Bulk_Campaigns/_result_file_url/returns_result_file_url.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_campaigns/by_account_id/returns_parsed_rows.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_campaigns/by_campaign_ids/returns_parsed_rows.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_CampaignManagement/_get_geo_locations/returns_a_list_of_geo_locations_hashes.yml
 - spec/fixtures/vcr_cassettes/campaign_performance_report/with_pending_status.yml
-- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_status.yml
+- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_empty_response.yml
+- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_response.yml
 - spec/fixtures/vcr_cassettes/oauth_credentials/access_token/with_successful_status.yml
 - spec/integration/soapy_bing/accounts_spec.rb
-- spec/integration/soapy_bing/ads/bulk/campaigns_spec.rb
-- spec/integration/soapy_bing/ads/reports/campaign_performance_report_spec.rb
-- spec/integration/soapy_bing/ads_spec.rb
+- spec/integration/soapy_bing/ads_campaigns_spec.rb
+- spec/integration/soapy_bing/campaign_management_spec.rb
 - spec/integration/soapy_bing/oauth_credentials_spec.rb
 - spec/simplecov_setup.rb
 - spec/soapy_bing/account_spec.rb
-- spec/soapy_bing/ads/bulk/parsers/csv_parser_spec.rb
-- spec/soapy_bing/ads/reports/campaign_performance_report_spec.rb
-- spec/soapy_bing/ads/reports/parsers/csv_parser_spec.rb
-- spec/soapy_bing/ads_spec.rb
-- spec/soapy_bing/helpers/class_name_spec.rb
+- spec/soapy_bing/accounts_spec.rb
+- spec/soapy_bing/ads/campaign_performance_report_spec.rb
+- spec/soapy_bing/ads/campaigns_spec.rb
+- spec/soapy_bing/ads/parsers/bulk_csv_parser_spec.rb
+- spec/soapy_bing/ads/parsers/report_csv_parser_spec.rb
+- spec/soapy_bing/country_codes_spec.rb
 - spec/soapy_bing/helpers/zip_downloader_spec.rb
 - spec/soapy_bing/oauth_credentials_spec.rb
 - spec/soapy_bing/param_guard_spec.rb
-- spec/soapy_bing/soap/request/base_spec.rb
-- spec/soapy_bing/soap/request/poll_generate_report_request_spec.rb
-- spec/soapy_bing/soap/response/base_spec.rb
-- spec/soapy_bing/soap/response/get_bulk_download_status_response_spec.rb
-- spec/soapy_bing/soap/response/payload_spec.rb
-- spec/soapy_bing/soap/response/poll_generate_report_response_spec.rb
-- spec/soapy_bing/soap/response/report_status_spec.rb
-- spec/soapy_bing/soap/response/submit_generate_report_response_spec.rb
-- spec/soapy_bing/soap/template_renderer_spec.rb
+- spec/soapy_bing/service_spec.rb
 - spec/spec_helper.rb
 - spec/support/dotenv.rb
 - spec/support/vcr.rb
@@ -313,52 +279,42 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Simple client for the Bing Ads APIs
 test_files:
-- spec/fixtures/bulk/campaigns.csv
-- spec/fixtures/bulk/campaigns.json
-- spec/fixtures/get_ad_groups_by_campaign_id.json
-- spec/fixtures/get_ads_by_ad_group_id.json
-- spec/fixtures/get_targets_by_campaign_ids.json
+- spec/fixtures/ads/campaign_performance_report.csv
+- spec/fixtures/ads/campaign_performance_report.json
+- spec/fixtures/ads/campaigns_by_account_id.csv
+- spec/fixtures/ads/campaigns_by_account_id.json
+- spec/fixtures/ads/campaigns_by_campaign_ids.csv
+- spec/fixtures/ads/campaigns_by_campaign_ids.json
 - spec/fixtures/helpers/hello.zip
-- spec/fixtures/reports/campaign_performance_report.csv
-- spec/fixtures/reports/campaign_performance_report.json
-- spec/fixtures/soap_templates/simple.xml.erb
 - spec/fixtures/vcr_cassettes/SoapyBing_Accounts/_list/returns_a_list_of_SoapyBing_Account_objects.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_ad_groups_by_campaign_id/1_1_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_ads_by_ad_group_id/1_2_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_get_targets_by_campaign_ids/1_3_1.yml
-- spec/fixtures/vcr_cassettes/SoapyBing_Ads_Bulk_Campaigns/_result_file_url/returns_result_file_url.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_campaigns/by_account_id/returns_parsed_rows.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_Ads/_campaigns/by_campaign_ids/returns_parsed_rows.yml
+- spec/fixtures/vcr_cassettes/SoapyBing_CampaignManagement/_get_geo_locations/returns_a_list_of_geo_locations_hashes.yml
 - spec/fixtures/vcr_cassettes/campaign_performance_report/with_pending_status.yml
-- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_status.yml
+- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_empty_response.yml
+- spec/fixtures/vcr_cassettes/campaign_performance_report/with_successful_response.yml
 - spec/fixtures/vcr_cassettes/oauth_credentials/access_token/with_successful_status.yml
 - spec/integration/soapy_bing/accounts_spec.rb
-- spec/integration/soapy_bing/ads/bulk/campaigns_spec.rb
-- spec/integration/soapy_bing/ads/reports/campaign_performance_report_spec.rb
-- spec/integration/soapy_bing/ads_spec.rb
+- spec/integration/soapy_bing/ads_campaigns_spec.rb
+- spec/integration/soapy_bing/campaign_management_spec.rb
 - spec/integration/soapy_bing/oauth_credentials_spec.rb
 - spec/simplecov_setup.rb
 - spec/soapy_bing/account_spec.rb
-- spec/soapy_bing/ads/bulk/parsers/csv_parser_spec.rb
-- spec/soapy_bing/ads/reports/campaign_performance_report_spec.rb
-- spec/soapy_bing/ads/reports/parsers/csv_parser_spec.rb
-- spec/soapy_bing/ads_spec.rb
-- spec/soapy_bing/helpers/class_name_spec.rb
+- spec/soapy_bing/accounts_spec.rb
+- spec/soapy_bing/ads/campaign_performance_report_spec.rb
+- spec/soapy_bing/ads/campaigns_spec.rb
+- spec/soapy_bing/ads/parsers/bulk_csv_parser_spec.rb
+- spec/soapy_bing/ads/parsers/report_csv_parser_spec.rb
+- spec/soapy_bing/country_codes_spec.rb
 - spec/soapy_bing/helpers/zip_downloader_spec.rb
 - spec/soapy_bing/oauth_credentials_spec.rb
 - spec/soapy_bing/param_guard_spec.rb
-- spec/soapy_bing/soap/request/base_spec.rb
-- spec/soapy_bing/soap/request/poll_generate_report_request_spec.rb
-- spec/soapy_bing/soap/response/base_spec.rb
-- spec/soapy_bing/soap/response/get_bulk_download_status_response_spec.rb
-- spec/soapy_bing/soap/response/payload_spec.rb
-- spec/soapy_bing/soap/response/poll_generate_report_response_spec.rb
-- spec/soapy_bing/soap/response/report_status_spec.rb
-- spec/soapy_bing/soap/response/submit_generate_report_response_spec.rb
-- spec/soapy_bing/soap/template_renderer_spec.rb
+- spec/soapy_bing/service_spec.rb
 - spec/spec_helper.rb
 - spec/support/dotenv.rb
 - spec/support/vcr.rb