nephos-server 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0c699cab58ca0ec6248b17674081ac621137843
-  data.tar.gz: 6ac12538e8f294cefe7c1881ef5eef6a182917b2
+  metadata.gz: 109c4c4ca9d472b6b5f0dd35a2bf6588faacbf52
+  data.tar.gz: a1fc6c4863ca689e02bb6f777bd24dbbacf5de1b
 SHA512:
-  metadata.gz: 5ff2cd7da5ee44559e590165c79c0530fdb3bf55b78a27c00f896e4c58e6106165db0d9be62669c33c6466607ff36288aef85a0ba4b191b19eb6103635d69077
-  data.tar.gz: 12f799ef408edcc5b8ef980999a62f35d0cd3277f22af71c6c0770945e4fa23cda3b871b465e84db69832ba87773fb511b9698b5effb9a9ca25ce4096fc53d68
+  metadata.gz: b9c9fad3377f4107a74a3ecf94ee52b05d69b8b8b2c69d17083afcca5f0daaef7ab85bf0160092dc080326e95cd388126d2dfd7e64012fee45029bf3b190413a
+  data.tar.gz: c63beb9a5addc4f40bddb07628738765344ff56181782de060210caad96ebb814086a5a63e3d9a655f05baddcf2f5efeda7d7074c232480d3d73c3cf94126a3c

data/README.md

@@ -6,21 +6,30 @@
 
 [![Code Climate](https://codeclimate.com/github/pouleta/NephosRubyServer/badges/gpa.svg)](https://codeclimate.com/github/pouleta/NephosRubyServer)
 
-This is a simple web server, based on rack and puma, with a minimal help:
+This is a minimal web server, based on [rack](TODO LINK) and [puma](TODO LINK).
+It is written in ruby. It also gives you a minimal architecture
+to speed up your application creation.
 
-- Controllers
-- Rendering
-- Routing
+Features provided:
 
-No templating, no database by default. They are extensions of your choice.
+- Controllers: gives you a resource logic.
+- Render: easier render content to the client.
+- Router: create a robust and simple routing system, with url variables.
+
+Features wich will not be provided by nephos-server:
+
+- Templating (HTML with variables, loops, ...): It already exists and they are easy to implement.
+  - [Slim](DOCUMENTATION/TEMPLATING/SLIM.md)
+- Database orm and connector: It already exists and simple to implement
+  - [Sequel](DOCUMENTATION/DATABASE/SEQUEL.md)
 
 # Start
 
 ```sh
-gem install nephos-server
-nephos-generator application MyApp
-cd MyApp
-nephos-server -p 8080 # port is not required
+gem install nephos-server # download the server
+nephos-generator application MyApp # generate the application
+cd MyApp # go in
+nephos-server -p 8080 # start the server. port is not required
 ```
 
 
@@ -28,14 +37,17 @@ nephos-server -p 8080 # port is not required
 
 ## Guides
 
-### [Render API](DOCUMENTATION/API_RENDER.md)
-### [Router GUIDE](DOCUMENTATION/GUIDE_ROUTER.md)
+Theses guides will provide you knowlegde about everything you can use in the application.
+
+- [Generator GUIDE](DOCUMENTATION/GUIDE_GENERATOR.md)
+- [Render API](DOCUMENTATION/API_RENDER.md)
+- [Router GUIDE](DOCUMENTATION/GUIDE_ROUTER.md)
 
 ## Examples
 
 ### Controller
 
-To create a controller, simply add a ruby code file to ``app/``, with a class inherited by ``Nephos::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 ``nephos-generator controller NAME``.
 
 ```ruby
@@ -52,7 +64,7 @@ end
 
 ### Rendering
 
-In a controller, use:
+To render a content to the client, you can return informations from a Controller method:
 
 ```ruby
 return {status: code}
@@ -66,29 +78,31 @@ return :empty
 
 ### Routing
 
-Like in ``/routes.rb``, you have to route manually the api.
+The routing (rules to execute the action the user wants), you have to write the ``/routes.rb`` file.
+if the user try to access to an url not described in the file, it will automaticaly render a 404 not found.
 
 ```ruby
 get url: "/", controller: "MainController", method: "root"       # /
 get url: "/add", controller: "MainController", method: "add_url" # /add
-get url: "/add/:url", controller: "MainController", method: "add_url" # /add
+get url: "/add/:url", controller: "MainController", method: "add_url" # /add with parameter :url
 get url: "/rm", controller: "MainController", method: "rm_url"   # /rm
-get url: "/rm/:url", controller: "MainController", method: "rm_url"   # /rm
+get url: "/rm/:url", controller: "MainController", method: "rm_url"   # /rm with parameter :url
 resource "infos" do
   get url: "/", controller: "MainController", method: "root" # generate /infos
+  get url: "/abbout", controller: "MainController", method: "root" # generate /infos/about
 end
 ```
 
 
 # Developers: Roadmap
 
-## TODO v0.3
-- Improve documentation (fix english, increase coverage, ...)
-- Improve unitary test coverage
+## TODO v0.4
+- improve generator with application status, tests, more generation (routing, ...)
 
 ## TODO v1
 - Improved Routing (more helper options)
 - Improved Rendering (more options)
+- Customisable errors (404 noticely, and 500)
 - Guide about
   - Controllers
   - Routing

data/lib/nephos-server/controller.rb

@@ -1,7 +1,7 @@
 module Nephos
   class Controller
 
-    attr_reader :env, :infos, :callpath
+    attr_reader :env, :infos, :callpath, :params
 
     # @param env [Hash] env extracted from the http request
     # @param parsed [Hash] pre-parsed env with parameters, ...
@@ -16,14 +16,10 @@ module Nephos
       @infos= parsed
       @callpath= callpath
       @params= parsed[:args]
-      @params.merge! Params.new(Hash[callpath[:params].zip @infos[:path]])
-      @params.select!{|k,v|k}
+      @params.merge! Hash[callpath[:params].zip @infos[:path]]
+      @params.select!{|k,v| not k.to_s.empty?}
+      @params = Params.new(@params)
     end
 
-    def arguments
-      @params
-    end
-    alias :params :arguments
-
   end
 end

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

@@ -56,40 +56,6 @@ module Nephos
   end
 end
 
-def route_prefix
-  @route_prefix ||= []
-  File.join(["/"] + @route_prefix)
-end
-
-def add_route(what, verb)
-  raise InvalidRoute unless what.is_a? Hash
-  what[:url] = File.expand_path File.join(route_prefix, what[:url])
-  Nephos::Router.check!(what)
-  Nephos::Router.add_params!(what)
-  Nephos::Router.add(what, verb)
-end
-
-# @param what [Hash]
-def get what
-  add_route what, "GET"
-end
-
-# @param what [Hash]
-def post what
-  add_route what, "POST"
-end
-
-# @param what [Hash]
-def put what
-  add_route what, "PUT"
-end
-
-def resource(name, &block)
-  @route_prefix ||= []
-  @route_prefix << name
-  block.call
-  @route_prefix.pop
-end
-
+require_relative 'helpers'
 load 'routes.rb'
 puts

data/test/controller.rb

@@ -16,4 +16,10 @@ class TestNephosServerController < Test::Unit::TestCase
     assert_raise do Nephos::Controller.new({}, {path: [], args: nil}, {params: {}}) end
   end
 
+  def test_controller_params
+    c = Nephos::Controller.new(env={}, {path: ["value"], args: {}}, {params: ["param"]})
+    assert_equal "value", c.params[:param]
+    assert_equal "value", c.params["param"]
+  end
+
 end

data/test/router.rb

@@ -6,13 +6,91 @@ end
 
 class TestNephosServerRouter < Test::Unit::TestCase
 
-  # remove all seeds
-  Nephos::Router::ROUTES = []
+  def reset_routes!
+    Nephos::Router::ROUTES.clear
+  end
+
+  def first
+    Nephos::Router::ROUTES.first
+  end
+
+  def test_multi_routes
+    reset_routes!
+    get url: "/a", controller: "TestController", method: "method", silent: true
+    get url: "/b", controller: "TestController", method: "method", silent: true
+    get url: "/c", controller: "TestController", method: "method", silent: true
+    post url: "/a", controller: "TestController", method: "method", silent: true
+    post url: "/b", controller: "TestController", method: "method", silent: true
+    post url: "/c", controller: "TestController", method: "method", silent: true
+    put url: "/a", controller: "TestController", method: "method", silent: true
+    put url: "/b", controller: "TestController", method: "method", silent: true
+    put url: "/c", controller: "TestController", method: "method", silent: true
+    assert_equal 9, Nephos::Router::ROUTES.size
+    assert_equal 3, Nephos::Router::ROUTES.select{ |r|
+      r[:verb] == "GET"
+    }.size
+  end
 
   def test_valid_routes
+    reset_routes!
     get url: "/", controller: "TestController", method: "method", silent: true
+    assert_equal "/", first[:url]
+    assert_equal "GET", first[:verb]
+    assert_equal "TestController", first[:controller]
+    assert_equal "method", first[:method]
+    assert_equal /^\/$/, first[:match]
+
+    reset_routes!
     post url: "/", controller: "TestController", method: "method", silent: true
+    assert_equal "/", first[:url]
+    assert_equal "POST", first[:verb]
+    assert_equal "TestController", first[:controller]
+    assert_equal "method", first[:method]
+    assert_equal /^\/$/, first[:match]
+
+    reset_routes!
     put url: "/", controller: "TestController", method: "method", silent: true
+    assert_equal "/", first[:url]
+    assert_equal "PUT", first[:verb]
+    assert_equal "TestController", first[:controller]
+    assert_equal "method", first[:method]
+    assert_equal /^\/$/, first[:match]
+  end
+
+  def test_valid_routes_params
+    reset_routes!
+    get url: "/:what", controller: "TestController", method: "method", silent: true
+    assert_equal "/:what", first[:url]
+    assert_equal /^\/[[:graph:]]+$/, first[:match]
+  end
+
+  def test_valid_resources
+    reset_routes!
+    resource "/home" do
+      assert_equal route_prefix, "/home"
+    end
+    resource "/home" do
+      get url: "/help", controller: "TestController", method: "method", silent: true
+    end
+    assert_equal "/home/help", first[:url]
+  end
+
+  def test_valid_resources_params
+    reset_routes!
+    resource "/home" do
+      get url: "/:what", controller: "TestController", method: "method", silent: true
+    end
+    assert_equal "/home/:what", first[:url]
+    assert_equal /^\/home\/[[:graph:]]+$/, first[:match]
+  end
+
+    def test_valid_resources_params2
+    reset_routes!
+    resource "/:id" do
+      get url: "/show", controller: "TestController", method: "method", silent: true
+    end
+    assert_equal "/:id/show", first[:url]
+    assert_equal /^\/[[:graph:]]+\/show$/, first[:match]
   end
 
 end

data/version

@@ -1 +1 @@
-0.2.4
+0.3.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nephos-server
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1
 platform: ruby
 authors:
 - poulet_a