adzerk 0.14 → 0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfcb33e06a66b4728d0a27e69c41a240a3d3f73ce3af93056fdbb794e6b1361c
-  data.tar.gz: d6b9c3113f6120d074a517643a56fb4cb1fc2b98b98abe016cb31cbebcadad32
+  metadata.gz: b08fcf724937ddb370874ccdf50506ca1f6e16be79cde06dc8777d1e1d99bfd6
+  data.tar.gz: 28776f7247b58b93c4590fa1689737288a738240403e0d0af18bebd381f9b97d
 SHA512:
-  metadata.gz: f549e8160c19e563cdb4aa4c54b085a833b62b6588227c2540f7e58471805ed88f79680f3d3a32c125639e98a7502b55fe9dee2b4736c560322a10ef5aa5aa61
-  data.tar.gz: 2be8a73fb39675f73bd02e13ddd6165f2402005b561b03ab94cf546fd4702c8fcf5105b1240cd7b0a8b71dcb214064764e6d7ce249bee12f2e87d7947533ceaa
+  metadata.gz: 4763be769dac520c65beb9e7e6049089633635a75fc20f9480428d1b286cbeaa2bd543d5a16e4ae4d4a40c5674ae3e6963e2f2d5f5141ab574686829d8511630
+  data.tar.gz: 5e6e08ec68228782bf1acdecc0c035ac66567f0886adcbde45ba77e03a073321d375287b1e4e316aee2a6d65ba7cb20c4812d1a4597567ae0eeb8a6dbc783090

data/lib/adzerk.rb

@@ -18,3 +18,6 @@ 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"

data/lib/adzerk/advertiser.rb

@@ -5,5 +5,15 @@ module Adzerk
       data = { 'advertiserName' => advertiser_name }
       parse_response(client.post_request(url, data))
     end
+
+    def instant_counts(advertiser_id)
+      url = "instantcounts/#{endpoint}/#{advertiser_id}?page=#{page}&pageSize=#{pageSize}"
+      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,8 @@
+module Adzerk
+  class Campaign < ApiEndpoint
+    def instant_counts(campaign_id)
+      url = "instantcounts/#{endpoint}/#{campaign_id}"
+      parse_response(client.get_request(url))
+    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_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,17 @@ 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
+
+    VERSION = Gem.loaded_specs['adzerk'].version.to_s
+    SDK_HEADER_NAME = 'X-Adzerk-Sdk-Version'
+    SDK_HEADER_VALUE = "adzerk-management-sdk-ruby:#{VERSION}"
 
     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,63 +25,88 @@ 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')
+      @campaigns = Adzerk::Campaign.new(:client => self, :endpoint => 'campaign')
       @channels = Adzerk::ApiEndpoint.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)
     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',
+    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 = 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)
       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')
       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,
+      SDK_HEADER_NAME => SDK_HEADER_VALUE,
       :accept => :mime)
     end
 
@@ -85,7 +116,7 @@ module Adzerk
       response = http.request(request)
       if response.kind_of? Net::HTTPClientError or response.kind_of? Net::HTTPServerError
         error_response = JSON.parse(response.body)
-        msg = error_response["message"] || error_response["Error"]
+        msg = error_response["message"] || error_response["Error"] || response.body
         raise Adzerk::ApiError.new(msg)
       end
       response

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)
+      url = "instantcounts/#{endpoint}/#{creative_map_id}"
+      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/flight.rb

@@ -8,5 +8,18 @@ module Adzerk
       url = 'region/' + region
       parse_reponse(@client.get_request(url))
     end
+
+    def instant_counts(flight_id)
+      url = "instantcounts/#{endpoint}/#{flight_id}"
+      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

data/lib/adzerk/instant_count.rb

@@ -0,0 +1,15 @@
+module Adzerk
+  class InstantCount
+    include Adzerk::Util
+
+    def initialize(args={})
+      @client = args[:client]
+    end
+
+    def bulk(data={})
+      url = "instantcounts/bulk"
+      response = @client.post_json_request(url, data)
+      parse_response(response)
+    end
+  end
+end

data/lib/adzerk/publisher.rb

@@ -13,5 +13,19 @@ module Adzerk
       parse_response(response)
     end
 
+    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)
+      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)
+      parse_response(response)
+    end
+
   end
 end

data/lib/adzerk/util.rb

@@ -1,6 +1,6 @@
 module Adzerk
   module Util
-    extend self 
+    extend self
 
     def camelize_data(data)
       return data unless data.respond_to?(:reduce)

data/lib/adzerk/version.rb

@@ -1,3 +1,3 @@
 module Adzerk
-  VERSION = "0.14"
+  VERSION = "0.15"
 end

data/test/category_api_spec.rb

@@ -106,9 +106,13 @@ describe "Category API" do
       @category.create(bad_id, $new_category)
     }.to raise_error "Flight is not a part of your network"
 
-    expect {
-      @category.list(bad_id)
-    }.to raise_error "Flight is not a part of your network"
+    # Disabling this assertion temporarily.
+    # The API is no longer returning an error bur rather an empty list.
+    # Once the bug in API is fixed, this needs to be re-enabled.
+    #
+    # expect {
+    #   @category.list(bad_id)
+    # }.to raise_error "Flight is not a part of your network"
 
     expect {
       @category.delete(bad_id,$category_id)

data/test/creative_template_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Creative Template API" do
+
+  before do
+    @creative_templates = Adzerk::Client.new(API_KEY).creative_templates
+  end
+
+  it "should create a new creative template" do
+    expected = {
+      description: 'Creative Template Description',
+      name: 'API Test Creative Template Name 1',
+      is_archived: false,
+      fields: [{
+        name: 'Title',
+        description: 'The Creative Template Title',
+        type: 'String',
+        variable: 'ctTitle',
+        required: true,
+      }, {
+        name: 'Thumbnail',
+        description: 'The URL of a Thumbnail Image',
+        type: 'String',
+        variable: 'ctThumbnailUrl',
+        required: false,
+      }],
+      contents: [{
+        type: 'Raw',
+        body: '{"title": "{{ctTitle}}", "thumbnailUrl": "{{ctThumbnailUrl}}" }'
+      }]
+    }
+
+    result = @creative_templates.create(expected)
+
+    $creative_template_id = result[:id].to_s
+
+    expect(result).to include(:id)
+    expect(result[:description]).to eq(expected[:description])
+    expect(result[:name]).to eq(expected[:name])
+    expect(result[:is_archived]).to eq(expected[:is_archived])
+    expect(result[:fields]).to match_array(expected[:fields])
+  end
+
+  it "should list existing creative templates" do
+    result = @creative_templates.list
+
+    expect(result[:page]).to eq(1)
+    expect(result[:page_size]).to eq(100)
+    expect(result[:total_items]).to be >= 1
+  end
+
+  it "should get an existing creative template" do
+    expected = {
+      description: 'Creative Template Description',
+      name: 'API Test Creative Template Name 1',
+      is_archived: false,
+      fields: [{
+        name: 'Title',
+        description: 'The Creative Template Title',
+        type: 'String',
+        variable: 'ctTitle',
+        required: true,
+      }, {
+        name: 'Thumbnail',
+        description: 'The URL of a Thumbnail Image',
+        type: 'String',
+        variable: 'ctThumbnailUrl',
+        required: false,
+      }],
+      contents: [{
+        type: 'Raw',
+        body: '{"title": "{{ctTitle}}", "thumbnailUrl": "{{ctThumbnailUrl}}" }'
+      }]
+    }
+
+    result = @creative_templates.get($creative_template_id)
+
+    expect(result[:description]).to eq(expected[:description])
+    expect(result[:name]).to eq(expected[:name])
+    expect(result[:is_archived]).to eq(expected[:is_archived])
+    expect(result[:fields]).to match_array(expected[:fields])
+  end
+
+  it "should update an existing creative template" do
+    update = {
+      updates: [{
+        path: ['IsArchived'],
+        value: true
+      }]
+    }
+
+    result = @creative_templates.update($creative_template_id, update)
+
+    expect(result[:is_archived]).to eq(true)
+  end
+end

data/test/geo_targeting_api_spec.rb

@@ -112,7 +112,7 @@ describe "GeoTargeting API" do
   it "should error when deleting a geotargeting that does not exist" do
     expect {
       @geotargetings.delete($flight_id, 1)
-    }.to raise_error "Couldn't find network for model: PassLocation, id: 1"
+    }.to raise_error "This PassLocation does not exist in your network."
   end
 
   it "should check if a flight is not a part of your network" do

data/test/instant_count_api_spec.rb

@@ -0,0 +1,25 @@
+require 'pp'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Instant Count API" do
+  before(:all) do
+    client = Adzerk::Client.new(API_KEY)
+    @instant_counts = client.instant_counts
+  end
+
+  it "should fetch bulk instant counts" do
+    advertiser_id = 1065290
+    campaign_id = 1582611
+
+    counts = @instant_counts.bulk({
+      :advertisers => [advertiser_id],
+      :campaigns => [campaign_id]
+    })
+
+    expect(counts).to have_key(:advertisers)
+    expect(counts[:advertisers]).to have_key(advertiser_id.to_s.to_sym)
+
+    expect(counts).to have_key(:campaigns)
+    expect(counts[:campaigns]).to have_key(campaign_id.to_s.to_sym)
+  end
+end

data/test/site_zone_targeting_api_spec.rb

@@ -127,7 +127,7 @@ describe "SiteZoneTargeting API" do
   it "should error when deleting a sitezone targeting that does not exist" do
     expect {
       @sitezonetargeting.delete($flight_id,1)
-    }.to raise_error "Couldn't find network for model: PassSiteMap, id: 1"
+    }.to raise_error "This PassSiteMap does not exist in your network."
   end
 
   it "should check if a flight is not a part of your network" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adzerk
 version: !ruby/object:Gem::Version
-  version: '0.14'
+  version: '0.15'
 platform: ruby
 authors:
 - Kacy Fortner
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -98,14 +98,17 @@ files:
 - lib/adzerk.rb
 - lib/adzerk/advertiser.rb
 - lib/adzerk/api_endpoint.rb
+- lib/adzerk/campaign.rb
 - lib/adzerk/category.rb
 - lib/adzerk/channel_site_map.rb
 - lib/adzerk/client.rb
 - lib/adzerk/creative.rb
 - lib/adzerk/creative_map.rb
+- lib/adzerk/creative_template.rb
 - lib/adzerk/errors.rb
 - lib/adzerk/flight.rb
 - lib/adzerk/geo_targeting.rb
+- lib/adzerk/instant_count.rb
 - lib/adzerk/invitation.rb
 - lib/adzerk/priority.rb
 - lib/adzerk/publisher.rb
@@ -121,8 +124,10 @@ files:
 - test/channel_site_map_api_spec.rb
 - test/creative_api_spec.rb
 - test/creative_map_api_spec.rb
+- test/creative_template_spec.rb
 - test/flight_api_spec.rb
 - test/geo_targeting_api_spec.rb
+- test/instant_count_api_spec.rb
 - test/invitation_api_spec.rb
 - test/login_api_spec.rb
 - test/priority_api_spec.rb