diff --git a/CHANGELOGS.txt b/CHANGELOGS.txt
index da54ebf3..6f4f3c1e 100644
--- a/CHANGELOGS.txt
+++ b/CHANGELOGS.txt
@@ -1,38 +1,7 @@
History for Eiffel-Web-Framework
+[2015-06-10]
+ * Updated EWF design to better support concurrency, including SCOOP via
+ the new standalone connector.
-[2011-09-23] Jocelyn
- * library "ewsgi":
- - NEW simple autotest cases using Nino web server
- -fixed issue with RAW_POST_DATA being added in form_data_parameters
- instead of meta_variables ...
- - Implemented WGI_VALUE for parameter's type (query_parameter,
- form_data_parameter, item ...)
- * Nino connector: added feature to shutdown the server from the WGI application
- * NEW library "http_client": a new library to perform simple http requests
- such as get, head, post, put, ... (currently implemented with Eiffel cURL)
- * NEW library "http_authorization": added simple library to support
- HTTP_AUTHORIZATION. For now only "Basic" auth type is supported ..
-
-[2011-09-22] Javier
- * NEW Example: added partial Restbuck example
-
-[2011-09-21] Jocelyn
- * Nino connector: fixed an issue with missing value for Content-Type and Content-Length
-
-[2011-09-13] Jocelyn
- * library "router": now using a generic design to allow customization of
- request handler context class.
- * NEW library "server/request/rest": first attempt to provide a library to
- help building RESTful application (the interfaces are likely to change
- soon) EXPERIMENTAL
-
-[2011-09-09] Jocelyn
- * library "uri-template": better support for {/vars} and {?vars}
-
-[2011-09-07] Jocelyn
- * library "router": now routing depends on uri (or uri template) and request methods
- * Nino connector: Fixed issue where HTTP_ prefix were missing for header meta variable.
-
-[2011-09-07] Jocelyn
- * changelog: starting to write down changelogs file
+[Previous ] Many significant changes in v0
diff --git a/MIGRATION.md b/MIGRATION.md
index 6b34d0b1..5a5b5bad 100644
--- a/MIGRATION.md
+++ b/MIGRATION.md
@@ -1,4 +1,4 @@
-Date: 2015-mar-31
+Date: 2015-june
# Goal:
=======
@@ -7,7 +7,7 @@ Date: 2015-mar-31
# Status:
=========
-- The current version of EWF has mainly 3 connectors: CGI, libFCGI, and nino.
+- The version v0 of EWF has mainly 3 connectors: CGI, libFCGI, and nino.
- CGI and libFCGI connectors does not need any concurrency support.
- But the nino connector had a pseudo concurrency support with Thread, however one could do write code that result in hasardeous concurrency execution.
diff --git a/doc/workbook/SERVICE_TEMPLATE.png b/doc/workbook/SERVICE_TEMPLATE.png
deleted file mode 100644
index f8eecdbd..00000000
Binary files a/doc/workbook/SERVICE_TEMPLATE.png and /dev/null differ
diff --git a/doc/workbook/basics/APPLICATION_EXECUTION.png b/doc/workbook/basics/APPLICATION_EXECUTION.png
new file mode 100644
index 00000000..270c78aa
Binary files /dev/null and b/doc/workbook/basics/APPLICATION_EXECUTION.png differ
diff --git a/doc/workbook/basics/Launcher Hierarchy.png b/doc/workbook/basics/Launcher Hierarchy.png
new file mode 100644
index 00000000..d7c04723
Binary files /dev/null and b/doc/workbook/basics/Launcher Hierarchy.png differ
diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png
new file mode 100644
index 00000000..ba484064
Binary files /dev/null and b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png differ
diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png
new file mode 100644
index 00000000..b42d4b96
Binary files /dev/null and b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png differ
diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png
new file mode 100644
index 00000000..ecca100e
Binary files /dev/null and b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png differ
diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png
new file mode 100644
index 00000000..c3eea2fb
Binary files /dev/null and b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png differ
diff --git a/doc/workbook/basics/basics.md b/doc/workbook/basics/basics.md
index e425620a..f5706441 100644
--- a/doc/workbook/basics/basics.md
+++ b/doc/workbook/basics/basics.md
@@ -1,4 +1,4 @@
-Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/workbook/handling_request/form.md)
+Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/doc/workbook/handling_request/form.md)
## EWF basic service
@@ -14,133 +14,140 @@ Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/wor
## EWF service structure
-The following code describes the basic structure of an EWF basic service that handles HTTP requests.
+The following code describes the basic structure of an EWF basic service that handles HTTP requests. We will need to define a Service Launcher and a Request Execution implementation.
```eiffel
class
- SERVICE_TEMPLATE
+ APPLICACTION
inherit
- WSF_DEFAULT_SERVICE -- Todo explain this, and the concept of launchers and connectors ()
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
create
- make_and_launch
+ make_and_launch
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- do
- -- To read incoming HTTP request, we need to use `req'
-
- -- May require talking to databases or other services.
-
- -- To send a response we need to setup, the status code and
- -- the response headers and the content we want to send out our client
- end
end
```
-When using the "nino" connector, by default the service listens on port 80, but often this port is already used by other applications, so it is recommended to use another port.
-To define another port, redefine the feature `initialize' and set up a new port number using the service options (see below).
+The class ```APPLICATION``` inherit from
+```WSF_DEFAULT_SERVICE [G ->WSF_EXECUTION create make end]``` it will be responsible to launch the service and set optional options.
+
+The class ```APPLICATION_EXECUTION``` is an implementation of ```WSF_EXECUTION``` interface, which is instantiated for each incoming request.
```eiffel
class
- SERVICE_TEMPLATE
+ APPLICATION_EXECUTION
+
inherit
- WSF_DEFAULT_SERVICE
- redefine
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Basic operations
+
+ execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ do
+ -- To read incoming HTTP request, we need to use `req'
+
+ -- May require talking to databases or other services.
+
+ -- To send a response we need to setup, the status code and
+ -- the response headers and the content we want to send out our client
+ end
+end
+```
+
+When using the "nino" connector or the new "standalone" connector, by default the service listens on port 80, but often this port is already used by other applications, so it is recommended to use another port.
+To define another port, redefine the feature `initialize' and set up a new port number using the service options (see below).
+
+
+```eiffel
+class
+ APPLICATION
+
+inherit
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
+ redefine
initialize
end
create
- make_and_launch
+ make_and_launch
feature {NONE} -- Initialization
initialize
-- Initialize current service.
- -- on port 9090
do
set_service_option ("port", 9090)
end
-
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incoming request.
- do
- -- To read incoming HTTP requires, we need to use `req'
-
- -- May require talking to databases or other services.
-
- -- To send a response we need to setup, the status code and
- -- the response headers and the content we want to send out client
- end
end
```
The **WSF_REQUEST** gives access to the incoming data; the class provides features to get information such as request method, form data, query parameters, uploaded files, HTTP request headers, and hostname of the client among others.
+
The **WSF_RESPONSE** provides features to define the response with information such as HTTP status codes (10x,20x, 30x, 40x, and 50x), response headers (Content-Type, Content-Length, etc.) and obviously the body of the message itself.
-**SERVICE_TEMPLATE** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how you want to run it cgi, fcgi or nino. For development is recommended to use Nino, a standalone web server written in Eiffel, and run the execution within the EiffelStudio debugger. For production fcgi (or cgi) using Apache or another popular web server.
+**APPLICATION** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how you want to run it cgi, fcgi,nino or standalone. For development is recommended to use a standalone web server written in Eiffel, and run the execution within the EiffelStudio debugger. For production fcgi (or cgi) using Apache or another popular web server.
-The **SERVICE_TEMPLATE** class inherits from _WSF_DEFAULT_SERVICE_ class, and this one also inherits from other interfaces. Let’s describe them in a few words.
+
-
+**WS_LAUNCHABLE_SERVICE** inherit from **WS_SERVICE** class, which is a marker interface in EWF. And also provides a way to launch our application using different kind of connectors. The class **WSF_DEFAULT_SERVICE_I**, inherit from **WS_LAUNCHABLE_SERVICE** and has a formal generic that should conform to **WSF_SERVICE_LAUNCHER [WSF_EXECUTION]**. Below a [BON diagram] (http://www.bon-method.com/index_normal.htm) showing one of the possible options.
-**WS_LAUNCHABLE_SERVICE** inherit from **WS_SERVICE** class, which is the low level entry point in EWF, handling each incoming request with a single procedure ```execute (req: WSF_REQUEST; res: WSF_RESPONSE) ...```. And also provides a way to launch our application using different kind of connectors. Below a [BON diagram] (http://www.bon-method.com/index_normal.htm) showing the different kind of connectors.
+
+Other connectors:
-
+**WSF_STANDALONE_SERVICE_LAUNCHER**
+**WSF_CGI_SERVICE_LAUNCHER**
+**WSF_NINO_SERVICE_LAUNCHER**
+**WSF_LIBFCGI_SERVICE_LAUNCHER**
-A basic EWF service inherits from **WSF_DEFAULT_SERVICE** (for other options see [?]).
-And then you only need to implement the **execute** feature, get data from the request *req* and write the response in *res*.
+A basic EWF service inherits from **WSF_DEFAULT_SERVICE**, which has a formal generic that should conform to **WSF_EXECUTION** class with a `make' creation procedure, in our case the class **APPLICATION_EXECUTION**.
+
+The **APPLICATION_EXECUTION** class inherits from **WSF_EXECUTION** interface, which is instantiated for each incoming request. **WSF_EXECUTION** inherit from **WGI_EXECUTION** which is the low level entry point in EWF, handling each incoming request with a single procedure ```execute (req: WSF_REQUEST; res: WSF_RESPONSE) ...```.
+
+In the **APPLICATION_EXECUTION** class class you will need to implement implement the **execute** feature, get data from the request *req* and write the response in *res*.
+
+
+
+The WSF_EXECUTION instance, in this case ```APPLICATION_EXECUTION``` is created per request, with two main attributes request: ```WSF_REQUEST``` and response: ```WSF_RESPONSE```.
## A simple Service to Generate Plain Text.
-Before to continue, it is recommended to review the getting started guided.
+Before to continue, it is recommended to review the getting started guided. In the example we will only shows the implementation of the WSF_EXECUTION interface.
```eiffel
class
- APPLICATION
+ APPLICATION_EXECUTION
inherit
- WSF_DEFAULT_SERVICE
- redefine
- initialize
- end
+ WSF_EXECUTION
create
- make_and_launch
-
-feature {NONE} -- Initialization
-
- initialize
- -- Initialize current service.
- do
- set_service_option ("port", 9090)
- end
+ make
feature -- Basic operations
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ execute
-- Execute the incomming request
do
-- To send a response we need to setup, the status code and
-- the response headers.
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>)
- res.put_string ("Hello World")
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>)
+ response.put_string ("Hello World")
end
-
end
+
```
##### Source code
The source code is available on Github. You can get it by running the command:
-```git clone https://github.com/EiffelWebFramework/ewf_examples.git```
+```git clone https://github.com/EiffelWebFramework/ewf.git```
-The example of simple service that generate plain text response is located in the directory $PATH/ewf_examples/workbook/basics/simple, where $PATH is where you run ```git clone``` . Just double click on the simple.ecf file and select the simple_nino target or if you prefer the command line, run the command:
+The example of simple service that generate plain text response is located in the directory $PATH/ewd/doc/workbook/basics/simple, where $PATH is where you run ```git clone``` . Just double click on the simple.ecf file and select the simple_nino target or if you prefer the command line, run the command:
```estudio -config simple.ecf -target simple_nino```
@@ -153,37 +160,25 @@ To generate HTML, it's needed
```eiffel
class
- APPLICATION
+ APPLICATION_EXECUTION
inherit
- WSF_DEFAULT_SERVICE
- redefine
- initialize
- end
+ WSF_EXECUTION
create
- make_and_launch
-
-feature {NONE} -- Initialization
-
- initialize
- -- Initialize current service.
- do
- set_service_option ("port", 9090)
- end
+ make
feature -- Basic operations
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ execute
-- Execute the incomming request
do
-- To send a response we need to setup, the status code and
-- the response headers.
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>)
- res.put_string (web_page)
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>)
+ response.put_string (web_page)
end
-
web_page: STRING = "[
@@ -201,11 +196,11 @@ end
##### Source code
The source code is available on Github. You can get it by running the command:
-```git clone https://github.com/EiffelWebFramework/ewf_examples.git```
+```git clone https://github.com/EiffelWebFramework/ewf.git```
-The example of the service that generates HTML is located in the directory $PATH/ewf_examples/workbook/basics/simple_html, where $PATH is where you run ```git clone``` . Just double click on the simple_html.ecf file and select the simple_html_nino target or if you prefer the command line, run the command:
+The example of the service that generates HTML is located in the directory $PATH/ewf/doc/workbook/basics/simple_html, where $PATH is where you run ```git clone``` . Just double click on the simple_html.ecf file and select the simple_html_nino target or if you prefer the command line, run the command:
```estudio -config simple_html.ecf -target simple_html_nino```
-Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/workbook/handling_request/form.md)
+Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/doc/workbook/handling_request/form.md)
diff --git a/doc/workbook/basics/simple/application.e b/doc/workbook/basics/simple/application.e
index 76fc8322..cf939f60 100644
--- a/doc/workbook/basics/simple/application.e
+++ b/doc/workbook/basics/simple/application.e
@@ -1,13 +1,11 @@
note
- description : "Basic Service that Generates Plain Text"
- date : "$Date$"
- revision : "$Revision$"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -23,15 +21,4 @@ feature {NONE} -- Initialization
set_service_option ("port", 9090)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- do
- -- To send a response we need to setup, the status code and
- -- the response headers.
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>)
- res.put_string ("Hello World")
- end
-
end
diff --git a/doc/workbook/basics/simple/application_execution.e b/doc/workbook/basics/simple/application_execution.e
new file mode 100644
index 00000000..58917ef8
--- /dev/null
+++ b/doc/workbook/basics/simple/application_execution.e
@@ -0,0 +1,25 @@
+note
+ description : "Basic Service that Generates Plain Text"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class
+ APPLICATION_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Basic operations
+
+ execute
+ -- Execute the incomming request
+ do
+ -- To send a response we need to setup, the status code and
+ -- the response headers.
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>)
+ response.put_string ("Hello World")
+ end
+end
diff --git a/doc/workbook/basics/simple/simple.ecf b/doc/workbook/basics/simple/simple.ecf
index 5f3b30d7..3d9149d0 100644
--- a/doc/workbook/basics/simple/simple.ecf
+++ b/doc/workbook/basics/simple/simple.ecf
@@ -37,6 +37,14 @@
+
+
+
+
+
+
diff --git a/doc/workbook/basics/simple_html/application.e b/doc/workbook/basics/simple_html/application.e
index 77b1b02c..cf939f60 100644
--- a/doc/workbook/basics/simple_html/application.e
+++ b/doc/workbook/basics/simple_html/application.e
@@ -1,13 +1,11 @@
note
- description : "Basic Service that Generate HTML"
- date : "$Date$"
- revision : "$Revision$"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -23,55 +21,4 @@ feature {NONE} -- Initialization
set_service_option ("port", 9090)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- do
- -- To send a response we need to setup, the status code and
- -- the response headers.
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>)
- res.put_string (web_page)
- end
-
-
- web_page: STRING = "[
-
-
-
- Resume
-
-
-
Use a tool to see the request and header details, for example (Developers tools in Chrome or Firebugs in Firefox)
+
+
+
+
This page is an example of $status
+
+
+
+
+]"
+
+
+
+
+end
diff --git a/doc/workbook/generating_response/status/application.e b/doc/workbook/generating_response/status/application.e
index 7aa03ac9..cf939f60 100644
--- a/doc/workbook/generating_response/status/application.e
+++ b/doc/workbook/generating_response/status/application.e
@@ -1,13 +1,11 @@
note
- description : "Basic Service that a simple web page to show the most common status codes"
- date : "$Date$"
- revision : "$Revision$"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -23,127 +21,4 @@ feature {NONE} -- Initialization
set_service_option ("port", 9090)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- local
- l_message: STRING
- do
- -- To send a response we need to setup, the status code and
- -- the response headers.
- if req.is_get_request_method then
- if req.path_info.same_string ("/") then
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>)
- res.put_string (web_page)
- elseif req.path_info.same_string ("/redirect") then
- send_redirect (req, res, "https://httpwg.github.io/")
- elseif req.path_info.same_string ("/bad_request") then
- -- Here you can do some logic for example log, send emails to register the error, before to send the response.
- create l_message.make_from_string (message_template)
- l_message.replace_substring_all ("$title", "Bad Request")
- l_message.replace_substring_all ("$status", "Bad Request 400")
- res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
- res.put_string (l_message)
- elseif req.path_info.same_string ("/internal_error") then
- -- Here you can do some logic for example log, send emails to register the error, before to send the response.
- create l_message.make_from_string (message_template)
- l_message.replace_substring_all ("$title", "Internal Server Error")
- l_message.replace_substring_all ("$status", "Internal Server Error 500")
- res.put_header ({HTTP_STATUS_CODE}.internal_server_error, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
- res.put_string (l_message)
- else
- create l_message.make_from_string (message_template)
- l_message.replace_substring_all ("$title", "Resource not found")
- l_message.replace_substring_all ("$status", "Resource not found 400")
- res.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
- res.put_string (l_message)
- end
- else
- create l_message.make_from_string (message_template)
- l_message.replace_substring_all ("$title", "Method Not Allowed")
- l_message.replace_substring_all ("$status", "Method Not Allowed 405")
- -- Method not allowed
- res.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
- res.put_string (l_message)
- end
- end
-
-
-feature -- Home Page
-
- send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32)
- -- Redirect to `a_location'
- local
- h: HTTP_HEADER
- do
- create h.make
- h.put_content_type_text_html
- h.put_current_date
- h.put_location (a_location)
- res.set_status_code ({HTTP_STATUS_CODE}.see_other)
- res.put_header_text (h.string)
- end
-
- web_page: STRING = "[
-
-
-
- Example showing common status codes
-
-
-
-
Use a tool to see the request and header details, for example (Developers tools in Chrome or Firebugs in Firefox)
-
-
-
-
This page is an example of Status Code 200
-
-
Redirect Example
-
Click on the following link will redirect you to the HTTP Specifcation, we can do the redirect from the HTML directly but
- here we want to show you an exmaple, where you can do something before to send a redirect Redirect
-
-
Bad Request
-
Click on the following link, the server will answer with a 400 error, check the status code Bad Request
-
-
Internal Server Error
-
Click on the following link, the server will answer with a 500 error, check the status code Internal Error
-
-
Resource not found
-
Click on the following link or add to the end of the url something like /1030303 the server will answer with a 404 error, check the status code Not found
Use a tool to see the request and header details, for example (Developers tools in Chrome or Firebugs in Firefox)
-
-
-
-
This page is an example of $status
-
-
-
-
-]"
-
-
-
-
end
diff --git a/doc/workbook/generating_response/status/application_execution.e b/doc/workbook/generating_response/status/application_execution.e
new file mode 100644
index 00000000..691513b6
--- /dev/null
+++ b/doc/workbook/generating_response/status/application_execution.e
@@ -0,0 +1,138 @@
+note
+ description : "Basic Service that a simple web page to show the most common status codes"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class
+ APPLICATION_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Basic operations
+
+ execute
+ -- Execute the incomming request
+ local
+ l_message: STRING
+ do
+ -- To send a response we need to setup, the status code and
+ -- the response headers.
+ if request.is_get_request_method then
+ if request.path_info.same_string ("/") then
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>)
+ response.put_string (web_page)
+ elseif request.path_info.same_string ("/redirect") then
+ send_redirect (request, response, "https://httpwg.github.io/")
+ elseif request.path_info.same_string ("/bad_request") then
+ -- Here you can do some logic for example log, send emails to register the error, before to send the response.
+ create l_message.make_from_string (message_template)
+ l_message.replace_substring_all ("$title", "Bad Request")
+ l_message.replace_substring_all ("$status", "Bad Request 400")
+ response.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
+ response.put_string (l_message)
+ elseif request.path_info.same_string ("/internal_error") then
+ -- Here you can do some logic for example log, send emails to register the error, before to send the response.
+ create l_message.make_from_string (message_template)
+ l_message.replace_substring_all ("$title", "Internal Server Error")
+ l_message.replace_substring_all ("$status", "Internal Server Error 500")
+ response.put_header ({HTTP_STATUS_CODE}.internal_server_error, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
+ response.put_string (l_message)
+ else
+ create l_message.make_from_string (message_template)
+ l_message.replace_substring_all ("$title", "Resource not found")
+ l_message.replace_substring_all ("$status", "Resource not found 400")
+ response.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
+ response.put_string (l_message)
+ end
+ else
+ create l_message.make_from_string (message_template)
+ l_message.replace_substring_all ("$title", "Method Not Allowed")
+ l_message.replace_substring_all ("$status", "Method Not Allowed 405")
+ -- Method not allowed
+ response.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>)
+ response.put_string (l_message)
+ end
+ end
+
+
+feature -- Home Page
+
+ send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32)
+ -- Redirect to `a_location'
+ local
+ h: HTTP_HEADER
+ do
+ create h.make
+ h.put_content_type_text_html
+ h.put_current_date
+ h.put_location (a_location)
+ res.set_status_code ({HTTP_STATUS_CODE}.see_other)
+ res.put_header_text (h.string)
+ end
+
+ web_page: STRING = "[
+
+
+
+ Example showing common status codes
+
+
+
+
Use a tool to see the request and header details, for example (Developers tools in Chrome or Firebugs in Firefox)
+
+
+
+
This page is an example of Status Code 200
+
+
Redirect Example
+
Click on the following link will redirect you to the HTTP Specifcation, we can do the redirect from the HTML directly but
+ here we want to show you an exmaple, where you can do something before to send a redirect Redirect
+
+
Bad Request
+
Click on the following link, the server will answer with a 400 error, check the status code Bad Request
+
+
Internal Server Error
+
Click on the following link, the server will answer with a 500 error, check the status code Internal Error
+
+
Resource not found
+
Click on the following link or add to the end of the url something like /1030303 the server will answer with a 404 error, check the status code Not found
EWF service example: Showing Browser Dectection Using User-Agent
@@ -414,7 +394,7 @@ Internet Explorer
Enjoy using Internet Explorer
```
-Chrome
+**Chrome**
---
```
EWF service example: Showing Browser Dectection Using User-Agent
@@ -448,10 +428,11 @@ As an exercise, try to write a similar service to retrieve the OS family using t
* [SERVER_PROTOCOL](https://tools.ietf.org/html/rfc3875#section-4.1.15)
* [SERVER_SOFTWARE](https://tools.ietf.org/html/rfc3875#section-4.1.16)
-An [EWF service](./headers/cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables.
+**Example**
+An [EWF service](/doc/workbook/handling_request/headers/cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables.
-Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query parameters] (/workbook/handling_request/form.md) | [Generating Responses](/workbook/generating_response/generating_response.md)
+Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query parameters] (/doc/workbook/handling_request/form.md) | [Generating Responses](/doc/workbook/generating_response/generating_response.md)
diff --git a/doc/workbook/handling_request/headers/browser_name/application.e b/doc/workbook/handling_request/headers/browser_name/application.e
index d793f479..cf939f60 100644
--- a/doc/workbook/handling_request/headers/browser_name/application.e
+++ b/doc/workbook/handling_request/headers/browser_name/application.e
@@ -1,14 +1,11 @@
note
- description : "Basic Service that Read a Request, a "
- date : "$Date$"
- revision : "$Revision$"
- EIS: "name=Browser detection using user agent","src=https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent", "protocol=url"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -22,88 +19,6 @@ feature {NONE} -- Initialization
-- Initialize current service.
do
set_service_option ("port", 9090)
- set_service_option ("verbose", true)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- local
- l_raw_data: STRING
- l_page_response: STRING
- l_rows: STRING
- do
- create l_page_response.make_from_string (html_template)
- if req.path_info.same_string ("/") then
-
- -- retrieve the user-agent
- if attached req.http_user_agent as l_user_agent then
- l_page_response.replace_substring_all ("$user_agent", l_user_agent)
- l_page_response.replace_substring_all ("$browser", get_browser_name (l_user_agent))
- else
- l_page_response.replace_substring_all ("$user_agent", "[]")
- l_page_response.replace_substring_all ("$browser", "Unknown, the user-agent was not present.")
- end
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>)
- res.put_string (l_page_response)
- end
- end
-
-
-feature -- Browser utility
-
- get_browser_name (a_user_agent: READABLE_STRING_8):READABLE_STRING_32
- -- Must contain Must not contain
- -- Firefox Firefox/xyz Seamonkey/xyz
- -- Seamonkey Seamonkey/xyz
- -- Chrome Chrome/xyz Chromium/xyz
- -- Chromium Chromium/xyz
- -- Safari Safari/xyz Chrome/xyz
- -- Chromium/xyz
- -- Opera OPR/xyz [1]
- -- Opera/xyz [2]
- -- Internet Explorer ;MSIE xyz; Internet Explorer doesn't put its name in the BrowserName/VersionNumber format
-
- do
- if
- a_user_agent.has_substring ("Firefox") and then
- not a_user_agent.has_substring ("Seamonkey")
- then
- Result := "Firefox"
- elseif a_user_agent.has_substring ("Seamonkey") then
- Result := "Seamonkey"
- elseif a_user_agent.has_substring ("Chrome") and then not a_user_agent.has_substring ("Chromium")then
- Result := "Chrome"
- elseif a_user_agent.has_substring ("Chromium") then
- Result := "Chromiun"
- elseif a_user_agent.has_substring ("Safari") and then not (a_user_agent.has_substring ("Chrome") or else a_user_agent.has_substring ("Chromium")) then
- Result := "Safari"
- elseif a_user_agent.has_substring ("OPR") or else a_user_agent.has_substring ("Opera") then
- Result := "Opera"
- elseif a_user_agent.has_substring ("MSIE") or else a_user_agent.has_substring ("Trident")then
- Result := "Internet Explorer"
- else
- Result := "Unknown"
- end
- end
-
-
- html_template: STRING = "[
-
-
-
-
-
-
-
EWF service example: Showing Browser Dectection Using User-Agent
-
- User Agent: $user_agent
-
-
Enjoy using $browser
-
-
- ]"
-
-
end
diff --git a/doc/workbook/handling_request/headers/browser_name/application_execution.e b/doc/workbook/handling_request/headers/browser_name/application_execution.e
new file mode 100644
index 00000000..8ef85fd0
--- /dev/null
+++ b/doc/workbook/handling_request/headers/browser_name/application_execution.e
@@ -0,0 +1,97 @@
+note
+ description : "Basic Service that Read a Request, a "
+ date : "$Date$"
+ revision : "$Revision$"
+ EIS: "name=Browser detection using user agent","src=https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent", "protocol=url"
+
+class
+ APPLICATION_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Basic operations
+
+ execute
+ -- Execute the incomming request
+ local
+ l_raw_data: STRING
+ l_page_response: STRING
+ l_rows: STRING
+ do
+ create l_page_response.make_from_string (html_template)
+ if request.path_info.same_string ("/") then
+
+ -- retrieve the user-agent
+ if attached request.http_user_agent as l_user_agent then
+ l_page_response.replace_substring_all ("$user_agent", l_user_agent)
+ l_page_response.replace_substring_all ("$browser", browser_name (l_user_agent))
+ else
+ l_page_response.replace_substring_all ("$user_agent", "[]")
+ l_page_response.replace_substring_all ("$browser", "Unknown, the user-agent was not present.")
+ end
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>)
+ response.put_string (l_page_response)
+ end
+ end
+
+
+feature -- Browser utility
+
+ browser_name (a_user_agent: READABLE_STRING_8): STRING_8
+ -- Must contain Must not contain
+ -- Firefox Firefox/xyz Seamonkey/xyz
+ -- Seamonkey Seamonkey/xyz
+ -- Chrome Chrome/xyz Chromium/xyz
+ -- Chromium Chromium/xyz
+ -- Safari Safari/xyz Chrome/xyz
+ -- Chromium/xyz
+ -- Opera OPR/xyz [1]
+ -- Opera/xyz [2]
+ -- Internet Explorer ;MSIE xyz; Internet Explorer doesn't put its name in the BrowserName/VersionNumber format
+
+ do
+ if
+ a_user_agent.has_substring ("Firefox") and then
+ not a_user_agent.has_substring ("Seamonkey")
+ then
+ Result := "Firefox"
+ elseif a_user_agent.has_substring ("Seamonkey") then
+ Result := "Seamonkey"
+ elseif a_user_agent.has_substring ("Chrome") and then not a_user_agent.has_substring ("Chromium")then
+ Result := "Chrome"
+ elseif a_user_agent.has_substring ("Chromium") then
+ Result := "Chromiun"
+ elseif a_user_agent.has_substring ("Safari") and then not (a_user_agent.has_substring ("Chrome") or else a_user_agent.has_substring ("Chromium")) then
+ Result := "Safari"
+ elseif a_user_agent.has_substring ("OPR") or else a_user_agent.has_substring ("Opera") then
+ Result := "Opera"
+ elseif a_user_agent.has_substring ("MSIE") or else a_user_agent.has_substring ("Trident")then
+ Result := "Internet Explorer"
+ else
+ Result := "Unknown"
+ end
+ end
+
+
+ html_template: STRING = "[
+
+
+
+
+
+
+
EWF service example: Showing Browser Dectection Using User-Agent
+
+ User Agent: $user_agent
+
+
Enjoy using $browser
+
+
+ ]"
+
+
+end
diff --git a/doc/workbook/handling_request/headers/cgi_variables/application.e b/doc/workbook/handling_request/headers/cgi_variables/application.e
index 718d5770..cf939f60 100644
--- a/doc/workbook/handling_request/headers/cgi_variables/application.e
+++ b/doc/workbook/handling_request/headers/cgi_variables/application.e
@@ -1,14 +1,11 @@
note
- description : "Basic Service that shows the standard CGI variables"
- date : "$Date$"
- revision : "$Revision$"
- EIS: "name=CGI specification","src=(https://tools.ietf.org/html/rfc3875", "protocol=url"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -22,294 +19,6 @@ feature {NONE} -- Initialization
-- Initialize current service.
do
set_service_option ("port", 9090)
- set_service_option ("verbose", true)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- local
- l_raw_data: STRING
- l_page_response: STRING
- l_rows: STRING
- do
- create l_page_response.make_from_string (html_template)
- if req.path_info.same_string ("/") then
-
- -- HTTP method
- l_page_response.replace_substring_all ("$http_method", req.request_method)
- -- URI
- l_page_response.replace_substring_all ("$uri", req.path_info)
- -- Protocol
- l_page_response.replace_substring_all ("$protocol", req.server_protocol)
-
- -- Fill the table rows with CGI standard variables
- create l_rows.make_empty
-
- -- Auth_type
- l_rows.append ("
+
+ $raw_header
+
+
+ ]"
+
+
+end
diff --git a/doc/workbook/handling_request/upload_file/application.e b/doc/workbook/handling_request/upload_file/application.e
index b37c0790..cf939f60 100644
--- a/doc/workbook/handling_request/upload_file/application.e
+++ b/doc/workbook/handling_request/upload_file/application.e
@@ -1,13 +1,11 @@
note
- description : "Basic Service that show how to Upload a file"
- date : "$Date$"
- revision : "$Revision$"
+ description: "Basic Service launcher"
class
APPLICATION
inherit
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
redefine
initialize
end
@@ -23,47 +21,4 @@ feature {NONE} -- Initialization
set_service_option ("port", 9090)
end
-feature -- Basic operations
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Execute the incomming request
- local
- file: WSF_FILE_RESPONSE
- l_answer: STRING
- do
- if req.is_get_request_method then
- if req.path_info.same_string ("/") then
- create file.make_html ("upload.html")
- res.send (file)
- else
- -- Here we should handle unexpected errors.
- end
- elseif req.is_post_request_method then
- if req.path_info.same_string ("/upload") then
- -- Check if we have an uploaded file
- if req.has_uploaded_file then
- -- iterate over all the uploaded files
- create l_answer.make_from_string ("
Uploaded File/s
")
- across req.uploaded_files as ic loop
- l_answer.append ("FileName:")
- l_answer.append (ic.item.filename)
- l_answer.append (" Size:")
- l_answer.append (ic.item.size.out)
- l_answer.append (" ")
- end
- res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>)
- res.put_string (l_answer)
- else
- -- Here we should handle unexpected errors.
- create l_answer.make_from_string ("No uploaded files ")
- create l_answer.append ("Back to Home")
- res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>)
- res.put_string (l_answer)
- end
- else
- -- Handle error
- end
- end
- end
-
end
diff --git a/doc/workbook/handling_request/upload_file/application_execution.e b/doc/workbook/handling_request/upload_file/application_execution.e
new file mode 100644
index 00000000..8186494e
--- /dev/null
+++ b/doc/workbook/handling_request/upload_file/application_execution.e
@@ -0,0 +1,58 @@
+note
+ description : "Basic Service that show how to Upload a file"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class
+ APPLICATION_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Basic operations
+
+ execute
+ -- Execute the incomming request
+ local
+ file: WSF_FILE_RESPONSE
+ l_answer: STRING
+ do
+ if request.is_get_request_method then
+ if request.path_info.same_string ("/") then
+ create file.make_html ("upload.html")
+ response.send (file)
+ else
+ -- Here we should handle unexpected errors.
+ end
+ elseif request.is_post_request_method then
+ if request.path_info.same_string ("/upload") then
+ -- Check if we have an uploaded file
+ if request.has_uploaded_file then
+ -- iterate over all the uploaded files
+ create l_answer.make_from_string ("
Uploaded File/s
")
+ across request.uploaded_files as ic loop
+ l_answer.append ("FileName:")
+ l_answer.append (ic.item.filename)
+ l_answer.append (" Size:")
+ l_answer.append (ic.item.size.out)
+ l_answer.append (" ")
+ end
+ response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>)
+ response.put_string (l_answer)
+ else
+ -- Here we should handle unexpected errors.
+ create l_answer.make_from_string ("No uploaded files ")
+ l_answer.append ("Back to Home")
+ response.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>)
+ response.put_string (l_answer)
+ end
+ else
+ -- Handle error
+ end
+ end
+ end
+
+end
diff --git a/doc/workbook/workbook.md b/doc/workbook/workbook.md
index 37b7789b..aa68c191 100644
--- a/doc/workbook/workbook.md
+++ b/doc/workbook/workbook.md
@@ -19,20 +19,20 @@ Before reading (or walking throught) the workbook, to get a quick overview of EW
## Introduction
-[Basic Concepts] (/workbook/basics/basics.md).
+[Basic Concepts] (/doc/workbook/basics/basics.md).
## Handling Requests: Form/Query Parameter
-[Handling Requests: Form/Query Parameter] (/workbook/handling_request/form.md).
+[Handling Requests: Form/Query Parameter] (/doc/workbook/handling_request/form.md).
## Handling Requests: Header Fields
-[Handling Requests: Header Fields](/workbook/handling_request/headers.md).
+[Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md).
## Generating Response
-[Generating Responses](/workbook/generating_response/generating_response.md)
+[Generating Responses](/doc/workbook/generating_response/generating_response.md)
## Handling Cookies
-[Handling Cookies](/workbook/handling_cookies/handling_cookies.md)
+[Handling Cookies](/doc/workbook/handling_cookies/handling_cookies.md)
diff --git a/draft/library/server/wsf_js_widget/examples/demo/application_execution.e b/draft/library/server/wsf_js_widget/examples/demo/application_execution.e
index 564f5c85..f52ea971 100644
--- a/draft/library/server/wsf_js_widget/examples/demo/application_execution.e
+++ b/draft/library/server/wsf_js_widget/examples/demo/application_execution.e
@@ -38,14 +38,14 @@ feature -- Router and Filter
-- NOTE: you could put all those files in a specific folder, and use WSF_FILE_SYSTEM_HANDLER with "/"
-- this way, it handles the caching and so on
- router.handle_with_request_methods ("/assets", create {WSF_FILE_SYSTEM_HANDLER}.make_hidden ("assets"), router.methods_GET)
+ router.handle ("/assets", create {WSF_FILE_SYSTEM_HANDLER}.make_hidden ("assets"), router.methods_GET)
end
feature -- Helper: mapping
map_agent_uri (a_uri: READABLE_STRING_8; a_action: like {WSF_URI_AGENT_HANDLER}.action; rqst_methods: detachable WSF_REQUEST_METHODS)
do
- router.map_with_request_methods (create {WSF_URI_MAPPING}.make (a_uri, create {WSF_URI_AGENT_HANDLER}.make (a_action)), rqst_methods)
+ router.map (create {WSF_URI_MAPPING}.make (a_uri, create {WSF_URI_AGENT_HANDLER}.make (a_action)), rqst_methods)
end
feature -- Execution
diff --git a/examples/debug/debug.ecf b/examples/debug/debug.ecf
index 5c6d642c..948e3e8e 100644
--- a/examples/debug/debug.ecf
+++ b/examples/debug/debug.ecf
@@ -18,7 +18,7 @@
-
+
@@ -28,7 +28,7 @@
-
+
diff --git a/examples/desktop_app/desktop_app.ecf b/examples/desktop_app/desktop_app.ecf
index 81a0aa50..6ba18b3f 100644
--- a/examples/desktop_app/desktop_app.ecf
+++ b/examples/desktop_app/desktop_app.ecf
@@ -7,7 +7,7 @@
-
+
diff --git a/examples/desktop_app/src/app_embedded_web_execution.e b/examples/desktop_app/src/app_embedded_web_execution.e
index 815e35a6..50f0a87a 100644
--- a/examples/desktop_app/src/app_embedded_web_execution.e
+++ b/examples/desktop_app/src/app_embedded_web_execution.e
@@ -45,11 +45,11 @@ feature -- Execution
req := request
create router.make (3)
- router.handle ("/test/{var}", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent handle_test))
- router.handle ("/env", create {WSF_URI_AGENT_HANDLER}.make (agent handle_env))
- router.handle ("/exit", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent handle_exit))
+ router.handle ("/test/{var}", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent handle_test), Void)
+ router.handle ("/env", create {WSF_URI_AGENT_HANDLER}.make (agent handle_env), Void)
+ router.handle ("/exit", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent handle_exit), Void)
create fs.make_with_path ((create {EXECUTION_ENVIRONMENT}).current_working_path.extended ("files"))
- router.handle ("/files", fs)
+ router.handle ("/files", fs, Void)
create sess
router.dispatch (req, response, sess)
if not sess.dispatched then
diff --git a/examples/filter/filter-safe.ecf b/examples/filter/filter-safe.ecf
index 6d85dcd0..cf802a06 100644
--- a/examples/filter/filter-safe.ecf
+++ b/examples/filter/filter-safe.ecf
@@ -27,7 +27,7 @@
-
+
diff --git a/examples/filter/src/filter_server_execution.e b/examples/filter/src/filter_server_execution.e
index 21727ede..4081d291 100644
--- a/examples/filter/src/filter_server_execution.e
+++ b/examples/filter/src/filter_server_execution.e
@@ -59,7 +59,7 @@ feature {NONE} -- Initialization
create l_methods
l_methods.enable_options
l_methods.enable_get
- router.handle_with_request_methods ("/user/{userid}", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent l_options_filter.execute), l_methods)
+ router.handle ("/user/{userid}", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent l_options_filter.execute), l_methods)
end
initialize_json
diff --git a/examples/obsolete/v0/filter/filter-safe.ecf b/examples/obsolete/v0/filter/filter-safe.ecf
new file mode 100644
index 00000000..8c6d4e4f
--- /dev/null
+++ b/examples/obsolete/v0/filter/filter-safe.ecf
@@ -0,0 +1,35 @@
+
+
+
+
+ /EIFGENs$
+ /\.git$
+ /\.svn$
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/examples/obsolete/v0/filter/filter.rc b/examples/obsolete/v0/filter/filter.rc
new file mode 100644
index 00000000..b0ec159c
--- /dev/null
+++ b/examples/obsolete/v0/filter/filter.rc
@@ -0,0 +1,6 @@
+#include
+
+STRINGTABLE
+BEGIN
+ 1 "This Program was made using EiffelStudio using Visual Studio C++"
+END
diff --git a/examples/obsolete/v0/filter/license.lic b/examples/obsolete/v0/filter/license.lic
new file mode 100644
index 00000000..73a78070
--- /dev/null
+++ b/examples/obsolete/v0/filter/license.lic
@@ -0,0 +1,4 @@
+${NOTE_KEYWORD}
+ copyright: "2011-${YEAR}, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+
diff --git a/examples/obsolete/v0/filter/readme.md b/examples/obsolete/v0/filter/readme.md
new file mode 100644
index 00000000..b1a43c03
--- /dev/null
+++ b/examples/obsolete/v0/filter/readme.md
@@ -0,0 +1,4 @@
+Filter example
+
+To test the example, you can just run in a terminal:
+> curl -u foo:bar http://localhost:9090/user/1 -v
diff --git a/examples/obsolete/v0/filter/src/database/database_api.e b/examples/obsolete/v0/filter/src/database/database_api.e
new file mode 100644
index 00000000..4c0024c0
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/database/database_api.e
@@ -0,0 +1,57 @@
+note
+ description: "Summary description for {DATABASE_API}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ DATABASE_API
+create
+ make
+
+feature -- Initialization
+
+ make
+ local
+ l_user: USER
+ do
+ create users.make (10)
+ create l_user.make (1, "foo", "bar")
+ users.put (l_user, l_user.id)
+ create l_user.make (2, "demo", "demo")
+ users.put (l_user, l_user.id)
+ end
+
+feature -- Access
+
+ user (a_id: INTEGER; a_name: detachable READABLE_STRING_GENERAL): detachable USER
+ -- User with id `a_id' or name `a_name'.
+ require
+ a_id > 0 xor a_name /= Void
+ local
+ n: like {USER}.name
+ do
+ if a_id > 0 then
+ Result := users.item (a_id)
+ elseif a_name /= Void then
+ n := a_name.as_string_8
+ across
+ users as c
+ until
+ Result /= Void
+ loop
+ if attached c.item as u and then u.name.same_string (n) then
+ Result := u
+ end
+ end
+ end
+ ensure
+ Result /= Void implies ((a_id > 0 and then Result.id = a_id) xor (a_name /= Void and then Result.name.same_string_general (a_name)))
+ end
+
+ users: HASH_TABLE [USER, INTEGER]
+
+;note
+ copyright: "2011-2012, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/database/shared_database_api.e b/examples/obsolete/v0/filter/src/database/shared_database_api.e
new file mode 100644
index 00000000..10ad5dff
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/database/shared_database_api.e
@@ -0,0 +1,20 @@
+note
+ description: "Summary description for {SHARED_DATABASE_API}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ SHARED_DATABASE_API
+
+feature -- Access
+
+ db_access: DATABASE_API
+ once
+ create Result.make
+ end
+
+note
+ copyright: "2011-2012, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/domain/json_user_converter.e b/examples/obsolete/v0/filter/src/domain/json_user_converter.e
new file mode 100644
index 00000000..34800625
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/domain/json_user_converter.e
@@ -0,0 +1,52 @@
+note
+ description: "JSON user converter."
+ author: "Olivier Ligot"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ JSON_USER_CONVERTER
+
+inherit
+ JSON_CONVERTER
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ make
+ do
+ create object.make (0, "", "")
+ end
+
+feature -- Access
+
+ object: USER
+
+ value: detachable JSON_OBJECT
+
+feature -- Conversion
+
+ from_json (j: attached like value): detachable like object
+ -- Convert from JSON value.
+ do
+ end
+
+ to_json (o: like object): like value
+ -- Convert to JSON value.
+ do
+ create Result.make
+ Result.put (json.value (o.id), id_key)
+ Result.put (json.value (o.name), name_key)
+ end
+
+ feature {NONE} -- Implementation
+
+ id_key: STRING = "id"
+ name_key: STRING = "name"
+
+note
+ copyright: "2011-2012, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/domain/user.e b/examples/obsolete/v0/filter/src/domain/user.e
new file mode 100644
index 00000000..0ad70f2c
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/domain/user.e
@@ -0,0 +1,59 @@
+note
+ description: "User."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ USER
+
+inherit
+ ANY
+ redefine
+ is_equal
+ end
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ make (an_id: INTEGER; a_name, a_password: STRING)
+ do
+ id := an_id
+ name := a_name
+ password := a_password
+ ensure
+ id_set: id = an_id
+ name_set: name = a_name
+ password_set: password = a_password
+ end
+
+feature -- Access
+
+ id: INTEGER
+ -- Identifier
+
+ name: STRING
+ -- Name
+
+ password: STRING
+ -- Password
+
+feature -- Comparison
+
+ is_equal (other: like Current): BOOLEAN
+ -- Is `other' attached to an object considered
+ -- equal to current object?
+ do
+ if Current = other then
+ Result := True
+ else
+ Result := (id = other.id) and (name = other.name) and (password = other.password)
+ end
+ end
+
+;note
+ copyright: "2011-2012, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/filter/authentication_filter.e b/examples/obsolete/v0/filter/src/filter/authentication_filter.e
new file mode 100644
index 00000000..c3bf8ae3
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/filter/authentication_filter.e
@@ -0,0 +1,65 @@
+note
+ description: "Authentication filter."
+ author: "Olivier Ligot"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ AUTHENTICATION_FILTER
+
+inherit
+ WSF_FILTER
+
+ WSF_URI_TEMPLATE_HANDLER
+
+ SHARED_DATABASE_API
+
+ SHARED_EJSON
+
+feature -- Basic operations
+
+ execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Execute the filter
+ local
+ l_auth: detachable HTTP_AUTHORIZATION
+ do
+ if attached req.http_authorization as l_http_authorization then
+ create l_auth.make (l_http_authorization)
+ end
+ if
+ l_auth /= Void and then
+ l_auth.is_basic and then
+ attached l_auth.login as l_auth_login and then
+ attached Db_access.user (0, l_auth_login) as l_user and then
+ l_auth_login.same_string (l_user.name) and then
+ attached l_auth.password as l_auth_password and then
+ l_auth_password.same_string (l_user.password)
+ then
+ req.set_execution_variable ("user", l_user)
+ execute_next (req, res)
+ else
+ handle_unauthorized ("Unauthorized", req, res)
+ end
+ end
+
+feature {NONE} -- Implementation
+
+ handle_unauthorized (a_description: STRING; req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Handle forbidden.
+ local
+ h: HTTP_HEADER
+ do
+ create h.make
+ h.put_content_type_text_plain
+ h.put_content_length (a_description.count)
+ h.put_current_date
+ h.put_header_key_value ({HTTP_HEADER_NAMES}.header_www_authenticate, "Basic realm=%"User%"")
+ res.set_status_code ({HTTP_STATUS_CODE}.unauthorized)
+ res.put_header_text (h.string)
+ res.put_string (a_description)
+ end
+
+note
+ copyright: "2011-2014, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/filter/filter_handler_context.e b/examples/obsolete/v0/filter/src/filter/filter_handler_context.e
new file mode 100644
index 00000000..a4f5a448
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/filter/filter_handler_context.e
@@ -0,0 +1,34 @@
+note
+ description: "Summary description for {FILTER_HANDLER_CONTEXT}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ FILTER_HANDLER_CONTEXT
+
+inherit
+ WSF_HANDLER_CONTEXT
+
+create
+ make
+
+feature -- Access
+
+ user: detachable USER
+ -- Authenticated user
+
+feature -- Element change
+
+ set_user (a_user: USER)
+ -- Set `user' to `a_user'
+ do
+ user := a_user
+ ensure
+ user_set: user = a_user
+ end
+
+note
+ copyright: "2011-2012, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/filter/src/filter_server.e b/examples/obsolete/v0/filter/src/filter_server.e
new file mode 100644
index 00000000..dfc9f8fe
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/filter_server.e
@@ -0,0 +1,111 @@
+note
+ description : "Filter example."
+ author : "Olivier Ligot"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class
+ FILTER_SERVER
+
+inherit
+ ANY
+
+ WSF_DEFAULT_SERVICE
+
+ WSF_ROUTED_SERVICE
+ undefine
+ execute
+ end
+
+ WSF_FILTERED_SERVICE
+
+ SHARED_EJSON
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ make
+ local
+ l_message: STRING
+ l_factory: INET_ADDRESS_FACTORY
+ do
+ initialize_router
+ initialize_filter
+ initialize_json
+ set_service_option ("port", port)
+ create l_message.make_empty
+ l_message.append_string ("Launching filter server at ")
+ create l_factory
+ l_message.append_string (l_factory.create_localhost.host_name)
+ l_message.append_string (" port ")
+ l_message.append_integer (port)
+ io.put_string (l_message)
+ io.put_new_line
+ make_and_launch
+ end
+
+ create_filter
+ -- Create `filter'
+ do
+ create {WSF_CORS_FILTER} filter
+ end
+
+ setup_filter
+ -- Setup `filter'
+ local
+ l_routing_filter: WSF_ROUTING_FILTER
+ l_logging_filter: WSF_LOGGING_FILTER
+ do
+ create l_routing_filter.make (router)
+ l_routing_filter.set_execute_default_action (agent execute_default)
+ filter.set_next (l_routing_filter)
+
+ create l_logging_filter
+ l_routing_filter.set_next (l_logging_filter)
+ end
+
+ setup_router
+ -- Setup `router'
+ local
+ l_options_filter: WSF_CORS_OPTIONS_FILTER
+ l_authentication_filter: AUTHENTICATION_FILTER
+ l_user_filter: USER_HANDLER
+ l_methods: WSF_REQUEST_METHODS
+ do
+ create l_options_filter.make (router)
+ create l_authentication_filter
+ create l_user_filter
+
+ l_options_filter.set_next (l_authentication_filter)
+ l_authentication_filter.set_next (l_user_filter)
+
+ create l_methods
+ l_methods.enable_options
+ l_methods.enable_get
+ router.handle_with_request_methods ("/user/{userid}", create {WSF_URI_TEMPLATE_AGENT_HANDLER}.make (agent l_options_filter.execute), l_methods)
+ end
+
+ initialize_json
+ -- Initialize `json'.
+ do
+ json.add_converter (create {JSON_USER_CONVERTER}.make)
+ end
+
+feature {NONE} -- Implementation
+
+ port: INTEGER = 9090
+ -- Port number
+
+note
+ copyright: "2011-2014, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+ source: "[
+ Eiffel Software
+ 5949 Hollister Ave., Goleta, CA 93117 USA
+ Telephone 805-685-1006, Fax 805-685-6869
+ Website http://www.eiffel.com
+ Customer support http://support.eiffel.com
+ ]"
+end
diff --git a/examples/obsolete/v0/filter/src/resource/user_handler.e b/examples/obsolete/v0/filter/src/resource/user_handler.e
new file mode 100644
index 00000000..722ccd03
--- /dev/null
+++ b/examples/obsolete/v0/filter/src/resource/user_handler.e
@@ -0,0 +1,97 @@
+note
+ description: "User handler."
+ author: "Olivier Ligot"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ USER_HANDLER
+
+inherit
+ WSF_FILTER
+
+ WSF_URI_TEMPLATE_HANDLER
+
+ WSF_RESOURCE_HANDLER_HELPER
+ redefine
+ do_get
+ end
+
+ SHARED_DATABASE_API
+
+ SHARED_EJSON
+
+feature -- Basic operations
+
+ execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Execute request handler
+ do
+ execute_methods (req, res)
+ execute_next (req, res)
+ end
+
+ do_get (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Using GET to retrieve resource information.
+ -- If the GET request is SUCCESS, we response with
+ -- 200 OK, and a representation of the user
+ -- If the GET request is not SUCCESS, we response with
+ -- 404 Resource not found
+ require else
+ authenticated_user_attached: attached {USER} req.execution_variable ("user")
+ local
+ id : STRING
+ do
+ if attached req.orig_path_info as orig_path then
+ id := get_user_id_from_path (orig_path)
+ if attached retrieve_user (id) as l_user then
+ if l_user ~ req.execution_variable ("user") then
+ compute_response_get (req, res, l_user)
+ elseif attached {USER} req.execution_variable ("user") as l_auth_user then
+ -- Trying to access another user that the authenticated one,
+ -- which is forbidden in this example...
+ handle_forbidden ("You try to access the user " + id.out + " while authenticating with the user " + l_auth_user.id.out, req, res)
+ end
+ else
+ handle_resource_not_found_response ("The following resource " + orig_path + " is not found ", req, res)
+ end
+ end
+ end
+
+feature {NONE} -- Implementation
+
+ compute_response_get (req: WSF_REQUEST; res: WSF_RESPONSE; l_user : USER)
+ local
+ h: HTTP_HEADER
+ l_msg : STRING
+ do
+ create h.make
+ h.put_content_type_application_json
+ if attached {JSON_VALUE} json.value (l_user) as jv then
+ l_msg := jv.representation
+ h.put_content_length (l_msg.count)
+ if attached req.request_time as time then
+ h.put_utc_date (time)
+ end
+ res.set_status_code ({HTTP_STATUS_CODE}.ok)
+ res.put_header_text (h.string)
+ res.put_string (l_msg)
+ end
+ end
+
+ get_user_id_from_path (a_path: READABLE_STRING_32): STRING
+ do
+ Result := a_path.split ('/').at (3)
+ end
+
+ retrieve_user (id: STRING) : detachable USER
+ -- Retrieve the user by id if it exist, in other case, Void
+ do
+ if id.is_integer and then Db_access.users.has (id.to_integer) then
+ Result := db_access.users.item (id.to_integer)
+ end
+ end
+
+note
+ copyright: "2011-2013, Olivier Ligot, Jocelyn Fiat and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/README-compilation.txt b/examples/obsolete/v0/restbucksCRUD/README-compilation.txt
new file mode 100644
index 00000000..6e3dfa50
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/README-compilation.txt
@@ -0,0 +1,3 @@
+The current example has a main target for the server: "restbucks"
+But we also provide "policy_driven_restbucks" target which is using the
+policy-driven framework than help coder fulfill HTTP expectations.
diff --git a/examples/obsolete/v0/restbucksCRUD/client/README.txt b/examples/obsolete/v0/restbucksCRUD/client/README.txt
new file mode 100644
index 00000000..033eaaf4
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/client/README.txt
@@ -0,0 +1,11 @@
+Make sure to have the Clib generated in the related cURL library
+
+- if you use EiffelStudio >= 7.0
+ check %ISE_LIBRARY%\library\cURL\spec\%ISE_C_COMPILER%\$ISE_PLATFORM
+ or $ISE_LIBRARY/library/cURL/spec/$ISE_PLATFORM
+
+- otherwise if you use earlier version
+ check under ext/ise_library/curl/spec/...
+
+And on Windows, be sure to get the libcurl.dll from %ISE_LIBRARY%\studio\spec\%ISE_PLATFORM%\bin\libcurl.dll
+
diff --git a/examples/obsolete/v0/restbucksCRUD/client/client-safe.ecf b/examples/obsolete/v0/restbucksCRUD/client/client-safe.ecf
new file mode 100644
index 00000000..d987ddaa
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/client/client-safe.ecf
@@ -0,0 +1,19 @@
+
+
+
+
+
+ /.git$
+ /EIFGENs$
+ /.svn$
+
+
+
+
+
+
+
+
+
+
diff --git a/examples/obsolete/v0/restbucksCRUD/client/client.ecf b/examples/obsolete/v0/restbucksCRUD/client/client.ecf
new file mode 100644
index 00000000..086d5727
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/client/client.ecf
@@ -0,0 +1,19 @@
+
+
+
+
+
+ /.git$
+ /EIFGENs$
+ /.svn$
+
+
+
+
+
+
+
+
+
+
diff --git a/examples/obsolete/v0/restbucksCRUD/client/client.rc b/examples/obsolete/v0/restbucksCRUD/client/client.rc
new file mode 100644
index 00000000..b0ec159c
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/client/client.rc
@@ -0,0 +1,6 @@
+#include
+
+STRINGTABLE
+BEGIN
+ 1 "This Program was made using EiffelStudio using Visual Studio C++"
+END
diff --git a/examples/obsolete/v0/restbucksCRUD/client/src/restbuck_client.e b/examples/obsolete/v0/restbucksCRUD/client/src/restbuck_client.e
new file mode 100644
index 00000000..56a82390
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/client/src/restbuck_client.e
@@ -0,0 +1,154 @@
+note
+ description : "Objects that ..."
+ author : "$Author$"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class
+ RESTBUCK_CLIENT
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ make
+ -- Initialize `Current'.
+ local
+ h: LIBCURL_HTTP_CLIENT
+ sess: HTTP_CLIENT_SESSION
+ resp : detachable HTTP_CLIENT_RESPONSE
+ l_location : detachable READABLE_STRING_8
+ body : STRING
+ do
+ create h.make
+ sess := h.new_session ("http://127.0.0.1:9090")
+-- Uncomment the following 2 lines, if you use fiddler2 web debugging tool
+-- sess.set_is_debug (True)
+-- sess.set_proxy ("127.0.0.1", 8888)
+
+ -- Create Order
+ print ("%N Create Order %N")
+ resp := create_order (sess)
+
+
+ -- Read the Order
+ print ("%N Read Order %N")
+ l_location := resp.header ("Location")
+ resp := read_order (sess, l_location)
+
+
+ -- Update the Order
+ if resp /= Void and then attached resp.body as l_body then
+ body := l_body.as_string_8
+ body.replace_substring_all ("takeAway", "in Shop")
+ print ("%N Update Order %N")
+ resp := update_order (sess, l_location, body)
+ end
+ end
+
+ update_order ( sess: HTTP_CLIENT_SESSION; uri : detachable READABLE_STRING_8; a_body : STRING): detachable HTTP_CLIENT_RESPONSE
+ local
+ context : HTTP_CLIENT_REQUEST_CONTEXT
+ do
+ if attached uri as l_uri then
+ sess.set_base_url (l_uri)
+ create context.make
+ context.headers.put ("application/json", "Content-Type")
+ Result := sess.put ("", context, a_body )
+ -- Show headers
+ across
+ Result.headers as l_headers
+ loop
+ print (l_headers.item.name)
+ print (":")
+ print (l_headers.item.value)
+ io.put_new_line
+ end
+
+ -- Show body
+ print (Result.body)
+ io.put_new_line
+ end
+ end
+
+
+ read_order ( sess: HTTP_CLIENT_SESSION; uri : detachable READABLE_STRING_8): detachable HTTP_CLIENT_RESPONSE
+ do
+ if attached uri as l_uri then
+ sess.set_base_url (l_uri)
+ Result := sess.get ("", Void)
+ -- Show headers
+ across
+ Result.headers as l_headers
+ loop
+ print (l_headers.item.name)
+ print (":")
+ print (l_headers.item.value)
+ io.put_new_line
+ end
+
+ -- Show body
+ print (Result.body)
+ io.put_new_line
+ end
+ end
+
+
+
+ create_order (sess: HTTP_CLIENT_SESSION) : HTTP_CLIENT_RESPONSE
+ local
+ s: READABLE_STRING_8
+ j: JSON_PARSER
+ id: detachable STRING
+ context : HTTP_CLIENT_REQUEST_CONTEXT
+ do
+ s := "[
+ {
+ "location":"takeAway",
+ "items":[
+ {
+ "name":"Late",
+ "option":"skim",
+ "size":"Small",
+ "quantity":1
+ }
+ ]
+ }
+ ]"
+
+ create context.make
+ context.headers.put ("application/json", "Content-Type")
+ Result := sess.post ("/order", context, s)
+ -- Show the Headers
+ across
+ Result.headers as l_headers
+ loop
+ print (l_headers.item.name)
+ print (":")
+ print (l_headers.item.value)
+ io.put_new_line
+ end
+
+
+ -- Show the Response body
+ if attached Result.body as m then
+ create j.make_with_string (m)
+ j.parse_content
+ if j.is_valid and then attached j.parsed_json_object as j_o then
+ if attached {JSON_STRING} j_o.item ("id") as l_id then
+ id := l_id.item
+ end
+ print (m)
+ io.put_new_line
+ end
+ end
+ end
+
+
+feature {NONE} -- Implementation
+
+invariant
+-- invariant_clause: True
+
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/license.lic b/examples/obsolete/v0/restbucksCRUD/license.lic
new file mode 100644
index 00000000..6928e20b
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/license.lic
@@ -0,0 +1,4 @@
+${NOTE_KEYWORD}
+ copyright: "2011-${YEAR}, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+
diff --git a/examples/obsolete/v0/restbucksCRUD/readme.md b/examples/obsolete/v0/restbucksCRUD/readme.md
new file mode 100644
index 00000000..6b85f132
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/readme.md
@@ -0,0 +1,297 @@
+Restbuck Eiffel Implementation based on the book of REST in Practice
+====================================================================
+This is an implementation of CRUD pattern for manipulate resources, this is the first step to use
+the HTTP protocol as an application protocol instead of a transport protocol.
+
+Restbuck Protocol
+-----------------
+
+
+
Verb
URI or template
Use
+
POST
/order
Create a new order, and upon success, receive a Locationheader specifying the new order's URI.
+
GET
/order/{orderId}
Request the current state of the order specified by the URI.
+
PUT
/order/{orderId}
Update an order at the given URI with new information, providing the full representation.
+
DELETE
/order/{orderId}
Logically remove the order identified by the given URI.
+
+
+Resource Represenation
+----------------------
+The previous tables shows a contrat, the URI or URI template, allows us to indentify resources, now we will chose a
+representacion, for this particular case we will use JSON.
+
+Note:
+1. *A resource can have multiple URIs*.
+2. *A resource can have multiple Representations*.
+
+RESTBUCKS_SERVER
+----------------
+This class implement the main entry of our REST CRUD service, we are using a default connector (Nino Connector,
+using a WebServer written in Eiffel).
+We are inheriting from URI_TEMPLATE_ROUTED_SERVICE, this allows us to map our service contrat, as is shown in the previous
+table, the mapping is defined in the feature setup_router, this also show that the class ORDER_HANDLER will be encharge
+of to handle different type of request to the ORDER resource.
+
+
+ class
+ RESTBUCKS_SERVER
+
+ inherit
+ ANY
+
+ URI_TEMPLATE_ROUTED_SERVICE
+
+ DEFAULT_SERVICE
+ -- Here we are using a default connector using the default Nino Connector,
+ -- but it's possible to use other connector (CGI or FCGI).
+
+ create
+ make
+
+ feature {NONE} -- Initialization
+
+ make
+ -- Initialize the router (this will have the request handler and
+ -- their context).
+ do
+ initialize_router
+ make_and_launch
+ end
+
+ create_router
+ do
+ create router.make (2)
+ end
+
+ setup_router
+ local
+ order_handler: ORDER_HANDLER [REQUEST_URI_TEMPLATE_HANDLER_CONTEXT]
+ do
+ create order_handler
+ router.map_with_request_methods ("/order", order_handler, <<"POST">>)
+ router.map_with_request_methods ("/order/{orderid}", order_handler, <<"GET", "DELETE", "PUT">>)
+ end
+
+ feature -- Execution
+
+ execute_default (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- I'm using this method to handle the method not allowed response
+ -- in the case that the given uri does not have a corresponding http method
+ -- to handle it.
+ local
+ h : HTTP_HEADER
+ l_description : STRING
+ l_api_doc : STRING
+ do
+ if req.content_length_value > 0 then
+ req.input.read_string (req.content_length_value.as_integer_32)
+ end
+ create h.make
+ h.put_status ({HTTP_STATUS_CODE}.method_not_allowed)
+ h.put_content_type_text_plain
+ l_api_doc := "%NPlease check the API%NURI:/order METHOD: POST%NURI:/order/{orderid} METHOD: GET, PUT, DELETE%N"
+ l_description := req.request_method + req.request_uri + " is not allowed" + "%N" + l_api_doc
+ h.put_content_length (l_description.count)
+ h.put_current_date
+ res.set_status_code ({HTTP_STATUS_CODE}.method_not_allowed)
+ res.write_header_text (h.string)
+ res.write_string (l_description)
+ end
+
+ end
+
+
+
+How to Create an order with POST
+--------------------------------
+
+Here is the convention that we are using:
+POST is used for creation and the server determines the URI of the created resource.
+If the request POST is SUCCESS, the server will create the order and will response with
+201 CREATED, the Location header will contains the newly created order's URI,
+if the request POST is not SUCCESS, the server will response with
+400 BAD REQUEST, the client send a bad request or
+500 INTERNAL_SERVER_ERROR, when the server can deliver the request.
+
+ POST /order HTTP/1.1
+ Host: 127.0.0.1:8080
+ Connection: keep-alive
+ Content-Length: 196
+ Origin: chrome-extension://fhjcajmcbmldlhcimfajhfbgofnpcjmb
+ Content-Type: application/json
+ Accept: */*
+ Accept-Encoding: gzip,deflate,sdch
+ Accept-Language: es-419,es;q=0.8,en;q=0.6
+ Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3
+
+ {
+ "location":"takeAway",
+ "items":[
+ {
+ "name":"Late",
+ "option":"skim",
+ "size":"Small",
+ "quantity":1
+ }
+ ]
+ }
+
+Response success
+
+ HTTP/1.1 201 Created
+ Status 201 Created
+ Content-Type application/json
+ Content-Length 123
+ Location http://localhost:8080/order/1
+ Date FRI,09 DEC 2011 20:34:20.00 GMT
+
+ {
+ "location" : "takeAway",
+ "status" : "submitted",
+ "items" : [ {
+ "name" : "late",
+ "size" : "small",
+ "quantity" : 1,
+ "option" : "skim"
+ } ]
+ }
+
+note:
+ curl -vv http://localhost:9090/order -H "Content-Type: application/json" -d "{\"location\":\"takeAway\",\"items\":[{\"name\":\"Late\",\"option\":\"skim\",\"size\":\"Small\",\"quantity\":1}]}" -X POST
+
+
+How to Read an order with GET
+-----------------------------
+Using GET to retrieve resource information.
+If the GET request is SUCCESS, we response with 200 OK, and a representation of the order
+If the GET request is not SUCCESS, we response with 404 Resource not found
+If is a Conditional GET and the resource does not change we send a 304, Resource not modifed
+
+ GET /order/1 HTTP/1.1
+ Host: 127.0.0.1:8080
+ Connection: keep-alive
+ Accept: */*
+ Accept-Encoding: gzip,deflate,sdch
+ Accept-Language: es-419,es;q=0.8,en;q=0.6
+ Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.3
+ If-None-Match: 6542EF270D91D3EAF39CFB382E4CEBA7
+
+Response
+ HTTP/1.1 200 OK
+
+ Status 200 OK
+ Content-Type application/json
+ Content-Length 123
+ Date FRI,09 DEC 2011 20:53:46.00 GMT
+ etag 2ED3A40954A95D766FC155682DC8BB52
+
+ {
+ "location" : "takeAway",
+ "status" : "submitted",
+ "items" : [ {
+ "name" : "late",
+ "size" : "small",
+ "quantity" : 1,
+ "option" : "skim"
+ } ]
+ }
+
+note:
+ curl -vv http://localhost:9090/order/1
+
+How to Update an order with PUT
+-------------------------------
+A successful PUT request will not create a new resource, instead it will change the state of the resource identified by the current uri.
+If success we response with 200 and the updated order.
+404 if the order is not found
+400 in case of a bad request
+500 internal server error
+If the request is a Conditional PUT, and it does not mat we response 415, precondition failed.
+
+Suposse that we had created an Order with the values shown in the _How to create an order with POST_
+But we change our decision and we want to stay in the shop.
+
+
+
+ PUT /order/1 HTTP/1.1
+ Content-Length: 122
+ Content-Type: application/json; charset=UTF-8
+ Host: localhost:8080
+ Connection: Keep-Alive
+ Expect: 100-Continue
+
+ {
+ "location" : "in shop",
+ "status" : "submitted",
+ "items" : [ {
+ "name" : "late",
+ "size" : "small",
+ "quantity" : 1,
+ "option" : "skim"
+ } ]
+ }
+
+
+Response success
+
+ HTTP/1.1 200 OK
+ Status 200 OK
+ Content-Type application/json
+ Date FRI,09 DEC 2011 21:06:26.00 GMT
+ etag 8767F900674B843E1F3F70BCF3E62403
+ Content-Length 122
+
+ {
+ "location" : "in shop",
+ "status" : "submitted",
+ "items" : [ {
+ "name" : "late",
+ "size" : "small",
+ "quantity" : 1,
+ "option" : "skim"
+ } ]
+ }
+
+How to Delete an order with DELETE
+----------------------------------
+Here we use DELETE to cancel an order, if that order is in state where it can still be canceled.
+204 if is ok
+404 Resource not found
+405 if consumer and service's view of the resouce state is inconsisent
+500 if we have an internal server error
+
+
+ DELETE /order/1 HTTP/1.1
+ Host: localhost:8080
+ Connection: Keep-Alive
+
+Response success
+
+ HTTP/1.1 204 No Content
+
+ Status 204 No Content
+ Content-Type application/json
+ Date FRI,09 DEC 2011 21:10:51.00 GMT
+
+If we want to check that the resource does not exist anymore we can try to retrieve a GET /order/1 and we will receive a
+404 No Found
+
+ GET /order/1 HTTP/1.1
+ Host: localhost:8080
+ Connection: Keep-Alive
+
+Response
+
+ HTTP/1.1 404 Not Found
+
+ Status 404 Not Found
+ Content-Type application/json
+ Content-Length 44
+ Date FRI,09 DEC 2011 21:14:17.79 GMT
+
+ The following resource/order/1 is not found
+
+
+References
+----------
+1. [How to get a cup of coffe](http://www.infoq.com/articles/webber-rest-workflow)
+2. [Rest in Practice] (http://restinpractice.com/default.aspx)
diff --git a/doc/workbook/basics/reading_request_data.md b/examples/obsolete/v0/restbucksCRUD/readme.txt
similarity index 100%
rename from doc/workbook/basics/reading_request_data.md
rename to examples/obsolete/v0/restbucksCRUD/readme.txt
diff --git a/examples/obsolete/v0/restbucksCRUD/restbucks-safe.ecf b/examples/obsolete/v0/restbucksCRUD/restbucks-safe.ecf
new file mode 100644
index 00000000..ca3978b8
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/restbucks-safe.ecf
@@ -0,0 +1,55 @@
+
+
+
+
+ /EIFGENs$
+ /\.git$
+ /\.svn$
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ /policy_driven_resource$
+
+
+
+
+
+
+
+
+
+ /resource$
+
+
+
+
diff --git a/examples/obsolete/v0/restbucksCRUD/restbucks.rc b/examples/obsolete/v0/restbucksCRUD/restbucks.rc
new file mode 100644
index 00000000..b0ec159c
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/restbucks.rc
@@ -0,0 +1,6 @@
+#include
+
+STRINGTABLE
+BEGIN
+ 1 "This Program was made using EiffelStudio using Visual Studio C++"
+END
diff --git a/examples/obsolete/v0/restbucksCRUD/src/database/database_api.e b/examples/obsolete/v0/restbucksCRUD/src/database/database_api.e
new file mode 100644
index 00000000..efc0bf20
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/database/database_api.e
@@ -0,0 +1,26 @@
+note
+ description: "Summary description for {DATABASE_API}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ DATABASE_API
+create
+ make
+
+feature -- Initialization
+
+ make
+ do
+ create orders.make (10)
+ end
+
+feature -- Access
+
+ orders: HASH_TABLE [ORDER, STRING]
+
+;note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/database/shared_database_api.e b/examples/obsolete/v0/restbucksCRUD/src/database/shared_database_api.e
new file mode 100644
index 00000000..de4c9a22
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/database/shared_database_api.e
@@ -0,0 +1,19 @@
+note
+ description: "Summary description for {SHARED_DATABASE_API}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ SHARED_DATABASE_API
+
+feature -- Access
+
+ db_access: DATABASE_API
+ once
+ create Result.make
+ end
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/item.e b/examples/obsolete/v0/restbucksCRUD/src/domain/item.e
new file mode 100644
index 00000000..2e27cf5a
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/item.e
@@ -0,0 +1,90 @@
+note
+ description: "Summary description for {ITEM}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ ITEM
+inherit
+ ITEM_CONSTANTS
+create
+ make
+feature -- Initialization
+ make ( a_name : STRING_32 ; a_size:STRING_32; a_option: STRING_32; a_quantity:INTEGER_8)
+ do
+ set_name (a_name)
+ set_size (a_size)
+ set_option (a_option)
+ set_quantity (a_quantity)
+ end
+
+feature -- Access
+ name : STRING
+ -- product name type of Coffee(Late, Cappuccino, Expresso)
+
+ option : STRING
+ -- customization option Milk (skim, semi, whole)
+
+ size : STRING
+ -- small, mediumm large
+
+ quantity :INTEGER
+
+
+
+
+feature -- Element Change
+ set_name (a_name: STRING)
+ require
+ valid_name: is_valid_coffee_type (a_name)
+ do
+ name := a_name
+ ensure
+ name_assigned : name.same_string(a_name)
+ end
+
+ set_size (a_size: STRING)
+ require
+ valid_size : is_valid_size_option (a_size)
+ do
+ size := a_size
+ ensure
+ size_assigned : size.same_string(a_size)
+ end
+
+ set_option (an_option: STRING)
+ require
+ valid_option : is_valid_milk_type (an_option)
+ do
+ option := an_option
+ ensure
+ option_assigned : option.same_string (an_option)
+ end
+
+ set_quantity (a_quantity: INTEGER)
+ require
+ valid_quantity : a_quantity > 0
+ do
+ quantity := a_quantity
+ ensure
+ quantity_assigned : quantity = a_quantity
+ end
+
+feature -- Report
+ hash_code: INTEGER
+ --Hash code value
+ do
+ Result := option.hash_code + name.hash_code + size.hash_code + quantity.hash_code
+ end
+
+
+invariant
+ valid_size : is_valid_size_option (size)
+ valid_coffe : is_valid_coffee_type (name)
+ valid_customization : is_valid_milk_type (option)
+ valid_quantity : quantity > 0
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/item_constants.e b/examples/obsolete/v0/restbucksCRUD/src/domain/item_constants.e
new file mode 100644
index 00000000..ecea445d
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/item_constants.e
@@ -0,0 +1,54 @@
+note
+ description: "Summary description for {ITEM_CONSTANTS}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ ITEM_CONSTANTS
+feature -- Access
+ is_valid_coffee_type (a_type: STRING) : BOOLEAN
+ --is `a_type' a valid coffee type
+ do
+ a_type.to_lower
+ coffe_types.compare_objects
+ Result := coffe_types.has (a_type)
+ end
+
+ Coffe_types : ARRAY[STRING]
+ -- List of valid Coffee types
+ once
+ Result := <<"late","cappuccino", "expresso">>
+ end
+
+ is_valid_milk_type (a_type: STRING) : BOOLEAN
+ --is `a_type' a valid milk type
+ do
+ a_type.to_lower
+ milk_types.compare_objects
+ Result := milk_types.has (a_type)
+ end
+
+ Milk_types : ARRAY[STRING]
+ -- List of valid Milk types
+ once
+ Result := <<"skim","semi", "whole">>
+ end
+
+ is_valid_size_option (an_option: STRING) : BOOLEAN
+ --is `an_option' a valid size option
+ do
+ an_option.to_lower
+ size_options.compare_objects
+ Result := size_options.has (an_option)
+ end
+
+ Size_options : ARRAY[STRING]
+ -- List of valid Size_options
+ once
+ Result := <<"small","mediumn", "large">>
+ end
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/json_order_converter.e b/examples/obsolete/v0/restbucksCRUD/src/domain/json_order_converter.e
new file mode 100644
index 00000000..1d022062
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/json_order_converter.e
@@ -0,0 +1,176 @@
+note
+ description: "Summary description for {JSON_ORDER_CONVERTER}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ JSON_ORDER_CONVERTER
+inherit
+ JSON_CONVERTER
+create
+ make
+feature -- Initialization
+ make
+ do
+ create object.make ("","","")
+ end
+feature -- Access
+ object : ORDER
+
+
+ value : detachable JSON_OBJECT
+feature -- Conversion
+
+ from_json (j: attached like value): detachable like object
+ -- Convert from JSON value. Returns Void if unable to convert
+ local
+ s_id, s_location, s_status: detachable STRING_32
+ q: INTEGER_8
+ o: ORDER
+ i : ITEM
+ l_array : detachable ARRAYED_LIST [JSON_VALUE]
+ is_valid_from_json : BOOLEAN
+ do
+ is_valid_from_json := True
+
+ if attached {STRING_32} json.object (j.item (id_key), Void) as l_id then
+ s_id := s_id
+ end
+ if attached {STRING_32} json.object (j.item (location_key), Void) as l_location then
+ s_location := l_location
+ end
+ if attached {STRING_32} json.object (j.item (status_key), Void) as l_status then
+ s_status := l_status
+ end
+
+ create o.make ("", s_location, s_status)
+
+ if attached {JSON_ARRAY} j.item (items_key) as l_val then
+ l_array := l_val.array_representation
+ from
+ l_array.start
+ until
+ l_array.after
+ loop
+ if attached {JSON_OBJECT} l_array.item_for_iteration as jv then
+ if attached {INTEGER_8} json.object (jv.item (quantity_key), Void) as l_integer then
+ q := l_integer
+ else
+ q := 0
+ end
+ if
+ attached {STRING_32} json.object (jv.item (name_key), Void) as s_name and then
+ attached {STRING_32} json.object (jv.item (size_key), Void) as s_key and then
+ attached {STRING_32} json.object (jv.item (option_key), Void) as s_option
+ then
+ if is_valid_item_customization (s_name, s_key, s_option,q) then
+ create i.make (s_name, s_key, s_option, q)
+ o.add_item (i)
+ else
+ is_valid_from_json := False
+ end
+ else
+ is_valid_from_json := False
+ end
+ end
+
+ l_array.forth
+ end
+ end
+ if not is_valid_from_json or o.items.is_empty then
+ Result := Void
+ else
+ Result := o
+ end
+ end
+
+ to_json (o: like object): like value
+ -- Convert to JSON value
+ local
+ ja : JSON_ARRAY
+ i : ITEM
+ jv: JSON_OBJECT
+ do
+ create Result.make
+-- Result.put (json.value (o.id), id_key)
+ Result.put (json.value (o.location), location_key)
+ Result.put (json.value (o.status), status_key)
+ from
+ create ja.make_empty
+ o.items.start
+ until
+ o.items.after
+ loop
+ i := o.items.item_for_iteration
+ create jv.make
+ jv.put (json.value (i.name), name_key)
+ jv.put (json.value (i.size),size_key)
+ jv.put (json.value (i.quantity), quantity_key)
+ jv.put (json.value (i.option), option_key)
+ ja.add (jv)
+ o.items.forth
+ end
+ Result.put (ja, items_key)
+ end
+
+ feature {NONE} -- Implementation
+ id_key: JSON_STRING
+ once
+ create Result.make_from_string ("id")
+ end
+
+ location_key: JSON_STRING
+ once
+ create Result.make_from_string ("location")
+ end
+
+ status_key: JSON_STRING
+ once
+ create Result.make_from_string ("status")
+ end
+
+ items_key : JSON_STRING
+ once
+ create Result.make_from_string ("items")
+ end
+
+
+ name_key : JSON_STRING
+
+ once
+ create Result.make_from_string ("name")
+ end
+
+ size_key : JSON_STRING
+
+ once
+ create Result.make_from_string ("size")
+ end
+
+ quantity_key : JSON_STRING
+
+ once
+ create Result.make_from_string ("quantity")
+ end
+
+
+ option_key : JSON_STRING
+
+ once
+ create Result.make_from_string ("option")
+ end
+feature -- Validation
+
+ is_valid_item_customization ( name : STRING_32; size: STRING_32; option : STRING_32; quantity : INTEGER_8 ) : BOOLEAN
+ local
+ ic : ITEM_CONSTANTS
+ do
+ create ic
+ Result := ic.is_valid_coffee_type (name) and ic.is_valid_milk_type (option) and ic.is_valid_size_option (size) and quantity > 0
+ end
+
+note
+ copyright: "2011-2015, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/order.e b/examples/obsolete/v0/restbucksCRUD/src/domain/order.e
new file mode 100644
index 00000000..721d2256
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/order.e
@@ -0,0 +1,114 @@
+note
+ description: "Summary description for {ORDER}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ ORDER
+create
+ make
+feature -- Initialization
+
+ make ( an_id : detachable STRING_32; a_location: detachable STRING_32; a_status: detachable STRING_32)
+ do
+ create {ARRAYED_LIST [ITEM]} items.make (10)
+ if an_id /= Void then
+ set_id (an_id)
+ else
+ set_id ("")
+ end
+ if a_location /= Void then
+ set_location (a_location)
+ else
+ set_location ("")
+ end
+ if a_status /= Void then
+ set_status (a_status)
+ else
+ set_status ("")
+ end
+ revision := 0
+ end
+
+feature -- Access
+
+ id : STRING_32
+ location : STRING_32
+ items: LIST[ITEM]
+ status : STRING_32
+ revision : INTEGER
+
+feature -- element change
+
+ set_id (an_id : STRING_32)
+ do
+ id := an_id
+ ensure
+ id_assigned : id.same_string (an_id)
+ end
+
+ set_location (a_location : STRING_32)
+ do
+ location := a_location
+ ensure
+ location_assigned : location.same_string (a_location)
+ end
+
+ set_status (a_status : STRING_32)
+ do
+ status := a_status
+ ensure
+ status_asigned : status.same_string (a_status)
+ end
+
+ add_item (a_item : ITEM)
+ require
+ valid_item: a_item /= Void
+ do
+ items.force (a_item)
+ ensure
+ has_item : items.has (a_item)
+ end
+
+ add_revision
+ do
+ revision := revision + 1
+ ensure
+ revision_incremented : old revision + 1 = revision
+ end
+
+feature -- Etag
+
+ etag : STRING_32
+ -- Etag generation for Order objects
+ do
+ Result := hash_code.out + revision.out
+ end
+
+
+feature -- Output
+
+feature -- Report
+
+ hash_code: INTEGER_32
+ -- Hash code value
+ do
+ from
+ items.start
+ Result := items.item.hash_code
+ until
+ items.off
+ loop
+ Result:= ((Result \\ 8388593) |<< 8) + items.item.hash_code
+ items.forth
+ end
+ if items.count > 1 then
+ Result := Result \\ items.count
+ end
+ end
+
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/order_validation.e b/examples/obsolete/v0/restbucksCRUD/src/domain/order_validation.e
new file mode 100644
index 00000000..5583a318
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/order_validation.e
@@ -0,0 +1,56 @@
+note
+ description: "Summary description for {ORDER_TRANSITIONS}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ ORDER_VALIDATION
+feature -- Access
+
+ is_valid_status_state (a_status: STRING) : BOOLEAN
+ --is `a_status' a valid coffee order state
+ do
+ a_status.to_lower
+ Order_states.compare_objects
+ Result := Order_states.has (a_status)
+ end
+
+ Order_states : ARRAY[STRING]
+ -- List of valid status states
+ once
+ Result := <<"submitted","pay","payed", "cancel","canceled","prepare","prepared","deliver","completed">>
+ end
+
+
+ is_valid_transition (order:ORDER a_status : STRING) :BOOLEAN
+ -- Given the current order state, determine if the transition is valid
+ do
+ a_status.to_lower
+ if order.status.same_string ("submitted") then
+ Result := a_status.same_string ("pay") or a_status.same_string ("cancel") or order.status.same_string (a_status)
+ elseif order.status.same_string ("pay") then
+ Result := a_status.same_string ("payed") or order.status.same_string (a_status)
+ elseif order.status.same_string ("cancel") then
+ Result := a_status.same_string ("canceled") or order.status.same_string (a_status)
+ elseif order.status.same_string ("payed") then
+ Result := a_status.same_string ("prepared") or order.status.same_string (a_status)
+ elseif order.status.same_string ("prepared") then
+ Result := a_status.same_string ("deliver") or order.status.same_string (a_status)
+ elseif order.status.same_string ("deliver") then
+ Result := a_status.same_string ("completed") or order.status.same_string (a_status)
+ end
+ end
+
+ is_state_valid_to_update ( a_status : STRING) : BOOLEAN
+ -- Given the current state `a_status' of an order, is possible to update the order?
+ do
+ if a_status.same_string ("submitted") or else a_status.same_string ("pay") or else a_status.same_string ("payed") then
+ Result := true
+ end
+ end
+
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/domain/shared_order_validation.e b/examples/obsolete/v0/restbucksCRUD/src/domain/shared_order_validation.e
new file mode 100644
index 00000000..4e3a1d33
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/domain/shared_order_validation.e
@@ -0,0 +1,19 @@
+note
+ description: "Summary description for {SHARED_ORDER_VALIDATION}."
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ SHARED_ORDER_VALIDATION
+
+feature
+ order_validation : ORDER_VALIDATION
+ once
+ create Result
+ end
+
+note
+ copyright: "2011-2012, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/policy_driven_resource/order_handler.e b/examples/obsolete/v0/restbucksCRUD/src/policy_driven_resource/order_handler.e
new file mode 100644
index 00000000..31410477
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/policy_driven_resource/order_handler.e
@@ -0,0 +1,574 @@
+note
+ description: "{ORDER_HANDLER} handle the resources that we want to expose"
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class ORDER_HANDLER
+
+inherit
+
+ WSF_SKELETON_HANDLER
+
+ SHARED_DATABASE_API
+
+ SHARED_EJSON
+
+ REFACTORING_HELPER
+
+ SHARED_ORDER_VALIDATION
+
+ WSF_RESOURCE_HANDLER_HELPER
+ rename
+ execute_options as helper_execute_options,
+ handle_internal_server_error as helper_handle_internal_server_error
+ end
+
+create
+
+ make_with_router
+
+
+feature -- Execution variables
+
+ Order_execution_variable: STRING = "ORDER"
+ -- Execution variable used by application
+
+ Generated_content_execution_variable: STRING = "GENERATED_CONTENT"
+ -- Execution variable used by application
+
+ Extracted_order_execution_variable: STRING = "EXTRACTED_ORDER"
+ -- Execution variable used by application
+
+feature -- Documentation
+
+ description: READABLE_STRING_GENERAL
+ -- General description for self-generated documentation;
+ -- The specific URI templates supported will be described automatically
+ do
+ Result := "Create, Read, Update or Delete an ORDER."
+ end
+
+feature -- Access
+
+ is_chunking (req: WSF_REQUEST): BOOLEAN
+ -- Will the response to `req' using chunked transfer encoding?
+ do
+ -- No.
+ end
+
+ includes_response_entity (req: WSF_REQUEST): BOOLEAN
+ -- Does the response to `req' include an entity?
+ -- Method will be DELETE, POST, PUT or an extension method.
+ do
+ Result := False
+ -- At present, there is no support for this except for DELETE.
+ end
+
+ conneg (req: WSF_REQUEST): SERVER_CONTENT_NEGOTIATION
+ -- Content negotiatior for all requests
+ once
+ create Result.make ({HTTP_MIME_TYPES}.application_json, "en", "UTF-8", "identity")
+ end
+
+ mime_types_supported (req: WSF_REQUEST): LIST [STRING]
+ -- All values for Accept header that `Current' can serve
+ do
+ create {ARRAYED_LIST [STRING]} Result.make_from_array (<<{HTTP_MIME_TYPES}.application_json>>)
+ Result.compare_objects
+ end
+
+ languages_supported (req: WSF_REQUEST): LIST [STRING]
+ -- All values for Accept-Language header that `Current' can serve
+ do
+ create {ARRAYED_LIST [STRING]} Result.make_from_array (<<"en">>)
+ Result.compare_objects
+ end
+
+ charsets_supported (req: WSF_REQUEST): LIST [STRING]
+ -- All values for Accept-Charset header that `Current' can serve
+ do
+ create {ARRAYED_LIST [STRING]} Result.make_from_array (<<"UTF-8">>)
+ Result.compare_objects
+ end
+
+ encodings_supported (req: WSF_REQUEST): LIST [STRING]
+ -- All values for Accept-Encoding header that `Current' can serve
+ do
+ create {ARRAYED_LIST [STRING]} Result.make_from_array (<<"identity">>)
+ Result.compare_objects
+ end
+
+ max_age (req: WSF_REQUEST): NATURAL
+ -- Maximum age in seconds before response to `req` is considered stale;
+ -- This is used to generate a Cache-Control: max-age header.
+ -- Return 0 to indicate already expired.
+ -- Return Never_expires to indicate never expires.
+ do
+ -- All our responses are considered stale.
+ end
+
+ is_freely_cacheable (req: WSF_REQUEST): BOOLEAN
+ -- Should the response to `req' be freely cachable in shared caches?
+ -- If `True', then a Cache-Control: public header will be generated.
+ do
+ -- definitely not!
+ end
+
+ private_headers (req: WSF_REQUEST): detachable LIST [READABLE_STRING_8]
+ -- Header names intended for a single user.
+ -- If non-Void, then a Cache-Control: private header will be generated.
+ -- Returning an empty list prevents the entire response from being served from a shared cache.
+ do
+ create {ARRAYED_LIST [READABLE_STRING_8]} Result.make (0)
+ end
+
+ non_cacheable_headers (req: WSF_REQUEST): detachable LIST [READABLE_STRING_8]
+ -- Header names that will not be sent from a cache without revalidation;
+ -- If non-Void, then a Cache-Control: no-cache header will be generated.
+ -- Returning an empty list prevents the response being served from a cache
+ -- without revalidation.
+ do
+ create {ARRAYED_LIST [READABLE_STRING_8]} Result.make (0)
+ end
+
+ is_sensitive (req: WSF_REQUEST): BOOLEAN
+ -- Is the response to `req' of a sensitive nature?
+ -- If `True' then a Cache-Control: no-store header will be generated.
+ do
+ Result := True
+ -- since it's commercial data.
+ end
+
+ allowed_cross_origins (req: WSF_REQUEST): detachable STRING
+ -- Value for Access-Control-Allow-Origin header;
+ -- If supplied, should be a single URI, or the values "*" or "null".
+ -- This is currently supported only for GET requests, and POSTs that functions as GET.
+ do
+ if req.is_get_head_request_method then
+ Result := "*"
+ end
+ end
+
+ matching_etag (req: WSF_REQUEST; a_etag: READABLE_STRING_32; a_strong: BOOLEAN): BOOLEAN
+ -- Is `a_etag' a match for resource requested in `req'?
+ -- If `a_strong' then the strong comparison function must be used.
+ local
+ l_id: STRING
+ l_etag_util: ETAG_UTILS
+ do
+ l_id := order_id_from_request (req)
+ if db_access.orders.has_key (l_id) then
+ check attached db_access.orders.item (l_id) as l_order then
+ -- postcondition of `has_key'
+ create l_etag_util
+ Result := a_etag.same_string (l_etag_util.md5_digest (l_order.out).as_string_32)
+ end
+ end
+ end
+
+ etag (req: WSF_REQUEST): detachable READABLE_STRING_8
+ -- Optional Etag for `req' in the requested variant
+ local
+ l_etag_utils: ETAG_UTILS
+ do
+ create l_etag_utils
+ if attached {ORDER} req.execution_variable (Order_execution_variable) as l_order then
+ Result := l_etag_utils.md5_digest (l_order.out)
+ end
+ end
+
+ last_modified (req: WSF_REQUEST): detachable DATE_TIME
+ -- When representation of resource selected in `req' was last modified;
+ -- SHOULD be set whenever it can reasonably be determined.
+ do
+ end
+
+ modified_since (req: WSF_REQUEST; a_date_time: DATE_TIME): BOOLEAN
+ -- Has resource requested in `req' been modified since `a_date_time' (UTC)?
+ do
+ -- We don't track this information. It is safe to always say yes.
+ Result := True
+ end
+
+feature -- Measurement
+
+ content_length (req: WSF_REQUEST): NATURAL
+ -- Length of entity-body of the response to `req'
+ do
+ check attached {READABLE_STRING_8} req.execution_variable (Generated_content_execution_variable) as l_response then
+ -- postcondition generated_content_set_for_get_head of `ensure_content_available'
+ -- We only call this for GET/HEAD in this example.
+ Result := l_response.count.as_natural_32
+ end
+ end
+
+ allow_post_to_missing_resource (req: WSF_REQUEST): BOOLEAN
+ -- The resource named in `req' does not exist, and this is a POST. Do we allow it?
+ do
+ -- No.
+ end
+
+feature -- Status report
+
+ finished (req: WSF_REQUEST): BOOLEAN
+ -- Has the last chunk been generated for `req'?
+ do
+ -- precondition is never met
+ end
+
+feature -- Execution
+
+ check_resource_exists (req: WSF_REQUEST; a_helper: WSF_METHOD_HELPER)
+ -- Call `a_helper.set_resource_exists' to indicate that `req.path_translated'
+ -- is the name of an existing resource.
+ -- We also put the order into `req.execution_variable (Order_execution_variable)' for GET or HEAD responses.
+ local
+ l_id: STRING
+ do
+ if req.is_post_request_method then
+ a_helper.set_resource_exists
+ -- because only /order is defined to this handler for POST
+ else
+ -- the request is of the form /order/{orderid}
+ l_id := order_id_from_request (req)
+ if db_access.orders.has_key (l_id) then
+ a_helper.set_resource_exists
+ if req.is_get_head_request_method then
+ check attached db_access.orders.item (l_id) as l_order then
+ -- postcondition `item_if_found' of `has_key'
+ req.set_execution_variable (Order_execution_variable, l_order)
+ end
+ end
+ end
+ end
+ ensure then
+ order_saved_only_for_get_head: attached {ORDER} req.execution_variable (Order_execution_variable) implies req.is_get_head_request_method
+ end
+
+feature -- GET/HEAD content
+
+ ensure_content_available (req: WSF_REQUEST)
+ -- Commence generation of response text (entity-body).
+ -- If not chunked, then this will create the entire entity-body so as to be available
+ -- for a subsequent call to `content'.
+ -- If chunked, only the first chunk will be made available to `next_chunk'. If chunk extensions
+ -- are used, then this will also generate the chunk extension for the first chunk.
+ -- We save the text in `req.execution_variable (Generated_content_execution_variable)'
+ -- We ignore the results of content negotiation, as there is only one possible combination.
+ do
+ check attached {ORDER} req.execution_variable (Order_execution_variable) as l_order then
+ -- precondition get_or_head and postcondition order_saved_only_for_get_head of `check_resource_exists' and
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ req.set_execution_variable (Generated_content_execution_variable, jv.representation)
+ else
+ req.set_execution_variable (Generated_content_execution_variable, "")
+ end
+ end
+ ensure then
+ generated_content_set_for_get_head: req.is_get_head_request_method implies
+ attached {READABLE_STRING_8} req.execution_variable (Generated_content_execution_variable)
+ end
+
+ content (req: WSF_REQUEST): READABLE_STRING_8
+ -- Non-chunked entity body in response to `req';
+ -- We only call this for GET/HEAD in this example.
+ do
+ check attached {READABLE_STRING_8} req.execution_variable (Generated_content_execution_variable) as l_response then
+ -- postcondition generated_content_set_for_get_head of `ensure_content_available'
+ Result := l_response
+ end
+ end
+
+ next_chunk (req: WSF_REQUEST): TUPLE [a_chunk: READABLE_STRING_8; a_extension: detachable READABLE_STRING_8]
+ -- Next chunk of entity body in response to `req';
+ -- The second field of the result is an optional chunk extension.
+ do
+ -- precondition `is_chunking' is never met, but we need a dummy `Result'
+ -- to satisfy the compiler in void-safe mode
+ Result := ["", Void]
+ end
+
+ generate_next_chunk (req: WSF_REQUEST)
+ -- Prepare next chunk (including optional chunk extension) of entity body in response to `req'.
+ -- This is not called for the first chunk.
+ do
+ -- precondition `is_chunking' is never met
+ end
+
+feature -- DELETE
+
+ delete (req: WSF_REQUEST)
+ -- Delete resource named in `req' or set an error on `req.error_handler'.
+ local
+ l_id: STRING
+ do
+ l_id := order_id_from_request (req)
+ if db_access.orders.has_key (l_id) then
+ if is_valid_to_delete (l_id) then
+ delete_order (l_id)
+ else
+ req.error_handler.add_custom_error ({HTTP_STATUS_CODE}.method_not_allowed, "DELETE not valid",
+ "There is conflict while trying to delete the order, the order could not be deleted in the current state")
+ end
+ else
+ req.error_handler.add_custom_error ({HTTP_STATUS_CODE}.not_found, "DELETE not valid",
+ "There is no such order to delete")
+ end
+ end
+
+ delete_queued (req: WSF_REQUEST): BOOLEAN
+ -- Has resource named by `req' been queued for deletion?
+ do
+ -- No
+ end
+
+
+feature -- PUT/POST
+
+ is_entity_too_large (req: WSF_REQUEST): BOOLEAN
+ -- Is the entity stored in `req.execution_variable (Request_entity_execution_variable)' too large for the application?
+ do
+ -- No. We don't care for this example.
+ end
+
+ check_content_headers (req: WSF_REQUEST)
+ -- Check we can support all content headers on request entity.
+ -- Set `req.execution_variable (Content_check_code_execution_variable)' to {NATURAL} zero if OK, or 415 or 501 if not.
+ do
+ -- We don't bother for this example. Note that this is equivalent to setting zero.
+ end
+
+ create_resource (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Create new resource in response to a PUT request when `check_resource_exists' returns `False'.
+ -- Implementor must set error code of 200 OK or 500 Server Error.
+ do
+ -- We don't support creating a new resource with PUT. But this can't happen
+ -- with our router mappings, so we don't bother to set a 500 response.
+ end
+
+ append_resource (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Create new resource in response to a POST request.
+ -- Implementor must set error code of 200 OK or 204 No Content or 303 See Other or 500 Server Error.
+ do
+ if attached {ORDER} req.execution_variable (Extracted_order_execution_variable) as l_order then
+ save_order (l_order)
+ compute_response_post (req, res, l_order)
+ else
+ handle_bad_request_response ("Not a valid order", req, res)
+ end
+ end
+
+ check_conflict (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Check we can support all content headers on request entity.
+ -- Set `req.execution_variable (Conflict_check_code_execution_variable)' to {NATURAL} zero if OK, or 409 if not.
+ -- In the latter case, write the full error response to `res'.
+ do
+ if attached {ORDER} req.execution_variable (Extracted_order_execution_variable) as l_order then
+ if not is_valid_to_update (l_order) then
+ req.set_execution_variable (Conflict_check_code_execution_variable, {NATURAL} 409)
+ handle_resource_conflict_response (l_order.out +"%N There is conflict while trying to update the order, the order could not be update in the current state", req, res)
+ end
+ else
+ req.set_execution_variable (Conflict_check_code_execution_variable, {NATURAL} 409)
+ --| This ought to be a 500, as if attached should probably be check attached. But as yet I lack a proof.
+ handle_resource_conflict_response ("There is conflict while trying to update the order, the order could not be update in the current state", req, res)
+ end
+ end
+
+ check_request (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Check that the request entity is a valid request.
+ -- The entity is available as `req.execution_variable (Conflict_check_code_execution_variable)'.
+ -- Set `req.execution_variable (Request_check_code_execution_variable)' to {NATURAL} zero if OK, or 400 if not.
+ -- In the latter case, write the full error response to `res'.
+ local
+ l_order: detachable ORDER
+ l_id: STRING
+ do
+ if attached {READABLE_STRING_8} req.execution_variable (Request_entity_execution_variable) as l_request then
+ l_order := extract_order_request (l_request)
+ if req.is_put_request_method then
+ l_id := order_id_from_request (req)
+ if l_order /= Void and then db_access.orders.has_key (l_id) then
+ l_order.set_id (l_id)
+ req.set_execution_variable (Request_check_code_execution_variable, {NATURAL} 0)
+ req.set_execution_variable (Extracted_order_execution_variable, l_order)
+ else
+ req.set_execution_variable (Request_check_code_execution_variable, {NATURAL} 400)
+ handle_bad_request_response (l_request +"%N is not a valid ORDER, maybe the order does not exist in the system", req, res)
+ end
+ else
+ req.set_execution_variable (Request_check_code_execution_variable, {NATURAL} 0)
+ req.set_execution_variable (Extracted_order_execution_variable, l_order)
+ end
+ else
+ req.set_execution_variable (Request_check_code_execution_variable, {NATURAL} 400)
+ handle_bad_request_response ("Request is not a valid ORDER", req, res)
+ end
+ end
+
+ update_resource (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Perform the update requested in `req'.
+ -- Write a response to `res' with a code of 204 or 500.
+ do
+ if attached {ORDER} req.execution_variable (Extracted_order_execution_variable) as l_order then
+ update_order (l_order)
+ compute_response_put (req, res, l_order)
+ else
+ handle_internal_server_error (res)
+ end
+ end
+
+feature -- HTTP Methods
+
+ compute_response_put (req: WSF_REQUEST; res: WSF_RESPONSE; l_order : ORDER)
+ local
+ h: HTTP_HEADER
+ joc : JSON_ORDER_CONVERTER
+ etag_utils : ETAG_UTILS
+ do
+ create h.make
+ create joc.make
+ create etag_utils
+ json.add_converter(joc)
+
+ create h.make
+ h.put_content_type_application_json
+ if attached req.request_time as time then
+ h.add_header ("Date:" +time.formatted_out ("ddd,[0]dd mmm yyyy [0]hh:[0]mi:[0]ss.ff2") + " GMT")
+ end
+ h.add_header ("etag:" + etag_utils.md5_digest (l_order.out))
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ h.put_content_length (jv.representation.count)
+ res.set_status_code ({HTTP_STATUS_CODE}.ok)
+ res.put_header_text (h.string)
+ res.put_string (jv.representation)
+ end
+ end
+
+ compute_response_post (req: WSF_REQUEST; res: WSF_RESPONSE; l_order : ORDER)
+ local
+ h: HTTP_HEADER
+ l_msg : STRING
+ l_location : STRING
+ joc : JSON_ORDER_CONVERTER
+ do
+ create h.make
+
+ create joc.make
+ json.add_converter(joc)
+
+ h.put_content_type_application_json
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ l_msg := jv.representation
+ h.put_content_length (l_msg.count)
+ if attached req.http_host as host then
+ l_location := "http://" + host + req.request_uri + "/" + l_order.id
+ h.put_location (l_location)
+ end
+ if attached req.request_time as time then
+ h.put_utc_date (time)
+ end
+ res.set_status_code ({HTTP_STATUS_CODE}.created)
+ res.put_header_text (h.string)
+ res.put_string (l_msg)
+ end
+ end
+
+feature {NONE} -- URI helper methods
+
+ order_id_from_request (req: WSF_REQUEST): STRING
+ -- Value of "orderid" template URI variable in `req'
+ require
+ req_attached: req /= Void
+ do
+ if attached {WSF_VALUE} req.path_parameter ("orderid") as l_value then
+ Result := l_value.as_string.value.as_string_8
+ else
+ Result := ""
+ end
+ end
+
+feature {NONE} -- Implementation Repository Layer
+
+ retrieve_order ( id : STRING) : detachable ORDER
+ -- get the order by id if it exist, in other case, Void
+ do
+ Result := db_access.orders.item (id)
+ end
+
+ save_order (an_order: ORDER)
+ -- save the order to the repository
+ local
+ i : INTEGER
+ do
+ from
+ i := 1
+ until
+ not db_access.orders.has_key ((db_access.orders.count + i).out)
+ loop
+ i := i + 1
+ end
+ an_order.set_id ((db_access.orders.count + i).out)
+ an_order.set_status ("submitted")
+ an_order.add_revision
+ db_access.orders.force (an_order, an_order.id)
+ end
+
+
+ is_valid_to_delete ( an_id : STRING) : BOOLEAN
+ -- Is the order identified by `an_id' in a state whre it can still be deleted?
+ do
+ if attached retrieve_order (an_id) as l_order then
+ if order_validation.is_state_valid_to_update (l_order.status) then
+ Result := True
+ end
+ end
+ end
+
+ is_valid_to_update (an_order: ORDER) : BOOLEAN
+ -- Check if there is a conflict while trying to update the order
+ do
+ if attached retrieve_order (an_order.id) as l_order then
+ if order_validation.is_state_valid_to_update (l_order.status) and then order_validation.is_valid_status_state (an_order.status) and then
+ order_validation.is_valid_transition (l_order, an_order.status) then
+ Result := True
+ end
+ end
+ end
+
+ update_order (an_order: ORDER)
+ -- update the order to the repository
+ do
+ an_order.add_revision
+ db_access.orders.force (an_order, an_order.id)
+ end
+
+ delete_order (an_order: STRING)
+ -- update the order to the repository
+ do
+ db_access.orders.remove (an_order)
+ end
+
+ extract_order_request (l_post : STRING) : detachable ORDER
+ -- extract an object Order from the request, or Void
+ -- if the request is invalid
+ local
+ parser : JSON_PARSER
+ joc : JSON_ORDER_CONVERTER
+ do
+ create joc.make
+ json.add_converter(joc)
+ create parser.make_with_string (l_post)
+ parser.parse_content
+ if parser.is_valid and then attached parser.parsed_json_value as jv then
+ if attached {like extract_order_request} json.object (jv, "ORDER") as res then
+ Result := res
+ end
+ end
+ end
+
+note
+ copyright: "2011-2015, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/resource/order_handler.e b/examples/obsolete/v0/restbucksCRUD/src/resource/order_handler.e
new file mode 100644
index 00000000..4088494e
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/resource/order_handler.e
@@ -0,0 +1,403 @@
+note
+ description: "{ORDER_HANDLER} handle the resources that we want to expose"
+ author: ""
+ date: "$Date$"
+ revision: "$Revision$"
+
+class ORDER_HANDLER
+inherit
+
+ WSF_URI_TEMPLATE_HANDLER
+
+ WSF_RESOURCE_HANDLER_HELPER
+ redefine
+ do_get,
+ do_post,
+ do_put,
+ do_delete
+ end
+
+ SHARED_DATABASE_API
+
+ SHARED_EJSON
+
+ REFACTORING_HELPER
+
+ SHARED_ORDER_VALIDATION
+
+ WSF_SELF_DOCUMENTED_HANDLER
+
+create
+ make_with_router
+
+feature {NONE} -- Initialization
+
+ make_with_router (a_router: WSF_ROUTER)
+ -- Initialize `router'.
+ require
+ a_router_attached: a_router /= Void
+ do
+ router := a_router
+ ensure
+ router_aliased: router = a_router
+ end
+
+feature -- Router
+
+ router: WSF_ROUTER
+ -- Associated router that could be used for advanced strategy
+
+feature -- Execute
+
+ execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Execute request handler
+ do
+ execute_methods (req, res)
+ end
+
+feature -- API DOC
+
+ api_doc : STRING = "URI:/order METHOD: POST%N URI:/order/{orderid} METHOD: GET, PUT, DELETE%N"
+
+
+feature -- Documentation
+
+ mapping_documentation (m: WSF_ROUTER_MAPPING; a_request_methods: detachable WSF_REQUEST_METHODS): WSF_ROUTER_MAPPING_DOCUMENTATION
+ do
+ create Result.make (m)
+ if a_request_methods /= Void then
+ if a_request_methods.has_method_post then
+ Result.add_description ("URI:/order METHOD: POST")
+ elseif
+ a_request_methods.has_method_get
+ or a_request_methods.has_method_put
+ or a_request_methods.has_method_delete
+ then
+ Result.add_description ("URI:/order/{orderid} METHOD: GET, PUT, DELETE")
+ end
+ end
+ end
+
+feature -- HTTP Methods
+
+ do_get (req: WSF_REQUEST; res: WSF_RESPONSE)
+ --
+ local
+ id: STRING
+ do
+ if attached req.path_info as l_path_info then
+ id := get_order_id_from_path (l_path_info)
+ if attached retrieve_order (id) as l_order then
+ if is_conditional_get (req, l_order) then
+ handle_resource_not_modified_response ("The resource" + l_path_info + "does not change", req, res)
+ else
+ compute_response_get (req, res, l_order)
+ end
+ else
+ handle_resource_not_found_response ("The following resource" + l_path_info + " is not found ", req, res)
+ end
+ end
+ end
+
+ is_conditional_get (req : WSF_REQUEST; l_order : ORDER) : BOOLEAN
+ -- Check if If-None-Match is present and then if there is a representation that has that etag
+ -- if the representation hasn't changed, we return TRUE
+ -- then the response is a 304 with no entity body returned.
+ local
+ etag_util : ETAG_UTILS
+ do
+ if attached req.meta_string_variable ("HTTP_IF_NONE_MATCH") as if_none_match then
+ create etag_util
+ if if_none_match.same_string (etag_util.md5_digest (l_order.out).as_string_32) then
+ Result := True
+ end
+ end
+ end
+
+ compute_response_get (req: WSF_REQUEST; res: WSF_RESPONSE; l_order: ORDER)
+ local
+ h: HTTP_HEADER
+ l_msg : STRING
+ etag_utils : ETAG_UTILS
+ do
+ create h.make
+ create etag_utils
+ h.put_content_type_application_json
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ l_msg := jv.representation
+ h.put_content_length (l_msg.count)
+ if attached req.request_time as time then
+ h.add_header ("Date:" + time.formatted_out ("ddd,[0]dd mmm yyyy [0]hh:[0]mi:[0]ss.ff2") + " GMT")
+ end
+ h.add_header ("etag:" + etag_utils.md5_digest (l_order.out))
+ res.set_status_code ({HTTP_STATUS_CODE}.ok)
+ res.put_header_text (h.string)
+ res.put_string (l_msg)
+ end
+ end
+
+ do_put (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Updating a resource with PUT
+ -- A successful PUT request will not create a new resource, instead it will
+ -- change the state of the resource identified by the current uri.
+ -- If success we response with 200 and the updated order.
+ -- 404 if the order is not found
+ -- 400 in case of a bad request
+ -- 500 internal server error
+ -- If the request is a Conditional PUT, and it does not mat we response
+ -- 415, precondition failed.
+ local
+ l_put: STRING
+ l_order : detachable ORDER
+ id : STRING
+ do
+ if attached req.path_info as l_path_info then
+ id := get_order_id_from_path (l_path_info)
+ l_put := retrieve_data (req)
+ l_order := extract_order_request(l_put)
+ if l_order /= Void and then db_access.orders.has_key (id) then
+ l_order.set_id (id)
+ if is_valid_to_update(l_order) then
+ if is_conditional_put (req, l_order) then
+ update_order( l_order)
+ compute_response_put (req, res, l_order)
+ else
+ handle_precondition_fail_response ("", req, res)
+ end
+ else
+ --| FIXME: Here we need to define the Allow methods
+ handle_resource_conflict_response (l_put +"%N There is conflict while trying to update the order, the order could not be update in the current state", req, res)
+ end
+ else
+ handle_bad_request_response (l_put +"%N is not a valid ORDER, maybe the order does not exist in the system", req, res)
+ end
+ end
+ end
+
+ is_conditional_put (req : WSF_REQUEST; order : ORDER) : BOOLEAN
+ -- Check if If-Match is present and then if there is a representation that has that etag
+ -- if the representation hasn't changed, we return TRUE
+ local
+ etag_util : ETAG_UTILS
+ do
+ if attached retrieve_order (order.id) as l_order then
+ if attached req.meta_string_variable ("HTTP_IF_MATCH") as if_match then
+ create etag_util
+ if if_match.same_string (etag_util.md5_digest (l_order.out).as_string_32) then
+ Result := True
+ end
+ else
+ Result := True
+ end
+ end
+ end
+
+
+ compute_response_put (req: WSF_REQUEST; res: WSF_RESPONSE; l_order : ORDER)
+ local
+ h: HTTP_HEADER
+ joc : JSON_ORDER_CONVERTER
+ etag_utils : ETAG_UTILS
+ do
+ create h.make
+ create joc.make
+ create etag_utils
+ json.add_converter(joc)
+
+ create h.make
+ h.put_content_type_application_json
+ if attached req.request_time as time then
+ h.add_header ("Date:" +time.formatted_out ("ddd,[0]dd mmm yyyy [0]hh:[0]mi:[0]ss.ff2") + " GMT")
+ end
+ h.add_header ("etag:" + etag_utils.md5_digest (l_order.out))
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ h.put_content_length (jv.representation.count)
+ res.set_status_code ({HTTP_STATUS_CODE}.ok)
+ res.put_header_text (h.string)
+ res.put_string (jv.representation)
+ end
+ end
+
+
+ do_delete (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Here we use DELETE to cancel an order, if that order is in state where
+ -- it can still be canceled.
+ -- 200 if is ok
+ -- 404 Resource not found
+ -- 405 if consumer and service's view of the resouce state is inconsisent
+ -- 500 if we have an internal server error
+ local
+ id: STRING
+ do
+ if attached req.path_info as l_path_info then
+ id := get_order_id_from_path (l_path_info)
+ if db_access.orders.has_key (id) then
+ if is_valid_to_delete (id) then
+ delete_order( id)
+ compute_response_delete (req, res)
+ else
+ --| FIXME: Here we need to define the Allow methods
+ handle_method_not_allowed_response (l_path_info + "%N There is conflict while trying to delete the order, the order could not be deleted in the current state", req, res)
+ end
+ else
+ handle_resource_not_found_response (l_path_info + " not found in this server", req, res)
+ end
+ end
+ end
+
+ compute_response_delete (req: WSF_REQUEST; res: WSF_RESPONSE)
+ local
+ h : HTTP_HEADER
+ do
+ create h.make
+ h.put_content_type_application_json
+ if attached req.request_time as time then
+ h.put_utc_date (time)
+ end
+ res.set_status_code ({HTTP_STATUS_CODE}.no_content)
+ res.put_header_text (h.string)
+ end
+
+ do_post (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Here the convention is the following.
+ -- POST is used for creation and the server determines the URI
+ -- of the created resource.
+ -- If the request post is SUCCESS, the server will create the order and will response with
+ -- HTTP_RESPONSE 201 CREATED, the Location header will contains the newly created order's URI
+ -- if the request post is not SUCCESS, the server will response with
+ -- HTTP_RESPONSE 400 BAD REQUEST, the client send a bad request
+ -- HTTP_RESPONSE 500 INTERNAL_SERVER_ERROR, when the server can deliver the request
+ local
+ l_post: STRING
+ do
+ l_post := retrieve_data (req)
+ if attached extract_order_request (l_post) as l_order then
+ save_order (l_order)
+ compute_response_post (req, res, l_order)
+ else
+ handle_bad_request_response (l_post +"%N is not a valid ORDER", req, res)
+ end
+ end
+
+ compute_response_post (req: WSF_REQUEST; res: WSF_RESPONSE; l_order : ORDER)
+ local
+ h: HTTP_HEADER
+ l_msg : STRING
+ l_location : STRING
+ joc : JSON_ORDER_CONVERTER
+ do
+ create h.make
+
+ create joc.make
+ json.add_converter(joc)
+
+ h.put_content_type_application_json
+ if attached {JSON_VALUE} json.value (l_order) as jv then
+ l_msg := jv.representation
+ h.put_content_length (l_msg.count)
+ if attached req.http_host as host then
+ l_location := "http://" + host + req.request_uri + "/" + l_order.id
+ h.put_location (l_location)
+ end
+ if attached req.request_time as time then
+ h.put_utc_date (time)
+ end
+ res.set_status_code ({HTTP_STATUS_CODE}.created)
+ res.put_header_text (h.string)
+ res.put_string (l_msg)
+ end
+ end
+
+feature {NONE} -- URI helper methods
+
+ get_order_id_from_path (a_path: READABLE_STRING_32) : STRING
+ do
+ Result := a_path.split ('/').at (3)
+ end
+
+feature {NONE} -- Implementation Repository Layer
+
+ retrieve_order ( id : STRING) : detachable ORDER
+ -- get the order by id if it exist, in other case, Void
+ do
+ Result := db_access.orders.item (id)
+ end
+
+ save_order (an_order: ORDER)
+ -- save the order to the repository
+ local
+ i : INTEGER
+ do
+ from
+ i := 1
+ until
+ not db_access.orders.has_key ((db_access.orders.count + i).out)
+ loop
+ i := i + 1
+ end
+ an_order.set_id ((db_access.orders.count + i).out)
+ an_order.set_status ("submitted")
+ an_order.add_revision
+ db_access.orders.force (an_order, an_order.id)
+ end
+
+
+ is_valid_to_delete ( an_id : STRING) : BOOLEAN
+ -- Is the order identified by `an_id' in a state whre it can still be deleted?
+ do
+ if attached retrieve_order (an_id) as l_order then
+ if order_validation.is_state_valid_to_update (l_order.status) then
+ Result := True
+ end
+ end
+ end
+
+ is_valid_to_update (an_order: ORDER) : BOOLEAN
+ -- Check if there is a conflict while trying to update the order
+ do
+ if attached retrieve_order (an_order.id) as l_order then
+ if order_validation.is_state_valid_to_update (l_order.status) and then order_validation.is_valid_status_state (an_order.status) and then
+ order_validation.is_valid_transition (l_order, an_order.status) then
+ Result := True
+ end
+ end
+ end
+
+ update_order (an_order: ORDER)
+ -- update the order to the repository
+ do
+ an_order.add_revision
+ db_access.orders.force (an_order, an_order.id)
+ end
+
+ delete_order (an_order: STRING)
+ -- update the order to the repository
+ do
+ db_access.orders.remove (an_order)
+ end
+
+ extract_order_request (l_post : STRING) : detachable ORDER
+ -- extract an object Order from the request, or Void
+ -- if the request is invalid
+ local
+ parser : JSON_PARSER
+ joc : JSON_ORDER_CONVERTER
+ do
+ create joc.make
+ json.add_converter(joc)
+ create parser.make_with_string (l_post)
+ parser.parse_content
+ if
+ parser.is_valid and then
+ attached parser.parsed_json_value as jv
+ then
+ if attached {like extract_order_request} json.object (jv, "ORDER") as res then
+ Result := res
+ end
+ end
+ end
+
+note
+ copyright: "2011-2015, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/restbucks_server.e b/examples/obsolete/v0/restbucksCRUD/src/restbucks_server.e
new file mode 100644
index 00000000..588b2057
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/restbucks_server.e
@@ -0,0 +1,58 @@
+note
+ description : "REST Buck server"
+ date : "$Date$"
+ revision : "$Revision$"
+
+class RESTBUCKS_SERVER
+
+inherit
+
+ WSF_ROUTED_SKELETON_SERVICE
+ undefine
+ requires_proxy
+ end
+
+ WSF_URI_TEMPLATE_HELPER_FOR_ROUTED_SERVICE
+
+ WSF_HANDLER_HELPER
+
+ WSF_DEFAULT_SERVICE
+
+ WSF_NO_PROXY_POLICY
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ make
+ do
+ initialize_router
+ set_service_option ("port", 9090)
+ make_and_launch
+ end
+
+ setup_router
+ local
+ order_handler: ORDER_HANDLER
+ doc: WSF_ROUTER_SELF_DOCUMENTATION_HANDLER
+ do
+ create order_handler.make_with_router (router)
+ router.handle_with_request_methods ("/order", order_handler, router.methods_POST)
+ router.handle_with_request_methods ("/order/{orderid}", order_handler, router.methods_GET + router.methods_DELETE + router.methods_PUT)
+ create doc.make_hidden (router)
+ router.handle_with_request_methods ("/api/doc", doc, router.methods_GET)
+ end
+
+
+note
+ copyright: "2011-2013, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+ source: "[
+ Eiffel Software
+ 5949 Hollister Ave., Goleta, CA 93117 USA
+ Telephone 805-685-1006, Fax 805-685-6869
+ Website http://www.eiffel.com
+ Customer support http://support.eiffel.com
+ ]"
+end
diff --git a/examples/obsolete/v0/restbucksCRUD/src/utils/etag_utils.e b/examples/obsolete/v0/restbucksCRUD/src/utils/etag_utils.e
new file mode 100644
index 00000000..9aed6c1d
--- /dev/null
+++ b/examples/obsolete/v0/restbucksCRUD/src/utils/etag_utils.e
@@ -0,0 +1,24 @@
+note
+ description: "Summary description for {ETAG_UTILS}."
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ ETAG_UTILS
+
+feature -- Access
+
+ md5_digest (a_string: STRING): STRING
+ -- Cryptographic hash function that produces a 128-bit (16-byte) hash value, based on `a_string'
+ local
+ md5: MD5
+ do
+ create md5.make
+ md5.update_from_string (a_string)
+ Result := md5.digest_as_string
+ end
+
+note
+ copyright: "2011-2014, Javier Velilla and others"
+ license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
+end
diff --git a/examples/restbucksCRUD/restbucks-safe.ecf b/examples/restbucksCRUD/restbucks-safe.ecf
index acf2f5dd..9a8a9a6e 100644
--- a/examples/restbucksCRUD/restbucks-safe.ecf
+++ b/examples/restbucksCRUD/restbucks-safe.ecf
@@ -8,7 +8,7 @@
-
+
-
+
diff --git a/examples/simple_file/service_file.ecf b/examples/simple_file/service_file.ecf
index 9674713e..7f39a526 100644
--- a/examples/simple_file/service_file.ecf
+++ b/examples/simple_file/service_file.ecf
@@ -5,7 +5,7 @@
-
+
diff --git a/examples/tutorial/README.wiki b/examples/tutorial/README.wiki
index 72976e1a..e2d6b9e3 100644
--- a/examples/tutorial/README.wiki
+++ b/examples/tutorial/README.wiki
@@ -8,10 +8,11 @@ To write once and run on any web server, on any platforms thanks to the notion o
== What is a connector? ==
A connector is the layer between the underlying httpd server, and your application based on EWF.
-Currently, 3 connectors are available within EWF (but others are available outside).
+Currently, 4 connectors are available within EWF (but others are available outside).
* CGI: the common CGI application (apache, iis, ...)
* FastCGI: on any server supporting libfcgi handling (apache, iis, ...)
-* Nino: using the standalone Eiffel Web Nino server, you can run anywhere easily, and debug simply with EiffelStudio's debugger
+* Standalone: a standalone Eiffel Web server, it can be run anywhere easily, and debug simply with EiffelStudio's debugger. It supports all concurrency modes, and require EiffelStudio >= 15.05.
+* Nino: similar to the "standalone" connectors, but lack good concurrency support.
Supporting a new connector is fairly simple, it just has to support the simple EWSGI specification which is really small. Then EWF will bring the power on top of it.
diff --git a/examples/tutorial/step_1.wiki b/examples/tutorial/step_1.wiki
index 7ab65ede..c9e115c4 100644
--- a/examples/tutorial/step_1.wiki
+++ b/examples/tutorial/step_1.wiki
@@ -7,12 +7,12 @@ or go to [[step_2.wiki|step 2]]
== Get EWF package ==
=== From the archive ===
-* Get recent archive from https://github.com/EiffelWebFramework/EWF/downloads
+* Get recent archive of version v1 from https://github.com/EiffelWebFramework/EWF/releases
=== From the source ===
* '''Requirement''': install [http://www.git-scm.org/ git] on your machine
- $ git clone --recursive https://github.com/EiffelWebFramework/EWF.git ewf
+ $ git clone -b v1 --recursive https://github.com/EiffelWebFramework/EWF.git ewf
== Install EWF ==
For now, there is nothing specific to do.
diff --git a/examples/tutorial/step_2.wiki b/examples/tutorial/step_2.wiki
index c6b759a1..e7b40edb 100644
--- a/examples/tutorial/step_2.wiki
+++ b/examples/tutorial/step_2.wiki
@@ -13,14 +13,14 @@ or go to [[step_3.wiki|step 3]]
== "hello" project ==
* using the "wsf" library:
** It provides service, request, response, ...
-* using the "default_nino" library
-** This is used to build the application in a portable manner, but for this compilation, it uses Eiffel Web Nino as connector.
-** We use Eiffel Web Nino for this tutorial, because there is no need to configure any apache, iis, and so on. And it is convenient to execute inside EiffelStudio
+* using the "default_standalone" library
+** This is used to build the application in a portable manner, but for this compilation, it uses the standalone web server as connector.
+** We use that standalone connection this tutorial, because there is no need to configure any apache, iis, and so on. And it is convenient to execute with EiffelStudio debugger.
* To see the result, you should open http://localhost/ on your web browser. Note if the application is using another port such as 9999, you should open http://localhost:9999/
* You will find inside [[step_2]] the "hello" project
-** target "hello" provides a very simple implementation (But by default, it is using port 80 with Eiffel Web Nino, which might already be busy by other application)
+** target "hello" provides a very simple implementation (But by default, it is using port 80 with standalone web server, which might already be busy by other application)
** target "hello_custom" which uses almost the same code, but in addition, you can use the ewf.ini file to precise the port number (9999 for this example)
* To see the result, open http://localhost/ in a web browser.
@@ -28,25 +28,38 @@ or go to [[step_3.wiki|step 3]]
* Eiffel code
class
- HELLO_APPLICATION
-
+ HELLO_APPLICATION
+
inherit
- WSF_DEFAULT_RESPONSE_SERVICE
-
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
+
create
- make_and_launch
-
- feature {NONE} -- Initialization
-
- response (req: WSF_REQUEST): WSF_PAGE_RESPONSE
- -- Computed response message.
- do
- create Result.make
- Result.put_string ("Hello World")
- end
+ make_and_launch
end
+ class
+ HELLO_EXECUTION
+
+ inherit
+ WSF_EXECUTION
+
+ create
+ make
+
+ feature -- Execution
+
+ execute
+ local
+ msg: WSF_PAGE_RESPONSE
+ do
+ create msg.make_with_body ("Hello World")
+ response.send (msg)
+ end
+
+ end
+
+Note: we could also declare the root class as being "WSF_DEFAULT_SERVICE [HELLO_EXECUTION]" to avoid this HELLO_APPLICATION class.
----
diff --git a/examples/tutorial/step_2/hello/alternatives/README.wiki b/examples/tutorial/step_2/hello/alternatives/README.wiki
index c331a521..f631ce5b 100644
--- a/examples/tutorial/step_2/hello/alternatives/README.wiki
+++ b/examples/tutorial/step_2/hello/alternatives/README.wiki
@@ -1,11 +1,11 @@
This folder contains 2 alternatives code
-1) "execute" using the WSF_SERVICE interface, i.e
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
+1) "message" using the WSF_MESSAGE_EXECUTION interface, i.e
+ message: WSF_RESPONSE_MESSAGE
do
...
end
-2) "launcher" using the WSF_RESPONSE_SERVICE interface, but it uses a launcher to start the service, instead of inheriting from WSF_DEFAULT_SERVICE or WSF_DEFAULT_RESPONSE_SERVICE
+2) "launcher" using the WSF_RESPONSE_SERVICE interface, but it uses a launcher to start the service, instead of inheriting from WSF_DEFAULT_SERVICE
diff --git a/examples/tutorial/step_2/hello/alternatives/execute/hello_application.e b/examples/tutorial/step_2/hello/alternatives/execute/hello_application.e
deleted file mode 100644
index 016aa2ad..00000000
--- a/examples/tutorial/step_2/hello/alternatives/execute/hello_application.e
+++ /dev/null
@@ -1,39 +0,0 @@
-note
- description: "[
- APPLICATION implements the `Hello World' service.
-
- It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready
- only `execute' needs to be implemented.
-
- `initialize' can be redefine to provide custom options if needed.
-
- ]"
-
-class
- HELLO_APPLICATION
-
-inherit
- WSF_DEFAULT_SERVICE
-
-create
- make_and_launch
-
-feature {NONE} -- Initialization
-
- execute (req: WSF_REQUEST; res: WSF_RESPONSE)
- local
- page: WSF_PAGE_RESPONSE
- do
- create page.make
- page.put_string ("Hello World")
- res.send (page)
-
- --| another alternative would have been more low level
- --| by setting the status code, the content type, and the content length which is 11 for "Hello World"
- --| res.put_header ({WSF_HEADER}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>)
- --| res.put_string ("Hello World")
- end
-
-
-
-end
diff --git a/examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.rc b/examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.rc
deleted file mode 100644
index 8b137891..00000000
--- a/examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.rc
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/examples/tutorial/step_2/hello/alternatives/launcher/hello_application.e b/examples/tutorial/step_2/hello/alternatives/launcher/hello_application.e
index 4dac696c..2eaef500 100644
--- a/examples/tutorial/step_2/hello/alternatives/launcher/hello_application.e
+++ b/examples/tutorial/step_2/hello/alternatives/launcher/hello_application.e
@@ -11,30 +11,31 @@ class
HELLO_APPLICATION
inherit
- WSF_RESPONSE_SERVICE
+ WSF_LAUNCHABLE_SERVICE
+ redefine
+ initialize
+ end
create
make_and_launch
feature {NONE} -- Initialization
- make_and_launch
+ initialize
local
- launcher: WSF_DEFAULT_SERVICE_LAUNCHER
opts: detachable WSF_SERVICE_LAUNCHER_OPTIONS
do
- --| Uncomment the following line, to read options from "ewf.ini" configuration file
- -- create {WSF_SERVICE_LAUNCHER_OPTIONS_FROM_INI} opts.make_from_file ("ewf.ini")
-
- create launcher.make_and_launch (Current, opts)
+ Precursor
+ --| Uncomment the following 2 lines, to read options from "ewf.ini" configuration file
+-- create {WSF_SERVICE_LAUNCHER_OPTIONS_FROM_INI} opts.make_from_file ("ewf.ini")
+-- import_service_options (opts)
end
-feature {NONE} -- Initialization
-
- response (req: WSF_REQUEST): WSF_PAGE_RESPONSE
+ launch (opts: detachable WSF_SERVICE_LAUNCHER_OPTIONS)
+ local
+ launcher: WSF_DEFAULT_SERVICE_LAUNCHER [HELLO_EXECUTION]
do
- create Result.make
- Result.put_string ("Hello World")
+ create launcher.make_and_launch (opts)
end
end
diff --git a/examples/tutorial/step_2/hello/alternatives/launcher/hello_execution.e b/examples/tutorial/step_2/hello/alternatives/launcher/hello_execution.e
new file mode 100644
index 00000000..2f3cd277
--- /dev/null
+++ b/examples/tutorial/step_2/hello/alternatives/launcher/hello_execution.e
@@ -0,0 +1,35 @@
+note
+ description: "[
+ Request execution for Current application.
+ Implement `execute' based on `request' and `response'.
+ ]"
+ author: "$Author$"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ HELLO_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Execution
+
+ execute
+ local
+ msg: WSF_PAGE_RESPONSE
+ do
+ create msg.make_with_body ("Hello World")
+ response.send (msg)
+
+ --| alternative would have been more low level
+ --| by setting the content type, and the content length which is 11 for "Hello World"
+ -- response.header.put_content_type_text_plain
+ -- response.header.put_content_length (11)
+ -- response.put_string ("Hello World")
+ end
+
+end
diff --git a/examples/tutorial/step_2/hello/alternatives/message/hello_application.e b/examples/tutorial/step_2/hello/alternatives/message/hello_application.e
new file mode 100644
index 00000000..d1f86da5
--- /dev/null
+++ b/examples/tutorial/step_2/hello/alternatives/message/hello_application.e
@@ -0,0 +1,21 @@
+note
+ description: "[
+ APPLICATION implements the `Hello World' service.
+
+ It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready
+ only `execute' needs to be implemented.
+
+ `initialize' can be redefine to provide custom options if needed.
+
+ ]"
+
+class
+ HELLO_APPLICATION
+
+inherit
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
+
+create
+ make_and_launch
+
+end
diff --git a/examples/tutorial/step_2/hello/alternatives/message/hello_execution.e b/examples/tutorial/step_2/hello/alternatives/message/hello_execution.e
new file mode 100644
index 00000000..1359203b
--- /dev/null
+++ b/examples/tutorial/step_2/hello/alternatives/message/hello_execution.e
@@ -0,0 +1,27 @@
+note
+ description: "[
+ Request execution for Current application.
+ Implement `message' based on `request' and `response'.
+ ]"
+ author: "$Author$"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ HELLO_EXECUTION
+
+inherit
+ WSF_MESSAGE_EXECUTION
+
+create
+ make
+
+feature -- Execution
+
+ message: WSF_PAGE_RESPONSE
+ do
+ create Result.make_with_body ("Hello World")
+ response.send (Result)
+ end
+
+end
diff --git a/examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.ecf b/examples/tutorial/step_2/hello/alternatives/message/hello_with_execute.ecf
similarity index 86%
rename from examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.ecf
rename to examples/tutorial/step_2/hello/alternatives/message/hello_with_execute.ecf
index 9375f810..9a2dbdf0 100644
--- a/examples/tutorial/step_2/hello/alternatives/execute/hello_with_execute.ecf
+++ b/examples/tutorial/step_2/hello/alternatives/message/hello_with_execute.ecf
@@ -11,9 +11,10 @@
+
-
+
diff --git a/examples/tutorial/step_2/hello/ewf.ini b/examples/tutorial/step_2/hello/ewf.ini
index fad6acb1..c29e92cc 100644
--- a/examples/tutorial/step_2/hello/ewf.ini
+++ b/examples/tutorial/step_2/hello/ewf.ini
@@ -1,4 +1,4 @@
-# For nino connector, use port 9999
+# For standalone connectors, use port 9999
port=9999
#verbose=true
diff --git a/examples/tutorial/step_2/hello/hello.ecf b/examples/tutorial/step_2/hello/hello.ecf
index 9df56668..097cfbd6 100644
--- a/examples/tutorial/step_2/hello/hello.ecf
+++ b/examples/tutorial/step_2/hello/hello.ecf
@@ -12,7 +12,7 @@
-
+
@@ -29,7 +29,7 @@
-
+
diff --git a/examples/tutorial/step_2/hello/src/custom_hello_application.e b/examples/tutorial/step_2/hello/src/custom_hello_application.e
index 701b91b9..5f0abe5c 100644
--- a/examples/tutorial/step_2/hello/src/custom_hello_application.e
+++ b/examples/tutorial/step_2/hello/src/custom_hello_application.e
@@ -2,19 +2,17 @@ note
description: "[
This class implements the `Hello World' service.
- It inherits from WSF_DEFAULT_RESPONSE_SERVICE to get default EWF connector ready
- only `response' needs to be implemented.
- In this example, it is redefined and specialized to be WSF_PAGE_RESPONSE
-
- `initialize' can be redefine to provide custom options if needed.
+ It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready
+ only `HELLO_EXECUTION' needs to be implemented.
+ `initialize' is redefined to provide custom options if needed.
]"
class
CUSTOM_HELLO_APPLICATION
inherit
- WSF_DEFAULT_RESPONSE_SERVICE
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
redefine
initialize
end
@@ -32,7 +30,7 @@ feature {NONE} -- Initialization
--| You can also uncomment the following line if you use the Nino connector
--| so that the server listens on port 9999
--| quite often the port 80 is already busy
--- set_service_option ("port", 9999)
+ set_service_option ("port", 9999)
--| Uncomment next line to have verbose option if available
-- set_service_option ("verbose", True)
@@ -41,13 +39,4 @@ feature {NONE} -- Initialization
Precursor
end
-feature {NONE} -- Initialization
-
- response (req: WSF_REQUEST): WSF_PAGE_RESPONSE
- -- Computed response message.
- do
- create Result.make
- Result.put_string ("Hello World")
- end
-
end
diff --git a/examples/tutorial/step_2/hello/src/hello_application.e b/examples/tutorial/step_2/hello/src/hello_application.e
index 41f77b0a..484fba8e 100644
--- a/examples/tutorial/step_2/hello/src/hello_application.e
+++ b/examples/tutorial/step_2/hello/src/hello_application.e
@@ -2,30 +2,20 @@ note
description: "[
This class implements the `Hello World' service.
- It inherits from WSF_DEFAULT_RESPONSE_SERVICE to get default EWF connector ready
- only `response' needs to be implemented.
- In this example, it is redefined and specialized to be WSF_PAGE_RESPONSE
-
- `initialize' can be redefine to provide custom options if needed.
+ It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready.
+ And implement HELLO_EXECUTION.
+ `initialize' can be redefine to provide custom options if needed,
+ such as specific port number.
]"
class
HELLO_APPLICATION
inherit
- WSF_DEFAULT_RESPONSE_SERVICE
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
create
make_and_launch
-feature {NONE} -- Initialization
-
- response (req: WSF_REQUEST): WSF_PAGE_RESPONSE
- -- Computed response message.
- do
- create Result.make
- Result.put_string ("Hello World")
- end
-
end
diff --git a/examples/tutorial/step_2/hello/src/hello_execution.e b/examples/tutorial/step_2/hello/src/hello_execution.e
new file mode 100644
index 00000000..2f3cd277
--- /dev/null
+++ b/examples/tutorial/step_2/hello/src/hello_execution.e
@@ -0,0 +1,35 @@
+note
+ description: "[
+ Request execution for Current application.
+ Implement `execute' based on `request' and `response'.
+ ]"
+ author: "$Author$"
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ HELLO_EXECUTION
+
+inherit
+ WSF_EXECUTION
+
+create
+ make
+
+feature -- Execution
+
+ execute
+ local
+ msg: WSF_PAGE_RESPONSE
+ do
+ create msg.make_with_body ("Hello World")
+ response.send (msg)
+
+ --| alternative would have been more low level
+ --| by setting the content type, and the content length which is 11 for "Hello World"
+ -- response.header.put_content_type_text_plain
+ -- response.header.put_content_length (11)
+ -- response.put_string ("Hello World")
+ end
+
+end
diff --git a/examples/tutorial/step_3.wiki b/examples/tutorial/step_3.wiki
index 5ed8dd00..d4858565 100644
--- a/examples/tutorial/step_3.wiki
+++ b/examples/tutorial/step_3.wiki
@@ -11,12 +11,12 @@ or go to [[step_4.wiki|step 4]]
== "hello" project ==
* Let's start from the "hello_custom" project
-* you will learn how to use the req: WSF_REQUEST argument
+* you will learn how to use the request: WSF_REQUEST argument
* See the hello project from [[step_3|step #3]] folder
* You can find code in [[step_3]] folder :
- response (req: WSF_REQUEST): WSF_HTML_PAGE_RESPONSE
+ message: WSF_HTML_PAGE_RESPONSE
-- Computed response message.
do
--| It is now returning a WSF_HTML_PAGE_RESPONSE
@@ -25,7 +25,7 @@ or go to [[step_4.wiki|step 4]]
Result.set_title ("EWF tutorial / Hello World!")
--| Check if the request contains a parameter named "user"
--| this could be a query, or a form parameter
- if attached req.string_item ("user") as l_user then
+ if attached request.string_item ("user") as l_user then
--| If yes, say hello world #name
Result.set_body ("Hello " + l_user + "!")
--| We should html encode this name
@@ -43,8 +43,8 @@ or go to [[step_4.wiki|step 4]]
end
--| note:
--| 1) Source of the parameter, we could have used
- --| req.query_parameter ("user") to search only in the query string
- --| req.form_parameter ("user") to search only in the form parameters
+ --| request.query_parameter ("user") to search only in the query string
+ --| request.form_parameter ("user") to search only in the form parameters
--| 2) response type
--| it could also have used WSF_PAGE_REPONSE, and build the html in the code
--|
diff --git a/examples/tutorial/step_3/hello/hello.ecf b/examples/tutorial/step_3/hello/hello.ecf
index b58272ca..000c2d3b 100644
--- a/examples/tutorial/step_3/hello/hello.ecf
+++ b/examples/tutorial/step_3/hello/hello.ecf
@@ -15,7 +15,7 @@
-
+
diff --git a/examples/tutorial/step_3/hello/src/hello_application.e b/examples/tutorial/step_3/hello/src/hello_application.e
index 6220e3f7..bbaea8a1 100644
--- a/examples/tutorial/step_3/hello/src/hello_application.e
+++ b/examples/tutorial/step_3/hello/src/hello_application.e
@@ -1,10 +1,9 @@
note
description: "[
- This class implements the `Hello World' service.
+ This class launch the HELLO_EXECUTION service.
- It inherits from WSF_DEFAULT_RESPONSE_SERVICE to get default EWF connector ready
- only `response' needs to be implemented.
- In this example, it is redefined and specialized to be WSF_PAGE_RESPONSE
+ It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready
+ only `HELLO_EXECUTION' needs to be implemented.
`initialize' can be redefine to provide custom options if needed.
@@ -14,7 +13,7 @@ class
HELLO_APPLICATION
inherit
- WSF_DEFAULT_RESPONSE_SERVICE
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
redefine
initialize
end
@@ -22,44 +21,6 @@ inherit
create
make_and_launch
-feature {NONE} -- Execution
-
- response (req: WSF_REQUEST): WSF_HTML_PAGE_RESPONSE
- -- Computed response message.
- do
- --| It is now returning a WSF_HTML_PAGE_RESPONSE
- --| Since it is easier for building html page
- create Result.make
- Result.set_title ("EWF tutorial / Hello World!")
- --| Check if the request contains a parameter named "user"
- --| this could be a query, or a form parameter
- if attached req.string_item ("user") as l_user then
- --| If yes, say hello world #name
- Result.set_body ("Hello " + l_user + "!")
- --| We should html encode this name
- --| but to keep the example simple, we don't do that for now.
- else
- --| Otherwise, ask for name
- Result.set_body ("[
-
- ]"
- )
- end
-
- --| note:
- --| 1) Source of the parameter, we could have used
- --| req.query_parameter ("user") to search only in the query string
- --| req.form_parameter ("user") to search only in the form parameters
- --| 2) response type
- --| it could also have used WSF_PAGE_REPONSE, and build the html in the code
- --|
-
- end
-
feature {NONE} -- Initialization
initialize
diff --git a/examples/tutorial/step_3/hello/src/hello_execution.e b/examples/tutorial/step_3/hello/src/hello_execution.e
new file mode 100644
index 00000000..652829db
--- /dev/null
+++ b/examples/tutorial/step_3/hello/src/hello_execution.e
@@ -0,0 +1,53 @@
+note
+ description: "Implementation of Hello world with form."
+ date: "$Date$"
+ revision: "$Revision$"
+
+class
+ HELLO_EXECUTION
+
+inherit
+ WSF_MESSAGE_EXECUTION
+
+create
+ make
+
+feature {NONE} -- Execution
+
+ message: WSF_HTML_PAGE_RESPONSE
+ -- Computed response message.
+ do
+ --| It is now returning a WSF_HTML_PAGE_RESPONSE
+ --| Since it is easier for building html page
+ create Result.make
+ Result.set_title ("EWF tutorial / Hello World!")
+ --| Check if the request contains a parameter named "user"
+ --| this could be a query, or a form parameter
+ if attached request.string_item ("user") as l_user then
+ --| If yes, say hello world #name
+ Result.set_body ("Hello " + l_user + "!")
+ --| We should html encode this name
+ --| but to keep the example simple, we don't do that for now.
+ else
+ --| Otherwise, ask for name
+ Result.set_body ("[
+
+ ]"
+ )
+ end
+
+ --| note:
+ --| 1) Source of the parameter, we could have used
+ --| request.query_parameter ("user") to search only in the query string
+ --| request.form_parameter ("user") to search only in the form parameters
+ --| 2) response type
+ --| it could also have used WSF_PAGE_REPONSE, and build the html in the code
+ --|
+
+ end
+
+end
diff --git a/examples/tutorial/step_4.wiki b/examples/tutorial/step_4.wiki
index 936424eb..8ee9f185 100644
--- a/examples/tutorial/step_4.wiki
+++ b/examples/tutorial/step_4.wiki
@@ -11,30 +11,30 @@ or go to the [[README.wiki|index]]
== "hello" project ==
* Let's start from the "hello" project
-* you will learn how to use the req: WSF_ROUTER component
+* you will learn how to use the WSF_ROUTER component
* See the hello project from [[step_4|step #4]] folder
* You can find code in [[step_4]] folder :
- To get a routed service based on URI Template, your service application class should inherit from WSF_URI_TEMPLATE_ROUTED_SERVICE
- then you need to implement "setup_router", the following code is from the step_4 example
+ To get a routed execution based on URI Template, your execution class should inherit from WSF_URI_TEMPLATE_ROUTED_EXECUTION
+ then you need to implement "setup_router". In addition you can inherit from WSF_ROUTED_URI_HELPER and WSF_ROUTED_URI_TEMPLATE_HELPER, in order to call user-friendly routine provided to work easily with uri, or uri-template mapping. the following code is from the step_4 example
setup_router
do
- router.map_agent ("/hello", agent execute_hello)
+ map_uri_agent ("/hello", agent execute_hello, Void)
- router.map_with_request_methods ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}, <<"GET", "POST">>)
- router.map_with_request_methods ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}, <<"GET", "POST">>)
+ map_uri_template ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}, <<"GET", "POST">>)
+ map_uri_template ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}, <<"GET", "POST">>)
- router.map_agent_response_with_request_methods ("/users/{user}/{?op}", agent response_user, <<"GET">>)
+ map_uri_template_response_agent ("/users/{user}/{?op}", agent response_user, <<"GET">>)
end
* map_agent is used to handle the url /hello with the feature "execute_hello"
-* map_agent_response_with_request_methods is similar but you precise the accepted request methods
-* map and map_with_request_method are similar to previous "agent" variant, but it is using a descendant of WSF_HANDLER to handle the related url.
+* map_agent_response is similar but you precise the accepted request methods
+* map is similar to previous "agent" variant, but it is using a descendant of WSF_HANDLER to handle the related request.
-* In this example, we use the URI Template router, this allows to define the route using resource like /user/{user} , and then you get access to the "user" data from the WSF_REQUEST.path_parameter or using the context argument passed for the execute or response handler.
+* In this example, we use the URI-Template router, this allows to define the route using resource like /user/{user} , and then you get access to the "user" data from the WSF_REQUEST.path_parameter or using the context argument passed for the execute or response handler.
* The example also includes basic notions of url, html encoding, check the hello.ecf to see the added libraries (http to get easy access to the http status code, encoder for simple encoding components)
----
diff --git a/examples/tutorial/step_4/hello/hello.ecf b/examples/tutorial/step_4/hello/hello.ecf
index 37cfd5d0..903ba32d 100644
--- a/examples/tutorial/step_4/hello/hello.ecf
+++ b/examples/tutorial/step_4/hello/hello.ecf
@@ -12,7 +12,7 @@
-
+
diff --git a/examples/tutorial/step_4/hello/src/hello_application.e b/examples/tutorial/step_4/hello/src/hello_application.e
index 3d0024a5..9e68dd41 100644
--- a/examples/tutorial/step_4/hello/src/hello_application.e
+++ b/examples/tutorial/step_4/hello/src/hello_application.e
@@ -3,7 +3,6 @@
This class implements the `Hello World' service.
It inherits from WSF_DEFAULT_SERVICE to get default EWF connector ready
- And from WSF_URI_TEMPLATE_ROUTED_SERVICE to use the router service
`initialize' can be redefine to provide custom options if needed.
@@ -13,9 +12,7 @@ class
HELLO_APPLICATION
inherit
- WSF_ROUTED_SERVICE
-
- WSF_DEFAULT_SERVICE
+ WSF_DEFAULT_SERVICE [HELLO_EXECUTION]
redefine
initialize
end
@@ -23,136 +20,6 @@ inherit
create
make_and_launch
-feature {NONE} -- Initialization
-
- setup_router
- do
--- router.map (create {WSF_URI_MAPPING}.make ("/hello", create {WSF_AGENT_URI_HANDLER}.make (agent execute_hello)))
- map_agent_uri ("/hello", agent execute_hello, Void)
-
--- router.map_with_request_methods (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}), router.methods_HEAD_GET_POST)
- map_uri_template ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}, router.methods_HEAD_GET_POST)
-
--- router.map_with_request_methods (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}), router.methods_GET_POST)
- map_uri_template ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}, router.methods_GET_POST)
-
--- router.map_with_request_methods (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/{?op}", create {WSF_AGENT_URI_TEMPLATE_RESPONSE_HANDLER}.make (agent response_user)), router.methods_GET)
- map_agent_uri_template_response ("/users/{user}/{?op}", agent response_user, router.methods_GET)
- end
-
-feature -- Helper: mapping
-
- map_agent_uri (a_uri: READABLE_STRING_8; a_action: like {WSF_URI_AGENT_HANDLER}.action; rqst_methods: detachable WSF_REQUEST_METHODS)
- do
- router.map_with_request_methods (create {WSF_URI_MAPPING}.make (a_uri, create {WSF_URI_AGENT_HANDLER}.make (a_action)), rqst_methods)
- end
-
- map_uri_template (a_tpl: READABLE_STRING_8; a_handler: WSF_URI_TEMPLATE_HANDLER; rqst_methods: detachable WSF_REQUEST_METHODS)
- do
- router.map_with_request_methods (create {WSF_URI_TEMPLATE_MAPPING}.make (a_tpl, a_handler), rqst_methods)
- end
-
- map_agent_uri_template_response (a_tpl: READABLE_STRING_8; a_action: like {WSF_URI_TEMPLATE_RESPONSE_AGENT_HANDLER}.action; rqst_methods: detachable WSF_REQUEST_METHODS)
- do
- router.map_with_request_methods (create {WSF_URI_TEMPLATE_MAPPING}.make (a_tpl, create {WSF_URI_TEMPLATE_RESPONSE_AGENT_HANDLER}.make (a_action)), rqst_methods)
- end
-
-feature -- Execution
-
- execute_hello (req: WSF_REQUEST; res: WSF_RESPONSE)
- -- Computed response message.
- local
- mesg: WSF_HTML_PAGE_RESPONSE
- s: STRING_8
- l_user_name: READABLE_STRING_32
- do
- --| It is now returning a WSF_HTML_PAGE_RESPONSE
- --| Since it is easier for building html page
- create mesg.make
- mesg.set_title ("EWF tutorial / Hello World!")
- --| Check if the request contains a parameter named "user"
- --| this could be a query, or a form parameter
- if attached {WSF_STRING} req.item ("user") as u then
- --| If yes, say hello world #name
-
- l_user_name := (create {HTML_ENCODER}).decoded_string (u.value)
-
- s := "
")
- mesg.set_body (s)
- --| We should html encode this name
- --| but to keep the example simple, we don't do that for now.
- else
- --| Otherwise, ask for name
- s := (create {HTML_ENCODER}).encoded_string ({STRING_32} "Hello / ahoj / नमस्ते / Ciào / مرحبا / Hola / 你好 / Hallo / Selam / Bonjour ")
- s.append ("[
-
- ]"
- )
- mesg.set_body (s)
- end
-
- --| note:
- --| 1) Source of the parameter, we could have used
- --| req.query_parameter ("user") to search only in the query string
- --| req.form_parameter ("user") to search only in the form parameters
- --| 2) response type
- --| it could also have used WSF_PAGE_REPONSE, and build the html in the code
- --|
-
- res.send (mesg)
- end
-
- response_user (req: WSF_REQUEST): WSF_RESPONSE_MESSAGE
- -- Computed response message.
- local
- html: WSF_HTML_PAGE_RESPONSE
- redir: WSF_HTML_DELAYED_REDIRECTION_RESPONSE
- s: STRING_8
- l_username: STRING_32
- do
- if attached {WSF_STRING} req.path_parameter ("user") as u then
- l_username := (create {HTML_ENCODER}).general_decoded_string (u.value)
- if
- attached {WSF_STRING} req.query_parameter ("op") as l_op
- then
- if l_op.is_case_insensitive_equal ("quit") then
- create redir.make (req.script_url ("/hello"), 3)
- create html.make
- redir.set_title ("Bye " + html.html_encoded_string (l_username))
- redir.set_body ("Bye " + html.html_encoded_string (l_username) + ", see you soon.
You will be redirected to " +
- redir.url_location + " in " + redir.delay.out + " second(s) ...
"
- )
- Result := redir
- else
- create html.make
- html.set_title ("Bad request")
- html.set_body ("Bad request: unknown operation '" + l_op.url_encoded_value + "'.")
- Result := html
- end
- else
- create html.make
-
- s := "
User '" + html.html_encoded_string (l_username) + "'!
")
- html.set_title ("User '" + u.url_encoded_value + "'")
- html.set_body (s)
- Result := html
- end
- else
- create html.make
- html.set_title ("Bad request")
- html.set_body ("Bad request: missing user parameter")
- Result := html
- end
- end
-
feature {NONE} -- Initialization
initialize
@@ -163,8 +30,6 @@ feature {NONE} -- Initialization
--| If you don't need any custom options, you are not obliged to redefine `initialize'
Precursor
- --| Initialize router
- initialize_router
end
diff --git a/examples/tutorial/step_4/hello/src/hello_execution.e b/examples/tutorial/step_4/hello/src/hello_execution.e
new file mode 100644
index 00000000..8f95d03a
--- /dev/null
+++ b/examples/tutorial/step_4/hello/src/hello_execution.e
@@ -0,0 +1,135 @@
+note
+ description: "[
+ This class implements the `Hello World' execution service.
+
+ It inherits from WSF_ROUTED_EXECUTION to use the router service
+ and from WSF_ROUTED_URI_TEMPLATE_HELPER to use help feature to map
+ uri-template routes
+ ]"
+
+class
+ HELLO_EXECUTION
+
+inherit
+ WSF_ROUTED_EXECUTION
+
+ WSF_ROUTED_URI_HELPER
+ WSF_ROUTED_URI_TEMPLATE_HELPER
+
+create
+ make
+
+feature {NONE} -- Initialization
+
+ setup_router
+ do
+-- router.map (create {WSF_URI_MAPPING}.make ("/hello", create {WSF_AGENT_URI_HANDLER}.make (agent execute_hello)))
+ map_uri_agent ("/hello", agent execute_hello, Void)
+
+-- router.map (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}), router.methods_HEAD_GET_POST)
+ map_uri_template ("/users/{user}/message/{mesgid}", create {USER_MESSAGE_HANDLER}, router.methods_HEAD_GET_POST)
+
+-- router.map (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}), router.methods_GET_POST)
+ map_uri_template ("/users/{user}/message/", create {USER_MESSAGE_HANDLER}, router.methods_GET_POST)
+
+-- router.map (create {WSF_URI_TEMPLATE_MAPPING}.make ("/users/{user}/{?op}", create {WSF_AGENT_URI_TEMPLATE_RESPONSE_HANDLER}.make (agent response_user)), router.methods_GET)
+ map_uri_template_response_agent ("/users/{user}/{?op}", agent response_user, router.methods_GET)
+ end
+
+feature -- Execution
+
+ execute_hello (req: WSF_REQUEST; res: WSF_RESPONSE)
+ -- Computed response message.
+ local
+ mesg: WSF_HTML_PAGE_RESPONSE
+ s: STRING_8
+ l_user_name: READABLE_STRING_32
+ do
+ --| It is now returning a WSF_HTML_PAGE_RESPONSE
+ --| Since it is easier for building html page
+ create mesg.make
+ mesg.set_title ("EWF tutorial / Hello World!")
+ --| Check if the request contains a parameter named "user"
+ --| this could be a query, or a form parameter
+ if attached {WSF_STRING} req.item ("user") as u then
+ --| If yes, say hello world #name
+
+ l_user_name := (create {HTML_ENCODER}).decoded_string (u.value)
+
+ s := "
")
+ mesg.set_body (s)
+ --| We should html encode this name
+ --| but to keep the example simple, we don't do that for now.
+ else
+ --| Otherwise, ask for name
+ s := (create {HTML_ENCODER}).encoded_string ({STRING_32} "Hello / ahoj / नमस्ते / Ciào / مرحبا / Hola / 你好 / Hallo / Selam / Bonjour ")
+ s.append ("[
+
+ ]"
+ )
+ mesg.set_body (s)
+ end
+
+ --| note:
+ --| 1) Source of the parameter, we could have used
+ --| req.query_parameter ("user") to search only in the query string
+ --| req.form_parameter ("user") to search only in the form parameters
+ --| 2) response type
+ --| it could also have used WSF_PAGE_REPONSE, and build the html in the code
+ --|
+
+ res.send (mesg)
+ end
+
+ response_user (req: WSF_REQUEST): WSF_RESPONSE_MESSAGE
+ -- Computed response message.
+ local
+ html: WSF_HTML_PAGE_RESPONSE
+ redir: WSF_HTML_DELAYED_REDIRECTION_RESPONSE
+ s: STRING_8
+ l_username: STRING_32
+ do
+ if attached {WSF_STRING} req.path_parameter ("user") as u then
+ l_username := (create {HTML_ENCODER}).general_decoded_string (u.value)
+ if
+ attached {WSF_STRING} req.query_parameter ("op") as l_op
+ then
+ if l_op.is_case_insensitive_equal ("quit") then
+ create redir.make (req.script_url ("/hello"), 3)
+ create html.make
+ redir.set_title ("Bye " + html.html_encoded_string (l_username))
+ redir.set_body ("Bye " + html.html_encoded_string (l_username) + ", see you soon.
You will be redirected to " +
+ redir.url_location + " in " + redir.delay.out + " second(s) ...
"
+ )
+ Result := redir
+ else
+ create html.make
+ html.set_title ("Bad request")
+ html.set_body ("Bad request: unknown operation '" + l_op.url_encoded_value + "'.")
+ Result := html
+ end
+ else
+ create html.make
+
+ s := "
User '" + html.html_encoded_string (l_username) + "'!
")
+ if not res.header_committed then
+ res.put_header_text ("Content-Type: text/html%R%NContent-Length: " + s.count.out + "%R%N%R%N")
+ end
if res.message_writable then
- res.put_string ("