soapy_bing 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6afe9e7e07f2ae7766ed8bf8ede8fd09bb44d959
-  data.tar.gz: 471bcd556c53589f2e2721507f85a4e582d29fbc
+  metadata.gz: 050d78288c2a6684ef1755104627587ba44f6263
+  data.tar.gz: 84eca8e11161bd4645d2d8ba35a7e42defdf281d
 SHA512:
-  metadata.gz: 1097d26a4f5a57076061b4a550a9c0cdfdc8579bc0315d86e444c07d0d3690c743ed36e8c94b33a19f4a8f423bfd0af4452eebce034dfad243861534b642e0d1
-  data.tar.gz: 3f3b44dec28fc377efc7cb813efef0d69847b6e5fb6eff01a717b6244cf42da59293d17d0f63f286d5d564735de65f284d5e059df4997d24923c095e5f1c1ad8
+  metadata.gz: b39872dacbc8cc83a41293ba31cbdbb98ddc22902093f361064b6218224e105c63a4f5e8baf7b86d3867dc10d6bd2dd9a4d5bce5e8a4c62428ab98a97287777a
+  data.tar.gz: b45e9ef2c03f630a262ef99f67e6267deb3354fd082a601bddbabd111973a69788a81dd03a391342d953b8dc431e4997ccea03110f5adad8f3d3c5a31a4e52a0

data/.gitignore

@@ -5,3 +5,4 @@ Gemfile.lock
 .env.local
 .env.development
 .bundle
+/pkg

data/lib/soapy_bing/ads/bulk/campaigns.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module SoapyBing
+  class Ads
+    module Bulk
+      class Campaigns
+        DEFAULT_ENTITIES = %w(CampaignTargets Ads).freeze
+        POLLING_TRIES = 30
+        NotCompleted = Class.new(StandardError)
+
+        attr_reader :oauth_credentials, :account, :entities, :status
+
+        def initialize(options)
+          @oauth_credentials = options.fetch(:oauth_credentials)
+          @account = options.fetch(:account)
+          @entities = options.fetch(:entities) || DEFAULT_ENTITIES
+        end
+
+        def rows
+          @rows ||= Parsers::CSVParser.new(Helpers::ZipDownloader.new(result_file_url).read).rows
+        end
+
+        def result_file_url
+          @result_file_url ||= begin
+            wait_status_complete
+            status['ResultFileUrl']
+          end
+        end
+
+        def fetch_status
+          @status = Soap::Request::GetBulkDownloadStatusRequest
+            .new(context: context.merge(request_id: download_request_id))
+            .perform
+            .payload
+        end
+
+        private
+
+        def wait_status_complete
+          Retryable.retryable(tries: POLLING_TRIES, on: NotCompleted) do
+            fetch_status
+            raise NotCompleted if status['RequestStatus'] != 'Completed'
+          end
+        end
+
+        def download_request_id
+          @download_request_id ||= Soap::Request::DownloadCampaignsByAccountIdsRequest
+            .new(context: context.merge(entities: entities))
+            .perform
+            .payload
+        end
+
+        def context
+          {
+            account: account,
+            authentication_token: oauth_credentials.access_token
+          }
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/ads/bulk/parsers/csv_parser.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+require 'csv'
+
+module SoapyBing
+  class Ads
+    module Bulk
+      module Parsers
+        class CSVParser
+          def initialize(raw)
+            @raw = raw
+          end
+
+          def rows
+            @rows ||= begin
+              header, *body = extract_csv_payload
+              body.map { |row| header.zip(row).to_h }
+            end
+          end
+
+          private
+
+          attr_reader :raw
+
+          def extract_csv_payload
+            text = raw.dup
+            text.force_encoding(Encoding::UTF_8).encode! unless text.encoding == Encoding::UTF_8
+            text.sub!(/^\xEF\xBB\xBF/, '') # cleanup BOM
+
+            CSV.parse(text)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/ads/bulk/parsers.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'soapy_bing/ads/bulk/parsers/csv_parser'

