oas 0.1.0 → 0.1.1

data/README.markdown

@@ -55,12 +55,46 @@ Usage Examples
     # Read a site group
     puts Oas.site_group("site_group_id")
 
+    # Reports
+    # StartDate defaults to first time in history
+    # EndDate defaults to Date.today
+
+    # Get advertiser reports
+    puts Oas.advertiser_report("advertiser_id", "Delivery.Advertiser.Base.T602.01,Delivery.Advertiser.Base.T652.01", "2011/01/01", "2011/01/31")
+
+    # Get campaign reports
+    puts Oas.campaign_report("campaign_id", "Delivery.Campaign.Base.T154.01")
+
+    # Get section reports
+    puts Oas.section_report("section_id", "Delivery.Section.Cookie.T358.01")
+
+    # Get site reports
+    puts Oas.site_report("site_id", "Delivery.Site.Base.T258.01")
+
+    # Get Site Performance Reports
+    puts Oas.site_performance_report("site_id, other_site_id", "2011/01/01", "2011/01/31")
+
+    # Get Page Priority Reports
+    puts Oas.page_priority_report("www.247realmedia.com/home")
+
+    # Get Campaigns Status Report
+    puts Oas.campaign_status_report
+
+    #Execute not implemented request
+    puts Oas.client.request('Site') do |xml|
+      xml.Database(:action => 'list') {
+        xml.SearchCriteria {
+          xml.Id "%"
+        }
+      }
+    end.inspect
+
 TODO
 ------------
 
 * Create and update support on Campaign and Database sections.
 * Listings
-* Reports
+* Reach and Frequency Reports
 * Inventory
 
 Copyright

data/lib/oas/api.rb

@@ -30,13 +30,13 @@ module Oas
         }
       end
       response = Hash.from_xml(response.to_hash[:oas_xml_request_response][:result])[:AdXML][:Response]
-      verify_errors(request_type, response)
+      verify_errors(response)
       response
     end
   
     private
-    def verify_errors(request_type, response)
-      return if (e = response[:Exception]).nil? && (e = response[request_type.to_sym][:Exception]).nil?
+    def verify_errors(response)
+      return if ((e = response[:Exception]).nil? && (!response[response.keys.first].is_a?(Hash) || (e = response[response.keys.first][:Exception]).nil?))
       error_code = e[:errorCode]
       error_msg  = e[:content]
       case error_code

data/lib/oas/client/{campaign.rb → campaigns.rb}

@@ -1,7 +1,7 @@
 module Oas
   class Client
     # Defines methods related to oas campaigns
-    module Campaign
+    module Campaigns
       def campaign(id)
         request("Campaign") do |xml|
           xml.Campaign(:action => "read") {
@@ -10,7 +10,16 @@ module Oas
             }
           }
         end
-      end      
+      end
+
+      def creative(campaign_id, id)
+        request("Creative") do |xml|
+          xml.Creative(:action => "read") {
+            xml.CampaignId campaign_id
+            xml.Id id
+          }
+        end
+      end
     end
   end
 end

data/lib/oas/client/{database.rb → databases.rb}

@@ -1,7 +1,7 @@
 module Oas
   class Client
-    # Defines methods related to oas database section
-    module Database
+    # Defines methods related to oas databases section
+    module Databases
       def advertiser(id)
         request("Advertiser") do |xml|
           xml.Database(:action => "read") {

data/lib/oas/client/{notification.rb → notifications.rb}

@@ -1,7 +1,7 @@
 module Oas
   class Client
     # Defines methods related to oas campaigns
-    module Notification
+    module Notifications
       def notification(campaign_id, event_name)
         request("Notification") do |xml|
           xml.Notification(:action => "read") {

data/lib/oas/client/reports.rb

@@ -0,0 +1,71 @@
+module Oas
+  class Client
+    # Defines methods related to oas reports section
+    module Reports
+      class MissingTablesError < Client::Error; end
+
+      def advertiser_report(advertiser_id, report_ids, start_date = nil, end_date = Date.today)
+        report_request("Advertiser", advertiser_id, report_ids, start_date, end_date)
+      end
+
+      def campaign_report(campaign_id, report_ids, start_date, end_date = Date.today)
+        report_request("Campaign", campaign_id, report_ids, start_date, end_date)
+      end
+
+      def section_report(section_id, report_ids, start_date = nil, end_date = Date.today)
+        report_request("Section", site_id, report_ids, start_date, end_date)
+      end
+
+      def site_report(site_id, report_ids, start_date = nil, end_date = Date.today)
+        report_request("Site", site_id, report_ids, start_date = Date.today, end_date)
+      end
+
+      def site_performance_report(site_ids = "", start_date = nil, end_date = Date.today)
+        request("SitePerformanceReport") do |xml|
+          xml.SitePerformanceReport {
+            xml.Ids {
+              site_ids.split(",").each do |s|
+                xml.Id s
+              end
+            }
+            xml.StartDate start_date
+            xml.EndDate end_date
+            xml.Table "Performance.Site.Base.T100.03"
+          }
+        end
+      end
+
+      def page_priority_report(page_url)
+        request("PagePriorityReport") do |xml|
+          xml.PagePriorityReport {
+            xml.Id page_url
+            xml.Table "Delivery.Page.Base.T100.05"
+          }
+        end
+      end
+
+      def campaign_status_report
+        request("StatusReport") do |xml|
+          xml.StatusReport(:type => "Campaign") {
+            xml.Table "ImpressionCampaignStatusDetail"
+          }
+        end
+      end
+
+      private
+      def report_request(type, id, report_ids, start_date, end_date)
+        raise NoReportTablesError.new if report_ids.blank?
+        request("Report") do |xml|
+          xml.Report(:type => type) {
+            xml.Id id
+            xml.StartDate start_date
+            xml.EndDate end_date
+            report_ids.split(",").each do |r|
+              xml.Table r
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/oas/client.rb

@@ -1,15 +1,17 @@
 module Oas
   class Client < Api
+    class Error < StandardError; end
+
     require 'oas/client/utils'
-    require 'oas/client/campaign'
-    require 'oas/client/creative'
-    require 'oas/client/database'
-    require 'oas/client/notification'
+    require 'oas/client/campaigns'
+    require 'oas/client/databases'
+    require 'oas/client/notifications'
+    require 'oas/client/reports'
     
     include Oas::Client::Utils
-    include Oas::Client::Campaign
-    include Oas::Client::Creative
-    include Oas::Client::Database
-    include Oas::Client::Notification
+    include Oas::Client::Campaigns
+    include Oas::Client::Databases
+    include Oas::Client::Notifications
+    include Oas::Client::Reports
   end
 end

data/lib/oas/version.rb

@@ -1,3 +1,3 @@
 module Oas
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/oas/client/{creative_spec.rb → campaigns_spec.rb}

@@ -1,6 +1,19 @@
 require 'spec_helper'
 
 describe Oas::Client do
+  describe "campaign" do
+    before(:each) do
+      stub_api_call fixture("read_campaign.xml")
+    end
+
+    it "should return a campaign hash for a given id" do
+      response = Oas.campaign("campaign_id")
+      response.should_not be_nil
+      response[:Campaign].should be_a(Hash)
+      response[:Campaign][:Overview][:Id].should eq("campaign_id")
+    end
+  end
+
   describe "creative" do
     before(:each) do
       stub_api_call fixture("read_creative.xml")

metadata

@@ -2,7 +2,7 @@
 name: oas
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Damian Caruso
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-12 00:00:00 -03:00
+date: 2011-05-19 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,10 +87,10 @@ files:
 - lib/oas.rb
 - lib/oas/api.rb
 - lib/oas/client.rb
-- lib/oas/client/campaign.rb
-- lib/oas/client/creative.rb
-- lib/oas/client/database.rb
-- lib/oas/client/notification.rb
+- lib/oas/client/campaigns.rb
+- lib/oas/client/databases.rb
+- lib/oas/client/notifications.rb
+- lib/oas/client/reports.rb
 - lib/oas/client/utils.rb
 - lib/oas/configuration.rb
 - lib/oas/core_ext/hash.rb
@@ -111,10 +111,9 @@ files:
 - spec/fixtures/read_site.xml
 - spec/fixtures/read_site_group.xml
 - spec/fixtures/wsdl.xml
-- spec/oas/client/campaign_spec.rb
-- spec/oas/client/creative_spec.rb
-- spec/oas/client/database_spec.rb
-- spec/oas/client/notification_spec.rb
+- spec/oas/client/campaigns_spec.rb
+- spec/oas/client/databases_spec.rb
+- spec/oas/client/notifications_spec.rb
 - spec/oas_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/oas/client/creative.rb

@@ -1,15 +0,0 @@
-module Oas
-  class Client
-    # Defines methods related to oas campaign creatives
-    module Creative
-      def creative(campaign_id, id)
-        request("Creative") do |xml|
-          xml.Creative(:action => "read") {
-            xml.CampaignId campaign_id
-            xml.Id id
-          }
-        end
-      end      
-    end
-  end
-end

data/spec/oas/client/campaign_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-
-describe Oas::Client do
-  describe "campaign" do
-    before(:each) do
-      stub_api_call fixture("read_campaign.xml")
-    end
-
-    it "should return a campaign hash for a given id" do
-      response = Oas.campaign("campaign_id")
-      response.should_not be_nil
-      response[:Campaign].should be_a(Hash)
-      response[:Campaign][:Overview][:Id].should eq("campaign_id")
-    end
-  end
-end