bukkit 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b456919320509c81ec4330d3fea300e46e96ca67
-  data.tar.gz: 5b07179f64b14ed897b797b77dda010079a0b8c8
+  metadata.gz: 28cb8d634661578cf277b6fc98310b33d3cfa09f
+  data.tar.gz: 78c6d26768e07272475313a00d1047f30f4fa1c5
 SHA512:
-  metadata.gz: 9198e59e4b3bf729c6e80cb886361417f1f2e8cd3ae42ca240ebb78606cb477247ef42a3486eff740de1ecb6ffec50020818cb4aae153465ecf1c3ff7535cfd8
-  data.tar.gz: 937abdb09b5882c8887e7f37b702eaf0d2f258e6bccbc03f25f4bb5779b12851141b60bc04531f789161596e4c031632c81a369bca3bad983b2877b304bed8ad
+  metadata.gz: 9f607ffc2ff9803d38f69f652d8ec8211cae91d345e5c8b024bf1871ff017055fe703410011d24b9c221025827458639c48cbaa47b3df0afc4b248f576b0bbcd
+  data.tar.gz: 1535f425f630dfe2f6cf43db46fd1247e968dad1ea41d89404bf8f7cf8ab02f1692c23d11d4f5f5e82dc869669e6296c85cfc4b78cae1c88c3b1b177de75ad0e

data/CHANGELOG

@@ -1,4 +1,5 @@
 v0.1.0: Added 'update' command and a few bug fixes.
 v0.1.1: Major bug fix.
 v0.1.2: 'website' command fixed.
-v0.1.3: Minor bug fixes.
+v0.1.3: Minor bug fixes.
+v0.1.4: Much better documentation.

data/README.md

