midb 1.0.5 → 1.1.0

data/lib/midb/server_view.rb

@@ -1,98 +1,108 @@
-require 'midb/server_controller'
 module MIDB
-  class ServerView
-    def self.success()
-      puts "Ayyy great"
-    end
+  module Interface
+    # View that handles everything from the server
+    class Server
 
-    # Method: json_error
-    # Return a JSON error response
-    def self.json_error(errno, msg)
-      return {"error" => {"errno" => errno, "msg" => msg}}
-    end
+      def self.success()
+        puts "Success!"
+      end
 
-    # Method: show_serving
-    # Shows the files being served
-    def self.show_serving()
-      puts "The follow JSON files are being served as APIs:"
-      MIDB::ServerController.config["serves"].each do |serv|
-        puts "- #{serv}"
+      # Return a JSON error response
+      #
+      # @param errno [Fixnum] Error number.
+      # @param msg [String] Error message.
+      def self.json_error(errno, msg)
+        return {"error" => {"errno" => errno, "msg" => msg}}
       end
-    end
 
-    # Method: server_stopped
-    # Notice that the server has been stopped.
-    def self.server_stopped()
-      puts "The server has been successfully stopped!"
-    end
+      # Shows the files being served
+      #
+      # @param cnf [Array<String>] The configuration from the server.
+      def self.show_serving(cnf)
+        puts "The follow JSON files are being served as APIs:"
+        cnf["serves"].each do |serv|
+          puts "- #{serv}"
+        end
+      end
 
-    # Method: info
-    # Send some info
-    def self.info(what, info=nil)
-      msg = case what
-            when :start then "Server started on port #{info}. Listening for connections..."
-            when :incoming_request then "> Incoming request from #{info}."
-            when :request then ">> Request method: #{info[0]}\n>>> Endpoint: #{info[1]}"
-            when :match_json then ">> The request matched a JSON file: #{info}.json\n>> Creating response..."
-            when :response then ">> Sending JSON response (RAW):\n#{info}"
-            when :success then "> Successfully managed this request!"
-            when :not_found then "> Invalid endpoint - sending a 404 error."
-            when :auth_required then ">> Authentication required. Checking for the HTTP header..."
-            when :no_auth then ">> No authentication header - sending a 401 error."
-            when :auth_success then ">> Successfully authenticated the request."
-            when :bootstrap then "> Successfully bootstraped!"
-            end
-      puts msg
-    end
+      # Notice that the server has been stopped.
+      def self.server_stopped()
+        puts "The server has been successfully stopped!"
+      end
 
-    # Method: out_config
-    # Output some config
-    def self.out_config(what)
-      msg = case what
-            when :dbengine then "Database engine: #{MIDB::ServerController.config['dbengine']}."
-            when :dbhost then "Database server host: #{MIDB::ServerController.config['dbhost']}."
-            when :dbport then "Database server port: #{MIDB::ServerController.config['dbport']}."
-            when :dbuser then "Database server user: #{MIDB::ServerController.config['dbuser']}."
-            when :dbpassword then "Database server password: #{MIDB::ServerController.config['dbpassword']}."
-            when :apikey then "Private API key: #{MIDB::ServerController.config['apikey']}"
-            else "Error??"
-            end
-      puts msg
-    end
+      # Send some info
+      # 
+      # @param what [Symbol] What to show the information for.
+      # @param info [Array<String>] Extra information needed for the message.
+      def self.info(what, info=nil)
+        msg = case what
+              when :start then "Server started on port #{info}. Listening for connections..."
+              when :incoming_request then "> Incoming request from #{info}."
+              when :request then ">> Request method: #{info[0]}\n>>> Endpoint: #{info[1]}"
+              when :match_json then ">> The request matched a JSON file: #{info}.json\n>> Creating response..."
+              when :response then ">> Sending JSON response (RAW):\n#{info}"
+              when :success then "> Successfully managed this request!"
+              when :not_found then "> Invalid endpoint - sending a 404 error."
+              when :auth_required then ">> Authentication required. Checking for the HTTP header..."
+              when :no_auth then ">> No authentication header - sending a 401 error."
+              when :auth_success then ">> Successfully authenticated the request."
+              when :bootstrap then "> Successfully bootstraped!"
+              end
+        puts msg
+      end
+
+      # Output some config
+      #
+      # @param what [Symbol] What to show the config for.
+      # @param cnf [Array<String>] The array for the config.
+      def self.out_config(what, cnf)
+        msg = case what
+              when :dbengine then "Database engine: #{cnf['dbengine']}."
+              when :dbhost then "Database server host: #{cnf['dbhost']}."
+              when :dbport then "Database server port: #{cnf['dbport']}."
+              when :dbuser then "Database server user: #{cnf['dbuser']}."
+              when :dbpassword then "Database server password: #{cnf['dbpassword']}."
+              when :apikey then "Private API key: #{cnf['apikey']}"
+              else "Error??"
+              end
+        puts msg
+      end
 
-    # Method: help
-    # Shows the help
-    def self.help(what)
-      case what
-      when :list
-        puts "midb has several commands that you can use. For detailed information, see `midb help command`."
-        puts " "
-        puts "bootstrap\tCreate the basic files and directories that midb needs to be ran in a folder."
-        puts "set\tModify this project's settings. See the detailed help for a list of options."
-        puts "serve\tServes a JSON file - creates an API endpoint."
-        puts "unserve\tStops serving a JSON file - the endpoint is no longer valid."
-        puts "start\tStarts an API server. See detailed help for more."
-      when :bootstrap
-        puts "This command creates the `.midb.yaml` config file, and the `db` and `json` directories if they don't exist."
-        puts "You must bootstrap before running any other commands."
-      when :set
-        puts "Sets config options. If no value is given, it shows the current value."
-        puts "db:host\tHost name of the database (for MySQL)"
-        puts "db:user\tUsername for the database (for MySQL)"
-        puts "db:password\tPassword for the database (for MySQL)"
-        puts "db:engine\t(sqlite3, mysql) Changes the database engine."
-        puts "api:key\tChanges the private API key, used for authentication over HTTP."
-      when :serve
-        puts "This command will create an API endpoint pointing to a JSON file in the json/ directory."
-        puts "It will support GET, POST, PUT and DELETE requests."
-        puts "For detailed information on how to format your file, see the GitHub README and/or wiki."
-      when :unserve
-        puts "Stops serving a JSON file under the json/ directory."
-      when :start
-        puts "Starts the server. You must run the serve/unserve commands beforehand, so to set some endpoints."
-        puts "Options:"
-        puts "db:DATABASE\tSets DATABASE as the database where to get the data. Mandatory."
-        puts "port:PORT\tSets PORT as the port where the server will listen to. Default: 8081."
+      # Shows the help
+      #
+      # @param what [Symbol] What to show the help for.
+      def self.help(what)
+        case what
+        when :list
+          puts "midb has several commands that you can use. For detailed information, see `midb help command`."
+          puts " "
+          puts "bootstrap\tCreate the basic files and directories that midb needs to be ran in a folder."
+          puts "set\tModify this project's settings. See the detailed help for a list of options."
+          puts "serve\tServes a JSON file - creates an API endpoint."
+          puts "unserve\tStops serving a JSON file - the endpoint is no longer valid."
+          puts "start\tStarts an API server. See detailed help for more."
+        when :bootstrap
+          puts "This command creates the `.midb.yaml` config file, and the `db` and `json` directories if they don't exist."
+          puts "You must bootstrap before running any other commands."
+        when :set
+          puts "Sets config options. If no value is given, it shows the current value."
+          puts "db:host\tHost name of the database (for MySQL)"
+          puts "db:user\tUsername for the database (for MySQL)"
+          puts "db:password\tPassword for the database (for MySQL)"
+          puts "db:engine\t(sqlite3, mysql) Changes the database engine."
+          puts "api:key\tChanges the private API key, used for authentication over HTTP."
+        when :serve
+          puts "This command will create an API endpoint pointing to a JSON file in the json/ directory."
+          puts "It will support GET, POST, PUT and DELETE requests."
+          puts "For detailed information on how to format your file, see the GitHub README and/or wiki."
+        when :unserve
+          puts "Stops serving a JSON file under the json/ directory."
+        when :start
+          puts "Starts the server. You must run the serve/unserve commands beforehand, so to set some endpoints."
+          puts "Options:"
+          puts "db:DATABASE\tSets DATABASE as the database where to get the data. Mandatory."
+          puts "port:PORT\tSets PORT as the port where the server will listen to. Default: 8081."
+        end
       end
     end
   end

data/lib/midb/serverengine_controller.rb

@@ -11,11 +11,11 @@ require 'json'
 require 'sqlite3'
 
 module MIDB
-  # @author unrar
-  # This class handles runs the server engine using sockets and a loop.
-  class ServerEngineController
-    # Attribute declaration here
-    class << self
+  module API
+    # @author unrar
+    # This class handles runs the server engine using sockets and a loop.
+    class Engine
+      # Attribute declaration here
       # @!attribute config
       #   @return [Hash] Contains the project's configuration, saved in .midb.yaml
       # @!attribute db
@@ -23,127 +23,135 @@ module MIDB
       # @!attribute http_status
       #   @return [String] HTTP status code and string representation for the header
       attr_accessor :config, :db, :http_status
-    end
 
+      # Constructor
+      #
+      # @param db   [String] Database to which the server will bind.
+      # @param stat [Fixnum] HTTP Status
+      # @param cnf  [Hash] Config from the server controller.
+      def initialize(db, stat, cnf)
+        @config = cnf
+        @db = db
+        @http_status = stat
+      end
 
-    # Starts the server on a given port (default: 8081)
-    #
-    # @param port [Fixnum] Port to which the server will listen.
-    def self.start(port=8081)
-      # Copy these values from the server controller
-      @http_status = MIDB::ServerController.http_status
-      @config = MIDB::ServerController.config
-      @db = MIDB::ServerController.db
-      serv = TCPServer.new("localhost", port)
-      MIDB::ServerView.info(:start, port)
-
-      # Manage the requests
-      loop do
-        socket = serv.accept
-        MIDB::ServerView.info(:incoming_request, socket.addr[3])
-
-        request = self.parse_request(socket.gets)
-
-        # Get a hash with the headers
-        headers = {}
-        while line = socket.gets.split(' ', 2)
-          break if line[0] == "" 
-          headers[line[0].chop] = line[1].strip
-        end
-        data = socket.read(headers["Content-Length"].to_i)
+      # Starts the server on a given port (default: 8081)
+      #
+      # @param port [Fixnum] Port to which the server will listen.
+      def start(port=8081)
+        serv = TCPServer.new("localhost", port)
+        MIDB::Interface::Server.info(:start, port)
+
+        # Manage the requests
+        loop do
+          socket = serv.accept
+          MIDB::Interface::Server.info(:incoming_request, socket.addr[3])
+
+          request = self.parse_request(socket.gets)
+
+          # Get a hash with the headers
+          headers = {}
+          while line = socket.gets.split(' ', 2)
+            break if line[0] == "" 
+            headers[line[0].chop] = line[1].strip
+          end
+          data = socket.read(headers["Content-Length"].to_i)
 
 
-        MIDB::ServerView.info(:request, request)
-        response_json = Hash.new()
+          MIDB::Interface::Server.info(:request, request)
+          response_json = Hash.new()
 
-        # Endpoint syntax: ["", FILE, ID, (ACTION)]
-        endpoint = request[1].split("/")
-        ep_file = endpoint[1]
+          # Endpoint syntax: ["", FILE, ID, (ACTION)]
+          endpoint = request[1].split("/")
+          ep_file = endpoint[1]
 
-        method = request[0]
-        endpoints = [] # Valid endpoints
+          method = request[0]
+          endpoints = [] # Valid endpoints
 
-        # Load the JSON served files
-        @config["serves"].each do |js|
-          # The filename is a valid endpoint
-          endpoints.push File.basename(js, ".*")
-        end
+          # Load the JSON served files
+          @config["serves"].each do |js|
+            # The filename is a valid endpoint
+            endpoints.push File.basename(js, ".*")
+          end
 
-        # Load the endpoints
-        found = false
-        endpoints.each do |ep|
-          if ep_file == ep
-            found = true
-            MIDB::ServerView.info(:match_json, ep)
-            # Analyze the request and pass it to the model
-            if method == "GET"
-              case endpoint.length
-              when 2
-                # No ID has been specified. Return all the entries
-                # Pass it to the model and get the JSON
-                response_json = MIDB::ServerModel.get_all_entries(@db, ep).to_json
-              when 3
-                # An ID has been specified. Should it exist, return all of its entries.
-                response_json = MIDB::ServerModel.get_entries(@db, ep, endpoint[2]).to_json
-              end
-            else
-              # An action has been specified. We're going to need HTTP authentification here.
-              MIDB::ServerView.info(:auth_required)
+          # Load the endpoints
+          found = false
+          endpoints.each do |ep|
+            if ep_file == ep
+              found = true
+              MIDB::Interface::Server.info(:match_json, ep)
+              # Create the model
+              dbop = MIDB::API::Model.new(ep, @db, self)
+              # Analyze the request and pass it to the model
+              if method == "GET"
+                case endpoint.length
+                when 2
+                  # No ID has been specified. Return all the entries
+                  # Pass it to the model and get the JSON
+                  response_json = dbop.get_all_entries().to_json
+                when 3
+                  # An ID has been specified. Should it exist, return all of its entries.
+                  response_json = dbop.get_entries(endpoint[2]).to_json
+                end
+              else
+                # An action has been specified. We're going to need HTTP authentification here.
+                MIDB::Interface::Server.info(:auth_required)
 
-              if (not headers.has_key? "Authentication") ||
-                 (not MIDB::SecurityController.check?(headers["Authentication"], data, @config["apikey"]))
-                @http_status = "401 Unauthorized"
-                response_json = MIDB::ServerView.json_error(401, "Unauthorized").to_json
-                MIDB::ServerView.info(:no_auth)
+                if (not headers.has_key? "Authentication") ||
+                   (not MIDB::API::Security.check?(headers["Authentication"], data, @config["apikey"]))
+                  @http_status = "401 Unauthorized"
+                  response_json = MIDB::Interface::Server.json_error(401, "Unauthorized").to_json
+                  MIDB::Interface::Server.info(:no_auth)
 
-              else
-                MIDB::ServerView.info(:auth_success)
-                if method == "POST"
-                  response_json = MIDB::ServerModel.post(@db, ep, data).to_json
                 else
-                  if endpoint.length >= 3
-                    if method == "DELETE"
-                      response_json = MIDB::ServerModel.delete(@db, ep, endpoint[2]).to_json 
-                    elsif method == "PUT"
-                      response_json = MIDB::ServerModel.put(@db, ep, endpoint[2], data).to_json
-                    end
+                  MIDB::Interface::Server.info(:auth_success)
+                  if method == "POST"
+                    response_json = dbop.post(data).to_json
                   else
-                    @http_status = "404 Not Found"
-                    response_json = MIDB::ServerView.json_error(404, "Must specify an ID.").to_json
+                    if endpoint.length >= 3
+                      if method == "DELETE"
+                        response_json = dbop.delete(endpoint[2]).to_json 
+                      elsif method == "PUT"
+                        response_json = dbop.put(endpoint[2], data).to_json
+                      end
+                    else
+                      @http_status = "404 Not Found"
+                      response_json = MIDB::Interface::Server.json_error(404, "Must specify an ID.").to_json
+                    end
                   end
                 end
               end
+              MIDB::Interface::Server.info(:response, response_json)
+              # Return the results via HTTP
+              socket.print "HTTP/1.1 #{@http_status}\r\n" +
+                          "Content-Type: text/json\r\n" +
+                          "Content-Length: #{response_json.size}\r\n" +
+                          "Connection: close\r\n"
+              socket.print "\r\n"
+              socket.print response_json
+              socket.print "\r\n"
+              MIDB::Interface::Server.info(:success)
             end
-            MIDB::ServerView.info(:response, response_json)
-            # Return the results via HTTP
-            socket.print "HTTP/1.1 #{@http_status}\r\n" +
-                        "Content-Type: text/json\r\n" +
-                        "Content-Length: #{response_json.size}\r\n" +
-                        "Connection: close\r\n"
-            socket.print "\r\n"
-            socket.print response_json
+          end
+          unless found
+            MIDB::Interface::Server.info(:not_found)
+            response = MIDB::Interface::Server.json_error(404, "Invalid API endpoint.").to_json
+
+            socket.print "HTTP/1.1 404 Not Found\r\n" +
+                         "Content-Type: text/json\r\n" +
+                         "Content-Length: #{response.size}\r\n" +
+                         "Connection: close\r\n"
             socket.print "\r\n"
-            MIDB::ServerView.info(:success)
+            socket.print response
           end
         end
-        unless found
-          MIDB::ServerView.info(:not_found)
-          response = MIDB::ServerView.json_error(404, "Invalid API endpoint.").to_json
-
-          socket.print "HTTP/1.1 404 Not Found\r\n" +
-                       "Content-Type: text/json\r\n" +
-                       "Content-Length: #{response.size}\r\n" +
-                       "Connection: close\r\n"
-          socket.print "\r\n"
-          socket.print response
-        end
       end
-    end
 
-    # Method: parse_request
-    # Parses an HTTP requests and returns an array [method, uri]
-    def self.parse_request(req)
-      [req.split(" ")[0], req.split(" ")[1]]
+      # Method: parse_request
+      # Parses an HTTP requests and returns an array [method, uri]
+      def parse_request(req)
+        [req.split(" ")[0], req.split(" ")[1]]
+      end
     end
   end
 end

data/lib/midb.rb

@@ -4,4 +4,5 @@ require 'midb/security_controller'
 require 'midb/server_controller'
 require 'midb/server_model'
 require 'midb/server_view'
-require 'midb/serverengine_controller'
+require 'midb/serverengine_controller'
+require 'midb/hooks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midb
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - unrar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -102,6 +102,7 @@ files:
 - lib/midb.rb
 - lib/midb/dbengine_model.rb
 - lib/midb/errors_view.rb
+- lib/midb/hooks.rb
 - lib/midb/security_controller.rb
 - lib/midb/server_controller.rb
 - lib/midb/server_model.rb