bing-ads-reporting 0.1.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5ea9a2f68ab024058db195ff33acb2e3c8eaa0e
-  data.tar.gz: 6ea308cc9e3c116bec9454035e78859dd6ae42bc
+  metadata.gz: 76f0917662f7d55f85fc067d94744e7f33891d71
+  data.tar.gz: a5583a6ec263e9adf5a4c8b0179b8787dcf3645e
 SHA512:
-  metadata.gz: 4a6c30cb0d9568d4790a695060267f140c8c558f69fc207e854aa6db141e88e4f5356a8bd943efc86165e3b4ea968843152fd3eb0e0500433a864419f690b6ec
-  data.tar.gz: e5597a7043e225f0c420fa5e3e2f14f0eae0b8f66b8149584b36769959504b7031017ddab9115b6316d7567a62d430d6c4b09849b4136286550b76880af0b6b5
+  metadata.gz: 609e71a291f1e6018cbfdcf0937a27cb96e538e790384583d85e03162ccb216aba450544b87256cdd2a8fa0c0ed95b0451507f2096d043de345a8ff920956c5c
+  data.tar.gz: 4a52d0d72a46af3fbecba1e0be47f0028c137034f1ef6f0dd38c6295de2e25eb5c0cb8ad78988c2999412c391e5b95ae99f81d20955a8b360ac6fc6eba4e2229

data/lib/bing-ads-reporting.rb

@@ -1,5 +1,6 @@
 require_relative 'bing-ads-reporting/service'
 require_relative 'bing-ads-reporting/version'
+require 'logger'
 
 module BingAdsReporting
 end

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

@@ -1,8 +1,11 @@
 module BingAdsReporting
+  class AuthenticationTokenExpired < Exception; end
+  
   class Service
 
-    def initialize(settings)
+    def initialize(settings, logger = nil)
       @settings = settings
+      @logger = logger || Logger.new($stdout)
     end
   
     def generate_report(report_settings, report_params)
@@ -10,40 +13,52 @@ module BingAdsReporting
       period = options[:period]
       report_type = options[:report_type]
     
-      response = client.call(:submit_generate_report, message: {
-        ns('ReportRequest') => {
-          ns("Format") => options[:format],
-          ns("Language") => "English",
-          ns("ReportName") => options[:report_name],
-          ns("ReturnOnlyCompleteData") => false,
-          ns("Aggregation") => options[:aggregation],
-          ns("Columns") => {
-            ns("#{report_type}ReportColumn") => options[:columns]
-          },
-          ns("Scope") => {
-            ns("AccountIds") => {
-              'arr:long' => @settings[:accountId]
-            }
-          },
-          ns("Time") => {
-            # apparently order is important, and end date has to be before start date, wtf
-            ns("CustomDateRangeEnd") => {
-              ns("Day") => period.to.day,
-              ns("Month") => period.to.month,
-              ns("Year") => period.to.year
+      begin
+        response = client.call(:submit_generate_report, message: {
+          ns('ReportRequest') => {
+            ns("Format") => options[:format],
+            ns("Language") => "English",
+            ns("ReportName") => options[:report_name],
+            ns("ReturnOnlyCompleteData") => false,
+            ns("Aggregation") => options[:aggregation],
+            ns("Columns") => {
+              ns("#{report_type}ReportColumn") => options[:columns]
+            },
+            ns("Scope") => {
+              ns("AccountIds") => {
+                'arr:long' => @settings[:accountId]
+              }
             },
-            ns("CustomDateRangeStart") => {
-              ns("Day") => period.from.day,
-              ns("Month") => period.from.month,
-              ns("Year") => period.from.year
+            ns("Time") => {
+              # apparently order is important, and end date has to be before start date, wtf
+              ns("CustomDateRangeEnd") => {
+                ns("Day") => period.to.day,
+                ns("Month") => period.to.month,
+                ns("Year") => period.to.year
+              },
+              ns("CustomDateRangeStart") => {
+                ns("Day") => period.from.day,
+                ns("Month") => period.from.month,
+                ns("Year") => period.from.year
+              }
+              # ns("PredefinedTime") => options[:time]
             }
-            # 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") => {"xmlns:i" => "http://www.w3.org/2001/XMLSchema-instance",
-                                                 "i:type" => ns("#{report_type}ReportRequest")}
-        }
-      })
+        })
+      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] rescue ''
+        if err == 'AuthenticationTokenExpired'
+          @logger.error err
+          raise AuthenticationTokenExpired.new(msg)
+        end
+        @logger.error e.message
+        @logger.error msg
+        raise e
+      end
       
       response.body[:submit_generate_report_response][:report_request_id]
     end
@@ -81,7 +96,7 @@ module BingAdsReporting
       end
 
       def download(url)
-        puts %Q{Downloading Bing report from: #{url}}
+        @logger.debug "Downloading Bing report from: #{url}"
         curl = Curl::Easy.new(url) do |c|
           c.use_ssl = 3
           c.ssl_version = 3
@@ -91,15 +106,24 @@ module BingAdsReporting
       end
 
       def client
+        if @settings[:username] && @settings[:password]
+          header = {ns('ApplicationToken') => @settings[:applicationToken],
+                                              ns('CustomerAccountId') => @settings[:accountId],
+                                              ns('CustomerId') => @settings[:customerId],
+                                              ns('DeveloperToken') => @settings[:developerToken],
+                                              ns('UserName') => @settings[:username],
+                                              ns('Password') => @settings[:password] }
+        else
+          header = {ns('ApplicationToken') => @settings[:applicationToken],
+                                              ns('CustomerAccountId') => @settings[:accountId],
+                                              ns('CustomerId') => @settings[:customerId],
+                                              ns('DeveloperToken') => @settings[:developerToken],
+                                              ns('AuthenticationToken') => @settings[:authenticationToken] }
+        end
         Savon.client({wsdl: "https://api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc?wsdl",
                       log_level: :info,
                       namespaces: {"xmlns:arr" => 'http://schemas.microsoft.com/2003/10/Serialization/Arrays'},
-                      soap_header: {ns('ApplicationToken') => @settings[:applicationToken],
-                                    ns('CustomerAccountId') => @settings[:accountId],
-                                    ns('CustomerId') => @settings[:customerId],
-                                    ns('DeveloperToken') => @settings[:developerToken],
-                                    ns('UserName') => @settings[:username],
-                                    ns('Password') => @settings[:password] }
+                      soap_header: header
                       })
                       # .merge({pretty_print_xml: true, log_level: :debug})) # for more logging
       end

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

@@ -1,3 +1,3 @@
 module BingAdsReporting
-  VERSION = "0.1.1"
+  VERSION = "1.1.1"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: bing-ads-reporting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Robert Borkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datebox
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Bing Ads Reports
@@ -72,17 +72,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Allows easily pull reports from Bing Ads