bsm-openx 1.9.1

data/lib/openx/services/targeting_rule.rb

@@ -0,0 +1,125 @@
+module OpenX
+  module Services
+
+    class TargetingRule < Hash
+      TYPES = {
+        'Client'  => %w(Browser Domain Ip Language Os Useragent),
+        'Geo'     => %w(Areacode City Continent Country Dma Latlong Netspeed Organisation Postalcode Region),
+        'Site'    => %w(Channel Pageurl Referingpage Source Variable),
+        'Time'    => %w(Date Day Hour)
+      }.freeze
+
+      DATA_KEYS = ['comparison', 'data', 'logical'].freeze
+      ALL_KEYS  = (DATA_KEYS + ['type']).freeze
+
+      attr_reader :type
+
+      def self.instantiate(hash)
+        rule = new(hash['type'])
+        DATA_KEYS.each {|k| rule.update k => hash[k] }
+        rule
+      end
+
+      def initialize(type)
+        super().update('type' => verify_type(type), 'logical' => 'and')
+      end
+
+      def equal?(value)
+        update 'comparison' => '==', 'data' => convert(value)
+      end
+      alias_method :eq?, :equal?
+      alias_method :is?, :equal?
+      alias_method :==,  :equal?
+
+      def not_equal?(value)
+        update 'comparison' => '!=', 'data' => convert(value)
+      end
+      alias_method :ne?,  :not_equal?
+      alias_method :not?, :not_equal?
+
+      def lt?(value)
+        update 'comparison' => '<', 'data' => convert(value)
+      end
+      alias_method :<,  :lt?
+
+      def gt?(value)
+        update 'comparison' => '>', 'data' => convert(value)
+      end
+      alias_method :>,  :gt?
+
+      def lte?(value)
+        update 'comparison' => '<=', 'data' => convert(value)
+      end
+      alias_method :<=,  :lte?
+
+      def gte?(value)
+        update 'comparison' => '>=', 'data' => convert(value)
+      end
+      alias_method :>=,  :gte?
+
+      def match?(value)
+        update 'comparison' => '=x', 'data' => convert(value)
+      end
+      alias_method :=~, :match?
+
+      def &(other)
+        other.logical('and')
+      end
+
+      def |(other)
+        other.logical('or')
+      end
+
+      def no_match?(value)
+        update 'comparison' => '!x', 'data' => convert(value)
+      end
+
+      def include?(*value)
+        update 'comparison' => '=~', 'data' => convert(value)
+      end
+      alias_method :contains?, :include?
+
+      def exclude?(*value)
+        update 'comparison' => '!~', 'data' => convert(value)
+      end
+      alias_method :does_not_contain?, :exclude?
+
+      def with(value)
+        update 'data' => convert(value)
+      end
+
+      def compare(value)
+        update 'comparison' => value
+      end
+
+      def logical(value)
+        value = value.to_s
+        update 'logical' => (value == 'or' ? value : 'and')
+      end
+
+      def complete?
+        values_at(*ALL_KEYS).all? {|v| !v.nil? }
+      end
+
+      private
+
+        def verify_type(type)
+          group, component = type.to_s.split(':').last(2)
+          raise "Invalid type '#{self['type']}'" unless TYPES.key?(group) && TYPES[group].include?(component)
+          "#{group}:#{component}"
+        end
+
+        def convert(value)
+          case value
+          when Array
+            value.map {|v| convert(v) }.join(',')
+          when Regexp
+            value.source
+          else
+            value.to_s
+          end
+        end
+
+    end
+  end
+end

data/lib/openx/services/targeting_rules.rb

