soapy_bing 0.0.1

data/lib/soapy_bing/soap/templates/submit_generate_report.erb.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+              xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
+              xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+              xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
+    <env:Header>
+        <tns:CustomerAccountId><%= account.account_id %></tns:CustomerAccountId>
+        <tns:CustomerId><%= account.customer_id %></tns:CustomerId>
+        <tns:DeveloperToken><%= account.developer_token %></tns:DeveloperToken>
+        <tns:AuthenticationToken><%= authentication_token %></tns:AuthenticationToken>
+    </env:Header>
+    <env:Body>
+        <tns:SubmitGenerateReportRequest>
+            <tns:ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="tns:<%= report_class %>Request">
+                <tns:Format><%= settings.format %></tns:Format>
+                <tns:Language><%= settings.language %></tns:Language>
+                <tns:ReportName><%= settings.name %></tns:ReportName>
+                <tns:ReturnOnlyCompleteData>false</tns:ReturnOnlyCompleteData>
+                <tns:Aggregation><%= settings.aggregation %></tns:Aggregation>
+                <tns:Columns>
+                     <% settings.columns.each do |column| %>
+                        <tns:<%= report_class %>Column><%= column %></tns:<%= report_class %>Column>
+                     <% end %>
+                </tns:Columns>
+                <tns:Scope>
+                    <tns:AccountIds>
+                        <arr:long><%= account.account_id %></arr:long>
+                    </tns:AccountIds>
+                </tns:Scope>
+                <tns:Time>
+                    <tns:CustomDateRangeEnd>
+                        <tns:Day><%= date_range.end.day %></tns:Day>
+                        <tns:Month><%= date_range.end.month %></tns:Month>
+                        <tns:Year><%= date_range.end.year %></tns:Year>
+                    </tns:CustomDateRangeEnd>
+                    <tns:CustomDateRangeStart>
+                        <tns:Day><%= date_range.begin.day %></tns:Day>
+                        <tns:Month><%= date_range.begin.month %></tns:Month>
+                        <tns:Year><%= date_range.begin.year %></tns:Year>
+                    </tns:CustomDateRangeStart>
+                </tns:Time>
+            </tns:ReportRequest>
+        </tns:SubmitGenerateReportRequest>
+    </env:Body>
+</env:Envelope>

data/lib/soapy_bing/soap.rb

@@ -0,0 +1,3 @@
+require 'soapy_bing/soap/template_renderer'
+require 'soapy_bing/soap/request'
+require 'soapy_bing/soap/response'

data/lib/soapy_bing/version.rb

@@ -0,0 +1,3 @@
+module SoapyBing
+  VERSION = '0.0.1'.freeze
+end

data/lib/soapy_bing.rb

@@ -0,0 +1,11 @@
+require 'httparty'
+require 'retryable'
+require 'active_support'
+require 'active_support/core_ext/string/inflections'
+
+require 'soapy_bing/helpers'
+require 'soapy_bing/param_guard'
+require 'soapy_bing/account'
+require 'soapy_bing/oauth_credentials'
+require 'soapy_bing/soap'
+require 'soapy_bing/ads'

data/lib/tasks/console.rake

@@ -0,0 +1,5 @@
+desc 'Start the IRB console (short-cut alias: "c")'
+task :console do
+  sh 'irb -I .  -I ./lib -I ./spec  -r ./spec/spec_helper.rb'
+end
+task c: :console

data/lib/tasks/coverage.rake

@@ -0,0 +1,6 @@
+desc 'Run specs and collect code coverage'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].invoke
+end
+task cov: :coverage

data/lib/tasks/spec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/soapy_bing.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'soapy_bing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'soapy_bing'
+  spec.version       = SoapyBing::VERSION
+  spec.authors       = ['ad2games GmbH']
+  spec.email         = ['developers@ad2games.com']
+  spec.summary       = 'Simple client for the Bing Ads APIs'
+  spec.description   = "#{spec.summary} (https://developers.bingads.microsoft.com)"
+  spec.homepage      = 'http://ad2games.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'erubis'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'retryable', '>= 2.0.0'
+  spec.add_dependency 'rubyzip', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'dotenv'
+end

data/spec/fixtures/reports/campaign_performance_report.csv

@@ -0,0 +1,37 @@
+"Report Name: MyReport"
+"Report Time: 10/14/2015"
+"Time Zone: Various"
+"Last Completed Available Day: 11/16/2015 2:40:00 AM (GMT)"
+"Last Completed Available Hour: 11/16/2015 2:40:00 AM (GMT)"
+"Report Aggregation: Hour of day"
+"Report Filter: "
+"Potential Incomplete Data: true"
+"Rows: 24"
+
+"HourOfDay","Impressions","Clicks","Spend"
+"0","3793","1599","72.65"
+"1","3560","1429","65.38"
+"2","3177","1275","57.92"
+"3","2194","849","38.68"
+"4","1393","531","24.14"
+"5","765","247","11.07"
+"6","393","141","6.31"
+"7","152","55","2.46"
+"8","86","25","1.12"
+"9","16","6","0.27"
+"10","6","3","0.13"
+"11","6","2","0.09"
+"12","36","18","0.80"
+"13","115","58","2.58"
+"14","754","332","14.89"
+"15","934","434","19.63"
+"16","1177","525","23.63"
+"17","1127","528","23.80"
+"18","1107","509","22.88"
+"19","1281","615","27.77"
+"20","1718","789","35.56"
+"21","2472","1207","54.23"
+"22","3660","1621","73.08"
+"23","3843","1754","79.54"
+
+"©2015 Microsoft Corporation. All rights reserved. "

data/spec/fixtures/reports/campaign_performance_report.json

@@ -0,0 +1,146 @@
+[
+  {
+    "HourOfDay": "0",
+    "Impressions": "3793",
+    "Clicks": "1599",
+    "Spend": "72.65"
+  },
+  {
+    "HourOfDay": "1",
+    "Impressions": "3560",
+    "Clicks": "1429",
+    "Spend": "65.38"
+  },
+  {
+    "HourOfDay": "2",
+    "Impressions": "3177",
+    "Clicks": "1275",
+    "Spend": "57.92"
+  },
+  {
+    "HourOfDay": "3",
+    "Impressions": "2194",
+    "Clicks": "849",
+    "Spend": "38.68"
+  },
+  {
+    "HourOfDay": "4",
+    "Impressions": "1393",
+    "Clicks": "531",
+    "Spend": "24.14"
+  },
+  {
+    "HourOfDay": "5",
+    "Impressions": "765",
+    "Clicks": "247",
+    "Spend": "11.07"
+  },
+  {
+    "HourOfDay": "6",
+    "Impressions": "393",
+    "Clicks": "141",
+    "Spend": "6.31"
+  },
+  {
+    "HourOfDay": "7",
+    "Impressions": "152",
+    "Clicks": "55",
+    "Spend": "2.46"
+  },
+  {
+    "HourOfDay": "8",
+    "Impressions": "86",
+    "Clicks": "25",
+    "Spend": "1.12"
+  },
+  {
+    "HourOfDay": "9",
+    "Impressions": "16",
+    "Clicks": "6",
+    "Spend": "0.27"
+  },
+  {
+    "HourOfDay": "10",
+    "Impressions": "6",
+    "Clicks": "3",
+    "Spend": "0.13"
+  },
+  {
+    "HourOfDay": "11",
+    "Impressions": "6",
+    "Clicks": "2",
+    "Spend": "0.09"
+  },
+  {
+    "HourOfDay": "12",
+    "Impressions": "36",
+    "Clicks": "18",
+    "Spend": "0.80"
+  },
+  {
+    "HourOfDay": "13",
+    "Impressions": "115",
+    "Clicks": "58",
+    "Spend": "2.58"
+  },
+  {
+    "HourOfDay": "14",
+    "Impressions": "754",
+    "Clicks": "332",
+    "Spend": "14.89"
+  },
+  {
+    "HourOfDay": "15",
+    "Impressions": "934",
+    "Clicks": "434",
+    "Spend": "19.63"
+  },
+  {
+    "HourOfDay": "16",
+    "Impressions": "1177",
+    "Clicks": "525",
+    "Spend": "23.63"
+  },
+  {
+    "HourOfDay": "17",
+    "Impressions": "1127",
+    "Clicks": "528",
+    "Spend": "23.80"
+  },
+  {
+    "HourOfDay": "18",
+    "Impressions": "1107",
+    "Clicks": "509",
+    "Spend": "22.88"
+  },
+  {
+    "HourOfDay": "19",
+    "Impressions": "1281",
+    "Clicks": "615",
+    "Spend": "27.77"
+  },
+  {
+    "HourOfDay": "20",
+    "Impressions": "1718",
+    "Clicks": "789",
+    "Spend": "35.56"
+  },
+  {
+    "HourOfDay": "21",
+    "Impressions": "2472",
+    "Clicks": "1207",
+    "Spend": "54.23"
+  },
+  {
+    "HourOfDay": "22",
+    "Impressions": "3660",
+    "Clicks": "1621",
+    "Spend": "73.08"
+  },
+  {
+    "HourOfDay": "23",
+    "Impressions": "3843",
+    "Clicks": "1754",
+    "Spend": "79.54"
+  }
+]