data/lib/soapy_bing/ads/bulk.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'soapy_bing/ads/bulk/parsers'
+require 'soapy_bing/ads/bulk/campaigns'

data/lib/soapy_bing/ads/reports/base.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 require 'ostruct'
-require 'uri'
-require 'httparty'
-require 'zip'
 
 module SoapyBing
   class Ads
@@ -10,7 +7,6 @@ module SoapyBing
       class Base
         class UnknownParserError < StandardError; end
         include Helpers::ClassName
-        include Helpers::SSLVersion
 
         DEFAULT_REPORT_SETTINGS = {
           format:      'Csv',
@@ -29,7 +25,7 @@ module SoapyBing
         end
 
         def rows
-          @rows ||= parser_class.new(report_body).rows
+          @rows ||= parser_class.new(Helpers::ZipDownloader.new(download_url).read).rows
         end
 
         private
@@ -56,20 +52,6 @@ module SoapyBing
           }
         end
 
-        def report_body
-          @report_body ||=
-            Zip::InputStream.open(download_io) do |archive_io|
-              file_io = archive_io.get_next_entry.get_input_stream
-              file_io.read
-            end
-        end
-
-        def download_io
-          https = URI.parse(download_url).scheme == 'https'
-          request_options = https ? { ssl_version: ssl_version } : {}
-          StringIO.new HTTParty.get(download_url, request_options).body
-        end
-
         def request_id
           @request_id ||=
             Soap::Request::SubmitGenerateReportRequest

data/lib/soapy_bing/ads.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'soapy_bing/ads/reports'
+require 'soapy_bing/ads/bulk'
 
 module SoapyBing
   class Ads
@@ -20,6 +21,14 @@ module SoapyBing
       )
     end
 
+    def bulk_campaigns(entities = nil)
+      Bulk::Campaigns.new(
+        oauth_credentials: oauth_credentials,
+        account: account,
+        entities: entities
+      )
+    end
+
     def get_ad_groups_by_campaign_id(campaign_id)
       do_request(Soap::Request::GetAdGroupsByCampaignIdRequest, campaign_id: campaign_id)
     end

data/lib/soapy_bing/helpers/zip_downloader.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'httparty'
+require 'zip'
+
+module SoapyBing
+  module Helpers
+    class ZipDownloader
+      def initialize(url)
+        @url = url
+      end
+
+      def read
+        Zip::InputStream.open(download_io) do |archive_io|
+          file_io = archive_io.get_next_entry.get_input_stream
+          file_io.read
+        end
+      end
+
+      private
+
+      def download_io
+        StringIO.new HTTParty.get(@url).body
+      end
+    end
+  end
+end

data/lib/soapy_bing/helpers.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 require 'soapy_bing/helpers/class_name'
-require 'soapy_bing/helpers/ssl_version'
+require 'soapy_bing/helpers/zip_downloader'

data/lib/soapy_bing/soap/request/download_campaigns_by_account_ids_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Request
+      class DownloadCampaignsByAccountIdsRequest < Base
+        API_BASE_URL = 'https://bulk.api.bingads.microsoft.com'
+        API_VERSION = 10
+        API_ENDPOINT =
+          "#{API_BASE_URL}/Api/Advertiser/CampaignManagement/V#{API_VERSION}/BulkService.svc"
+
+        def perform
+          Response::DownloadCampaignsByAccountIdsResponse.new(post(API_ENDPOINT))
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/request/get_bulk_download_status_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Request
+      class GetBulkDownloadStatusRequest < Base
+        API_BASE_URL = 'https://bulk.api.bingads.microsoft.com'
+        API_VERSION = 10
+        API_ENDPOINT =
+          "#{API_BASE_URL}/Api/Advertiser/CampaignManagement/V#{API_VERSION}/BulkService.svc"
+
+        def perform
+          Response::GetBulkDownloadStatusResponse.new(post(API_ENDPOINT))
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/request.rb

@@ -6,3 +6,5 @@ require 'soapy_bing/soap/request/get_ad_groups_by_campaign_id_request'
 require 'soapy_bing/soap/request/get_ads_by_ad_group_id_request'
 require 'soapy_bing/soap/request/get_targets_by_campaign_ids_request'
 require 'soapy_bing/soap/request/get_accounts_info_request'
+require 'soapy_bing/soap/request/download_campaigns_by_account_ids_request'
+require 'soapy_bing/soap/request/get_bulk_download_status_request'

data/lib/soapy_bing/soap/response/download_campaigns_by_account_ids_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Response
+      class DownloadCampaignsByAccountIdsResponse < Base
+        def extract_payload
+          response['DownloadRequestId']
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/response/get_accounts_info_response.rb

@@ -4,7 +4,7 @@ module SoapyBing
     module Response
       class GetAccountsInfoResponse < Base
         def extract_payload
-          Array.wrap(body['Envelope']['Body'][class_name]['AccountsInfo']['AccountInfo'])
+          Array.wrap(response['AccountsInfo']['AccountInfo'])
         end
       end
     end

data/lib/soapy_bing/soap/response/get_ad_groups_by_campaign_id_response.rb

@@ -4,7 +4,7 @@ module SoapyBing
     module Response
       class GetAdGroupsByCampaignIdResponse < Base
         def extract_payload
-          Array.wrap(body['Envelope']['Body'][class_name]['AdGroups']['AdGroup'])
+          Array.wrap(response['AdGroups']['AdGroup'])
         end
       end
     end

data/lib/soapy_bing/soap/response/get_ads_by_ad_group_id_response.rb

@@ -4,7 +4,7 @@ module SoapyBing
     module Response
       class GetAdsByAdGroupIdResponse < Base
         def extract_payload
-          Array.wrap(body['Envelope']['Body'][class_name]['Ads']['Ad'])
+          Array.wrap(response['Ads']['Ad'])
         end
       end
     end

data/lib/soapy_bing/soap/response/get_bulk_download_status_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module SoapyBing
+  module Soap
+    module Response
+      class GetBulkDownloadStatusResponse < Base
+        def extract_payload
+          response.slice('PercentComplete', 'RequestStatus', 'ResultFileUrl')
+        end
+      end
+    end
+  end
+end

data/lib/soapy_bing/soap/response/get_targets_by_campaign_ids_response.rb

@@ -4,7 +4,7 @@ module SoapyBing
     module Response
       class GetTargetsByCampaignIdsResponse < Base
         def extract_payload
-          Array.wrap(body['Envelope']['Body'][class_name]['Targets']['Target']).first
+          Array.wrap(response['Targets']['Target']).first
         end
       end
     end

data/lib/soapy_bing/soap/response/payload.rb

@@ -3,13 +3,25 @@ module SoapyBing
   module Soap
     module Response
       module Payload
+        Fault = Class.new(StandardError)
+
         def payload
-          @payload ||= extract_payload
+          @payload ||= check_errors_and_extract_payload
+        end
+
+        def check_errors_and_extract_payload
+          fault = body.dig('Envelope', 'Body', 'Fault')
+          raise Fault, fault.to_s if fault
+          extract_payload
         end
 
         def extract_payload
           raise NotImplementedError
         end
+
+        def response
+          @response ||= body.dig('Envelope', 'Body', class_name)
+        end
       end
     end
   end

data/lib/soapy_bing/soap/response/report_status.rb

@@ -14,7 +14,7 @@ module SoapyBing
         end
 
         def report_status
-          body['Envelope']['Body'][class_name]['ReportRequestStatus']
+          response['ReportRequestStatus']
         end
 
         def error?

data/lib/soapy_bing/soap/response/submit_generate_report_response.rb

@@ -4,7 +4,7 @@ module SoapyBing
     module Response
       class SubmitGenerateReportResponse < Base
         def extract_payload
