soapy_bing 0.3.1 → 0.4.0

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Request
-      class PollGenerateReportRequest < Base
-        class FailedStatusError < StandardError; end
-        class PendingStatusError < StandardError; end
-        class PollingTimeoutError < StandardError; end
-
-        API_BASE_URL = 'https://reporting.api.bingads.microsoft.com'
-        API_VERSION = 9
-        API_ENDPOINT =
-          "#{API_BASE_URL}/Api/Advertiser/Reporting/V#{API_VERSION}/ReportingService.svc"
-
-        POLLING_TRIES = 100
-
-        def perform
-          Retryable.retryable(tries: POLLING_TRIES, on: PendingStatusError) { poll! }
-        rescue PendingStatusError
-          raise PollingTimeoutError
-        end
-
-        private
-
-        def poll!
-          response = Response::PollGenerateReportResponse.new(post(API_ENDPOINT))
-          raise PendingStatusError if response.pending?
-          raise FailedStatusError if response.error?
-          response
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Request
-      class SubmitGenerateReportRequest < Base
-        API_BASE_URL = 'https://reporting.api.bingads.microsoft.com'
-        API_VERSION = 9
-        API_ENDPOINT =
-          "#{API_BASE_URL}/Api/Advertiser/Reporting/V#{API_VERSION}/ReportingService.svc"
-
-        def perform
-          Response::SubmitGenerateReportResponse.new(post(API_ENDPOINT))
-        end
-      end
-    end
-  end
-end

data/lib/soapy_bing/soap/response.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-require 'active_support/core_ext/array/wrap'
-
-require 'soapy_bing/soap/response/payload'
-require 'soapy_bing/soap/response/report_status'
-require 'soapy_bing/soap/response/base'
-require 'soapy_bing/soap/response/submit_generate_report_response'
-require 'soapy_bing/soap/response/poll_generate_report_response'
-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/response/base.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class Base
-        include Helpers::ClassName
-        include Payload
-
-        attr_reader :body
-
-        def initialize(body)
-          @body = body
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# 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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class GetAccountsInfoResponse < Base
-        def extract_payload
-          Array.wrap(response['AccountsInfo']['AccountInfo'])
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class GetAdGroupsByCampaignIdResponse < Base
-        def extract_payload
-          Array.wrap(response['AdGroups']['AdGroup'])
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class GetAdsByAdGroupIdResponse < Base
-        def extract_payload
-          Array.wrap(response['Ads']['Ad'])
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class GetBulkDownloadStatusResponse < Base
-        StatusFailed = Class.new(StandardError)
-
-        def extract_payload
-          if response['RequestStatus'] == 'Failed'
-            raise StatusFailed, response['Errors'].to_s
-          end
-          response.slice('PercentComplete', 'RequestStatus', 'ResultFileUrl')
-        end
-      end
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class GetTargetsByCampaignIdsResponse < Base
-        def extract_payload
-          Array.wrap(response['Targets']['Target']).first
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      module Payload
-        Fault = Class.new(StandardError)
-
-        def 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
-end

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      class PollGenerateReportResponse < Base
-        include ReportStatus
-
-        def extract_payload
-          report_status['ReportDownloadUrl']
-        end
-      end
-    end
-  end
-end

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

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Response
-      module ReportStatus
-        include Helpers::ClassName
-
-        def status
-          @status ||= extract_status
-        end
-
-        def extract_status
-          report_status['Status']
-        end
-
-        def report_status
-          response['ReportRequestStatus']
-        end
-
-        def error?
-          status == 'Error'
-        end
-
-        def success?
-          status == 'Success'
-        end
-
-        def pending?
-          status == 'Pending'
-        end
-      end
-    end
-  end
-end

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

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

data/lib/soapy_bing/soap/template_renderer.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-require 'ostruct'
-require 'erubis'
-
-module SoapyBing
-  module Soap
-    class TemplateRenderer < OpenStruct
-      TEMPLATE_PATH = File.expand_path('../templates', __FILE__)
-
-      def render(template_name)
-        template_body = read(template_name)
-        Erubis::XmlEruby.new(template_body).result(binding)
-      end
-
-      private
-
-      def read(name)
-        File.read(File.join(TEMPLATE_PATH, "#{name}.xml.erb"))
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-<?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_accounts_info.xml.erb

@@ -1,12 +0,0 @@
-<?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/Customer/v9">
-  <Action mustUnderstand="1">GetAccountsInfo</Action>
-  <AuthenticationToken><%= authentication_token %></AuthenticationToken>
-  <DeveloperToken><%= developer_token %></DeveloperToken>
-</s:Header>
-<s:Body>
-  <GetAccountsInfoRequest xmlns="https://bingads.microsoft.com/Customer/v9">
-  </GetAccountsInfoRequest>
-</s:Body>
-</s:Envelope>

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

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
-              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
-    <env:Header>
-        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
-        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
-        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
-        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
-    </env:Header>
-    <env:Body>
-        <tns:GetAdGroupsByCampaignIdRequest>
-            <tns:CampaignId><%= campaign_id %></tns:CampaignId>
-        </tns:GetAdGroupsByCampaignIdRequest>
-    </env:Body>
-</env:Envelope>

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

@@ -1,15 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
-              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
-    <env:Header>
-        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
-        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
-        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
-        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
-    </env:Header>
-    <env:Body>
-        <tns:GetAdsByAdGroupIdRequest>
-          <tns:AdGroupId><%= ad_group_id %></tns:AdGroupId>
-        </tns:GetAdsByAdGroupIdRequest>
-    </env:Body>
-</env:Envelope>

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

@@ -1,15 +0,0 @@
-<?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/soap/templates/get_targets_by_campaign_ids.xml.erb

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<env:Envelope xmlns:tns="https://bingads.microsoft.com/CampaignManagement/v10"
-              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
-              xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
-    <env:Header>
-        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
-        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
-        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
-        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
-    </env:Header>
-    <env:Body>
-        <tns:GetTargetsByCampaignIdsRequest>
-            <tns:CampaignIds>
-              <% campaign_ids.each do |campaign_id| %>
-                <arr:long><%= campaign_id %></arr:long>
-              <% end %>
-            </tns:CampaignIds>
-        </tns:GetTargetsByCampaignIdsRequest>
-    </env:Body>
-</env:Envelope>

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

@@ -1,18 +0,0 @@
-<?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><%= account.account_id %></tns:CustomerAccountId>
-        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
-        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
-        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
-    </env:Header>
-    <env:Body>
-        <tns:PollGenerateReportRequest>
-            <tns:ReportRequestId xsi:nil="false"><%= request_id %></tns:ReportRequestId>
-        </tns:PollGenerateReportRequest>
-    </env:Body>
-</env:Envelope>

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

@@ -1,46 +0,0 @@
-<?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><%= account.account_id %></tns:CustomerAccountId>
-        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
-        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
-        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
-    </env:Header>
-    <env:Body>
-        <tns:SubmitGenerateReportRequest>
-            <tns:ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="tns:<%= report_class %>Request">
-                <tns:Format><%= settings.format %></tns:Format>
-                <tns:Language><%= settings.language %></tns:Language>
-                <tns:ReportName><%= settings.name %></tns:ReportName>
-                <tns:ReturnOnlyCompleteData>false</tns:ReturnOnlyCompleteData>
-                <tns:Aggregation><%= settings.aggregation %></tns:Aggregation>
-                <tns:Columns>
-                     <% settings.columns.each do |column| %>
-                        <tns:<%= report_class %>Column><%= column %></tns:<%= report_class %>Column>
-                     <% end %>
-                </tns:Columns>
-                <tns:Scope>
-                    <tns:AccountIds>
-                        <arr:long><%= account.account_id %></arr:long>
-                    </tns:AccountIds>
-                </tns:Scope>
-                <tns:Time>
-                    <tns:CustomDateRangeEnd>
-                        <tns:Day><%= date_range.end.day %></tns:Day>
-                        <tns:Month><%= date_range.end.month %></tns:Month>
-                        <tns:Year><%= date_range.end.year %></tns:Year>
-                    </tns:CustomDateRangeEnd>
-                    <tns:CustomDateRangeStart>
-                        <tns:Day><%= date_range.begin.day %></tns:Day>
-                        <tns:Month><%= date_range.begin.month %></tns:Month>
-                        <tns:Year><%= date_range.begin.year %></tns:Year>
-                    </tns:CustomDateRangeStart>
-                </tns:Time>
-            </tns:ReportRequest>
-        </tns:SubmitGenerateReportRequest>
-    </env:Body>
-</env:Envelope>