oas 0.1.2 → 1.2.0

data/lib/oas/api.rb

@@ -1,56 +0,0 @@
-require 'nokogiri'
-require 'httpclient'
-require 'savon'
-
-module Oas
-  class Api
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
-      
-    def initialize(options={})
-      options = Oas.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
-      end
-    end
-
-    def request(request_type, &block)
-      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
-        xml.AdXML {
-          xml.Request(:type => request_type) {
-            yield(xml) if block_given?
-          }
-        }
-      end
-      response = webservice.request :n1, :oas_xml_request, :"xmlns:n1" => "http://api.oas.tfsm.com/" do
-        soap.body = {
-          "String_1" => account.to_s,
-          "String_2" => username.to_s,
-          "String_3" => password.to_s,
-          "String_4" => xml.to_xml
-        }
-      end
-      response = Hash.from_xml(response.to_hash[:oas_xml_request_response][:result])[:AdXML][:Response]
-      verify_errors(response)
-      response
-    end
-  
-    private
-    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
-      when 550
-         raise Oas::InvalidSite.new(error_msg, error_code)
-      when 551
-         raise Oas::InvalidPage.new(error_msg, error_code)
-      else
-         raise Oas::Error.new(error_msg, error_code)
-      end
-    end
-    
-    def webservice
-      @webservice ||= Savon::Client.new(endpoint)
-    end
-  end
-end

data/lib/oas/client/campaigns.rb

@@ -1,25 +0,0 @@
-module Oas
-  class Client
-    # Defines methods related to oas campaigns
-    module Campaigns
-      def campaign(id)
-        request("Campaign") do |xml|
-          xml.Campaign(:action => "read") {
-            xml.Overview {
-              xml.Id id
-            }
-          }
-        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/databases.rb

