rackstep 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d43164a0ecd96e90a43c8c343e5b5736473e3cbd
+  data.tar.gz: 3591804ceda2a7619911120c1ee8f08c26d97a18
+SHA512:
+  metadata.gz: d6658db5f112bb9073706866abaad6392d5a1197adb290b63b30133c7b22dd8aa6b9eab716c938d8dc31e00a05f99aa6ac2a6c5e17f19c9520ef88b1cc4b1c67
+  data.tar.gz: 2bfb9aab2733304ce1d645c3e6765951a3968d61aaad2ee45b7637420a8c62afaff01e54b9c28cc0b68a655f6e4a48517d35a3522271e30ce85d184c0d1806cd

data/lib/controller.rb

@@ -0,0 +1,42 @@
+# Abstract controller class with some helper methods. ALL your controllers
+# MUST use this one as a superclass.
+
+module RackStep
+
+  class Controller
+
+    # The request will be injected here.
+    attr_accessor :request
+    # Represents the response information that will be delivered to the user
+    # (a Hash with contentType, content and httpStatus).
+    # By default httpStatus is 200 and contentType is application/json.
+    attr_accessor :response
+
+    def initialize
+      @response = Hash.new
+      @response[:contentType] = 'application/json'
+      @response[:httpStatus]  = 200
+      @response[:content] = ''
+      @pagesDirectory = 'app/public/pages'
+    end
+
+    # RackStep will always execute this method before delegating the request
+    # processing to the specified method. The user may overwrite this method.
+    # This can be used to check for access authorization or any piece of code
+    # that must be executed before every request for this controller.
+    def before
+    end
+
+    # This is not the best way to serve static content. In production, consider
+    # using Nginx or Apache. Using ruby/rack to serve static content is a waste
+    # of resources and should be only used for low traffic web pages. This
+    # method is provided so that in this circumstances you may use it to keep a
+    # simpler architecture.
+    def render_page(pageName)
+      response[:contentType] = 'text/html'
+      File.read("#{@pagesDirectory}/#{pageName}.html")
+    end
+
+  end
+
+end

data/lib/rackstep.rb

@@ -0,0 +1,58 @@
+require_relative 'controller'
+require_relative 'router'
+
+module RackStep
+
+  class App
+
+    # We will store the request and create a router in this class initializer.
+    attr_reader :request, :router
+
+    # Static method called from config.ru ("run App").
+    def self.call(env)
+      new(env).process_request
+    end
+
+    def initialize(env)
+      @request = Rack::Request.new(env)
+      @router = RackStep::Router.new
+    end
+
+    def process_request
+      # Trying to find what controller should process this request.
+      # This will return a hash with the name of the controller, the
+      # method (action), etc.
+      route = router.find_route_for(request)
+      # If no valid route is found, will break the request and return http 404
+      # (page not found).
+      if (route == nil)
+        return page_not_found_response
+      end
+      # Initialize the correspondent controller
+      controller = Object.const_get(route.controller).new
+      # Inject the request into the Controller
+      controller.request = request
+      # Execute the before method of this controller
+      controller.send(:before)
+      # Execute the apropriate method/action
+      controller.send(route.method)
+      response = controller.response
+      # Generate a rack response that will be returned to the user
+      Rack::Response.new( response[:content],
+                          response[:httpStatus],
+                          {'Content-Type' => response[:contentType]} )
+    end
+
+    # Will use this as response when no route is found.
+    def page_not_found_response
+      Rack::Response.new("404 - Page not found", 404)
+    end
+
+    # Adds a new route to the application.
+    def add_route(verb, path, controller, method)
+      @router.add_route(verb, path, controller, method)
+    end
+
+  end
+
+end

data/lib/router.rb

@@ -0,0 +1,61 @@
+
+module RackStep
+
+  class Router
+
+    # Will store all the possible routes. By default it's empty and should be
+    # populated by the application.
+    attr_accessor :routes
+
+    def initialize
+      @routes = Hash.new
+    end
+
+    def add_route(verb, path, controller, method)
+      route = Route.new(verb, path, controller, method)
+      routes[route.id] = route
+    end
+
+    # Given a request, will parse it's path to find what it the apropriate
+    # controller and mehod/action to respond it.
+    def find_route_for(request)
+      path = request.path
+      # Ignoring the first char if path starts with '/'. This way the path of
+      # 'http//localhost/' will be the same of 'http://localhost' (both will
+      # be empty strings).
+      path = path[1..-1] if path[0] == '/'
+      # Extracting the type of request (GET, POST, PUT, DELETE).
+      verb = request.request_method
+      # Re-creating the route id (verb + path).
+      route_id = verb + path
+      # Getting the correspondent route or nil if route is invalid.
+      route = routes[route_id]
+
+      return route
+    end
+
+  end
+
+  # Represents a single route. The verb can be 'GET', 'PUT', 'POST' or 'DELETE'.
+  # The path is a string with something like 'users', the controller is the
+  # name of the class that will process this type of request and the method
+  # parameter is the name of the method that will be executed.
+  class Route
+
+    attr_accessor :verb, :path, :controller, :method
+
+    def initialize(verb, path, controller, method)
+      @verb = verb
+      @path = path
+      @controller = controller
+      @method = method
+    end
+
+    # Unique id of the route (verb + path). Eg: 'GETuser'
+    def id
+      verb + path
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: rackstep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marcio Frayze
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies: []
+description: RackStep is (yet another) micro ruby framework for web development.
+email: mfdavid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/controller.rb
+- lib/rackstep.rb
+- lib/router.rb
+homepage: https://github.com/mfdavid/RackStep
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: RackStep micro web framework
+test_files: []