weasel_diesel 1.0.3 → 1.0.4

data/lib/weasel_diesel/version.rb

@@ -1,3 +1,3 @@
 class WeaselDiesel
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/weasel_diesel.rb

@@ -351,6 +351,31 @@ class WeaselDiesel
     route_loading_point <=> other.route_loading_point
   end
 
+  # Takes input param documentation and copy it over to the document object.
+  # We need to do that so the params can be both documented when a param is defined
+  # and in the documentation block.
+  # @api private
+  def sync_input_param_doc
+    defined_params.namespaced_params.each do |prms| 
+      doc.namespace(prms.space_name) do |ns|
+        prms.list_optional.each do |rule|
+          ns.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+        end
+        prms.list_required.each do |rule|
+          ns.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+        end
+      end
+    end
+
+    defined_params.list_optional.each do |rule|
+      doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+    end
+
+    defined_params.list_required.each do |rule|
+      doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
+    end
+  end
+
   SERVICE_ROOT_REGEXP = /(.*?)[\/\(\.]/
   SERVICE_ACTION_REGEXP = /[\/\(\.]([a-z0-9_]+)[\/\(\.\?]/i
   SERVICE_RESTFUL_SHOW_REGEXP = /\/:[a-z0-9_]+\.\w{3}$/
@@ -387,6 +412,8 @@ class WeaselDiesel
     end
   end
 
+
+
 end
 
 # Extending the top level module to add some helpers
@@ -409,14 +436,7 @@ module Kernel
     service = WeaselDiesel.new(url)
     yield service
 
-    service.defined_params.list_optional.each do |rule|
-      service.doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
-    end
-
-    service.defined_params.list_required.each do |rule|
-      service.doc.param(rule.name, rule.options[:doc]) if rule.options[:doc]
-    end
-
+    service.sync_input_param_doc
     WSList.add(service)
 
     service

data/lib/ws_list.rb

@@ -53,6 +53,18 @@ module WSList
     @list.find{|service| service.url == url}
   end
   
+  # Returns a service based on its verb and url
+  #
+  # @param [String] verb The request method (GET, POST, PUT, DELETE)
+  # @param [String] url The url of the service you are looking for.
+  # @return [Nil, WeaselDiesel] The found service.
+  #
+  # @api public
+  def find(verb, url)
+    verb = verb.to_s.downcase.to_sym
+    @list.find{|service| service.verb == verb && service.url == url}
+  end
+  
   
 end
 

data/spec/test_services.rb

@@ -1,4 +1,6 @@
-WeaselDieselSpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
+unless Object.const_defined?("WeaselDieselSpecOptions")
+  WeaselDieselSpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
+end
 
 describe_service "services/test.xml" do |service|
   service.formats  :xml, :json
@@ -25,7 +27,7 @@ describe_service "services/test.xml" do |service|
   service.params.namespace :user do |user|
     user.integer :id, :required => :true
     user.string :sex, :in => %Q{female, male}
-    user.boolean :mailing_list, :default => true
+    user.boolean :mailing_list, :default => true, :doc => "is the user subscribed to the ML?"
   end
 
   # the response contains a list of player creation ratings each object in the list
@@ -78,6 +80,30 @@ The most common way to use this service looks like that:
   end
 end
 
+describe_service "services/test.xml" do |service|
+  service.formats  :xml, :json
+  service.http_verb :delete
+
+  service.params do |p|
+    p.integer  :id, :doc => "id of item to be deleted"
+  end
+
+  service.response do |response|
+    response.element(:name => "player_creation_ratings") do |e|
+      e.integer  :id, :doc => "id doc"
+    end
+  end
+
+
+  service.documentation do |doc|
+    # doc.overall <markdown description text>
+    doc.overall <<-DOC
+     This deletes a test service.
+    DOC
+  end
+end
+
+
 
 describe_service "services/test_no_params.xml" do |service|
   service.formats  :xml

data/spec/wd_documentation_spec.rb

@@ -20,6 +20,16 @@ describe WeaselDiesel::Documentation do
     @doc.params_doc[:num].should == 'The number to test'
   end
 
+  it "shouldn't list the namespaced documentation at the root of the object" do
+    @doc.params_doc[:mailing_list].should be_nil
+  end
+
+  it "should have info on the documented namespaced params" do
+    @doc.namespaced_params.should_not be_empty
+    expected_documentation = @doc.namespaced_params.find{|ns| ns.name == :user}.params[:mailing_list]
+    expected_documentation.should_not be_nil
+  end
+
   it "should allow to define namespaced params doc" do
     service = WSList.all.find{|s| s.url == "services.xml"}
     service.documentation do |doc|

data/spec/ws_list_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe WSList do
+
+  it "find service by verb/route" do
+    service = WSList.find(:get, 'services/test.xml')
+    service.should_not be_nil
+    
+    service.url.should == 'services/test.xml'
+    service.verb.should == :get
+
+    service = WSList.find(:delete, 'services/test.xml')
+    service.url.should == 'services/test.xml'
+    service.verb.should == :delete
+  end
+end

metadata

@@ -1,103 +1,131 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: weasel_diesel
-version: !ruby/object:Gem::Version
-  version: 1.0.3
+version: !ruby/object:Gem::Version 
+  hash: 31
   prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 4
+  version: 1.0.4
 platform: ruby
-authors:
+authors: 
 - Matt Aimonetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-05-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack-test
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: backports
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: json
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
 description: Ruby DSL describing Web Services without implementation details.
-email:
+email: 
 - mattaimonetti@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -127,33 +155,44 @@ files:
 - spec/wd_documentation_spec.rb
 - spec/wd_params_spec.rb
 - spec/wd_spec.rb
+- spec/ws_list_spec.rb
 - spec/wsdsl_sinatra_ext_spec.rb
 - weasel_diesel.gemspec
+has_rdoc: true
 homepage: https://github.com/mattetti/Weasel-Diesel
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  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
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: wsdsl
-rubygems_version: 1.8.24
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Web Service DSL
-test_files:
+test_files: 
 - spec/hello_world_controller.rb
 - spec/hello_world_service.rb
 - spec/json_response_description_spec.rb
@@ -166,5 +205,5 @@ test_files:
 - spec/wd_documentation_spec.rb
 - spec/wd_params_spec.rb
 - spec/wd_spec.rb
+- spec/ws_list_spec.rb
 - spec/wsdsl_sinatra_ext_spec.rb
-has_rdoc: