soapy_bing 0.3.1 → 0.4.0

data/lib/soapy_bing/ads/bulk.rb

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

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

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  class Ads
-    module Bulk
-      class Campaigns
-        DEFAULT_ENTITIES = %w(CampaignTargets Ads).freeze
-        DEFAULT_POLLING_SETTINGS = {
-          tries: 20,
-          sleep: ->(n) { n < 7 ? 2**n : 120 }
-        }.freeze
-        NotCompleted = Class.new(StandardError)
-
-        attr_reader :oauth_credentials, :account, :entities, :polling_settings, :status
-
-        def initialize(options)
-          @oauth_credentials = options.fetch(:oauth_credentials)
-          @account = options.fetch(:account)
-          @entities = options.fetch(:entities) || DEFAULT_ENTITIES
-          @polling_settings = DEFAULT_POLLING_SETTINGS.merge(options.fetch(:polling_settings) || {})
-        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(polling_settings.merge(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.rb

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

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

@@ -1,35 +0,0 @@
-# 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/reports.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-require 'soapy_bing/ads/reports/parsers'
-require 'soapy_bing/ads/reports/base'
-require 'soapy_bing/ads/reports/campaign_performance_report'

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

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-require 'ostruct'
-
-module SoapyBing
-  class Ads
-    module Reports
-      class Base
-        class UnknownParserError < StandardError; end
-        include Helpers::ClassName
-
-        DEFAULT_REPORT_SETTINGS = {
-          format:      'Csv',
-          language:    'English',
-          name:        'MyReport',
-          aggregation: 'HourOfDay',
-          columns:     %w(TimePeriod CampaignName Impressions Clicks Spend CampaignId)
-        }.freeze
-
-        attr_reader :oauth_credentials, :account, :settings
-
-        def initialize(options)
-          @oauth_credentials = options.fetch(:oauth_credentials)
-          @account = options.fetch(:account)
-          @settings = OpenStruct.new(DEFAULT_REPORT_SETTINGS.merge(options.fetch(:settings, {})))
-        end
-
-        def rows
-          @rows ||= parser_class.new(Helpers::ZipDownloader.new(download_url).read).rows
-        end
-
-        private
-
-        def parser_class
-          class_name = "#{settings.format.upcase}Parser".to_sym
-          raise UnknownParserError, class_name unless Parsers.constants.include?(class_name)
-          Parsers.const_get class_name
-        end
-
-        def download_url
-          @url ||=
-            Soap::Request::PollGenerateReportRequest
-              .new(context: poll_generate_report_context)
-              .perform
-              .payload
-        end
-
-        def poll_generate_report_context
-          {
-            account: account,
-            authentication_token: oauth_credentials.access_token,
-            request_id: request_id
-          }
-        end
-
-        def request_id
-          @request_id ||=
-            Soap::Request::SubmitGenerateReportRequest
-              .new(context: submit_generate_report_context)
-              .perform
-              .payload
-        end
-
-        def submit_generate_report_context
-          {
-            account: account,
-            authentication_token: oauth_credentials.access_token,
-            settings: settings,
-            report_class: class_name
-          }
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-require 'date'
-
-module SoapyBing
-  class Ads
-    module Reports
-      class CampaignPerformanceReport < Base
-        attr_reader :date_range
-
-        def initialize(options)
-          super(options)
-          @date_range = Range.new(
-            Date.parse(options.fetch(:date_start)),
-            Date.parse(options.fetch(:date_end))
-          )
-        end
-
-        def submit_generate_report_context
-          super.merge(date_range: date_range)
-        end
-      end
-    end
-  end
-end

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

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

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-require 'csv'
-
-module SoapyBing
-  class Ads
-    module Reports
-      module Parsers
-        class CSVParser
-          class FormatError < StandardError; end
-
-          CSV_PAYLOAD_OFFSET_FRONT = 10 # First 10 csv lines are report metadata
-          CSV_PAYLOAD_OFFSET_BACK = 2 # Last 2 csv lines are Microsoft copyright
-
-          def initialize(raw)
-            @raw = raw
-          end
-
-          def rows
-            @rows ||= begin
-              header, *body = extract_csv_payload
-              raise FormatError if body.size != payload_rows_number
-              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_rows = CSV.parse(text)
-            csv_rows[CSV_PAYLOAD_OFFSET_FRONT...-CSV_PAYLOAD_OFFSET_BACK]
-          end
-
-          def payload_rows_number
-            raw.match(/"Rows: (\d+)"/)[1].to_i
-          end
-        end
-      end
-    end
-  end
-end

data/lib/soapy_bing/helpers/class_name.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Helpers
-    module ClassName
-      def class_name
-        @class_name ||= self.class.name.demodulize
-      end
-    end
-  end
-end

data/lib/soapy_bing/soap.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-require 'soapy_bing/soap/template_renderer'
-require 'soapy_bing/soap/request'
-require 'soapy_bing/soap/response'

data/lib/soapy_bing/soap/request.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-require 'soapy_bing/soap/request/base'
-require 'soapy_bing/soap/request/submit_generate_report_request'
-require 'soapy_bing/soap/request/poll_generate_report_request'
-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/request/base.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-require 'httparty'
-
-module SoapyBing
-  module Soap
-    module Request
-      class Base
-        include Helpers::ClassName
-
-        DEFAULT_HTTP_HEADERS = {
-          'Content-Type' => 'text/xml;charset=UTF-8'
-        }.freeze
-
-        attr_reader :context
-
-        def initialize(context:)
-          @context = context
-        end
-
-        def post(url, body: default_body, headers: default_headers)
-          HTTParty.post(url, body: body, headers: headers)
-        end
-
-        def default_body
-          TemplateRenderer.new(context).render(action_name.underscore)
-        end
-
-        def default_headers
-          DEFAULT_HTTP_HEADERS.merge('SOAPAction' => action_name)
-        end
-
-        def action_name
-          class_name.sub(/Request$/, '')
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# 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_accounts_info_request.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-module SoapyBing
-  module Soap
-    module Request
-      class GetAccountsInfoRequest < Base
-        API_BASE_URL = 'https://clientcenter.api.bingads.microsoft.com'
-        API_VERSION = 9
-        API_ENDPOINT = "#{API_BASE_URL}/Api/CustomerManagement/" \
-          "v#{API_VERSION}/CustomerManagementService.svc"
-
-        def perform
-          Response::GetAccountsInfoResponse.new(post(API_ENDPOINT))
-        end
-      end
-    end
-  end
-end

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

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

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

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

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

@@ -1,17 +0,0 @@
-# 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/get_targets_by_campaign_ids_request.rb

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