ad_gear_client 0.3.8

data/lib/ad_gear.rb

@@ -0,0 +1,108 @@
+#--
+# Copyright (c) 2009 François Beausoleil
+# Copyright (c) 2009 Bloom Digital Platforms
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+
+require "active_support"
+require "active_resource"
+require "bigdecimal"
+require "logger"
+
+warn "You are using the plain jane version of ActiveResource.  You could use Digest authentication if you used http://github.com/francois/rails/tree/ar_digest" unless ActiveResource::Base.respond_to?(:use_basic_authentication)
+
+module AdGear
+  # AdGear's models superclass
+  autoload :Base, "ad_gear/base"
+
+  # AdGear models themselves
+  autoload :Advertiser, "ad_gear/advertiser"
+  autoload :Site, "ad_gear/site"
+  autoload :AdSpot, "ad_gear/ad_spot"
+  autoload :AdSpotMembership, "ad_gear/ad_spot_membership"
+  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 :WebPlacement, "ad_gear/web_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"
+  autoload :AdUnitFile, "ad_gear/ad_unit_file"
+  autoload :AdUnitInteraction, "ad_gear/ad_unit_interaction"
+  autoload :AdUnitClick, "ad_gear/ad_unit_click"
+  autoload :AdUnitVariable, "ad_gear/ad_unit_variable"
+
+  # Templates and their dependencies, to know what child models are required
+  autoload :Template, "ad_gear/template"
+  autoload :File, "ad_gear/file"
+  autoload :Variable, "ad_gear/variable"
+  autoload :Click, "ad_gear/click"
+  autoload :Interaction, "ad_gear/interaction"
+
+  # Miscellaneous stuff
+  autoload :Config, "ad_gear/config"
+  autoload :XmlFormat, "ad_gear/xml_format"
+  autoload :HasManyArray, "ad_gear/has_many_array"
+
+  class UnsupportedOperation < RuntimeError; end
+
+  # Configures AdGear's ActiveResource models.
+  #
+  # NOTE: AdGear's client expects and uses Nokogiri instead of REXML.
+  # See http://rubyglasses.blogspot.com/2009/07/40-speedup-using-nokogiri.html#instructions
+  def self.config=(config)
+    @config = config
+
+    AdGear::Base.logger   = config.logger
+
+    AdGear::Base.site     = config.site
+    AdGear::Base.user     = config.user
+    AdGear::Base.password = config.password
+    AdGear::Base.format   = config.format
+
+    if AdGear::Base.respond_to?(:use_basic_authentication=)
+      AdGear::Base.use_basic_authentication = config.use_basic_authentication
+    end
+
+    if AdGear::Base.respond_to?(:use_digest_authentication=)
+      AdGear::Base.use_digest_authentication = config.use_digest_authentication
+    end
+
+    # TODO: Programatically determine if we can use Nokogiri
+    ActiveSupport::XmlMini.backend = "Nokogiri"
+
+    # Can't require before now, because our own method is overwritten
+    require "ad_gear/core_ext"
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.logger
+    config.logger
+  end
+end

data/test/ad_gear/ad_spot_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+require "ostruct"
+
+class AdGear::AdSpotTest < 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
+
+  def test_embed_code_should_not_be_encoded
+    spot = AdGear::AdSpot.new(:id => 84, :name => "XLsuite", :format_id => 42, :embed_code => "some code")
+
+    doc = Nokogiri::XML(spot.encode)
+    xpath doc, "/ad-spot/embed-code" do |ns|
+      assert ns.empty?, doc
+    end
+  end
+
+  def test_setting_format_sets_format_id_internally
+    format = stub("AdGear::Format", :id => 231)
+
+    spot = AdGear::AdSpot.new
+    spot.format = format
+    assert_equal 231, spot.attributes["format_id"], spot.attributes
+  end
+
+  def test_instantiating_with_format_sets_format_id_internally
+    format = stub("AdGear::Format", :id => 231)
+    spot = AdGear::AdSpot.new(:format => format)
+    assert_equal 231, spot.attributes["format_id"], spot.attributes
+  end
+  
+  def test_setting_format_to_nil_sets_format_id_to_nil
+    spot = AdGear::AdSpot.new
+    spot.format = nil
+    assert_nil spot.attributes["format_id"]
+  end
+end

data/test/ad_gear/config_test.rb

@@ -0,0 +1,114 @@
+require "test_helper"
+require "tempfile"
+require "stringio"
+
+class AdGear::ConfigTest < Test::Unit::TestCase
+  should "read a file on disk when given a path" do
+    econf = {"site" => "http://whatever.com/", "user" => "francois", "password" => "many"}
+    Tempfile.open("config") do |io|
+      io.write econf.to_yaml
+      io.close
+
+      aconf = AdGear::Config.new(io.path)
+      assert_equal econf, aconf.to_hash
+    end
+  end
+
+  should "pass a file's content through ERB before evaluating configuration" do
+    conf = {"user" => "<%= :whoami %>"}
+    econf = {"user" => "whoami"}
+    Tempfile.open("config") do |io|
+      io.write conf.to_yaml
+      io.close
+
+      aconf = AdGear::Config.new(io.path)
+      assert_equal econf, aconf.to_hash
+    end
+  end
+
+  should "read a stream" do
+    econf = {"site" => "http://whatever.com/", "user" => "francois", "password" => "many"}
+    Tempfile.open("config") do |io|
+      io.write econf.to_yaml
+      io.rewind
+
+      aconf = AdGear::Config.new(io)
+      assert_equal econf, aconf.to_hash
+    end
+  end
+
+  should "read the specified env" do
+    econf = {"site" => "http://whatever.com/", "user" => "francois", "password" => "many"}
+    env = {"development" => econf}
+    aconf = AdGear::Config.new(StringIO.new(env.to_yaml), "development")
+    assert_equal econf, aconf.to_hash
+  end
+
+  should "raise a MissingEnvironmentSpecification when the file is empty" do
+    assert_raise AdGear::Config::MissingEnvironmentSpecification do
+      AdGear::Config.new(StringIO.new(""), "development")
+    end
+  end
+
+  should "raise a MissingEnvironmentSpecification when the env doesn't exist" do
+    econf = {"site" => "http://whatever.com/", "user" => "francois", "password" => "many"}
+    env = {"development" => econf}
+
+    assert_raise AdGear::Config::MissingEnvironmentSpecification do
+      AdGear::Config.new(StringIO.new(env.to_yaml), "test")
+    end
+  end
+
+  should "instantiate a Logger for STDOUT when the logger key is 'stdout'" do
+    Logger.expects(:new).with(STDOUT).returns(mock("Logger"))
+    AdGear::Config.new(StringIO.new({"logger" => "stdout"}.to_yaml))
+  end
+
+  should "instantiate a Logger for STDERR when the logger key is 'stderr'" do
+    Logger.expects(:new).with(STDERR).returns(mock("Logger"))
+    AdGear::Config.new("logger" => "stderr")
+  end
+
+  should "instantiate a Logger for the file named 'log/adgear.log' when the key is 'log/adgear.log'" do
+    Logger.expects(:new).with(File.join(Dir.pwd, "log/adgear.log")).returns(mock("Logger"))
+    AdGear::Config.new(StringIO.new({"logger" => File.join(Dir.pwd, "log/adgear.log")}.to_yaml))
+  end
+
+  should "pass the config file through ERB before using the values" do
+    conf = AdGear::Config.new(StringIO.new({"user" => "<%= :whoami %>"}.to_yaml))
+    assert_equal "whoami", conf.user
+  end
+
+  should "warn when the path to the logger is relative" do
+    config = AdGear::Config.new
+    config.expects(:warn)
+    config.logger = "development.log"
+  end
+
+  context "Given a configured AdGear::Config" do
+    setup do
+      conf = {"site" => "http://whatever.com/", "user" => "francois", "password" => "many", "use_basic_authentication" => false, "use_digest_authentication" => true}
+      @config = AdGear::Config.new(conf)
+    end
+
+    should "return the correct site from #site" do
+      assert_equal "http://whatever.com/", @config.site
+    end
+
+    should "return the correct user from #user" do
+      assert_equal "francois", @config.user
+    end
+
+    should "return the correct password from #password" do
+      assert_equal "many", @config.password
+    end
+
+    should "return the correct use_basic_authentication from #use_basic_authentication" do
+      assert_equal false, @config.use_basic_authentication
+    end
+
+    should "return the correct use_digest_authentication from #use_digest_authentication" do
+      assert_equal true, @config.use_digest_authentication
+    end
+  end
+end

data/test/ad_gear/placement_rule_test.rb

@@ -0,0 +1,22 @@
+require "test_helper"
+
+class AdGear::PlacementRuleTest < 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/site_test.rb

@@ -0,0 +1,69 @@
+require "test_helper"
+require "ostruct"
+
+class AdGear::SiteTest < 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
+
+  def test_adding_an_ad_spot_puts_it_in_the_new_collection
+    site = AdGear::Site.new(:name => "XLsuite", :url => "http://xlsuite.com/", :publisher_id => 1)
+    site.ad_spots << AdGear::AdSpot.new(:format_id => 13, :name => "sidebar top")
+
+    doc = Nokogiri::XML(site.to_xml)
+    xpath doc, "/site/ad-spot-attributes/new/*/name" do |ns|
+      assert_equal 1, ns.length, doc
+    end
+  end
+
+  def test_adding_an_existing_ad_spot_puts_it_in_the_old_collection
+    site = AdGear::Site.new(:name => "XLsuite", :url => "http://xlsuite.com/", :publisher_id => 1)
+    FakeWeb.register_uri(:get, "http://test.host/ad_spots/42.xml", :body => "<ad-spot><id>42</id><name>bla</name></ad-spot>")
+    site.ad_spots << AdGear::AdSpot.find(42)
+
+    doc = Nokogiri::XML(site.to_xml)
+    xpath doc, "/site/ad-spot-attributes/n42/name" do |ns|
+      assert_equal 1, ns.length, doc
+    end
+  end
+
+  def test_instantiating_with_ad_spots_still_generates_ad_spots_in_the_new_collection
+    site = AdGear::Site.new(:name         => "XLsuite",
+                            :url          => "http://xlsuite.com/",
+                            :publisher_id => 1,
+                            :ad_spots     => [{:format_id => 13, :name => "sidebar top"}])
+
+    doc = Nokogiri::XML(site.to_xml)
+    xpath doc, "/site/ad-spot-attributes/new/*/name" do |ns|
+      assert_equal 1, ns.length, doc
+    end
+  end
+
+  def test_adding_a_new_ad_spot_to_existing_ad_spots_adds_to_new_collection
+    site = AdGear::Site.new(:name         => "XLsuite",
+                            :url          => "http://xlsuite.com/",
+                            :publisher_id => 1,
+                            :ad_spots     => [{:format_id => 13, :name => "sidebar top"}])
+    site.ad_spots << AdGear::AdSpot.new(:format_id => 13, :name => "homepage bottom")
+
+    doc = Nokogiri::XML(site.to_xml)
+    xpath doc, "/site/ad-spot-attributes/new/*/name" do |ns|
+      assert_equal 2, ns.length, doc
+    end
+  end
+
+  def test_embed_code_should_not_be_encoded
+    site = AdGear::Site.new(:id => 84, :name => "XLsuite", :url => "http://xlsuite.com/", :embed_code => "some code")
+
+    doc = Nokogiri::XML(site.encode)
+    xpath doc, "/site/embed-code" do |ns|
+      assert ns.empty?, doc
+    end
+  end
+end

data/test/ad_gear/upload_test.rb

@@ -0,0 +1,58 @@
+require "test_helper"
+
+class AdGear::UploadTest < Test::Unit::TestCase
+  def setup
+    super
+    AdGear.config = OpenStruct.new(:site => "http://test.host/api", :format => :xml)
+  end
+
+  def teardown
+    AdGear::Base.site = nil
+    super
+  end
+
+  should "upload the data using RestClient" do
+    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
+    assert_raise(AdGear::UnsupportedOperation) do
+      AdGear::Upload.new.update_attribute
+    end
+  end
+
+  should "raise an exception when calling #update_attributes" do
+    assert_raise(AdGear::UnsupportedOperation) do
+      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

data/test/ad_gear_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+require "ostruct"
+
+class AdGearTest < Test::Unit::TestCase
+  should "configure AdGear::Base when calling #config= with config object" do
+    assert_nil AdGear::Base.site
+
+    AdGear.config = OpenStruct.new(:site => "http://bla.com", :user => "user", :password => "test", :format => :xml)
+
+    assert_equal "http://bla.com", AdGear::Base.site.to_s
+    assert_equal "user", AdGear::Base.user
+    assert_equal "test", AdGear::Base.password
+  end
+
+  should "override Array#to_xml to generate XML envelopes containing only class name" do
+    sites = [ AdGear::Site.new, AdGear::Site.new ]
+
+    doc = Nokogiri::XML(sites.to_xml)
+    xpath doc, "/sites/site" do |ns|
+      assert_equal 2, ns.length, doc
+    end
+  end
+end

data/test/fixtures/access-denied-no-auth.txt

@@ -0,0 +1,13 @@
+HTTP/1.1 401 Authorization Required
+Date: Mon, 03 Aug 2009 20:06:42 GMT
+Server: Apache/2.2.11 (Unix) mod_ssl/2.2.11 OpenSSL/0.9.7l DAV/2 Phusion_Passenger/2.2.2
+X-Powered-By: Phusion Passenger (mod_rails/mod_rack) 2.2.2
+WWW-Authenticate: Digest realm="AdGear API", qop="auth", algorithm=MD5, nonce="MTI0OTMzMDAwMjphN2NkNGU0YmUwZDQ5MjhhZjYzNzA4NzZiNjA4YTU0Ng==", opaque="a21e6002d2bd70e6dbeaca094ded4f93"
+X-Runtime: 13
+Cache-Control: no-cache
+Set-Cookie: _AdGear_session=BAh7BjoPc2Vzc2lvbl9pZCIlYmE3NGNiZWIxN2ZhNmMyZDNjYWM5ZDEyMDFjMDhkZGI%3D--102443fec5480274e2163b6eb98ef2722c8f90cc; path=/; HttpOnly
+Content-Length: 28
+Status: 401
+Content-Type: text/html; charset=utf-8
+
+HTTP Digest: Access denied.

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "test/unit"
+require "shoulda"
+require "mocha"
+require "fakeweb"
+require "builder"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "ad_gear"
+
+begin
+  require "ruby-debug"
+rescue LoadError
+  # Don't care, it's nice but not required
+end
+
+class Test::Unit::TestCase
+  BASE_URI = "http://api.adgear.com/services"
+
+  def setup
+    FakeWeb.allow_net_connect = false
+  end
+
+  def teardown
+    FakeWeb.allow_net_connect = true
+  end
+
+  protected
+  def xpath(doc, path)
+    yield doc.xpath(path)
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification 
+name: ad_gear_client
+version: !ruby/object:Gem::Version 
+  version: 0.3.8
+platform: ruby
+authors: 
+- "Fran\xC3\xA7ois Beausoleil"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: lsegal-yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: francois-rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: francois@teksol.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ad_gear_client.gemspec
+- examples/.gitignore
+- examples/ad_gear.yml.sample
+- examples/create_campaign.rb
+- examples/create_placement.rb
+- examples/prelude.rb
+- examples/read_write_site.rb
+- examples/upload_file_to_ad_unit.rb
+- lib/ad_gear.rb
+- lib/ad_gear/ad_spot.rb
+- lib/ad_gear/ad_spot_membership.rb
+- lib/ad_gear/ad_unit.rb
+- lib/ad_gear/ad_unit_click.rb
+- 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/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
+- 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/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
+- 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: true
+homepage: http://github.com/francois/ad_gear_client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ad_gear_client
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+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_campaign.rb
+- examples/create_placement.rb
+- examples/prelude.rb
+- examples/read_write_site.rb
+- examples/upload_file_to_ad_unit.rb