soapy_bing 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6769b40c74197462ce64b3858e1d9685a96a2afc
-  data.tar.gz: e7cd2d208675f7318e838318e9ba3f7598a95d2c
+  metadata.gz: 6516951a384d76b68b51cbd390f1d66fb7b41f8d
+  data.tar.gz: aa5436b3258ebfda01f6b832782242f0d6c39ee4
 SHA512:
-  metadata.gz: 9d9c735dccb584cc54a9de1a4827a481393f24a4ab7e086c0e3ac9770d9c0d272fbedda8d8da233e2fcb8a78132663be31a3c58be26c36e1ee5525dfb1e21990
-  data.tar.gz: 9c19239300bc2ee50a79a3c87cdb995d24a7e37b7e029c976cc735ce7683088faed872e76f383ba9397d76b46df3175a9fa36ef40ed696cd1d6347a82a9b6aec
+  metadata.gz: 4472f06bcc20a6520359a9542d4361e61969214373c40bfbf909d93751de2b7e584d082aa31cadcb94f7dea6fade3d17f03f31d96849117971dd627cd69981b1
+  data.tar.gz: 2c7a31b9d70b3b3c6d82c1532566e456d546b0ef48875773eda984ce80002c1c62bfb8dadea6c54a02176edc0fd99829e04beca9f903461f1ee92287b2e832d3

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.3.4

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -8,41 +8,41 @@ Client library for [Bing Ads API](https://msdn.microsoft.com/en-us/library/bing-
 In your Gemfile
 
 ```ruby
-gem 'soapy_bing', git: 'https://github.com/ad2games/soapy_bing'
+gem 'soapy_bing'
 ```
 
 ## Usage Examples
 
 ```ruby
 bing_ads = SoapyBing::Ads.new
-report = bing_ads.campaign_performance_report(
-  date_start: '2015-10-14',
-  date_end: '2015-10-14',
-
+rows = bing_ads.campaign_performance_report(
+  date_start: '2017-05-14',
+  date_end: '2017-05-14',
   settings: {       # optional
-    columns: ['']   # see SoapyBing::Ads::Report::Base::DEFAULT_REPORT_SETTINGS[:columns]
+    columns: ['']   # see SoapyBing::Report::Base::DEFAULT_REPORT_SETTINGS[:columns]
   }
 )
-report.rows # =>
-            #     [{
-            #       "HourOfDay"    => "0",
-            #       "CampaignName" => "My Campaign",
-            #       "Impressions"  => "100",
-            #       "Clicks"       => "47",
-            #       "Spend"        => "12.65"
-            #     }, {
-            #       ...
-            #     }]
+# =>
+#     [{
+#       "GregorianDate" => "2017-05-14"
+#       "Hour"          => "0",
+#       "CampaignName"  => "My Campaign",
+#       "Impressions"   => "100",
+#       "Clicks"        => "47",
+#       "Spend"         => "12.65"
+#     }, {
+#       ...
+#     }]
 ```
 
 ## Authentication
 
 Authentication attributes could be passed explicitly when new instance of SoapyBing::Ads is created.
-Or they could be configured as Envronment variables.
+Or they could be configured as Environment variables.
 
 ```ruby
 SoapyBing::Ads.new(
-  oauth: {                  # optional, could be configured via environment variables as
+  oauth_credentials: {      # optional, could be configured via environment variables as
     client_id: '',          # ENV['BING_ADS_OAUTH_CLIENT_ID']
     client_secret: '',      # ENV['BING_ADS_OAUTH_CLIENT_SECRET']
     refresh_token: ''       # ENV['BING_ADS_OAUTH_REFRESH_TOKEN']

data/Rakefile

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

data/lib/soapy_bing.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'httparty'
 require 'retryable'
 require 'active_support'
@@ -9,6 +10,9 @@ require 'soapy_bing/param_guard'
 require 'soapy_bing/customer'
 require 'soapy_bing/account'
 require 'soapy_bing/oauth_credentials'
-require 'soapy_bing/soap'
 require 'soapy_bing/ads'
 require 'soapy_bing/accounts'
+require 'soapy_bing/service'
+require 'soapy_bing/service_operation'
+require 'soapy_bing/campaign_management'
+require 'soapy_bing/country_codes'

data/lib/soapy_bing/account.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module SoapyBing
   class Account
     attr_reader :developer_token, :account_id, :customer_id

data/lib/soapy_bing/accounts.rb

@@ -1,32 +1,28 @@
 # frozen_string_literal: true
+
 module SoapyBing
   class Accounts
-    attr_reader :oauth_credentials, :customer
+    attr_reader :service
 
-    def initialize(oauth: {}, customer: {})
-      @oauth_credentials = OauthCredentials.new(oauth)
-      @customer = Customer.new(customer)
+    def initialize(*args)
+      @service = Service.customer_management(*args)
     end
 
     def list
-      do_request(Soap::Request::GetAccountsInfoRequest).map do |account|
-        Account.new(
-          developer_token: customer.developer_token,
-          customer_id: customer.customer_id,
-          account_id: account['Id']
-        )
+      response = service.get_accounts_info
+      response[:accounts_info][:account_info].map do |account_info|
+        build_account(account_info)
       end
     end
 
     private
 
-    def do_request(klass, options = {})
-      klass.new(context: {
-        authentication_token: oauth_credentials.access_token,
-        developer_token: customer.developer_token
-      }.merge(options))
-        .perform
-        .payload
+    def build_account(account_info)
+      Account.new(
+        developer_token: service.customer.developer_token,
+        customer_id: service.customer.customer_id,
+        account_id: account_info[:id]
+      )
     end
   end
 end

data/lib/soapy_bing/ads.rb

@@ -1,56 +1,33 @@
 # frozen_string_literal: true
-require 'soapy_bing/ads/reports'
-require 'soapy_bing/ads/bulk'
+
+require 'soapy_bing/ads/campaigns'
+require 'soapy_bing/ads/campaign_performance_report'
 
 module SoapyBing
   class Ads
-    attr_reader :oauth_credentials, :account
+    attr_reader :service_options
 
-    def initialize(oauth: {}, account: {})
-      @oauth_credentials = OauthCredentials.new(oauth)
-      @account = Account.new(account)
+    def initialize(service_options = {})
+      @service_options = service_options
     end
 
-    def campaign_performance_report(date_start:, date_end:, settings: {})
-      Reports::CampaignPerformanceReport.new(
-        oauth_credentials: oauth_credentials,
-        account: account,
+    def campaign_performance_report(date_start:, date_end:, settings: {}, polling_settings: {})
+      CampaignPerformanceReport.new(
+        service_options: service_options,
         date_start: date_start,
         date_end: date_end,
-        settings: settings
-      )
-    end
-
-    def bulk_campaigns(entities = nil, polling_settings = {})
-      Bulk::Campaigns.new(
-        oauth_credentials: oauth_credentials,
-        account: account,
-        entities: entities,
+        settings: settings,
         polling_settings: polling_settings
-      )
-    end
-
-    def get_ad_groups_by_campaign_id(campaign_id)
-      do_request(Soap::Request::GetAdGroupsByCampaignIdRequest, campaign_id: campaign_id)
+      ).rows
     end
 
-    def get_ads_by_ad_group_id(ad_group_id)
-      do_request(Soap::Request::GetAdsByAdGroupIdRequest, ad_group_id: ad_group_id)
-    end
-
-    def get_targets_by_campaign_ids(campaign_ids)
-      do_request(Soap::Request::GetTargetsByCampaignIdsRequest, campaign_ids: campaign_ids)
-    end
-
-    private
-
-    def do_request(klass, options)
-      klass.new(context: {
-        account: account,
-        authentication_token: oauth_credentials.access_token
-      }.merge(options))
-        .perform
-        .payload
+    def campaigns(entities = Campaigns::DEFAULT_ENTITIES, polling_settings: {}, campaign_ids: nil)
+      Campaigns.new(
+        service_options: service_options,
+        entities: entities,
+        polling_settings: polling_settings,
+        campaign_ids: campaign_ids
+      ).rows
     end
   end
 end

data/lib/soapy_bing/ads/campaign_performance_report.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'soapy_bing/ads/report'
+require 'date'
+
+module SoapyBing
+  class Ads
+    class CampaignPerformanceReport < Report
+      attr_reader :date_start, :date_end
+
+      def initialize(options)
+        super
+        @date_start = Date.parse(options.fetch(:date_start))
+        @date_end = Date.parse(options.fetch(:date_end))
+      end
+
+      def message
+        {
+          aggregation: settings.aggregation,
+          columns: { campaign_performance_report_column: settings.columns },
+          scope: scope,
+          time: {
+            custom_date_range_end: date_hash(date_end),
+            custom_date_range_start: date_hash(date_start)
+          }
+        }
+      end
+
+      private
+
+      def scope
+        {
+          account_ids: {
+            '@xmlns:a1' => 'http://schemas.microsoft.com/2003/10/Serialization/Arrays',
+            'a1:long' => service.account.account_id
+          }
+        }
+      end
+
+      def date_hash(date)
+        { day: date.day, month: date.month, year: date.year }
+      end
+
+      def request_type
+        'CampaignPerformanceReportRequest'
+      end
+    end
+  end
+end

data/lib/soapy_bing/ads/campaigns.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'soapy_bing/ads/parsers/bulk_csv_parser'
+
+module SoapyBing
+  class Ads
+    class Campaigns
+      DEFAULT_ENTITIES = %w[CampaignTargetCriterions Ads].freeze
+      DEFAULT_POLLING_SETTINGS = {
+        tries: 20,
+        sleep: ->(n) { n < 7 ? 2**n : 120 }
+      }.freeze
+      NotCompleted = Class.new(StandardError)
+      StatusFailed = Class.new(StandardError)
+
+      attr_reader :service, :entities, :polling_settings, :status, :campaign_ids
+
+      def initialize(
+        service_options:,
+        entities: DEFAULT_ENTITIES,
+        polling_settings: {},
+        campaign_ids: nil
+      )
+        @service = Service.bulk(service_options)
+        @entities = entities
+        @polling_settings = DEFAULT_POLLING_SETTINGS.merge(polling_settings)
+        @campaign_ids = campaign_ids
+      end
+
+      def rows
+        @rows ||= Parsers::BulkCsvParser.new(Helpers::ZipDownloader.new(result_file_url).read).rows
+      end
+
+      private
+
+      def result_file_url
+        @result_file_url ||= begin
+          wait_status_complete
+          status[:result_file_url]
+        end
+      end
+
+      def fetch_status
+        response = service.get_bulk_download_status(request_id: download_request_id)
+        if response[:request_status] == 'Failed'
+          raise StatusFailed, response[:errors].to_s
+        end
+        @status = response.slice(:percent_complete, :request_status, :result_file_url)
+      end
+
+      def wait_status_complete
+        Retryable.retryable(polling_settings.merge(on: NotCompleted)) do
+          fetch_status
+          raise NotCompleted if status[:request_status] != 'Completed'
+        end
+      end
+
+      def download_request_id
+        @download_request_id ||= download_campaigns
+      end
+
+      def download_campaigns
+        response = campaign_ids ? by_campaign_ids : by_account_ids
+        response[:download_request_id]
+      end
+
+      def by_campaign_ids
+        service.download_campaigns_by_campaign_ids(
+          {
+            campaigns: {
+              campaign_scope: campaign_scope
+            }
+          }.merge(common_request_body)
+        )
+      end
+
+      def campaign_scope
+        campaign_ids.map do |campaign_id|
+          {
+            campaign_id: campaign_id,
+            parent_account_id: service.account.account_id
+          }
+        end
+      end
+
+      def by_account_ids
+        service.download_campaigns_by_account_ids(
+          {
+            account_ids: {
+              '@xmlns:a1' => 'http://schemas.microsoft.com/2003/10/Serialization/Arrays',
+              'a1:long' => service.account.account_id
+            }
+          }.merge(common_request_body)
+        )
+      end
+
+      def common_request_body
+        {
+          download_entities: { download_entity: entities },
+          download_file_type: 'Csv',
+          format_version: '5.0'
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module SoapyBing
+  class Ads
+    module Parsers
+      class BulkCsvParser
+        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

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module SoapyBing
+  class Ads
+    module Parsers
+      class ReportCsvParser
+        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