adzerk 0.12 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f22414a06756a78f2e6d8ee07568be6e99ba7a91
-  data.tar.gz: 1674c74ef8ce38b9e307eb51897c18c396eccea6
+SHA256:
+  metadata.gz: 81c206b72f16aa47a2968e4f6fcc1143bd44d8ead4585e8c65e70e14a1b2541f
+  data.tar.gz: a61cfe82cbd4fe8a2899307fbc4844da2ae974257891e97b9c7336427c3d3989
 SHA512:
-  metadata.gz: b959885a659a94db14a5ea8e520314cc18f20bada0c7f1d005e05b974c35aeb963df396d190ea648509ddcbfc951532eaa2d56743ca15e40b806b5bf16286d5d
-  data.tar.gz: a65125e6343526b18933b7fe547a59118305472f486d73edc13643a7cb35ffab5eb1ba3c9a0e6a8d34ac1cf94a0acdd2561d5be8741f64da40b953a9f29d9717
+  metadata.gz: 44611cee6e3f78945dae45e86f286cbfb964c603933587191798df9c9b810bfd214c7b110edae97ff46968fca5ee74d0a7ef8dee87ccaca0ef47ef01672b7e6f
+  data.tar.gz: 0fab0586f87c62820036ef226b2c27bf2ee8c9a7ca38075ba17429c8269bed5e9e2e51649fcc3c722e968416006454533a6e5b44ea55b8ac67f35d8e9616df0b

data/lib/adzerk.rb

@@ -13,8 +13,14 @@ require "adzerk/publisher"
 require "adzerk/invitation"
 require "adzerk/reporting"
 require "adzerk/channel_site_map"
+require "adzerk/channel"
 require "adzerk/geo_targeting"
 require "adzerk/site_zone_targeting"
 require "adzerk/category"
 require "adzerk/client"
 require "adzerk/priority"
+require "adzerk/campaign"
+require "adzerk/instant_count"
+require "adzerk/creative_template"
+require "adzerk/scheduled_reporting"
+require "adzerk/day_parting"

data/lib/adzerk/advertiser.rb

@@ -5,5 +5,16 @@ module Adzerk
       data = { 'advertiserName' => advertiser_name }
       parse_response(client.post_request(url, data))
     end
+
+    def instant_counts(advertiser_id, data={})
+      query_string = URI.encode_www_form(data)
+      url = "instantcounts/#{endpoint}/#{advertiser_id}?#{query_string}"
+      parse_response(client.get_request(url))
+    end
+
+    def list_creatives(advertiser_id, page: 1, pageSize: 500)
+      url = "advertiser/#{advertiser_id}/creatives?page=#{page}&pageSize=#{pageSize}"
+      parse_response(@client.get_request(url))
+    end
   end
 end

data/lib/adzerk/api_endpoint.rb

@@ -14,8 +14,8 @@ module Adzerk
 
     def create(opts={}, subid=nil)
       e = (subid && subendpoint) ? "#{subendpoint}/#{subid}/#{endpoint}" : endpoint
-      data = { datakey => camelize_data(opts).to_json }
-      response = @client.post_request(e, data)
+      data = camelize_data(opts)
+      response = @client.post_json_request(e, data)
       parse_response(response)
     end
 
@@ -24,16 +24,17 @@ module Adzerk
       parse_response(response)
     end
 
-    def list(subid=nil)
+    def list(subid=nil, page: 1, pageSize: 500)
       e = (subid && subendpoint) ? "#{subendpoint}/#{subid}/#{endpoint}" : endpoint
+      e = "#{e}?page=#{page}&pageSize=#{pageSize}"
       response = @client.get_request(e)
       parse_response(response)
     end
 
     def update(opts={})
       id = opts[:id].to_s
-      data = { datakey => camelize_data(opts).to_json }
-      response = @client.put_request("#{endpoint}/#{id}", data)
+      data = camelize_data(opts)
+      response = @client.put_json_request("#{endpoint}/#{id}", data)
       parse_response(response)
     end
 

data/lib/adzerk/campaign.rb

@@ -0,0 +1,15 @@
+module Adzerk
+  class Campaign < ApiEndpoint
+    def instant_counts(campaign_id, data={})
+      query_string = URI.encode_www_form(data)
+      url = "instantcounts/#{endpoint}/#{campaign_id}?#{query_string}"
+      parse_response(client.get_request(url))
+    end
+
+    def search(campaign_name)
+      url = 'campaign/search'
+      data = { 'campaignName' => campaign_name }
+      parse_response(client.post_request(url, data))
+    end
+  end
+end

data/lib/adzerk/category.rb

@@ -20,13 +20,13 @@ module Adzerk
       @client.get_request(url)
     end
 
-    def listAll
+    def listAll(page: 1, pageSize: 500)
       response = client.get_request('categories')
       parse_response(response)
     end
 
-    def list(flight_id)
-      url = "flight/#{flight_id}/categories"
+    def list(flight_id, page: 1, pageSize: 500)
+      url = "flight/#{flight_id}/categories?page=#{page}&pageSize=#{pageSize}"
       response = client.get_request(url)
       parse_response(response)
     end

data/lib/adzerk/channel.rb

@@ -0,0 +1,9 @@
+module Adzerk
+    class Channel < ApiEndpoint
+        def get_priorities(channel_id)
+            url = "channel/#{channel_id}/priorities"
+            response = client.get_request(url)
+            parse_response(response)
+        end
+    end
+end

data/lib/adzerk/channel_site_map.rb

@@ -21,7 +21,7 @@ module Adzerk
       response = parse_response(response)
     end
 
-    def list
+    def list(page: 1, pageSize: 500)
       response = client.get_request('channelSite')
       parse_response(response)
     end

data/lib/adzerk/client.rb

@@ -6,11 +6,21 @@ module Adzerk
     attr_reader :sites, :ad_types, :zones, :campaigns, :channels, :priorities,
                 :advertisers, :flights, :creatives, :creative_maps,
                 :publishers, :invitations, :reports, :channel_site_maps,
-                :logins, :geotargetings, :sitezonetargetings, :categories
+                :logins, :geotargetings, :sitezonetargetings, :categories,
+                :instant_counts, :ads, :creative_templates, :scheduled_reports, 
+                :day_parts
+
+    VERSION = Gem.loaded_specs['adzerk'].version.to_s
+    SDK_HEADER_NAME = 'X-Adzerk-Sdk-Version'
+    SDK_HEADER_VALUE = "adzerk-management-sdk-ruby:#{VERSION}"
+    BASE_SLEEP = 0.25
+    MAX_SLEEP = 5
+    MAX_ATTEMPTS = 10
 
     DEFAULTS = {
-      :host => ENV["ADZERK_API_HOST"] || 'https://api.adzerk.net/v1/',
-      :header => 'X-Adzerk-ApiKey'
+      :host => ENV["ADZERK_API_HOST"] || 'https://api.adzerk.net/',
+      :header => 'X-Adzerk-ApiKey',
+      :include_creative_templates => true
     }
 
     def initialize(key, opts = {})
@@ -19,74 +29,129 @@ module Adzerk
       @logins = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'login')
       @sites = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'site')
       @ad_types = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'adtypes', :subendpoint => 'channel', :datakey => 'adtype')
-      @flights = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'flight')
+      @flights = Adzerk::Flight.new(:client => self, :endpoint => 'flight')
       @zones = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'zone')
-      @campaigns = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'campaign')
-      @channels = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'channel')
+      @campaigns = Adzerk::Campaign.new(:client => self, :endpoint => 'campaign')
+      @channels = Adzerk::Channel.new(:client => self, :endpoint => 'channel')
       @priorities = Adzerk::Priority.new(:client => self, :endpoint => 'priority')
       @advertisers = Adzerk::Advertiser.new(:client => self, :endpoint => 'advertiser')
       @publishers = Adzerk::Publisher.new(:client => self, :endpoint => 'publisher')
       @creatives = Adzerk::Creative.new(:client => self, :endpoint => 'creative')
       @creative_maps = Adzerk::CreativeMap.new(:client => self)
+      @ads = @creative_maps
       @invitations = Adzerk::Invitation.new(:client => self)
       @reports = Adzerk::Reporting.new(:client => self)
       @channel_site_maps = Adzerk::ChannelSiteMap.new(:client => self)
       @geotargetings = Adzerk::GeoTargeting.new(:client => self, :endpoint => 'geotargeting')
       @sitezonetargetings = Adzerk::SiteZoneTargeting.new(:client => self, :endpoint => 'sitezone')
       @categories = Adzerk::Category.new(:client => self, :endpoint => 'category')
-
+      @instant_counts = Adzerk::InstantCount.new(:client => self)
+      @creative_templates = Adzerk::CreativeTemplate.new(:client => self)
+      @scheduled_reports = Adzerk::ScheduledReporting.new(:client => self, :endpoint => 'report')
+      @day_parts = Adzerk::DayParting.new(:client => self, :endpoint => 'dayparting')
     end
 
-    def get_request(url)
-      uri = URI.parse(@config[:host] + url)
+    def get_request(url, version: 'v1')
+      uri = URI.parse("#{@config[:host]}#{version}/#{url}")
       request = Net::HTTP::Get.new(uri.request_uri)
       request.add_field(@config[:header], @api_key)
