adzerk 0.16 → 0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de13745f2fdeb568524fc13132ce9357b360b18b8f52441796ccba849936d325
-  data.tar.gz: 2012611e5f91cbb4660d9c52bfba65e1530bdacda6e2b28ab94eaad2d5d07943
+  metadata.gz: 81c206b72f16aa47a2968e4f6fcc1143bd44d8ead4585e8c65e70e14a1b2541f
+  data.tar.gz: a61cfe82cbd4fe8a2899307fbc4844da2ae974257891e97b9c7336427c3d3989
 SHA512:
-  metadata.gz: 1ba9d92c3d94e1e991a6100c5c17aa5a4eb1bf466ce30d87ef52d3b37e2c3681ce913f25223c59448497989fb3352c9252f3a3669b2e1f526a9fd6b642a94d4f
-  data.tar.gz: 22c4cbb832d2f13023c29202691c437661f028c44bddf0e07805d4e92a7b936039313311a585b5c0d8c2263c002572d0f9c77fecfb1769e861b45d35b428f63f
+  metadata.gz: 44611cee6e3f78945dae45e86f286cbfb964c603933587191798df9c9b810bfd214c7b110edae97ff46968fca5ee74d0a7ef8dee87ccaca0ef47ef01672b7e6f
+  data.tar.gz: 0fab0586f87c62820036ef226b2c27bf2ee8c9a7ca38075ba17429c8269bed5e9e2e51649fcc3c722e968416006454533a6e5b44ea55b8ac67f35d8e9616df0b

data/lib/adzerk.rb

@@ -13,6 +13,7 @@ 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"
@@ -20,4 +21,6 @@ require "adzerk/client"
 require "adzerk/priority"
 require "adzerk/campaign"
 require "adzerk/instant_count"
-require "adzerk/creative_template"
+require "adzerk/creative_template"
+require "adzerk/scheduled_reporting"
+require "adzerk/day_parting"

data/lib/adzerk/advertiser.rb

@@ -6,8 +6,9 @@ module Adzerk
       parse_response(client.post_request(url, data))
     end
 
-    def instant_counts(advertiser_id)
-      url = "instantcounts/#{endpoint}/#{advertiser_id}?page=#{page}&pageSize=#{pageSize}"
+    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
 

data/lib/adzerk/campaign.rb

@@ -1,8 +1,15 @@
 module Adzerk
   class Campaign < ApiEndpoint
-    def instant_counts(campaign_id)
-      url = "instantcounts/#{endpoint}/#{campaign_id}"
+    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/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/client.rb

@@ -7,7 +7,8 @@ module Adzerk
                 :advertisers, :flights, :creatives, :creative_maps,
                 :publishers, :invitations, :reports, :channel_site_maps,
                 :logins, :geotargetings, :sitezonetargetings, :categories,
-                :instant_counts, :ads, :creative_templates
+                :instant_counts, :ads, :creative_templates, :scheduled_reports, 
+                :day_parts
 
     VERSION = Gem.loaded_specs['adzerk'].version.to_s
     SDK_HEADER_NAME = 'X-Adzerk-Sdk-Version'
@@ -31,7 +32,7 @@ module Adzerk
       @flights = Adzerk::Flight.new(:client => self, :endpoint => 'flight')
       @zones = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'zone')
       @campaigns = Adzerk::Campaign.new(:client => self, :endpoint => 'campaign')
-      @channels = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'channel')
+      @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')
@@ -46,6 +47,8 @@ module Adzerk
       @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, version: 'v1')

data/lib/adzerk/creative_map.rb

@@ -34,10 +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))
+    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/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,16 +1,25 @@
 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 instant_counts(flight_id)
-      url = "instantcounts/#{endpoint}/#{flight_id}"
+    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
 

data/lib/adzerk/instant_count.rb

@@ -11,5 +11,11 @@ module Adzerk
       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/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

@@ -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.16"
+  VERSION = "0.17"
 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

@@ -140,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,

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'

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)
 

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

data/test/flight_api_spec.rb

@@ -170,6 +170,15 @@ describe "Flight API" do
     expect(flights.length).to be > 0
   end
 
+  it "should get flight instant counts" do
+    data = {
+      start: "2021-04-04",
+      end: "2021-04-20"
+    }
+    count = @flights.instant_counts($flight_id, data)
+    expect(count.length).to be > 0
+  end
+
   it "should delete a new flight" do
     response = @flights.delete($flight_id)
     expect(response.body).to eq('"Successfully deleted"')
@@ -250,4 +259,21 @@ describe "Flight API" do
       )
     }.to raise_error "This campaign is not part of your network"
   end
+
+  it "should list countries" do
+    response = @flights.countries()
+    expect(response.length).to be > 0
+  end
+
+  it "should list metro codes for region" do
+    region_code = "MN"
+    response = @flights.regions(region_code)
+    expect(response.length).to be > 0
+  end
+
+  it "should list regions for a country" do
+    country_code = "US"
+    response = @flights.list_regions_for_country(country_code)
+    expect(response.length).to be > 0
+  end
 end

data/test/instant_count_api_spec.rb

@@ -5,11 +5,32 @@ describe "Instant Count API" do
   before(:all) do
     client = Adzerk::Client.new(API_KEY)
     @instant_counts = client.instant_counts
+    @advertisers = client.advertisers
+    @campaigns = client.campaigns
+
+    advertiser = @advertisers.create(:title => "test")
+    @advertiser_id = advertiser[:id]
+
+    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 => @advertiser_id,
+             :flights => [],
+             :is_deleted => false)
+    @campaign_id = campaign[:id]
+  end
+
+  after(:all) do
+    @campaigns.delete(@campaign_id)
+    @advertisers.delete(@advertiser_id)
   end
 
   it "should fetch bulk instant counts" do
-    advertiser_id = 1065290
-    campaign_id = 1582611
+    advertiser_id = @advertiser_id
+    campaign_id = @campaign_id
 
     counts = @instant_counts.bulk({
       :advertisers => [advertiser_id],
@@ -22,4 +43,13 @@ describe "Instant Count API" do
     expect(counts).to have_key(:campaigns)
     expect(counts[:campaigns]).to have_key(campaign_id.to_s.to_sym)
   end
+
+  it "should get network instant counts" do
+    data = {
+      start: "2021-04-04",
+      end: "2021-04-20"
+    }
+    count = @instant_counts.network_counts(data)
+    expect(count.length).to be > 0
+  end
 end

data/test/scheduled_reporting_api_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Reporting API" do
+    before(:all) do
+        client = Adzerk::Client.new(API_KEY)
+        @scheduled_reports = client.scheduled_reports
+    end
+
+    it "should create a scheduled report" do
+        $name = 'Test Report' + rand(1000000).to_s
+        $login_id = 25218
+        $kickoff_date = '2020-02-02T00:00:00'
+        $scheduling_window = 1
+        $recurrence_type = 2
+        data = {
+            :name => $name,
+            :login_id => $login_id,
+            :kickoff_date => $kickoff_date,
+            :scheduling_window => $scheduling_window,
+            :recurrence_type => $recurrence_type,
+            :criteria => {
+                :start_date_iso => '2020-01-01T00:00:00',
+                :end_date_iso => '2020-11-23T23:59:59',
+                :group_by => ['month'],
+                :parameters => [{
+                :country_code => 'US'
+                }],
+            },
+            :emails => ['cbensel@kevel.co'],
+            :show_events => true,
+            :show_click_bucketing => true,
+            :show_revenue => true,
+            :show_conversions => true,
+        }
+
+        response = @scheduled_reports.create(data)
+        expect($name).to eq(response[:name])
+        expect($login_id).to eq(response[:login_id])
+        expect($kickoff_date).to eq(response[:kickoff_date])
+        expect($scheduling_window).to eq(response[:scheduling_window])
+        expect($recurrence_type).to eq(response[:recurrence_type])
+        $report_id = response[:id]
+    end
+
+    it "should get a single report" do
+        response = @scheduled_reports.get($report_id)
+        expect($report_id).to eq(response[:id])
+        expect($name).to eq(response[:name])
+    end
+
+    it "should list all reports for account" do 
+        response = @scheduled_reports.list()
+        expect(response.length).to be > 0
+    end
+
+    it "should delete a report" do
+        response = @scheduled_reports.delete($report_id)
+        expect(response).to eq('Successfully deleted')
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adzerk
 version: !ruby/object:Gem::Version
-  version: '0.16'
+  version: '0.17'
 platform: ruby
 authors:
 - Kacy Fortner
@@ -17,7 +17,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -100,11 +100,13 @@ files:
 - lib/adzerk/api_endpoint.rb
 - lib/adzerk/campaign.rb
 - lib/adzerk/category.rb
+- lib/adzerk/channel.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/day_parting.rb
 - lib/adzerk/errors.rb
 - lib/adzerk/flight.rb
 - lib/adzerk/geo_targeting.rb
@@ -113,6 +115,7 @@ files:
 - lib/adzerk/priority.rb
 - lib/adzerk/publisher.rb
 - lib/adzerk/reporting.rb
+- lib/adzerk/scheduled_reporting.rb
 - lib/adzerk/site_zone_targeting.rb
 - lib/adzerk/util.rb
 - lib/adzerk/version.rb
@@ -125,6 +128,7 @@ files:
 - test/creative_api_spec.rb
 - test/creative_map_api_spec.rb
 - test/creative_template_spec.rb
+- test/day_parting_api_spec.rb
 - test/flight_api_spec.rb
 - test/geo_targeting_api_spec.rb
 - test/instant_count_api_spec.rb
@@ -134,6 +138,7 @@ files:
 - test/publisher_api_spec.rb
 - test/rakefile.rb
 - test/report_api_spec.rb
+- test/scheduled_reporting_api_spec.rb
 - test/security_api_spec.rb
 - test/site_api_spec.rb
 - test/site_zone_targeting_api_spec.rb