soapy_bing 0.3.1 → 0.4.0

data/lib/soapy_bing/ads/report.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'soapy_bing/ads/parsers/report_csv_parser'
+
+module SoapyBing
+  class Ads
+    NotCompleted = Class.new(StandardError)
+    StatusFailed = Class.new(StandardError)
+
+    class Report
+      DEFAULT_REPORT_SETTINGS = {
+        format:      'Csv',
+        language:    'English',
+        name:        'MyReport',
+        aggregation: 'Hourly',
+        columns:     %w[TimePeriod CampaignName Impressions Clicks Spend CampaignId]
+      }.freeze
+
+      DEFAULT_POLLING_SETTINGS = {
+        tries: 20,
+        sleep: ->(n) { n < 7 ? 2**n : 120 }
+      }.freeze
+
+      attr_reader :service, :settings, :polling_settings, :status
+
+      def initialize(options)
+        @service = Service.reporting(options.fetch(:service_options))
+        @settings = OpenStruct.new(DEFAULT_REPORT_SETTINGS.merge(options.fetch(:settings, {})))
+        @polling_settings = DEFAULT_POLLING_SETTINGS.merge(options.fetch(:polling_settings, {}))
+      end
+
+      def rows
+        @rows ||= download_and_parse_rows
+      end
+
+      private
+
+      def download_and_parse_rows
+        # https://msdn.microsoft.com/en-us/library/bing-ads-api-migration-guide(v=msads.100).aspx#Report-Download-URL-and-Empty-Reports
+        return [] unless download_url
+        Parsers::ReportCsvParser.new(Helpers::ZipDownloader.new(download_url).read).rows
+      end
+
+      def download_url
+        @download_url ||= begin
+          wait_status_complete
+          status[:report_download_url]
+        end
+      end
+
+      def fetch_status
+        response = service.poll_generate_report(report_request_id: report_request_id)
+        if response[:report_request_status][:status] == 'Error'
+          raise StatusFailed, response[:errors].to_s
+        end
+        @status = response[:report_request_status].slice(:status, :report_download_url)
+      end
+
+      def wait_status_complete
+        Retryable.retryable(polling_settings.merge(on: NotCompleted)) do
+          fetch_status
+          raise NotCompleted if status[:status] != 'Success'
+        end
+      end
+
+      def report_request_id
+        @report_request_id ||= submit_generate_report
+      end
+
+      def submit_generate_report
+        response = service.submit_generate_report do |namespace_identifier|
+          {
+            report_request: {
+              '@xsi:type' => "#{namespace_identifier}:#{request_type}"
+            }.merge(base_message).merge(message)
+          }
+        end
+        response[:report_request_id]
+      end
+
+      def base_message
+        {
+          # https://msdn.microsoft.com/en-us/library/bing-ads-reporting-campaignperformancereportrequest.aspx#Anchor_2
+          format: settings.format,
+          language: settings.language,
+          report_name: settings.name,
+          return_only_completed_data: false
+        }
+      end
+    end
+  end
+end

data/lib/soapy_bing/campaign_management.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SoapyBing
+  class CampaignManagement
+    attr_reader :service
+
+    def initialize(*args)
+      @service = Service.campaign_management(*args)
+    end
+
+    def get_geo_locations # rubocop:disable Style/AccessorMethodName
+      response = service.get_geo_locations_file_url(
+        version: '1.0',
+        language_locale: 'en'
+      )
+      csv = HTTParty.get(response[:file_url]).body
+      header, *body = CSV.parse(csv)
+      body.map { |row| header.zip(row).to_h }
+    end
+  end
+end

data/lib/soapy_bing/country_codes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SoapyBing
+  class CountryCodes
+    YML_FILE_PATH = File.join(__dir__, 'country_codes.yml').freeze
+
+    def initialize
+      @country_codes = YAML.safe_load(File.read(YML_FILE_PATH))
+    end
+
+    def code(id)
+      @country_codes.fetch(id.to_s)
+    end
+  end
+end

data/lib/soapy_bing/country_codes.yml

@@ -0,0 +1,727 @@
+---
+'1': AL
+'2': AQ
+'3': DZ
+'4': AS
+'5': AD
+'6': AO
+'7': AG
+'8': AR
+'9': AU
+'10': AT
+'11': BS
+'12': BD
+'13': BB
+'14': BE
+'15': BM
+'16': BT
+'17': BO
+'18': BW
+'20': BR
+'21': BZ
+'23': SB
+'24': VG
+'25': BN
+'26': BG
+'27': MM
+'28': BI
+'29': BY
+'30': KH
+'31': CM
+'32': CA
+'33': CV
+'34': KY
+'35': CF
+'36': LK
+'37': TD
+'38': CL
+'39': CN
+'40': TW
+'41': CX
+'42': CC
+'43': CO
+'44': YT
+'45': CG
+'46': CD
+'47': CK
+'48': CR
+'49': HR
+'51': CZ
+'52': BJ
+'53': DK
+'54': DM
+'55': DO
+'56': EC
+'57': SV
+'58': GQ
+'59': ET
+'60': ER
+'61': EE
+'62': FO
+'63': FK
+'65': FI
+'66': FR
+'67': GF
+'68': PF
+'69': DJ
+'70': GA
+'71': GM
+'72': DE
+'73': GH
+'74': GI
+'75': KI
+'76': GR
+'77': GL
+'78': GD
+'79': GP
+'80': GU
+'81': GT
+'82': GN
+'83': GY
+'84': HT
+'86': VA
+'87': HN
+'88': HU
+'89': IS
+'90': IN
+'91': ID
+'92': IE
+'93': IT
+'94': CI
+'95': JM
+'96': JP
+'97': KZ
+'98': KE
+'100': KR
+'101': KG
+'102': LA
+'103': LS
+'104': LV
+'105': LR
+'106': LY
+'107': LI
+'108': LT
+'109': LU
+'110': MG
+'111': MW
+'112': MY
+'113': MV
+'114': ML
+'115': MT
+'116': MQ
+'117': MR
+'118': MU
+'119': MX
+'120': MC
+'121': MN
+'122': MD
+'123': MS
+'124': MA
+'125': MZ
+'126': NA
+'127': NR
+'128': NP
+'129': NL
+'130': AN
+'131': AW
+'132': NC
+'133': VU
+'134': NZ
+'135': NI
+'136': NE
+'137': NG
+'138': NF
+'139': 'NO'
+'140': MP
+'141': FM
+'142': MH
+'143': PW
+'144': PK
+'145': PA
+'146': PG
+'147': PY
+'148': PE
+'149': PH
+'150': PN
+'151': PL
+'152': PT
+'153': GW
+'154': PR
+'155': RE
+'156': RU
+'157': RW
+'158': AI
+'159': SM
+'160': ST
+'161': SN
+'162': SC
+'163': SL
+'164': SG
+'165': SK
+'166': VN
+'167': SI
+'168': ZA
+'169': ZW
+'170': ES
+'172': SR
+'173': SZ
+'174': SE
+'175': CH
+'176': TJ
+'177': TH
+'178': TG
+'179': TK
+'180': TO
+'181': TT
+'182': TR
+'183': TM
+'184': TC
+'185': UG
+'186': MK
+'187': EG
+'188': GB
+'189': TZ
+'190': US
+'191': BF
+'192': UY
+'193': UZ
+'194': WF
+'195': WS
+'196': ZM
+'198': BA
+'199': FJ
+'200': HK
+'201': MO
+'202': VE
+'203': AZ
+'204': BH
+'205': AM
+'206': CY
+'208': GE
+'210': IL
+'211': JO
+'212': KW
+'213': LB
+'214': OM
+'215': QA
+'216': SA
+'218': AE
+'219': YE
+'220': PS
+'221': AF
+'222': TL
+'223': NU
+'224': RO
+'225': SO
+'226': KM
+'227': TN
+'228': IQ
+'229': SH
+'230': KN
+'231': LC
+'232': PM
+'233': VC
+'234': TV
+'235': UA
+'237': VI
+'4993': RS
+'4994': ME
+'4054': AU-WA
+'4053': AU-VI
+'4049': AU-NT
+'4141': AU-CT
+'4052': AU-TS
+'4050': AU-QL
+'4048': AU-NS
+'4051': AU-SA
+'4065': CA-SK
+'4059': CA-NS
+'4062': CA-ON
+'4058': CA-NB
+'4061': CA-NU
+'4066': CA-YT
+'4064': CA-QC
+'4057': CA-MB
+'4060': CA-NT
+'4056': CA-BC
+'4055': CA-AB
+'4140': CA-NL
+'4063': CA-PE
+'3319': CH-VD
+'3304': CH-GE
+'3313': CH-SH
+'474': AT-9
+'468': AT-3
+'3310': CH-NW
+'3311': CH-OW
+'471': AT-6
+'472': AT-7
+'3302': CH-BS
+'3320': CH-VS
+'3307': CH-JU
+'3303': CH-FR
+'3316': CH-TG
+'3305': CH-GL
+'469': AT-4
+'470': AT-5
+'3297': CH-AG
+'3300': CH-BE
+'3299': CH-AR
+'466': AT-1
+'467': AT-2
+'3308': CH-LU
+'3314': CH-SO
+'3322': CH-ZH
+'3306': CH-GR
+'3317': CH-TI
+'3312': CH-SG
+'473': AT-8
+'615': BE-VWV
+'3315': CH-SZ
+'3301': CH-BL
+'616': BE-WAL
+'610': BE-VAN
+'3318': CH-UR
+'3321': CH-ZG
+'619': BE-WLG
+'621': BE-WNA
+'3298': CH-AI
+'3309': CH-NE
+'1417': DE-TH
+'1406': DE-HB
+'1403': DE-BE
+'1411': DE-NW
+'1414': DE-SL
+'1408': DE-HH
+'1409': DE-MV
+'1410': DE-NI
+'1402': DE-BB
+'1412': DE-RP
+'1405': DE-BY
+'1413': DE-SH
+'1416': DE-ST
+'1407': DE-HE
+'1404': DE-BW
+'1415': DE-SN
+'71113': DK-082
+'71114': DK-083
+'71112': DK-084
+'1054': DK-080
+'71115': DK-085
+'612': BE-VLG
+'613': BE-VLI
+'3229': ES-TO
+'3186': ES-CS
+'3169': ES-AL
+'3178': ES-CA
+'614': BE-VOV
+'620': BE-WLX
+'3226': ES-T
+'3234': ES-Z
+'609': BE-BRU
+'611': BE-VBR
+'3212': ES-O
+'3191': ES-GC
+'617': BE-WBR
+'618': BE-WHT
+'3231': ES-VA
+'3223': ES-SG
+'3195': ES-H
+'3235': ES-ZA
+'675': BR-MT
+'683': BR-RO
+'3206': ES-ML
+'3172': ES-AV
+'666': BR-AP
+'668': BR-CE
+'665': BR-AM
+'685': BR-RS
+'3215': ES-PM
+'3175': ES-BI
+'3192': ES-GE
+'3198': ES-L
+'674': BR-MS
+'682': BR-RN
+'3168': ES-AB
+'3220': ES-S
+'3196': ES-HU
+'3177': ES-C
+'3194': ES-GU
+'3176': ES-BU
+'671': BR-GO
+'684': BR-RR
+'3202': ES-LU
+'3185': ES-CR
+'3179': ES-CC
+'3201': ES-LO
+'3193': ES-GR
+'3221': ES-SA
+'3184': ES-CO
+'3227': ES-TE
+'688': BR-SP
+'669': BR-DF
+'3228': ES-TF
+'3210': ES-NA
+'3167': ES-A
+'3173': ES-B
+'680': BR-PR
+'663': BR-AC
+'3213': ES-OR
+'3224': ES-SO
+'686': BR-SC
+'677': BR-PB
+'3203': ES-M
+'3230': ES-V
+'3233': ES-VI
+'3205': ES-MA
+'689': BR-TO
+'679': BR-PI
+'3199': ES-LE
+'3217': ES-PO
+'681': BR-RJ
+'678': BR-PE
+'3197': ES-J
+'3180': ES-CE
+'672': BR-MA
+'664': BR-AL
+'3214': ES-P
+'3174': ES-BA
+'687': BR-SE
+'670': BR-ES
+'3188': ES-CU
+'3222': ES-SE
+'673': BR-MG
+'676': BR-PA
+'3208': ES-MU
+'3225': ES-SS
+'667': BR-BA
+'902': CN-54
+'899': CN-51
+'890': CN-36
+'885': CN-31
+'882': CN-21
+'2578': NO-11
+'2581': NO-15
+'879': CN-13
+'905': CN-63
+'2579': NO-12
+'2572': NO-05
+'888': CN-34
+'896': CN-45
+'2573': NO-06
+'2570': NO-03
+'893': CN-42
+'901': CN-53
+'2580': NO-14
+'2569': NO-02
+'887': CN-33
+'904': CN-62
+'881': CN-15
+'878': CN-12
+'2577': NO-10
+'2583': NO-17
+'2586': NO-20
+'2584': NO-18
+'2575': NO-08
+'2571': NO-04
+'889': CN-35
+'886': CN-32
+'2582': NO-16
+'2574': NO-07
+'897': CN-46
+'895': CN-44
+'2576': NO-09
+'2568': NO-01
+'2585': NO-19
+'2499': NZ-HKB
+'2508': NZ-TAS
+'2505': NZ-OTA
+'2511': NZ-WKO
+'2510': NZ-WGN
+'2509': NZ-TKI
+'2501': NZ-MWT
+'2500': NZ-MBH
+'2497': NZ-CAN
+'903': CN-61
+'884': CN-23
+'2495': NZ-AUK
+'2498': NZ-GIS
+'2507': NZ-STL
+'2503': NZ-NSN
+'898': CN-50
+'906': CN-64
+'2504': NZ-NTL
+'2496': NZ-BOP
+'880': CN-14
+'894': CN-43
+'2512': NZ-WTC
+'3291': SE-T
+'3280': SE-D
+'3283': SE-G
+'877': CN-11
+'900': CN-52
+'3290': SE-S
+'3294': SE-X
+'891': CN-37
+'883': CN-22
+'3282': SE-F
+'3284': SE-H
+'3296': SE-Z
+'3293': SE-W
+'892': CN-41
+'907': CN-65
+'3276': SE-AB
+'3287': SE-M
+'3286': SE-K
+'3285': SE-I
+'1285': FR-L
+'1301': FR-V
+'3288': SE-N
+'3279': SE-C
+'3278': SE-BD
+'3292': SE-U
+'3289': SE-O
+'3277': SE-AC
+'3295': SE-Y
+'3281': SE-E
+'4108': US-MT
+'4105': US-MO
+'4122': US-RI
+'4114': US-NM
+'4079': US-AK
+'4113': US-NJ
+'1293': FR-PM
+'4116': US-NY
+'4134': US-WV
+'1284': FR-K
+'1275': FR-D
+'4085': US-CO
+'4111': US-NE
+'4094': US-ID
+'4128': US-UT
+'4088': US-DE
+'4131': US-VT
+'1292': FR-PF
+'1286': FR-M
+'4093': US-IA
+'4102': US-ME
+'4125': US-TN
+'4098': US-KY
+'1278': FR-G
+'1295': FR-R
+'4095': US-IL
+'4112': US-NH
+'1272': FR-A
+'1298': FR-T
+'4104': US-MN
+'4096': US-IN
+'4107': US-MS
+'4081': US-AR
+'4132': US-WA
+'4097': US-KS
+'1276': FR-E
+'1289': FR-NC
+'4123': US-SC
+'4129': US-VA
+'1282': FR-I
+'1290': FR-O
+'4103': US-MI
+'4080': US-AL
+'4115': US-NV
+'4120': US-PA
+'4089': US-FL
+'4092': US-HI
+'1273': FR-B
+'1287': FR-MQ
+'4086': US-CT
+'4100': US-MA
+'1281': FR-H
+'1299': FR-TF
+'4117': US-OH
+'4087': US-DC
+'4090': US-GA
+'4126': US-TX
+'4083': US-AZ
+'4109': US-NC
+'1274': FR-C
+'1279': FR-GF
+'4110': US-ND
+'4119': US-OR
+'1296': FR-RE
+'1288': FR-N
+'4133': US-WI
+'4099': US-LA
+'4135': US-WY
+'4084': US-CA
+'1302': FR-WF
+'1297': FR-S
+'4101': US-MD
+'4124': US-SD
+'1280': FR-GP
+'1291': FR-P
+'1294': FR-Q
+'1283': FR-J
+'1277': FR-F
+'1300': FR-U
+'1303': FR-YT
+'4139': GB-WLS
+'4078': GB-SCT
+'4077': GB-NIR
+'4076': GB-ENG
+'1677': IN-WB
+'1654': IN-DN
+'71109': IN-JH
+'4118': US-OK
+'1659': IN-JK
+'1668': IN-NL
+'1676': IN-UP
+'71111': IN-CG
+'1662': IN-LD
+'71110': IN-UK
+'1670': IN-PB
+'1661': IN-KL
+'1653': IN-DL
+'1648': IN-AR
+'1656': IN-GJ
+'1665': IN-MN
+'1673': IN-SK
+'1650': IN-BR
+'1647': IN-AP
+'1667': IN-MZ
+'1664': IN-ML
+'1657': IN-HP
+'1674': IN-TN
+'1658': IN-HR
+'1655': IN-GA
+'1663': IN-MH
+'1672': IN-RJ
+'1649': IN-AS
+'1675': IN-TR
+'1666': IN-MP
+'1660': IN-KA
+'1651': IN-CH
+'1671': IN-PY
+'1669': IN-OR
+'1652': IN-DD
+'1887': IT-RI
+'1904': IT-TS
+'1878': IT-PR
+'1818': IT-AR
+'1844': IT-FI
+'1886': IT-RG
+'71333': IT-MB
+'1861': IT-MI
+'1895': IT-SR
+'1812': IT-AG
+'1821': IT-BA
+'1855': IT-LI
+'1835': IT-CN
+'1838': IT-CS
+'1863': IT-MO
+'1843': IT-FG
+'1826': IT-BO
+'1852': IT-KR
+'1829': IT-BZ
+'1898': IT-TA
+'1875': IT-PI
+'1881': IT-PV
+'1832': IT-CE
+'1841': IT-EN
+'1907': IT-VA
+'1815': IT-AO
+'1864': IT-MS
+'1824': IT-BL
+'1884': IT-RC
+'1901': IT-TO
+'1858': IT-LU
+'71329': IT-BT
+'1889': IT-RN
+'1909': IT-VC
+'1823': IT-BI
+'1866': IT-NA
+'1867': IT-NO
+'71330': IT-CI
+'1840': IT-CZ
+'1883': IT-RA
+'1906': IT-UD
+'1817': IT-AQ
+'1872': IT-PD
+'1849': IT-GR
+'71332': IT-VS
+'1856': IT-LO
+'1890': IT-RO
+'1859': IT-MC
+'1833': IT-CH
+'1847': IT-GE
+'1799': IT-45
+'1839': IT-CT
+'1882': IT-PZ
+'1831': IT-CB
+'1816': IT-AP
+'1899': IT-TE
+'1846': IT-FR
+'1850': IT-IM
+'1873': IT-PE
+'1880': IT-PT
+'1837': IT-CR
+'1860': IT-ME
+'1865': IT-MT
+'1891': IT-SA
+'71331': IT-FM
+'1842': IT-FE
+'1908': IT-VB
+'1834': IT-CL
+'1857': IT-LT
+'1848': IT-GO
+'1825': IT-BN
+'1874': IT-PG
+'1897': IT-SV
+'1914': IT-VV
+'1814': IT-AN
+'1822': IT-BG
+'1900': IT-TN
+'1892': IT-SI
+'1876': IT-PN
+'1853': IT-LC
+'1896': IT-SS
+'1827': IT-BR
+'1813': IT-AL
+'1902': IT-TP
+'1910': IT-VE
+'1819': IT-AT
+'1870': IT-PA
+'1877': IT-PO
+'1854': IT-LE
+'1913': IT-VT
+'1862': IT-MN
+'1836': IT-CO
+'1879': IT-PS
+'1830': IT-CA
+'1893': IT-SO
+'1885': IT-RE
+'1888': IT-RM
+'1868': IT-NU
+'1828': IT-BS
+'1911': IT-VI
+'1871': IT-PC
+'1851': IT-IS
+'1894': IT-SP
+'71334': IT-OG
+'1905': IT-TV
+'1912': IT-VR
+'1903': IT-TR
+'1869': IT-OR
+'1820': IT-AV
+'71335': IT-OT
+'2487': NL-ZE
+'2478': NL-FL
+'2481': NL-GR
+'2486': NL-UT
+'2480': NL-GE
+'2483': NL-NB
+'2477': NL-DR
+'2484': NL-NH
+'2482': NL-LI
+'2485': NL-OV
+'2488': NL-ZH
+'2479': NL-FR