RubyGems - zinfinit-actionwebservice - Versions diffs - 2.3.4.2 - Mend

zinfinit-actionwebservice 2.3.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (80) hide show

data/CHANGELOG +323 -0
data/MIT-LICENSE +21 -0
data/README +381 -0
data/Rakefile +173 -0
data/examples/googlesearch/README +143 -0
data/examples/googlesearch/autoloading/google_search_api.rb +50 -0
data/examples/googlesearch/autoloading/google_search_controller.rb +57 -0
data/examples/googlesearch/delegated/google_search_service.rb +108 -0
data/examples/googlesearch/delegated/search_controller.rb +7 -0
data/examples/googlesearch/direct/google_search_api.rb +50 -0
data/examples/googlesearch/direct/search_controller.rb +58 -0
data/examples/metaWeblog/README +17 -0
data/examples/metaWeblog/apis/blogger_api.rb +60 -0
data/examples/metaWeblog/apis/blogger_service.rb +34 -0
data/examples/metaWeblog/apis/meta_weblog_api.rb +67 -0
data/examples/metaWeblog/apis/meta_weblog_service.rb +48 -0
data/examples/metaWeblog/controllers/xmlrpc_controller.rb +16 -0
data/generators/web_service/USAGE +28 -0
data/generators/web_service/templates/api_definition.rb +5 -0
data/generators/web_service/templates/controller.rb +8 -0
data/generators/web_service/templates/functional_test.rb +19 -0
data/generators/web_service/web_service_generator.rb +29 -0
data/lib/action_web_service.rb +68 -0
data/lib/action_web_service/api.rb +297 -0
data/lib/action_web_service/base.rb +38 -0
data/lib/action_web_service/casting.rb +149 -0
data/lib/action_web_service/client.rb +3 -0
data/lib/action_web_service/client/base.rb +28 -0
data/lib/action_web_service/client/soap_client.rb +113 -0
data/lib/action_web_service/client/xmlrpc_client.rb +58 -0
data/lib/action_web_service/container.rb +3 -0
data/lib/action_web_service/container/action_controller_container.rb +93 -0
data/lib/action_web_service/container/delegated_container.rb +86 -0
data/lib/action_web_service/container/direct_container.rb +69 -0
data/lib/action_web_service/dispatcher.rb +2 -0
data/lib/action_web_service/dispatcher/abstract.rb +207 -0
data/lib/action_web_service/dispatcher/action_controller_dispatcher.rb +397 -0
data/lib/action_web_service/invocation.rb +202 -0
data/lib/action_web_service/protocol.rb +4 -0
data/lib/action_web_service/protocol/abstract.rb +112 -0
data/lib/action_web_service/protocol/discovery.rb +37 -0
data/lib/action_web_service/protocol/soap_protocol.rb +176 -0
data/lib/action_web_service/protocol/soap_protocol/marshaler.rb +242 -0
data/lib/action_web_service/protocol/xmlrpc_protocol.rb +122 -0
data/lib/action_web_service/scaffolding.rb +281 -0
data/lib/action_web_service/simple.rb +53 -0
data/lib/action_web_service/string_to_datetime_for_soap.rb +10 -0
data/lib/action_web_service/struct.rb +68 -0
data/lib/action_web_service/support/class_inheritable_options.rb +26 -0
data/lib/action_web_service/support/signature_types.rb +256 -0
data/lib/action_web_service/templates/scaffolds/layout.html.erb +65 -0
data/lib/action_web_service/templates/scaffolds/methods.html.erb +6 -0
data/lib/action_web_service/templates/scaffolds/parameters.html.erb +29 -0
data/lib/action_web_service/templates/scaffolds/result.html.erb +30 -0
data/lib/action_web_service/test_invoke.rb +110 -0
data/lib/action_web_service/version.rb +9 -0
data/lib/actionwebservice.rb +1 -0
data/setup.rb +1379 -0
data/test/abstract_client.rb +183 -0
data/test/abstract_dispatcher.rb +548 -0
data/test/abstract_unit.rb +39 -0
data/test/api_test.rb +102 -0
data/test/apis/auto_load_api.rb +3 -0
data/test/apis/broken_auto_load_api.rb +2 -0
data/test/base_test.rb +42 -0
data/test/casting_test.rb +94 -0
data/test/client_soap_test.rb +155 -0
data/test/client_xmlrpc_test.rb +153 -0
data/test/container_test.rb +73 -0
data/test/dispatcher_action_controller_soap_test.rb +138 -0
data/test/dispatcher_action_controller_xmlrpc_test.rb +59 -0
data/test/fixtures/db_definitions/mysql.sql +8 -0
data/test/fixtures/users.yml +12 -0
data/test/gencov +3 -0
data/test/invocation_test.rb +185 -0
data/test/run +6 -0
data/test/scaffolded_controller_test.rb +146 -0
data/test/struct_test.rb +52 -0
data/test/test_invoke_test.rb +112 -0
metadata +173 -0

data/examples/googlesearch/delegated/search_controller.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'google_search_service'
+class SearchController < ApplicationController
+  wsdl_service_name 'GoogleSearch'
+  web_service_dispatching_mode :delegated
+  web_service :beta3, GoogleSearchService.new
+end

data/examples/googlesearch/direct/google_search_api.rb ADDED Viewed

@@ -0,0 +1,50 @@
+class DirectoryCategory < ActionWebService::Struct
+  member :fullViewableName, :string
+  member :specialEncoding,  :string
+end
+class ResultElement < ActionWebService::Struct
+  member :summary,                   :string
+  member :URL,                       :string
+  member :snippet,                   :string
+  member :title,                     :string
+  member :cachedSize,                :string
+  member :relatedInformationPresent, :bool
+  member :hostName,                  :string
+  member :directoryCategory,         DirectoryCategory
+  member :directoryTitle,            :string
+end
+class GoogleSearchResult < ActionWebService::Struct
+  member :documentFiltering,          :bool
+  member :searchComments,             :string
+  member :estimatedTotalResultsCount, :int
+  member :estimateIsExact,            :bool
+  member :resultElements,             [ResultElement]
+  member :searchQuery,                :string
+  member :startIndex,                 :int
+  member :endIndex,                   :int
+  member :searchTips,                 :string
+  member :directoryCategories,        [DirectoryCategory]
+  member :searchTime,                 :float
+end
+class GoogleSearchAPI < ActionWebService::API::Base
+  inflect_names false
+  api_method :doGetCachedPage,         :returns => [:string], :expects => [{:key=>:string}, {:url=>:string}]
+  api_method :doGetSpellingSuggestion, :returns => [:string], :expects => [{:key=>:string}, {:phrase=>:string}]
+  api_method :doGoogleSearch, :returns => [GoogleSearchResult], :expects => [
+    {:key=>:string},
+    {:q=>:string},
+    {:start=>:int},
+    {:maxResults=>:int},
+    {:filter=>:bool},
+    {:restrict=>:string},
+    {:safeSearch=>:bool},
+    {:lr=>:string},
+    {:ie=>:string},
+    {:oe=>:string}
+  ]
+end

data/examples/googlesearch/direct/search_controller.rb ADDED Viewed

