wsdsl 0.5.0 → 0.5.1

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'jeweler'
+gem 'rspec'
+gem 'rack-test'
+gem 'sinatra'
+if RUBY_VERSION =~ /1.8/
+  gem 'backports'
+  gem 'json'
+end

data/README.md

@@ -149,6 +149,35 @@ This library comes with a test suite requiring Ruby 1.9.2
 The following gems need to be available:
 Rspec, Rack, Sinatra
 
+## RUBY 1.8 warning
+
+This library was written for Ruby 1.9 and 1.8 support was added later on
+via the backports libary and some tweaks. However, because unlike in
+ruby 1.9, the hash insert order isn't kept in 1.8 the following syntax
+isn't supported and the alternative version needs to be used:
+
+    service.response do |response|
+      response.element(:name => "player_creation_ratings") do |e|
+        e.attribute  :id          => :integer, :doc => "id doc"
+        e.attribute  :is_accepted => :boolean, :doc => "is accepted doc"
+        e.attribute  :name        => :string,  :doc => "name doc"
+      end
+    end
+
+Instead the following version should be used:
+
+    service.response do |response|
+      response.element(:name => "player_creation_ratings") do |e|
+        e.integer  :id, :doc => "id doc"
+        e.boolean  :is_accepted, :doc => "is accepted doc"
+        e.string   :name, :doc => "name doc"
+      end
+    end
+
+Both code snippets do the exact same thing but the first version is 1.9
+only.
+
+
 
 ## Copyright
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/response.rb

@@ -173,14 +173,13 @@ class WSDSL
       #
       # @return [Array<WSDSL::Response::Attribute>]
       # @api public
-      def attribute(opts)
-        raise ArgumentError unless opts.is_a?(Hash)
-        # extract the documentation part and add it where it belongs
-        new_attribute = Attribute.new(opts)
+      def attribute(opts, extra_opts={})
+        raise ArgumentError unless opts.is_a?(Hash) && extra_opts.is_a?(Hash)
+        new_attribute = Attribute.new(opts, extra_opts)
         @attributes << new_attribute
         # document the attribute if description available
         # we might want to have a placeholder message when a response attribute isn't defined
-        if opts.has_key?(:doc)
+        if opts.merge!(extra_opts).has_key?(:doc)
           @doc.attribute(new_attribute.name, opts[:doc])
         end
         @attributes
@@ -299,7 +298,7 @@ class WSDSL
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def string(name=nil, opts={})
-        attribute({name => :string}.merge(opts))
+        attribute({name => :string}, opts)
       end
 
       # Shortcut to create a string attribute
@@ -307,7 +306,7 @@ class WSDSL
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def integer(name=nil, opts={})
-        attribute({name => :integer}.merge(opts))
+        attribute({name => :integer}, opts)
       end
 
       # Shortcut to create a string attribute
@@ -315,7 +314,7 @@ class WSDSL
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def float(name=nil, opts={})
-        attribute({name => :float}.merge(opts))
+        attribute({name => :float}, opts)
       end
 
       # Shortcut to create a string attribute
@@ -323,7 +322,7 @@ class WSDSL
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def boolean(name=nil, opts={})
-        attribute({name => :boolean}.merge(opts))
+        attribute({name => :boolean}, opts)
       end
 
       # Shortcut to create a string attribute
@@ -331,7 +330,7 @@ class WSDSL
       # @param [Symbol, String] name the name of the attribute.
       # @param [Hash] opts the attribute options.
       def datetime(name=nil, opts={})
-        attribute({name => :datetime}.merge(opts))
+        attribute({name => :datetime}, opts)
       end
 
       # Converts an element into a hash representation
@@ -422,14 +421,17 @@ class WSDSL
         # name, type, doc, type
         #
         # @param [Hash, Array] o_params
+        # @param [Hash] o_extra_params A hash with extra params passed, needed to support Ruby 1.8 :(
         #
         # @api public
-        def initialize(o_params)
+        def initialize(o_params, o_extra_params={})
           params = o_params.dup
+          extra_params = o_extra_params.dup
           if params.is_a?(Hash)
             @name, @type = params.shift
             @doc  = params.delete(:doc) if params.has_key?(:doc)
-            @opts = params
+            @doc  ||= extra_params.delete(:doc) if extra_params.has_key?(:doc)
+            @opts = params.merge!(extra_params)
           elsif params.is_a?(Array)
             @name = params.shift
             @type = params.shift

data/spec/spec_helper.rb

@@ -1,3 +1,9 @@
+if RUBY_VERSION =~ /1.8/
+  require 'rubygems'
+  require 'backports'
+  require 'json'
+end
+
 require 'rspec'
 require 'rack/test'
 require 'sinatra'

data/spec/test_services.rb

@@ -26,6 +26,8 @@ describe_service "services/test.xml" do |service|
 
   # the response contains a list of player creation ratings each object in the list
 
+=begin
+  #Format not supported by Ruby 1.8 due to hash insertion order not being maintained.
   service.response do |response|
     response.element(:name => "player_creation_ratings") do |e|
       e.attribute  :id          => :integer, :doc => "id doc"
@@ -40,6 +42,23 @@ describe_service "services/test.xml" do |service|
       end
     end
   end
+=end
+
+  service.response do |response|
+    response.element(:name => "player_creation_ratings") do |e|
+      e.integer  :id, :doc => "id doc"
+      e.boolean  :is_accepted, :doc => "is accepted doc"
+      e.string   :name, :doc => "name doc"
+
+      e.array :player_creation_rating, 'PlayerCreationRating' do |a|
+        a.string :comments,  :doc => "comments doc"
+        a.integer :player_id, :doc => "player_id doc"
+        a.integer :rating, :doc => "rating doc"
+        a.string :username,  :doc => "username doc"
+      end
+    end
+  end
+
 
   service.documentation do |doc|
     # doc.overall <markdown description text>

data/spec/wsdsl_spec.rb

@@ -287,6 +287,7 @@ The most common way to use this service looks like that:
     end
 
     it "should have documentation for a response element attribute" do
+      p @service.response.elements.first.doc.inspect
       @service.response.elements.first.doc.attributes.should_not be_empty
       @service.response.elements.first.doc.attributes[:id].should == "id doc"
     end

data/wsdsl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "wsdsl"
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Aimonetti"]
-  s.date = "2012-01-10"
+  s.date = "2012-01-12"
   s.description = "A Ruby DSL describing Web Services without implementation details."
   s.email = "mattaimonetti@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    "Gemfile",
     "LICENSE",
     "README.md",
     "Rakefile",
@@ -53,9 +54,21 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-test>, [">= 0"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
     else
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
     end
   else
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wsdsl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,52 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-10 00:00:00.000000000 Z
-dependencies: []
+date: 2012-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70320885201320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70320885201320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70320885200840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70320885200840
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70320885200360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70320885200360
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70320885199880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70320885199880
 description: A Ruby DSL describing Web Services without implementation details.
 email: mattaimonetti@gmail.com
 executables: []
@@ -19,6 +63,7 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile