touchlocal-openx 1.1.1 → 1.1.2

data/History.txt

@@ -4,3 +4,21 @@
 
   * Birthday!
 
+=== 1.1.0 / 2009-10-26
+
+* 2 major enhancements
+
+  * OpenX API Version 2 Support added
+  * OpenX Invocation API Support added
+
+* 1 minor enhancement
+
+  * Ruby on Rails documentation support added
+
+=== 1.1.1 / 2009-11-06
+
+* Minor bugfix to environment handling for Win32 users
+
+=== 1.1.2 / 2009-11-19
+
+* Documentation updates and patch to enable banner support on the OpenX Server

data/{README.txt → README.rdoc}

@@ -1,12 +1,13 @@
-= openx
+= OpenX
 
-* http://openx.rubyforge.org
+* http://gemcutter.org/gems/touchlocal-openx
+* http://github.com/touchlocal/openx
 
-== DESCRIPTION:
+== Description
 
 A Ruby interface to the OpenX XML-RPC API.
 
-== SYNOPSIS:
+== Synopsis
 
   OpenX::Services::Base.configuration = {
     'username'  => 'admin',
@@ -26,35 +27,35 @@ A Ruby interface to the OpenX XML-RPC API.
     Publisher.create!(
       :agency       => agency,
       :name         => 'My Test Publisher',
-      :contact_name => 'Aaron Patterson',
-      :email        => 'aaron@tenderlovemaking.com',
+      :contact_name => 'My Contact',
+      :email        => 'agency@example.com',
       :username     => 'user',
       :password     => 'password'
     )
   end
 
-== REQUIREMENTS:
+== Requirements
 
 * ruby
 
-== INSTALL:
+== Install
 
-* sudo gem install openx
+* sudo gem install touchlocal-openx --source "http://gemcutter.org"
+* add "require 'openx'" to your code
 * Update your $HOME/.openx/credentials.yml file.  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
+    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
 
-== RUBY ON RAILS INTEGRATION
+== Ruby on Rails Integration
 
 As common deployment scenarios for RoR projects dictates that you manage all
 of your dependent files from within your project, storing your credentials.yml
@@ -73,13 +74,42 @@ Then, add your gem require line to the initialize block of the environment.rb:
 You will of course need to install the gem, either manually or via 
 rake gems:install
 
-Finally, create a config/initializers/openx.rb and include the following line:
+Finally, create a config/initializers/openx.rb and include the following:
 
+  require 'yaml'
   OpenX::Services::Base.configuration = 
     YAML.load_file(File.join(Rails.root, 'config', 'credentials.yml'))[Rails.env]
 
 
-== LICENSE:
+== Banner Keyword Support
+
+Not all attributes of OpenX objects that can be set in the web interface are 
+accessible via the API. A notable case of this is the ability to access 
+Banner Keywords. While it seems to be a case of "We'll add them as people 
+need them," this process is slower than one might expect; 
+https://developer.openx.org/jira/browse/OX-4779 has been an open ticket since 
+January 2009.
+
+As TouchLocal required the ability to access Banner Keywords, the 
+OpenX::Services::Banner object has the support for this attribute. If the 
+server does not support the attribute, then setting it will have no effect, 
+and it will return nil when retrieving it. To enable support on the server, 
+you will need access to the server source, and the included 
+php/openx-2.8.1-keywords.diff
+
+Copy the openx-2.8.1-keywords.diff file to the root of the OpenX distribution 
+on your server, and execute:
+
+    patch -p0 < openx-2.8.1-keywords.diff
+
+This will patch the relevant OpenX API to allow access to the keyword 
+attribute, meaning that now both your client and server support it. Happy days.
+
+This patch has been tested on OpenX Server versions 2.8.1 and 2.8.2 at the 
+time of writing.
+
+
+== License
 
 (The MIT License)
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/openx/invocation.rb

@@ -25,6 +25,7 @@ module OpenX
         
         url = OpenX::Services::Base.configuration['invocation_url']
 
+        # Basic requirement as per /lib/max/Delivery/XML-RPC.php in OpenX
         settings = {:cookies => [], :remote_addr => 'localhost'}
         
         context = [] # used by reference after initial use

data/lib/openx/services/banner.rb

@@ -59,7 +59,7 @@ module OpenX
                       :image          => :aImage,
                       :backup_image   => :aBackupImage,
                       # 'keyword' only supported by patched server
-                      # as per https://developer.openx.org/jira/browse/OX-4779
+                      # as per README.rdoc
                       # No averse effect when unsupported by server (returns nil)
                       :keyword        => :keyword
 

data/lib/openx/services/base.rb

@@ -12,7 +12,9 @@ module OpenX
       #   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
+      # 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

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/touchlocal-openx.gemspec

@@ -5,21 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{touchlocal-openx}
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Patterson", "Andy Smith", "TouchLocal Plc"]
-  s.date = %q{2009-11-06}
+  s.date = %q{2009-11-19}
   s.description = %q{A Ruby interface to the OpenX XML-RPC API}
   s.email = %q{info@touchlocal.com}
   s.extra_rdoc_files = [
-    "README.txt"
+    "README.rdoc"
   ]
   s.files = [
     ".gitignore",
      "History.txt",
      "Manifest.txt",
-     "README.txt",
+     "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/openx.rb",
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "lib/openx/services/session.rb",
      "lib/openx/services/zone.rb",
      "lib/openx/xmlrpc_client.rb",
+     "php/openx-2.8.1-keywords.diff",
      "test/assets/300x250.jpg",
      "test/assets/cat.swf",
      "test/helper.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: touchlocal-openx
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 +10:00
+date: 2009-11-19 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -22,12 +22,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 files: 
 - .gitignore
 - History.txt
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - VERSION
 - lib/openx.rb
@@ -43,6 +43,7 @@ files:
 - lib/openx/services/session.rb
 - lib/openx/services/zone.rb
 - lib/openx/xmlrpc_client.rb
+- php/openx-2.8.1-keywords.diff
 - test/assets/300x250.jpg
 - test/assets/cat.swf
 - test/helper.rb