bsm-openx 1.9.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+.svn/
+pkg/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem 'activesupport', :require => 'active_support/test_case'
+  gem 'rake'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.0)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  jeweler
+  rake

data/README.txt

@@ -0,0 +1,85 @@
+= OpenX
+
+A Ruby interface to the OpenX XML-RPC API.
+
+== SYNOPSIS:
+
+  OpenX.configuration = {
+    'username'  => 'admin',
+    'password'  => 'password',
+    'url'       => 'http://localhost/www/api/v2/xmlrpc/',
+    'timeout'   => 10,   # Optional
+    'reconnect' => true  # Optional
+  }
+
+  OpenX::Services::Agency.find(:all).each do |agency|
+    puts agency.name
+
+    # Look up publishers
+    agency.publishers.each do |publisher|
+      puts "-- #{publisher.name}"
+    end
+
+    # Create a publisher
+    OpenX::Services::Publisher.create!(
+      :agency       => agency,
+      :name         => 'My Test Publisher',
+      :contact_name => 'Aaron Patterson',
+      :email        => 'aaron@tenderlovemaking.com',
+      :username     => 'user',
+      :password     => 'password'
+    )
+  end
+
+== REQUIREMENTS:
+
+* ruby
+
+== INSTALL:
+
+* sudo gem install bsm-openx
+* Update your $HOME/.openx/credentials.yml file.
+  You can set your own path via OpenX.config_file = '/path/pto/file.yml'.
+  Here is a sample:
+
+  ---
+  production:
+    username: admin
+    password: admin
+    url: http://www.example.com/www/api/v2/xmlrpc/
+    invocation_url: http://www.example.com/www/delivery/axmlrpc.php
+
+The YAML file lists configuration for each environment.  The gem uses the
+'production' environment by default. Trailing slash is required on the 'url'.
+'invocation_url' is only used by the OpenX::Invocation methods to serve
+advertisements over XML-RPC
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010:
+
+* {Aaron Patterson}[http://tenderlovemaking.com]
+* Andy Smith
+* {TouchLocal P/L}[http://www.touchlocal.com]
+* Dimitrij Denissenko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,51 @@
+$: << File.join(File.dirname(__FILE__), "lib")
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'openx'
+
+Rake::TestTask.new(:test) do |test|
+  test.test_files = FileList["test/**/test_*.rb"].sort
+  test.libs << "test"
+  test.verbose = false
+  test.warning = true
+end
+
+task :default => :test
+
+namespace :openx do
+  task :clean do
+    ENV['OPENX_ENV'] = 'test'
+    include OpenX::Services
+
+    Agency.find(:all) do |agency|
+      Advertiser.find(:all, agency.id).each do |advertiser|
+        Campaign.find(:all, advertiser.id).each do |campaign|
+          Banner.find(:all, campaign.id).each do |banner|
+            banner.destroy
+          end
+          campaign.destroy
+        end
+        advertiser.destroy
+      end
+    end
+
+  end
+end
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "bsm-openx"
+    gemspec.summary = "A Ruby interface to the OpenX XML-RPC API"
+    gemspec.description = "A Ruby interface to the OpenX XML-RPC API"
+    gemspec.email = "dimitrij@blacksquaremedia.com"
+    gemspec.homepage = "http://github.com/dim/openx"
+    gemspec.authors = ["Aaron Patterson", "Andy Smith", "TouchLocal P/L", "Dimitrij Denissenko"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.9.1

data/bsm-openx.gemspec

@@ -0,0 +1,92 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bsm-openx}
+  s.version = "1.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Patterson", "Andy Smith", "TouchLocal P/L", "Dimitrij Denissenko"]
+  s.date = %q{2010-09-09}
+  s.description = %q{A Ruby interface to the OpenX XML-RPC API}
+  s.email = %q{dimitrij@blacksquaremedia.com}
+  s.extra_rdoc_files = [
+    "README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "README.txt",
+     "Rakefile",
+     "VERSION",
+     "bsm-openx.gemspec",
+     "lib/openx.rb",
+     "lib/openx/image.rb",
+     "lib/openx/invocation.rb",
+     "lib/openx/services.rb",
+     "lib/openx/services/advertiser.rb",
+     "lib/openx/services/agency.rb",
+     "lib/openx/services/banner.rb",
+     "lib/openx/services/base.rb",
+     "lib/openx/services/campaign.rb",
+     "lib/openx/services/channel.rb",
+     "lib/openx/services/persistance.rb",
+     "lib/openx/services/publisher.rb",
+     "lib/openx/services/session.rb",
+     "lib/openx/services/targeting_rule.rb",
+     "lib/openx/services/targeting_rules.rb",
+     "lib/openx/services/zone.rb",
+     "lib/openx/xmlrpc_client.rb",
+     "test/assets/300x250.jpg",
+     "test/assets/cat.swf",
+     "test/helper.rb",
+     "test/test_advertiser.rb",
+     "test/test_agency.rb",
+     "test/test_banner.rb",
+     "test/test_base.rb",
+     "test/test_campaign.rb",
+     "test/test_channel.rb",
+     "test/test_openx.rb",
+     "test/test_publisher.rb",
+     "test/test_services.rb",
+     "test/test_session.rb",
+     "test/test_targeting_rule.rb",
+     "test/test_targeting_rules.rb",
+     "test/test_zone.rb"
+  ]
+  s.homepage = %q{http://github.com/dim/openx}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby interface to the OpenX XML-RPC API}
+  s.test_files = [
+    "test/test_openx.rb",
+     "test/test_channel.rb",
+     "test/test_targeting_rule.rb",
+     "test/test_zone.rb",
+     "test/test_session.rb",
+     "test/helper.rb",
+     "test/test_campaign.rb",
+     "test/test_base.rb",
+     "test/test_agency.rb",
+     "test/test_advertiser.rb",
+     "test/test_services.rb",
+     "test/test_banner.rb",
+     "test/test_targeting_rules.rb",
+     "test/test_publisher.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/openx.rb

@@ -0,0 +1,41 @@
+module OpenX
+  autoload :Image, 'openx/image'
+  autoload :Invocation, 'openx/invocation'
+  autoload :Services, 'openx/services'
+  autoload :XmlrpcClient, 'openx/xmlrpc_client'
+  autoload :XmlrpcSessionClient, 'openx/xmlrpc_client'
+
+  @@env           = ENV['OPENX_ENV'] || 'production'
+  @@config_file   = File.join(ENV['HOME'], '.openx', 'credentials.yml')
+  @@configuration = nil
+
+  DEFAULT_OPTIONS = { 'retry' => true, 'timeout' => 10 }
+
+  class << self
+
+    def env
+      @@env
+    end
+
+    def env=(value)
+      @@env = value
+    end
+
+    def configuration
+      @@configuration ||= DEFAULT_OPTIONS.merge(YAML.load_file(config_file)[env])
+    end
+
+    def configuration=(value)
+      @@configuration = value
+    end
+
+    def config_file
+      @@config_file
+    end
+
+    def config_file=(value)
+      @@config_file = value
+    end
+
+  end
+end

data/lib/openx/image.rb

@@ -0,0 +1,22 @@
+module OpenX
+  class Image
+    include XMLRPC::Marshallable
+    attr_accessor :filename, :content, :editswf
+
+    def initialize(hash_or_file)
+      @editswf = 0
+      if hash_or_file.is_a?(File)
+        @filename = File.basename(hash_or_file.path)
+        @editswf = File.basename(@filename, '.swf') == @filename ? 0 : 1
+        @content  = XMLRPC::Base64.new(hash_or_file.read)
+      else
+        raise ArgumentError unless hash_or_file.key?(:filename)
+        raise ArgumentError unless hash_or_file.key?(:content)
+        hash_or_file.each { |k,v| send(:"#{k}=", v) }
+        unless self.content.is_a?(XMLRPC::Base64)
+          self.content = XMLRPC::Base64.new(self.content)
+        end
+      end
+    end
+  end
+end

data/lib/openx/invocation.rb

@@ -0,0 +1,62 @@
+module OpenX
+  class Invocation
+    class << self
+      DEFAULTS = {
+        :count => 1,
+        :campaignid => 0,
+        :target => '',
+        :source => '',
+        :with_text => false,
+        :exclusions => [],
+        :inclusions => [],
+        :exclude_by_campaignid => false,
+        :exclude_by_bannerid => false
+      }.freeze
+
+      #
+      # banner = OpenX::Invocation.view("Plumber")
+      #
+      # banners = OpenX::Invocation.view("Plumber", :count => 2, :exclude_by_campaignid => true) ;nil
+      # banners.each do |banner|
+      #   puts "Banner #{banner['bannerid']}"
+      # end; nil
+      #
+      def view(what, params = {})
+        params   = DEFAULTS.merge(params)
+        url      = OpenX::Services.configuration['invocation_url']
+        settings = {:cookies => [], :remote_addr => 'localhost'}
+
+        context = [] # used by reference after initial use
+        params[:exclusions].each { |item| context << convert_to_context(false, item) }
+        params[:inclusions].each { |item| context << convert_to_context(true,  item) }
+        count   = params[:count].to_i
+
+        remote_params = [ what, params[:campaignid], params[:target], params[:source], params[:with_text], context]
+        server  = XmlrpcClient.new(url)
+
+        out = []
+        if count > 0
+          (0...count).each do
+            out << banner = server.call('openads.view', settings, *remote_params)
+            if count > 1
+              if params[:exclude_by_campaignid]
+                campaign_id = banner['campaignid']
+                context << convert_to_context(false, "campaignid:#{campaign_id}")
+              elsif params[:exclude_by_bannerid]
+                banner_id = banner['bannerid']
+                context << convert_to_context(false, "bannerid:#{banner_id}")
+              end
+            end
+          end
+        end
+        count > 1 ? out : out.first
+      end
+
+      def convert_to_context(is_inclusion, item)
+        key = is_inclusion ? '==' : '!='
+        { key => item }
+      end
+      protected :convert_to_context
+    end
+  end
+end

data/lib/openx/services.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+
+module OpenX
+  module Services
+    autoload :Persistance, 'openx/services/persistance'
+    autoload :Base, 'openx/services/base'
+    autoload :Session, 'openx/services/session'
+    autoload :Advertiser, 'openx/services/advertiser'
+    autoload :Agency, 'openx/services/agency'
+    autoload :Campaign, 'openx/services/campaign'
+    autoload :Banner, 'openx/services/banner'
+    autoload :Publisher, 'openx/services/publisher'
+    autoload :Zone, 'openx/services/zone'
+    autoload :Channel, 'openx/services/channel'
+    autoload :TargetingRule, 'openx/services/targeting_rule'
+    autoload :TargetingRules, 'openx/services/targeting_rules'
+
+    @@connection = nil
+
+    # Default connection
+    def self.default_connection
+      @@connection ||= establish_connection(OpenX.configuration)
+    end
+
+    def self.establish_connection(config)
+      connection = Session.new(config['url'])
+      connection.create config['username'], config['password']
+      connection
+    end
+
+  end
+end

data/lib/openx/services/advertiser.rb

@@ -0,0 +1,31 @@
+module OpenX
+  module Services
+    class Advertiser < Base
+      openx_accessor :name          => :advertiserName,
+                     :contact_name  => :contactName,
+                     :email         => :emailAddress,
+                     :username      => :username,
+                     :password      => :password,
+                     :agency_id     => :agencyId,
+                     :id            => :advertiserId
+
+      has_one :agency
+
+      self.create   = 'ox.addAdvertiser'
+      self.update   = 'ox.modifyAdvertiser'
+      self.delete   = 'ox.deleteAdvertiser'
+      self.find_one = 'ox.getAdvertiser'
+      self.find_all = 'ox.getAdvertiserListByAgencyId'
+
+      def initialize(params = {})
+        raise "need agency" unless params[:agency_id] || params[:agency]
+        params[:agency_id] ||= params[:agency].id
+        super(params)
+      end
+
+      def campaigns
+        Campaign.find(:all, self.id)
+      end
+    end
+  end
+end