savon_model 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://gems.blau.de"
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    savon_model (0.1.0)
+
+GEM
+  remote: http://gems.blau.de/
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    httpi (0.6.0)
+    mocha (0.9.8)
+      rake
+    rake (0.8.7)
+    rspec (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+      rspec-mocks (= 2.0.0)
+    rspec-core (2.0.0)
+    rspec-expectations (2.0.0)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0)
+      rspec-core (= 2.0.0)
+      rspec-expectations (= 2.0.0)
+    savon (0.8.0.alpha.1)
+      builder (~> 2.1.2)
+      crack (~> 0.1.8)
+      httpi (>= 0.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.9.8)
+  rspec (~> 2.0.0)
+  savon (~> 0.8.0.alpha.1)
+  savon_model!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Harrington
+
+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.md

@@ -0,0 +1,62 @@
+Savon::Model
+============
+
+Model for SOAP service oriented applications.
+
+[Bugs](http://github.com/rubiii/savon_model/issues) | [Docs](http://rubydoc.info/gems/savon_model/frames)
+
+Installation
+------------
+
+The gem is available through [Rubygems](http://rubygems.org/gems/savon_model) and can be installed via:
+
+    $ gem install savon_model
+
+Getting started
+---------------
+
+    class User
+      include Savon::Model
+
+      client do                                               [1]
+        http.headers["Pragma"] = "no-cache"
+      end
+
+      endpoint "http://example.com/users"                     [2]
+      namespace "http://v1.example.com/users"                 [3]
+
+      actions :get_user, :get_all_users                       [4]
+
+      def self.all
+        get_all_users.to_array                                [5]
+      end
+
+      def self.find(id)
+        get_user(:id => id).to_hash                           [6]
+      end
+
+      def self.delete(id)
+        client.request(:delete_user) do                       [7]
+          soap.body = { :id => 1 }
+        end.to_hash
+      end
+    end
+
+1. You can call the `client` method with a block of settings to be passed to `Savon::Client.new`.
+   The `client` method memoizes a `Savon::Client` instance, so you need to call this method before
+   it gets called by any other method.
+
+2. Sets the SOAP endpoint.
+
+3. Sets the SOAP namespace.
+
+4. Specifies the SOAP actions provided by the service. This method dynamically creates both class
+   and instance methods named after the arguments. These methods accept an optional SOAP body Hash
+   or XML String to be passed to the `Savon::Client` instance.
+
+5. `User.all` calls the `get_all_users` SOAP action and returns a `Savon::Response`.
+
+6. `User.find` calls the `get_user` SOAP action with a SOAP body Hash and returns a `Savon::Response`.
+
+7. This is an example of what happens "behind the scenes" on [6]. You can always use the `client`
+   method to directly access and use the `Savon::Client` instance.

data/Rakefile

@@ -0,0 +1,40 @@
+require "rake"
+
+begin
+  require "yard"
+  
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ["README.md", "lib/**/*.rb"]
+  end
+rescue LoadError
+  desc message = %{"gem install yard" to generate documentation}
+  task("yard") { abort message }
+end
+
+begin
+  require "metric_fu"
+  
+  MetricFu::Configuration.run do |c|
+    c.metrics = [:churn, :flog, :flay, :reek, :roodi, :saikuro] # :rcov seems to be broken
+    c.graphs = [:flog, :flay, :reek, :roodi]
+    c.flay = { :dirs_to_flay => ["lib"], :minimum_score => 20 }
+    c.rcov[:rcov_opts] << "-Ilib -Ispec"
+  end
+rescue LoadError
+  desc message = %{"gem install metric_fu" to generate metrics}
+  task("metrics:all") { abort message }
+end
+
+begin
+  require "rspec/core/rake_task"
+  
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-fd -c)
+  end
+rescue LoadError
+  task :spec do
+    abort "Run 'gem install rspec' to be able to run specs"
+  end
+end
+
+task :default => :spec

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/savon/ext/response.rb

@@ -0,0 +1,41 @@
+require "savon"
+require "savon/model"
+
+module Savon
+  module SOAP
+    class Response
+
+      # Returns the +original_hash+ 
+      def new_hash
+        @new_hash ||= response_pattern original_hash
+      end
+
+      alias_method :original_hash, :to_hash
+      alias_method :to_hash, :new_hash
+
+      def to_array
+        @array ||= begin
+          array = to_hash.kind_of?(Array) ? to_hash : [to_hash]
+          array.compact
+        end
+      end
+
+    private
+
+      def response_pattern(hash)
+        return hash if Model.response_pattern.blank?
+        
+        Model.response_pattern.inject(hash) do |memo, pattern|
+          key = case pattern
+            when Regexp then memo.keys.find { |key| key.to_s =~ pattern }
+            else             memo.keys.find { |key| key.to_s == pattern.to_s }
+          end
+          
+          return unless key
+          memo[key]
+        end
+      end
+
+    end
+  end
+end

data/lib/savon/model.rb

@@ -0,0 +1,65 @@
+require "savon"
+require "savon/ext/response"
+
+module Savon
+  module Model
+
+    VERSION = "0.1.0"
+
+    class << self
+
+      def response_pattern
+        @response_pattern ||= []
+      end
+
+      attr_writer :response_pattern
+
+    end
+
+    module ClassMethods
+
+      def client(&block)
+        @client ||= Savon::Client.new &block
+      end
+
+      def endpoint(uri)
+        client.wsdl.endpoint = uri
+      end
+
+      def namespace(uri)
+        client.wsdl.namespace = uri
+      end
+
+      def actions(*args)
+        args.each do |arg|
+          define_class_action arg
+          define_instance_action arg
+        end
+      end
+
+    private
+
+      def define_class_action(action)
+        self.class.send :define_method, action do |body|
+          client.request :wsdl, action, :body => body
+        end
+      end
+
+      def define_instance_action(action)
+        define_method action do |body|
+          self.class.send action, body
+        end
+      end
+
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def client
+      self.class.client
+    end
+
+  end
+end

data/lib/savon_model.rb

@@ -0,0 +1 @@
+require "savon/model"

data/savon_model.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib/", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "savon_model"
+
+Gem::Specification.new do |s|
+  s.name = "savon_model"
+  s.version = Savon::Model::VERSION
+  s.authors = "Daniel Harrington"
+  s.email = "me@rubiii.com"
+  s.homepage = "http://github.com/rubiii/#{s.name}"
+  s.summary = "SOAP model"
+  s.description = "Model for SOAP service oriented applications."
+
+  s.rubyforge_project = s.name
+
+  s.add_development_dependency "savon", "~> 0.8.0.alpha.1"
+
+  s.add_development_dependency "rspec", "~> 2.0.0"
+  s.add_development_dependency "mocha", "~> 0.9.8"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = "lib"
+end

data/spec/fixtures/authentication.xml

@@ -0,0 +1,14 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <ns2:authenticateResponse xmlns:ns2="http://v1_0.ws.user.example.com">
+      <return>
+        <authenticationValue>
+          <token>a68d1d6379b62ff339a0e0c69ed4d9cf</token>
+          <tokenHash>AAAJxA;cIedoT;mY10ExZwG6JuKgp2OYKxow==</tokenHash>
+          <client>radclient</client>
+        </authenticationValue>
+        <success>true</success>
+      </return>
+    </ns2:authenticateResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/fixtures/users.xml

@@ -0,0 +1,18 @@
+<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+  <soap:Body>
+    <ns2:getAllUsersResponse xmlns:ns2="http://v1_0.ws.user.example.com">
+      <return>
+        <id>1</id>
+        <name>Thilko</name>
+      </return>
+      <return>
+        <id>2</id>
+        <name>Peter</name>
+      </return>
+      <return>
+        <id>3</id>
+        <name>Alex</name>
+      </return>
+    </ns2:getAllUsersResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/savon/ext/response_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+require "savon/ext/response"
+
+describe Savon::SOAP::Response do
+  let(:response) { Savon::SOAP::Response.new http_response(:authentication) }
+  let(:users_response) { Savon::SOAP::Response.new http_response(:users) }
+
+  describe "#original_hash" do
+    it "should return the original Hash" do
+      response.original_hash[:authenticate_response].should be_a(Hash)
+    end
+  end
+
+  describe "#to_hash" do
+    it "should memoize the result" do
+      response.to_hash.should equal(response.to_hash)
+    end
+
+    context "without response pattern" do
+      it "should return the original Hash" do
+        response.to_hash[:authenticate_response].should be_a(Hash)
+      end
+    end
+
+    context "with response pattern" do
+      around do |example|
+        Savon::Model.response_pattern = [/.+_response/, :return]
+        example.run
+        Savon::Model.response_pattern = nil
+      end
+
+      it "should apply the response pattern" do
+        response.to_hash[:success].should be_true
+      end
+    end
+
+    context "with unmatched response pattern" do
+      around do |example|
+        Savon::Model.response_pattern = [:unmatched, :pattern]
+        example.run
+        Savon::Model.response_pattern = nil
+      end
+
+      it "should apply the response pattern" do
+        response.to_hash.should be_nil
+      end
+    end
+  end
+
+  describe "#to_array" do
+    around do |example|
+      Savon::Model.response_pattern = [/.+_response/, :return]
+      example.run
+      Savon::Model.response_pattern = nil
+    end
+
+    it "should return an Array for a single response element" do
+      response.to_array.should be_an(Array)
+      response.to_array.first[:success].should be_true
+    end
+
+    it "should memoize the result" do
+      response.to_array.should equal(response.to_array)
+    end
+
+    it "should return an Array for multiple response element" do
+      users_response.to_array.should be_an(Array)
+      users_response.to_array.should have(3).items
+    end
+  end
+
+  def http_response(fixture)
+    HTTPI::Response.new 200, {}, File.read("spec/fixtures/#{fixture}.xml")
+  end
+
+end

data/spec/savon/model_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "savon/model"
+
+describe Savon::Model do
+  let :model do
+    Class.new { include Savon::Model }
+  end
+
+  describe ".client" do
+    it "should should pass a given block to a new Savon::Client"
+
+    it "should memoize the Savon::Client" do
+      model.client.should equal(model.client)
+    end
+  end
+
+  describe ".endpoint" do
+    it "should set the SOAP endpoint" do
+      model.endpoint "http://example.com"
+      model.client.wsdl.endpoint.should == "http://example.com"
+    end
+  end
+
+  describe ".namespace" do
+    it "should set the target namespace" do
+      model.namespace "http://v1.example.com"
+      model.client.wsdl.namespace.should == "http://v1.example.com"
+    end
+  end
+
+  describe ".actions" do
+    before(:all) { model.actions :get_user, :get_all_users }
+
+    it "should define class methods each action" do
+      model.should respond_to(:get_user, :get_all_users)
+    end
+
+    it "should define instance methods each action" do
+      model.new.should respond_to(:get_user, :get_all_users)
+    end
+
+    context "(class-level)" do
+      it "should execute SOAP requests with a given body" do
+        model.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        model.get_user :id => 1
+      end
+    end
+
+    context "(instance-level)" do
+      it "should delegate to the corresponding class method" do
+        model.expects(:get_all_users).with(:active => true)
+        model.new.get_all_users :active => true
+      end
+    end
+  end
+
+  describe "#client" do
+    it "should return the class-level Savon::Client" do
+      model.new.client.should == model.client
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "rspec"
+require "mocha"
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: savon_model
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -3702664226
+        segments: 
+        - 0
+        - 8
+        - 0
+        - alpha
+        - 1
+        version: 0.8.0.alpha.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id003
+description: Model for SOAP service oriented applications.
+email: me@rubiii.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/savon/ext/response.rb
+- lib/savon/model.rb
+- lib/savon_model.rb
+- savon_model.gemspec
+- spec/fixtures/authentication.xml
+- spec/fixtures/users.xml
+- spec/savon/ext/response_spec.rb
+- spec/savon/model_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubiii/savon_model
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: savon_model
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: SOAP model
+test_files: []
+