malcolm 0.0.1

data/README.markdown

@@ -0,0 +1,22 @@
+# Malcolm [![Malcolm Build Status][Build Icon]][Build Status]
+
+Malcolm is a collection of middleware for [Faraday](https://github.com/technoweenie/faraday),
+the excellent HTTP client interface based on [Rack](http://rack.github.com/).
+
+[Build Icon]: https://secure.travis-ci.org/site5/malcolm.png?branch=master
+[Build Status]: https://travis-ci.org/site5/malcolm
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Site5.com. See LICENSE for details.

data/README.md

@@ -0,0 +1,22 @@
+# Malcolm [![Malcolm Build Status][Build Icon]][Build Status]
+
+Malcolm is a collection of middleware for [Faraday](https://github.com/technoweenie/faraday),
+the excellent HTTP client interface based on [Rack](http://rack.github.com/).
+
+[Build Icon]: https://secure.travis-ci.org/site5/malcolm.png?branch=master
+[Build Status]: https://travis-ci.org/site5/malcolm
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 Site5.com. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+begin
+  require 'rspec/core/rake_task'
+rescue LoadError
+  puts "Please install rspec (bundle install)"
+  exit
+end
+
+RSpec::Core::RakeTask.new :spec
+Bundler::GemHelper.install_tasks
+
+desc  "Run all specs with rcov"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/,features\/}
+end
+
+task :default => [:spec]

data/lib/malcolm/request/soap_builder.rb

@@ -0,0 +1,24 @@
+module Malcolm
+  # Request middleware that converts params to XML and wraps them in a SOAP envelope.
+  #See http://www.w3.org/TR/2007/REC-soap12-part0-20070427/
+  class SOAPBuilder < Faraday::Middleware
+    dependency 'xmlsimple'
+    
+    # Assumes request body is a hash of key-value pairs    
+    def call(env)
+      env[:body] = wrap(env[:body])
+      @app.call env
+    end
+    
+  private
+    
+    # Builds an XML document around request data
+    def wrap(data)
+      raise "Request body already serialized.  Please make sure it is a hash before applying SOAP Builder." unless data.is_a?(Hash)
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?><env:Envelope xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\"><env:Body>".tap do |soap_envelope|
+        soap_envelope << XmlSimple.xml_out(data, :keep_root => true) if data
+        soap_envelope << "</env:Body></env:Envelope>"
+      end
+    end
+  end
+end

data/lib/malcolm/response/soap_parser.rb

@@ -0,0 +1,47 @@
+module Malcolm
+  # Response middleware that unwraps a SOAP envelope for you
+  class SOAPParser < Faraday::Middleware
+    dependency 'nori'
+    
+    Nori.configure do |config|
+      config.strip_namespaces = true
+      config.convert_tags_to { |tag| tag.snakecase.to_sym }
+    end
+    
+    def initialize(env, *args)
+      key = args[0]
+      super(env)
+    end
+  
+    # Expects response XML to already be parsed
+    def on_complete(env)
+      env[:body] = Nori.parse(env[:body])
+      env[:body] = env[:body][:envelope][:body]
+      env[:body] = find_key_in_hash(env[:body], @key)
+    end
+    
+  private
+
+    # Finds +index+ in +hash+ by searching recursively
+    #
+    # @param [Hash] hash
+    #   The hash to search
+    #
+    # @param index
+    #   The hash key to look for
+    def find_key_in_hash(hash, index)
+      hash.each do |key, val|
+        if val.respond_to? :has_key?
+          if val.has_key? index
+            return val[index]
+          else
+            return find_key_in_hash val, index
+          end
+        else
+          val
+        end
+      end
+    end
+    
+  end
+end

data/lib/malcolm.rb

@@ -0,0 +1,13 @@
+require 'faraday'
+
+module Malcolm
+  autoload :SOAPBuilder, 'malcolm/request/soap_builder'
+  autoload :SOAPParser,  'malcolm/response/soap_parser'
+
+  Faraday.register_middleware :request,
+    :soap => SOAPBuilder
+    
+  Faraday.register_middleware :response,
+    :soap => SOAPParser
+
+end

data/spec/fixtures/soap.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:xmethods-delayed-quotes" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ns2="http://xml.apache.org/xml-soap" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
+<SOAP-ENV:Body><ns1:addIpResponse>
+<Result xsi:type="ns2:Map">
+  <item><key xsi:type="xsd:string">ip</key><value xsi:type="xsd:string">127.0.0.1</value></item>
+  <item><key xsi:type="xsd:string">id</key><value xsi:type="xsd:string">123456</value></item>
+</Result>
+</ns1:addIpResponse>
+</SOAP-ENV:Body>
+</SOAP-ENV:Envelope>

data/spec/malcolm/request/soap_builder_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Malcolm::SOAPBuilder do
+  
+  it "builds a soap envelope for request" do
+    middleware = described_class.new(lambda{|env| env})
+    env = {:body => {"test" => "data"}, :request_headers => Faraday::Utils::Headers.new}
+    result = middleware.call(env)
+    xml = result[:body]
+    xml.should include %{<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body>}
+  end
+  
+  it "converts body to xml" do
+    middleware = described_class.new(lambda{|env| env})
+    env = {:body => {"test" => "data"}, :request_headers => Faraday::Utils::Headers.new}
+    result = middleware.call(env)
+    xml = result[:body]
+    xml.should include %{<test>data}
+  end
+  
+  it "raises if body isn't a hash" do
+    middleware = described_class.new(lambda{|env| env})
+    env = {:body => "test=data", :request_headers => Faraday::Utils::Headers.new}
+    expect { middleware.call(env) }.to raise_error
+  end
+  
+
+end

data/spec/malcolm/response/soap_parser_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Malcolm::SOAPParser do
+
+  it "parses xml" do
+    env = { :body => load_fixture("soap.xml") }
+    middleware = described_class.new(lambda{|env| env})
+    res = middleware.on_complete(env)
+    res.should be_a Hash
+  end
+  
+  it "drills down to body" do
+    env = { :body => load_fixture("soap.xml") }
+    middleware = described_class.new(lambda{|env| env})
+    res = middleware.on_complete(env)
+    res.keys.should_not include(:envelope)
+  end
+  
+  it "fetches given key" do
+    env = { :body => load_fixture("soap.xml") }
+    middleware = described_class.new(lambda{|env| env}, :item)
+    res = middleware.on_complete(env)
+    res.keys.should_not include(:envelope)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'malcolm'
+
+def load_fixture(name)
+  File.read("spec/fixtures/#{name}")
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: malcolm
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Floyd Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -245658415
+        segments: 
+        - 0
+        - 8
+        - 0rc2
+        version: 0.8.0rc2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+description: "    A collection of Faraday middleware\n"
+email: fwright@site5.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- Rakefile
+- README.md
+- lib/malcolm/request/soap_builder.rb
+- lib/malcolm/response/soap_parser.rb
+- lib/malcolm.rb
+- spec/fixtures/soap.xml
+- spec/malcolm/request/soap_builder_spec.rb
+- spec/malcolm/response/soap_parser_spec.rb
+- spec/spec_helper.rb
+- README.markdown
+has_rdoc: true
+homepage: https://github.com/site5/malcolm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A collection of Faraday middleware
+test_files: []
+