bukkit 0.1.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28cb8d634661578cf277b6fc98310b33d3cfa09f
-  data.tar.gz: 78c6d26768e07272475313a00d1047f30f4fa1c5
+  metadata.gz: e7ced55fac2997afa5877dd165625d82bca1f8d1
+  data.tar.gz: 36590a981aa62acd61f28e0cf23d37b59e6b1e7a
 SHA512:
-  metadata.gz: 9f607ffc2ff9803d38f69f652d8ec8211cae91d345e5c8b024bf1871ff017055fe703410011d24b9c221025827458639c48cbaa47b3df0afc4b248f576b0bbcd
-  data.tar.gz: 1535f425f630dfe2f6cf43db46fd1247e968dad1ea41d89404bf8f7cf8ab02f1692c23d11d4f5f5e82dc869669e6296c85cfc4b78cae1c88c3b1b177de75ad0e
+  metadata.gz: 5e39dddb56387717c3d715d225264d51a5cc7290df1c64ee733f7bda26d630438f4f1e7e3682b06700397fd5e53c6071cacbafbef2809faaccb309d15e61dee5
+  data.tar.gz: 447d45871aae6430387cd021edbc195d057c6e75f288ba1102bddde54ee02aaf5f1fb952419d69322686ed89c0121e0f6cbca7438791bee6f9504582bc1920fe

data/CHANGELOG

@@ -2,4 +2,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.4: Much better documentation.
+v0.1.4: Much better documentation.
+v1.0.0: Total revamp of the CLI and docs. Definitely v1.0.

data/README.md

@@ -1,4 +1,4 @@
-bukkit
+Bukkit-CLI
 ======
 
 A command line wrapper for CraftBukkit.
@@ -12,19 +12,25 @@ A command line wrapper for CraftBukkit.
 ```
 
 ###Commands:
-`bukkit new my-awesome-server-name` Creates a new server.
+__To View Command Options run:__ `bukkit [command] [options: --help, -h]`
 
-`bukkit start` Starts up your server. Must be run in the server's root directory.
+`bukkit [--help, -h]` Display global help.
 
-`bukkit install pluginname` Installs a new plugin. As long as it is on [dev.bukkit.org](http://dev.bukkit.org/).
+`bukkit install` Install a new bukkit plugin.
 
-`bukkit website pluginname` Opens the website of a plugin.
+`bukkit new my-awesome-server-name [options: --rb, --beta, --dev]` Create a new Bukkit server.
 
-`bukkit update` Get's latest version of CraftBukkit.
+`bukkit start` Start your server.
 
-`bukkit [-[-h]elp]` Displays help for commands.
+`bukkit update [options: --rb, --beta, --dev]` Download the latest version of CraftBukkit.
 
-`bukkit [-[-v]ersion]` Gives current Bukkit CLI version
+`bukkit website my-favorite-plugin [options: --url (just show url, don't open)]` Visit a plugin's website.
 
 ###Prerequisites:
 
+* [Ruby](https://www.ruby-lang.org/en/downloads/) ([RVM](http://rvm.io/) - for Linux/Mac and [RubyInstaller](http://rubyinstaller.org/) - Windows)
+  * `2.0.0` (recommended!)
+  * `1.9.3` (go right ahead)
+  * `other versions` (may or may not work, if you find a bug though [report it!](https://github.com/JesseHerrick/bukkit/issues/new))
+* [Java](http://java.com/en/download/manual.jsp)
+  * All Versions Allowed by [Bukkit](https://github.com/Bukkit/Bukkit).

data/bin/bukkit

@@ -2,4 +2,133 @@
 
 $: << File.expand_path(File.dirname(__FILE__) + "/../lib")
 
-require 'bukkit.rb'
+require 'rubygems'
+require 'commander/import'
+
+require 'bukkit.rb'
+
+program :version, Bukkit::VERSION
+program :description, "A Command Line Interface for CraftBukkit."
+
+command :new do |c|
+	c.syntax = "bukkit new my-awesome-server-name [options]"
+	c.summary = "Create a new Bukkit server."
+	c.description = "Create a new Bukkit server with the given name."
+	c.example "Creates a new server with the name 'my-awesome-server-name'.", "bukkit new my-awesome-server-name"
+	c.option "--rb", "Create a new server with the recommended build."
+	c.option "--beta", "Create a new server with the beta build."
+	c.option "--dev", "Create a new server with the dev build."
+	# TODO: Those are bools, pass the t/f values to a case statement then pass that to Bukkit::new
+	c.action do |args, options|
+    # Make 'dir' = to first arg
+    dir = args.shift
+
+		if options.rb == true
+			build = "rb"
+		elsif options.beta == true
+			build = "beta"
+		elsif options.dev == true
+			build = "dev"
+		else
+			build = ask "What build would you like? (rb/beta/dev)"
+			case build.downcase
+			when "rb", "recommended", "r"
+				build = "rb"
+			when "beta", "b"
+				build = "beta"
+			when "dev", "d", "developer"
+				build = "dev"
+			else
+				abort "ERROR: Invalid option '#{build}'\nTry `bukkit new --help`"
+			end
+		end
+    begin
+		  Bukkit::new(build, dir)
+    rescue TypeError
+      abort "ERROR: Server name not specified.\nTry `bukkit new --help`"
+    end
+	end
+end
+
+command :start do |c|
+  c.syntax = "bukkit start"
+  c.summary = "Start your server."
+  c.description = "Start the bukkit server. (Must be in server's root)"
+  c.example "Start your server.", "bukkit start"
+  c.action do |args, options|
+    puts "Starting the server!"
+  end
+end
+
+command :install do |c|
+  c.syntax = "bukkit install my-favorite-plugin [options]"
+  c.summary = "Install a new bukkit plugin."
+  c.description = "Installs a new bukkit plugin. Must be on dev.bukkit.org. (can also be a zip!)"
+
+  c.example "Installs the plugin 'my-favorite-plugin' (will ask for website when done).", "bukkit install my-favorite-plugin"
+
+  c.example "Installs the plugin 'my-favorite-plugin' and doesn't ask to open it's website", "bukkit install my-favorite-plugin --nowebsite"
+  c.option "--nowebsite", "Doesn't ask for website after install."
+  
+  c.action do |args, options|
+    if options.nowebsite == true
+    	Bukkit::Install.normal(args.shift, true)
+    else
+    	Bukkit::Install.normal(args.shift)
+    end
+  end
+end
+
+command :website do |c|
+  c.syntax = "bukkit website my-favorite-plugin"
+  c.summary = "Open a plugin's website."
+  c.description = "Opens a plugin's website your default browser."
+  c.example "Open a plugin's website.", "bukkit website my-favorite-plugin"
+  c.option "-u", "--url", "Only show the url."
+  c.action do |args, options|
+    plugin = args.shift.downcase
+    if options.url == true
+      Bukkit.url(plugin)
+    else
+      Bukkit.website(plugin)
+    end
+  end
+end
+
+command :update do |c|
+  c.syntax = "bukkit update [options]"
+  c.summary = "Get the latest version of bukkit."
+  c.description = "Download the latest version of CraftBukkit."
+  c.example "Updates your server to the latest recommended build.", "bukkit update --rb"
+  c.option "--rb", "Get the latest recommended build."
+  c.option "--beta", "Get the latest beta build."
+  c.option "--dev", "Get the latest dev build."
+  # TODO: Those are bools, pass the t/f values to a case statement then pass that to Bukkit::new
+  c.action do |args, options|
+    if options.rb == true
+      build = "rb"
+    elsif options.beta == true
+      build = "beta"
+    elsif options.dev == true
+      build = "dev"
+    else
+      build = ask "What build would you like? (rb/beta/dev)"
+      case build.downcase
+      when "rb", "recommended", "r"
+        build = "rb"
+      when "beta", "b"
+        build = "beta"
+      when "dev", "d", "developer"
+        build = "dev"
+      else
+        abort "ERROR: Invalid option '#{build}'\nTry `bukkit new --help`"
+      end
+    end
+    # Send args & opts to Bukkit::update
+    begin
+      Bukkit::update(build)
+    rescue
+      abort "ERROR: Something bad happened!.\nTry `bukkit new --help`\n  If error persists create an issue with specific details here:\n        https://github.com/JesseHerrick/bukkit/issues/new"
+    end
+  end
+end

data/bukkit.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency('json')
   spec.add_dependency('archive-zip')
   spec.add_dependency('launchy')
+  spec.add_dependency('commander')
 end

data/lib/bukkit.rb

@@ -1,42 +1,11 @@
 # Orderly and Alphabetical Require Statements
 require 'rubygems'
 
+require 'bukkit/check'
 require 'bukkit/download'
-require 'bukkit/help'
 require 'bukkit/install'
 require 'bukkit/new'
 require 'bukkit/start'
 require 'bukkit/update'
 require 'bukkit/version'
-require 'bukkit/website'
-
-module Bukkit
-	opt1 = ARGV[0]
-
-# First arg control flow
-	case opt1
-	when "-v", "--version", "version", "v"
-		puts Bukkit::VERSION_FULL
-	when "-h", "--help", "help", "h"
-		Bukkit::Help.all
-	when "new"
-		Bukkit::new
-	when "start"
-		Bukkit::start
-	when "install"
-		Bukkit::install
-	when "website"
-		Bukkit::website(ARGV[1].downcase)
-	when "update"
-		Bukkit::update
-	else
-		if opt1.nil?
-			puts "You didn't enter a command.\n"
-			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
+require 'bukkit/website'

data/lib/bukkit/check.rb

@@ -0,0 +1,11 @@
+module Bukkit
+	class Check
+		def self.root?
+			if File.exists? "craftbukkit.jar"
+				true
+			else
+				false
+			end
+		end
+	end
+end

data/lib/bukkit/download.rb

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

data/lib/bukkit/install.rb

@@ -4,21 +4,31 @@ require 'archive/zip'
 require 'launchy'
 
 module Bukkit
-	def self.install
-		$opt2 = ARGV[1].downcase
-		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"]
+	class Install
+		def self.normal(plugin, nowebsite = false)
+			# Check if in root
+			abort "ERROR: Not in server's root directory.\nTry `bukkit new my-awesome-server-name`." if Bukkit::Check.root? == false
+
+			# BukGet API for Plugin Installs
+			plugins_api = JSON.parse(open("http://api.bukget.org/3/plugins/bukkit/#{plugin}").read)
+			# Get Plugin's Website
+			@@website = plugins_api["website"]
+			# Get Plugin's Download Link
 			download = plugins_api["versions"][0]["download"]
+			# Get Plugin's Filename
 			filename = plugins_api["versions"][0]["filename"]
+			# Switch to plugins dir
+			plugin = plugin.downcase
 			Dir.chdir("plugins")
-			puts "Downloading #{$opt2} from #{website}..."
+			puts "Downloading #{plugin} from #{@@website}..."
+			# Download File from dev.bukkit.org
 			Bukkit::download(filename, download)
+
+			# Unzip if it's a zip
 			if File.extname(filename) == ".zip"
 				# Extract Zip Archive
-				Archive::Zip.extract(filename, $opt2) 
-				Dir.chdir($opt2)
+				Archive::Zip.extract(filename, plugin) 
+				Dir.chdir(plugin)
 				jarfiles = Dir.glob("*.jar")
 				# Move each jar file outside the folder.
 				jarfiles.each do |jar|
@@ -26,27 +36,31 @@ module Bukkit
 				end
 				Dir.chdir("../")
 				# Delete the extracted folder.
-				%x(rm -rf #{$opt2}/)
+				%x(rm -rf #{plugin}/)
 				# Delete the archive.
 				%x(rm #{filename})
-				puts "Plugin successfully installed!"
-				ask_website
+
+				puts "#{plugin.capitalize!} successfully installed!"
+
+				if nowebsite == false
+					website?
+				end
 			else
-				puts "Plugin successfully installed!"
-				ask_website
+				if nowebsite == true
+					abort
+				else
+					website?
+				end
 			end
-		rescue Errno::ENOENT
-			puts "  You aren't in a server's root directory.\n  'plugins' directory not found."
-		rescue
-			puts "  Plugin not found."
 		end
-	end
-end
 
-def ask_website
-	if ARGV.include? "--website"
-		Bukkit.website($opt2)
-	elsif ARGV.include? "-w"
-		Bukkit.website($opt2)
+		def self.website?
+			website_yn = agree "Would you like to visit it's website? (yes/no)"
+
+			if website_yn == true
+				puts "Launching website!"
+				Launchy.open(@@website)
+			end
+		end
 	end
 end

data/lib/bukkit/new.rb

@@ -1,48 +1,30 @@
 module Bukkit
-	def self.new
-		create_folder
-		puts "  Do want the recommended build, beta build, or dev build?"
-		print "  rb, beta, dev? "
-		q1 = $stdin.gets.chomp
+	# N2K: http://cbukk.it/craftbukkit.jar http://cbukk.it/craftbukkit-beta.jar http://cbukk.it/craftbukkit-dev.jar
+	def self.new(build, dir)
+		# Create a Folder for the Server
+		begin
+			Dir.mkdir(dir)
+			Dir.chdir(dir)
+		rescue Errno::EEXIST
+			abort("ERROR: Directory already exists. Try a different name.")
+		end
 
-		case q1
-		when "rb", "recommended", "r"
-			puts "Downloading CraftBukkit Recommended build... (this could take a minute)\n"
+		case build
+		when "rb"
+			# Download Recommended Build
+			say "Downloading Recommended Build... (this may take a while)"
 			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit.jar")
-			puts "\nSuccessfully downloaded Recommended build."
-			Bukkit::start
-		when "beta", "b"
-			puts "Downloading CraftBukkit Beta build... (this could take a minute)\n"
+		when "beta"
+			# Download Beta Build
+			say "Downloading Beta Build... (this may take a while)"
 			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-beta.jar")
-			puts "\nSuccessfully downloaded Beta build."
-			Bukkit::start
-		when "dev", "development", "d"
-			puts "Downloading CraftBukkit Development build... (this could take a minute)\n"
+		when "dev"
+			# Download Developer Build
+			say "Downloading Developer Build... (this may take a while)"
 			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-dev.jar")
-			puts "\nSuccessfully downloaded Development build."
-			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
-	end
-end
 
-def create_folder
-	opt2 = ARGV[1]
-	if opt2.nil?
-		abort("  Server name not specified.\n  USAGE: 'bukkit new SERVERNAME'")
-	else
-		begin
-			Dir.mkdir(opt2.to_s)
-			Dir.chdir(opt2.to_s)
-		rescue Errno::EEXIST
-			abort("  Directory already exists. Try a different name.")
-		end
+		# Start the Server
+		Bukkit.start
 	end
 end

data/lib/bukkit/start.rb

@@ -1,14 +1,6 @@
 module Bukkit
 	def self.start
-		if ARGV.include? "-s"
-			abort
-		elsif ARGV.include? "-s"
-			abort
-		else
-			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
+		abort "ERROR: You aren't in your server's root directory." if Bukkit::Check.root? == false
+		system 'java -jar craftbukkit.jar'
 	end
 end

data/lib/bukkit/update.rb

@@ -1,33 +1,19 @@
 module Bukkit
-	def self.update
-		begin
-			puts "  Do want the recommended build, beta build, or dev build?"
-			print "  rb, beta, dev? "
-			q1 = $stdin.gets.chomp
-
-			case q1
-			when "rb", "recommended", "r"
-				puts "Downloading CraftBukkit Recommended build... (this could take a minute)\n"
-				Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit.jar")
-				puts "\nSuccessfully updated."
-			when "beta", "b"
-				puts "Downloading CraftBukkit Beta build... (this could take a minute)\n"
-				Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-beta.jar")
-				puts "\nSuccessfully updated."
-			when "dev", "development", "d"
-				puts "Downloading CraftBukkit Development build... (this could take a minute)\n"
-				Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-dev.jar")
-				puts "\nSuccessfully updated."
-			else
-				if q1.length > 0
-					abort("  \"#{q1}\" is not an option.")
-				else
-					abort("  You didn't enter an option.")
-				end
-			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
+	def self.update(build)
+		# Get build url.
+		case build
+		when "rb"
+			# Download the Latest Recommended Build
+			say "Downloading Recommended Build... (this may take a while)"
+			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit.jar")
+		when "beta"
+			# Download the Latest Beta Build
+			say "Downloading Beta Build... (this may take a while)"
+			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-beta.jar")
+		when "dev"
+			# Download the Latest Developer Build
+			say "Downloading Developer Build... (this may take a while)"
+			Bukkit::download("craftbukkit.jar", "http://cbukk.it/craftbukkit-dev.jar")
 		end
 	end
 end

data/lib/bukkit/version.rb

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

data/lib/bukkit/website.rb

@@ -3,15 +3,24 @@ require 'json'
 require 'launchy'
 
 module Bukkit
-	def self.website(plugin_name)
-		begin
-			plugins_api = JSON.parse(open("http://api.bukget.org/3/plugins/bukkit/#{plugin_name}").read)
-			website = plugins_api["website"]
-			puts "Opening #{plugin_name}'s website in your default browser."
-			Launchy.open(website)
-		rescue OpenURI::HTTPError
-			puts "  Plugin not found.\n  Make sure you have the name correct."
-			Bukkit::Help.website
-		end
-	end
-end
+   def self.website(plugin)
+        begin
+    	    plugins_api = JSON.parse(open("http://api.bukget.org/3/plugins/bukkit/#{plugin}").read)
+    	    website = plugins_api["website"]
+    	    puts "Opening the plugin's website in your default browser..."
+    	    Launchy.open(website)
+    	rescue OpenURI::HTTPError
+    	    puts "ERROR: Plugin not found.\nMake sure you have the name correct.\nTry `bukkit website --help`"
+    	    Bukkit::Help.website
+    	rescue
+    	    puts "ERROR: Plugin name is undefined."
+	   end
+    end
+
+    def self.url(plugin)
+        plugins_api = JSON.parse(open("http://api.bukget.org/3/plugins/bukkit/#{plugin}").read)
+        website = plugins_api["website"]
+        say "\n#{plugin}'s website URL is #{website}."
+        puts ""
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bukkit
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Jesse Herrick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A command line wrapper for CraftBukkit.
 email:
 - school@jessegrant.net
@@ -67,8 +81,8 @@ files:
 - bin/bukkit
 - bukkit.gemspec
 - lib/bukkit.rb
+- lib/bukkit/check.rb
 - lib/bukkit/download.rb
-- lib/bukkit/help.rb
 - lib/bukkit/install.rb
 - lib/bukkit/new.rb
 - lib/bukkit/start.rb

data/lib/bukkit/help.rb

@@ -1,51 +0,0 @@
-module Bukkit
-	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