bsm-openx 1.9.3 → 1.9.4

data/VERSION

@@ -1 +1 @@
-1.9.3
+1.9.4

data/bsm-openx.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bsm-openx}
-  s.version = "1.9.3"
+  s.version = "1.9.4"
 
   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-13}
+  s.date = %q{2010-09-14}
   s.description = %q{A Ruby interface to the OpenX XML-RPC API}
   s.email = %q{dimitrij@blacksquaremedia.com}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "lib/openx.rb",
      "lib/openx/image.rb",
      "lib/openx/invocation.rb",
+     "lib/openx/persistance.rb",
      "lib/openx/services.rb",
      "lib/openx/services/advertiser.rb",
      "lib/openx/services/agency.rb",
@@ -33,12 +34,11 @@ Gem::Specification.new do |s|
      "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/targeting_rule.rb",
+     "lib/openx/targeting_rules.rb",
      "lib/openx/xmlrpc_client.rb",
      "test/assets/300x250.jpg",
      "test/assets/cat.swf",

data/lib/openx.rb

@@ -1,6 +1,9 @@
 module OpenX
+  autoload :Persistance, 'openx/persistance'
   autoload :Image, 'openx/image'
   autoload :Invocation, 'openx/invocation'
+  autoload :TargetingRule, 'openx/targeting_rule'
+  autoload :TargetingRules, 'openx/targeting_rules'
   autoload :Services, 'openx/services'
   autoload :XmlrpcClient, 'openx/xmlrpc_client'
   autoload :XmlrpcSessionClient, 'openx/xmlrpc_client'

data/lib/openx/persistance.rb

@@ -0,0 +1,63 @@
+module OpenX
+  module Persistance
+
+    module ClassMethods
+
+      def create!(params = {})
+        new(params).save!
+      end
+
+      def find(id, *args)
+        if id == :all
+          responses = remote.call(find_all, *args)
+          responses.map do |response|
+            new(translate(response))
+          end
+        else
+          response  = remote.call(find_one, id)
+          new(translate(response))
+        end
+      end
+
+      def destroy(id)
+        new(:id => id).destroy
+      end
+
+      private
+
+        def translate(response)
+          params    = {}
+          self.translations.each do |k,v|
+            params[k] = response[v.to_s] if response[v.to_s]
+          end
+          params
+        end
+
+    end
+
+    module InstanceMethods
+
+      def save!
+        params = {}
+        self.class.translations.keys.each do |k|
+          value = send(:"#{k}")
+          params[self.class.translations[k].to_s] = value if value
+        end
+
+        if new_record?
+          @id = remote.call(self.class.create, params)
+        else
+          remote.call(self.class.update, params)
+        end
+        self
+      end
+
+      def destroy
+        remote.call(self.class.delete, id)
+        @id = nil
+      end
+
+    end
+
+  end
+end

data/lib/openx/services.rb

@@ -2,7 +2,6 @@ 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'
@@ -12,8 +11,6 @@ module OpenX
     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
 

data/lib/openx/services/banner.rb

@@ -81,12 +81,14 @@ module OpenX
       end
 
       def targeting
-        remote.call('ox.getBannerTargeting', self.id) do |line|
+        raise "Banner must be saved" if new_record?
+        remote.call('ox.getBannerTargeting', self.id).map do |line|
           TargetingRule.instantiate(line)
         end
       end
 
       def targeting=(rules)
+        raise "Banner must be saved" if new_record?
         remote.call('ox.setBannerTargeting', self.id, rules)
       end
     end

data/lib/openx/services/channel.rb

@@ -31,7 +31,7 @@ module OpenX
         end
       end
 
-      # Applied targeting to channel. See OpenX::Services::TargetingRules for details
+      # Applied targeting to channel. See OpenX::TargetingRules for details
       def targeting=(rules)
         raise "Channel must be saved" if new_record?
         remote.call("ox.setChannelTargeting",  self.id, rules)

data/lib/openx/targeting_rule.rb

@@ -0,0 +1,121 @@
+module OpenX
+  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?
+
+    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?(*values)
+      update 'comparison' => '=~', 'data' => convert(values)
+    end
+    alias_method :contains?, :include?
+
+    def exclude?(*values)
+      update 'comparison' => '!~', 'data' => convert(values)
+    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

data/lib/openx/targeting_rules.rb

@@ -0,0 +1,24 @@
+module OpenX
+
+  # Create targeting rule sets. Example:
+  #
+  #    rules = OpenX::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

data/test/helper.rb

@@ -25,8 +25,8 @@ module OpenX
     Advertiser     = OpenX::Services::Advertiser
     Session        = OpenX::Services::Session
     Channel        = OpenX::Services::Channel
-    TargetingRule  = OpenX::Services::TargetingRule
-    TargetingRules = OpenX::Services::TargetingRules
+    TargetingRule  = OpenX::TargetingRule
+    TargetingRules = OpenX::TargetingRules
 
     undef :default_test
 
@@ -110,7 +110,7 @@ module OpenX
     end
 
     def targeting_rules
-      @targeting_rules ||= OpenX::Services::TargetingRules.new do |t|
+      @targeting_rules ||= OpenX::TargetingRules.new do |t|
         t['Site:Pageurl'].include?('test') &
         t['Client:Ip'].match?(/^127\./) |
         t['Geo:Country'].include?('GB', 'US')

data/test/test_targeting_rule.rb

@@ -41,7 +41,6 @@ class TargetingRuleTest < OpenX::TestCase
   end
 
   test "comparisons" do
-    assert_equal({"logical"=>"and", "type"=>"Geo:Region", "comparison"=>"==", "data" => "GB|H9"}, new_rule == 'GB|H9')
     assert_equal({"logical"=>"and", "type"=>"Geo:Region", "comparison"=>"==", "data" => "GB|H9"}, new_rule.eq?('GB|H9'))
     assert_equal({"logical"=>"and", "type"=>"Geo:Region", "comparison"=>"==", "data" => "GB|H9"}, new_rule.equal?('GB|H9'))
     assert_equal({"logical"=>"and", "type"=>"Geo:Region", "comparison"=>"==", "data" => "GB|H9"}, new_rule.is?('GB|H9'))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bsm-openx
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 59
   prerelease: false
   segments: 
   - 1
   - 9
-  - 3
-  version: 1.9.3
+  - 4
+  version: 1.9.4
 platform: ruby
 authors: 
 - Aaron Patterson
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-13 00:00:00 +01:00
+date: 2010-09-14 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,7 @@ files:
 - lib/openx.rb
 - lib/openx/image.rb
 - lib/openx/invocation.rb
+- lib/openx/persistance.rb
 - lib/openx/services.rb
 - lib/openx/services/advertiser.rb
 - lib/openx/services/agency.rb
@@ -48,12 +49,11 @@ files:
 - 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/targeting_rule.rb
+- lib/openx/targeting_rules.rb
 - lib/openx/xmlrpc_client.rb
 - test/assets/300x250.jpg
 - test/assets/cat.swf

data/lib/openx/services/persistance.rb

@@ -1,64 +0,0 @@
-module OpenX
-  module Services
-    module Persistance
-
-      module ClassMethods
-
-        def create!(params = {})
-          new(params).save!
-        end
-
-        def find(id, *args)
-          if id == :all
-            responses = remote.call(find_all, *args)
-            responses.map do |response|
-              new(translate(response))
-            end
-          else
-            response  = remote.call(find_one, id)
-            new(translate(response))
-          end
-        end
-
-        def destroy(id)
-          new(:id => id).destroy
-        end
-
-        private
-
-          def translate(response)
-            params    = {}
-            self.translations.each do |k,v|
-              params[k] = response[v.to_s] if response[v.to_s]
-            end
-            params
-          end
-
-      end
-
-      module InstanceMethods
-
-        def save!
-          params = {}
-          self.class.translations.keys.each do |k|
-            value = send(:"#{k}")
-            params[self.class.translations[k].to_s] = value if value
-          end
-
-          if new_record?
-            @id = remote.call(self.class.create, params)
-          else
-            remote.call(self.class.update, params)
-          end
-          self
-        end
-
-        def destroy
-          remote.call(self.class.delete, id)
-          @id = nil
-        end
-
-      end
-    end
-  end
-end

data/lib/openx/services/targeting_rule.rb

@@ -1,125 +0,0 @@
-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?(*values)
-        update 'comparison' => '=~', 'data' => convert(values)
-      end
-      alias_method :contains?, :include?
-
-      def exclude?(*values)
-        update 'comparison' => '!~', 'data' => convert(values)
-      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

@@ -1,26 +0,0 @@
-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