@@ -0,0 +1,58 @@
+class SearchController < ApplicationController
+  web_service_api :google_search
+  wsdl_service_name 'GoogleSearch'
+  def doGetCachedPage
+    "<html><body>i am a cached page. my key was %s, url was %s</body></html>" % [@params['key'], @params['url']]
+  end
+  def doSpellingSuggestion
+    "%s: Did you mean '%s'?" % [@params['key'], @params['phrase']]
+  end
+  def doGoogleSearch
+    resultElement = ResultElement.new
+    resultElement.summary = "ONlamp.com: Rolling with Ruby on Rails"
+    resultElement.URL = "http://www.onlamp.com/pub/a/onlamp/2005/01/20/rails.html"
+    resultElement.snippet = "Curt Hibbs shows off Ruby on Rails by building a simple application that requires " +
+                            "almost no Ruby experience. ... Rolling with Ruby on Rails. ..."
+    resultElement.title = "Teh Railz0r"
+    resultElement.cachedSize = "Almost no lines of code!"
+    resultElement.relatedInformationPresent = true
+    resultElement.hostName = "rubyonrails.com"
+    resultElement.directoryCategory = category("Web Development", "UTF-8")
+    result = GoogleSearchResult.new
+    result.documentFiltering = @params['filter']
+    result.searchComments = ""
+    result.estimatedTotalResultsCount = 322000
+    result.estimateIsExact = false
+    result.resultElements = [resultElement]
+    result.searchQuery = "http://www.google.com/search?q=ruby+on+rails"
+    result.startIndex = @params['start']
+    result.endIndex = @params['start'] + @params['maxResults']
+    result.searchTips = "\"on\" is a very common word and was not included in your search [details]"
+    result.searchTime = 0.000001
+    # For Mono, we have to clone objects if they're referenced by more than one place, otherwise
+    # the Ruby SOAP collapses them into one instance and uses references all over the
+    # place, confusing Mono.
+    #
+    # This has recently been fixed:
+    #   http://bugzilla.ximian.com/show_bug.cgi?id=72265
+    result.directoryCategories = [
+      category("Web Development", "UTF-8"),
+      category("Programming", "US-ASCII"),
+    ]
+    result
+  end
+  private
+    def category(name, encoding)
+      cat = DirectoryCategory.new
+      cat.fullViewableName = name.dup
+      cat.specialEncoding = encoding.dup
+      cat
+    end
+end

data/examples/metaWeblog/README ADDED Viewed

