oas 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.redcar
+.rvmrc
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ruby-oas.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Realmedia LatinAmerica
+
+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.markdown

@@ -0,0 +1,69 @@
+OAS API Ruby Gem
+====================
+A Ruby wrapper for OAS 7.4 API
+
+Installation
+------------
+    gem install oas
+
+Usage Examples
+--------------
+    require "rubygems"
+    require "oas"
+
+    # All methods require authentication.
+    Oas.configure do |config|
+      config.endpoint = WSDL_URI
+      config.account  = YOUR_OAS_ACCOUNT
+      config.username = YOUR_USERNAME
+      config.password = YOUR_PASSWORD
+    end
+
+    # Read an advertiser
+    puts Oas.advertiser("advertiser_id")
+
+    # Read an agency
+    puts Oas.agency("agency_id")
+
+    # Read a campaign
+    puts Oas.campaign("campaign_id")
+
+    # Read a campaign group
+    puts Oas.campaign_group("campaign_group_id")
+
+    # Read a creative
+    puts Oas.creative("campaign_id", "creative_id")
+
+    # Read a keyname
+    puts Oas.keyname("keyname")
+
+    # Read a keyword
+    puts Oas.keyword("keyword_id")
+
+    # Read a notification
+    puts Oas.notification("campaign_id", "event_name")
+
+    # Read a page
+    puts Oas.page("page_url")
+
+    # Read a section
+    puts Oas.section("section_id")
+
+    # Read a site
+    puts Oas.site("site_id")
+
+    # Read a site group
+    puts Oas.site_group("site_group_id")
+
+TODO
+------------
+
+* Create and update support on Campaign and Database sections.
+* Listings
+* Reports
+* Inventory
+
+Copyright
+---------
+Copyright (c) 2011 Realmedia LatinAmerica.
+See [LICENSE](https://github.com/realmedia/ruby-oas/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :test => :spec
+task :default => :spec

data/lib/oas/api.rb

@@ -0,0 +1,56 @@
+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(request_type, response)
+      response
+    end
+  
+    private
+    def verify_errors(request_type, response)
+      return if (e = response[:Exception]).nil? && (e = response[request_type.to_sym][: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/campaign.rb

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

data/lib/oas/client/creative.rb

@@ -0,0 +1,15 @@
+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/lib/oas/client/database.rb

@@ -0,0 +1,96 @@
+module Oas
+  class Client
+    # Defines methods related to oas database section
+    module Database
+      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/notification.rb

@@ -0,0 +1,15 @@
+module Oas
+  class Client
+    # Defines methods related to oas campaigns
+    module Notification
+      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/utils.rb

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

@@ -0,0 +1,15 @@
+module Oas
+  class Client < Api
+    require 'oas/client/utils'
+    require 'oas/client/campaign'
+    require 'oas/client/creative'
+    require 'oas/client/database'
+    require 'oas/client/notification'
+    
+    include Oas::Client::Utils
+    include Oas::Client::Campaign
+    include Oas::Client::Creative
+    include Oas::Client::Database
+    include Oas::Client::Notification
+  end
+end

data/lib/oas/configuration.rb

@@ -0,0 +1,45 @@
+module Oas
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Twitter::Client}
+    VALID_OPTIONS_KEYS = [
+      :endpoint,      
+      :account,
+      :username,
+      :password].freeze
+    
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "https://oas.realmedianetwork.net/oasapi/OaxApi?wsdl".freeze
+    
+    # The account that will be used to connect if none is set
+    DEFAULT_ACCOUNT = "OasDefault"
+    
+    # By default, don't set a username
+    DEFAULT_USERNAME = nil
+    
+    # By default, don't set a password
+    DEFAULT_PASSWORD = nil
+    
+    attr_accessor *VALID_OPTIONS_KEYS
+    
+    def self.extended(base)
+      base.reset
+    end
+    
+    def configure
+      yield self if block_given?
+    end
+    
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k) }
+      options
+    end
+    
+    def reset
+      self.endpoint   = DEFAULT_ENDPOINT
+      self.account    = DEFAULT_ACCOUNT
+      self.username   = DEFAULT_USERNAME
+      self.password   = DEFAULT_PASSWORD
+    end
+  end
+end

data/lib/oas/core_ext/hash.rb

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

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

@@ -0,0 +1,17 @@
+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/lib/oas/version.rb

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

data/lib/oas.rb

@@ -0,0 +1,31 @@
+Dir[File.join(File.dirname(__FILE__),'oas/core_ext/**/*.rb')].each {|f| require f}
+
+require 'oas/version'
+require 'oas/error'
+require 'oas/configuration'
+require 'oas/api'
+require 'oas/client'
+
+module Oas
+  extend Configuration
+
+  # Alias for Oas::Client.new
+  #
+  # @return [Oas::Client]
+  def self.client(options={})
+    Oas::Client.new(options)
+  end
+  
+  # Delegate to Oas::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private = false)
+    client.respond_to?(method, include_private) || super(method, include_private)
+  end
+
+  HTTPI.log = false
+  Savon.configure { |c| c.log = false }
+end

data/oas.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "oas/version"
+
+Gem::Specification.new do |s|
+  s.name        = "oas"
+  s.version     = Oas::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Damian Caruso"]
+  s.email       = ["damian.caruso@gmail.com"]
+  s.homepage    = "http://github.com/realmedia/ruby-oas"
+  s.summary     = %q{Ruby wrapper for the OAS 7.4 API}
+  s.description = %q{Ruby wrapper for the OAS 7.4 API}
+
+  s.rubyforge_project = "oas"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "httpclient", "~> 2.2.0.2"
+  s.add_dependency "nokogiri", "~> 1.4.4"
+  s.add_dependency "savon", "~> 0.9.2"
+  
+  s.add_development_dependency "rspec", "~> 2.5.0"
+  s.add_development_dependency "webmock", "~> 1.6.2"
+end

data/spec/fixtures/read_advertiser.xml

@@ -0,0 +1,49 @@
+<?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

@@ -0,0 +1,49 @@
+<?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>