midb 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee36621935f7db48f10ae5e199e1e04fa6af949
-  data.tar.gz: 125adfc8de0773ea3dc2c87bafa110ca84f011b2
+  metadata.gz: c1800c9b95f115f1c96c363a245c6ba28fbc0541
+  data.tar.gz: 77177bd1d17209dd9cd304ae8a1259851cc93291
 SHA512:
-  metadata.gz: cdc131cdc0c230b93d3f323fd712e4e9eb53fee916ec1385ad4caa9bd810e37b7039907ac6776e64923084908832006fe667854aef9fd1568e09824aca2b9ef1
-  data.tar.gz: 496d34906597bca28076bdc7cdb67f425d0fe498dccb403f1a1c57a59c1aeaa43361eee11913922432f76e2f1619ebb27ec6f85dcc0272891d3ea4976eda8649
+  metadata.gz: 3faa266d28b6965fe4b97e3b4e74cbdcb8b9f538ea76c5381e7d4a28ca614cd0f1704ec20038d9d4272e8a512f2315902bf466991c4edf9c38c42ae6e43c395b
+  data.tar.gz: a418745028a7f5770d66ae4a18ce7a327d5160aa39a1542f0cb5c5072f9413372c4c96d3351c61e3a0243563d7196b835ae240b0299b6e5548900989301b9aa7

data/bin/midb

@@ -4,11 +4,14 @@
 # 08/31/15, unrar
 require 'midb'
 
+api = MIDB::API::Controller.new(ARGV)
+api.init()
+api.save()
 # Pass the arguments to the controler, we don't want the action here ;-)
-MIDB::ServerController.args = ARGV
+#MIDB::ServerController.args = ARGV
 
 # And start the server
-MIDB::ServerController.init()
+#MIDB::ServerController.init()
 
 # Save data in case we didn't actually start the server but change the configuration
-MIDB::ServerController.save()
+#!!MIDB::ServerController.save()

data/lib/midb/dbengine_model.rb

@@ -1,91 +1,95 @@
-require 'midb/server_controller'
 require 'sqlite3'
 require 'mysql2'
 
 module MIDB
-  # @author unrar
-  # This class handles engine-dependent database operations
-  class DbengineModel
+  module API
+    # @author unrar
+    # This class handles engine-dependent database operations
+    class Dbengine
 
-    # @!attribute engine
-    #   @return [Symbol] The database engine being used
-    # @!attribute host
-    #   @return [String] Host name where the database is located
-    # @!attribute uname
-    #   @return [String] Username for the database
-    # @!attribute pwd
-    #   @return [String] Password for the database.
-    # @!attribute port
-    #   @return [Fixnum] Port for the database
-    # @!attribute db
-    #   @return [String] Name of the database  
-    attr_accessor :engine, :host, :uname, :pwd, :port, :db
+      # @!attribute engine
+      #   @return [Symbol] The database engine being used
+      # @!attribute host
+      #   @return [String] Host name where the database is located
+      # @!attribute uname
+      #   @return [String] Username for the database
+      # @!attribute pwd
+      #   @return [String] Password for the database.
+      # @!attribute port
+      #   @return [Fixnum] Port for the database
+      # @!attribute db
+      #   @return [String] Name of the database  
+      attr_accessor :engine, :host, :uname, :pwd, :port, :db
 
-    # Constructor - initializes the attributes with the configuration from ServerController
-    def initialize()
-      @engine = MIDB::ServerController.config["dbengine"]
-      @host = MIDB::ServerController.config["dbhost"]
-      @port = MIDB::ServerController.config["dbport"]
-      @uname = MIDB::ServerController.config["dbuser"]
-      @pwd = MIDB::ServerController.config["dbpassword"]
-      @db = MIDB::ServerController.db
-    end
+      # Constructor - initializes the attributes with the configuration from ServerController
+      #
+      # @param cnf [Array<String>] The configuration array.
+      # @param db  [String] Database name.
+      def initialize(cnf, db)
+        @engine = cnf["dbengine"]
+        @host = cnf["dbhost"]
+        @port = cnf["dbport"]
+        @uname = cnf["dbuser"]
+        @pwd = cnf["dbpassword"]
+        @db = db
+      end
 
-    # Connect to the specified database
-    #
-    # @return [SQLite3::Database, Mysql2::Client] A resource referencing to the database
-    def connect()
-      # Connect to an SQLite3 database
-      if @engine == :sqlite3
-        sq = SQLite3::Database.open("./db/#{@db}.db")
-        sq.results_as_hash = true
-        return sq
-      # Connect to a MySQL database
-      elsif @engine == :mysql
-        return Mysql2::Client.new(:host => @host, :username => @uname, :password => @pwd, :database => @db)
+      # Connect to the specified database
+      #
+      # @return [SQLite3::Database, Mysql2::Client] A resource referencing to the database
+      def connect()
+        # Connect to an SQLite3 database
+        if @engine == :sqlite3
+          sq = SQLite3::Database.open("./db/#{@db}.db")
+          sq.results_as_hash = true
+          return sq
+        # Connect to a MySQL database
+        elsif @engine == :mysql
+          return Mysql2::Client.new(:host => @host, :username => @uname, :password => @pwd, :database => @db)
+        end
       end
-    end
 
-    # Perform a query to the database.
-    #
-    # @param res [SQLite3::Database, Mysql2::Client] An existing database resource.
-    # @param query [String] The SQL query to be ran.
-    #
-    # @return [Array, Hash] Returns an array of hashes for SQLite3 or a hash for MySQL
-    def query(res, query)
-      if @engine == :sqlite3
-        return res.execute(query)
-      elsif @engine == :mysql
-        return res.query(query)
+      # Perform a query to the database.
+      #
+      # @param res [SQLite3::Database, Mysql2::Client] An existing database resource.
+      # @param query [String] The SQL query to be ran.
+      #
+      # @return [Array, Hash] Returns an array of hashes for SQLite3 or a hash for MySQL
+      def query(res, query)
+        if @engine == :sqlite3
+          return res.execute(query)
+        elsif @engine == :mysql
+          return res.query(query)
+        end
       end
-    end
 
-    # Extract a field from a query, because different engines return different types (see #query)
-    #
-    # @param result [Array, Hash] The result of a query obtained via #query
-    # @param field [String] The name of the field to be extracted.
-    #
-    # @return [String, Fixnum] The field extracted from a query
-    def extract(result, field)
-      if @engine == :sqlite3
-        return result[0][field] || result[field]
-      elsif @engine == :mysql
-        result.each do |row|
-          return row[field]
+      # Extract a field from a query, because different engines return different types (see #query)
+      #
+      # @param result [Array, Hash] The result of a query obtained via #query
+      # @param field [String] The name of the field to be extracted.
+      #
+      # @return [String, Fixnum] The field extracted from a query
+      def extract(result, field)
+        if @engine == :sqlite3
+          return result[0][field] || result[field]
+        elsif @engine == :mysql
+          result.each do |row|
+            return row[field]
+          end
         end
       end
-    end
 
-    # Returns the length of a result, because different engines return diferent types (see #query)
-    #
-    # @param result [Array, Hash] The result of a query obtained via #query
-    # 
-    # @return [Fixnum] Length of the result.
-    def length(result)
-      if @engine == :sqlite3
-        return result.length
-      elsif @engine == :mysql 
-        return result.count
+      # Returns the length of a result, because different engines return diferent types (see #query)
+      #
+      # @param result [Array, Hash] The result of a query obtained via #query
+      # 
+      # @return [Fixnum] Length of the result.
+      def length(result)
+        if @engine == :sqlite3
+          return result.length
+        elsif @engine == :mysql 
+          return result.count
+        end
       end
     end
   end

data/lib/midb/errors_view.rb

@@ -1,31 +1,30 @@
-require 'midb/server_controller'
-
 module MIDB
-  # A view that outputs errors.
-  class ErrorsView
-
-    # Handles fatal errors that will cause the application to abrort.
-    # 
-    # @param err [Symbol] The ID of the error that's to be reported.
-    def self.die(err)
-      errmsg =  case err
-                when :noargs then "No command supplied. See `midb help`."
-                when :server_already_started then "The server has already been started and is running."
-                when :server_not_running then "The server isn't running."
-                when :server_error then "Error while starting server."
-                when :no_serves then "No files are being served. Try running `midb serve file.json`"
-                when :syntax then "Syntax error. See `midb help`"
-                when :file_404 then "File not found."
-                when :not_json then "Specified file isn't JSON!"
-                when :json_exists then "Specified file is already being served."
-                when :json_not_exists then "The JSON file isn't being served."
-                when :unsupported_engine then "The specified database engine isn't supported by midb."
-                when :already_project then "This directory already contains a midb project."
-                when :bootstrap then "midb hasn't been bootstraped in this folder. Run `midb bootstrap`."
-                when :no_help then "No help available for this command. See a list of commands with `midb help`."
-                else "Unknown error: #{err.to_s}"
-                end
-      abort("Fatal error: #{errmsg}")
+  module Interface
+    # A view that outputs errors.
+    class Errors
+      # Handles fatal errors that will cause the application to abrort.
+      # 
+      # @param err [Symbol] The ID of the error that's to be reported.
+      def self.die(err)
+        errmsg =  case err
+          when :noargs then "No command supplied. See `midb help`."
+          when :server_already_started then "The server has already been started and is running."
+          when :server_not_running then "The server isn't running."
+          when :server_error then "Error while starting server."
+          when :no_serves then "No files are being served. Try running `midb serve file.json`"
+          when :syntax then "Syntax error. See `midb help`"
+          when :file_404 then "File not found."
+          when :not_json then "Specified file isn't JSON!"
+          when :json_exists then "Specified file is already being served."
+          when :json_not_exists then "The JSON file isn't being served."
+          when :unsupported_engine then "The specified database engine isn't supported by midb."
+          when :already_project then "This directory already contains a midb project."
+          when :bootstrap then "midb hasn't been bootstraped in this folder. Run `midb bootstrap`."
+          when :no_help then "No help available for this command. See a list of commands with `midb help`."
+          else "Unknown error: #{err.to_s}"
+        end
+        abort("Fatal error: #{errmsg}")
+      end
     end
   end
 end

data/lib/midb/hooks.rb

@@ -0,0 +1,13 @@
+# ADDED in midb-2.0.0a  by unrar #
+#
+# The "hooks" part of the MIDB::API module allows programmers to customize their API.
+# Hooks are methods that are run in the API; overriding them allows you to run a custom API.
+#
+module MIDB
+  module API
+    class Hooks
+      def self.after_get_all_entries()
+      end
+    end
+  end
+end

data/lib/midb/security_controller.rb

@@ -3,40 +3,42 @@ require 'base64'
 require 'cgi'
 
 module MIDB
-  # Controller that handles API HMAC authentication.
-  # 
-  # @note This will probably become a separate project soon.
-  class SecurityController
+  module API
+    # Controller that handles API HMAC authentication.
+    # 
+    # @note This will probably become a separate project soon.
+    class Security
 
-    # Checks if an HTTP header is the authorization one
-    #
-    # @deprecated It's no longer used but kept for historical reasons.
-    # @param header [String] A line of an HTTP header.
-    # @return [Boolean] Whether it's an auth header or not.
-    def self.is_auth?(header)
-       return header.split(":")[0].downcase == "authentication"
-    end
+      # Checks if an HTTP header is the authorization one
+      #
+      # @deprecated It's no longer used but kept for historical reasons.
+      # @param header [String] A line of an HTTP header.
+      # @return [Boolean] Whether it's an auth header or not.
+      def self.is_auth?(header)
+         return header.split(":")[0].downcase == "authentication"
+      end
 
-    # Parses an authentication header so to get the HMAC digest.
-    #
-    # @param header [String] A line of an HTTP header (should have been checked
-    #                         to be an auth header)
-    # @return [String] The HMAC digest as a string.
-    def self.parse_auth(header)
-      return header.split(" ")[1]
-    end
+      # Parses an authentication header so to get the HMAC digest.
+      #
+      # @param header [String] A line of an HTTP header (should have been checked
+      #                         to be an auth header)
+      # @return [String] The HMAC digest as a string.
+      def self.parse_auth(header)
+        return header.split(" ")[1]
+      end
 
-    # Checks if an HMAC digest is properly authenticated.
-    # 
-    # @param header [String] A line of an HTTP header (see #parse_auth)
-    # @param params [String] The data passed via the HTTP request.
-    # @param key [String] The private API key.
-    #
-    # @return [Boolean] Whether the given digest matches the correct one or not.
-    def self.check?(header, params, key)
-      hmac = HMAC::SHA1.new(key)
-      hmac.update(params)
-      return self.parse_auth(header) == CGI.escape(Base64.encode64("#{hmac.digest}"))
+      # Checks if an HMAC digest is properly authenticated.
+      # 
+      # @param header [String] A line of an HTTP header (see #parse_auth)
+      # @param params [String] The data passed via the HTTP request.
+      # @param key [String] The private API key.
+      #
+      # @return [Boolean] Whether the given digest matches the correct one or not.
+      def self.check?(header, params, key)
+        hmac = HMAC::SHA1.new(key)
+        hmac.update(params)
+        return self.parse_auth(header) == CGI.escape(Base64.encode64("#{hmac.digest}"))
+      end
     end
   end
 end