spiceworks-openx 1.0.0

data/lib/openx/services/campaign.rb

@@ -0,0 +1,51 @@
+module OpenX
+  module Services
+    class Campaign < Base
+      # Translate our property names to OpenX property names
+      openx_accessor  :name               => :campaignName,
+                      :advertiser_id      => :advertiserId,
+                      :id                 => :campaignId,
+                      :start_date         => :startDate,
+                      :end_date           => :endDate,
+                      :impressions        => :impressions,
+                      :target_impressions => :targetImpressions,
+                      :target_clicks      => :targetClicks,
+                      :revenue            => :revenue,
+                      :revenue_type       => :revenueType,
+                      :impressions        => :impressions,
+                      :clicks             => :clicks,
+                      :priority           => :priority,
+                      :weight             => :weight,
+                      :campaign_type      => :campaignType
+
+      has_one :advertiser
+
+      self.create   = 'ox.addCampaign'
+      self.update   = 'ox.modifyCampaign'
+      self.delete   = 'ox.deleteCampaign'
+      self.find_one = 'ox.getCampaign'
+      self.find_all = 'ox.getCampaignListByAdvertiserId'
+
+      # Revenue types
+      CPM             = 1
+      CPC             = 2
+      CPA             = 3
+      MONTHLY_TENANCY = 4
+
+      # Campaign types
+      REMNANT   = 1
+      HIGH      = 2
+      EXCLUSIVE = 3
+
+      def initialize(params = {})
+        raise ArgumentError unless params[:advertiser_id] || params[:advertiser]
+        params[:advertiser_id] ||= params[:advertiser].id
+        super(params)
+      end
+
+      def banners
+        Banner.find(:all, self.id)
+      end
+    end
+  end
+end

data/lib/openx/services/publisher.rb

@@ -0,0 +1,31 @@
+module OpenX
+  module Services
+    class Publisher < Base
+      openx_accessor :name          => :publisherName,
+                     :contact_name  => :contactName,
+                     :email         => :emailAddress,
+                     :username      => :username,
+                     :password      => :password,
+                     :id            => :publisherId,
+                     :agency_id     => :agencyId
+
+      has_one :agency
+
+      self.create   = 'ox.addPublisher'
+      self.update   = 'ox.modifyPublisher'
+      self.delete   = 'ox.deletePublisher'
+      self.find_one = 'ox.getPublisher'
+      self.find_all = 'ox.getPublisherListByAgencyId'
+
+      def initialize(params = {})
+        raise "need agency" unless params[:agency_id] || params[:agency]
+        params[:agency_id] ||= params[:agency].id
+        super(params)
+      end
+
+      def zones
+        Zone.find(:all, self.id)
+      end
+    end
+  end
+end

data/lib/openx/services/session.rb

@@ -0,0 +1,24 @@
+module OpenX
+  module Services
+    class Session
+      attr_accessor :url, :id
+
+      def initialize(url)
+        @url    = url
+        @server = XMLRPC::Client.new2("#{@url}")
+        @id     = nil
+      end
+
+      def create(user, password)
+        @id = @server.call('ox.logon', user, password)
+        self
+      end
+
+      def destroy
+        @server.call('ox.logoff', @id)
+        @id = nil
+        self
+      end
+    end
+  end
+end

data/lib/openx/services/zone.rb