+      request.add_field(SDK_HEADER_NAME, SDK_HEADER_VALUE)
       send_request(request, uri)
     end
 
-    def post_request(url, data)
-      uri = URI.parse(@config[:host] + url)
+    def post_request(url, data, version: 'v1')
+      uri = URI.parse("#{@config[:host]}#{version}/#{url}")
       request = Net::HTTP::Post.new(uri.request_uri)
       request.add_field(@config[:header], @api_key)
+      request.add_field(SDK_HEADER_NAME, SDK_HEADER_VALUE)
       request.set_form_data(data)
       send_request(request, uri)
     end
 
-    def put_request(url, data)
-      uri = URI.parse(@config[:host] + url)
+    def post_json_request(url, data, version: 'v1')
+      uri = URI.parse("#{@config[:host]}#{version}/#{url}")
+      request = Net::HTTP::Post.new(uri.request_uri, 'Content-Type' => 'application/json')
+      request.add_field(@config[:header], @api_key)
+      request.add_field(SDK_HEADER_NAME, SDK_HEADER_VALUE)
+      request.body = data.to_json
+      send_request(request, uri)
+    end
+
+    def put_request(url, data, version: 'v1')
+      uri = URI.parse("#{@config[:host]}#{version}/#{url}")
       request = Net::HTTP::Put.new(uri.request_uri)
       request.add_field(@config[:header], @api_key)
+      request.add_field(SDK_HEADER_NAME, SDK_HEADER_VALUE)
       request.set_form_data(data)
       send_request(request, uri)
     end
 
-    def create_creative(data={}, image_path='')
-      response = RestClient.post(@config[:host] + 'creative',
-                                 {:creative => camelize_data(data).to_json},
-                                  :X_Adzerk_ApiKey => @api_key,
-                                  :accept => :json)
+    def put_json_request(url, data, version: 'v1')
+      uri = URI.parse("#{@config[:host]}#{version}/#{url}")
+      request = Net::HTTP::Put.new(uri.request_uri, 'Content-Type' => 'application/json')
+      request.add_field(@config[:header], @api_key)
+      request.add_field(SDK_HEADER_NAME, SDK_HEADER_VALUE)
+      request.body = data.to_json
+      send_request(request, uri)
+    end
+
+    def create_creative(data={}, image_path='', version: 'v1')
+      response = nil
+      attempt = 0
+
+      loop do
+        response = RestClient.post(@config[:host] + version + '/creative',
+                                  {:creative => camelize_data(data).to_json},
+                                    :X_Adzerk_ApiKey => @api_key,
+                                    :X_Adzerk_Sdk_Version => SDK_HEADER_VALUE,
+                                    :accept => :json)
+        break if response.code != 429 or attempt >= (@config[:max_attempts] || MAX_ATTEMPTS)
+        sleep(rand(0.0..[MAX_SLEEP, BASE_SLEEP * 2 ** attempt].min()))
+        attempt += 1
+      end
       response = upload_creative(JSON.parse(response)["Id"], image_path) unless image_path.empty?
       response
     end
 
-    def upload_creative(id, image_path, size_override: false)
+    def upload_creative(id, image_path, size_override: false, version: 'v1')
+      response = nil
+      attempt = 0
       image = File.new(image_path, 'rb')
-      url = @config[:host] + 'creative/' + id.to_s + '/upload'
+      url = @config[:host] + version + '/creative/' + id.to_s + '/upload'
       url += '?sizeOverride=true' if size_override
-      RestClient.post(url,
-      {:image => image},
-      "X-Adzerk-ApiKey" => @api_key,
-      :accept => :mime)
+      loop do
+        response = RestClient.post(url,
+        {:image => image},
+        "X-Adzerk-ApiKey" => @api_key,
+        SDK_HEADER_NAME => SDK_HEADER_VALUE,
+        :accept => :mime)
+
+        break if response.code != 429 or attempt >= (@config[:max_attempts] || MAX_ATTEMPTS)
+        sleep(rand(0.0..[MAX_SLEEP, BASE_SLEEP * 2 ** attempt].min()))
+        attempt += 1
+      end
+      response
     end
 
     def send_request(request, uri)
+      response = nil
+      attempt = 0
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = uri.scheme == 'https'
-      response = http.request(request)
-      if response.kind_of? Net::HTTPClientError
+
+      loop do
+        response = http.request(request)
+        break if response.code != "429" or attempt >= (@config[:max_attempts] || MAX_ATTEMPTS)
+        sleep(rand(0.0..[MAX_SLEEP, BASE_SLEEP * 2 ** attempt].min()))
+        attempt += 1
+      end
+
+      if response.kind_of? Net::HTTPClientError or response.kind_of? Net::HTTPServerError
         error_response = JSON.parse(response.body)