-          body['Envelope']['Body'][class_name]['ReportRequestId']
+          response['ReportRequestId']
         end
       end
     end

data/lib/soapy_bing/soap/response.rb

@@ -10,3 +10,5 @@ require 'soapy_bing/soap/response/get_ad_groups_by_campaign_id_response'
 require 'soapy_bing/soap/response/get_ads_by_ad_group_id_response'
 require 'soapy_bing/soap/response/get_targets_by_campaign_ids_response'
 require 'soapy_bing/soap/response/get_accounts_info_response'
+require 'soapy_bing/soap/response/download_campaigns_by_account_ids_response'
+require 'soapy_bing/soap/response/get_bulk_download_status_response'

data/lib/soapy_bing/soap/template_renderer.rb

@@ -15,7 +15,7 @@ module SoapyBing
       private
 
       def read(name)
-        File.read(File.join(TEMPLATE_PATH, "#{name}.erb.xml"))
+        File.read(File.join(TEMPLATE_PATH, "#{name}.xml.erb"))
       end
     end
   end

data/lib/soapy_bing/soap/templates/download_campaigns_by_account_ids.xml.erb

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
+    <Action mustUnderstand="1">DownloadCampaignsByAccountIds</Action>
+    <AuthenticationToken i:nil="false"><%= authentication_token %></AuthenticationToken>
+    <CustomerAccountId i:nil="false"><%= account.account_id %></CustomerAccountId>
+    <CustomerId i:nil="false"><%= account.customer_id %></CustomerId>
+    <DeveloperToken i:nil="false"><%= account.developer_token %></DeveloperToken>
+  </s:Header>
+  <s:Body>
+    <DownloadCampaignsByAccountIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
+      <AccountIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
+        <a1:long><%= account.account_id %></a1:long>
+      </AccountIds>
+      <CompressionType i:nil="false">Zip</CompressionType>
+      <DataScope>EntityData</DataScope>
+      <DownloadFileType i:nil="false">Csv</DownloadFileType>
+      <Entities><%= entities.join(' ') %></Entities>
+      <FormatVersion i:nil="false">4.0</FormatVersion>
+    </DownloadCampaignsByAccountIdsRequest>
+  </s:Body>
+</s:Envelope>

data/lib/soapy_bing/soap/templates/get_bulk_download_status.xml.erb

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
+  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
+    <Action mustUnderstand="1">GetBulkDownloadStatus</Action>
+    <AuthenticationToken i:nil="false"><%= authentication_token %></AuthenticationToken>
+    <CustomerAccountId i:nil="false"><%= account.account_id %></CustomerAccountId>
+    <CustomerId i:nil="false"><%= account.customer_id %></CustomerId>
+    <DeveloperToken i:nil="false"><%= account.developer_token %></DeveloperToken>
+  </s:Header>
+  <s:Body>
+    <GetBulkDownloadStatusRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v10">
+      <RequestId i:nil="false"><%= request_id %></RequestId>
+    </GetBulkDownloadStatusRequest>
+  </s:Body>
+</s:Envelope>

data/lib/soapy_bing/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SoapyBing
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/fixtures/bulk/campaigns.csv

