adzerk 0.13 → 0.18

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

data/lib/adzerk/instant_count.rb

@@ -0,0 +1,21 @@
+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
+
+    def network_counts(data={})
+      query_string = URI.encode_www_form(data)
+      url = "instantcounts/network?#{query_string}"
+      parse_response(@client.get_request(url))
+    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/scheduled_reporting.rb

@@ -0,0 +1,24 @@
+module Adzerk
+    class ScheduledReporting < ApiEndpoint
+        def create(data)
+            url = "report/schedule"
+            formatted_data = data.transform_keys{ |key| key.downcase }
+            parse_response(@client.post_json_request(url, camelize_data(formatted_data)))
+        end
+
+        def get(report_id)
+            url = "report/schedule/#{report_id}"
+            parse_response(@client.get_request(url))
+        end
+
+        def list()
+            url = "report/schedule"
+            parse_response(@client.get_request(url))
+        end
+
+        def delete(report_id)
+            url = "report/schedule/#{report_id}/delete"
+            parse_response(@client.get_request(url))
+        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)
@@ -29,7 +29,12 @@ module Adzerk
     end
 
     def parse_response(response)
-      uncamelize_data(JSON.parse(response.body))
+      parsed_body = JSON.parse(response.body)
+      case parsed_body
+        when Hash then uncamelize_data(parsed_body)
+        when Array then parsed_body.map {|elem| uncamelize_data(elem)}
+        else parsed_body
+      end
     end
   end
 end

data/lib/adzerk/version.rb

@@ -1,3 +1,3 @@
 module Adzerk
-  VERSION = "0.13"
+  VERSION = "0.18"
 end

data/test/advertiser_api_spec.rb

@@ -50,6 +50,14 @@ describe "Advertiser API" do
     expect(advertiser[:total_items]).to be > 0
   end
 
+  it "should get advertiser instant counts" do
+    data = {
+      days: 5
+    }
+    count = @advertisers.instant_counts($advertiser_id, data)
+    expect(count.length).to be > 0
+  end
+
   it "should delete a new advertiser" do
     response = @advertisers.delete($advertiser_id)
     expect(response.body).to eq('"Successfully deleted."')

data/test/campaign_api_spec.rb

@@ -73,7 +73,8 @@ describe "Campaign API" do
       :name => "Test",
       :priority_id => $priority_id,
       :impressions => 10000,
-      :is_deleted => false
+      :is_deleted => false,
+      :goal_type => 1
     }]
     new1_campaign = {
       :name => $campaign_name,
@@ -88,8 +89,6 @@ describe "Campaign API" do
     campaign = @campaigns.create(new1_campaign)
     $campaign_id_1 = campaign[:id].to_s
     expect($campaign_name).to eq(campaign[:name])
-    # JSON.parse(response.body)["StartDate"].should == "/Date(1293858000000-0500)/"
-    # JSON.parse(response.body)["EndDate"].should == "/Date(1325307600000-0500)/"
     expect($campaign_is_active).to eq(campaign[:is_active])
     expect(campaign[:is_deleted]).to eq(false)
     expect($campaign_price.to_f).to eq(campaign[:price])
@@ -141,6 +140,19 @@ describe "Campaign API" do
     expect(campaigns.length).to be > 0
   end
 
+  it "should get campaign instant counts" do
+    data = {
+      days: 5
+    }
+    count = @campaigns.instant_counts($campaign_id, data)
+    expect(count.length).to be > 0
+  end
+
+  it "should search campaign based on name" do
+    campaign = @campaigns.search("Test%")
+    expect(campaign[:total_items]).to be > 0
+  end
+
   it "should not create/update a campaign with a advertiserId that doesn't belong to it" do
     new_campaign = {
       :name => 'Test campaign ' + rand(1000000).to_s,
@@ -173,7 +185,7 @@ describe "Campaign API" do
   end
 
   it "should not retrieve a campaign with a advertiserId that doesn't belong to it" do
-    expect { @campaigns.get('123') }.to raise_error("This campaign is not part of your network")
+    expect { @campaigns.get('123') }.to raise_error("Campaign not found.")
   end
 
     it "should delete a new campaign" do

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/channel_api_spec.rb

@@ -39,6 +39,11 @@ describe "Channel API" do
     expect($channel_ad_types).to eq(channel[:ad_types])
   end
 
+  it "should get priorities for channel" do
+    count = @channels.get_priorities($channel_id)
+    expect(count.length).to be > 0
+  end
+
   it "should update a channel" do
     $u_channel_title = 'Test Channel ' + rand(1000000).to_s + 'test'
     $u_channel_commission = '1.0'
@@ -74,7 +79,7 @@ describe "Channel API" do
     expect(last_channel[:engine]).to eq($u_channel_engine)
     expect(last_channel[:keywords]).to eq($u_channel_keywords)
     expect(last_channel[:cpm]).to eq($u_channel_CPM.to_f)
-    expect(last_channel[:ad_types]).to eq($u_channel_AdTypes)
+    expect(last_channel[:ad_types]).to match_array($u_channel_AdTypes)
   end
 
   it "should delete a new channel" do

data/test/creative_map_api_spec.rb

@@ -169,7 +169,7 @@ describe "Creative Flight API" do
   it "should list all creatives maps for a flight" do
     creative_maps = @creative_maps.list(@flight_id)
     creative_map = creative_maps[:items].last
-    $map_id= creative_map[:id]
+    $map_id = creative_map[:id]
 
     expect(creative_map[:campaign_id]).to eq(@campaign_id)
     expect(creative_map[:flight_id]).to eq(@flight_id)
@@ -195,6 +195,14 @@ describe "Creative Flight API" do
     expect(creative_map[:creative][:is_sync]).to eq($IsSync)
   end
 
+  it "should get creative map instant counts" do
+    data = {
+      days: 5
+    }
+    count = @creative_maps.instant_counts($map_id, data)
+    expect(count.length).to be > 0
+   end
+
   it "should get a specific creative map" do
     creative_map = @creative_maps.get($map_id, @flight_id)
 
@@ -332,7 +340,7 @@ describe "Creative Flight API" do
   end
 
   it "should not get a map in a different network" do
-    expect{ @creative_maps.get(123, @flight_id) }.to raise_error "This PassCreativeMap does not belong to your network."
+    expect{ @creative_maps.get(123, @flight_id) }.to raise_error Adzerk::ApiError
   end
 
   it "should get a map that's been deleted" do
@@ -382,37 +390,6 @@ describe "Creative Flight API" do
     }.to raise_error "This creative map has been deleted"
   end
 
-  it "should fail when creating a map for a campaign in a different network" do
-    expect {
-      creative_map = @creative_maps.create(
-        :campaign_id => 123,
-        :flight_id => @flight_id,
-        :size_override => false,
-        :iframe => false,
-        :impressions => 100000,
-        :percentage => 50,
-        :siteId => @site_id,
-        :zoneId => @zone_id,
-        :distributionType => 1,
-        :isActive => true,
-        :isDeleted => false,
-        :creative => {
-          :title => "Creative Title",
-          :url => "http://www.adzerk.com",
-          :body => "Test Body",
-          :advertiser_id => @advertiser_id,
-          :ad_type_id => 18,
-          'IsHTMLJS' => true,
-          :script_body => "<html></html>",
-          :is_active => true,
-          :alt => "alt text",
-          :is_deleted => false,
-          :is_sync => false
-        }
-      )
-    }.to raise_error "This campaign is not part of your network"
-  end
-
   it "should fail when creating a map for a site in a different network" do
     expect {
       creative_map = @creative_maps.create(

data/test/creative_template_spec.rb

@@ -0,0 +1,100 @@
+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,
+        ad_query: false
+      }, {
+        name: 'Thumbnail',
+        description: 'The URL of a Thumbnail Image',
+        type: 'String',
+        variable: 'ctThumbnailUrl',
+        required: false,
+        ad_query: true
+      }],
+      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,
+        ad_query: false,
+      }, {
+        name: 'Thumbnail',
+        description: 'The URL of a Thumbnail Image',
+        type: 'String',
+        variable: 'ctThumbnailUrl',
+        required: false,
+        ad_query: true,
+      }],
+      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/day_parting_api_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "DayParting API" do
+    before(:all) do
+        client = Adzerk::Client.new(API_KEY)
+        @day_partings = client.day_parts
+        @flights = client.flights
+        @advertisers = client.advertisers
+        @channels = client.channels
+        @campaigns = client.campaigns
+        @priorities = client.priorities
+
+        advertiser = @advertisers.create(:title => "test")
+        $advertiserId = advertiser[:id].to_s
+
+        channel = @channels.create(:title => 'Test Channel ' + rand(1000000).to_s,
+                                :commission => '0.0',
+                                :engine => 'CPM',
+                                :keywords => 'test',
+                                'CPM' => '10.00',
+                                :ad_types =>  [1,2,3,4])
+        $channel_id = channel[:id].to_s
+
+        priority = @priorities.create(:name => "High Priority Test",
+                                    :channel_id => $channel_id,
+                                    :weight => 1,
+                                    :is_deleted => false)
+        $priority_id = priority[:id].to_s
+
+        campaign = @campaigns.
+        create(:name => 'Test campaign ' + rand(1000000).to_s,
+                :start_date => "1/1/2011",
+                :end_date => "12/31/2011",
+                :is_active => false,
+                :price => '10.00',
+                :advertiser_id => $advertiserId,
+                :flights => [],
+                :is_deleted => false)
+        $campaign_id = campaign[:id]
+
+        new_flight = {
+        :priority_id => $priority_id,
+        :name => 'Test flight ' + rand(1000000).to_s,
+        :start_date => "1/1/2011",
+        :end_date => "12/31/2011",
+        :no_end_date => false,
+        :price => '15.00',
+        :option_type => 1,
+        :impressions => 10000,
+        :is_unlimited => false,
+        :is_full_speed => false,
+        :keywords => "test, test2",
+        :user_agent_keywords => nil,
+        :weight_override => nil,
+        :campaign_id => $campaign_id,
+        :is_active => true,
+        :is_deleted => false,
+        :goal_type => 1
+        }
+        flight = @flights.create(new_flight)
+        $flight_id = flight[:id].to_s
+    end
+
+    after(:all) do
+        @flights.delete($flight_id)
+        @campaigns.delete($campaign_id)
+        @advertisers.delete($advertiserId)
+        @priorities.delete($priority_id)
+        @channels.delete($channel_id)
+    end
+
+    it "should create a day part entity" do
+        data = {
+            :start_time => '09:30:00',
+            :end_time => '17:00:00',
+            :week_days => ['MO','TU']
+        }
+
+        response = @day_partings.create($flight_id, data)
+        expect(response[:timepart_id]).to_not eq(nil)
+        $timepart_id = response[:timepart_id].to_s
+    end
+
+    it "should get a day parting entity associated with a flight" do
+        response = @day_partings.get($flight_id, $timepart_id)
+        expect(response[:id].to_s).to eq($timepart_id)
+        expect(response[:flight_id].to_s).to eq($flight_id)
+        expect(response[:start_time]).to_not eq(nil)
+        expect(response[:end_time]).to_not eq(nil)
+        expect(response[:week_days]).to_not eq(nil)
+    end
+
+    it "should list all the day part entities in a flight" do
+        response = @day_partings.list($flight_id)
+        expect(response[:items].length).to be > 0
+    end
+
+    it "should delete a day part entity associated with a flight" do
+        response = @day_partings.delete($flight_id, $timepart_id)
+        expect(response.code).to eq('204')
+    end
+end