francois-ad_gear_client 0.1.1

data/.document

@@ -0,0 +1 @@
+lib/**/*.rb

data/.gitignore

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

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,17 @@
+= 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.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2009 François Beausoleil.
+Copyright (c) 2009 Bloom Digital Platforms
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1,117 @@
+# 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.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"
+  end
+
+  Jeweler::RubyforgeTasks.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
+  sh "irb -Ilib:vendor/activeresource/lib:vendor/activemodel/lib:vendor/activesupport/lib -rad_gear"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/ad_gear_client.gemspec

@@ -0,0 +1,96 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ad_gear_client}
+  s.version = "0.1.1"
+
+  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.email = %q{francois@teksol.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ad_gear_client.gemspec",
+     "examples/.gitignore",
+     "examples/ad_gear.yml.sample",
+     "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_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/base.rb",
+     "lib/ad_gear/campaign.rb",
+     "lib/ad_gear/click.rb",
+     "lib/ad_gear/config.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/site.rb",
+     "lib/ad_gear/template.rb",
+     "lib/ad_gear/upload.rb",
+     "lib/ad_gear/variable.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/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/site_test.rb",
+     "test/ad_gear/upload_test.rb",
+     "test/ad_gear_test.rb",
+     "test/test_helper.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"])
+    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"])
+    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"])
+  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/prelude.rb

@@ -0,0 +1,18 @@
+$:.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
+
+AdGear.config = AdGear::Config.new("ad_gear.yml", "development")

data/examples/read_write_site.rb

@@ -0,0 +1,32 @@
+require "prelude"
+
+p AdGear::Site.find(:all)
+
+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")
+
+begin
+  p site.new?
+  p site.save
+  p site.new?
+  p "Saved"
+
+  p site.embed_code
+  p site.ad_spots
+
+  p site.ad_spots.class
+
+  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
+
+  puts site.to_xml
+  site.save
+
+  p "After PUT"
+  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/examples/upload_file_to_ad_unit.rb

@@ -0,0 +1,40 @@
+require "prelude"
+
+begin
+  gem "francois-rest-client", ">= 1.1.5"
+rescue RuntimeError => e
+  p e
+end
+
+require "restclient"
+p RestClient.version
+RestClient.log = "stdout"
+
+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
+
+templates = AdGear::Template.find(:all)
+template = templates.detect {|template| template.name == "Javascript"}
+formats   = AdGear::Format.find(:all)
+campaigns = AdGear::Campaign.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
+assert_raise ActiveResource::BadRequest do
+  ad_unit.save
+end
+
+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,6 @@
+module AdGear
+  class AdSpot < AdGear::Base
+    ignorable_attributes :embed_code
+    belongs_to :format
+  end
+end

data/lib/ad_gear/ad_unit.rb

@@ -0,0 +1,6 @@
+module AdGear
+  class AdUnit < AdGear::Base
+    has_many :ad_unit_files, :ad_unit_clicks, :ad_unit_interactions, :ad_unit_variables
+    belongs_to :campaign, :format
+  end
+end

data/lib/ad_gear/ad_unit_click.rb

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

data/lib/ad_gear/ad_unit_file.rb

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

data/lib/ad_gear/ad_unit_interaction.rb

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

data/lib/ad_gear/ad_unit_variable.rb

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

data/lib/ad_gear/base.rb

@@ -0,0 +1,144 @@
+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
+      end
+      super(params)
+    end
+
+    # Declares a relationship where we store the ID, but accept and/or return the full object.
+    #
+    # @example
+    #   class AdGear::AdSpot < AdGear::Base
+    #     belongs_to :format
+    #   end
+    #
+    #   AdGear::AdSpot.new(:format => Format.find(1)).attributes
+    #     #=> {"format_id" => 1}
+    def self.belongs_to(*attributes)
+      attributes.flatten.compact.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)
+      end
+    end
+
+    def self.belongs_to_associations #:nodoc:
+      @belongs_to_associations ||= []
+    end
+
+    # Defines a managed sub-collection.  Elements managed through a #has_many are
+    # ready for use by AttributeFu or ActiveRecord's 2.3 nested_attributes.
+    #
+    # @example
+    #   class AdGear::AdUnit < AdGear::Base
+    #     has_many :ad_unit_files, :ad_unit_clicks
+    #     has_many :ad_unit_interactions, :ad_unit_variables
+    #   end
+    #
+    #   AdGear::AdUnit.new(:ad_unit_files => [AdUnitFile.new(...)]).to_xml
+    #   <ad-unit>
+    #     <ad-unit-file-attributes>
+    #       <new>
+    #         <n0>
+    #           ...
+    #         </n0>
+    #       </new>
+    #       <!-- If there were "old" records, they'd be here
+    #     </ad-unit-file-attributes>
+    #   </ad-unit>
+    def self.has_many(*collections)
+      collections.flatten.compact.each do |collection|
+        collection_name = collection.to_s
+
+        # Remember what collections we are managing, for use in #to_xml
+        has_many_collections << collection_name
+
+        # Define a getter for the collection that transforms a plain Array into
+        # a HasManyArray which knows about new and old records
+        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)
+        end
+      end
+    end
+
+    def self.has_many_collections #:nodoc:
+      @has_many_collections ||= []
+    end
+
+    # Defines a list of attributes that should be ignored and not sent back to the server.
+    #
+    # @example
+    #   class AdGear::Site < AdGear::Base
+    #     ignorable_attributes :embed_code
+    #   end
+    #
+    #   AdGear::Site.find(13).to_xml
+    #   <site>
+    #     ...
+    #     <!-- no embed-code element -->
+    #   </site>
+    def self.ignorable_attributes(*attributes)
+      @ignorable_attributes ||= []
+      @ignorable_attributes += attributes.flatten.compact.map {|name| name.to_s}
+      @ignorable_attributes
+    end
+
+    def to_xml(options={})
+      self.class.has_many_collections.each do |name|
+        send(name) # convert the @attributes value into a HasManyArray
+      end
+
+      hash = if self.class.ignorable_attributes.empty?
+               @attributes
+             else
+               returning(@attributes.dup) do |hash|
+                 self.class.ignorable_attributes.each do |attr_name|
+                   hash.delete(attr_name)
+                 end
+               end
+             end
+      hash.to_xml({:root => self.class.element_name}.merge(options))
+    end
+
+    # Delegates to #to_xml, as this is the simplest thing that could possibly work
+    def encode(options={}) #:nodoc:
+      self.to_xml
+    end
+
+    private
+
+    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)
+      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.blank? ? nil : AdGear.const_get(attribute_name.classify).find(id)
+      end
+    end
+
+    def self.belongs_to_attribute_name_for(association_name)
+      "#{association_name}_id"
+    end
+
+    def self.unpack_belongs_to_association(value)
+      value ? value.id : nil
+    end
+  end
+end

data/lib/ad_gear/campaign.rb

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

data/lib/ad_gear/click.rb

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