@@ -0,0 +1,8 @@
+Type,Status,Id,Parent Id,Sub Type,Campaign,Ad Group,Website,Sync Time,Client Id,Modified Time,Tracking Template,Custom Parameter,Final Url,Mobile Final Url,Time Zone,Budget Id,Budget Name,Budget,Budget Type,Bid Strategy Type,KeywordVariantMatchEnabled,Campaign Type,Priority,Start Date,End Date,Network Distribution,Pricing Model,Ad Rotation,Search Network,Search Bid,Content Network,Content Bid,Language,Title,Text,Display Url,Destination Url,Business Name,Phone Number,Promotion,Editorial Status,Editorial Location,Editorial Term,Editorial Reason Code,Editorial Appeal Status,Device Preference,Ad Format Preference,Title Part 1,Title Part 2,Path 1,Path 2,Keyword,Match Type,Bid,Param1,Param2,Param3,Target,Physical Intent,Bid Adjustment,Radius Target Id,Name,OS Names,Radius,Unit,Business Id,From Hour,From Minute,To Hour,To Minute,Version,Ad Schedule,Use Searcher Time Zone,Sitelink Extension Order,Sitelink Extension Link Text,Sitelink Extension Destination Url,Sitelink Extension Description1,Sitelink Extension Description2,Geo Code Status,Map Icon,Business Icon,Address Line 1,Address Line 2,Postal Code,City,State Or Province Code,Province Name,Latitude,Longitude,Country Code,Call Only,Call Tracking Enabled,Toll Free,Alternative Text,Media Ids,Publisher Countries,Store Id,Product Condition 1,Product Value 1,Product Condition 2,Product Value 2,Product Condition 3,Product Value 3,Product Condition 4,Product Value 4,Product Condition 5,Product Value 5,Product Condition 6,Product Value 6,Product Condition 7,Product Value 7,Callout Text,Action Text,Action Link Url,Is Exact,Source,Url,Structured Snippet Header,Structured Snippet Values,Spend,Impressions,Clicks,CTR,Avg CPC,Avg CPM,Avg position,Conversions,CPA,Quality Score,Keyword Relevance,Landing Page Relevance,Landing Page User Experience,App Platform,App Id,Tracking Enabled,App Status,Error,Error Number,Field Path,Is Excluded,Parent Criterion Id,Remarketing List,Remarketing List Id,Scope,Membership Duration,UET Tag Id,Description,Remarketing Targeting Setting,Domain Language,Dynamic Ad Target Condition 1,Dynamic Ad Target Condition 2,Dynamic Ad Target Condition 3,Dynamic Ad Target Value 1,Dynamic Ad Target Value 2,Dynamic Ad Target Value 3
+Format Version,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,4.0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Account,,2000001,9000001,,,,,09/09/2016 14:28:40,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Text Ad,Active,4000000075,1900000096,,saga_FR_exact,lost saga,,,,12/13/2014 16:32:34.413,,,,,,,,,,,,,,,,,,,,,,,,Joue á Lost Saga,MMO de combat gratuit. Inscris-toi et joue gratuitement !,saga.nexoneu.com,t.ad2games.com/k?w=59594_240806755&p=27871&c5=direct&c6=saga_FR_exact&c7=MV&c8=SEM_bing&ex=12007,,,,Active,,,,,All,All,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Text Ad,Paused,7000000082,2800000068,,B. BB_game_US_alpha,1. Game Online,,,,02/25/2015 14:22:42.380,,,,,,,,,,,,,,,,,,,,,,,,Game Online MMORPG,"Explore a vast, expanding universe. Register now and play for free!",example.com,example.com/?E=Wu%2byxu8PC76sbG%2beMQchUHtUq0rOvXqJ&s1=game_US_alpha&s2={keyword},,,,Active,,,,,All,All,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Text Ad,Paused,7000000083,2800000068,,B. BB_game_US_alpha,1. Game Online,,,,02/25/2015 14:22:42.380,,,,,,,,,,,,,,,,,,,,,,,,Play Game Online,"Explore a vast, expanding universe. Register now and play for free!",example.com,example.com/?E=Wu%2byxu8PC76sbG%2beMQchUHtUq0rOvXqJ&s1=game_US_alpha&s2={keyword},,,,Active,,,,,All,All,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Campaign Location Target,Active,450000052,90000073,Country,saga_FR_exact,,,,,05/06/2014 14:18:49.787,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,FR,PeopleInOrSearchingForOrViewingPages,0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+Campaign Location Target,Active,450000024,91000058,Country,B. BB_game_US_alpha,,,,,03/25/2015 00:07:29.180,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,US,PeopleInOrSearchingForOrViewingPages,0,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,