bing-ads-reporting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 773fcc14aa93c2faee97f6fa3317f7dbed4667b9
+  data.tar.gz: 9fda00618b7236eb8a040af7880fe42166d01b69
+SHA512:
+  metadata.gz: 3be8fa42af95e5e50e69a653b4cff4970099ab373b6405f4810bfcfedeeacb7d49ec67b12e4f0f95a95f271a923fd554a0da885b6579f01dd805e68722035653
+  data.tar.gz: 4378bc1fe318e37ed619851ecbcf63d357e539c1ac711ee12b61bd007990efa9888a36ebb179efd1f78b1d922dbd8e61ce8a05b9786149f9d40704f424ebd09a

data/lib/bing-ads-reporting.rb

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

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

@@ -0,0 +1,110 @@
+module BingAdsReporting
+  class Service
+
+    def initialize(settings)
+      @settings = settings
+    end
+  
+    def generate_report(report_settings, report_params)
+      options = default_options(report_settings).merge(report_params)
+      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
+            },
+            ns("CustomDateRangeStart") => {
+              ns("Day") => period.from.day,
+              ns("Month") => period.from.month,
+              ns("Year") => period.from.year
+            }
+            # ns("PredefinedTime") => options[:time]
+          }
+        },
+        :attributes! => {ns("ReportRequest") => {"xmlns:i" => "http://www.w3.org/2001/XMLSchema-instance",
+                                                 "i:type" => ns("#{report_type}ReportRequest")}
+        }
+      })
+      
+      response.body[:submit_generate_report_response][:report_request_id]
+    end
+  
+    def report_ready?(id)
+      status = poll_report(id).body[:poll_generate_report_response][:report_request_status][:status] rescue nil
+      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
+    end
+    
+    def report_body(id)
+      download(report_url(id))
+    end
+  
+    private
+  
+      def default_options(report_settings)
+        { format: report_settings[:report_format],
+          columns: report_settings[:columns],
+          aggregation: report_settings[:aggregation],
+          report_type: report_settings[:report_type],
+          report_name: "MyReport" }
+      end
+      
+      def poll_report(id)
+        client.call(:poll_generate_report, message: {
+          ns("ReportRequestId") => id,
+          :attributes! => { ns("ReportRequestId") => {"xsi:nil" => false} }
+        })
+      end
+
+      def download(url)
+        puts %Q{Downloading Bing report from: #{url}}
+        curl = Curl::Easy.new(url) do |c|
+          c.use_ssl = 3
+          c.ssl_version = 3
+        end
+        curl.perform
+        curl.body_str
+      end
+
+      def client
+        Savon.client({wsdl: "https://adcenterapi.microsoft.com/Api/Advertiser/v8/Reporting/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] }
+                      })
+                      # .merge({pretty_print_xml: true, log_level: :debug}) # for more logging
+      end
+
+      def ns(str)
+        "tns:#{str}"
+      end
+  
+  end
+end

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

@@ -0,0 +1,3 @@
+module BingAdsReporting
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: bing-ads-reporting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Robert Borkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 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
+email:
+- robert.borkowski@forward3d.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bing-ads-reporting.rb
+- lib/bing-ads-reporting/service.rb
+- lib/bing-ads-reporting/version.rb
+homepage: https://github.com/forward3d/bing-ads-reporting
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Allows easily pull reports from Bing Ads
+test_files: []