midb 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1800c9b95f115f1c96c363a245c6ba28fbc0541
-  data.tar.gz: 77177bd1d17209dd9cd304ae8a1259851cc93291
+  metadata.gz: d5ef9483dfada39d3e9f8bccc1c44e1e418a49b1
+  data.tar.gz: 954831b1336e3d3402279f2d5b1cd49f99850d50
 SHA512:
-  metadata.gz: 3faa266d28b6965fe4b97e3b4e74cbdcb8b9f538ea76c5381e7d4a28ca614cd0f1704ec20038d9d4272e8a512f2315902bf466991c4edf9c38c42ae6e43c395b
-  data.tar.gz: a418745028a7f5770d66ae4a18ce7a327d5160aa39a1542f0cb5c5072f9413372c4c96d3351c61e3a0243563d7196b835ae240b0299b6e5548900989301b9aa7
+  metadata.gz: 50e11179acc6827bb9fc7ece5f5ecaf4b7938dac3838d82601d2c496a62fd5f6f4fa00fbab474c927a1c925e7aec4ede32603542256627c806e020c7d8010bbb
+  data.tar.gz: e148bf8571b0f54652a79945f92df92ebde4ab67e3898acc4541f1c34342b93fb6fa9d20f8d006e3eb9f44a4f0a9145293e1706e227f993dcceed68d1d50aee5

data/lib/midb/hooks.rb

@@ -3,10 +3,43 @@
 # 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.
 #
+# This hooking technology has been developed in its-hookable.
+#
 module MIDB
   module API
     class Hooks
-      def self.after_get_all_entries()
+      attr_accessor :hooks
+      def initialize()
+        @hooks = Hash.new
+        @hooks["after_get_all_entries"] = []
+        @hooks["format_field"] = []
+      end
+
+      # This method adds a method _reference_ (:whatever) to the hash defined above.
+      def register(hook, method)
+        @hooks[hook].push method
+      end
+
+      # These are the methods that are ran when the hook is called from the main class.
+      # The code can be slightly modified depending on the arguments that each hook takes,
+      # but that's up to the original developer - not the one who does the customization.
+
+
+      def after_get_all_entries(n_entries)
+        @hooks["after_get_all_entries"].each do |f|
+          # Just run :f whenever this method is called, no arguments.
+          Object.send(f, n_entries)
+        end
+      end
+
+      def format_field(field, what)
+        if @hooks["format_field"] == []
+          return what
+        else
+          @hooks["format_field"].each do |f|
+            return Object.send(f, field, what)
+          end
+        end
       end
     end
   end

data/lib/midb/server_controller.rb

@@ -3,6 +3,7 @@ require 'midb/server_view'
 require 'midb/errors_view'
 require 'midb/security_controller'
 require 'midb/serverengine_controller'
+require 'midb/hooks'
 
 require 'yaml'
 require 'socket'
@@ -26,12 +27,14 @@ module MIDB
       #   @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
+      # @!attribute h
+      #   @return [Object] MIDB::API::Hooks instance
+      attr_accessor :args, :config, :db, :http_status, :port, :hooks
 
       # Constructor for this controller.
       #
       # @param args [Array<String>] Arguments passed to the binary.
-      def initialize(args)
+      def initialize(args, hooks=nil)
         # Default values
         #
         # @see #http_status
@@ -42,6 +45,12 @@ module MIDB
         @args = args
         @config = Hash.new()
         @port = 8081
+        if hooks == nil
+          # At some point someone should register this.
+          @hooks = MIDB::API::Hooks.new
+        else
+          @hooks = hooks
+        end
       end
 
       #####################
@@ -172,8 +181,8 @@ module MIDB
           end
         end
 
-        # Call the server engine
-        eng = MIDB::API::Engine.new(@db, @http_status, @config)
+        # Call the server engine and supply the (non)existing hooks
+        eng = MIDB::API::Engine.new(@db, @http_status, @config, @hooks)
         if eng.start(@port)
           @config["status"] = :running
           MIDB::Interface::Server.success()

data/lib/midb/server_model.rb

@@ -10,17 +10,20 @@ module MIDB
   module API
     class Model
 
-      attr_accessor :jsf, :db, :engine
+      attr_accessor :jsf, :db, :engine, :hooks
 
       # Constructor
       #
       # @param jsf [String] JSON file with the schema
       # @param db [String] Database to operate on.
       # @param engine [Object] Reference to the API engine.
+      #
+      # @notice that @hooks (the hooks) are taken from the engine.
       def initialize(jsf, db, engine)
         @jsf = jsf
         @db = db
         @engine = engine
+        @hooks = engine.hooks
       end
 
       # Safely get the structure
@@ -261,6 +264,7 @@ module MIDB
                 query = dbe.query(dblink, "SELECT #{field} from #{table} WHERE id=#{row['id']};")
               end
               jso[row["id"]][name] = dbe.length(query) > 0 ? dbe.extract(query,field) : "unknown"
+              jso[row["id"]][name] = @hooks.format_field(name, jso[row["id"]][name])
             end
           end
           @engine.http_status = "200 OK"
@@ -299,9 +303,10 @@ module MIDB
               query = dbe.query(dblink, "SELECT #{field} from #{table} WHERE id=#{row['id']};")
             end
             jso[row["id"]][name] = dbe.length(query) > 0 ? dbe.extract(query,field) : "unknown"
+            jso[row["id"]][name] = @hooks.format_field(name, jso[row["id"]][name])
           end
         end
-        MIDB::API::Hooks.after_get_all_entries()
+        @hooks.after_get_all_entries(rows.length)
         return jso
       end
     end

data/lib/midb/server_view.rb

@@ -74,7 +74,7 @@ module MIDB
       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 "midb v1.1.1 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."

data/lib/midb/serverengine_controller.rb

@@ -3,6 +3,7 @@ require 'midb/server_model'
 require 'midb/server_view'
 require 'midb/errors_view'
 require 'midb/security_controller'
+require 'midb/hooks'
 
 require 'yaml'
 require 'socket'
@@ -22,17 +23,25 @@ module MIDB
       #   @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
-      attr_accessor :config, :db, :http_status
+      # @!attribute h
+      #   @return [Object] MIDB::API::Hooks instance
+      attr_accessor :config, :db, :http_status, :hooks
+
 
       # 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)
+      def initialize(db, stat, cnf, hooks=nil)
         @config = cnf
         @db = db
         @http_status = stat
+        if hooks == nil
+          @hooks = MIDB::API::Hooks.new
+        else
+          @hooks = hooks
+        end
       end
 
       # Starts the server on a given port (default: 8081)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: midb
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - unrar