oas 2.1.2 → 2.1.3

data/lib/oas/client.rb

@@ -1,56 +1,59 @@
-require 'oas/adxml'
-require 'savon'
-
-module OAS
-  class Client
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
-
-    def initialize(opts={})
-      options = OAS.options.merge(opts)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
-      end
-
-      @savon = Savon::Client.new do |client|
-        client.endpoint endpoint.to_s
-        client.namespace "http://api.oas.tfsm.com/"
-        client.namespace_identifier :n1
-        client.convert_request_keys_to :camelcase
-        client.open_timeout timeout.to_i
-        client.read_timeout timeout.to_i
-        client.ssl_verify_mode :none
-        client.logger logger
-        client.log !!logger
-      end
-    end
-
-    def execute(request)
-      response = @savon.call :oas_xml_request, message: Hash["String_1", account.to_s, "String_2", username.to_s, "String_3", password.to_s, "String_4", request.to_xml.to_s]
-      OAS::AdXML.parse response.body[:oas_xml_request_response][:result]
-    rescue Savon::HTTPError => e
-      _raise_http_error!(e)
-    rescue Savon::InvalidResponseError => e
-      raise OAS::Error.new(e.message)
-    end
-
-    private
-
-    def _raise_http_error!(e)
-      case e.http.code
-      when 403
-        raise OAS::Error::HTTP::Forbidden.new
-      when 500
-        raise OAS::Error::HTTP::InternalServerError.new
-      when 502
-        raise OAS::Error::HTTP::BadGateway.new
-      when 503
-        raise OAS::Error::HTTP::ServiceUnavailable.new
-      when 504
-        raise OAS::Error::HTTP::GatewayTimeout.new
-      else
-        raise OAS::Error::HTTP.new(e.to_s)
-      end
-    end
-
-  end
+require 'oas/adxml'
+require 'savon'
+
+module OAS
+  class Client
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    def initialize(opts={})
+      options = OAS.options.merge(opts)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+
+      @savon = Savon::Client.new do |client|
+        client.endpoint endpoint.to_s
+        client.namespace "http://api.oas.tfsm.com/"
+        client.namespace_identifier :n1
+        client.convert_request_keys_to :camelcase
+        client.open_timeout timeout.to_i
+        client.read_timeout timeout.to_i
+        client.ssl_verify_mode :none
+        client.logger logger
+        client.log !!logger
+      end
+    end
+
+    def execute(request)
+      response = @savon.call :oas_xml_request, message: Hash["String_1", account.to_s, "String_2", username.to_s, "String_3", password.to_s, "String_4", request.to_xml.to_s]
+      doc = OAS::AdXML.parse(response.body[:oas_xml_request_response][:result])
+      doc.http_headers = response.http.headers
+      doc
+    rescue Savon::HTTPError => e
+      _raise_http_error!(e)
+    rescue Savon::InvalidResponseError => e
+      raise OAS::Error.new(e.message)
+    end
+
+    private
+
+    def _raise_http_error!(e)
+      case e.http.code
+      when 403
+        klass = OAS::Error::HTTP::Forbidden
+      when 500
+        klass = OAS::Error::HTTP::InternalServerError
+      when 502
+        klass = OAS::Error::HTTP::BadGateway
+      when 503
+        klass = OAS::Error::HTTP::ServiceUnavailable
+      when 504
+        klass = OAS::Error::HTTP::GatewayTimeout
+      else
+        klass = OAS::Error::HTTP
+      end
+      raise klass.new(e.http.code, e.http.headers, e.http.body)
+    end
+
+  end
 end

data/lib/oas/configuration.rb

@@ -1,52 +1,52 @@
-module OAS
-  module Configuration
-    # An array of valid keys in the options hash when configuring a {OAS::Client}
-    VALID_OPTIONS_KEYS = [
-      :endpoint,      
-      :account,
-      :username,
-      :password,
-      :timeout,
-      :logger].freeze
-    
-    # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = "https://oas.realmediadigital.com/oasapi/OaxApi".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
-
-    # By default, set open and read timeout to 300
-    DEFAULT_TIMEOUT = 300
-    
-    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
-      self.timeout    = DEFAULT_TIMEOUT
-      self.logger     = nil
-    end
-  end
+module OAS
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {OAS::Client}
+    VALID_OPTIONS_KEYS = [
+      :endpoint,      
+      :account,
+      :username,
+      :password,
+      :timeout,
+      :logger].freeze
+    
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "https://oas.realmediadigital.com/oasapi/OaxApi".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
+
+    # By default, set open and read timeout to 300
+    DEFAULT_TIMEOUT = 300
+    
+    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
+      self.timeout    = DEFAULT_TIMEOUT
+      self.logger     = nil
+    end
+  end
 end

data/lib/oas/error.rb

@@ -1,9 +1,19 @@
-module OAS
-  class Error < StandardError; end
-  class Error::HTTP < Error; end
-  class Error::HTTP::Forbidden < Error::HTTP; end
-  class Error::HTTP::BadGateway < Error::HTTP; end
-  class Error::HTTP::GatewayTimeout < Error::HTTP; end
-  class Error::HTTP::InternalServerError < Error::HTTP; end
-  class Error::HTTP::ServiceUnavailable < Error::HTTP; end
+module OAS
+  class Error < StandardError; end
+
+  class Error::HTTP < Error
+    attr_reader :code, :headers, :body
+
+    def initialize(code, headers, body)
+      @code    = code
+      @headers = headers
+      @body    = body
+    end
+  end
+
+  class Error::HTTP::Forbidden < Error::HTTP; end
+  class Error::HTTP::BadGateway < Error::HTTP; end
+  class Error::HTTP::GatewayTimeout < Error::HTTP; end
+  class Error::HTTP::InternalServerError < Error::HTTP; end
+  class Error::HTTP::ServiceUnavailable < Error::HTTP; end
 end

data/lib/oas/version.rb

@@ -1,3 +1,3 @@
-module OAS
-  VERSION = '2.1.2'
-end
+module OAS
+  VERSION = '2.1.3'
+end

data/oas.gemspec

@@ -1,29 +1,29 @@
-# -*- 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/oas-ruby-client"
-  s.summary     = %q{Ruby client for the OpenAdstream API}
-  s.description = %q{Ruby client for the OpenAdstream API}
-  s.licenses    = ['MIT']
-
-  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 "nokogiri", "~> 1.5"
-  s.add_dependency "nori",     "~> 2.0"
-  s.add_dependency "savon",    "~> 2.0"
-  
-  s.add_development_dependency "rake",    "~> 0.9"
-  s.add_development_dependency "webmock", "~> 1.9"
-end
+# -*- 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/oas-ruby-client"
+  s.summary     = %q{Ruby client for the OpenAdstream API}
+  s.description = %q{Ruby client for the OpenAdstream API}
+  s.licenses    = ['MIT']
+
+  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 "nokogiri", "~> 1.5"
+  s.add_dependency "nori",     "~> 2.0"
+  s.add_dependency "savon",    "~> 2.0"
+  
+  s.add_development_dependency "rake",    "~> 0.9"
+  s.add_development_dependency "webmock", "~> 1.9"
+end

data/test/fixtures/response.xml

@@ -1,15 +1,15 @@
-<?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></Response></AdXML>
-        ]]>
-      </result>
-    </ns1:OasXmlRequestResponse>
-  </soapenv:Body>
+<?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></Response></AdXML>
+        ]]>
+      </result>
+    </ns1:OasXmlRequestResponse>
+  </soapenv:Body>
 </soapenv:Envelope>

data/test/helper.rb

@@ -1,2 +1,2 @@
-require 'minitest/autorun'
+require 'minitest/autorun'
 require 'oas'

data/test/test_adxml.rb

@@ -1,69 +1,73 @@
-require 'helper'
-
-class TestAdXML < MiniTest::Unit::TestCase
-  def setup
-    @doc = OAS::AdXML.new
-  end
-
-  def test_set_encoding
-    assert_match 'UTF-8', @doc.to_xml
-  end
-
-  def test_set_root_node
-    new_doc = Nokogiri.XML @doc.to_xml
-    assert_equal 'AdXML', new_doc.root.name
-  end
-
-  def test_convert_to_hash
-    assert @doc.to_hash.has_key?(:AdXML)
-  end
-
-  def test_adxml_parsing
-    assert_kind_of OAS::AdXML, OAS::AdXML.parse("<AdXML></AdXML>")
-  end
-
-  def test_response_iterator
-    str = <<-EOXML
-    <AdXML>
-      <Response>
-        <Campaign/>
-      </Response>
-      <Response>
-        <Campaign/>
-      </Response>
-    </AdXML>
-    EOXML
-    responses = []
-    doc = OAS::AdXML.new Nokogiri.XML(str)
-    doc.each_response do |res|
-      responses << res
-      assert_kind_of OAS::AdXML::Response, res
-      assert_equal 'Response', Nokogiri.XML(res.to_xml).root.name
-    end
-    assert_equal 2, responses.size
-  end
-
-  def test_request_builder
-    @doc.request do |req|
-      req.Site do |xml|
-        assert_kind_of Nokogiri::XML::Builder, xml
-      end
-    end
-
-    new_doc = Nokogiri.XML(@doc.to_xml)
-    assert_equal 1, new_doc.xpath("/AdXML/Request[@type='Site']").length
-  end
-
-  def test_chain_request_blocks
-    @doc.request do |req|
-      req.Site
-      req.Site
-    end
-    @doc.request do |req|
-      req.Campaign
-    end
-
-    new_doc = Nokogiri.XML(@doc.to_xml)
-    assert_equal 3, new_doc.xpath('/AdXML/Request').length
-  end
+require 'helper'
+
+class TestAdXML < MiniTest::Unit::TestCase
+  def setup
+    @doc = OAS::AdXML.new
+  end
+
+  def test_http_headers
+    assert_kind_of Hash, @doc.http_headers
+  end
+
+  def test_set_encoding
+    assert_match 'UTF-8', @doc.to_xml
+  end
+
+  def test_set_root_node
+    new_doc = Nokogiri.XML @doc.to_xml
+    assert_equal 'AdXML', new_doc.root.name
+  end
+
+  def test_convert_to_hash
+    assert @doc.to_hash.has_key?(:AdXML)
+  end
+
+  def test_adxml_parsing
+    assert_kind_of OAS::AdXML, OAS::AdXML.parse("<AdXML></AdXML>")
+  end
+
+  def test_response_iterator
+    str = <<-EOXML
+    <AdXML>
+      <Response>
+        <Campaign/>
+      </Response>
+      <Response>
+        <Campaign/>
+      </Response>
+    </AdXML>
+    EOXML
+    responses = []
+    doc = OAS::AdXML.new Nokogiri.XML(str)
+    doc.each_response do |res|
+      responses << res
+      assert_kind_of OAS::AdXML::Response, res
+      assert_equal 'Response', Nokogiri.XML(res.to_xml).root.name
+    end
+    assert_equal 2, responses.size
+  end
+
+  def test_request_builder
+    @doc.request do |req|
+      req.Site do |xml|
+        assert_kind_of Nokogiri::XML::Builder, xml
+      end
+    end
+
+    new_doc = Nokogiri.XML(@doc.to_xml)
+    assert_equal 1, new_doc.xpath("/AdXML/Request[@type='Site']").length
+  end
+
+  def test_chain_request_blocks
+    @doc.request do |req|
+      req.Site
+      req.Site
+    end
+    @doc.request do |req|
+      req.Campaign
+    end
+
+    new_doc = Nokogiri.XML(@doc.to_xml)
+    assert_equal 3, new_doc.xpath('/AdXML/Request').length
+  end
 end