@@ -19,3 +19,12 @@ A command line wrapper for CraftBukkit.
 `bukkit install pluginname` Installs a new plugin. As long as it is on [dev.bukkit.org](http://dev.bukkit.org/).
 
 `bukkit website pluginname` Opens the website of a plugin.
+
+`bukkit update` Get's latest version of CraftBukkit.
+
+`bukkit [-[-h]elp]` Displays help for commands.
+
+`bukkit [-[-v]ersion]` Gives current Bukkit CLI version
+
+###Prerequisites:
+

data/lib/bukkit.rb

@@ -1,4 +1,4 @@
-# Orderly and Alphabetical requires h, i, n, s, v
+# Orderly and Alphabetical Require Statements
 require 'rubygems'
 
 require 'bukkit/download'
@@ -15,10 +15,10 @@ module Bukkit
 
 # First arg control flow
 	case opt1
-	when "-v", "--version", "version"
+	when "-v", "--version", "version", "v"
 		puts Bukkit::VERSION_FULL
-	when "-h", "--help", "help"
-		Bukkit::help
+	when "-h", "--help", "help", "h"
+		Bukkit::Help.all
 	when "new"
 		Bukkit::new
 	when "start"
@@ -32,10 +32,11 @@ module Bukkit
 	else
 		if opt1.nil?
 			puts "You didn't enter a command.\n"
-			Bukkit::help
+			Bukkit::Help.all
 		else
 			puts "'#{opt1}' is not a command."
 			puts "Run 'bukkit --help' for a list of commands."
+			Bukkit::Help.all
 		end
 	end
 end

data/lib/bukkit/download.rb

@@ -7,6 +7,7 @@ module Bukkit
 				file.write open("#{uri}").read
 			end
 		rescue Errno::ENOENT
+			Bukkit::Help.download
 			abort "Error! No internet connection."
 		end
 	end

data/lib/bukkit/help.rb

@@ -1,26 +1,51 @@
 module Bukkit
-	def self.help
-		puts "  Commands:"
-		puts "    Create new server:"
-		puts "      bukkit new SERVER_NAME"
-		puts "\n"
-		puts "    Start the server:"
-		puts "      bukkit start"
-		puts "\n"
-		puts "    Install a plugin:"
-		puts "      bukkit install PLUGIN_NAME"
-		puts "\n"
-		puts "    Open a plugin's website:"
-		puts "      bukkit website PLUGIN_NAME"
-		puts "\n"
-		puts "    Update your version of CraftBukkit:"
-		puts "      bukkit update"
-		puts "\n"
-		# Put Last
-		puts "    Show this page:"
-		puts "      bukkit --help OR bukkit -h"
-		puts "\n"
-		puts "    Get version:"
-		puts "      bukkit --version OR bukkit -v"
+	class Help
+
+		# All Help Commands
+
+		def self.all
+			puts "Usage: bukkit COMMAND [OPTIONS]"
+			puts ""
+			puts "COMMANDS:"
+			
+			new
+			start
+			install
+			website
+			update
+			help
+			version
+		end
+
+		# Individual Help Commands
+
+		def self.new
+			puts "    USAGE: bukkit new my-awesome-server-name"
+			puts "        Creates a new server."
+		end
+		def self.start
+			puts "    USAGE: bukkit start"
+			puts "        Starts up your server. Must be run in the server's root directory."
+		end
+		def self.install
+			puts "    USAGE: bukkit install pluginname"
+			puts "        Installs a new plugin. As long as it is on http://dev.bukkit.org."
+		end
+		def self.website
+			puts "    USAGE: bukkit website pluginname"
+			puts "        Opens the website of a plugin."
+		end
+		def self.update
+			puts "    USAGE: bukkit update"
+			puts "        Get's latest version of CraftBukkit."
+		end
+		def self.help
+			puts "    USAGE: bukkit [-[-h]elp]"
+			puts "        Displays help for commands."
+		end
+		def self.version
+			puts "    USAGE: bukkit [-[-v]ersion]"
+			puts "        Gives current Bukkit CLI version"
+		end
 	end
 end

data/lib/bukkit/install.rb

@@ -6,7 +6,7 @@ require 'launchy'
 module Bukkit
 	def self.install
 		$opt2 = ARGV[1].downcase
-		abort("USAGE: bukkit install PLUGIN_NAME") if $opt2.nil?
+		abort(Bukkit::Help.install) if $opt2.nil?
 		begin
 			plugins_api = JSON.parse(open("http://api.bukget.org/3/plugins/bukkit/#{$opt2}").read)
 			website = plugins_api["website"]

data/lib/bukkit/new.rb

@@ -23,8 +23,10 @@ module Bukkit
 			Bukkit::start
 		else
 			if q1.length > 0
+				Bukkit::Help.new
 				abort("  \"#{q1}\" is not an option.")
 			else
+				Bukkit::Help.new
 				abort("  You didn't enter an option.")
 			end
 		end

data/lib/bukkit/start.rb

@@ -8,6 +8,7 @@ module Bukkit
 			puts "Make sure that you're in your server's root directory."
 			puts "If Java runtime is not present, run 'bukkit start' once Java is installed to complete the installation."
 			system 'java -jar craftbukkit.jar'
+			Bukkit::Help.start
 		end
 	end
 end

data/lib/bukkit/update.rb

@@ -27,6 +27,7 @@ module Bukkit
 			end
 		rescue
 			puts "Uh oh! Something failed. Please report what you were doing at the time of this bug, and any other info you have at: https://github.com/JesseHerrick/bukkit/issues/new"
+			Bukkit::Help.update
 		end
 	end
 end

data/lib/bukkit/version.rb

@@ -1,4 +1,4 @@
 module Bukkit
-	VERSION = "0.1.3"
+	VERSION = "0.1.4"
 	VERSION_FULL = "Bukkit-CLI v#{VERSION}"
 end

data/lib/bukkit/website.rb

@@ -11,6 +11,7 @@ module Bukkit
 			Launchy.open(website)
 		rescue OpenURI::HTTPError
 			puts "  Plugin not found.\n  Make sure you have the name correct."
+			Bukkit::Help.website
 		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bukkit
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jesse Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-07 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json