@@ -0,0 +1,17 @@
+= metaWeblog example
+This example shows how one might begin to go about adding metaWeblog
+(http://www.xmlrpc.com/metaWeblogApi) API support to a Rails-based
+blogging application.
+The example APIs are more verbose than you may want to make them, for documentation
+reasons.
+= Running
+  1. Copy the "apis" directory and its files into "app" in a Rails project.
+  2. Copy the "controllers" directory and its files into "app" in a Rails project
+  3. Fire up a desktop blogging application (such as w.bloggar, MarsEdit, or BloGTK),
+     point it at http://localhost:3000/xmlrpc/api, and try creating or editing blog posts.

data/examples/metaWeblog/apis/blogger_api.rb ADDED Viewed

@@ -0,0 +1,60 @@
+#
+# see the blogger API spec at http://www.blogger.com/developers/api/1_docs/
+# note that the method signatures are subtly different to metaWeblog, they
+# are not identical. take care to ensure you handle the different semantics
+# properly if you want to support blogger API too, to get maximum compatibility.
+#
+module Blog
+  class Blog < ActionWebService::Struct
+    member :url,      :string
+    member :blogid,   :string
+    member :blogName, :string
+  end
+  class User < ActionWebService::Struct
+    member :nickname,  :string
+    member :userid,    :string
+    member :url,       :string
+    member :email,     :string
+    member :lastname,  :string
+    member :firstname, :string
+  end
+end
+#
+# blogger
+#
+class BloggerAPI < ActionWebService::API::Base
+  inflect_names false
+  api_method :newPost, :returns => [:string], :expects => [
+    {:appkey=>:string},
+    {:blogid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+    {:content=>:string},
+    {:publish=>:bool}
+  ]
+  api_method :editPost, :returns => [:bool], :expects => [
+    {:appkey=>:string},
+    {:postid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+    {:content=>:string},
+    {:publish=>:bool}
+  ]
+  api_method :getUsersBlogs, :returns => [[Blog::Blog]], :expects => [
+    {:appkey=>:string},
+    {:username=>:string},
+    {:password=>:string}
+  ]
+  api_method :getUserInfo, :returns => [Blog::User], :expects => [
+    {:appkey=>:string},
+    {:username=>:string},
+    {:password=>:string}
+  ]
+end

data/examples/metaWeblog/apis/blogger_service.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require 'blogger_api'
+class BloggerService < ActionWebService::Base
+  web_service_api BloggerAPI
+  def initialize
+    @postid = 0
+  end
+  def newPost(key, id, user, pw, content, publish)
+    $stderr.puts "id=#{id} user=#{user} pw=#{pw}, content=#{content.inspect} [#{publish}]"
+    (@postid += 1).to_s
+  end
+  def editPost(key, post_id, user, pw, content, publish)
+    $stderr.puts "id=#{post_id} user=#{user} pw=#{pw} content=#{content.inspect} [#{publish}]"
+    true
+  end
+  def getUsersBlogs(key, user, pw)
+    $stderr.puts "getting blogs for #{user}"
+    blog = Blog::Blog.new(
+      :url =>'http://blog',
+      :blogid => 'myblog',
+      :blogName => 'My Blog'
+    )
+    [blog]
+  end
+  def getUserInfo(key, user, pw)
+    $stderr.puts "getting user info for #{user}"
+    Blog::User.new(:nickname => 'user', :email => 'user@test.com')
+  end
+end

data/examples/metaWeblog/apis/meta_weblog_api.rb ADDED Viewed

@@ -0,0 +1,67 @@
+#
+# here lie structures, cousins of those on http://www.xmlrpc.com/metaWeblog
+# but they don't necessarily the real world reflect
+# so if you do, find that your client complains:
+# please tell, of problems you suffered through
+#
+module Blog
+  class Post < ActionWebService::Struct
+    member :title,       :string
+    member :link,        :string
+    member :description, :string
+    member :author,      :string
+    member :category,    :string
+    member :comments,    :string
+    member :guid,        :string
+    member :pubDate,     :string
+  end
+  class Category < ActionWebService::Struct
+    member :description, :string
+    member :htmlUrl,     :string
+    member :rssUrl,      :string
+  end
+end
+#
+# metaWeblog
+#
+class MetaWeblogAPI < ActionWebService::API::Base
+  inflect_names false
+  api_method :newPost, :returns => [:string], :expects => [
+    {:blogid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+    {:struct=>Blog::Post},
+    {:publish=>:bool}
+  ]
+  api_method :editPost, :returns => [:bool], :expects => [
+    {:postid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+    {:struct=>Blog::Post},
+    {:publish=>:bool},
+  ]
+  api_method :getPost, :returns => [Blog::Post], :expects => [
+    {:postid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+  ]
+  api_method :getCategories, :returns => [[Blog::Category]], :expects => [
+    {:blogid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+  ]
+  api_method :getRecentPosts, :returns => [[Blog::Post]], :expects => [
+    {:blogid=>:string},
+    {:username=>:string},
+    {:password=>:string},
+    {:numberOfPosts=>:int},
+  ]
+end

data/examples/metaWeblog/apis/meta_weblog_service.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require 'meta_weblog_api'
+class MetaWeblogService < ActionWebService::Base
+  web_service_api MetaWeblogAPI
+  def initialize
+    @postid = 0
+  end
+  def newPost(id, user, pw, struct, publish)
+    $stderr.puts "id=#{id} user=#{user} pw=#{pw}, struct=#{struct.inspect} [#{publish}]"
+    (@postid += 1).to_s
+  end
+  def editPost(post_id, user, pw, struct, publish)
+    $stderr.puts "id=#{post_id} user=#{user} pw=#{pw} struct=#{struct.inspect} [#{publish}]"
+    true
+  end
+  def getPost(post_id, user, pw)
+    $stderr.puts "get post #{post_id}"
+    Blog::Post.new(:title => 'hello world', :description => 'first post!')
+  end
+  def getCategories(id, user, pw)
+    $stderr.puts "categories for #{user}"
+    cat = Blog::Category.new(
+      :description => 'Tech',
+      :htmlUrl     => 'http://blog/tech',
+      :rssUrl      => 'http://blog/tech.rss')
+    [cat]
+  end
+  def getRecentPosts(id, user, pw, num)
+    $stderr.puts "recent #{num} posts for #{user} on blog #{id}"
+    post1 = Blog::Post.new(
+      :title => 'first post!',
+      :link => 'http://blog.xeraph.org/testOne.html',
+      :description => 'this is the first post'
+    )
+    post2 = Blog::Post.new(
+      :title => 'second post!',
+      :link => 'http://blog.xeraph.org/testTwo.html',
+      :description => 'this is the second post'
+    )
+    [post1, post2]
+  end
+end

data/examples/metaWeblog/controllers/xmlrpc_controller.rb ADDED Viewed

@@ -0,0 +1,16 @@
+#
+# example controller implementing both blogger and metaWeblog APIs
+# in a way that should be compatible with clients supporting both/either.
+#
+# test by pointing your client at http://URL/xmlrpc/api
+#
+require 'meta_weblog_service'
+require 'blogger_service'
+class XmlrpcController < ApplicationController
+  web_service_dispatching_mode :layered
+  web_service :metaWeblog, MetaWeblogService.new
+  web_service :blogger, BloggerService.new
+end

data/generators/web_service/USAGE ADDED Viewed

@@ -0,0 +1,28 @@
+Description:
+    The web service generator creates the controller and API definition for
+    a web service.
+    The generator takes a web service name and a list of API methods as arguments.
+    The web service name may be given in CamelCase or under_score and should
+    contain no extra suffixes.  To create a web service within a
+    module, specify the web service name as 'module/webservice'.
+    The generator creates a controller class in app/controllers, an API definition
+    in app/apis, and a functional test suite in test/functional.
+Example:
+    ./script/generate web_service User add edit list remove
+    User web service.
+        Controller: app/controllers/user_controller.rb
+        API:        app/apis/user_api.rb
+        Test:       test/functional/user_api_test.rb
+Modules Example:
+    ./script/generate web_service 'api/registration' register renew
+    Registration web service.
+        Controller: app/controllers/api/registration_controller.rb
+        API:        app/apis/api/registration_api.rb
+        Test:       test/functional/api/registration_api_test.rb

data/generators/web_service/templates/api_definition.rb ADDED Viewed

@@ -0,0 +1,5 @@
+class <%= class_name %>Api < ActionWebService::API::Base
+<% for method_name in args -%>
+  api_method :<%= method_name %>
+<% end -%>
+end

data/generators/web_service/templates/controller.rb ADDED Viewed

@@ -0,0 +1,8 @@
+class <%= class_name %>Controller < ApplicationController
+  wsdl_service_name '<%= class_name %>'
+<% for method_name in args -%>
+  def <%= method_name %>
+  end
+<% end -%>
+end

data/generators/web_service/templates/functional_test.rb ADDED Viewed

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '<%= '/..' * class_nesting_depth %>/../test_helper'
+require '<%= file_path %>_controller'
+class <%= class_name %>Controller; def rescue_action(e) raise e end; end
+class <%= class_name %>ControllerApiTest < Test::Unit::TestCase
+  def setup
+    @controller = <%= class_name %>Controller.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+<% for method_name in args -%>
+  def test_<%= method_name %>
+    result = invoke :<%= method_name %>
+    assert_equal nil, result
+  end
+<% end -%>
+end

data/generators/web_service/web_service_generator.rb ADDED Viewed

@@ -0,0 +1,29 @@
+class WebServiceGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, "#{class_name}Api", "#{class_name}Controller", "#{class_name}ApiTest"
+      # API and test directories.
+      m.directory File.join('app/services', class_path)
+      m.directory File.join('app/controllers', class_path)
+      m.directory File.join('test/functional', class_path)
+      # API definition, controller, and functional test.
+      m.template 'api_definition.rb',
+                  File.join('app/services',
+                            class_path,
+                            "#{file_name}_api.rb")
+      m.template 'controller.rb',
+                  File.join('app/controllers',
+                            class_path,
+                            "#{file_name}_controller.rb")
+      m.template 'functional_test.rb',
+                  File.join('test/functional',
+                            class_path,
+                            "#{file_name}_api_test.rb")
+    end
+  end
+end