adzerk 0.1.4 → 0.2

data/lib/adzerk.rb

@@ -0,0 +1,15 @@
+require "json"
+require "net/http"
+require "active_support/inflector"
+require "rest_client"
+require "adzerk/util"
+require "adzerk/api_endpoint"
+require "adzerk/advertiser"
+require "adzerk/flight"
+require "adzerk/creative"
+require "adzerk/creative_map"
+require "adzerk/publisher"
+require "adzerk/invitation"
+require "adzerk/reporting"
+require "adzerk/channel_site_map"
+require "adzerk/client"

data/lib/adzerk/advertiser.rb

@@ -0,0 +1,9 @@
+module Adzerk
+  class Advertiser < ApiEndpoint
+    def search(advertiser_name)
+      url = 'advertiser/search'
+      data = { 'advertiserName' => advertiser_name }
+      parse_response(client.post_request(url, data))
+    end
+  end
+end

data/lib/adzerk/api_endpoint.rb

@@ -0,0 +1,41 @@
+module Adzerk
+  class ApiEndpoint
+
+    include Adzerk::Util
+
+    attr_reader :client, :endpoint
+
+    def initialize(args= {})
+      @client = args[:client]
+      @endpoint = args[:endpoint]
+    end
+
+    def create(opts={})
+      data = { endpoint => camelize_data(opts).to_json }
+      response = @client.post_request(endpoint, data)
+      parse_response(response)
+    end
+
+    def get(id)
+      response = @client.get_request("#{endpoint}/#{id}")
+      parse_response(response)
+    end
+
+    def list
+      response = @client.get_request(endpoint)
+      parse_response(response)
+    end
+
+    def update(opts={})
+      id = opts[:id].to_s
+      data = { endpoint => camelize_data(opts).to_json }
+      response = @client.put_request("#{endpoint}/#{id}", data)
+      parse_response(response)
+    end
+
+    def delete(id)
+      url = "#{endpoint}/#{id}/delete"
+      @client.get_request(url)
+    end
+  end
+end

data/lib/adzerk/channel_site_map.rb

@@ -0,0 +1,53 @@
+module Adzerk
+  class ChannelSiteMap
+
+    include Adzerk::Util
+
+    attr_reader :client
+
+    def initialize(args= {})
+      @client = args[:client]
+    end
+
+    def create(data={})
+      data = { 'channelSite' => camelize_data(data).to_json }
+      response = client.post_request('channelSite', data)
+      parse_response(response)
+    end
+
+    def get(channel_id, site_id)
+      url = "channel/#{channel_id}/site/#{site_id}"
+      response = client.get_request(url)
+      response = parse_response(response)
+    end
+
+    def list
+      response = client.get_request('channelSite')
+      parse_response(response)
+    end
+
+    def update(data={})
+      data = { 'channelSite' => camelize_data(data).to_json }
+      response = client.put_request('channelSite', data)
+      parse_response(response)
+    end
+
+    def delete(channel_id, site_id)
+      url = "channel/#{channel_id}/site/#{site_id}/delete"
+      client.get_request(url)
+    end
+
+    def sites_in_channel(channel_id)
+      url = "sitesInChannel/#{channel_id}"
+      response = client.get_request(url)
+      parse_response(response)
+    end
+
+    def channels_in_site(site_id)
+      url = "channelsInSite/#{site_id}"
+      response = client.get_request(url)
+      parse_response(response)
+    end
+  end
+end
+

data/lib/adzerk/client.rb

@@ -0,0 +1,80 @@
+module Adzerk
+  class Client
+
+    include Adzerk::Util
+
+    attr_reader :sites, :zones, :campaigns, :channels, :priorities,
+                :advertisers, :flights, :creatives, :creative_maps,
+                :publishers, :invitations, :reports, :channel_site_maps,
+                :logins
+
+    DEFAULTS = {
+      :host => ENV["ADZERK_API_HOST"] || 'http://api.adzerk.net/v1/',
+      :header => 'X-Adzerk-ApiKey'
+    }
+
+    def initialize(key, opts = {})
+      @api_key = key
+      @config = DEFAULTS.merge!(opts)
+      @sites = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'site')
+      @flights = Adzerk::ApiEndpoint.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')
+      @priorities = Adzerk::ApiEndpoint.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)
+      @invitations = Adzerk::Invitation.new(:client => self)
+      @reports = Adzerk::Reporting.new(:client => self)
+      @channel_site_maps = Adzerk::ChannelSiteMap.new(:client => self)
+      @logins = Adzerk::ApiEndpoint.new(:client => self, :endpoint => 'login')
+    end
+
+    def get_request(url)
+      uri = URI.parse(@config[:host] + url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.add_field(@config[:header], @api_key)
+      http.request(request)
+    end
+
+    def post_request(url, data)
+      uri = URI.parse(@config[:host] + url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.add_field(@config[:header], @api_key)
+      request.set_form_data(data)
+      http.request(request)
+    end
+
+    def put_request(url, data)
+      uri = URI.parse(@config[:host] + url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Put.new(uri.request_uri)
+      request.add_field(@config[:header], @api_key)
+      request.set_form_data(data)
+      http.request(request)
+    end
+
+    def create_creative(data={}, image_path='')      
+      response = RestClient.post(@config[:host] + 'creative',
+                                 {:creative => camelize_data(data).to_json},
+                                 :X_Adzerk_ApiKey => @api_key,
+                                 :content_type => :json, 
+                                 :accept => :json)
+      response = upload_creative(JSON.parse(response)["Id"], image_path) unless image_path.empty?
+      response
+    end
+
+    def upload_creative(id, image_path)
+      image = File.new(image_path, 'rb')
+      RestClient.post(@config[:host] + 'creative/' + id.to_s + '/upload',
+      {:image => image},
+      "X-Adzerk-ApiKey" => @api_key,
+      :accept => :mime)
+    end
+
+  end
+end

data/lib/adzerk/creative.rb

@@ -0,0 +1,17 @@
+require "rest_client"
+
+module Adzerk
+  class Creative < ApiEndpoint
+
+    def create(data= {}, imagepath='')
+      response = @client.create_creative(data, imagepath)
+      uncamelize_data(JSON.parse(response))
+    end
+
+    def list(advertiserId)
+      url = 'advertiser/' + advertiserId.to_s + "/creatives"
+      parse_response(@client.get_request(url))
+    end
+
+  end
+end

data/lib/adzerk/creative_map.rb

@@ -0,0 +1,38 @@
+module Adzerk
+  class CreativeMap
+
+    include Adzerk::Util
+
+    def initialize(args={})
+      @client = args[:client]
+    end
+
+    def create(data={})
+      url = "flight/#{data[:flight_id]}/creative"
+      data = { 'creative' => camelize_data(data).to_json }
+      parse_response(@client.post_request(url, data))
+    end
+
+    def get(id, flight_id)
+      url = "flight/#{flight_id}/creative/#{id}"
+      parse_response(@client.get_request(url))
+    end
+
+    def list(flight_id)
+      url = "flight/#{flight_id}/creatives"
+      parse_response(@client.get_request(url))
+    end
+
+    def update(data={})
+      url = "flight/#{data[:flight_id]}/creative/#{data[:id]}"
+      data = { 'creative' => camelize_data(data).to_json }
+      parse_response(@client.put_request(url, data))
+    end
+
+    def delete(id, flight_id)
+      url = "flight/#{flight_id}/creative/#{id}/delete"
+      @client.get_request(url)
+    end
+
+  end
+end

data/lib/adzerk/flight.rb

@@ -0,0 +1,12 @@
+module Adzerk
+  class Flight < ApiEndpoint
+    def countries
+      parse_response(@client.get_request('countries'))
+    end
+
+    def regions(region)
+      url = 'region/' + region
+      parse_reponse(@client.get_request(url))
+    end
+  end
+end

data/lib/adzerk/invitation.rb

@@ -0,0 +1,23 @@
+module Adzerk
+  class Invitation
+
+    include Adzerk::Util
+
+    attr_reader :client
+
+    def initialize(args= {})
+      @client = args[:client]
+    end
+
+    def invite_publisher(data={})
+      data = { 'invitation' => camelize_data(data).to_json }
+      @client.post_request('invite-publisher', data)
+    end
+
+    def invite_advertiser(data={})
+      data = { 'invitation' => camelize_data(data).to_json }
+      @client.post_request('invite-advertiser', data)
+    end
+
+  end
+end

data/lib/adzerk/publisher.rb

@@ -0,0 +1,17 @@
+module Adzerk
+  class Publisher < ApiEndpoint
+
+    def earnings(data={})
+      data = { 'earnings' => camelize_data(data).to_json }
+      response = @client.post_request('/earnings', data)
+      parse_response(response)
+    end
+
+    def payments(data={})
+      data = { 'payments' => camelize_data(data).to_json }
+      response = @client.post_request('/payments', data)
+      parse_response(response)
+    end
+
+  end
+end

data/lib/adzerk/reporting.rb

@@ -0,0 +1,21 @@
+module Adzerk
+  class Reporting
+    include Adzerk::Util
+
+    attr_accessor :client
+
+    def initialize(args = {})
+      @client = args.fetch(:client)
+    end
+
+    def create_report(data={})
+      data = { 'criteria' => camelize_data(data).to_json }
+      parse_response(client.post_request('report', data))
+    end
+
+    def retrieve_report(id)
+      url = 'report/' + id
+      client.get_request(url)
+    end
+  end
+end

data/lib/adzerk/util.rb

@@ -0,0 +1,37 @@
+module Adzerk
+  module Util
+    extend self
+
+    def camelize_data(data)
+      return data unless data.respond_to?(:reduce)
+      data.reduce({}) do |acc, (sym, val)|
+        acc[sym.to_s.camelize] = case val
+                                   when Hash then camelize_data(val)
+                                   when Array then val.map { |elem| camelize_data(elem) }
+                                   else val
+                                 end
+        acc
+      end
+    end
+
+    def uncamelize_data(data)
+      # stop condition for the recursion
+      return data unless data.respond_to?(:reduce)
+      data.reduce({}) do |acc, (key, val)|
+        acc[key.underscore.to_sym] = case val
+                                       when Hash then uncamelize_data(val)
+                                       when Array then val.map {|elem| uncamelize_data(elem) }
+                                       else val
+                                     end
+        acc
+      end
+    end
+
+    def parse_response(response)
+      if response.code == "200" or response.code == "400"
+        uncamelize_data(JSON.parse(response.body))
+      else
+      end
+    end
+  end
+end

data/lib/adzerk/version.rb

@@ -0,0 +1,3 @@
+module Adzerk
+  VERSION = "0.2"
+end

data/test/advertiser_api_spec.rb

@@ -1,106 +1,81 @@
-require './spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Advertiser API" do
-  
-  $advertiser_url = 'http://www.adzerk.com'
-  @@advertiser = $adzerk::Advertiser.new
-  
+
+  before do
+    @advertisers = Adzerk::Client.new(API_KEY).advertisers
+  end
+
   it "should create a new advertiser" do
     $title = 'Test advertiser ' + rand(1000000).to_s
-    $isActive = true
-    $isDeleted = false
-    
-    new_advertiser = {
-      'Title' => $title,
-      'IsActive' => $isActive,
-      'IsDeleted' => $isDeleted
-    }
-  
-    response = @@advertiser.create(new_advertiser)
-    $advertiser_id = JSON.parse(response.body)["Id"].to_s
-    $title.should == JSON.parse(response.body)["Title"]
-    $isActive.should == JSON.parse(response.body)["IsActive"]
-    $isDeleted.should == JSON.parse(response.body)["IsDeleted"]
+    $is_active = true
+    $is_deleted = false
+
+    advertiser = @advertisers.create(:title => $title,
+                                     :is_active => $is_active,
+                                     :is_deleted => $is_deleted)
+    $advertiser_id = advertiser[:id].to_s
+    $title.should == advertiser[:title]
+    $is_active.should == advertiser[:is_active]
+    $is_deleted.should == advertiser[:is_deleted]
   end
-  
+
   it "should list a specific advertiser" do
-    response = @@advertiser.get($advertiser_id)
-    response.body.should == '{"Id":' + $advertiser_id + ',"Title":"' + $title + '","IsActive":' + $isActive.to_s + ',"IsDeleted":' + $isDeleted.to_s + '}'
+    advertiser = @advertisers.get($advertiser_id)
+    $title.should == advertiser[:title]
+    $is_active.should == advertiser[:is_active]
+    $is_deleted.should == advertiser[:is_deleted]
   end
-  
-  
+
   it "should list all advertisers" do
-    result = @@advertiser.list()
+    result = @advertisers.list
     result.length.should > 0
-    result["Items"].last["Id"].to_s.should == $advertiser_id
-    result["Items"].last["Title"].should == $title
-    result["Items"].last["IsDeleted"].should == $isDeleted
-    result["Items"].last["IsActive"].should == $isActive
+    advertiser = result[:items].last
+    $title.should == advertiser[:title]
+    $is_active.should == advertiser[:is_active]
+    $is_deleted.should == advertiser[:is_deleted]
+    $advertiser_id.should == advertiser[:id].to_s
   end
-  
+
   it "should update a advertiser" do
-    $title << "test"
-    $isActive = false
-    $isDeleted = false
-    
-    updated_advertiser = {
-      'Id' => $advertiser_id.to_i,
-      'Title' => $title,
-      'IsDeleted' => $IsDeleted,
-      'IsActive' => $IsActive
-    }
-    response = @@advertiser.update(updated_advertiser)
-    $advertiser_id = JSON.parse(response.body)["Id"].to_s
-    $title.should == JSON.parse(response.body)["Title"]
-    $isActive.should == JSON.parse(response.body)["IsActive"]
-    $isDeleted.should == JSON.parse(response.body)["IsDeleted"]
+    advertiser = @advertisers.update(:id => $advertiser_id,
+                                     :title => "Cocacola",
+                                     :is_active => false)
+    advertiser[:title].should eq("Cocacola")
+    advertiser[:is_active].should eq(false)
+  end
+
+  it "should search advertiser based on name" do
+    advertiser = @advertisers.search("Cocacola")
+    advertiser[:total_items].should > 0
   end
 
   it "should delete a new advertiser" do
-    response = @@advertiser.delete($advertiser_id)
-    response.body.should == 'OK'
+    response = @advertisers.delete($advertiser_id)
+    response.body.should == '"Successfully deleted."'
   end
-  
+
   it "should not list deleted advertisers" do
-    result = @@advertiser.list()
-    result["Items"].each do |r|
-      r["Id"].to_s.should_not == $advertiser_id
+    response = @advertisers.list
+    response[:items].each do |r|
+      r["Id"].should_not == $advertiser_id
     end
   end
-  
+
   it "should not get individual deleted advertiser" do
-    response = @@advertiser.get($advertiser_id)
-    true.should == !response.body.scan(/Exception/).empty?
+    response = @advertisers.get $advertiser_id
+    response[:message].should eq("This advertiser is deleted.")
   end
-  
-  it "should not update deleted advertisers" do
-    updated_advertiser = {
-      'Id' => $advertiser_id,
-      'Title' => "test"
-    }
-    response = @@advertiser.update(updated_advertiser)
-    JSON.parse(response.body)["Id"].should == 0
-  end
-  
-  it "should create a new advertiser without IsActive or IsDeleted" do
-    new_advertiser = {
-      'Title' => $title
-    }
-    response = @@advertiser.create(new_advertiser)
-    $title.should == JSON.parse(response.body)["Title"]
-    JSON.parse(response.body)["IsActive"].should == false
-    JSON.parse(response.body)["IsDeleted"].should == false
+
+  it "should not update a deleted advertiser" do
+    advertiser = @advertisers.update(:id => $advertiser_id,
+                                     :title => "Cocacola")
+    advertiser[:message].should eq("This advertiser is deleted.")
   end
-  
+
   it "should require a title" do
-    new_advertiser = {}
-    response = @@advertiser.create(new_advertiser)
-    true.should == !response.body.scan(/Exception/).empty?
+    response = @advertisers.create()
+    response[:message].should eq("A title is required.")
   end
 
-  it "should search advertiser based on name" do
-    response = @@advertiser.search("test")
-
-    JSON.parse(response.body)["TotalItems"].should > 0
-  end
-end
+end