nephos-server 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd4f2176f42e827ebb36ac19f651e3adb12e7609
-  data.tar.gz: 99677cc04947d8c967c358d8e2cc8dab847e5879
+  metadata.gz: a7a62dad08b09b531aab62f3e9800f65ec7e849d
+  data.tar.gz: ffd36f823891ca5141950551e6e3de7984f8b8d4
 SHA512:
-  metadata.gz: 4d609afb7b502b5ab9831f289b0029cecfbe0ea3ccf8c8c86686df86e575eb1021a8b73b7f39fc4449ce00cecd0c018b264f322d5cfcbce8977345bc65e67824
-  data.tar.gz: 1db01ad58ca2bec79883ca541b8e6d6bd436fea5622b4f0fe193fdcecc1864a917ea3595fe7c8347d0678be3d5d30e4168f5d462ecfdbda00f85886f78b3f291
+  metadata.gz: 58a3d571167c75ccd6ebc97bc56fd4ec44c766b1dccfe3748746b467e44db39d3fe3ea3cd8588fdb3b53f92f692f0fd5b28fafe87537e4e4b7910637a84e90df
+  data.tar.gz: bbf86241ed2a7671d81b84cdea1c32960ef0e698ff29a0b37c246a2f7d0940b0d12ad13f14f5d1a7d606a53c55da93b44bf85ed6f9bb5a52ea0b7235c2882540

data.tar.gz.sig

@@ -0,0 +1,4 @@
+��β�G����Г��kp-Ĥ�V�v�`'#�%��?�{��yjq���7��-��A�\,wX`6a���jV?Vt7vk1a`{����X����X�7�
+G��0��S��	��c���O1����Ţ:�ɵ�uUD#�)�;m�m����@��%D�wO��m�*���퉊�1j�۽<�J'��R
+Z`�ɀ����۶B��#�Ln�ÒrRK�jzl
+��<��������a&�(M�-�FS����)I��9�r�

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.6.4
+	* Fix application generator (replace in the gemfile nephos-server by nephos)
+        * Improve guides (more doc, corrections, update)
+	* Certificate for sign the gem
+
 v0.6.3
         * Add customisable default error page
 

data/DOCUMENTATION/API_RENDER.md

@@ -1,7 +1,6 @@
 # Render API
 
 ## Understand the API
-
 The render API is a simple system to allows you to render HTTP responses to a client.
 The API allows you to customize differents parts of the response:
 
@@ -13,22 +12,21 @@ The API use the returns of the Controllers methods to build the HTTP responses.
 
 
 ## Use the API
-
 To use the API, you have to create a new controller.
-The controller must be placed or requires in the ``app/`` directory,
-via a ``file.rb`` file.
-It must contain a class, wich inherit from ``Nephos::Controller``.
-Each public method can be an entry point, defined in the ``routes.rb`` file.
-[Routing doc](GUIDE_ROUTING.md).
+The controller must be placed or requires in the ``app/`` directory. Check the
+[Guide about the controller](GUIDE_CONTROLLER.md).
+
+It must contain a class, inheriting from ``Nephos::Controller``.
+Each public method **can** be an entry point, defined in the ``routes.rb`` file.
+[Routing documentation](GUIDE_ROUTING.md).
 
 In the controller, you can use few helpers,
-like the method ``params()``, ``env()``, and ``infos()``
+like the method ``params()`` and ``cookies``
 
 The methods used as entry point must return a ``Hash`` described in the following lines.
 It may optionnaly be an ``Integer``, to return only a status, or ``:empty``.
 
 ## Options
-
 The returns of a Controller method can include the following keys:
 
 - :plain
@@ -57,14 +55,12 @@ end
 The following sections will describe how each key works and modify the HTTP response.
 
 ### Content
-
 The ``:content`` key must be associated with a ``String`` (or ``Hash`` is json).
 
 **Optionnal**:
 a default value is provided, based on the ``:status`` if no ``:content`` if specified.
 
 ### Type
