CatBox 0.0.0 → 0.0.1

data/lib/CatBox.rb

@@ -1,6 +1,15 @@
 require "msgpack"
 require "mysql2"
+# @author Christian Stone
+#Main CatBox Class
+#Used for Storing Key Value Data to a MySql table
 class CatBox
+	# Initializes CatBox by creating DB Connection and Creating CatBox table if needed
+	# @param [String] scheme the database to connect to
+	# @param [String] host the IP address of MySql Server
+	# @param [String] user the MySql user on the server
+	# @param [String, nil] password the password of the user
+	# @return [Boolean] True if All Goes Well
 	def initialize(scheme=nil,host="127.0.0.1",user="admin",password=nil)
 		options={:database => scheme,:host =>host, :username => user}
 		options[:password]=password if !password.nil?
@@ -10,58 +19,50 @@ class CatBox
 		test=tables.each do |x|
 			return true if x=="cat_box"
 		end
-		build_table if !test 
+		@client.query( 'CREATE TABLE cat_box (box_key VARCHAR(80) NOT NULL PRIMARY KEY, package BLOB)') if !test 
 		return true
 	end
 
-	def build_table
-		@client.query( 'CREATE TABLE cat_box (box_key VARCHAR(80) NOT NULL PRIMARY KEY, package BLOB)')
-	end
-
+	#Clears CatBox Table
+	# @return [Boolean] True if All Goes Well
 	def empty_cache
 		@client.query( 'TRUNCATE TABLE cat_box;')
-
+		return true
 	end
 
+	#Overide Array Style Operator for usefulness 
+	# @param [String] index the key to look up
+	# @return [Object,nil] The Object stored in that location
 	def [](index)
 		fetch(index)
 	end
 
-	def []=(key,index)
-		put(key,index)
+	#Overide Array Style Operator for usefulness 
+	# @param [String] index the key to look up
+	# @param [Object] data the object to be stored
+	# @return [Object] The Object stored in that location
+	def []=(index,data)
+		put(index,data)
 	end
 
-	def self.[](index)
-		fetch(index)
-	end
-
-	def self.[]=(key,index)
-		put(key,index)
-	end
 
-
-	def put(key, data)
+	#Puts Data into CatBox
+	# @param [String] index the key to look up
+	# @param [Object] data the object to be stored
+	# @return [Object] The Object stored in that location
+	def put(index, data)
 		data=data.to_msgpack
-		@client.query("INSERT INTO cat_box(box_key, package) VALUES ('#{@client.escape(key.to_s)}', '#{@client.escape(data)}') ON DUPLICATE KEY UPDATE package='#{@client.escape(data)}'")
+		@client.query("INSERT INTO cat_box(box_key, package) VALUES ('#{@client.escape(index.to_s)}', '#{@client.escape(data)}') ON DUPLICATE KEY UPDATE package='#{@client.escape(data)}'")
 		return true
 	end
 	
-	def fetch(key)
-		data=@client.query("SELECT package FROM cat_box where box_key='#{@client.escape(key.to_s)}'").first
+	#Gets Data from CatBox
+	# @param [String] index the key to look up
+	# @return [Object,nil] The Object stored in that location
+	def fetch(index)
+		data=@client.query("SELECT package FROM cat_box where box_key='#{@client.escape(index.to_s)}'").first
 		return nil if data.nil?
 		data=data["package"]
 		return MessagePack.unpack(data)
 	end
-
-	def self.put(key, value)
-		@@default_cache.put(key, value)
-	end
-
-	def self.fetch(key)
-		@@default_cache.fetch(key)
-	end
-
-	def self.initialize(scheme=nil,host="127.0.0.1",user="admin",password=nil)
-		@@default_cache=CatBox.new(scheme, host, user, password)
-	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: CatBox
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/CatBox.rb
-homepage: http://rubygems.org/gems/catbox
+homepage: https://rubygems.org/gems/CatBox
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -36,10 +36,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- msgpack
+- mysql2
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: AssCache
+summary: CatBox
 test_files: []
+has_rdoc: