openx 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-04-07
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,26 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/openx.rb
+lib/openx/image.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/publisher.rb
+lib/openx/services/session.rb
+lib/openx/services/zone.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_publisher.rb
+test/test_session.rb
+test/test_zone.rb

data/README.txt

@@ -0,0 +1,80 @@
+= openx
+
+* http://openx.rubyforge.org
+
+== DESCRIPTION:
+
+A Ruby interface to the OpenX XML-RPC API.
+
+== SYNOPSIS:
+
+  OpenX::Services::Base.configuration = {
+    'username'  => 'admin',
+    'password'  => 'password',
+    'url'       => 'http://localhost/www/api/v1/xmlrpc',
+  }
+
+  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
+    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 openx
+* Update your $HOME/.openx/credentials.yml file.  Here is a sample:
+
+  ---
+  production:
+    username: admin
+    password: admin
+    url: http://localhost/~aaron/openx-2.5.70-beta/www/api/v1/xmlrpc
+
+The YAML file lists configuration for each environment.  The gem uses the
+'production' environment by default.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008:
+
+* {Aaron Patterson}[http://tenderlovemaking.com]
+* Andy Smith
+
+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,40 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+$: << "lib/"
+require 'openx'
+
+HOE = Hoe.new('openx', OpenX::VERSION) do |p|
+  # p.rubyforge_name = 'ruby-openxx' # if different than lowercase project name
+  p.developer('Aaron Patterson', 'aaron.patterson@gmail.com')
+end
+
+namespace :openx do
+  task :clean do
+    include OpenX::Services
+    ENV['OPENX_ENV'] = 'test'
+    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
+
+namespace :gem do
+  task :spec do
+    File.open("#{HOE.name}.gemspec", 'w') do |f|
+      f.write(HOE.spec.to_ruby)
+    end
+  end
+end
+
+# vim: syntax=Ruby

data/lib/openx.rb

@@ -0,0 +1,7 @@
+require 'xmlrpc/client'
+require 'openx/services'
+require 'openx/image'
+
+module OpenX
+  VERSION = '1.0.0'
+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/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/services/advertiser.rb

@@ -0,0 +1,32 @@
+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.endpoint = '/AdvertiserXmlRpcService.php'
+      self.create   = 'addAdvertiser'
+      self.update   = 'modifyAdvertiser'
+      self.delete   = 'deleteAdvertiser'
+      self.find_one = 'getAdvertiser'
+      self.find_all = '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

data/lib/openx/services/agency.rb

@@ -0,0 +1,35 @@
+module OpenX
+  module Services
+    class Agency < Base
+      # Translate our property names to OpenX property names
+      openx_accessor  :name          => :agencyName,
+                      :contact_name  => :contactName,
+                      :email         => :emailAddress,
+                      :username      => :username,
+                      :password      => :password,
+                      :id            => :agencyId,
+                      :account_id    => :accountId
+
+      self.endpoint = '/AgencyXmlRpcService.php'
+      self.create   = 'addAgency'
+      self.update   = 'modifyAgency'
+      self.delete   = 'deleteAgency'
+      self.find_one = 'getAgency'
+      self.find_all = 'getAgencyList'
+
+      def create_advertiser!(params = {})
+        Advertiser.create!(params.merge({
+          :agency   => self,
+        }))
+      end
+
+      def advertisers
+        Advertiser.find(:all, self.id)
+      end
+
+      def publishers
+        Publisher.find(:all, self.id)
+      end
+    end
+  end
+end

data/lib/openx/services/banner.rb

@@ -0,0 +1,80 @@
+require 'date'
+
+module OpenX
+  module Services
+    class Banner < Base
+      LOCAL_SQL = 'sql'
+      LOCAL_WEB = 'web'
+      EXTERNAL  = 'url'
+      HTML      = 'html'
+      TEXT      = 'txt'
+
+      class << self
+        def find(id, *args)
+          session   = self.connection
+          server    = XMLRPC::Client.new2("#{session.url}#{endpoint}")
+          if id == :all
+            responses = server.call(find_all(), session.id, *args)
+            response = responses.first
+            return [] unless response
+            responses = [response]
+
+            ### Annoying..  For some reason OpenX returns a linked list.
+            ### Probably a bug....
+            while response.key?('aImage')
+              response = response.delete('aImage')
+              break unless response
+              responses << response
+            end
+
+            responses.map { |response|
+              new(translate(response))
+            }
+          else
+            response  = server.call(find_one(), session.id, id)
+            new(translate(response))
+          end
+        end
+      end
+
+      # Translate our property names to OpenX property names
+      openx_accessor  :name           => :bannerName,
+                      :campaign_id    => :campaignId,
+                      :id             => :bannerId,
+                      :storage_type   => :storageType,
+                      :file_name      => :fileName,
+                      :image_url      => :imageURL,
+                      :html_template  => :htmlTemplate,
+                      :width          => :width,
+                      :height         => :height,
+                      :weight         => :weight,
+                      :target         => :target,
+                      :url            => :url,
+                      :status         => :status,
+                      :adserver       => :adserver,
+                      :transparent    => :transparent,
+                      :image          => :aImage,
+                      :backup_image   => :aBackupImage
+
+      has_one :campaign
+
+      self.endpoint = '/BannerXmlRpcService.php'
+      self.create   = 'addBanner'
+      self.update   = 'modifyBanner'
+      self.delete   = 'deleteBanner'
+      self.find_one = 'getBanner'
+      self.find_all = 'getBannerListByCampaignId'
+
+      def initialize(params = {})
+        raise ArgumentError unless params[:campaign_id] || params[:campaign]
+        params[:campaign_id] ||= params[:campaign].id
+        super(params)
+      end
+
+      def statistics start_on = Date.today, end_on = Date.today
+        session = self.class.connection
+        @server.call('bannerDailyStatistics', session.id, self.id, start_on, end_on)
+      end
+    end
+  end
+end

data/lib/openx/services/base.rb

@@ -0,0 +1,125 @@
+require 'yaml'
+
+module OpenX
+  module Services
+    class Base
+      include Comparable
+
+      CONFIGURATION_YAML = File.join(ENV['HOME'], '.openx', 'credentials.yml')
+
+      @@connection    = nil
+      @@configuration = nil
+
+      class << self
+        attr_accessor :endpoint, :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    = XMLRPC::Client.new2("#{session.url}#{endpoint}")
+          if id == :all
+            responses = server.call(find_all(), session.id, *args)
+            responses.map { |response|
+              new(translate(response))
+            }
+          else
+            response  = server.call(find_one(), session.id, 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 = XMLRPC::Client.new2("#{self.class.connection.url}#{self.class.endpoint}")
+        #@server.instance_variable_get(:@http).set_debug_output($stderr)
+      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.id, params)
+        else
+          @server.call(self.class.update, session.id, params)
+        end
+        self
+      end
+
+      def destroy
+        session = self.class.connection
+        @server.call(self.class.delete, session.id, id)
+        @id = nil
+      end
+
+      def <=>(other)
+        self.id <=> other.id
+      end
+    end
+  end
+end