trialday 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d77199f6b23c06e721942c3cb229a7793d2f0669
-  data.tar.gz: 071aff33072a0c73b7a26e316ada99e418fd69a8
+  metadata.gz: d1ba05c9f8eab2a210334a8231bc4d4f5b4973cc
+  data.tar.gz: 24ac3c8da03bb1182152e842e089edc5a6814c62
 SHA512:
-  metadata.gz: 8be9e4a744caa8fc82d00cd60efae91b13d3af3d8e6be56ed80a7f342031b09adfd084f1f8726d2ffa64986232e005535c04fed471bb1596e5945df4801364aa
-  data.tar.gz: 2bc88122cf0ab0d914881fafaa60282917b0f0a2fb93acc154ea92715245d495731284186adc5442002e2031111dd70b432ab7abcbe251fce9594c86ae2def18
+  metadata.gz: 90d9d58fb6dc484bbd24c17a38f74023d1bcc786cba237d48d2cd4177dd7875ec20eec20cd45b4ee4b07c52a4da89f9e1e1bb551b5156b62bed4560f92335403
+  data.tar.gz: 137dccd43ea5c1a1831c11b26f2f21a98d5d03e30b7ef365f6b8c3744829aa9fc1b811309d772ddf4490895337376d5d3443066b8ef980e3cd9ced3ce8cb0586

data/lib/trialday.rb

@@ -1,17 +1,35 @@
-app_files = File.expand_path('../app/**/*.rb', __FILE__)
-Dir.glob(app_files).each { |file| require(file) }
+#--
+# Trialday
+#
+# Trialday is a small web framework for writing simple JSON APIs.
+# It's Rack based (https://rack.github.io/).
+#
+# The architecture is composed of 3 main layers, that are represented
+# below with base, mains and router.
+#
+# Trial day is a reverse engineering of Sinatra
+# [https://github.com/sinatra/sinatra/tree/master/lib/sinatra]
+#++
+require 'rack'
+require 'trialday/base'
+require 'trialday/router'
+require 'trialday/main'
 
-class Trialday
-  def call(env)
-    request = Rack::Request.new(env)
-    serve_request(request)
-  end
 
-  def serve_request(request)
-    Router.new(request).route!
-  end
-end
+# = Trialday Delegator
+#
+# In order to public expose the get and set methods, we use metaprogramming
+# defining both of them in a dynamic way. The defined methods are then
+# extended in this main file to it they can be accessed from outside.
+# The idea comes from Sinatra base: lib/sinatra/base.rb#L1918
+#
+# PS: include would include the module in Object
+# while extend only extends the `main` object
+extend Trialday::Delegator
 
-def get x, &block
-  Rack::Handler::WEBrick.run Trialday.new
+# = Rack Builder
+#
+# Implements a small DSL to iteratively construct Rack applications.
+class Rack::Builder
+  include Trialday::Delegator
 end

data/lib/trialday/base.rb

@@ -0,0 +1,42 @@
+# = Trialday Base
+#
+# The Base class contains the integrations between the Application class
+# and the router. It uses class methods to, when called, invoke the
+# Router.route. This will add the new route to the list of available routes.
+# [see Sinatra: lib/sinatra/base.rb#L1599]
+#
+# = Trialday Delegator
+#
+# The Delegator dynamic creates the integrations between the public
+# api and the Trialday::Application class. It generates get/post methods
+# on the fly and by metaprogramming defines what should happen whe the API
+# is called. The Application is then registered to accept the parameters,
+# calling passing the routes path and body block to the scope.
+# [see Sinatra: lib/sinatra/base.rb#L1908]
+module Trialday
+
+  class Base
+    class << self
+      # Defining a `GET` handler
+      def get(path, &block)
+        Trialday::Router.route(path, 'GET', &block)
+      end
+      # Defining a `POST` handler
+      def post(path, &block)
+        Trialday::Router.route(path, 'POST', &block)
+      end
+    end
+  end
+
+  module Delegator #:nodoc:
+    def self.delegate(*methods)
+      methods.each do |method_name|
+        define_method(method_name) do |*args, &block|
+          Trialday::Application.send(method_name, *args, &block)
+        end
+      end
+    end
+
+    delegate :get, :post
+  end
+end

data/lib/trialday/main.rb

@@ -0,0 +1,30 @@
+# = Trialday Application
+#
+# Rack Applications needs an object which will have a 'call' method.
+# This call method can be simple and just return a HTTP response.
+# In our scenario this class will get the reference from Rack::Request
+# and call the 'serve_request' method.
+#
+# The serve_request method returns the Trialday::Router.
+# the ida is to have an main object to orchestrate the possible
+# calls to the framework API.
+#
+# To start up the Rack server we use ruby's at_exist method.
+# This will ensure that the Router object will be completely ready
+# for Rack to server, in this case, using WEBrick.
+# [see Sinatra: /lib/sinatra/main.rb#L26]
+module Trialday
+
+  class Application < Base
+    def call(env)
+      request = Rack::Request.new(env)
+      serve_request(request)
+    end
+
+    def serve_request(request)
+      Router.new(request).route!
+    end
+  end
+
+  at_exit { Rack::Handler::WEBrick.run Trialday::Application.new }
+end

data/lib/trialday/router.rb

@@ -0,0 +1,79 @@
+# = Trialday Router
+#
+# The Router for Trialday framework.
+# The Router is responsible to keep a collections of paths
+# and knows where and what to return. It verifies if the request is a get
+# or post, and check to see if the API was pre-defined with an response for
+# the desired call.
+#
+# This class uses ideas from Sinatra, and could be extensively improved.
+# For now, it uses a routes list that could be tweaked.
+# The framework also includes a 'not_foud' route in case the Router wasn't
+# configured to respond to a specific call.
+# [see Sinatra: ib/sinatra/base.rb#L1602]
+require 'json'
+
+module Trialday
+  class Router
+    @@routes = []
+
+    def initialize(request)
+      @request = request
+    end
+
+    def route!
+      routes_list.each do |r|
+        if action == r['path']
+          verb = @request.get? ? 'GET' : 'POST'
+          if verb == 'GET'
+            return [200, { "Content-Type" => "application/json" }, [r['body'].call.to_json]]
+          elsif verb == 'POST'
+            return [200, { "Content-Type" => "application/json" }, [@request.body.read]]
+          end
+        end
+      end
+
+      not_found
+    end
+
+    def action
+      '/'+ route_info[:resource]
+    end
+
+    def routes_list
+      @@routes
+    end
+
+    class << self
+      def route(path, verb, &block)
+        @@routes << {"path"=>path, "body"=>block, "verb"=>"GET"}
+      end
+    end
+
+    private
+
+    def not_found(msg = "Route not found.")
+      [404, { "Content-Type" => "text/plain" }, [msg]]
+    end
+
+    def route_info
+      @route_info ||= begin
+        resource = path_fragments[0]
+        { resource: resource }
+      end
+    end
+
+    def find_id_and_action(fragment)
+      @request.get? ? :index : :create
+    end
+
+    def add_route_info_to_request_params!
+      @request.params.merge!(route_info)
+    end
+
+    def path_fragments
+      @fragments ||= @request.path.split("/").reject { |s| s.empty? }
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trialday
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Anderson Leite
@@ -17,6 +17,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/trialday.rb
+- lib/trialday/base.rb
+- lib/trialday/main.rb
+- lib/trialday/router.rb
 homepage: http://rubygems.org/gems/trialday
 licenses:
 - MIT