ad_gear_client 0.3.8

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+pkg
+doc
+*.log

data/LICENSE

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

data/README.rdoc

@@ -0,0 +1,55 @@
+= ad_gear_client
+
+This gem is Ruby 1.8.6, Ruby 1.8.7, Ruby 1.9 and JRuby 1.3 compatible.
+
+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.
+Copyright (c) 2009 Bloom Digital Platforms
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name              = "ad_gear_client"
+    gem.summary           = %Q{A Ruby client for accessing AdGear http://bloomdigital.com/}
+    gem.email             = "francois@teksol.info"
+    gem.homepage          = "http://github.com/francois/ad_gear_client"
+    gem.authors           = ["François Beausoleil"]
+    gem.rubyforge_project = "ad_gear_client"
+
+    gem.files.exclude ".document"
+
+    gem.add_development_dependency "lsegal-yard", ">= 0.2.3"
+    gem.add_development_dependency "mocha", ">= 0.9.5"
+
+    gem.add_dependency "activeresource", "> 2.0"
+    gem.add_dependency "francois-rest-client", "~> 1"
+    gem.add_dependency "nokogiri"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.libs << "vendor/activesupport/lib"  if File.directory?("vendor/activesupport/lib")
+  test.libs << "vendor/activemodel/lib"    if File.directory?("vendor/activemodel/lib")
+  test.libs << "vendor/activeresource/lib" if File.directory?("vendor/activeresource/lib")
+
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+module AdGear
+  if File.exist?("VERSION")
+    Version = File.read("VERSION")
+  else
+    Version = ""
+  end
+end
+
+begin
+  require "yard"
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.options = ["--title", "AdGear::Client #{AdGear::Version}", "--readme", "README.rdoc"]
+  end
+
+  namespace :doc do
+    desc "Blow away all generated documentation"
+    task :clean do
+      rm_rf "doc"
+    end
+  end
+
+  task :doc => "doc:clean"
+rescue LoadError
+  STDERR.puts "YARD is not available.  In order to generate the best possible documentation, install YARD:  sudo gem install yard"
+
+  require 'rake/rdoctask'
+  Rake::RDocTask.new(:doc) do |rdoc|
+    rdoc.rdoc_dir = "doc"
+    rdoc.title    = "AdGear::Client #{AdGear::Version}"
+
+    rdoc.rdoc_files.include('README*')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+end
+
+desc "Runs tests under all supported multiruby versions"
+task :multi do
+  tests = FileList["test/**/*_test.rb"].map do |file|
+    'require "%s"' % file
+  end.join("; ")
+  sh %{ multiruby -w -Ilib:test -e 'require "rubygems"; require "test/unit"; #{tests}' }
+end
+
+namespace :test do
+  desc "Do a live test against http://adgear.local/"
+  task :live do
+    base_url = ENV["BASE_URL"] || "http://adgear.local/api/services"
+    $:.unshift "lib"
+    require "ad_gear"
+
+    begin
+      client = AdGear::Client.new("francois", "94457f97dd3aa153c05257104e59a90f41a8110184cdefc8e52e4e295e48a782", :base_url => base_url, :logger => Logger.new(STDOUT))
+      p client.sites
+    rescue
+      puts $!
+      puts $!.backtrace
+    end
+  end
+end
+
+task :shell do
+  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

@@ -0,0 +1 @@
+0.3.8

data/ad_gear_client.gemspec

@@ -0,0 +1,114 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ad_gear_client}
+  s.version = "0.3.8"
+
+  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-11-13}
+  s.email = %q{francois@teksol.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.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"
+  ]
+  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.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_campaign.rb",
+     "examples/create_placement.rb",
+     "examples/prelude.rb",
+     "examples/read_write_site.rb",
+     "examples/upload_file_to_ad_unit.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.5"])
+      s.add_runtime_dependency(%q<activeresource>, ["> 2.0"])
+      s.add_runtime_dependency(%q<francois-rest-client>, ["~> 1"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+    else
+      s.add_dependency(%q<lsegal-yard>, [">= 0.2.3"])
+      s.add_dependency(%q<mocha>, [">= 0.9.5"])
+      s.add_dependency(%q<activeresource>, ["> 2.0"])
+      s.add_dependency(%q<francois-rest-client>, ["~> 1"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<lsegal-yard>, [">= 0.2.3"])
+    s.add_dependency(%q<mocha>, [">= 0.9.5"])
+    s.add_dependency(%q<activeresource>, ["> 2.0"])
+    s.add_dependency(%q<francois-rest-client>, ["~> 1"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+  end
+end
+

data/examples/.gitignore

@@ -0,0 +1 @@
+ad_gear.yml

data/examples/ad_gear.yml.sample

@@ -0,0 +1,8 @@
+--- 
+development: 
+  site: http://adgear.local/api
+  user: francois
+  password: 94457f97dd3aa153c05257104e59a90f41a8110184cdefc8e52e4e295e48a782
+  use_basic_authentication: false
+  use_digest_authentication: true
+  logger: STDERR

data/examples/create_campaign.rb

@@ -0,0 +1,23 @@
+require "prelude"
+
+begin
+  log "Searching for an existing advertiser"
+
+  advertiser = AdGear::Advertiser.find(:first)
+  if advertiser.nil? then
+    log "Creating a new advertiser since none existed"
+    advertiser = AdGear::Advertiser.new(:name => "Coca-Cola")
+    advertiser.save
+  end
+
+  log "Creating campaign"
+  wc = AdGear::WebCampaign.new(:name             => "Coca-Cola is Rich",
+                               :default_start_at => 10.days.from_now,
+                               :default_end_at   => 30.days.from_now,
+                               :advertiser       => advertiser)
+  wc.save
+
+  log "Done testing"
+rescue ActiveResource::BadRequest => e
+  p ActiveResource::Formats[:xml].decode(e.response.body)
+end

data/examples/create_placement.rb

@@ -0,0 +1,57 @@
+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"
+
+  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"
+
+  log "Instantiating a rotating publisher placement"
+  placement = AdGear::WebPlacement.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])])
+  log "Saving the placement"
+  placement.save
+
+  log "Instantiating a weighted publisher placment"
+  placement = AdGear::WebPlacement.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])])
+  log "Saving the placement"
+  placement.save
+rescue ActiveResource::BadRequest => e
+  p ActiveResource::Formats[:xml].decode(e.response.body)
+end

data/examples/prelude.rb

@@ -0,0 +1,27 @@
+$:.unshift "../lib"
+%w(activesupport activemodel activeresource rest-client).each do |lib|
+  $:.unshift "../vendor/#{lib}/lib" if File.directory?("../vendor/#{lib}/lib")
+end
+
+require "ad_gear"
+require "pp"
+
+begin
+  require "ruby-debug"
+rescue LoadError
+  # Ignored under 1.9, JRuby
+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

@@ -0,0 +1,36 @@
+require "prelude"
+
+begin
+  log "Getting formats"
+  formats = AdGear::Format.find(:all)
+
+  log "Getting sites"
+  sites = AdGear::Site.find(:all)
+
+  log "Instantiating new Site"
+  site = AdGear::Site.new(:name => "XLsuite", :url => "http://xlsuite.com/", :ad_spots => [{:format_id => formats.first.id, :name => "sidebar top"}])
+
+  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"
+
+  log "Done testing"
+rescue ActiveResource::BadRequest => e
+  p ActiveResource::Formats[:xml].decode(e.response.body)
+end

data/examples/upload_file_to_ad_unit.rb

@@ -0,0 +1,49 @@
+require "prelude"
+
+begin
+  gem "francois-rest-client", ">= 1.1.5"
+rescue RuntimeError => e
+  p e
+end
+
+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"
+  p upload.id
+else
+  p upload.errors
+  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)
+
+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)
+ad_unit.ad_unit_files        << AdGear::AdUnitFile.new(:name => "image", :upload => upload)
+ad_unit.ad_unit_interactions << AdGear::AdUnitInteraction.new(:name => "something")
+ad_unit.ad_unit_clicks       << AdGear::AdUnitClick.new(:name => "clickTAG", :url => "http://somewhere.com/")
+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/ad_spot.rb

@@ -0,0 +1,7 @@
+module AdGear
+  class AdSpot < AdGear::Base
+    ignorable_attributes :embed_code
+    belongs_to :format
+    has_many :ad_spot_memberships
+  end
+end

data/lib/ad_gear/ad_spot_membership.rb

@@ -0,0 +1,5 @@
+module AdGear
+  class AdSpotMembership < AdGear::Base
+    belongs_to :ad_spot, :placement
+  end
+end

data/lib/ad_gear/ad_unit.rb

@@ -0,0 +1,17 @@
+module AdGear
+  class AdUnit < AdGear::Base
+    has_many :ad_unit_files, :ad_unit_clicks, :ad_unit_interactions, :ad_unit_variables
+    has_many :placement_memberships
+    ignorable_attributes :placements
+    belongs_to :web_campaign, :as => :campaign
+    belongs_to :format
+
+    def active?
+      state == "active"
+    end
+
+    def deleted?
+      state == "deleted"
+    end
+  end
+end

data/lib/ad_gear/ad_unit_click.rb

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

data/lib/ad_gear/ad_unit_file.rb

@@ -0,0 +1,6 @@
+module AdGear
+  class AdUnitFile < AdGear::Base
+    belongs_to :upload
+    belongs_to :ad_unit
+  end
+end

data/lib/ad_gear/ad_unit_interaction.rb

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

data/lib/ad_gear/ad_unit_variable.rb

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

data/lib/ad_gear/advertiser.rb

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