bing-ads-reporting 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4e8d0fe7973de30dff975c44607935432b1e4e9
-  data.tar.gz: b4da0af50e213be19df24d16b44941b3dd1ce466
+  metadata.gz: fc0057cb44b94bed322895917c644f381754a07c
+  data.tar.gz: 16e037d6ff98041c96dc50b260a2cb36aa598a44
 SHA512:
-  metadata.gz: 47d4ea5411fec635f089e5c234cdd412eff110506e1589956fae8242be5ef5a570ae0f79e6df5fbbe34acc40202781b21740d6caee38c7ae80befc210fd2cd46
-  data.tar.gz: 382a565cf992292f30380ba760fbd6c45c7a8063c769022159911cc9cf0a4772d342dc80dca29627a10c3ddbebcbc837fdec5e71aee2365f56e9af8c892c1097
+  metadata.gz: 12fa989c13af0dd517d4eb7ab81582b3abf6ec0f2d43cfefe3f672c45157407a73681828ae24ca03118b49d212820ed407f6e1dc4bd9f7dc00a299060bdd86da
+  data.tar.gz: 93d79fd944913be27f9e9f5c089cb62af994cbbaacf6bfde041d8c14e31276782a48c87f45d13703d3ccb7064c4c19ecfc6d310097dcbf6d0dad52e9b665099e

data/lib/bing-ads-reporting/service.rb

@@ -2,6 +2,7 @@ module BingAdsReporting
   class AuthenticationTokenExpired < Exception; end
   
   class Service
+    SUCCESS = 'Success'
 
     def initialize(settings, logger = nil)
       @settings = settings
@@ -19,7 +20,8 @@ module BingAdsReporting
             ns("Format") => options[:format],
             ns("Language") => "English",
             ns("ReportName") => options[:report_name],
-            ns("ReturnOnlyCompleteData") => false,
+            ns("ReturnOnlyCompleteData") => 'false',
+
             ns("Aggregation") => options[:aggregation],
             ns("Columns") => {
               ns("#{report_type}ReportColumn") => options[:columns]
@@ -44,8 +46,10 @@ module BingAdsReporting
               # ns("PredefinedTime") => options[:time]
             }
           },
-          :attributes! => {ns("ReportRequest") => {"xmlns:i" => "http://www.w3.org/2001/XMLSchema-instance",
-                                                   "i:type" => ns("#{report_type}ReportRequest")}
+          :attributes! => {ns("ReportRequest") => {
+                                                   "i:type" => ns("#{report_type}ReportRequest"),
+                                                   "i:nil" => 'false'
+                                                   }
           }
         })
         
@@ -73,18 +77,24 @@ module BingAdsReporting
       polled = poll_report(id)
       status = polled.body[:poll_generate_report_response][:report_request_status][:status] rescue nil
       raise "Report status: Error for ID: #{id}. TrackingId: #{polled.header[:tracking_id]}" if status == "Error"
-      status == "Success"
-    end
-    
-    def report_url(id)
-      download_url = poll_report(id).body[:poll_generate_report_response][:report_request_status][:report_download_url] rescue nil
+      status == SUCCESS
     end
     
+    # returns nil if there is no data
     def report_body(id)
       download(report_url(id))
     end
   
     private
+
+      def report_url(id)
+        polled = poll_report(id)
+        status = polled.body[:poll_generate_report_response][:report_request_status][:status] rescue nil
+        download_url = polled.body[:poll_generate_report_response][:report_request_status][:report_download_url] rescue nil
+        return nil if download_url.nil? && status == SUCCESS
+        raise "Report URL is not available for report id #{id}" unless download_url
+        download_url
+      end
   
       def default_options(report_settings)
         { format: report_settings[:report_format],
@@ -95,18 +105,28 @@ module BingAdsReporting
       end
       
       def poll_report(id)
-        client.call(:poll_generate_report, message: {
-          ns("ReportRequestId") => id,
-          :attributes! => { ns("ReportRequestId") => {"xsi:nil" => false} }
-        })
+        begin
+          client.call(:poll_generate_report, message: {
+            ns("ReportRequestId") => id,
+          })
+        rescue Savon::SOAPFault => e
+          err = e.to_hash[:fault][:detail][:ad_api_fault_detail][:errors][:ad_api_error][:error_code] rescue nil
+          msg = e.to_hash[:fault][:detail][:ad_api_fault_detail][:errors][:ad_api_error][:message] if err
+          if err.nil?
+            err = e.to_hash[:fault][:detail][:api_fault_detail][:operation_errors][:operation_error][:error_code] rescue nil
+            msg = e.to_hash[:fault][:detail][:api_fault_detail][:operation_errors][:operation_error][:message] if err
+          end
+          if err == 'AuthenticationTokenExpired'
+            @logger.error err
+            raise AuthenticationTokenExpired.new(msg)
+          end
+        end
       end
 
       def download(url)
+        return unless url
         @logger.debug "Downloading Bing report from: #{url}"
-        curl = Curl::Easy.new(url) do |c|
-          c.use_ssl = 3
-          c.ssl_version = 3
-        end
+        curl = Curl::Easy.new(url)
         curl.perform
         curl.body_str
       end
@@ -126,17 +146,19 @@ module BingAdsReporting
                                               ns('DeveloperToken') => @settings[:developerToken],
                                               ns('AuthenticationToken') => @settings[:authenticationToken] }
         end
-        Savon.client({wsdl: "https://api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc?wsdl",
+        Savon.client({
+                      wsdl: "https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V11/ReportingService.svc?singleWsdl",
                       log_level: :info,
-                      namespaces: {"xmlns:arr" => 'http://schemas.microsoft.com/2003/10/Serialization/Arrays'},
+                      namespaces: { "xmlns:arr" => 'http://schemas.microsoft.com/2003/10/Serialization/Arrays',
+                                    "xmlns:i" => "http://www.w3.org/2001/XMLSchema-instance" },
                       soap_header: header
                       })
-                      # .merge({pretty_print_xml: true, log_level: :debug})) # for more logging
+                      # .merge({pretty_print_xml: true, log_level: :debug, log: true, logger: @logger})) # for more logging
       end
 
       def ns(str)
         "tns:#{str}"
       end
-  
+
   end
 end

data/lib/bing-ads-reporting/version.rb

@@ -1,3 +1,3 @@
 module BingAdsReporting
-  VERSION = "1.1.2"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bing-ads-reporting
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Robert Borkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datebox
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Allows easily pull reports from Bing Ads