nephos-server 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 829761db1101c722504e7778ec2cd55f8edca2d1
-  data.tar.gz: 16741f9f42c3754172f69b43fdec9d1c07449d90
+  metadata.gz: 0339bf695959f0e5b19b9b73609e561dfb496f23
+  data.tar.gz: ed4d9148e39b2540a88d5160d38dfe8d36499d3a
 SHA512:
-  metadata.gz: 9236bd2cc50a63baed30ad1c092bcb17b8d2863c40d09dce2d0e605f3a91b457d13738f7036ce7961a98135604095a6857298a866bfa9879f9d783f39439d7bf
-  data.tar.gz: 345df24516023c3b0d5417a77ab4a86a75e0cc33f353c6d582c5bb8c64a3ecb3a3b52dcef13d97c1b61e3e523f5d7da97588e40c653fd0870f7a1ba29a0b6860
+  metadata.gz: db650e2505b3f6a3b54efdfc5d1dfa4da006bed596f54a2b615928c0f676dd626da8a2c6a49073914080566254ddc325cc6d27291c4d09f8e19a82a94fdc1c4a
+  data.tar.gz: 6a05e3f8d9d0ece9e41faf43218e6741f30b29246add62032094a7650217a68f5186736e8d358a1e0e8ae52374cf566c4c23259c29919c72440f9e7d8491039a

data/CHANGELOG

@@ -1,3 +1,11 @@
+v0.5.2
+	* fix regression on content-type from v0.4
+
+v0.5.1
+	* fix nephos gem (binaries can be used out of an application)
+	* improve code documentation (annotations above the methods and classes)
+	* fix content type for json to application/json
+
 v0.5.0
 	* improve executables: version taking in count
 

data/README.md

