jjp-openx 1.1.4

data/lib/openx/services/base.rb

@@ -0,0 +1,134 @@
+require 'yaml'
+
+module OpenX
+  module Services
+    class Base
+      include Comparable
+
+      # HOME || HOMEPATH is for Win32 users who do not have HOME set by default
+      #
+      # Configuration can be overridden for Rails at load time by doing this:
+      # OpenX::Services::Base.configuration = 
+      #   YAML.load_file(File.join(Rails.root, 'config', 'credentials.yml'))[Rails.env]
+      # 
+      # Rescue nil is there for Rails sites that are monitored by Monit,
+      # which does not set the environment variables as expected.
+      # Note that the configuration can be set explicitly (as above), 
+      # in which case this constant is not used and can safely be nil.
+      CONFIGURATION_YAML = File.join((ENV['HOME'] || ENV['HOMEPATH']), '.openx', 'credentials.yml') rescue nil
+
+      @@connection    = nil
+      @@configuration = nil
+
+      class << self
+        attr_accessor :translations
+        attr_accessor :create, :update, :delete, :find_one, :find_all
+
+        def configuration
+          @@configuration ||=
+            YAML.load_file(CONFIGURATION_YAML)[ENV['OPENX_ENV'] || 'production']
+        end
+
+        def configuration=(c); @@configuration = c; end
+
+        def connection= c
+          @@connection = c
+        end
+
+        def connection
+          unless @@connection
+            @@connection = Session.new(configuration['url'])
+            @@connection.create( configuration['username'],
+                                configuration['password']
+                              )
+          end
+          @@connection
+        end
+
+        def create!(params = {})
+          new(params).save!
+        end
+
+        def openx_accessor(accessor_map)
+          @translations ||= {}
+          @translations = accessor_map.merge(@translations)
+          accessor_map.each do |ruby,openx|
+            attr_accessor :"#{ruby}"
+          end
+        end
+
+        def has_one(*things)
+          things.each do |thing|
+            attr_writer :"#{thing}"
+            define_method(:"#{thing}") do
+              klass = thing.to_s.capitalize.gsub(/_[a-z]/) { |m| m[1].chr.upcase }
+              klass = OpenX::Services.const_get(:"#{klass}")
+              klass.find(send("#{thing}_id"))
+            end
+          end
+        end
+
+        def find(id, *args)
+          session   = self.connection
+          server    = XmlrpcClient.new2("#{session.url}")
+          if id == :all
+            responses = server.call(find_all(), session, *args)
+            responses.map { |response|
+              new(translate(response))
+            }
+          else
+            response  = server.call(find_one(), session, id)
+            new(translate(response))
+          end
+        end
+
+        def destroy(id)
+          new(:id => id).destroy
+        end
+
+        private
+        def translate(response)
+          params    = {}
+          self.translations.each { |k,v|
+            params[k] = response[v.to_s] if response[v.to_s]
+          }
+          params
+        end
+      end
+
+      def initialize(params = {})
+        @id = nil
+        params.each { |k,v| send(:"#{k}=", v) }
+        @server = XmlrpcClient.new2("#{self.class.connection.url}")
+      end
+
+      def new_record?; @id.nil?; end
+
+      def save!
+        params = {}
+        session = self.class.connection
+        self.class.translations.keys.each { |k|
+          value = send(:"#{k}")
+          params[self.class.translations[k].to_s] = value if value
+        }
+
+        if new_record?
+          @id = @server.call(self.class.create, session, params)
+        else
+          @server.call(self.class.update, session, params)
+        end
+        self
+      end
+
+      def destroy
+        session = self.class.connection
+        @server.call(self.class.delete, session, id)
+        @id = nil
+      end
+
+      def <=>(other)
+        self.id <=> other.id
+      end
+    end
+  end
+end

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.new("Missing advertiser_id") 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,33 @@
+module OpenX
+  module Services
+    class Session
+      attr_accessor :url, :id
+      attr_accessor :user, :password
+
+      def initialize(url)
+        @url    = url
+        @server = XmlrpcClient.new2("#{@url}")
+        @id     = nil
+      end
+
+      def create(user, password)
+        @user = user
+        @password = password
+        @id = @server.call('ox.logon', @user, @password)
+        self
+      end
+
+      def recreate!
+        raise "Unable to refresh Session" unless @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 = XmlrpcClient.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    = XmlrpcClient.new2("#{session.url}")
+        server.call("ox.linkCampaign", session, 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    = XmlrpcClient.new2("#{session.url}")
+        server.call("ox.unlinkCampaign", session, 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    = XmlrpcClient.new2("#{session.url}")
+        server.call("ox.linkBanner", session, 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    = XmlrpcClient.new2("#{session.url}")
+        server.call("ox.unlinkBanner", session, 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    = XmlrpcClient.new2("#{session.url}")
+        server.call("ox.generateTags", session, self.id, tag_type, [])
+      end
+    end
+  end
+end

data/lib/openx/services.rb

@@ -0,0 +1,8 @@
+require 'openx/services/base'
+require 'openx/services/session'
+require 'openx/services/advertiser'
+require 'openx/services/agency'
+require 'openx/services/campaign'
+require 'openx/services/banner'
+require 'openx/services/publisher'
+require 'openx/services/zone'

data/lib/openx/xmlrpc_client.rb

@@ -0,0 +1,78 @@
+require 'xmlrpc/client'
+
+module OpenX
+
+  unless defined? HTTPBroken
+    # A module that captures all the possible Net::HTTP exceptions 
+    # from http://pastie.org/pastes/145154
+    module HTTPBroken; end
+    
+    [Timeout::Error, Errno::EINVAL, Errno::EPIPE, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, 
+      Net::HTTPHeaderSyntaxError, Net::ProtocolError].each {|m| m.send(:include, HTTPBroken)}
+  end
+
+  class XmlrpcClient
+    @uri = nil
+    @server = nil
+    
+    @retry_on_http_error = true
+    @timeout = 10 # seconds
+    
+    class << self
+      attr_accessor :retry_on_http_error, :timeout
+      
+      def init_server(uri)
+        server = XMLRPC::Client.new2(uri)
+        server.timeout = self.timeout
+        #server.instance_variable_get(:@http).set_debug_output($stderr)
+        server
+      end
+      
+      def new2(uri)
+        server = init_server(uri)
+        new(server, uri)
+      end
+    end
+    
+    def initialize(server, uri)
+      @server = server
+      @uri = uri
+    end
+    
+    def call(method, *args)
+      if args.first.is_a?(OpenX::Services::Session)
+        session = args.shift()
+        args.unshift(session.id)
+        begin
+          do_call(method, *args)
+        rescue XMLRPC::FaultException => sess_id_err
+          if sess_id_err.message.strip == 'Session ID is invalid'
+            session.recreate!
+            args.shift()
+            args.unshift(session.id)
+            do_call(method, *args)
+          else
+            raise sess_id_err
+          end
+        end
+      else
+        do_call(method, *args)
+      end
+    end
+    
+    def do_call(method, *args)
+      begin
+        @server.call(method, *args)
+      rescue HTTPBroken => httpbe
+        if self.class.retry_on_http_error
+          @server = self.class.init_server(@uri)
+          @server.call(method, *args)
+        else
+          raise httpbe
+        end
+      end
+    end
+    private :do_call
+    
+  end
+end

data/lib/openx.rb

@@ -0,0 +1,9 @@
+require 'xmlrpc/client'
+require 'openx/xmlrpc_client'
+require 'openx/services'
+require 'openx/invocation'
+require 'openx/image'
+
+module OpenX
+  VERSION = '1.1.0'
+end

data/php/openx-2.8.1-keywords.diff

@@ -0,0 +1,110 @@
+Index: www/api/v2/xmlrpc/BannerXmlRpcService.php
+===================================================================
+--- www/api/v2/xmlrpc/BannerXmlRpcService.php	(revision 44144)
++++ www/api/v2/xmlrpc/BannerXmlRpcService.php	(working copy)
+@@ -86,7 +86,7 @@
+                 1, array('campaignId', 'bannerName', 'storageType', 'fileName',
+                         'imageURL', 'htmlTemplate', 'width', 'height', 'weight',
+                         'target', 'url', 'bannerText', 'status', 'adserver', 'transparent',
+-                        'capping', 'sessionCapping', 'block', 'comments'),
++                        'capping', 'sessionCapping', 'block', 'comments', 'keyword'),
+                    array('aImage', 'aBackupImage'), $oResponseWithError)) {
+ 
+             return $oResponseWithError;
+@@ -121,7 +121,7 @@
+                 1, array('bannerId', 'campaignId', 'bannerName', 'storageType', 'fileName',
+                         'imageURL', 'htmlTemplate', 'width', 'height', 'weight',
+                         'target', 'url', 'bannerText', 'status', 'adserver', 'transparent',
+-                        'capping', 'sessionCapping', 'block', 'comments'),
++                        'capping', 'sessionCapping', 'block', 'comments', 'keyword'),
+                    array('aImage', 'aBackupImage'), $oResponseWithError)) {
+ 
+             return $oResponseWithError;
+Index: lib/OA/Dll/Banner.php
+===================================================================
+--- lib/OA/Dll/Banner.php	(revision 44144)
++++ lib/OA/Dll/Banner.php	(working copy)
+@@ -203,7 +203,8 @@
+             !$this->checkStructureNotRequiredIntegerField($oBanner, 'capping') ||
+             !$this->checkStructureNotRequiredIntegerField($oBanner, 'sessionCapping') ||
+             !$this->checkStructureNotRequiredIntegerField($oBanner, 'block') ||
+-            !$this->checkStructureNotRequiredStringField($oBanner,  'comments')
++            !$this->checkStructureNotRequiredStringField($oBanner,  'comments') ||
++            !$this->checkStructureNotRequiredStringField($oBanner,  'keyword')
+             ) {
+             return false;
+         }
+Index: lib/OA/Dll/BannerInfo.php
+===================================================================
+--- lib/OA/Dll/BannerInfo.php	(revision 44144)
++++ lib/OA/Dll/BannerInfo.php	(working copy)
+@@ -210,6 +210,13 @@
+     var $comments;
+ 
+     /**
++     * This field provides keywords to be stored.
++     *
++     * @var string $keyword
++     */
++    var $keyword;
++
++    /**
+      * This method sets all default values when adding a new banner.
+      *
+      * @access public
+@@ -251,6 +258,10 @@
+         if (is_null($this->block)) {
+             // Leave null
+         }
++
++        if (is_null($this->keyword)) {
++            // Leave null
++        }
+     }
+ 
+     function encodeImage($aImage)
+@@ -305,6 +316,7 @@
+                     'aImage' => 'custom',
+                     'aBackupImage' => 'custom',
+                     'comments' => 'string',
++                    'keyword' => 'string',
+                 );
+     }
+ }
+Index: lib/xmlrpc/php/BannerInfo.php
+===================================================================
+--- lib/xmlrpc/php/BannerInfo.php	(revision 44144)
++++ lib/xmlrpc/php/BannerInfo.php	(working copy)
+@@ -210,6 +210,13 @@
+     var $comments;
+ 
+     /**
++     * This field provides keywords to be stored.
++     *
++     * @var string $keyword
++     */
++    var $keyword;
++
++    /**
+      * This method sets all default values when adding a new banner.
+      *
+      * @access public
+@@ -251,6 +258,10 @@
+         if (is_null($this->block)) {
+             // Leave null
+         }
++
++        if (is_null($this->keyword)) {
++            // Leave null
++        }
+     }
+ 
+     function encodeImage($aImage)
+@@ -305,6 +316,7 @@
+                     'aImage' => 'custom',
+                     'aBackupImage' => 'custom',
+                     'comments' => 'string',
++                    'keyword' => 'string',
+                 );
+     }
+ }

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