-
 The ``:type`` key has to be associated with a ``String`` matching with **"kind/type"**.
 
 **Optionnal**:
@@ -74,13 +70,11 @@ Kinds and Types (called type and sub-type by w3c) are described here:
 [the w3c documentation](http://www.w3.org/Protocols/rfc1341/4_Content-Type.html)
 
 #### Kind:
-
 - image
 - text
 - ...
 
 #### Type:
-
 - plain
 - javascript
 - jpeg
@@ -88,7 +82,6 @@ Kinds and Types (called type and sub-type by w3c) are described here:
 
 
 ### Status
-
 The ``:status`` key is associable with an Integer. It must represent the HTTP status code.
 
 **Optionnal**:
@@ -98,7 +91,6 @@ The default value is 200.
 
 
 ### Plain, HTML, JSON
-
 The keys ``:plain``, ``:html``, ``:json`` can replace both ``:content`` ``:type``.
 It is associated like ``:content`` and **replace automaticaly the type**.
 

data/DOCUMENTATION/GUIDE_CONTROLLER.md

@@ -3,5 +3,69 @@
 ## Intern architecture
 
 ### Cookies
+You can set cookies and get them via ``cookies`` in the body of any controller.
 
-You can set cookies and get them via ``cookies`` in the body of the controller.
+### Params
+You can access to the parameters (defined by http or via the URI, based on your
+routing rules).
+They are accessible via ``params`` in the body of every controller.
+
+### Hooks
+You can define hooks, which are some methods, called every times, before or
+after a call to a routed method. There is 2 kinds of hook actually:
+
+- after_action
+- before_action
+
+Each of them will be called juste before or after calling the method requested.
+It means that the cookies are not saved yet (so you can change them, etc.)
+
+The hooks are defined by calling the methods ``after_action`` or
+``before_action``, out of a method, usually on the top of the controller.
+
+Hooks take 1 or 2 arguments.
+- The first is the name of the method to call.
+- The second, **optional**, is a hash, containing ``:only`` or ``:except``
+  keys, associated to an Array or Symbol or one Symbol. Each symbol represents
+  a method triggering the hook.
+
+**Note: If there is no 2sd argument, then the hook is triggered every times.**
+
+**Note: except is not already implemented**
+
+Example:
+```ruby
+class MainController < Nephos::Controller
+
+  before_action :fct_before_all
+  before_action :fct_before_root, only: [:root]
+  after_action :fct_after_root, only: :root
+
+  def fct_before_all
+    # puts "BEFORE ALL"
+  end
+
+  def fct_before_root
+    # puts "BEFORE"
+  end
+
+  def fct_after_root
+    # puts "AFTER"
+  end
+
+  def root
+    # puts "ROOT"
+    cookies["a"] = "b"
+    cookies.delete("b").to_h
+    # puts "Cookies from the root:", cookies
+    {
+      json: {
+        list: $dataset,
+        add: '/add',
+        rm: '/rm',
+      }
+    }
+  end
+
+end
+```

data/DOCUMENTATION/GUIDE_ROUTER.md

@@ -1,25 +1,30 @@
 # Routing Guide
 
-## How the routes are inputed by the client ?
-
+### How the routes are inputed by the client ?
 Each HTTP request made by the client will contains a **REQUEST_URI** value.
 The web server receive this information, and will choose what to do,
 based on the rules you will define.
 
-## How to define the rules ?
-
-You have to write the rules in the ``/routes.rb`` file.
+### How to define the rules ?
+The rules definitions are writen in the ``/routes.rb`` file.
 Few helpers are provided to make the job easier.
-They will be described in the following section.
+They will be described in the section ([helpers](#the-helpers)).
+
+### Is there default rules ?
+No there is not, but, there is still 2 kind of response that you cannot route:
+
+1. If you did not write the route requested, then it will be a 404 error.
+2. If the controller contains errors (not a valid return, or uncaught exception), then a 505 is returned.
+
+To handle these errors, your should see [error guide](GUIDE_ERRORS.md).
 
-## The helpers
 
+## The helpers
 As every HTTP request requires an HTTP verb, there is 4 helpers to handle them.
 ``get``, ``post``, ``put``, ``add_route``. Indeed, there is 3 main verbs (GET POST PUT).
 But as you can need to create other verbs (DELETE, PATCH, ...), we allows you to handle them.
 
 ### add_route
-
 The method ``add_route`` take 2 arguments.
 
 1. verb (has to be a string, upcase as possible, like **GET**)
@@ -32,39 +37,54 @@ The option argument must contains the 3 following keys:
 - ``:method``: the method of the controller that will be used to compute and render a result to the client.
 
 As example, yuo can write:
-
 ```ruby
 add_route "GET", url: "/tmp", controller: "MyController", method: "tmp"
 ```
 
 ### get post put
-
 Theses 3 helpers allows you to use ``add_route`` without the first argument.
 
+Example:
+```ruby
+get url: "/tmp", controller: "MyController", method: "tmp"
+post url: "/tmp", controller: "MyController", method: "tmp"
+```
 ### resource
-
 This method takes 1 parameter and 1 block.
 The parameter is a partial url, and the bloc, other routes.
 
 Resource can be chained many times.
-For Example, you can do this:
 
+For example, you can do this:
 ```ruby
 resource "user" do
+get url: "/index", controller: "UserController", method: "show" # /user/index
   resource "informations" do
-    get url: "/index", controller: "UserController", method: "show" # /user/informations/index
+    get url: "/", controller: "UserController", method: "show" # /user/informations/
   end
 end
 ```
 
-It will generate the route ``/home/index``, calling the ``MainController#root`` method.
-
-
 ## URL Parameters
+The parameters can be passed through the URL. To allow a resource to have
+parameters, you will have to place a  ``/:param`` in your route rules. The
+parameter will be placed in the controller in the ``params`` method, an be
+accessible via ``params[:param]``. This is the reason why you should never
+have 2 URL parameters with the same name, because only the last will be usable.
 
-**TODO: more documentation**
-
-place a ``/:param`` in your route. The parameter will be placed in the controller in the ``params`` method
+Example:
+```ruby
+resource "user" do
+  get url: "/:id", controller: "UserController", method: "show" # /user/(anything)
+end
+resource "static" do
+  resource ":page" do
+    get url: "/", controller: "StaticPageController", method: "show" # /static/(anything)
+    get url: "/edit", controller: "StaticPageController", method: "edit" # /static/(anything)/edit
+    put url: "/", controller: "StaticPageController", method: "update" # /static/(anything)
+  end
+end
+```
 
 ## Notes
 

data/README.md

@@ -19,7 +19,6 @@ Features which will not be provided by nserver:
   - [Sequel](DOCUMENTATION/DATABASE/SEQUEL.md)
 
 # Start
-
 ```sh
 gem install nephos # download the server and executables
 ngenerator application MyApp # generate the application
@@ -39,7 +38,6 @@ nserver -p 8080 -h 0.0.0.0 # start the server. port is not required, neither hos
 # Documentation
 
 ## Guides
-
 Theses guides will provide you knowlegde about everything you can use in the application.
 
 - [Generator GUIDE](DOCUMENTATION/GUIDE_GENERATOR.md)
@@ -51,16 +49,16 @@ Theses guides will provide you knowlegde about everything you can use in the app
 
 ## Examples
 
-### Production
-
-To avoid information leaks from your application, set the environment variable ``export ENVIRONMENT=production``,
-or run the server with ``-e production`` parameter.
-It will disable ruby error messages when an error occurs in the controller.
+### Production and environment
+To avoid information leaks from your application, set the environment variable
+``export ENVIRONMENT=production``, or run the server with ``-e production``
+parameter. When an error occurs, the backtrace will be print to the client in
+the rendered page, unless the server runs in production environment.
 
 ### Controller
-
+Every routes will call a method from a controller.
 To create a controller, add a ruby file to ``app/``, with a class inherited by ``Nephos::Controller``
-The basic code of a controller can be generated via ``ngenerator controller NAME``.
+You should user ``ngenerator --controller NAME`` to generate a new controller.
 
 ```ruby
 class Example < Nephos::Controller
@@ -76,7 +74,6 @@ end
 ```
 
 ### Rendering
-
 To render a content to the client, you can return informations from a Controller method:
 
 ```ruby
@@ -91,7 +88,6 @@ return :empty
 ```
 
 ### Routing
-
 The routing (rules to execute the action the user wants), you have to write the ``/routes.rb`` file.
 If the user try to access an url not described in the file, it will automaticaly render a 404 not found.
 
@@ -111,13 +107,14 @@ end
 # Developers: Roadmap
 
 ## TODO v0.6
-- feature to change HTTP header from controller
+- Alias for routing
 - functionnal tests
+- extension for urls (optional .xxx, with controller effect)
 
 ## TODO v0.7
+- feature to change HTTP header from controller
 - Documentation on architecture (UML)
 - Improved documentation (Tutorial, Improved guides)
-- Alias for routing
 
 ## v1 requierements
 - Environement, Daemons, Port, Listen Host, Routables, Arguments

data/bin/nephos-generator

@@ -9,7 +9,7 @@ require_relative '../lib/nephos-server/bin-helpers'
 GEMFILE = <<EOF
 source 'https://rubygems.org'
 
-gem 'nephos-server'
+gem 'nephos'
 EOF
 
 ROUTE_RB = <<EOF

data/lib/nephos-server/router/main.rb

@@ -73,7 +73,7 @@ module Nephos
       rescue => err
         STDERR.puts "Error: #{err.message}"
         STDERR.puts err.backtrace
-        return error_custom(req, 500, "Error: 500\n#{err.message}\n---Backtrace---\n#{err.backtrace.join("\n")}\n")
+        return error_custom(req, 500, "#{err.message}\n---Backtrace---\n#{err.backtrace.join("\n")}\n")
       end
     end
 

data/nephos-server.gemspec

@@ -60,8 +60,9 @@ nephos-status
 )
   s.homepage    = 'https://github.com/pouleta/NephosRubyServer'
   s.license     = 'GNU/GPLv3'
-  #s.cert_chain  = ['certs/poulet_a.pem']
-  #s.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  s.cert_chain  = ['certs/nephos.pem']
+  s.signing_key = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
 
   # s.add_dependency 'nephos', '~> 1.0'
   s.add_dependency 'nomorebeer', '~> 1.1'

data/test/functional/generator.rb

@@ -9,7 +9,23 @@ class TestNephosServerGenerator < Test::Unit::TestCase
     assert(File.exists? "/tmp/nephos-server-test/routes.rb")
     assert(Dir.exists? "/tmp/nephos-server-test/app")
     gemfile_data = File.read("/tmp/nephos-server-test/Gemfile").split("\n")
-    assert(gemfile_data.include? "gem 'nephos-server'")
+    assert(gemfile_data.include? "gem 'nephos'")
+    `rm -rf /tmp/nephos-server-test 2> /tmp/null`
+  end
+
+  def test_generator_application_with_build
+    `rm -rf /tmp/nephos-server-test 2> /tmp/null`
+
+    `./bin/nephos-generator --test -a /tmp/nephos-server-test --no-git`
+    assert(Dir.exists? "/tmp/nephos-server-test")
+    assert(File.exists? "/tmp/nephos-server-test/Gemfile")
+    assert(File.exists? "/tmp/nephos-server-test/routes.rb")
+    assert(Dir.exists? "/tmp/nephos-server-test/app")
+    gemfile_data = File.read("/tmp/nephos-server-test/Gemfile").split("\n")
+    assert(gemfile_data.include? "gem 'nephos'")
+    gemfile_lock_data = File.read("/tmp/nephos-server-test/Gemfile.lock").split
+    assert(gemfile_lock_data.include? "nephos")
+    assert(gemfile_lock_data.include? "nephos-server")
     `rm -rf /tmp/nephos-server-test 2> /tmp/null`
   end
 

data/version

@@ -1 +1 @@
-0.6.3
+0.6.4

metadata

@@ -1,14 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: nephos-server
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - poulet_a
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDljCCAn6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBIMRYwFAYDVQQDDA1hcnRo
+  dXIucG91bGV0MRkwFwYKCZImiZPyLGQBGRYJY3J5cHRvbGFiMRMwEQYKCZImiZPy
+  LGQBGRYDbmV0MB4XDTE1MTAwMzIxNTQyMFoXDTE2MTAwMjIxNTQyMFowSDEWMBQG
+  A1UEAwwNYXJ0aHVyLnBvdWxldDEZMBcGCgmSJomT8ixkARkWCWNyeXB0b2xhYjET
+  MBEGCgmSJomT8ixkARkWA25ldDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
+  ggEBANnLB9vH7/O0aUWi0f9VtC7F73zMC1OvxDaJq+qIcmGBFiKPOngDCRyKffWf
+  A6gyf7VsJAlDVFYoyNw7bzLFjBT9gkb5xmED3Uaxvt8Ax131YvKv0sTsQeiTVHHW
+  1crq7266hW1McrFU2A1uQRV8FHuruUJBuP7UUYK7fZi0barbkdAIb4VvQFZxXByI
+  lKdQSuhu8k0RcG1vTACEsQXJIUImc8CWMi8/TG3HidJdASMvIWtV2rNQXlQ+UgIc
+  UeHC0p+SNTrc09H6q+5eH8NRYhJ91xKuLXv7NNy8M3quAMHcQ1GM6DWljc+Jc4cm
+  uAPQMYJf7Vy6OzWLoEiv2QU6sE0CAwEAAaOBijCBhzAJBgNVHRMEAjAAMAsGA1Ud
+  DwQEAwIEsDAdBgNVHQ4EFgQU08cDEZOTZNjP/0+E2unJWyw4NzQwJgYDVR0RBB8w
+  HYEbYXJ0aHVyLnBvdWxldEBjcnlwdG9sYWIubmV0MCYGA1UdEgQfMB2BG2FydGh1
+  ci5wb3VsZXRAY3J5cHRvbGFiLm5ldDANBgkqhkiG9w0BAQUFAAOCAQEAo60BuRZM
+  5Vtn0H0kHHTPiXz09lwxx4cFpTqrTTM0T6qM3gKsR5eLyR1Rt5hGmYLPgY4ZW4zI
+  XcuDbgRJrczZs7AZNy5NXyVWpxCwkZzklpbGTuYQdFz7mKfVyALjLjrilOIktXcz
+  PvB7EoLlqYvq9cnwV3WE1MkRcBd07xpofcp0kxae2dCOZPUq24TcNaRe7Utw6jjA
+  iL0bcH7zZkzMsNoNpPAgsd3ovU4Mf9M+A3M8COmd7KzKyZ0k7P12u5InPWUsNQS2
+  tcYkgfqUJPitIJx1RvWZpIyH5uJhRUYK3+vU9nMOxez5WbIlC1TtpByKAPMX+sht
+  gib3AoIT8jh/2w==
+  -----END CERTIFICATE-----
+date: 2015-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nomorebeer
@@ -141,7 +164,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: "* Improve daemons * Improve Rakefile and tests structure * Add few functional
-  (router, server, generator) tests * Add new unitary tests"
+summary: "* Fix application generator (replace in the gemfile nephos-server by nephos)"
 test_files: []
 has_rdoc: