s_savon_model 0.4.0

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.yardoc
+doc
+coverage
+tmp
+*~
+*.gem
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

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,64 @@
+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
+
+      document "http://example.com/users?wsdl"                [2.0]
+      basic_auth "login", "password"                                   [2.1]
+      endpoint "http://example.com/users"                          [2.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/lib/savon/model.rb

@@ -0,0 +1,120 @@
+require "savon"
+
+module Savon
+
+  # = Savon::Model
+  #
+  # Model for SOAP service oriented applications.
+  module Model
+
+    VERSION = "0.4.0"
+
+    def self.handle_response=(recipe)
+      @handle_response = recipe
+    end
+
+    def self.handle_response
+      @handle_response
+    end
+
+    module ClassMethods
+
+      def self.extend_object(base)
+        super
+        base.init_savon_model
+      end
+
+      def init_savon_model
+        class_action_module
+        instance_action_module
+      end
+
+      # Accepts one or more SOAP actions and generates both class and instance methods named
+      # after the given actions. Each generated method accepts an optional SOAP body Hash and
+      # a block to be passed to <tt>Savon::Client#request</tt> and executes a SOAP request.
+      def actions(*actions)
+        actions.each do |action|
+          define_class_action action
+          define_instance_action action
+        end
+      end
+
+    private
+
+      def define_class_action(action)
+        class_action_module.module_eval <<-CODE
+          def #{action.to_s.snakecase}(body = nil, &block)
+            response = client.request :wsdl, #{action.inspect}, :body => body, &block
+            Savon::Model.handle_response ? Savon::Model.handle_response.call(response) : response
+          end
+        CODE
+      end
+
+      def define_instance_action(action)
+        instance_action_module.module_eval <<-CODE
+          def #{action.to_s.snakecase}(body = nil, &block)
+            self.class.#{action.to_s.snakecase} body, &block
+          end
+        CODE
+      end
+
+      def class_action_module
+        @class_action_module ||= Module.new do
+
+          def client(&block)
+            @client ||= Savon::Client.new &block
+          end
+
+          def endpoint(uri)
+            client.wsdl.endpoint = uri
+          end
+          
+          def document(uri)
+            client.wsdl.document = uri
+          end
+          
+          def basic_auth(login, password)
+            client.http.auth.basic login, password
+          end
+
+          def namespace(uri)
+            client.wsdl.namespace = uri
+          end
+
+        end.tap { |mod| extend mod }
+      end
+
+      def instance_action_module
+        @instance_action_module ||= Module.new do
+
+          def client(&block)
+            self.class.client &block
+          end
+
+          def endpoint(uri)
+            self.class.endpoint uri
+          end
+          
+          def document(uri)
+            self.class.document uri
+          end
+          
+          def basic_auth(login, password)
+            self.class.basic_auth login, password
+          end
+
+          def namespace(uri)
+            self.class.namespace uri
+          end
+
+        end.tap { |mod| include mod }
+      end
+
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+  end
+end

data/lib/savon_model.rb

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

data/savon_model.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib/", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "savon_model"
+
+Gem::Specification.new do |s|
+  s.name = "s_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_dependency "httpi", ">= 0.7.8"
+  s.add_dependency "savon", ">= 0.8.2"
+
+  s.add_development_dependency "rspec", "~> 2.4.0"
+  s.add_development_dependency "autotest"
+  s.add_development_dependency "mocha", "~> 0.9.8"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = "lib"
+end

data/spec/savon/model_spec.rb

@@ -0,0 +1,136 @@
+require "spec_helper"
+require "savon/model"
+
+describe Savon::Model do
+  let(:model) { Class.new { include Savon::Model } }
+
+  describe ".handle_response" do
+    before(:all) { model.actions :get_user, "GetAllUsers" }
+
+    it "should be used for pre-processing SOAP responses" do
+      Savon::Model.handle_response = lambda { |response| response }
+
+      model.client.stubs(:request).returns("response")
+      model.get_user.should == "response"
+    end
+  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, "GetAllUsers" }
+
+    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
+
+      it "should accept and pass Strings for action names" do
+        model.client.expects(:request).with(:wsdl, "GetAllUsers", :body => { :id => 1 })
+        model.get_all_users :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
+
+  describe "#endpoint" do
+    it "should delegate to .endpoint" do
+      model.expects(:endpoint).with("http://example.com")
+      model.new.endpoint "http://example.com"
+    end
+  end
+
+  describe "#namespace" do
+    it "should delegate to .namespace" do
+      model.expects(:namespace).with("http://v1.example.com")
+      model.new.namespace "http://v1.example.com"
+    end
+  end
+
+  describe "overwriting action methods" do
+    context "(class-level)" do
+      let :supermodel do
+        supermodel = model.dup
+        supermodel.actions :get_user
+
+        def supermodel.get_user(body = nil, &block)
+          p "super"
+          super
+        end
+
+        supermodel
+      end
+
+      it "should be possible" do
+        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        supermodel.expects(:p).with("super")  # stupid, but works
+
+        supermodel.get_user :id => 1
+      end
+    end
+
+    context "(instance-level)" do
+      let :supermodel do
+        supermodel = model.dup
+        supermodel.actions :get_user
+        supermodel = supermodel.new
+
+        def supermodel.get_user(body = nil, &block)
+          p "super"
+          super
+        end
+
+        supermodel
+      end
+
+      it "should be possible" do
+        supermodel.client.expects(:request).with(:wsdl, :get_user, :body => { :id => 1 })
+        supermodel.expects(:p).with("super")  # stupid, but works
+
+        supermodel.get_user :id => 1
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "bundler"
+Bundler.require :default, :test
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: s_savon_model
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Daniel Harrington
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-21 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: savon
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :runtime
+  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: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !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: *id005
+description: Model for SOAP service oriented applications.
+email: me@rubiii.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/savon/model.rb
+- lib/savon_model.rb
+- savon_model.gemspec
+- spec/savon/model_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubiii/s_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: s_savon_model
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: SOAP model
+test_files: []
+