@@ -0,0 +1,26 @@
+module OpenX
+  module Services
+
+    # Create targeting rule sets. Example:
+    #
+    #    rules = OpenX::Services::TargetingRules.new do |t|
+    #      t['Site:Pageurl'].include?('test') &
+    #      t['Client:Ip'].match?(/^127\./) |
+    #      t['Geo:Country'].include?('GB', 'US')
+    #    end
+    class TargetingRules < Array
+
+      def initialize(&block)
+        super([])
+        block.call(self)
+      end
+
+      def [](key)
+        rule = TargetingRule.new(key)
+        push(rule)
+        rule
+      end
+
+    end
+  end
+end

data/lib/openx/services/zone.rb

@@ -0,0 +1,82 @@
+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, options = {})
+          options = { 'ip_address' => '192.168.1.1', 'cookies' => [] }.update(options)
+          server  = XmlrpcClient.new("#{connection.host}/delivery/axmlrpc.php")
+          server.call('openads.view', options, "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?
+        remote.call("ox.linkCampaign", 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?
+        remote.call("ox.unlinkCampaign", 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?
+        remote.call("ox.linkBanner",  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?
+        remote.call("ox.unlinkBanner", self.id, banner.id)
+      end
+
+      # Generate tags for displaying this zone using +tag_type+
+      def generate_tags(tag_type = IFRAME)
+        remote.call("ox.generateTags", self.id, tag_type, [])
+      end
+    end
+  end
+end

data/lib/openx/xmlrpc_client.rb

@@ -0,0 +1,72 @@
+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
+    attr_reader :client, :url
+
+    def initialize(url)
+      @url = url
+      init_client!
+    end
+
+    def call(method, *args)
+      @client.call(method, *convert(args))
+    rescue HTTPBroken
+      raise unless OpenX.configuration['retry']
+      init_client!
+      retry
+    end
+
+    protected
+
+      def convert(args)
+        args
+      end
+
+    private
+
+      def init_client!
+        @client = XMLRPC::Client.new2(url)
+        @client.timeout = OpenX.configuration['timeout']
+      end
+
+  end
+
+
+  class XmlrpcSessionClient < XmlrpcClient
+
+    attr_reader :session
+
+    def initialize(session)
+      @session = session
+      super(session.url)
+    end
+
+    def call(method, *args)
+      super
+    rescue XMLRPC::FaultException => error
+      raise unless error.message =~ /Session ID.*invalid/i
+      session.recreate!
+      retry
+    end
+
+    protected
+
+      def convert(args)
+         [session.id] + args
+      end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,131 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '../lib')))
+
+ENV['OPENX_ENV'] = 'test'
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+Bundler.require :test
+
+require 'test/unit'
+require 'openx'
+
+module OpenX
+  class TestCase < ActiveSupport::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'))
+
+    Base           = OpenX::Services::Base
+    Banner         = OpenX::Services::Banner
+    Zone           = OpenX::Services::Zone
+    Publisher      = OpenX::Services::Publisher
+    Campaign       = OpenX::Services::Campaign
+    Agency         = OpenX::Services::Agency
+    Advertiser     = OpenX::Services::Advertiser
+    Session        = OpenX::Services::Session
+    Channel        = OpenX::Services::Channel
+    TargetingRule  = OpenX::Services::TargetingRule
+    TargetingRules = OpenX::Services::TargetingRules
+
+    undef :default_test
+
+    def setup
+      raise 'Please create the credentials file' unless File.exists?(OpenX.config_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 channel
+      @channel ||= Channel.create!(
+        {
+          :publisher   => publisher,
+          :name        => "Channel - #{Time.now}",
+          :comments    => 'Random Comments',
+          :description => 'Random Description'
+        }
+      )
+    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 targeting_rules
+      @targeting_rules ||= OpenX::Services::TargetingRules.new do |t|
+        t['Site:Pageurl'].include?('test') &
+        t['Client:Ip'].match?(/^127\./) |
+        t['Geo:Country'].include?('GB', 'US')
+      end
+    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
+      @channel.destroy if defined? @channel
+    end
+
+  end
+end

data/test/test_advertiser.rb

@@ -0,0 +1,82 @@
+require File.dirname(__FILE__) + '/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