midb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6a12da2fe9657a3beacfe2a00aed774bede4101
-  data.tar.gz: 7af6d67d1a748311d665af0b1330d7ac4ba69dcb
+  metadata.gz: 8a61365a18572ed93ed1115447612d6f1f1463f5
+  data.tar.gz: dbc56dd3cb04e326c2a12e23d887b28f9d389584
 SHA512:
-  metadata.gz: 7eaee7eccb98dbf4001039eea0f2d11a012b305bff7fb822597137b631689cfbae555188f1f5384e2a035067ad836a85920864086c65e1ec03b7f98f35cb3dea
-  data.tar.gz: 1deda596c389b6804abe4cd55202165f4a3897a6169899e5aa4e2f3f3af4cf7101f66a5a474ed5c91bceb8f0b42c09a8163be42de5ca5935d1168a51b4997cd7
+  metadata.gz: 88389b80d4ad740ea1bbf541dd2ee5fc54faf8e99de8266dc26d5350ae0bf1ca5a27bd4776eaef062e73c1040403ba63947899ebb368753f259c8d374b284514
+  data.tar.gz: abc6f7ae590fc3013402739769f6a5f9252cab0c63483c93897931a825abda899d993fd75e01037babe1082cd619ca47c518d06bb82c7bed0102883f8ef4043f

data/lib/midb/dbengine_model.rb

@@ -3,8 +3,25 @@ require 'sqlite3'
 require 'mysql2'
 
 module MIDB
+  # @author unrar
+  # This class handles engine-dependent database operations
   class DbengineModel
+
+    # @!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"]
@@ -13,20 +30,28 @@ module MIDB
       @pwd = MIDB::ServerController.config["dbpassword"]
       @db = MIDB::ServerController.db
     end
-    # Method: connect
+
     # 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
 
-    # Method: query
-    # Perform a query, return a hash
+    # 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)
@@ -35,8 +60,12 @@ module MIDB
       end
     end
 
-    # Method: extract
-    # Extract a field from a query
+    # 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]
@@ -46,5 +75,18 @@ module MIDB
         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
+      end
+    end
   end
 end

data/lib/midb/errors_view.rb

@@ -1,11 +1,12 @@
 require 'midb/server_controller'
 
-# This controller handles errors.
 module MIDB
+  # A view that outputs errors.
   class ErrorsView
-    # Method: die
-    # Handles arguments that cause program termination.
-    # Errors: :noargs, :server_already_started
+
+    # 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`."
@@ -25,7 +26,6 @@ module MIDB
                 else "Unknown error: #{err.to_s}"
                 end
       abort("Fatal error: #{errmsg}")
-
     end
   end
 end

data/lib/midb/security_controller.rb

@@ -2,29 +2,40 @@ require 'hmac-sha1'
 require 'base64'
 require 'cgi'
 
-# midb security controller - handles API authentication 
-# this will probably become another different project soon!
 module MIDB
+  # Controller that handles API HMAC authentication.
+  # 
+  # @note This will probably become a separate project soon.
   class SecurityController
 
-    # Method: is_auth?
     # 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
 
-    # Method: parse_auth
-    # Parses an authentication header
+    # 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
 
-    # Method: check?
-    # Checks if an HMAC digest is properly authenticated
+    # 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)
-      signature = params
       hmac = HMAC::SHA1.new(key)
-      hmac.update(signature)
+      hmac.update(params)
       return self.parse_auth(header) == CGI.escape(Base64.encode64("#{hmac.digest}"))
     end
   end

data/lib/midb/server_controller.rb

@@ -12,23 +12,33 @@ require 'sqlite3'
 module MIDB
   # This controller controls the behavior of the midb server.
   class ServerController
-    # Variable declaration
+
+     # Attribute declaration here
     class << self
-      # args[] => passed by the binary
-      # config => configuration array saved and loaded from .midb.yaml
-      # db => the database we're using
-      # http_status => the HTTP status, sent by the model
+      # @!attribute args
+      #   @return [Array<String>] Arguments passed to the binary.
+      # @!attribute config
+      #   @return [Hash] Contains the project's configuration, saved in .midb.yaml
+      # @!attribute db
+      #   @return [String] Database name (if SQLite is the engine, file name without extension)
+      # @!attribute http_status
+      #   @return [String] HTTP status code and string representation for the header
+      # @!attribute port
+      #   @return [Fixnum] Port where the server will listen.
       attr_accessor :args, :config, :db, :http_status, :port
     end
-    # status => server status
-    # serves[] => JSON files served by the API
+    # Default values
+    #
+    # @see #http_status
+    # @see #args
+    # @see #config
+    # @see #port
     @http_status = "200 OK"
     @args = []
     @config = Hash.new()
     @port = 8081
 
-    # Method: init
-    # Decide what to do according to the supplied command!
+    # Decide the server's behavior depending on the arguments. 
     def self.init()
       # We should have at least one argument, which can be `run` or `serve`
       MIDB::ErrorsView.die(:noargs) if @args.length < 1

data/lib/midb/server_model.rb

@@ -244,7 +244,7 @@ module MIDB
             else
               query = dbe.query(dblink, "SELECT #{field} from #{table} WHERE id=#{row['id']};")
             end
-            jso[row["id"]][name] = query.length > 0 ? dbe.extract(query,field) : "unknown"
+            jso[row["id"]][name] = dbe.length(query) > 0 ? dbe.extract(query,field) : "unknown"
           end
         end
         MIDB::ServerController.http_status = "200 OK"
@@ -284,7 +284,7 @@ module MIDB
           else
             query = dbe.query(dblink, "SELECT #{field} from #{table} WHERE id=#{row['id']};")
           end
-          jso[row["id"]][name] = query.length > 0 ? dbe.extract(query,field) : "unknown"
+          jso[row["id"]][name] = dbe.length(query) > 0 ? dbe.extract(query,field) : "unknown"
         end
       end
       return jso

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - unrar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2