@@ -1,96 +0,0 @@
-module Oas
-  class Client
-    # Defines methods related to oas databases section
-    module Databases
-      def advertiser(id)
-        request("Advertiser") do |xml|
-          xml.Database(:action => "read") {
-            xml.Advertiser {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def agency(id)
-        request("Agency") do |xml|
-          xml.Database(:action => "read") {
-            xml.Agency {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def campaign_group(id)
-        request("CampaignGroup") do |xml|
-          xml.Database(:action => "read") {
-            xml.CampaignGroup {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def keyname(name)
-        request("Keyname") do |xml|
-          xml.Database(:action => "read") {
-            xml.Keyname {
-              xml.Name name
-            }
-          }
-        end
-      end
-
-      def keyword(id)
-        request("Keyword") do |xml|
-          xml.Database(:action => "read") {
-            xml.Keyword {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def page(url)
-        request("Page") do |xml|
-          xml.Database(:action => "read") {
-            xml.Page {
-              xml.Url url
-            }
-          }
-        end
-      end
-
-      def section(id)
-        request("Section") do |xml|
-          xml.Database(:action => "read") {
-            xml.Section {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def site(id)
-        request("Site") do |xml|
-          xml.Database(:action => "read") {
-            xml.Site {
-              xml.Id id
-            }
-          }
-        end
-      end
-
-      def site_group(id)
-        request("SiteGroup") do |xml|
-          xml.Database(:action => "read") {
-            xml.SiteGroup {
-              xml.Id id
-            }
-          }
-        end
-      end
-    end
-  end
-end

data/lib/oas/client/notifications.rb

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

data/lib/oas/client/reports.rb

@@ -1,71 +0,0 @@
-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/utils.rb

@@ -1,16 +0,0 @@
-module Oas
-  class Client
-    module Utils
-      private
-      def build_attributes(xml, attributes = {})
-        attributes.each do |key,value|
-          if value.is_a?(Hash)
-            build_attributes(xml, value)
-          else
-            xml.send(key.to_sym, value)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/oas/core_ext/hash.rb

@@ -1,57 +0,0 @@
-require 'nokogiri'
-
-class Hash
-  class << self
-    def from_xml(xml_io)
-      result = Nokogiri::XML(xml_io)
-      return { result.root.name.to_sym => xml_node_to_hash(result.root) }
-    end
-
-    def xml_node_to_hash(node)
-      # If we are at the root of the document, start the hash
-      if node.element?
-        result_hash = {}
-        if node.attributes != {}          
-          node.attributes.keys.each do |key|
-            result_hash[node.attributes[key].name.to_sym] = prepare(node.attributes[key].value)
-          end
-        end
-        if node.children.size > 0
-          node.children.each do |child|            
-            result = xml_node_to_hash(child)
-
-            if child.name == "text"
-              unless child.next_sibling || child.previous_sibling
-                result = prepare(result)
-                return result if result_hash.empty?
-                result_hash[:content] = result
-                return result_hash
-              end
-            elsif result_hash[child.name.to_sym]
-              if result_hash[child.name.to_sym].is_a?(Object::Array)
-                result_hash[child.name.to_sym] << prepare(result)
-              else
-                result_hash[child.name.to_sym] = [result_hash[child.name.to_sym]] << prepare(result)
-              end
-            else
-              result_hash[child.name.to_sym] = prepare(result)              
-            end
-          end
-          return result_hash
-        else
-          return nil
-        end 
-      else 
-        return prepare(node.content.to_s) 
-      end 
-    end          
-
-    def prepare(data)
-      (data.class == String && data.to_i.to_s == data) ? data.to_i : data
-    end
-  end
-  
-  def to_struct(struct_name)
-    Struct.new(struct_name,*keys).new(*values)
-  end
-end

data/lib/oas/core_ext/object.rb

@@ -1,6 +0,0 @@
-class Object
-  # From activesupport/lib/active_support/core_ext/object/blank.rb, line 12
-  def blank?
-    respond_to?(:empty?) ? empty? : !self
-  end
-end

data/lib/oas/error.rb

@@ -1,17 +0,0 @@
-module Oas
-  # Custom error class for rescuing from all Oas errors
-  class Error < StandardError
-    attr_reader :error_code
-
-    def initialize(message, error_code)
-      @error_code = error_code
-      super message
-    end
-  end
-  
-  # Raised when Oas returns the error code 550
-  class InvalidSite < Error; end
-  
-  # Raised when Oas returns the error code 551
-  class InvalidUrl < Error; end
-end

data/spec/fixtures/read_advertiser.xml

@@ -1,49 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
-                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
-                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <soapenv:Body>
-    <ns1:OasXmlRequestResponse xmlns:ns1="http://api.oas.tfsm.com/">
-      <result>
-        <![CDATA[
-        <?xml version="1.0"?>
-        <AdXML>
-          <Response>
-             <Advertiser>
-               <Id>advertiser_id</Id>
-               <Organization>A Company Name</Organization>
-               <Notes></Notes>
-               <ContactFirstName></ContactFirstName>
-               <ContactLastName></ContactLastName>
-               <ContactTitle></ContactTitle>
-               <Email></Email>
-               <Phone></Phone>
-               <Fax></Fax>
-               <ExternalUsers/>
-               <BillingInformation>
-                 <Method>
-                  <Code>O</Code>
-                 </Method>
-                 <Address>test address2</Address>
-                 <City>Philadelphia</City>
-                 <State>
-                  <Code>US:PA</Code>
-                 </State>
-                 <Country>
-                  <Code>US</Code>
-                 </Country>
-                 <Zip>20007</Zip>
-                 <Email>testmail@247realmeida.com</Email>
-               </BillingInformation>
-               <WhoCreated>realmedia</WhoCreated>
-               <WhenCreated>01/20/2008 20:59:29</WhenCreated>
-               <WhoModified>realmedia</WhoModified>
-               <WhenModified>01/20/2008 21:22:33</WhenModified>
-             </Advertiser>
-          </Response>
-        </AdXML>
-        ]]>
-      </result>
-    </ns1:OasXmlRequestResponse>
-  </soapenv:Body>
-</soapenv:Envelope>

data/spec/fixtures/read_agency.xml

@@ -1,49 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
-                  xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
-                  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-  <soapenv:Body>
-    <ns1:OasXmlRequestResponse xmlns:ns1="http://api.oas.tfsm.com/">
-      <result>
-        <![CDATA[
-        <?xml version="1.0"?>
-        <AdXML>
-          <Response>
-            <Agency>
-              <Id>agency_id</Id>
-              <Organization>A Company Name</Organization>
-              <Notes>This Agency was added through the API.(With Billing Info)</Notes>
-              <ContactFirstName>Nobody</ContactFirstName>
-              <ContactLastName>Kim</ContactLastName>
-              <ContactTitle>Senior Engineer</ContactTitle>
-              <Email>nobody@247realmedia.com</Email>
-              <Phone>123-123-1234</Phone>
-              <Fax>123-123-1235</Fax>
-              <ExternalUsers>
-              <UserId>ExtUser1</UserId>
-              <UserId>ExtUser2</UserId>
-              </ExternalUsers>
-              <BillingInformation>
-                <Method>
-                  <Code>M</Code>
-                </Method>
-                <Address>51-12 BANPO 4-DONG SEOCHO-GU, SEOUL, SOUTH KOREA</Address>
-                <City>SEOUL</City>
-                <State>
-                  <Code>KR:SOULTUKPYOLS</Code>
-                </State>
-                <Country>
-                  <Code>KR</Code>
-                </Country>
-                <Zip>137-802</Zip>
-              </BillingInformation>
-              <InternalQuickReport>short</InternalQuickReport>
-              <ExternalQuickReport>to-date</ExternalQuickReport>
-            </Agency>
-          </Response>
-        </AdXML>
-        ]]>
-      </result>
-    </ns1:OasXmlRequestResponse>
-  </soapenv:Body>
-</soapenv:Envelope>