jjp-openx 1.1.4 → 1.1.6

data/History.txt

@@ -22,3 +22,46 @@
 === 1.1.2 / 2009-11-19
 
 * Documentation updates and patch to enable banner support on the OpenX Server
+
+=== 1.1.4 / 2010-04-17
+
+* Fork of 1.1.2
+
+  * Added statistic methods for Banner:
+  
+    * renamed statistics method into daily_statistics, left statistics method as an alias for daily_statistics
+    * daily_statistics(start_on = Date.today, end_on = Date.today) - Daily stats for the Banner
+    * publisher_statistics(start_on = Date.today, end_on = Date.today) - Banner stats by Publisher
+    * zone_statistics(start_on = Date.today, end_on = Date.today) - Banner stats by Zone
+
+=== 1.1.5 / 2010-05-18
+
+* Created generic statistics method:
+
+  * get_statistics(service_method, start_on = Date.today, end_on = Date.today, local_time_zone = true) in sepearate module OpenX::Services::Statistics in file statistics.rb
+  * included statistics module in all stats objects: Agency, Advertiser, Campaign, Banner, Publisher, Zone.
+  * all existing statistics methods are now calling get_statistics.
+
+* Added to statistics methods localTZ parameter default to true. This way OpenX will return stats for the period of time with offset according to the local time zone. If that parameter is false it will give numbers for UTC. The localTZ implementation based only on that post http://forum.openx.org/index.php?s=18f1d84f86e32297083f87f8d9eb4fda&showtopic=503433151
+  
+  * statistics
+  * daily_statistics
+  * publisher_statistics
+  * zone_statistics
+  
+* Added statistics methods for other objects as well
+  
+  * Agency
+  * Advertiser
+  * Campaign
+  * Banner
+  * Publisher
+  
+    * daily_statistics
+    * banner_statistics
+  
+  * Zone
+  
+=== 1.1.6 / 2010-05-18
+
+* lib/openx/services/statistic.rb file was missing on github while building gemspec, so the version 1.1.5 is actually broken.

data/README.rdoc

@@ -5,7 +5,7 @@
 
 == Description
 
-A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/
+A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/ . It also works with v2 of OpenX API, especially that it now can pass localTZ to the OpenX API which will give back the correct statistics for the local time zone.
 
 == Synopsis
 

data/Rakefile

@@ -8,7 +8,7 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "jjp-openx"
     gemspec.summary = "A Ruby interface to the OpenX XML-RPC API with more OpenX APIs used"
-    gemspec.description = "A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/"
+    gemspec.description = "A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/ . It also works with v2 of OpenX API, especially that it now can pass localTZ to the OpenX API which will give back the correct statistics for the local time zone."
     gemspec.email = "jacobjp@mac.com"
     gemspec.homepage = "http://github.com/DoppioJP/openx"
     gemspec.authors = ["Aaron Patterson", "Andy Smith", "TouchLocal Plc", "DoppioJP"]

data/VERSION

@@ -1 +1 @@
-1.1.4
+1.1.6

data/jjp-openx.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jjp-openx}
-  s.version = "1.1.4"
+  s.version = "1.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Patterson", "Andy Smith", "TouchLocal Plc", "DoppioJP"]
-  s.date = %q{2010-04-18}
-  s.description = %q{A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/}
+  s.date = %q{2010-05-19}
+  s.description = %q{A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/ . It also works with v2 of OpenX API, especially that it now can pass localTZ to the OpenX API which will give back the correct statistics for the local time zone.}
   s.email = %q{jacobjp@mac.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -34,6 +34,7 @@ Gem::Specification.new do |s|
      "lib/openx/services/campaign.rb",
      "lib/openx/services/publisher.rb",
      "lib/openx/services/session.rb",
+     "lib/openx/services/statistics.rb",
      "lib/openx/services/zone.rb",
      "lib/openx/xmlrpc_client.rb",
      "php/openx-2.8.1-keywords.diff",

data/lib/openx/invocation.rb

@@ -1,14 +1,27 @@
 module OpenX
   class Invocation
     class << self
+      # Whatever
+      #   banner = OpenX::Invocation.view("Plumber")
       #
-      # banner = OpenX::Invocation.view("Plumber")
+      #   banners = OpenX::Invocation.view("Plumber", :count => 2, :exclude_by_campaignid => true) ;nil
       #
-      # banners = OpenX::Invocation.view("Plumber", :count => 2, :exclude_by_campaignid => true) ;nil
-      # banners.each do |banner|
-      #   puts "Banner #{banner['bannerid']}"
-      # end; nil
+      #   banners.each do |banner|
+      #     puts "Banner #{banner['bannerid']}"
+      #   end; nil
       #
+      #
+      # Defaults
+      #   :count => 1,
+      #   :campaignid => 0,
+      #   :target => '',
+      #   :source => '',
+      #   :with_text => false,
+      #   :exclusions => [],
+      #   :inclusions => [],
+      #   :exclude_by_campaignid => false,
+      #   :exclude_by_bannerid => false
+      # 
       def view(what, params = {})
         defaults = {
           :count => 1,

data/lib/openx/services/advertiser.rb

@@ -1,6 +1,10 @@
 module OpenX
   module Services
     class Advertiser < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       openx_accessor :name          => :advertiserName,
                      :contact_name  => :contactName,
                      :email         => :emailAddress,

data/lib/openx/services/agency.rb

@@ -1,6 +1,10 @@
 module OpenX
   module Services
     class Agency < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       # Translate our property names to OpenX property names
       openx_accessor  :name          => :agencyName,
                       :contact_name  => :contactName,

data/lib/openx/services/banner.rb

@@ -3,6 +3,10 @@ require 'date'
 module OpenX
   module Services
     class Banner < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       LOCAL_SQL = 'sql'
       LOCAL_WEB = 'web'
       EXTERNAL  = 'url'
@@ -11,7 +15,7 @@ module OpenX
 
       RUNNING = 0
       PAUSED  = 1
-
+      
       class << self
         def find(id, *args)
           session   = self.connection
@@ -77,32 +81,29 @@ module OpenX
         super(params)
       end
 
-      # Alias for daily_statistics method to keep consistency with OpenX API calls
-      # Originally it was call for ox.bannerDailyStatistics so it is kept for compatibility with the previous version
-      def statistics start_on = Date.today, end_on = Date.today
-        daily_statistics start_on, end_on
+      # Alias for daily_statistics method to keep consistency with OpenX API calls. 
+      # Originally it was call for ox.bannerDailyStatistics so it is kept for compatibility with the previous version of the gem.
+      def statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        daily_statistics start_on, end_on, local_time_zone
       end
       
-      # Returns statistics in Array of Hashes by day, which are: impressions, clicks, requests and revenue.
+      # Returns statistics in Array of Hashes by day, which are: impressions, clicks, requests and revenue. 
       # Each day is represented by XMLRPC::DateTime which has instant variables:
       # @year, @month, @day, @hour, @min, @sec
-      def daily_statistics start_on = Date.today, end_on = Date.today
-        session = self.class.connection
-        @server.call('ox.bannerDailyStatistics', session, self.id, start_on, end_on)
+      def daily_statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        self.get_statistics('ox.bannerDailyStatistics', start_on, end_on, local_time_zone)
       end
       
       # Returns statistics in Array of Hashes by publisher, which are: impression, clicks, requests and revenue.
       # Also returns publisherName and publisherId
-      def publisher_statistics start_on = Date.today, end_on = Date.today
-        session = self.class.connection
-        @server.call('ox.bannerPublisherStatistics', session, self.id, start_on, end_on)
+      def publisher_statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        self.get_statistics('ox.bannerPublisherStatistics', start_on, end_on, local_time_zone)
       end
 
       # Returns statistics in Array of Hashes by zone, which are: impression, clicks, requests, conversions and revenue.
       # Also returns publisherName, publisherId, zoneName, zoneId
-      def zone_statistics start_on = Date.today, end_on = Date.today
-        session = self.class.connection
-        @server.call('ox.bannerZoneStatistics', session, self.id, start_on, end_on)
+      def zone_statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        self.get_statistics('ox.bannerZoneStatistics', start_on, end_on, local_time_zone)
       end
 
       def targeting

data/lib/openx/services/campaign.rb

@@ -1,6 +1,10 @@
 module OpenX
   module Services
     class Campaign < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       # Translate our property names to OpenX property names
       openx_accessor  :name               => :campaignName,
                       :advertiser_id      => :advertiserId,
@@ -27,7 +31,7 @@ module OpenX
       self.find_all = 'ox.getCampaignListByAdvertiserId'
 
       # Revenue types
-      CPM             = 1
+      CPM             = 1 
       CPC             = 2
       CPA             = 3
       MONTHLY_TENANCY = 4
@@ -37,12 +41,14 @@ module OpenX
       HIGH      = 2
       EXCLUSIVE = 3
 
+      # Creates new Campaign for the given Advertiser.id required in params[:advertiser_id] or params[:advertiser]
       def initialize(params = {})
         raise ArgumentError.new("Missing advertiser_id") unless params[:advertiser_id] || params[:advertiser]
         params[:advertiser_id] ||= params[:advertiser].id
         super(params)
       end
 
+      # Return all banners for the Campaign
       def banners
         Banner.find(:all, self.id)
       end

data/lib/openx/services/publisher.rb

@@ -1,6 +1,10 @@
 module OpenX
   module Services
     class Publisher < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       openx_accessor :name          => :publisherName,
                      :contact_name  => :contactName,
                      :email         => :emailAddress,
@@ -26,6 +30,18 @@ module OpenX
       def zones
         Zone.find(:all, self.id)
       end
+      
+      # Returns statistics in Array of Hashes by day, which are: impression, clicks, requests and revenue.
+      def daily_statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        self.get_statistics('ox.publisherDailyStatistics', start_on, end_on, local_time_zone)
+      end
+
+      # Returns statistics in Array of Hashes by banner, which are: impression, clicks, requests and revenue.
+      # Also returns bannerName, bannerId, advertiserName, advertiserId, campaignName, campaignId
+      def banner_statistics start_on = Date.today, end_on = Date.today, local_time_zone = true
+        self.get_statistics('ox.publisherBannerStatistics', start_on, end_on, local_time_zone)
+      end
+      
     end
   end
 end

data/lib/openx/services/statistics.rb

@@ -0,0 +1,25 @@
+module OpenX
+  module Services
+    module Statistics
+      
+      # Generic method to get statistics.
+      # - +service_method+ - The name of the OpenX API service method to be called.
+      # - +start_on+ - When date range starts for stats request. OpenX parameter +oStartDate+ which ignores time part of it.
+      # - +end_on+ - When date range ends for stats request. OpenX parameter +oEndDate+ which ignores time part of it.
+      # - +local_time_zone+ - For v2 of OpenX API only which will respect the local Time Zone. OpenX parameter +localTZ+.
+      #
+      # With such generic method the gem is able to get any statistics available from the OpenX API, 
+      # because all those statistics methods have the same call format.
+      def get_statistics service_method, start_on = Date.today, end_on = Date.today, local_time_zone = true
+        session = self.class.connection
+        
+        # For compatibility with v1 of OpenX API.
+        if OpenX::Services::Base.configuration["url"].include?("/v1/")
+          @server.call(service_method, session, self.id, start_on, end_on)
+        else
+          @server.call(service_method, session, self.id, start_on, end_on, local_time_zone)
+        end
+      end
+    end
+  end
+end

data/lib/openx/services/zone.rb

@@ -1,6 +1,10 @@
 module OpenX
   module Services
     class Zone < Base
+
+      require 'openx/services/statistics'
+      include OpenX::Services::Statistics
+
       # Delivery types
       BANNER        = 'delivery-b'
       INTERSTITIAL  = 'delivery-i'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 1
-  - 4
-  version: 1.1.4
+  - 6
+  version: 1.1.6
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -17,11 +17,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-18 00:00:00 +01:00
+date: 2010-05-19 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/
+description: A Ruby interface to the OpenX XML-RPC API. Used touchlocal 1.1.2 version as base for adding more API calls to OpenX API from http://developer.openx.org/api/ . It also works with v2 of OpenX API, especially that it now can pass localTZ to the OpenX API which will give back the correct statistics for the local time zone.
 email: jacobjp@mac.com
 executables: []
 
@@ -48,6 +48,7 @@ files:
 - lib/openx/services/campaign.rb
 - lib/openx/services/publisher.rb
 - lib/openx/services/session.rb
+- lib/openx/services/statistics.rb
 - lib/openx/services/zone.rb
 - lib/openx/xmlrpc_client.rb
 - php/openx-2.8.1-keywords.diff