jro_apps/redmine Files · vendor/plugins/actionwebservice/lib/action_web_service/base.rb

Merged r1451 to r1454, r1458, r1460 to r1463 from trunk....

Merged r1451 to r1454, r1458, r1460 to r1463 from trunk. git-svn-id: http://redmine.rubyforge.org/svn/branches/0.7-stable@1474 e93f8b46-1217-0410-a6f0-8f06a7374b81

Jean-Philippe Lang - - Load All Authors

File last commit:

r962:6d9490ddcc9c


                r1460:2074f0ab4144

Download file

             base.rb
        
                    38 lines
            
             | 1.1 KiB
            
                | text/x-ruby
            
             |
                RubyLexer
            
             / vendor / plugins / actionwebservice / lib / action_web_service / base.rb
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      module ActionWebService # :nodoc:

        class ActionWebServiceError < StandardError # :nodoc:

        end

        # An Action Web Service object implements a specified API.

        #

        # Used by controllers operating in _Delegated_ dispatching mode.

        #

        # ==== Example

        # 

        #   class PersonService < ActionWebService::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 < ActionWebService::API::Base

        #     api_method :find_person,   :expects => [SearchCriteria], :returns => [[Person]]

        #     api_method :delete_person, :expects => [:int]

        #   end

        #

        #   class SearchCriteria < ActionWebService::Struct

        #     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

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				module ActionWebService # :nodoc:
				class ActionWebServiceError < StandardError # :nodoc:
				end

				# An Action Web Service object implements a specified API.
				#
				# Used by controllers operating in _Delegated_ dispatching mode.
				#
				# ==== Example
				#
				# class PersonService < ActionWebService::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 < ActionWebService::API::Base
				# api_method :find_person, :expects => [SearchCriteria], :returns => [[Person]]
				# api_method :delete_person, :expects => [:int]
				# end
				#
				# class SearchCriteria < ActionWebService::Struct
				# 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