@@ -0,0 +1,98 @@
+module OpenX
+  module Services
+    class Zone < Base
+      # Delivery types
+      BANNER        = 'delivery-b'
+      INTERSTITIAL  = 'delivery-i'
+      TEXT          = 'delivery-t'
+      EMAIL         = 'delivery-e'
+
+      # Tag Types
+      JAVASCRIPT  = 'adjs'
+      LOCAL       = 'local'
+      IFRAME      = 'adframe'
+      XMLRPC_TAG  = 'xmlrpc'
+
+      openx_accessor :name          => :zoneName,
+                     :id            => :zoneId,
+                     :width         => :width,
+                     :height        => :height,
+                     :type          => :type,
+                     :publisher_id  => :publisherId
+
+      has_one :publisher
+
+      self.create   = 'ox.addZone'
+      self.update   = 'ox.modifyZone'
+      self.delete   = 'ox.deleteZone'
+      self.find_one = 'ox.getZone'
+      self.find_all = 'ox.getZoneListByPublisherId'
+
+      class << self
+        ###
+        # Deliver +zone_id+ to +ip_address+ with +cookies+, 
+        def deliver zone_id, ip_address = '192.168.1.1', cookies = []
+          url = "#{self.configuration['root']}/delivery/axmlrpc.php"
+          server = XMLRPC::Client.new2(url)
+          server.call('openads.view', {
+            'cookies'     => cookies,
+            'remote_addr' => ip_address,
+          }, "zone:#{zone_id}", 0, '', '', true, [])
+        end
+      end
+
+      def initialize(params = {})
+        raise "need publisher" unless params[:publisher_id] || params[:publisher]
+        params[:publisher_id] ||= params[:publisher].id
+        super(params)
+      end
+
+      # Link this zone to +campaign+
+      def link_campaign(campaign)
+        raise "Zone must be saved" if new_record?
+        raise ArgumentError.new("Campaign must be saved")if campaign.new_record?
+
+        session   = self.class.connection
+        server    = XMLRPC::Client.new2("#{session.url}")
+        server.call("ox.linkCampaign", session.id, self.id, campaign.id)
+      end
+
+      # Unlink this zone from +campaign+
+      def unlink_campaign(campaign)
+        raise "Zone must be saved" if new_record?
+        raise ArgumentError.new("Campaign must be saved")if campaign.new_record?
+
+        session   = self.class.connection
+        server    = XMLRPC::Client.new2("#{session.url}")
+        server.call("ox.unlinkCampaign", session.id, self.id, campaign.id)
+      end
+
+      # Link this zone to +banner+
+      def link_banner(banner)
+        raise "Zone must be saved" if new_record?
+        raise ArgumentError.new("Banner must be saved")if banner.new_record?
+
+        session   = self.class.connection
+        server    = XMLRPC::Client.new2("#{session.url}")
+        server.call("ox.linkBanner", session.id, self.id, banner.id)
+      end
+
+      # Unlink this zone from +banner+
+      def unlink_banner(banner)
+        raise "Zone must be saved" if new_record?
+        raise ArgumentError.new("Banner must be saved")if banner.new_record?
+
+        session   = self.class.connection
+        server    = XMLRPC::Client.new2("#{session.url}")
+        server.call("ox.unlinkBanner", session.id, self.id, banner.id)
+      end
+
+      # Generate tags for displaying this zone using +tag_type+
+      def generate_tags(tag_type = IFRAME)
+        session   = self.class.connection
+        server    = XMLRPC::Client.new2("#{session.url}")
+        server.call("ox.generateTags", session.id, self.id, tag_type, [])
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,99 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib')))
+
+require 'test/unit'
+require 'openx'
+
+ENV['OPENX_ENV'] = 'test'
+
+module OpenX
+  class TestCase < Test::Unit::TestCase
+    TEST_SWF = File.expand_path(File.join(File.dirname(__FILE__), 'assets', 'cat.swf'))
+    TEST_JPG = File.expand_path(File.join(File.dirname(__FILE__), 'assets', '300x250.jpg'))
+
+    include OpenX::Services
+
+    undef :default_test
+
+    def setup
+      assert(
+             File.exists?(Base::CONFIGURATION_YAML),
+              'Please create the credentials file'
+            )
+    end
+
+    def agency
+      @agency ||= Agency.create!(
+        {
+          :name         => "Testing! - #{Time.now}",
+          :contact_name => 'Contact Name!',
+          :email        => 'foo@bar.com'
+        }
+      )
+    end
+
+    def advertiser
+      @advertiser ||= Advertiser.create!(
+        {
+          :name         => "adv-#{Time.now}",
+          :contact_name => 'Contact Name!',
+          :email        => 'foo@bar.com'
+        }.merge(:agency => agency)
+      )
+    end
+
+    def campaign
+      @campaign ||= Campaign.create!(
+        {
+          :advertiser => advertiser,
+          :name         => "Campaign-#{Time.now}",
+          :impressions => 2000
+        }
+      )
+    end
+
+    def publisher
+      @publisher ||= Publisher.create!(
+        {
+          :agency       => agency,
+          :name         => "Publisher! - #{Time.now}",
+          :contact_name => 'Aaron Patterson',
+          :email        => 'aaron@tenderlovemaking.com',
+          :username     => 'one',
+          :password     => 'two',
+        }
+      )
+    end
+
+    def zone
+      @zone ||= Zone.create!(
+        {
+          :publisher  => publisher,
+          :name       => "Zone - #{Time.now}",
+          :type       => Zone::BANNER,
+          :width      => 300,
+          :height     => 250,
+        }
+      )
+    end
+
+    def banner
+      @banner ||= Banner.create!({
+        :name         => "Banner-#{Time.now}",
+        :storage_type => Banner::LOCAL_SQL,
+        :campaign     => campaign,
+        :url          => 'http://tenderlovemaking.com/',
+        :file_name    => 'oogabooga',
+        :image        => OpenX::Image.new(File.open(TEST_SWF, 'rb'))
+      })
+    end
+
+    def destroy
+      @banner.destroy if defined? @banner
+      @zone.destroy if defined? @zone
+      @publisher.destroy if defined? @publisher
+      @campaign.destroy if defined? @campaign
+      @advertiser.destroy if defined? @advertiser
+      @agency.destroy if defined? @agency
+    end
+  end
+end

data/test/test_advertiser.rb

@@ -0,0 +1,82 @@
+require 'helper'
+
+class AdvertiserTest < OpenX::TestCase
+  def test_create_advertiser
+    advertiser = nil
+    assert_nothing_raised {
+      advertiser = Advertiser.create!(init_params.merge({
+        :agency   => agency,
+      }))
+    }
+    assert_not_nil advertiser
+    init_params.each do |k,v|
+      assert_equal(v, advertiser.send(:"#{k}"))
+    end
+  end
+
+  def test_destroy
+    a = nil
+    assert_nothing_raised {
+      a = Advertiser.create!(init_params.merge({:agency => agency}))
+    }
+    id = a.id
+    assert_nothing_raised {
+      a.destroy
+    }
+    assert_raises(XMLRPC::FaultException) {
+      Advertiser.find(id)
+    }
+  end
+
+  def test_create_advertiser_with_agency
+    advertiser = nil
+    assert_nothing_raised {
+      advertiser = agency.create_advertiser!(init_params)
+    }
+    assert_not_nil advertiser
+    init_params.each do |k,v|
+      assert_equal(v, advertiser.send(:"#{k}"))
+    end
+  end
+
+  def test_find_advertiser
+    advertiser = nil
+    assert_nothing_raised {
+      advertiser = agency.create_advertiser!(init_params)
+    }
+    assert_not_nil advertiser
+
+    original = advertiser
+    advertiser = Advertiser.find(advertiser.id)
+    assert_equal(original, advertiser)
+    assert_not_nil advertiser
+    assert_not_nil advertiser.agency
+    init_params.each do |k,v|
+      assert_equal(v, advertiser.send(:"#{k}"))
+    end
+  end
+
+  def test_find_all_advertisers
+    advertiser = nil
+    assert_nothing_raised {
+      advertiser = agency.create_advertiser!(init_params)
+    }
+    assert_not_nil advertiser
+
+    advertisers = Advertiser.find(:all, agency.id)
+
+    advertiser = advertisers.find { |a| a.id == advertiser.id }
+    assert_not_nil advertiser
+    init_params.each do |k,v|
+      assert_equal(v, advertiser.send(:"#{k}"))
+    end
+  end
+
+  def init_params
+    {
+      :name         => 'Test advertiser',
+      :contact_name => 'Contact name',
+      :email        => 'email@example.com',
+    }
+  end
+end

data/test/test_agency.rb

@@ -0,0 +1,94 @@
+require 'helper'
+
+class AgencyTest < OpenX::TestCase
+  def destroy
+    Agency.find(:all).each do |agency|
+      agency.destroy if agency.name == init_params[:name]
+    end
+    super
+  end
+
+  def test_create!
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    assert_not_nil a
+    assert_not_nil a.id
+    init_params.each { |k,v|
+      assert_equal(v, a.send(:"#{k}"))
+    }
+  end
+
+  def test_modify
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    assert_not_nil a
+    assert_not_nil a.id
+    a.name = 'Awesome name!'
+    a.save!
+
+    a = Agency.find(a.id)
+    assert_equal('Awesome name!', a.name)
+    a.destroy
+  end
+
+  def test_find
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    a = Agency.find(a.id)
+    init_params.each { |k,v|
+      assert_equal(v, a.send(:"#{k}"))
+    }
+  end
+
+  def test_find_all
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    list = Agency.find(:all)
+    assert list.all? { |x| x.is_a?(Agency) }
+    assert list.any? { |x| x.name == init_params[:name] }
+  end
+
+  def test_destroy
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    id = a.id
+    assert_nothing_raised {
+      a.destroy
+    }
+    assert_raises(XMLRPC::FaultException) {
+      Agency.find(id)
+    }
+  end
+
+  def test_static_destroy
+    a = nil
+    assert_nothing_raised {
+      a = Agency.create!(init_params)
+    }
+    id = a.id
+    assert_nothing_raised {
+      Agency.destroy(id)
+    }
+    assert_raises(XMLRPC::FaultException) {
+      Agency.find(id)
+    }
+  end
+
+  def init_params
+    {
+      :name         => 'Testing!',
+      :contact_name => 'Contact Name!',
+      :email        => 'foo@bar.com'
+    }
+  end
+end