wasabi 2.3.0 → 2.4.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.4.0 (2012-06-08)
+
+* Feature: `Wasabi::Document` now accepts either a URL of a remote document,
+  a path to a local file or raw XML. The code for this was moved from Savon over
+  here as a first step towards supporting WSDL imports.
+
 ## 2.3.0 (2012-06-07)
 
 * Improvement: [#3](https://github.com/rubiii/wasabi/pull/3) adds object inheritance.

data/lib/wasabi.rb

@@ -1,5 +1,6 @@
 require "wasabi/version"
 require "wasabi/document"
+require "wasabi/resolver"
 
 module Wasabi
 

data/lib/wasabi/document.rb

@@ -1,4 +1,5 @@
 require "nokogiri"
+require "wasabi/resolver"
 require "wasabi/parser"
 
 module Wasabi
@@ -24,12 +25,9 @@ module Wasabi
       self.document = document
     end
 
-    attr_accessor :document
+    attr_accessor :document, :request, :xml
 
-    # Returns whether a +document+ was set.
-    def document?
-      !!document
-    end
+    alias_method :document?, :document
 
     # Returns the SOAP endpoint.
     def endpoint
@@ -49,7 +47,7 @@ module Wasabi
 
     # Returns the value of elementFormDefault.
     def element_form_default
-      @element_form_default ||= xml? ? parser.element_form_default : :unqualified
+      @element_form_default ||= document ? parser.element_form_default : :unqualified
     end
 
     # Sets the elementFormDefault value.
@@ -84,7 +82,7 @@ module Wasabi
         parser.types.each do |type, info|
           namespaces << [[type], info[:namespace]]
           (info.keys - [:namespace]).each { |field| namespaces << [[type, field], info[:namespace]] }
-        end if document?
+        end if document
         namespaces
       end
     end
@@ -98,7 +96,7 @@ module Wasabi
             tag, namespace = field_type.split(":").reverse
             result << [[type, field], tag] if user_defined(namespace)
           end
-        end if document?
+        end if document
         result
       end
     end
@@ -112,12 +110,7 @@ module Wasabi
     # Returns the raw WSDL document.
     # Can be used as a hook to extend the library.
     def xml
-      @xml ||= document
-    end
-
-    # Returns whether there is a WSDL document to parse.
-    def xml?
-      xml.kind_of?(String)
+      @xml ||= Resolver.new(document, request).xml
     end
 
     # Parses the WSDL document and returns the <tt>Wasabi::Parser</tt>.
@@ -129,7 +122,7 @@ module Wasabi
 
     # Raises an error if the WSDL document is missing.
     def guard_parse
-      return true if xml?
+      return true if document
       raise ArgumentError, "Wasabi needs a WSDL document"
     end
 

data/lib/wasabi/resolver.rb

@@ -0,0 +1,46 @@
+require "httpi"
+
+module Wasabi
+
+  # = Wasabi::Resolver
+  #
+  # Resolves local and remote WSDL documents.
+  class Resolver
+
+    class HTTPError < StandardError; end
+
+    def initialize(document, request = nil)
+      @document = document
+      @request = request
+    end
+
+    def xml
+      raise ArgumentError, "Wasabi is missing a document to resolve" unless @document
+
+      case @document
+        when /^http[s]?:/ then from_remote
+        when /^</         then @document
+        else                   from_fs
+      end
+    end
+
+    private
+
+    def from_remote
+      response = HTTPI.get(request)
+      raise HTTPError.new(response) if response.error?
+      response.body
+    end
+
+    def request
+      @request ||= HTTPI::Request.new
+      @request.url = @document
+      @request
+    end
+
+    def from_fs
+      File.read(@document)
+    end
+
+  end
+end

data/lib/wasabi/version.rb

@@ -1,5 +1,5 @@
 module Wasabi
 
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 
 end

data/spec/spec_helper.rb

@@ -5,5 +5,5 @@ support_files = File.expand_path("spec/support/**/*.rb")
 Dir[support_files].each { |file| require file }
 
 RSpec.configure do |config|
-  config.include Fixture
+  config.include SpecSupport::Methods
 end

data/spec/support/fixture.rb

@@ -1,20 +1,42 @@
-module Fixture
+module SpecSupport
 
-  def self.[](name)
-    fixtures[name]
-  end
+  class Fixture
+    def self.[](name)
+      fixtures[name]
+    end
 
-  def self.[]=(name, value)
-    fixtures[name] = value
-  end
+    def self.[]=(name, value)
+      fixtures[name] = value
+    end
+
+    def self.fixtures
+      @fixtures ||= {}
+    end
+
+    def initialize(file, ext = :wsdl)
+      self.file = file
+      self.ext = ext
+    end
+
+    attr_accessor :file, :ext
+
+    def filename
+      "#{file}.#{ext}"
+    end
+
+    def path
+      File.expand_path("spec/fixtures/#{filename}")
+    end
 
-  def self.fixtures
-    @fixtures ||= {}
+    def read
+      Fixture[filename] ||= File.read(path)
+    end
   end
 
-  def fixture(file, ext = :wsdl)
-    filename = "#{file}.#{ext}"
-    Fixture[filename] ||= File.read File.expand_path("spec/fixtures/#{filename}")
+  module Methods
+    def fixture(*args)
+      Fixture.new(*args)
+    end
   end
 
 end

data/spec/wasabi/document/authentication_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: authentication.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:authentication) }
+    subject { Wasabi::Document.new fixture(:authentication).read }
 
     its(:namespace) { should == "http://v1_0.ws.auth.order.example.com/" }
 

