francois-ad_gear_client 0.1.1 → 0.2.0

data/Rakefile

@@ -113,5 +113,17 @@ namespace :test do
 end
 
 task :shell do
-  sh "irb -Ilib:vendor/activeresource/lib:vendor/activemodel/lib:vendor/activesupport/lib -rad_gear"
+  require "pp"
+  FileList["vendor/*/lib"].each do |path|
+    $LOAD_PATH.unshift path
+  end
+  $LOAD_PATH.unshift "lib"
+
+  require "ad_gear"
+  AdGear.config = AdGear::Config.new("examples/ad_gear.yml", "development")
+
+  require "irb"
+  ARGV.clear
+  include AdGear
+  IRB.start
 end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/ad_gear_client.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ad_gear_client}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Fran\303\247ois Beausoleil"]
-  s.date = %q{2009-08-12}
+  s.authors = ["François Beausoleil"]
+  s.date = %q{2009-09-02}
   s.email = %q{francois@teksol.info}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
      "ad_gear_client.gemspec",
      "examples/.gitignore",
      "examples/ad_gear.yml.sample",
+     "examples/create_placement.rb",
      "examples/prelude.rb",
      "examples/read_write_site.rb",
      "examples/upload_file_to_ad_unit.rb",
@@ -32,6 +33,7 @@ Gem::Specification.new do |s|
      "lib/ad_gear/ad_unit_file.rb",
      "lib/ad_gear/ad_unit_interaction.rb",
      "lib/ad_gear/ad_unit_variable.rb",
+     "lib/ad_gear/advertiser.rb",
      "lib/ad_gear/base.rb",
      "lib/ad_gear/campaign.rb",
      "lib/ad_gear/click.rb",
@@ -40,6 +42,10 @@ Gem::Specification.new do |s|
      "lib/ad_gear/format.rb",
      "lib/ad_gear/has_many_array.rb",
      "lib/ad_gear/interaction.rb",
+     "lib/ad_gear/placement_membership.rb",
+     "lib/ad_gear/placement_rule.rb",
+     "lib/ad_gear/publisher.rb",
+     "lib/ad_gear/publisher_placement.rb",
      "lib/ad_gear/site.rb",
      "lib/ad_gear/template.rb",
      "lib/ad_gear/upload.rb",
@@ -48,25 +54,29 @@ Gem::Specification.new do |s|
      "lib/core_ext.rb",
      "test/ad_gear/ad_spot_test.rb",
      "test/ad_gear/config_test.rb",
+     "test/ad_gear/placement_rule_test.rb",
      "test/ad_gear/site_test.rb",
      "test/ad_gear/upload_test.rb",
      "test/ad_gear_test.rb",
      "test/fixtures/access-denied-no-auth.txt",
      "test/test_helper.rb"
   ]
+  s.has_rdoc = true
   s.homepage = %q{http://github.com/francois/ad_gear_client}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{ad_gear_client}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.1}
   s.summary = %q{A Ruby client for accessing AdGear http://bloomdigital.com/}
   s.test_files = [
     "test/ad_gear/ad_spot_test.rb",
      "test/ad_gear/config_test.rb",
+     "test/ad_gear/placement_rule_test.rb",
      "test/ad_gear/site_test.rb",
      "test/ad_gear/upload_test.rb",
      "test/ad_gear_test.rb",
      "test/test_helper.rb",
+     "examples/create_placement.rb",
      "examples/prelude.rb",
      "examples/read_write_site.rb",
      "examples/upload_file_to_ad_unit.rb"
@@ -74,7 +84,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+    s.specification_version = 2
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<lsegal-yard>, [">= 0.2.3"])

data/examples/create_placement.rb

@@ -0,0 +1,49 @@
+require "prelude"
+
+begin
+  publishers      = AdGear::Publisher.find(:all)
+  publisher       = publishers.detect(&:active?)
+  assert_not_nil publisher, "Missing a Publisher"
+
+  formats         = AdGear::Format.find(:all)
+  format          = formats.first
+  assert_not_nil format, "Missing a Format"
+
+  campaigns       = AdGear::Campaign.find(:all)
+  campaign        = campaigns.first
+  assert_not_nil campaign, "Missing a Campaign"
+
+  ad_units        = AdGear::AdUnit.find(:all)
+  active_ad_units = ad_units.select(&:active?)
+  assert active_ad_units.any?, "No active AdUnits available"
+
+  placement = AdGear::PublisherPlacement.new(
+    :campaign            => campaign,
+    :format              => format,
+    :selection_mechanism => "rotated",
+    :name                => "Snow Leopard for a week",
+    :start_at            => 3.days.from_now,
+    :end_at              => 7.days.from_now,
+    :placement_rules     => [
+      AdGear::PlacementRule.new(:kind => "PlacementInclusion", :bookable => publisher)],
+    :placement_memberships => [
+      AdGear::PlacementMembership.new(:selection_attribute => "1", :ad_unit => active_ad_units[0]),
+      AdGear::PlacementMembership.new(:selection_attribute => "2", :ad_unit => active_ad_units[1])])
+  placement.save
+
+  placement = AdGear::PublisherPlacement.new(
+    :campaign            => campaign,
+    :format              => format,
+    :selection_mechanism => "weighted",
+    :name                => "BMW M5",
+    :start_at            => 3.days.from_now,
+    :end_at              => 7.days.from_now,
+    :placement_rules     => [
+      AdGear::PlacementRule.new(:kind => "PlacementInclusion", :bookable => publisher)],
+    :placement_memberships => [
+      AdGear::PlacementMembership.new(:selection_attribute => "30", :ad_unit => active_ad_units[0]),
+      AdGear::PlacementMembership.new(:selection_attribute => "70", :ad_unit => active_ad_units[1])])
+  placement.save
+rescue ActiveResource::BadRequest => e
+  p ActiveResource::Formats[:xml].decode(e.response.body)
+end

data/examples/read_write_site.rb

@@ -1,19 +1,22 @@
 require "prelude"
 
-p AdGear::Site.find(:all)
+begin
+  formats = AdGear::Format.find(:all)
+  p formats
 
-formats = AdGear::Format.find(:all)
-site = AdGear::Site.new(:name => "XLsuite", :url => "http://xlsuite.com/", :ad_spots => [{:format_id => formats.first.id, :name => "sidebar top"}])
-site.ad_spots << AdGear::AdSpot.new(:format_id => formats.first.id, :name => "homepage banner")
+  sites = AdGear::Site.find(:all)
+  p sites
+
+  site = AdGear::Site.new(:name => "XLsuite", :url => "http://xlsuite.com/", :ad_spots => [{:format_id => formats.first.id, :name => "sidebar top"}])
+  site.ad_spots << AdGear::AdSpot.new(:format_id => formats.first.id, :name => "homepage banner")
 
-begin
   p site.new?
   p site.save
   p site.new?
   p "Saved"
 
-  p site.embed_code
-  p site.ad_spots
+  pp site.embed_code
+  pp site.ad_spots
 
   p site.ad_spots.class
 
@@ -21,6 +24,11 @@ begin
   site.ad_spots.detect {|as| as.name == "homepage banner"}.name = "home page banner"
   assert_equal 3, site.ad_spots.length, site.to_xml
 
+  ad_spot = AdGear::AdSpot.new(:format_id => formats.first.id, :name => "east", :site_id => site.id)
+  assert ad_spot.save, "Could not save new AdSpot"
+  site = AdGear::Site.find(site.id) # TODO: Support #reload
+  assert site.ad_spots.detect {|as| as.name == "east"}, "Could not find new AdSpot linked to old site"
+
   puts site.to_xml
   site.save
 
@@ -28,5 +36,4 @@ begin
   assert_equal 3, site.ad_spots.length, site.to_xml
 rescue ActiveResource::BadRequest => e
   p ActiveResource::Formats[:xml].decode(e.response.body)
-  p "Could not save"
 end

data/lib/ad_gear/ad_unit.rb

@@ -2,5 +2,13 @@ module AdGear
   class AdUnit < AdGear::Base
     has_many :ad_unit_files, :ad_unit_clicks, :ad_unit_interactions, :ad_unit_variables
     belongs_to :campaign, :format
+
+    def active?
+      state == "active"
+    end
+
+    def deleted?
+      state == "deleted"
+    end
   end
 end

data/lib/ad_gear/advertiser.rb

@@ -0,0 +1,4 @@
+module AdGear
+	class Advertiser < AdGear::Base
+	end
+end

data/lib/ad_gear/base.rb

@@ -1,17 +1,10 @@
 module AdGear
   class Base < ActiveResource::Base
     def initialize(params={})
-      params = params.inject(Hash.new) do |memo, (name, value)|
-        name = name.to_s
-        if self.class.belongs_to_associations.include?(name) then
-          name       = self.class.belongs_to_attribute_name_for(name)
-          value      = self.class.unpack_belongs_to_association(value)
-        end
-
-        memo[name] = value
-        memo
+      super({})
+      params.each do |key, value|
+        send("#{key}=", value)
       end
-      super(params)
     end
 
     # Declares a relationship where we store the ID, but accept and/or return the full object.
@@ -19,22 +12,30 @@ module AdGear
     # @example
     #   class AdGear::AdSpot < AdGear::Base
     #     belongs_to :format
+    #     belongs_to :bookable, :polymorphic => true
     #   end
     #
-    #   AdGear::AdSpot.new(:format => Format.find(1)).attributes
-    #     #=> {"format_id" => 1}
+    #   include AdGear
+    #   AdSpot.new(:format => Format.find(1), :bookable => Publisher.find(2)).attributes
+    #     #=> {"format_id" => 1, "bookable_id" => 2, "bookable_type" => "Publisher"}
     def self.belongs_to(*attributes)
-      attributes.flatten.compact.each do |attribute|
+      options = attributes.extract_options!
+      attributes.each do |attribute|
         attribute_name = attribute.to_s
-        belongs_to_associations << attribute_name
-
-        belongs_to_attribute_writer_for(attribute_name)
-        belongs_to_attribute_reader_for(attribute_name)
+        belongs_to_associations[attribute_name] = options
+
+        if options[:polymorphic] then
+          polymorphic_belongs_to_attribute_writer_for(attribute_name)
+          polymorphic_belongs_to_attribute_reader_for(attribute_name)
+        else
+          belongs_to_attribute_writer_for(attribute_name)
+          belongs_to_attribute_reader_for(attribute_name)
+        end
       end
     end
 
     def self.belongs_to_associations #:nodoc:
-      @belongs_to_associations ||= []
+      @belongs_to_associations ||= {}
     end
 
     # Defines a managed sub-collection.  Elements managed through a #has_many are
@@ -69,7 +70,15 @@ module AdGear
         define_method(collection_name) do
           arr = @attributes[collection_name]
           return arr if arr.kind_of?(AdGear::HasManyArray)
-          @attributes[collection_name] = AdGear::HasManyArray.new(collection_name.to_sym, arr)
+          @attributes[collection_name] = AdGear::HasManyArray.new(collection_name.to_sym, AdGear.const_get(collection_name.classify), arr)
+        end
+
+        define_method("#{collection_name}=") do |arr|
+          @attributes[collection_name] = if arr.kind_of?(AdGear::HasManyArray) then
+                                           arr
+                                         else
+                                           AdGear::HasManyArray.new(collection_name.to_sym, AdGear.const_get(collection_name.classify), arr)
+                                         end
         end
       end
     end
@@ -120,25 +129,40 @@ module AdGear
 
     private
 
+    def self.polymorphic_belongs_to_attribute_writer_for(attribute_name) #:nodoc:
+      define_method("#{attribute_name}=") do |value|
+        @attributes[self.class.belongs_to_attribute_name_for_id(attribute_name)]    = value ? value.id : nil
+        @attributes[self.class.belongs_to_attribute_name_for_class(attribute_name)] = value ? value.class.name.demodulize : nil
+      end
+    end
+
+    def self.polymorphic_belongs_to_attribute_reader_for(attribute_name) #:nodoc:
+      define_method(attribute_name) do
+        klass = @attributes[belongs_to_attribute_name_for_class(attribute_name)]
+        id    = @attributes[belongs_to_attribute_name_for_id(attribute_name)]
+        id.blank? ? nil : AdGear.const_get(AdGear.const_get(klass)).find(id)
+      end
+    end
+
     def self.belongs_to_attribute_writer_for(attribute_name) #:nodoc:
       define_method("#{attribute_name}=") do |value|
-        @attributes[self.class.belongs_to_attribute_name_for(attribute_name)] = self.class.unpack_belongs_to_association(value)
+        @attributes[self.class.belongs_to_attribute_name_for_id(attribute_name)] = value ? value.id : nil
       end
     end
 
     def self.belongs_to_attribute_reader_for(attribute_name) #:nodoc:
       define_method(attribute_name) do
-        id = @attributes[belongs_to_attribute_name_for(attribute_name)]
+        id = @attributes[belongs_to_attribute_name_for_id(attribute_name)]
         id.blank? ? nil : AdGear.const_get(attribute_name.classify).find(id)
       end
     end
 
-    def self.belongs_to_attribute_name_for(association_name)
-      "#{association_name}_id"
+    def self.belongs_to_attribute_name_for_class(association_name)
+      "#{association_name}_type"
     end
 
-    def self.unpack_belongs_to_association(value)
-      value ? value.id : nil
+    def self.belongs_to_attribute_name_for_id(association_name)
+      "#{association_name}_id"
     end
   end
 end

data/lib/ad_gear/has_many_array.rb

@@ -2,8 +2,9 @@ module AdGear
   class HasManyArray
     include Enumerable
 
-    def initialize(name, saved=nil)
+    def initialize(name, klass, saved=nil)
       @name  = name.to_s.singularize.dasherize + "-attributes"
+      @klass = klass
       @new   = []
       @saved = []
       saved.each do |obj|
@@ -12,8 +13,15 @@ module AdGear
     end
 
     def <<(object)
-      is_new = object.respond_to?(:new_record?) && object.new_record?
-      root   = is_new ? @new : @saved
+      root = if object.kind_of?(Hash) then
+               # Instantiate an object from the Hash, which will obviously be a new object
+               object = @klass.new(object)
+               @new
+             elsif object.respond_to?(:new_record?) && object.new_record?
+               @new
+             else
+               @saved
+             end
       root << object
     end
 

data/lib/ad_gear/placement_membership.rb

@@ -0,0 +1,5 @@
+module AdGear
+	class PlacementMembership < AdGear::Base
+		belongs_to :ad_unit
+	end
+end

data/lib/ad_gear/placement_rule.rb

@@ -0,0 +1,5 @@
+module AdGear
+	class PlacementRule < AdGear::Base
+    belongs_to :bookable, :polymorphic => true
+	end
+end

data/lib/ad_gear/publisher.rb

@@ -0,0 +1,7 @@
+module AdGear
+  class Publisher < AdGear::Base
+    def active?
+      state == "active"
+    end
+  end
+end

data/lib/ad_gear/publisher_placement.rb

@@ -0,0 +1,26 @@
+module AdGear
+  class PublisherPlacement < AdGear::Base
+		belongs_to :campaign, :format
+		has_many :placement_rules, :placement_memberships
+
+		def selection_mechanism
+			case value = attributes["selection_mechanism"]
+			when "R" ; "rotated"
+			when "W" ; "weighted"
+			else     ; value
+			end
+		end
+
+		def selection_mechanism=(value)
+			case value
+			when /^r/i
+				attributes["selection_mechanism"] = "R"
+			when /^w/i
+				attributes["selection_mechanism"] = "W"
+			else
+				# Assign whatever we received, and hope for the best
+				attributes["selection_mechanism"] = value
+			end
+		end
+  end
+end

data/lib/ad_gear.rb

@@ -38,6 +38,12 @@ module AdGear
   autoload :Campaign, "ad_gear/campaign"
   autoload :Format, "ad_gear/format"
   autoload :Upload, "ad_gear/upload"
+  autoload :Publisher, "ad_gear/publisher"
+
+  # Placements and it's dependencies
+  autoload :PublisherPlacement, "ad_gear/publisher_placement"
+  autoload :PlacementRule, "ad_gear/placement_rule"
+  autoload :PlacementMembership, "ad_gear/placement_membership"
 
   # AdUnits and it's child models
   autoload :AdUnit, "ad_gear/ad_unit"

data/test/ad_gear/placement_rule_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+
+class AdGear::PublisherPlacementTest < Test::Unit::TestCase
+  def setup
+    super
+    AdGear.config = OpenStruct.new(:site => "http://test.host", :format => :xml)
+  end
+
+  def teardown
+    AdGear::Base.site = nil
+    super
+  end
+
+	should "polymorphically assign the bookable" do
+		publisher = AdGear::Publisher.new
+		publisher.stubs(:id).returns(42)
+
+		rule = AdGear::PlacementRule.new(:bookable => publisher)
+		assert_equal "Publisher", rule.bookable_type
+		assert_equal 42, rule.bookable_id
+	end
+end

data/test/ad_gear/upload_test.rb

@@ -12,15 +12,16 @@ class AdGear::UploadTest < Test::Unit::TestCase
   end
 
   should "upload the data using RestClient" do
-		xml = Builder::XmlMarkup.new
-		xml.upload do
-			xml.id 42
-		end
-
-		RestClient.expects(:post).with(responds_with(:to_s, URI.parse("http://test.host/api/uploads.xml").to_s), has_entry(:upload, has_entry(:uploaded_data, kind_of(File))), kind_of(Hash)).returns(xml.target!)
-		upload = AdGear::Upload.new(:filename => "test/fixtures/access-denied-no-auth.txt")
-		upload.save
-		assert_equal 42, upload.id.to_i
+    xml = Builder::XmlMarkup.new
+    xml.upload do
+      xml.id 42
+    end
+
+    uri = URI.parse("http://test.host/api/uploads.xml")
+    RestClient.expects(:post).with(uri.to_s, all_of(has_key("upload[uploaded_data]"), has_key("upload[filename]")), {}).returns(xml.target!)
+    upload = AdGear::Upload.new(:filename => "test/fixtures/access-denied-no-auth.txt")
+    upload.save
+    assert_equal 42, upload.id.to_i
   end
 
   should "raise an exception when calling #update_attribute" do
@@ -34,4 +35,24 @@ class AdGear::UploadTest < Test::Unit::TestCase
       AdGear::Upload.new.update_attributes
     end
   end
+
+  should "retry with Digest authentication when RestClient::Unauthorized is raised" do
+    xml = Builder::XmlMarkup.new
+    xml.upload do
+      xml.id 42
+    end
+
+    uri = URI.parse("http://test.host/api/uploads.xml")
+
+    ActiveResource::Digest.stubs(:authenticate).returns("Calculated Authorization Header")
+    headers = {"www-authenticate" => ""}
+    unauthorized_response = stub("response", :[] => "Server Generated WWW-Authenticate Header")
+
+    RestClient.stubs(:post).with(anything, anything, {}).raises(RestClient::Unauthorized.new(unauthorized_response))
+    RestClient.expects(:post).with(anything, anything, has_key("Authorization")).returns(xml.target!)
+
+    upload = AdGear::Upload.new(:filename => "test/fixtures/access-denied-no-auth.txt")
+    upload.save
+    assert_equal 42, upload.id.to_i
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: francois-ad_gear_client
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-12 00:00:00 -07:00
+date: 2009-09-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,6 +71,7 @@ files:
 - ad_gear_client.gemspec
 - examples/.gitignore
 - examples/ad_gear.yml.sample
+- examples/create_placement.rb
 - examples/prelude.rb
 - examples/read_write_site.rb
 - examples/upload_file_to_ad_unit.rb
@@ -81,6 +82,7 @@ files:
 - lib/ad_gear/ad_unit_file.rb
 - lib/ad_gear/ad_unit_interaction.rb
 - lib/ad_gear/ad_unit_variable.rb
+- lib/ad_gear/advertiser.rb
 - lib/ad_gear/base.rb
 - lib/ad_gear/campaign.rb
 - lib/ad_gear/click.rb
@@ -89,6 +91,10 @@ files:
 - lib/ad_gear/format.rb
 - lib/ad_gear/has_many_array.rb
 - lib/ad_gear/interaction.rb
+- lib/ad_gear/placement_membership.rb
+- lib/ad_gear/placement_rule.rb
+- lib/ad_gear/publisher.rb
+- lib/ad_gear/publisher_placement.rb
 - lib/ad_gear/site.rb
 - lib/ad_gear/template.rb
 - lib/ad_gear/upload.rb
@@ -97,14 +103,14 @@ files:
 - lib/core_ext.rb
 - test/ad_gear/ad_spot_test.rb
 - test/ad_gear/config_test.rb
+- test/ad_gear/placement_rule_test.rb
 - test/ad_gear/site_test.rb
 - test/ad_gear/upload_test.rb
 - test/ad_gear_test.rb
 - test/fixtures/access-denied-no-auth.txt
 - test/test_helper.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/francois/ad_gear_client
-licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -125,17 +131,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ad_gear_client
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: A Ruby client for accessing AdGear http://bloomdigital.com/
 test_files: 
 - test/ad_gear/ad_spot_test.rb
 - test/ad_gear/config_test.rb
+- test/ad_gear/placement_rule_test.rb
 - test/ad_gear/site_test.rb
 - test/ad_gear/upload_test.rb
 - test/ad_gear_test.rb
 - test/test_helper.rb
+- examples/create_placement.rb
 - examples/prelude.rb
 - examples/read_write_site.rb
 - examples/upload_file_to_ad_unit.rb