@@ -2,11 +2,14 @@
 
 [![GitHub version](https://badge.fury.io/gh/pouleta%2FNephosRubyServer.svg)](http://badge.fury.io/gh/pouleta%2FNephosRubyServer)
 
-[![Gem Version](https://badge.fury.io/rb/nserver.svg)](http://badge.fury.io/rb/nserver)
+[![Gem Version](https://badge.fury.io/rb/nephos-server.svg)](http://badge.fury.io/rb/nephos-server)
 
 [![Code Climate](https://codeclimate.com/github/pouleta/NephosRubyServer/badges/gpa.svg)](https://codeclimate.com/github/pouleta/NephosRubyServer)
 
-This is a minimal web server, based on [rack](TODO LINK) and [puma](TODO LINK).
+[![Nephos Executables](https://badge.fury.io/rb/nephos.svg)](http://badge.fury.io/rb/nephos)
+
+
+This is a minimal web server, based on [rack](https://github.com/rack/rack) and [puma](https://github.com/puma/puma).
 It is written in ruby. It also gives you a minimal architecture
 to speed up your application bootstrap.
 
@@ -48,6 +51,7 @@ Theses guides will provide you knowlegde about everything you can use in the app
 - [Generator GUIDE](DOCUMENTATION/GUIDE_GENERATOR.md)
 - [Render API](DOCUMENTATION/API_RENDER.md)
 - [Router GUIDE](DOCUMENTATION/GUIDE_ROUTER.md)
+- [Code documentation on RubyDoc.info](http://www.rubydoc.info/gems/nephos-server/toplevel) -> **Note: you can also generate local documentation via yard**
 
 ## Examples
 
@@ -110,9 +114,9 @@ end
 # Developers: Roadmap
 
 ## TODO v0.5
-- executables with version
 - cookies, ...
 - usage of rack parsers (Rack::Request.new(env) etc.)
+- improved code documentation
 
 ## TODO v0.6
 - startable as daemon

data/app/main.rb

@@ -1,6 +1,9 @@
 class MainController < Nephos::Controller
 
   def root
+    cookies["a"] = "b"
+    cookies.delete("b").to_h
+    puts cookies
     {
       json: {
         list: $dataset,

data/bin/nephos-server

@@ -9,7 +9,7 @@ require 'nephos-server/bin-helpers'
 class RoutingError < StandardError; end
 
 begin
-  OptionParser.new do |opts|
+  opts = OptionParser.new do |opts|
     opts.banner = "Usage<#{Nephos::VERSION}>: nephos-server <options>"
 
     $server_port = ENV["SERVER_PORT"] || 8080
@@ -34,8 +34,11 @@ begin
     opts.on("--test", "Enable testing mode (for nephos developpers)") do
       $test = true
     end
+
   end.parse!
 
+  Dir.chdir(opts[0]) if not opts.empty?
+
   if $test
     require_relative "../lib/nephos-server"
   else

data/bin/nephos-status

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+require 'colorize'
 require 'optparse'
 
 require 'nephos-server/version'
@@ -43,5 +44,6 @@ begin
   end
 
 rescue => err
-  puts err.message
+  puts "Error:".red + " #{err.message}"
+  puts err.backtrace
 end

data/lib/nephos-server/bin-helpers.rb

@@ -1,6 +1,15 @@
 module Nephos
   module Bin
 
+    # @param dir [String]
+    #
+    # The method check in the parameter directory:
+    # - if the directory exists
+    # - if a Gemfile.lock has been generated
+    # - if it contain nephos-server dependency
+    #
+    # note: if the Gemfile includes nephos and not nephos-server,
+    # it will work anyway, because nephos require nephos-server
     def self.is_a_valid_application? dir="."
       return false if not Dir.exists? dir
       gfl = File.expand_path "Gemfile.lock", dir

data/lib/nephos-server/controller.rb

@@ -1,7 +1,12 @@
 module Nephos
+
+  # This class must be inherited by the other Controllers.
+  # It contains a constructor (you should not rewrite it)
+  # It contains some helpers too, like an access to the environment,
+  # and the parameters.
   class Controller
 
-    attr_reader :env, :infos, :callpath, :params
+    attr_reader :env, :infos, :callpath, :params, :cookies
 
     # @param env [Hash] env extracted from the http request
     # @param parsed [Hash] pre-parsed env with parameters, ...
@@ -19,6 +24,7 @@ module Nephos
       @params.merge! Hash[callpath[:params].zip @infos[:path]]
       @params.select!{|k,v| not k.to_s.empty?}
       @params = Params.new(@params)
+      @cookies = Params.new()
     end
 
   end

data/lib/nephos-server/params.rb

@@ -1,8 +1,16 @@
 # coding: utf-8
 
 module Nephos
+
+  # Params to a hash, where every elements are accessibles via a stringified key
+  # so, even if the entry was added with the key :KEY, it will be accessible via
+  # a string equivalent to :key.to_s
+  #   param["key"] == param[:key]
+  #
+  # Every methods present in {Hash} are usable in {Param}.
   class Params
 
+    # @param hash [Hash] hash containing the parameters
     def initialize(hash={})
       raise ArgumentError, "the first argument must be a Hash" unless hash.is_a? Hash
       @hash = Hash[hash.map{|k,v| [k.to_s, v]}]
@@ -21,5 +29,9 @@ module Nephos
       @hash[i.to_s] = v.to_s
     end
 
+    def to_h
+      return @hash
+    end
+
   end
 end

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

@@ -3,6 +3,17 @@ def route_prefix
   File.join(["/"] + @route_prefix)
 end
 
+# @param verb [String] has to be a valid http verb, so a string uppercase
+# @param what [Hash] has to contain the following keys:
+#   - :url
+#   - :controller
+#   - :method
+#
+# The method create a valid route, set in Nephos::Router::ROUTES
+# it will call the method from the controller, based on the parameters
+# if the client request match with the verb and the url provided.
+#
+# Checkout the documentation about the parameters and API for more informations
 def add_route(verb, what)
   raise InvalidRoute, "what must be a hash" unless what.is_a? Hash
   what[:url] = File.expand_path File.join(route_prefix, what[:url])
@@ -11,21 +22,28 @@ def add_route(verb, what)
   Nephos::Router.add(what, verb)
 end
 
-# @param what [Hash]
+# @param what [Hash] see {#add_route}
 def get what
   add_route "GET", what
 end
 
-# @param what [Hash]
+# @param what [Hash] see {#add_route}
 def post what
   add_route "POST", what
 end
 
-# @param what [Hash]
+# @param what [Hash] see {#add_route}
 def put what
   add_route "PUT", what
 end
 
+# @param name [String]
+# @param block [Bloc]
+#
+# Create a resource named based on the parameter name
+# Every call of {#add_route} {#get} {#post} {#put} in the bloc
+# will have a modified url, working with the following schema:
+#   "/name/" + url
 def resource(name, &block)
   @route_prefix ||= []
   @route_prefix << name

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

@@ -8,6 +8,9 @@ module Nephos
       return display
     end
 
+    # @param what [Hash]
+    #
+    # TODO: doc
     def self.add_params!(what)
       params = what[:url].split('/').map do |p|
         p.match(/:\w+/) ? {p: "[^\/]+", name: p} : {p: p, name: nil}
@@ -18,12 +21,28 @@ module Nephos
       what[:params] = params.map{|e| e[:name] && e[:name][1..-1]}[1..-1] || []
     end
 
+    # @param what [Hash]
+    #
+    # Check if the what parameter contains the needed keys
+    # - :url
+    # - :controller
+    # - :method
     def self.check_keys! what
       raise InvalidRouteUrl, "Missing URL" unless what.keys.include? :url
       raise InvalidRouteController, "Missing Controller" unless what.keys.include? :controller
       raise InvalidRouteMethod, "Missing Method" unless what.keys.include? :method
     end
 
+    # @param what [Hash]
+    #
+    # TODO:
+    # - Improve instanciation test
+    #
+    # Check if:
+    # - the what parameter contains a :controller
+    # - this controller exists
+    # - if the controller is a child of the {Controller} class
+    # - if the controller is instanciable
     def self.check_controller! what
       begin
         controller = Module.const_get(what[:controller])
@@ -41,6 +60,10 @@ module Nephos
       return instance
     end
 
+    # @param what [Hash]
+    # @param instance [Controller]
+    #
+    # Check if the param instance has a method named what[:method]
     def self.check_method! what, instance
       if not instance.respond_to? what[:method]
         raise InvalidRouteMethod, "No method named \"#{what[:method]}\""

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

@@ -4,18 +4,23 @@ end
 puts
 
 module Nephos
+
+  # The {Router} provides an interface between the {Controller} and the client
+  # queries.
   module Router
 
     ROUTES = []
 
     # @param arg [Hash or Symbol]
-    # shortcut to #{Nephos::Responder.render}
+    #
+    # Shortcut to #{Nephos::Responder.render}
     def self.render arg
       Responder.render arg
     end
 
     # @param path [Array]
-    # find the right route to use from the url
+    #
+    # Find the right route to use from the url
     def self.parse_path path, verb
       route = File.join(["/"] + path)
       return ROUTES.find{|e| e[:match] =~ route and e[:verb] == verb}
@@ -41,6 +46,8 @@ module Nephos
       end
     end
 
+    # Interface which handle the client query (stored in env), calls the
+    # {Controller} method (using the routes) and render it's return
     def self.execute(env)
       begin
         route = URI.parse(env['REQUEST_URI'])

data/lib/nephos-server/server/responder.rb

@@ -6,7 +6,7 @@ module Nephos
     CT_CHARSET_PREFIX = '; charset='
 
     def self.content_type(kind, type, charset='UTF-8')
-      {'Content-type' => "#{kind}/#{type}" + CT_CHARSET_PREFIX + charset}
+      "#{kind}/#{type}" + CT_CHARSET_PREFIX + charset
     end
 
     # @param params [Hash] containing :type => "kind/type", example: "text/html"
@@ -21,7 +21,7 @@ module Nephos
     PRESET_CT = {
       plain: "text/plain",
       html: "text/html",
-      json: "text/javascript",
+      json: "application/json",
     }
 
     private
@@ -67,11 +67,12 @@ module Nephos
       return [204, ct_specific({type: PRESET_CT[:plain]}), [""]] if params == :empty
       return render(status: params) if params.is_a? Integer
       params = set_default_params(params)
-      return [
-        params[:status],
-        params[:type],
-        [params[:content]],
-      ]
+      resp = Rack::Response.new
+      resp.status = params[:status]
+      resp["Content-Type"] = params[:type]
+      resp.body = [params[:content]]
+      #resp.set_cookies ...
+      return resp
     end
 
   end

data/test/responder.rb

@@ -70,7 +70,7 @@ class TestNephosServerResponder < Test::Unit::TestCase
     Nephos::Responder.set_default_params_type(p4)
     Nephos::Responder.set_default_params_type(p5)
     plain = Nephos::Responder.ct_specific({type: "text/plain"})
-    json = Nephos::Responder.ct_specific({type: "text/javascript"})
+    json = Nephos::Responder.ct_specific({type: "application/json"})
     html = Nephos::Responder.ct_specific({type: "text/html"})
     assert_equal plain, p1[:type]
     assert_equal html, p2[:type]

data/version

@@ -1 +1 @@
-0.5.0
+0.5.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nephos-server
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - poulet_a
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nomorebeer
@@ -164,5 +164,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: "* improve executables: version taking in count"
+summary: "* fix regression on content-type from v0.4"
 test_files: []
+has_rdoc: