playerconnect-wsdsl 0.2.2

data/playerconnect-wsdsl.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{playerconnect-wsdsl}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Team SDOD}]
+  s.date = %q{2011-07-07}
+  s.description = %q{A Ruby DSL describing Web Services without implementation details.}
+  s.email = %q{sdod@scea.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rvmrc_example",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/documentation.rb",
+    "lib/framework_ext/sinatra.rb",
+    "lib/framework_ext/sinatra_controller.rb",
+    "lib/inflection.rb",
+    "lib/params.rb",
+    "lib/params_verification.rb",
+    "lib/response.rb",
+    "lib/ws_list.rb",
+    "lib/wsdsl.rb",
+    "playerconnect-wsdsl.gemspec",
+    "spec/hello_world_controller.rb",
+    "spec/hello_world_service.rb",
+    "spec/params_verification_spec.rb",
+    "spec/preferences_service.rb",
+    "spec/spec_helper.rb",
+    "spec/test_services.rb",
+    "spec/wsdsl_sinatra_ext_spec.rb",
+    "spec/wsdsl_spec.rb",
+    "wsdsl.gemspec"
+  ]
+  s.homepage = %q{http://github.com/playerconnect/wsdsl}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Web Service DSL}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/hello_world_controller.rb

@@ -0,0 +1,5 @@
+class HelloWorldController < SinatraServiceController
+  def list
+    "Hello #{params[:name]}"
+  end
+end

data/spec/hello_world_service.rb

@@ -0,0 +1,20 @@
+describe_service "hello_world.xml" do |service|
+  service.formats    :xml
+  service.http_verb :get
+  service.disable_auth # on by default
+
+  service.param.string  :name, :default => 'World'
+
+  service.response do |response|
+    response.element(:name => "greeting") do |e|
+	    e.attribute "message" => :string, :doc => "The greeting message sent back."
+	  end
+  end
+
+  service.documentation do |doc|
+  	doc.overall "This service provides a simple hello world implementation example."
+  	doc.params :name, "The name of the person to greet."
+  	doc.example "<code>http://ps3.yourgame.com/hello_world.xml?name=Matt</code>"
+ end
+
+end

data/spec/params_verification_spec.rb

@@ -0,0 +1,93 @@
+require_relative "spec_helper"
+
+describe ParamsVerification do
+  
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+    @valid_params = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123'}}
+  end
+  
+  it "should validate valid params" do
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should_not raise_exception
+  end
+  
+  it "should return the params" do
+    params = @valid_params.dup
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params.should be_an_instance_of(Hash)
+    returned_params.keys.size.should >= 3
+  end
+  
+  it "should set the default value for an optional param" do
+    params = @valid_params.dup
+    params['timestamp'].should be_nil
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params['timestamp'].should_not be_nil
+  end
+
+  it "should set the default value for a namespace optional param" do
+    params = {'framework' => 'RSpec', 'version' => '1.02', 'user' => {'id' => '123'}}
+    params['user']['mailing_list'].should be_nil
+    returned_params = ParamsVerification.validate!(params, @service.defined_params)
+    returned_params['user']['mailing_list'].should be_true
+  end
+  
+  it "should raise an exception when a required param is missing" do
+    params = @valid_params.dup
+    params.delete('framework')
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::MissingParam)
+  end
+
+  it "should cast a comma delimited string into an array when param marked as an array" do
+    service = WSList.all.find{|s| s.url == "services/array_param.xml"}
+    service.should_not be_nil
+    params = {'seq' => "a,b,c,d,e,g"}
+    validated = ParamsVerification.validate!(params, service.defined_params)
+    validated['seq'].should == %W{a b c d e g}
+  end
+
+  it "should not raise an exception if a req array param doesn't contain a comma" do
+    service = WSList.all.find{|s| s.url == "services/array_param.xml"}
+    params = {'seq' => "a b c d e g"}
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should_not raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param is of the wrong type" do
+    params = @valid_params.dup
+    params['user']['id'] = 'abc'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param is under the minvalue" do
+    params = @valid_params.dup
+    params['num'] = 1
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+  end
+  
+  it "should raise an exception when a param isn't in the param option list" do
+    params = @valid_params.dup
+    params['alpha'] = 'z'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+
+  it "should raise an exception when a nested optional param isn't in the param option list" do
+    params = @valid_params.dup
+    params['user']['sex'] = 'large'
+    lambda{ ParamsVerification.validate!(params, @service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamType)
+    # other service
+    params = {'preference' => {'region_code' => 'us', 'language_code' => 'de'}}
+    service = WSList.all.find{|s| s.url == 'preferences.xml'}
+    service.should_not be_nil
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception(ParamsVerification::InvalidParamValue)
+  end
+  
+  it "should validate that no params are passed when accept_no_params! is set on a service" do
+    service = WSList.all.find{|s| s.url == "services/test_no_params.xml"}
+    service.should_not be_nil
+    params = @valid_params.dup
+    lambda{ ParamsVerification.validate!(params, service.defined_params) }.should raise_exception
+  end
+  
+end

data/spec/preferences_service.rb

@@ -0,0 +1,10 @@
+describe_service "preferences.xml" do |service|
+  
+  service.params do |p|
+    p.namespace :preference do |pr|
+      pr.string :language_code, :options => ['en', 'fr']
+      pr.string :region_code, :options => ['europe']
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require 'rack/test'
+require 'sinatra'
+
+require_relative "../lib/wsdsl"
+require_relative 'test_services'
+require_relative 'preferences_service'
+require_relative "../lib/framework_ext/sinatra_controller"
+
+ENV["RACK_ENV"] = 'test'
+
+RSpec.configure do |conf|
+  conf.include Rack::Test::Methods
+end

data/spec/test_services.rb

@@ -0,0 +1,83 @@
+WSDSLSpecOptions = ['RSpec', 'Bacon'] # usually pulled from a model
+
+describe_service "services/test.xml" do |service|
+  service.formats  :xml, :json
+  service.http_verb :get
+  
+  service.params do |p|
+    p.string :framework, :in => WSDSLSpecOptions, :null => false, :required => true
+   
+    p.datetime :timestamp, :default => Time.now
+    p.string   :alpha,     :in      => ['a', 'b', 'c']
+    p.string   :version,   :null    => false
+    p.integer  :num,      :minvalue => 42
+
+  end
+  
+  # service.param :delta, :optional => true, :type => 'float'
+  # # if the optional flag isn't passed, the param is considered required. 
+  # service.param :epsilon, :type => 'string'
+  
+  service.params.namespace :user do |user|
+    user.integer :id, :required => :true
+    user.string :sex, :in => %Q{female, male}
+    user.boolean :mailing_list, :default => true
+  end
+  
+  # the response contains a list of player creation ratings each object in the list 
+  
+  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"
+      
+      e.array :name => 'player_creation_rating', :type => 'PlayerCreationRating' do |a|
+        a.attribute :comments  => :string,  :doc => "comments doc"
+        a.attribute :player_id => :integer, :doc => "player_id doc"
+        a.attribute :rating    => :integer, :doc => "rating doc"
+        a.attribute :username  => :string,  :doc => "username doc"
+      end
+    end
+  end
+  
+  service.documentation do |doc|
+    # doc.overall <markdown description text>
+    doc.overall <<-DOC
+     This is a test service used to test the framework.
+    DOC
+    
+    # doc.params <name>, <definition>
+    doc.param :framework, "The test framework used, could be one of the two following: #{WSDSLSpecOptions.join(", ")}."
+    doc.param :version, "The version of the framework to use."
+    
+    # doc.example <markdown text>
+    doc.example <<-DOC
+The most common way to use this service looks like that:
+    http://example.com/services/test.xml?framework=rspec&version=2.0.0
+    DOC
+  end
+end
+
+
+describe_service "services/test_no_params.xml" do |service|
+  service.formats  :xml
+  service.http_verb :get
+  service.accept_no_params!
+end
+
+describe_service "services.xml" do |service|
+  service.formats  :xml
+  service.http_verb :put
+  
+end
+
+describe_service "services/array_param.xml" do |s|
+  s.formats :xml
+  s.http_verb :post
+
+  s.params do |p|
+    p.array :seq, :required => true
+  end
+
+end

data/spec/wsdsl_sinatra_ext_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+require 'sinatra'
+require File.expand_path("./../lib/framework_ext/sinatra.rb", File.dirname(__FILE__))
+WSDSL.send(:include, WSDSLSinatraExtension)
+
+describe "Hello World example" do
+    require_relative "hello_world_service"
+    require_relative "hello_world_controller"
+
+    def app
+      Sinatra::Application
+    end
+
+    before(:all) do
+      service = WSList.all.find{|s| s.url == 'hello_world.xml'}
+      service.should_not be_nil
+      service.load_sinatra_route
+    end
+
+    it "should dispatch the hello world service properly" do
+      get "/hello_world.xml"
+      last_response.body.should include("Hello World")
+    end
+
+end
+

data/spec/wsdsl_spec.rb

@@ -0,0 +1,222 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe WSDSL do
+  
+  before :all do
+    @service = WSList.all.find{|s| s.url == 'services/test.xml'}
+    @service.should_not be_nil
+  end
+  
+  it "should have an url" do
+    # dummy test since that's how we found the service, but oh well
+    @service.url.should == 'services/test.xml'
+  end
+  
+  it "should have some http verbs defined" do
+    @service.verb.should == :get
+  end
+  
+  it "should have supported formats defined" do
+    @service.formats.should == [:xml, :json]
+  end
+  
+  it "should have params info" do
+    @service.params.should be_an_instance_of(WSDSL::Params)
+  end
+
+  it "should have direct access to the required params" do
+    @service.required_rules.should == @service.params.list_required
+  end
+  
+  it "should have direct access to the optional params" do
+    @service.optional_rules.should == @service.params.list_optional
+  end
+  
+  it "should have direct access to the nested params" do
+    @service.nested_params.should == @service.params.namespaced_params
+  end
+  
+  it "should set the controller accordingly" do
+    @service.controller_name.should_not be_nil
+    @service.controller_name.should == 'ServicesController'
+    service = WSDSL.new("preferences.xml")
+    service.name.should == 'preferences'
+    ExtlibCopy.classify('preferences').should == 'Preferences'
+    service.controller_name.should == 'PreferencesController'
+  end
+  
+  it "should set the action accordingly" do
+    @service.action.should_not be_nil
+    @service.action.should == 'test' 
+  end
+  
+  it "should support restful routes based on the HTTP verb" do
+    service = WSList.all.find{|s| s.url == "services.xml"}
+    service.should_not be_nil
+    service.http_verb.should == :put
+    service.action.should_not be_nil
+    service.controller_name.should == 'ServicesController'
+    service.action.should == 'update'
+  end
+
+  it "should have a default action" do
+   service = WSDSL.new('spec_test.xml')
+   service.action.should == 'list'
+  end
+
+  it "should route to show when an id is the last passed param" do
+    service = WSDSL.new("players/:id.xml")
+    service.action.should == 'show'
+  end
+
+  it "should support some extra attributes" do
+    service = WSDSL.new("players/:id.xml")
+    service.extra[:custom_name] = 'fooBar'
+    service.extra[:custom_name].should == 'fooBar'
+  end
+
+  it "should respect the global controller pluralization flag" do
+    WSDSL.use_pluralized_controllers = true
+    service = WSDSL.new("player/:id.xml")
+    service.controller_name.should == "PlayersController"
+    service = WSDSL.new("players/:id.xml")
+    service.controller_name.should == "PlayersController"
+    WSDSL.use_pluralized_controllers = false
+    service = WSDSL.new("player/:id.xml")
+    service.controller_name.should == "PlayerController"
+  end
+
+
+  it "should let overwrite the controller name and action after initialization" do
+    describe_service "players/:id.xml" do |service|
+      service.controller_name = "CustomController"
+      service.action = "foo"
+    end
+    service = WSList.all.find{|s| s.url == "players/:id.xml"}
+    service.controller_name.should == "CustomController"
+    service.action.should == "foo"
+  end
+
+  describe WSDSL::Params do
+    
+    before(:all) do
+      @sparams = @service.params
+    end
+    
+    it "should have the possibility to have a space name" do
+      @sparams.should respond_to(:space_name)
+      service_params = WSDSL::Params.new(:space_name => 'spec_test')
+      service_params.space_name.should == 'spec_test'
+    end
+    
+    it "should have a list of required param rules" do
+      @sparams.list_required.should be_an_instance_of(Array)
+      @sparams.list_required.length.should == 1
+    end
+
+    it "should have a list of optional param rules" do
+      @sparams.list_optional.should be_an_instance_of(Array)
+      @sparams.list_optional.length.should == 4
+    end
+    
+    it "should have a list of namespaced param rules" do
+      @sparams.namespaced_params.should be_an_instance_of(Array)
+      @sparams.namespaced_params.length.should == 1
+      @sparams.namespaced_params.first.space_name.should == :user
+    end
+    
+    describe WSDSL::Params::Rule do
+      before :all do
+        @rule = @sparams.list_required.first
+        @rule.should_not be_nil
+      end
+      
+      it "should have a name" do
+        @rule.name.should == :framework
+      end
+      
+      it "should have options" do
+        @rule.options[:type].should == :string
+        @rule.options[:in].should ==  WSDSLSpecOptions
+        @rule.options[:null].should be_false
+      end
+    end
+    
+  end
+  
+  it "should have some documentation" do
+    @service.doc.should be_an_instance_of(WSDSL::Documentation)
+  end
+  
+  describe WSDSL::Documentation do
+    before(:all) do
+      @doc = @service.doc
+      @doc.should_not be_nil
+    end
+    
+    it "should have an overall description" do
+      @doc.desc.strip.should == "This is a test service used to test the framework."
+    end
+    
+    it "should have a list of params doc" do
+      @doc.params_doc.should be_an_instance_of(Hash)
+      @doc.params_doc.keys.sort.should == [:framework, :version]
+      @doc.params_doc[:framework].should == "The test framework used, could be one of the two following: #{WSDSLSpecOptions.join(", ")}."
+    end
+    
+    it "should allow to define namespaced params doc" do
+      service = WSList.all.find{|s| s.url == "services.xml"}
+      service.documentation do |doc|
+        doc.namespace :preference do |ns|
+          ns.param :id, "Ze id."
+        end
+      end
+      service.doc.namespaced_params.should_not be_empty
+      ns = service.doc.namespaced_params.find{|ns| ns.name == :preference}
+      ns.should_not be_nil
+      ns.params[:id].should == "Ze id."
+    end
+    
+    it "should have an optional list of examples" do
+      @doc.examples.should be_an_instance_of(Array)
+      @doc.examples.first.should == <<-DOC
+The most common way to use this service looks like that:
+    http://example.com/services/test.xml?framework=rspec&version=2.0.0
+      DOC
+    end
+    
+    it "should have the service response documented" do
+      @doc.response.should_not be_nil
+    end
+    
+    it "should have documentation for the response elements via the response itself" do
+      @service.response.elements.first.should_not be_nil
+      @service.response.elements.first.doc.should_not be_nil
+      @service.response.elements.first.doc.name.should == "player_creation_ratings"
+    end
+
+    it "should have documentation for a response element attribute" do
+      @service.response.elements.first.doc.attributes.should_not be_empty
+      @service.response.elements.first.doc.attributes[:id].should == "id doc"
+    end
+    
+    it "should have documentation for a response element array" do
+      element = @service.response.elements.first
+      element.arrays.should_not be_empty
+      element.arrays.first.name.should == "player_creation_rating"
+      element.arrays.first.obj_type.should == "PlayerCreationRating"
+      element.arrays.first.attributes.should_not be_empty
+    end
+    
+    it "should have documentation for the attributes of an response element array" do
+      element = @service.response.elements.first
+      array = element.arrays.first
+      attribute = array.attributes.find{|att| att.name == :comments }
+      attribute.should_not be_nil
+      attribute.name.should == :comments # just in case we change the way to find the attribute
+      attribute.doc.should == "comments doc"
+    end
+
+  end
+
+end

data/wsdsl.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wsdsl}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Aimonetti"]
+  s.date = %q{2011-05-19}
+  s.description = %q{A Ruby DSL describing Web Services without implementation details.}
+  s.email = %q{mattaimonetti@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/documentation.rb",
+    "lib/framework_ext/sinatra.rb",
+    "lib/framework_ext/sinatra_controller.rb",
+    "lib/inflection.rb",
+    "lib/params.rb",
+    "lib/params_verification.rb",
+    "lib/response.rb",
+    "lib/ws_list.rb",
+    "lib/wsdsl.rb",
+    "wsdsl.gemspec"
+  ]
+  s.homepage = %q{http://github.com/mattetti/wsdsl}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Web Service DSL}
+  s.test_files = [
+    "spec/hello_world_controller.rb",
+    "spec/hello_world_service.rb",
+    "spec/params_verification_spec.rb",
+    "spec/preferences_service.rb",
+    "spec/spec_helper.rb",
+    "spec/test_services.rb",
+    "spec/wsdsl_sinatra_ext_spec.rb",
+    "spec/wsdsl_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: playerconnect-wsdsl
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+  prerelease: 
+platform: ruby
+authors:
+- Team SDOD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-07 00:00:00.000000000Z
+dependencies: []
+description: A Ruby DSL describing Web Services without implementation details.
+email: sdod@scea.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .rvmrc_example
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/documentation.rb
+- lib/framework_ext/sinatra.rb
+- lib/framework_ext/sinatra_controller.rb
+- lib/inflection.rb
+- lib/params.rb
+- lib/params_verification.rb
+- lib/response.rb
+- lib/ws_list.rb
+- lib/wsdsl.rb
+- playerconnect-wsdsl.gemspec
+- spec/hello_world_controller.rb
+- spec/hello_world_service.rb
+- spec/params_verification_spec.rb
+- spec/preferences_service.rb
+- spec/spec_helper.rb
+- spec/test_services.rb
+- spec/wsdsl_sinatra_ext_spec.rb
+- spec/wsdsl_spec.rb
+- wsdsl.gemspec
+homepage: http://github.com/playerconnect/wsdsl
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Web Service DSL
+test_files: []