savon_model 1.0.0 → 1.1.0

data/.travis.yml

@@ -0,0 +1,11 @@
+# https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
+bundler_args: --without developer_happiness
+script: "bundle exec rake"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx
+  - rbx-2.0
+  - jruby

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+== 1.1.0 (2011-09-26)
+
+* Feature: Added a .wsse_auth class method to set WSSE credentials.
+* Refactoring: Removed several client-related instance methods.
+
+== 1.0.0 (2011-06-24)
+
+* Switched to Semantic Versioning.

data/Gemfile

@@ -1,2 +1,7 @@
 source :rubygems
 gemspec
+
+# excluded from travis
+group :developer_happiness do
+  gem "autotest"
+end

data/README.md

@@ -1,71 +1,153 @@
-Savon::Model [![Build Status](http://travis-ci.org/rubiii/savon_model.png)](http://travis-ci.org/rubiii/savon_model)
+Savon::Model [![Build Status](https://secure.travis-ci.org/rubiii/savon_model.png)](http://travis-ci.org/rubiii/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:
+Savon::Model is available through [Rubygems](http://rubygems.org/gems/savon_model) and can be installed via:
 
-    $ gem install savon_model
+``` bash
+$ gem install savon_model
+```
 
 
-Getting started
----------------
+Include
+-------
 
-    class User
-      include Savon::Model
+Savon::Model comes with quite a few handy class and instance methods for using [Savon](https://github.com/rubiii/savon) inside your SOAP model classes.  
+Simply include the module in any of your classes to get started.
 
-      client do                                               [1]
-        http.headers["Pragma"] = "no-cache"
-      end
+``` ruby
+require "savon_model"
 
-      document "http://example.com/users?wsdl"                [2]
+class User
+  include Savon::Model
+end
+```
 
-      endpoint "http://example.com/users"                     [3]
-      namespace "http://v1.example.com/users"                 [4]
 
-      basic_auth "login", "password"                          [5]
+Service
+-------
 
-      actions :get_user, :get_all_users                       [6]
+You can configure Savon to work with or without a WSDL document with the `.document`, `.endpoint` and `.namespace` class methods.  
+Point Savon to the WSDL of your service:
 
-      def self.all
-        get_all_users.to_array                                [7]
-      end
+``` ruby
+class User
+  include Savon::Model
 
-      def self.find(id)
-        get_user(:id => id).to_hash                           [8]
-      end
+  document "http://service.example.com?wsdl"
+end
+```
 
-      def self.delete(id)
-        client.request(:delete_user) do                       [9]
-          soap.body = { :id => 1 }
-        end.to_hash
-      end
-    end
+or set the SOAP endpoint and target namespace to bypass the WSDL:
+
+``` ruby
+class User
+  include Savon::Model
+
+  endpoint "http://service.example.com"
+  namespace "http://v1.service.example.com"
+end
+```
+
+
+Authentication
+--------------
+
+Set your HTTP basic authentication username and password via the `.basic_auth` method:
+
+``` ruby
+class User
+  include Savon::Model
+
+  basic_auth "login", "password"
+end
+```
+
+or use the `.wsse_auth` method to set your WSSE username, password and (optional) whether or not to use digest authentication.
+
+``` ruby
+class User
+  include Savon::Model
+
+  wsse_auth "login", "password", :digest
+end
+```
+
+
+Actions
+-------
+
+Define the service methods you're working with via the `.actions` class method. Savon::Model creates both class and instance  
+methods for every action. These methods accept a SOAP body Hash and return a `Savon::SOAP::Response` for you to use.  
+You can wrap those methods in other methods:
 
-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.
+``` ruby
+class User
+  include Savon::Model
 
-2. Sets the WSDL document.
+  actions :get_user, :get_all_users
 
-3. Sets the SOAP endpoint.
-4. Sets the target namespace.
+  def self.all
+    get_all_users.to_array
+  end
 
-5. Sets basic auth credentials.
+end
+```
 
-6. 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.
+or extend them by delegating to `super`:
 
-7. `User.all` calls the `get_all_users` SOAP action and returns a `Savon::Response`.
+``` ruby
+class User
+  include Savon::Model
+
+  actions :get_user, :get_all_users
+
+  def get_user(id)
+    super(:user_id => id).to_hash[:get_user_response][:return]
+  end
+
+end
+```
+
+
+Else
+----
+
+The `Savon::Client` instance used in your model lives at `.client` inside your class. It gets initialized lazily whenever you call  
+any other class or instance method that tries to access the client. In case you need to control how the client gets initialized,  
+you can pass a block to `.client` before it's memoized:
+
+``` ruby
+class User
+  include Savon::Model
+
+  client do
+    http.headers["Pragma"] = "no-cache"
+  end
+
+end
+```
+
+You can also bypass Savon::Model and directly use the client:
+
+``` ruby
+class User
+  include Savon::Model
+
+  document "http://service.example.com?wsdl"
+
+  def find_by_id(id)
+    response = client.request(:find_user) do
+      soap.body = { :id => id }
+    end
 
-8. `User.find` calls the `get_user` SOAP action with a SOAP body Hash and returns a `Savon::Response`.
+    response.body[:find_user_response][:return]
+  end
 
-9. 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.
+end
+```

data/Rakefile

@@ -1,11 +1,7 @@
-require "bundler"
-Bundler::GemHelper.install_tasks
-
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w(-c)
-end
+RSpec::Core::RakeTask.new
 
 task :default => :spec
 task :test => :spec

data/lib/savon/model.rb

@@ -40,20 +40,20 @@ module Savon
     private
 
       def define_class_action(action)
-        class_action_module.module_eval <<-CODE
+        class_action_module.module_eval %{
           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
+        instance_action_module.module_eval %{
           def #{action.to_s.snakecase}(body = nil, &block)
             self.class.#{action.to_s.snakecase} body, &block
           end
-        CODE
+        }
       end
 
       def class_action_module
@@ -66,15 +66,19 @@ module Savon
           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 wsse_auth(*args)
+            client.wsse.credentials(*args)
+          end
+
           def namespace(uri)
             client.wsdl.namespace = uri
           end
@@ -89,22 +93,6 @@ module Savon
             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
 

data/lib/savon/model_version.rb

@@ -1,7 +1,7 @@
 module Savon
   module Model
 
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
 
   end
 end

data/savon_model.gemspec

@@ -1,6 +1,5 @@
-lib = File.expand_path("../lib/", __FILE__)
-$:.unshift lib unless $:.include?(lib)
-
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 require "savon/model_version"
 
 Gem::Specification.new do |s|
@@ -9,18 +8,20 @@ Gem::Specification.new do |s|
   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.summary     = "Model for SOAP service oriented applications"
+  s.description = s.summary
 
   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 "mocha", "~> 0.9.8"
-  s.add_development_dependency "autotest"
+  s.add_development_dependency "rake",  "~> 0.8.7"
+  s.add_development_dependency "rspec", "~> 2.6.0"
+  s.add_development_dependency "mocha", "~> 0.10.0"
 
-  s.files = `git ls-files`.split("\n")
-  s.require_path = "lib"
+  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"]
 end

data/spec/savon/model_spec.rb

@@ -2,109 +2,135 @@ require "spec_helper"
 require "savon/model"
 
 describe Savon::Model do
-  let(:model) { Class.new { include Savon::Model } }
+
+  let(:model) do
+    Class.new { include Savon::Model }
+  end
 
   describe ".handle_response" do
-    before(:all) { model.actions :get_user, "GetAllUsers" }
 
-    it "should be used for pre-processing SOAP responses" do
+    before(:all) do
+      model.actions :get_user, "GetAllUsers"
+    end
+
+    it "can 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
+    it "passes a given block to a new Savon::Client"
+
+    it "memoizes the Savon::Client" do
       model.client.should equal(model.client)
     end
+
   end
 
   describe ".endpoint" do
-    it "should set the SOAP endpoint" do
+
+    it "sets the SOAP endpoint" do
       model.endpoint "http://example.com"
       model.client.wsdl.endpoint.should == "http://example.com"
     end
+
   end
 
   describe ".document" do
-    it "should set WSDL document" do
+
+    it "sets WSDL document" do
       model.document "http://example.com/?wsdl"
       model.client.wsdl.document.should == "http://example.com/?wsdl"
     end
+
   end
 
   describe ".basic_auth" do
-    it "should set HTTP Basic auth credentials" do
+
+    it "sets HTTP Basic auth credentials" do
       model.basic_auth "login", "password"
-      puts model.client.http.auth.basic.should == ["login", "password"]
+      model.client.http.auth.basic.should == ["login", "password"]
+    end
+
+  end
+
+  describe ".wsse_auth" do
+
+    it "sets WSSE auth credentials" do
+      model.wsse_auth "login", "password", :digest
+
+      model.client.wsse.username.should == "login"
+      model.client.wsse.password.should == "password"
+      model.client.wsse.should be_digest
     end
+
   end
 
   describe ".namespace" do
-    it "should set the target namespace" do
+
+    it "sets 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
+    before(:all) do
+      model.actions :get_user, "GetAllUsers"
+    end
+
+    it "defines class methods each action" do
       model.should respond_to(:get_user, :get_all_users)
     end
 
-    it "should define instance methods each action" do
+    it "defines 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
+
+      it "executes 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
+      it "accepts and passes 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
+
+      it "delegates 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"
+    it "returns the class-level Savon::Client" do
+      model.new.client.should == model.client
     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
+
+      let(:supermodel) do
         supermodel = model.dup
         supermodel.actions :get_user
 
@@ -116,16 +142,18 @@ describe Savon::Model do
         supermodel
       end
 
-      it "should be possible" do
+      it "works" 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
+
+      let(:supermodel) do
         supermodel = model.dup
         supermodel.actions :get_user
         supermodel = supermodel.new
@@ -138,13 +166,15 @@ describe Savon::Model do
         supermodel
       end
 
-      it "should be possible" do
+      it "works" 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: savon_model
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,12 +15,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-24 00:00:00 Z
+date: 2011-09-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: httpi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,12 +29,12 @@ dependencies:
         - 7
         - 8
         version: 0.7.8
+  name: httpi
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: savon
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,55 +45,59 @@ dependencies:
         - 8
         - 2
         version: 0.8.2
+  name: savon
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 49
         segments: 
-        - 2
-        - 4
         - 0
-        version: 2.4.0
+        - 8
+        - 7
+        version: 0.8.7
+  name: rake
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: mocha
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 43
+        hash: 23
         segments: 
+        - 2
+        - 6
         - 0
-        - 9
-        - 8
-        version: 0.9.8
+        version: 2.6.0
+  name: rspec
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: autotest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 55
         segments: 
         - 0
-        version: "0"
+        - 10
+        - 0
+        version: 0.10.0
+  name: mocha
   type: :development
-  version_requirements: *id005
-description: Model for SOAP service oriented applications.
+  prerelease: false
+  requirement: *id005
+description: Model for SOAP service oriented applications
 email: me@rubiii.com
 executables: []
 
@@ -106,6 +108,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -145,9 +149,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: savon_model
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: SOAP model
-test_files: []
-
+summary: Model for SOAP service oriented applications
+test_files: 
+- spec/savon/model_spec.rb
+- spec/spec_helper.rb