data/spec/wasabi/document/geotrust_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: geotrust.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:geotrust) }
+    subject { Wasabi::Document.new fixture(:geotrust).read }
 
     its(:namespace) { should == "http://api.geotrust.com/webtrust/query" }
 

data/spec/wasabi/document/inherited_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: inherited.xml" do
 
-    subject { Wasabi::Document.new fixture(:inherited) }
+    subject { Wasabi::Document.new fixture(:inherited).read }
 
     its(:type_definitions) do
       should include([["Account", "Id"], "ID"])

data/spec/wasabi/document/multiple_namespaces_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: multiple_namespaces.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:multiple_namespaces) }
+    subject { Wasabi::Document.new fixture(:multiple_namespaces).read }
 
     its(:namespace) { should == "http://example.com/actions" }
 

data/spec/wasabi/document/namespaced_actions_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: namespaced_actions.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:namespaced_actions) }
+    subject { Wasabi::Document.new fixture(:namespaced_actions).read }
 
     its(:namespace) { should == "http://api.example.com/api/" }
 

data/spec/wasabi/document/no_namespace_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: no_namespace.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:no_namespace) }
+    subject { Wasabi::Document.new fixture(:no_namespace).read }
 
     its(:namespace) { should == "urn:ActionWebService" }
 

data/spec/wasabi/document/soap12_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: soap12.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:soap12) }
+    subject { Wasabi::Document.new fixture(:soap12).read }
 
     its(:endpoint) { should == URI("http://blogsite.example.com/endpoint12") }
 

data/spec/wasabi/document/two_bindings_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe Wasabi::Document do
   context "with: two_bindings.wsdl" do
 
-    subject { Wasabi::Document.new fixture(:two_bindings) }
+    subject { Wasabi::Document.new fixture(:two_bindings).read }
 
     its(:element_form_default) { should == :unqualified }
 

data/spec/wasabi/document_spec.rb

@@ -2,7 +2,26 @@ require "spec_helper"
 
 describe Wasabi::Document do
 
-  subject { Wasabi::Document.new }
+  subject { Wasabi::Document.new fixture(:authentication).read }
+
+  describe ".new" do
+    it "accepts a URL" do
+      HTTPI.expects(:get).returns(HTTPI::Response.new(200, {}, "wsdl"))
+
+      document = Wasabi::Document.new("http://example.com?wsdl")
+      document.xml.should == "wsdl"
+    end
+
+    it "accepts a path" do
+      document = Wasabi::Document.new fixture(:authentication).path
+      document.xml.should == fixture(:authentication).read
+    end
+
+    it "accepts raw XML" do
+      document = Wasabi::Document.new fixture(:authentication).read
+      document.xml.should == fixture(:authentication).read
+    end
+  end
 
   describe ".validate_element_form_default!" do
     [:unqualified, :qualified].each do |value|

data/spec/wasabi/parser/multiple_namespaces_spec.rb

@@ -9,7 +9,7 @@ describe Wasabi::Parser do
       parser
     end
 
-    let(:xml) { fixture(:multiple_namespaces) }
+    let(:xml) { fixture(:multiple_namespaces).read }
 
     it "lists the types" do
       subject.types.keys.sort.should == ["Article", "Save"]

data/spec/wasabi/parser/no_namespace_spec.rb

@@ -9,7 +9,7 @@ describe Wasabi::Parser do
       parser
     end
 
-    let(:xml) { fixture(:no_namespace) }
+    let(:xml) { fixture(:no_namespace).read }
 
     it "lists the types" do
       subject.types.keys.sort.should == ["McContact", "McContactArray", "MpUser", "MpUserArray"]

data/spec/wasabi/parser/symbolic_endpoint_spec.rb

@@ -9,7 +9,7 @@ describe Wasabi::Parser do
       parser
     end
 
-    let(:xml) { fixture(:symbolic_endpoint) }
+    let(:xml) { fixture(:symbolic_endpoint).read }
 
     it "allows symbolic endpoints" do
       subject.endpoint.should be_nil

data/spec/wasabi/resolver_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Wasabi::Resolver do
+
+  describe "#xml" do
+    it "resolves remote documents" do
+      HTTPI.expects(:get).returns(HTTPI::Response.new(200, {}, "wsdl"))
+      xml = Wasabi::Resolver.new("http://example.com?wsdl").xml
+      xml.should == "wsdl"
+    end
+
+    it "resolves remote documents" do
+      xml = Wasabi::Resolver.new(fixture(:authentication).path).xml
+      xml.should == fixture(:authentication).read
+    end
+
+    it "simply returns raw XML" do
+      xml = Wasabi::Resolver.new("<xml/>").xml
+      xml.should == "<xml/>"
+    end
+  end
+
+end

data/spec/wasabi/wasabi_spec.rb

@@ -4,7 +4,7 @@ describe Wasabi do
 
   describe ".document" do
     it "should return a new Wasabi::Document" do
-      document = Wasabi.document fixture(:authentication)
+      document = Wasabi.document fixture(:authentication).read
       document.should be_a(Wasabi::Document)
     end
   end

data/wasabi.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = s.name
 
+  s.add_dependency "httpi",    "~> 1.0"
   s.add_dependency "nokogiri", ">= 1.4.0"
 
   s.add_development_dependency "rake",  "~> 0.9"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wasabi
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 31
   prerelease: 
   segments: 
   - 2
-  - 3
+  - 4
   - 0
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,10 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-07 00:00:00 Z
+date: 2012-06-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  name: httpi
+  type: :runtime
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,9 +47,9 @@ dependencies:
   name: nokogiri
   type: :runtime
   prerelease: false
-  requirement: *id001
+  requirement: *id002
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,9 +62,9 @@ dependencies:
   name: rake
   type: :development
   prerelease: false
-  requirement: *id002
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -62,9 +77,9 @@ dependencies:
   name: rspec
   type: :development
   prerelease: false
-  requirement: *id003
+  requirement: *id004
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,7 +92,7 @@ dependencies:
   name: mocha
   type: :development
   prerelease: false
-  requirement: *id004
+  requirement: *id005
 description: A simple WSDL parser
 email: 
 - me@rubiii.com
@@ -101,6 +116,7 @@ files:
 - lib/wasabi/core_ext/string.rb
 - lib/wasabi/document.rb
 - lib/wasabi/parser.rb
+- lib/wasabi/resolver.rb
 - lib/wasabi/version.rb
 - lib/wasabi/xpath_helper.rb
 - spec/fixtures/authentication.wsdl
@@ -131,6 +147,7 @@ files:
 - spec/wasabi/parser/no_namespace_spec.rb
 - spec/wasabi/parser/no_target_namespace_spec.rb
 - spec/wasabi/parser/symbolic_endpoint_spec.rb
+- spec/wasabi/resolver_spec.rb
 - spec/wasabi/wasabi_spec.rb
 - wasabi.gemspec
 homepage: https://github.com/rubiii/wasabi
@@ -195,4 +212,5 @@ test_files:
 - spec/wasabi/parser/no_namespace_spec.rb
 - spec/wasabi/parser/no_target_namespace_spec.rb
 - spec/wasabi/parser/symbolic_endpoint_spec.rb
+- spec/wasabi/resolver_spec.rb
 - spec/wasabi/wasabi_spec.rb