aboutsummaryrefslogtreecommitdiffstats
path: root/actionwebservice/lib/action_service/base.rb
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2005-02-18 23:43:09 +0000
committerDavid Heinemeier Hansson <david@loudthinking.com>2005-02-18 23:43:09 +0000
commit7a67d0f617db7d2962b6c3b80466e21570b244bf (patch)
tree56fa640e31f4f7f22d34a246bc1b197706a07e3a /actionwebservice/lib/action_service/base.rb
parentfdecb6843ba8c5b0f718225f343017e11fa7f711 (diff)
downloadrails-7a67d0f617db7d2962b6c3b80466e21570b244bf.tar.gz
rails-7a67d0f617db7d2962b6c3b80466e21570b244bf.tar.bz2
rails-7a67d0f617db7d2962b6c3b80466e21570b244bf.zip
Renamed Action Service to Action Web Service
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@669 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'actionwebservice/lib/action_service/base.rb')
-rw-r--r--actionwebservice/lib/action_service/base.rb41
1 files changed, 41 insertions, 0 deletions
diff --git a/actionwebservice/lib/action_service/base.rb b/actionwebservice/lib/action_service/base.rb
new file mode 100644
index 0000000000..05fd2afd34
--- /dev/null
+++ b/actionwebservice/lib/action_service/base.rb
@@ -0,0 +1,41 @@
+require 'action_service/support/class_inheritable_options'
+require 'action_service/support/signature'
+
+module ActionService # :nodoc:
+ class ActionServiceError < StandardError # :nodoc:
+ end
+
+ # An Action Service object implements a specified API.
+ #
+ # Used by controllers operating in _Delegated_ dispatching mode.
+ #
+ # ==== Example
+ #
+ # class PersonService < ActionService::Base
+ # web_service_api PersonAPI
+ #
+ # def find_person(criteria)
+ # Person.find_all [...]
+ # end
+ #
+ # def delete_person(id)
+ # Person.find_by_id(id).destroy
+ # end
+ # end
+ #
+ # class PersonAPI < ActionService::API::Base
+ # api_method :find_person, :expects => [SearchCriteria], :returns => [[Person]]
+ # api_method :delete_person, :expects => [:int]
+ # end
+ #
+ # class SearchCriteria < ActionStruct::Base
+ # member :firstname, :string
+ # member :lastname, :string
+ # member :email, :string
+ # end
+ class Base
+ # Whether to report exceptions back to the caller in the protocol's exception
+ # format
+ class_inheritable_option :web_service_exception_reporting, true
+ end
+end