minecraft-jsonapi 0.0.7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in minecraft-jsonapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Hoffman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# Minecraft::JSONAPI
+
+A simple Ruby gem to interact with a Minecraft server running [the JSONAPI mod](https://github.com/alecgorge/jsonapi)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minecraft-jsonapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minecraft-jsonapi
+
+## Usage
+
+```ruby
+require 'minecraft-jsonapi'
+
+api = Minecraft::JSONAPI.new(host: "123.45.6.78", port: 20059, username: "admin", password: "12345", salt: "mmm")
+
+api.sendMessage "Dinnerbone", "Hello, Dinnerbone!"
+
+# Namespaced commands can be sent via blocks...
+api.permissions do |perms|
+	perms.addPlayerToGroup "Fustrate", "Jolly Good Fellows"
+	groups = perms.getGroups
+end
+
+# or Ruby's built-in "send" method
+files = api.send("fs.listDirectory", ".")
+
+# which is equivalent to
+#   files = api.call(:"fs.listDirectory" => ".")[0]
+# and
+#   files = api.fs { |fs| fs.listDirectory "." }
+
+percent_disk_usage = api.system do |system|
+	system.getDiskUsage / system.getDiskSize
+end
+
+players_online = api.getPlayerCount
+players_limit = api.getPlayerLimit
+api.banWithReason "Nardageddon", "For excessive use of jungle planks."
+api.reloadServer
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/minecraft-jsonapi.rb

@@ -0,0 +1,56 @@
+require 'minecraft-jsonapi/version'
+require 'minecraft-jsonapi/namespace'
+require 'minecraft-jsonapi/jsonapi'
+require 'minecraft-jsonapi/response'
+
+require 'json'
+require 'digest/sha2'
+require 'net/http'
+require 'cgi'
+
+module Minecraft
+	module JSONAPI
+		CALL_URL          = 'http://%{host}:%{port}/api/call?method=%{method}&args=%{args}&key=%{key}'
+		CALL_MULTIPLE_URL = 'http://%{host}:%{port}/api/call-multiple?method=%{method}&args=%{args}&key=%{key}'
+
+		# Shortcut to Minecraft::JSONAPI::JSONAPI.new
+		def self.new(options = {})
+			Minecraft::JSONAPI::JSONAPI.new options
+		end
+
+		def self.send_request(url)
+			get_raw_response(url).response
+		end
+
+		def self.get_raw_response(url)
+			uri = URI.parse(url)
+
+			http = Net::HTTP.new(uri.host, uri.port)
+			http.open_timeout = 10
+			http.read_timeout = 10
+			response = http.request(Net::HTTP::Get.new(uri.request_uri))
+
+			Minecraft::JSONAPI::Response.new(response.body)
+		end
+
+		# Wrap arguments in an array if they're not already an array or hash
+		# Converts nil to [], "" to [""], "Username" to ["Username"], etc.
+		def self.map_to_array(arguments)
+			if arguments.nil?
+				[]
+			elsif arguments.is_a?(Array) || arguments.is_a?(Hash)
+				arguments
+			else
+				[arguments]
+			end
+		end
+
+		def self.url_encoded_json(data)
+			begin
+				CGI.escape JSON.generate data
+			rescue JSON::GeneratorError
+				CGI.escape data
+			end
+		end
+	end
+end

data/lib/minecraft-jsonapi/jsonapi.rb

@@ -0,0 +1,51 @@
+module Minecraft
+	module JSONAPI
+		class JSONAPI
+			def initialize(options = {})
+				raise "A username must be provided." if options[:username].nil?
+				raise "A password must be provided." if options[:password].nil?
+				raise "Please use a salt."           if options[:salt].nil?
+
+				@host     = options[:host]     || 'localhost'
+				@port     = options[:port]     || 20059
+				@username = options[:username]
+				@password = options[:password]
+				@salt     = options[:salt]
+			end
+
+			def make_url(method, args)
+				if method.is_a? Array
+					Minecraft::JSONAPI::CALL_MULTIPLE_URL % { host: @host, port: @port, method: Minecraft::JSONAPI.url_encoded_json(method), args: Minecraft::JSONAPI.url_encoded_json(args), key: create_key(method) }
+				else
+					Minecraft::JSONAPI::CALL_URL          % { host: @host, port: @port, method: Minecraft::JSONAPI.url_encoded_json(method), args: Minecraft::JSONAPI.url_encoded_json(args), key: create_key(method) }
+				end
+			end
+
+			def call(methods)
+				method_names = methods.keys.map(&:to_s)
+				method_arguments = methods.values.map { |args| Minecraft::JSONAPI.map_to_array args }
+
+				url = make_url(method_names, method_arguments)
+				Minecraft::JSONAPI.send_request(url)
+			end
+
+			def method_missing(method, *args, &block)
+				if block_given?
+					block.call Minecraft::JSONAPI::Namespace.new(self, method.to_s)
+				else
+					url = make_url(method.to_s, args)
+					Minecraft::JSONAPI.send_request(url)
+				end
+			end
+
+			def create_key(method)
+				method = JSON.generate(method) if method.is_a? Array
+
+				Digest::SHA2.new.update([@username, method, @password, @salt].join).to_s
+			end
+
+			def namespace
+			end
+		end
+	end
+end

data/lib/minecraft-jsonapi/namespace.rb

@@ -0,0 +1,22 @@
+module Minecraft
+	module JSONAPI
+		class Namespace
+			def initialize(parent, namespace)
+				@parent = parent
+				@namespace = namespace
+			end
+
+			def method_missing(method, *args)
+				method = [@namespace, method.to_s].join(".")
+				url = @parent.make_url(method, args)
+
+				Minecraft::JSONAPI.send_request(url)
+			end
+
+			# This will bubble upwards until we hit the actual JSONAPI class
+			def make_url(*args)
+				@parent.make_url(*args)
+			end
+		end
+	end
+end

data/lib/minecraft-jsonapi/response.rb

@@ -0,0 +1,32 @@
+module Minecraft
+	module JSONAPI
+		class Response
+			def initialize(data)
+				data = JSON.parse data
+
+				# Was this a multi-call?
+				if data["source"].is_a? Array
+					@result =   data["success"].map { |r| r["result"] }
+					@source =   data["success"].map { |r| r["source"] }
+					@response = data["success"].map { |r| r["success"] }
+				else
+					@result =   data["result"]
+					@source =   data["source"]
+					@response = data["success"]
+				end
+			end
+
+			def result
+				@result
+			end
+
+			def source
+				@source
+			end
+
+			def response
+				@response
+			end
+		end
+	end
+end

data/lib/minecraft-jsonapi/version.rb

@@ -0,0 +1,5 @@
+module Minecraft
+	module JSONAPI
+		VERSION = "0.0.7"
+	end
+end

data/minecraft-jsonapi.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minecraft-jsonapi/version'
+
+Gem::Specification.new do |gem|
+	gem.name          = "minecraft-jsonapi"
+	gem.version       = Minecraft::JSONAPI::VERSION
+	gem.authors       = ["Steven Hoffman"]
+	gem.email         = ["git@fustrate.com"]
+	gem.description   = "A simple Ruby gem to interact with a Minecraft server running the JSONAPI mod"
+	gem.summary       = "A simple Ruby gem to interact with a Minecraft server running the JSONAPI mod"
+	gem.homepage      = "https://github.com/Fustrate/minecraft-jsonapi"
+
+	gem.files         = `git ls-files`.split($/)
+	gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+	gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+	gem.require_paths = ["lib"]
+end

data/test/test_minecraft-jsonapi.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'minecraft-jsonapi'
+
+class MinecraftJSONAPITest < Test::Unit::TestCase
+	def api
+		@api ||= Minecraft::JSONAPI.new(username: "admin", password: "12345", salt: "mmm")
+	end
+
+	def test_create_new_shortcut
+		assert_equal Minecraft::JSONAPI::JSONAPI, api.class
+	end
+
+	def test_map_to_array
+		assert_equal [], Minecraft::JSONAPI.map_to_array(nil)
+		assert_equal [""], Minecraft::JSONAPI.map_to_array("")
+		assert_equal ["Fustrate"], Minecraft::JSONAPI.map_to_array("Fustrate")
+
+		assert_equal [12345], Minecraft::JSONAPI.map_to_array(12345)
+		assert_equal [1, 2, 3], Minecraft::JSONAPI.map_to_array([1, 2, 3])
+		assert_equal [1, "2", 3.0], Minecraft::JSONAPI.map_to_array([1, "2", 3.0])
+
+		hash = { :one => "two", :three => "four" }
+
+		assert_equal hash, Minecraft::JSONAPI.map_to_array(hash)
+	end
+
+	def test_url_encoded_json
+		assert_equal "%5B%22test%22%5D", Minecraft::JSONAPI.url_encoded_json(["test"])
+		assert_equal "%5B%22test%22%2C5%5D", Minecraft::JSONAPI.url_encoded_json(["test", 5])
+	end
+
+	def test_connection
+		assert_equal 0, api.getPlayerCount
+	end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: minecraft-jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Steven Hoffman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-22 00:00:00.000000000 Z
+dependencies: []
+description: A simple Ruby gem to interact with a Minecraft server running the JSONAPI
+  mod
+email:
+- git@fustrate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minecraft-jsonapi.rb
+- lib/minecraft-jsonapi/jsonapi.rb
+- lib/minecraft-jsonapi/namespace.rb
+- lib/minecraft-jsonapi/response.rb
+- lib/minecraft-jsonapi/version.rb
+- minecraft-jsonapi.gemspec
+- test/test_minecraft-jsonapi.rb
+homepage: https://github.com/Fustrate/minecraft-jsonapi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple Ruby gem to interact with a Minecraft server running the JSONAPI
+  mod
+test_files:
+- test/test_minecraft-jsonapi.rb