francois-ad_gear_client 0.2.0 → 0.3.1

data/.gitignore

@@ -3,3 +3,4 @@
 coverage
 pkg
 doc
+*.log

data/README.rdoc

@@ -6,10 +6,48 @@ AdGear::Client is a client for accessing AdGear's RESTian web service.
 
 AdGear is a product of Bloom Digital Platforms, a Montreal-based company founded in 2008. Through the AdGear family of products Bloom provides advertising management solutions to publishers, ad networks and platform developers looking to monetize their audiences.
 
+== Getting Started
+
+Create a config file, such as config/ad_gear.yml
+
+    # Sample ad_gear.yml configuration file.  This file uses the same environment specifications as Rails, but they are actually optional
+    development: &defaults
+      site: http://adgear.local/api
+      user: francois
+      password: 94457f97dd3aa153c05257104e59a90f41a8110184cdefc8e52e4e295e48a782
+      use_basic_authentication: false
+      use_digest_authentication: true
+
+      # This is RestClient's logger support
+      logger: STDERR
+
+    test:
+      <<: *defaults
+
+    production:
+      <<: *defaults
+      site:  http://admin.adgear.com/api
+      user: francois
+      password: 0
+      logger: log/ad_gear.log
+
+Then, load the configuration:
+
+    require "ad_gear"
+
+    AdGear.config = AdGear::Config.new("path/to/ad_gear.yml", RAILS_ENV) # or whatever ENV you need
+
+    # You can start using the client here
+    formats = AdGear::Format.find(:all)
+
+The environment is actually optional.  If you do not specify it, the +site+, +user+, +password+ and other keys must exist at the root level of the file.  If you specify a key, and the YAML file does not have that key at the root, an +AdGear::Config::MissingEnvironmentSpecification+ will be raised (fail early).
+
 == Dependencies
 
 AdGear::Client works best with the ActiveResource branch made by François Beausoleil, at http://github.com/francois/rails.  This branch of ActiveResource supports Digest authentication.  AdGear::Client will work wihout that branch, but without Digest authentication.
 
+This gem also requires the francois-rest-client gem, for file upload support.
+
 == Copyright
 
 Copyright (c) 2009 François Beausoleil.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/ad_gear_client.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ad_gear_client}
-  s.version = "0.2.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["François Beausoleil"]
-  s.date = %q{2009-09-02}
+  s.authors = ["Fran\303\247ois Beausoleil"]
+  s.date = %q{2009-09-15}
   s.email = %q{francois@teksol.info}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -35,9 +35,9 @@ Gem::Specification.new do |s|
      "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",
      "lib/ad_gear/config.rb",
+     "lib/ad_gear/core_ext.rb",
      "lib/ad_gear/file.rb",
      "lib/ad_gear/format.rb",
      "lib/ad_gear/has_many_array.rb",
@@ -45,13 +45,13 @@ Gem::Specification.new do |s|
      "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",
      "lib/ad_gear/variable.rb",
+     "lib/ad_gear/web_campaign.rb",
+     "lib/ad_gear/web_placement.rb",
      "lib/ad_gear/xml_format.rb",
-     "lib/core_ext.rb",
      "test/ad_gear/ad_spot_test.rb",
      "test/ad_gear/config_test.rb",
      "test/ad_gear/placement_rule_test.rb",
@@ -61,12 +61,11 @@ Gem::Specification.new do |s|
      "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.1}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{A Ruby client for accessing AdGear http://bloomdigital.com/}
   s.test_files = [
     "test/ad_gear/ad_spot_test.rb",
@@ -84,7 +83,7 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     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

@@ -1,23 +1,28 @@
 require "prelude"
 
 begin
+  log "Getting publishers"
   publishers      = AdGear::Publisher.find(:all)
   publisher       = publishers.detect(&:active?)
   assert_not_nil publisher, "Missing a Publisher"
 
+  log "Getting formats"
   formats         = AdGear::Format.find(:all)
   format          = formats.first
   assert_not_nil format, "Missing a Format"
 
-  campaigns       = AdGear::Campaign.find(:all)
+  log "Getting WebCampaigns"
+  campaigns       = AdGear::WebCampaign.find(:all)
   campaign        = campaigns.first
   assert_not_nil campaign, "Missing a Campaign"
 
+  log "Getting AdUnits"
   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(
+  log "Instantiating a rotating publisher placement"
+  placement = AdGear::WebPlacement.new(
     :campaign            => campaign,
     :format              => format,
     :selection_mechanism => "rotated",
@@ -29,9 +34,11 @@ begin
     :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])])
+  log "Saving the placement"
   placement.save
 
-  placement = AdGear::PublisherPlacement.new(
+  log "Instantiating a weighted publisher placment"
+  placement = AdGear::WebPlacement.new(
     :campaign            => campaign,
     :format              => format,
     :selection_mechanism => "weighted",
@@ -43,6 +50,7 @@ begin
     :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])])
+  log "Saving the placement"
   placement.save
 rescue ActiveResource::BadRequest => e
   p ActiveResource::Formats[:xml].decode(e.response.body)

data/examples/prelude.rb

@@ -15,4 +15,13 @@ end
 require "test/unit/assertions"
 include Test::Unit::Assertions
 
+def log(msg)
+  AdGear.logger.info msg.to_yaml
+  if msg.kind_of?(String) then
+    puts msg
+  else
+    pp msg
+  end
+end
+
 AdGear.config = AdGear::Config.new("ad_gear.yml", "development")

data/examples/read_write_site.rb

@@ -1,39 +1,36 @@
 require "prelude"
 
 begin
+  log "Getting formats"
   formats = AdGear::Format.find(:all)
-  p formats
 
+  log "Getting sites"
   sites = AdGear::Site.find(:all)
-  p sites
 
+  log "Instantiating new Site"
   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")
-
-  p site.new?
-  p site.save
-  p site.new?
-  p "Saved"
 
-  pp site.embed_code
-  pp site.ad_spots
-
-  p site.ad_spots.class
+  log "banner AdSpot"
+  site.ad_spots << AdGear::AdSpot.new(:format_id => formats.first.id, :name => "homepage banner")
 
+  log "vertical AdSpot"
   site.ad_spots << AdGear::AdSpot.new(:format_id => formats.first.id, :name => "homepage vertical")
   site.ad_spots.detect {|as| as.name == "homepage banner"}.name = "home page banner"
   assert_equal 3, site.ad_spots.length, site.to_xml
 
+  log "Saving new Site"
+  assert site.save, "Could not save site"
+
+  log "Instantiating new AdSpot outside Site"
   ad_spot = AdGear::AdSpot.new(:format_id => formats.first.id, :name => "east", :site_id => site.id)
+  log "Saving"
   assert ad_spot.save, "Could not save new AdSpot"
+
+  log "Reloading site"
   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
-
-  p "After PUT"
-  assert_equal 3, site.ad_spots.length, site.to_xml
+  log "Done testing"
 rescue ActiveResource::BadRequest => e
   p ActiveResource::Formats[:xml].decode(e.response.body)
 end

data/examples/upload_file_to_ad_unit.rb

@@ -10,6 +10,7 @@ require "restclient"
 p RestClient.version
 RestClient.log = "stdout"
 
+log "Instantiating upload"
 upload = AdGear::Upload.new(:filename => File.dirname(__FILE__) + "/ad_gear.yml")
 if upload.save then
   p "uploaded successfully"
@@ -19,10 +20,15 @@ else
   exit 1
 end
 
+log "Finding correct template"
 templates = AdGear::Template.find(:all)
 template = templates.detect {|template| template.name == "Javascript"}
+
+log "Getting formats"
 formats   = AdGear::Format.find(:all)
-campaigns = AdGear::Campaign.find(:all)
+
+log "Getting WebCampaigns"
+campaigns = AdGear::WebCampaign.find(:all)
 
 # Use Javascript, but forget to put the payload
 ad_unit = AdGear::AdUnit.new(:campaign => campaigns.first, :name => "BMW M5", :format => formats.first, :template => template.name)
@@ -32,9 +38,12 @@ ad_unit.ad_unit_clicks       << AdGear::AdUnitClick.new(:name => "clickTAG", :ur
 puts "================="*8
 puts ad_unit.to_xml
 puts "================="*8
+
+log "Attempt save, but forget to include the payload"
 assert_raise ActiveResource::BadRequest do
   ad_unit.save
 end
 
+log "Save with payload"
 ad_unit.ad_unit_variables << AdGear::AdUnitVariable.new(:name => "payload", :value => "// whatever")
 assert ad_unit.save, "What?  Now I'm providing the system-required variable, why am I still erroring out?\n" + ad_unit.errors.to_yaml

data/lib/ad_gear.rb

@@ -35,13 +35,13 @@ module AdGear
   # AdGear models themselves
   autoload :Site, "ad_gear/site"
   autoload :AdSpot, "ad_gear/ad_spot"
-  autoload :Campaign, "ad_gear/campaign"
+  autoload :WebCampaign, "ad_gear/web_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 :WebPlacement, "ad_gear/web_placement"
   autoload :PlacementRule, "ad_gear/placement_rule"
   autoload :PlacementMembership, "ad_gear/placement_membership"
 
@@ -90,10 +90,15 @@ module AdGear
 
     ActiveSupport::XmlMini.backend = "Nokogiri"
 
-    require "core_ext"
+    # Can't require before now, because our own method is overwritten
+    require "ad_gear/core_ext"
   end
 
   def self.config
-    config
+    @config
+  end
+
+  def self.logger
+    config.logger
   end
 end

data/lib/ad_gear/web_campaign.rb

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

data/lib/ad_gear/web_placement.rb

@@ -0,0 +1,26 @@
+module AdGear
+  class WebPlacement < 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/test/ad_gear/placement_rule_test.rb

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class AdGear::PublisherPlacementTest < Test::Unit::TestCase
+class AdGear::PlacementRuleTest < Test::Unit::TestCase
   def setup
     super
     AdGear.config = OpenStruct.new(:site => "http://test.host", :format => :xml)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: francois-ad_gear_client
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-02 00:00:00 -07:00
+date: 2009-09-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,9 +84,9 @@ files:
 - 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
 - lib/ad_gear/config.rb
+- lib/ad_gear/core_ext.rb
 - lib/ad_gear/file.rb
 - lib/ad_gear/format.rb
 - lib/ad_gear/has_many_array.rb
@@ -94,13 +94,13 @@ files:
 - 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
 - lib/ad_gear/variable.rb
+- lib/ad_gear/web_campaign.rb
+- lib/ad_gear/web_placement.rb
 - lib/ad_gear/xml_format.rb
-- lib/core_ext.rb
 - test/ad_gear/ad_spot_test.rb
 - test/ad_gear/config_test.rb
 - test/ad_gear/placement_rule_test.rb
@@ -109,8 +109,9 @@ files:
 - test/ad_gear_test.rb
 - test/fixtures/access-denied-no-auth.txt
 - test/test_helper.rb
-has_rdoc: true
+has_rdoc: false
 homepage: http://github.com/francois/ad_gear_client
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -131,9 +132,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ad_gear_client
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A Ruby client for accessing AdGear http://bloomdigital.com/
 test_files: 
 - test/ad_gear/ad_spot_test.rb

data/lib/ad_gear/campaign.rb

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

data/lib/ad_gear/publisher_placement.rb

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