-        raise Adzerk::ApiError.new(error_response["message"])
+        msg = error_response["message"] || error_response["Error"] || response.body
+        raise Adzerk::ApiError.new(msg)
       end
+
       response
     end
 

data/lib/adzerk/creative.rb

@@ -8,8 +8,8 @@ module Adzerk
       uncamelize_data(JSON.parse(response))
     end
 
-    def list(advertiserId)
-      url = 'advertiser/' + advertiserId.to_s + "/creatives"
+    def list(advertiserId, page: 1, pageSize: 500)
+      url = "advertiser/#{advertiserId}/creatives?page=#{page}&pageSize=#{pageSize}"
       parse_response(@client.get_request(url))
     end
 

data/lib/adzerk/creative_map.rb

@@ -18,8 +18,8 @@ module Adzerk
       parse_response(@client.get_request(url))
     end
 
-    def list(flight_id)
-      url = "flight/#{flight_id}/creatives"
+    def list(flight_id, page: 1, pageSize: 500)
+      url = "flight/#{flight_id}/creatives?page=#{page}&#pageSize=#{pageSize}"
       parse_response(@client.get_request(url))
     end
 
@@ -34,5 +34,10 @@ module Adzerk
       @client.get_request(url)
     end
 
+    def instant_counts(creative_map_id, data={})
+      query_string = URI.encode_www_form(data)
+      url = "instantcounts/ad/#{creative_map_id}?#{query_string}"
+      parse_response(@client.get_request(url))
+    end
   end
 end

data/lib/adzerk/creative_template.rb

@@ -0,0 +1,30 @@
+module Adzerk
+  class CreativeTemplate
+
+    include Adzerk::Util
+
+    attr_reader :client
+
+    def initialize(args={})
+      @client = args[:client]
+    end
+
+    def create(data={})
+      parse_response(@client.post_json_request("creative-templates", camelize_data(data), version: 'v2'))
+    end
+
+    def update(id, data={})
+      url = "creative-templates/#{id}/update"
+      parse_response(@client.post_json_request(url, camelize_data(data), version: 'v2'))
+    end
+
+    def get(id)
+      parse_response(@client.get_request("creative-templates/#{id}", version: 'v2'))
+    end
+
+    def list(page: 1, pageSize: 100)
+      url = "creative-templates?page=#{page}&pageSize=#{pageSize}"
+      parse_response(@client.get_request(url, version: 'v2'))
+    end
+  end
+end

data/lib/adzerk/day_parting.rb

@@ -0,0 +1,23 @@
+module Adzerk
+    class DayParting < ApiEndpoint
+        def create(flight_id, data={})
+            url = "flight/#{flight_id}/dayparting"
+            parse_response(@client.post_json_request(url, camelize_data(data)))
+        end
+
+        def get(flight_id, timepart_id)
+            url = "flight/#{flight_id}/dayparting/#{timepart_id}"
+            parse_response(@client.get_request(url))
+        end
+
+        def list(flight_id)
+            url = "flight/#{flight_id}/dayparting"
+            parse_response(@client.get_request(url))
+        end
+
+        def delete(flight_id, timepart_id)
+            url = "flight/#{flight_id}/dayparting/#{timepart_id}/delete"
+            @client.post_request(url, data={})
+        end
+    end
+end

data/lib/adzerk/flight.rb

@@ -1,12 +1,34 @@
 module Adzerk
   class Flight < ApiEndpoint
     def countries
-      parse_response(@client.get_request('countries'))
+      response = @client.get_request('countries')
+      parse_response(response)
     end
 
     def regions(region)
-      url = 'region/' + region
-      parse_reponse(@client.get_request(url))
+      url = "region/#{region}"
+      response = @client.get_request(url)
+      parse_response(response)
+    end
+
+    def list_regions_for_country(country_code)
+      url = "country/#{country_code}/regions?version=2"
+      response = @client.get_request(url)
+      parse_response(response)
+    end
+
+    def instant_counts(flight_id, data={})
+      query_string = URI.encode_www_form(data)
+      url = "instantcounts/#{endpoint}/#{flight_id}?#{query_string}"
+      parse_response(client.get_request(url))
+    end
+
+    def list_for_campaign(campaign_id, is_active = nil)
+      url = "campaign/#{campaign_id}/flight"
+      if !is_active.nil?
+        url = "#{url}?isActive=#{is_active}"
+      end
+      parse_response(@client.get_request(url))
     end
   end
 end