data/spec/fixtures/soap_templates/simple.erb.xml

@@ -0,0 +1,2 @@
+<%= greeting %>, <%= target %>!
+<%= provocation %>

data/spec/fixtures/vcr_cassettes/campaign_performance_report/with_pending_status.yml

@@ -0,0 +1,168 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://login.live.com/oauth20_token.srf
+    body:
+      encoding: UTF-8
+      string: client_id=bing-ads-oauth-client-id&client_secret=bing-ads-oauth-client-secret&grant_type=refresh_token&refresh_token=bing-ads-oauth-refresh-token
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-store
+      Pragma:
+      - no-cache
+      Content-Length:
+      - '1317'
+      Content-Type:
+      - application/json
+      Server:
+      - Microsoft-IIS/8.5
+      X-Content-Type-Options:
+      - nosniff
+      Date:
+      - Fri, 13 Nov 2015 14:23:43 GMT
+      Connection:
+      - close
+    body:
+      encoding: UTF-8
+      string: '{"token_type":"bearer","expires_in":3600,"scope":"bingads.manage","access_token":"bing-ads-oauth-authentication-token","refresh_token":"bing-ads-oauth-refresh-token","user_id":"bing-ads-oauth-user-id"}'
+    http_version: 
+  recorded_at: Fri, 13 Nov 2015 14:23:44 GMT
+- request:
+    method: post
+    uri: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
+                      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+                      xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
+            <env:Header>
+                <tns:CustomerAccountId>bing-ads-account-id</tns:CustomerAccountId>
+                <tns:CustomerId>bing-ads-customer-id</tns:CustomerId>
+                <tns:DeveloperToken>bing-ads-developer-token</tns:DeveloperToken>
+                <tns:AuthenticationToken>bing-ads-oauth-authentication-token</tns:AuthenticationToken>
+            </env:Header>
+            <env:Body>
+                <tns:SubmitGenerateReportRequest>
+                    <tns:ReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" i:type="tns:CampaignPerformanceReportRequest">
+                        <tns:Format>Csv</tns:Format>
+                        <tns:Language>English</tns:Language>
+                        <tns:ReportName>MyReport</tns:ReportName>
+                        <tns:ReturnOnlyCompleteData>false</tns:ReturnOnlyCompleteData>
+                        <tns:Aggregation>HourOfDay</tns:Aggregation>
+                        <tns:Columns>
+                                <tns:CampaignPerformanceReportColumn>TimePeriod</tns:CampaignPerformanceReportColumn>
+                                <tns:CampaignPerformanceReportColumn>Impressions</tns:CampaignPerformanceReportColumn>
+                                <tns:CampaignPerformanceReportColumn>Clicks</tns:CampaignPerformanceReportColumn>
+                                <tns:CampaignPerformanceReportColumn>Spend</tns:CampaignPerformanceReportColumn>
+                        </tns:Columns>
+                        <tns:Scope>
+                            <tns:AccountIds>
+                                <arr:long>bing-ads-account-id</arr:long>
+                            </tns:AccountIds>
+                        </tns:Scope>
+                        <tns:Time>
+                            <tns:CustomDateRangeEnd>
+                                <tns:Day>14</tns:Day>
+                                <tns:Month>10</tns:Month>
+                                <tns:Year>2015</tns:Year>
+                            </tns:CustomDateRangeEnd>
+                            <tns:CustomDateRangeStart>
+                                <tns:Day>14</tns:Day>
+                                <tns:Month>10</tns:Month>
+                                <tns:Year>2015</tns:Year>
+                            </tns:CustomDateRangeStart>
+                        </tns:Time>
+                    </tns:ReportRequest>
+                </tns:SubmitGenerateReportRequest>
+            </env:Body>
+        </env:Envelope>
+    headers:
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Soapaction:
+      - SubmitGenerateReport
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '396'
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/8.0
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Fri, 13 Nov 2015 14:23:44 GMT
+    body:
+      encoding: UTF-8
+      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Header><h:TrackingId
+        xmlns:h="https://bingads.microsoft.com/Reporting/v9">bing-ads-report-tracking-id</h:TrackingId></s:Header><s:Body><SubmitGenerateReportResponse
+        xmlns="https://bingads.microsoft.com/Reporting/v9"><ReportRequestId>bing-ads-report-request-id</ReportRequestId></SubmitGenerateReportResponse></s:Body></s:Envelope>
+    http_version: 
+  recorded_at: Fri, 13 Nov 2015 14:23:45 GMT
+- request:
+    method: post
+    uri: https://reporting.api.bingads.microsoft.com/Api/Advertiser/Reporting/V9/ReportingService.svc
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xmlns:tns="https://bingads.microsoft.com/Reporting/v9"
+                      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
+                      xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
+            <env:Header>
+                <tns:CustomerAccountId>bing-ads-account-id</tns:CustomerAccountId>
+                <tns:CustomerId>bing-ads-customer-id</tns:CustomerId>
+                <tns:DeveloperToken>bing-ads-developer-token</tns:DeveloperToken>
+                <tns:AuthenticationToken>bing-ads-oauth-authentication-token</tns:AuthenticationToken>
+            </env:Header>
+            <env:Body>
+                <tns:PollGenerateReportRequest>
+                    <tns:ReportRequestId xsi:nil="false">bing-ads-report-request-id</tns:ReportRequestId>
+                </tns:PollGenerateReportRequest>
+            </env:Body>
+        </env:Envelope>
+    headers:
+      Content-Type:
+      - text/xml;charset=UTF-8
+      Soapaction:
+      - PollGenerateReport
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Length:
+      - '493'
+      Content-Type:
+      - text/xml; charset=utf-8
+      Server:
+      - Microsoft-IIS/8.0
+      X-Powered-By:
+      - ASP.NET
+      Date:
+      - Fri, 13 Nov 2015 14:23:45 GMT
+    body:
+      encoding: UTF-8
+      string: <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Header><h:TrackingId
+        xmlns:h="https://bingads.microsoft.com/Reporting/v9">bing-ads-report-tracking-id</h:TrackingId></s:Header><s:Body><PollGenerateReportResponse
+        xmlns="https://bingads.microsoft.com/Reporting/v9"><ReportRequestStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><ReportDownloadUrl
+        i:nil="true"/><Status>Pending</Status></ReportRequestStatus></PollGenerateReportResponse></s:Body></s:Envelope>
+    http_version: 
+  recorded_at: Fri, 13 Nov 2015 14:23:46 GMT
+recorded_with: VCR 3.0.0