mcjsonapi 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe76057b271dd85eaaa0cb96984b526c1a3a3667
+  data.tar.gz: 3fc0de21bd28dac3e9bf9bced037c3dab98baa6b
+SHA512:
+  metadata.gz: c11780a9132eed9cdae1da8241930071fd87835efb5d8411e4ce1d30dc2aba18793a5c69d978b9a0ba87448bd60681b7983ce4520ab9c8f7cf8f821573467cbb
+  data.tar.gz: fc3a4dd31508ccbe298e3f9328b45336b69cb57044b8e277ec685230ef1e726b9f2e56a19ae658213c5e9191e2c78c04a2dc091af05c5f759292bdd866470a54

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - elomatreb@googlemail.com
+
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+guard "rspec" do
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ole B. <elomatreb@googlemail.com>
+
+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,44 @@
+# mcjsonapi [![Build Status](https://api.travis-ci.org/elomatreb/mcjsonapi.svg?branch=dev)](https://travis-ci.org/elomatreb/mcjsonapi)
+
+This rubygem provides an easy way to interact with a [Minecraft](https://minecraft.net) ([bukkit](https://bukkit.org/)) server running the [JSONAPI plugin](https://github.com/alecgorge/jsonapi). It uses the v2-API, so it has full support for permissions.
+
+Calling multiple methods is not yet implemented, but is planned for the 1.0 release.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+```
+gem 'mcjsonapi', '~> 0.9.0'
+```
+(Don't forget to run `$ bundle install`)
+
+Or install it manually:
+```
+$ gem install mcjsonapi
+```
+## Usage
+```ruby
+require "mcjsonapi"
+
+# Create a new API instance
+api = Mcjsonapi::API.new username: "username", password: "password", host: "localhost", port: 20059
+# localhost:20059 is assumed as default host/port
+
+# Call a single method
+api.call "server.version"
+# => "git-Bukkit-1.6.4-R2.0-b2918jnks (MC: 1.6.4)"
+
+# Call a method with arguments
+api.call { name: "players.online.send_message", arguments: ["Player", "Hello World"] }
+
+# Generate a call key
+api.generate_key("server.version")
+# => "8433478ce05d331c743ff69cad00792039396d222d304545bd40f2ccecd714c9"
+    
+# Calling multiple methods at once is not yet implemented.
+```
+
+## License
+
+This project is available under the permissive [MIT license](http://opensource.org/licenses/MIT). (See [LICENSE.md](LICENSE.md) for details).
+Any type of contribution is appreciated.

data/Rakefile

@@ -0,0 +1,8 @@
+require "rspec/core/rake_task"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/mcjsonapi.rb

@@ -0,0 +1,9 @@
+# Require files
+["api", "version"].each do |f|
+  require "mcjsonapi/#{f}"
+end
+
+# Require gems
+["digest/sha2", "net/http", "json"].each do |g|
+  require g
+end

data/lib/mcjsonapi/api.rb

@@ -0,0 +1,56 @@
+module Mcjsonapi
+  class API
+    attr_reader :host, :port, :username
+
+    def initialize(options = {})
+      raise ArgumentError, "Username and password must be given." if options[:username].nil? || options[:password].nil?
+
+      @host = options[:host] || "localhost"
+      @port = options[:port] || 20059
+
+      @username = options[:username]
+      @password = options[:password]
+    end
+
+    def generate_key(method)
+      Digest::SHA256.hexdigest @username+method+@password
+    end
+
+    def call(options = {})
+
+      if options.is_a? String
+        if options.empty?
+          raise ArgumentError, "A method must be given."
+        else
+          options = { name: options }
+        end
+      elsif options.is_a? Hash
+        if options.empty? || options[:name].nil?
+          raise ArgumentError, "A method must be given."
+        end
+      else
+        raise ArgumentError, "A method must be given."
+      end
+
+      options[:username] = @username
+      options[:key]      = generate_key(options[:name])
+
+      data = URI::encode JSON.generate(options)
+      
+      response = Net::HTTP.get_response URI("http://#{@host}:#{@port}/api/2/call?json=#{data}")
+
+      raise APIError, "The API responded with an HTTP error." unless response.is_a? Net::HTTPOK
+
+      response_data = JSON.parse(response.body)[0]
+
+      if response_data["is_success"]
+        return response_data["success"]
+      else
+        raise APIError, "The API raised an error: #{response_data["error"]["message"]} (Code #{response_data["error"]["code"]})"
+      end
+    end
+
+  end
+
+  class APIError < StandardError; end
+end

data/lib/mcjsonapi/version.rb

@@ -0,0 +1,3 @@
+module Mcjsonapi
+  VERSION = "0.9.0"
+end

data/mcjsonapi.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mcjsonapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mcjsonapi"
+  spec.version       = Mcjsonapi::VERSION
+  spec.authors       = ["elomatreb"]
+  spec.email         = ["elomatreb@googlemail.com"]
+  spec.summary       = "A gem to interact with a Minecraft server running the JSONAPI plugin."
+  spec.description   = <<-EOF
+    A gem to interact with a Minecraft (bukkit) server that has the 
+    {JSONAPI plugin}[https://github.com/alecgorge/jsonapi] installed. It supports
+    calling single and multiple methods.
+  EOF
+  spec.homepage      = "https://github.com/elomatreb/mcjsonapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/mcjsonapi_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+
+describe "Mcjsonapi:" do
+  let(:username) { "username" }
+  let(:password) { "password" }
+  let(:version)  { 'git-Bukkit-1.6.4-R2.0-b2918jnks (MC: 1.6.4)' }
+
+  describe "new instance" do
+    describe "with invalid information" do
+      describe "without any information" do
+        it "should raise an error" do
+          expect { Mcjsonapi::API.new }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe "without password" do
+        it "should raise an error" do
+          expect { Mcjsonapi::API.new username: username }.to raise_error(ArgumentError)
+        end
+      end
+
+      describe "without username" do
+        it "should raise an error" do
+          expect { Mcjsonapi::API.new password: password }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe "with valid information" do
+      let(:api) { Mcjsonapi::API.new username: username, password: password }
+
+      it "should use correct username" do
+        expect(api.username).to eq username
+      end
+
+      describe "with no host given" do
+        let(:api) { Mcjsonapi::API.new username: username, password: password }
+
+        it "should assume localhost as default" do
+          expect(api.host).to eq "localhost"
+        end
+      end
+
+      describe "with host given" do
+        let(:api) { Mcjsonapi::API.new host: "api.example.com", username: username, password: password }
+
+        it "should use the given host" do
+          expect(api.host).to eq "api.example.com"
+        end
+      end
+
+      describe "with no port given" do
+        let(:api) { Mcjsonapi::API.new username: username, password: password }
+
+        it "should assume 20059 as default" do
+          expect(api.port).to eq 20059
+        end
+      end
+
+      describe "with port given" do
+        let(:api) { Mcjsonapi::API.new port: 31337, username: username, password: password }
+
+        it "should use the given port" do
+          expect(api.port).to eq 31337
+        end
+      end
+    end
+  end
+
+  describe "key generation" do
+    let(:api) { Mcjsonapi::API.new username: username, password: password }
+
+    describe "with no method parameter" do
+      it "should raise an error" do
+        expect { api.generate_key }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "with correct parameters" do
+      it "should return a valid key" do
+        expect(api.generate_key "server.version").to eq Digest::SHA256.hexdigest(username+"server.version"+password)
+      end
+    end
+  end
+
+  describe "request" do
+    let(:api) { Mcjsonapi::API.new username: username, password: password }
+
+    describe "with no parameters" do
+      it "should raise an error" do
+        expect { api.call }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "with empty (string) parameters" do
+      it "should raise an error" do
+        expect { api.call "" }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "with empty (hash) parameters" do
+      it "should raise an error" do
+        expect { api.call {} }.to raise_error(ArgumentError)
+      end
+    end
+
+    describe "with single string parameter" do
+      describe "with no existing method" do
+        it "should raise an error" do
+          expect { api.call "server.ersion" }.to raise_error(Mcjsonapi::APIError)
+        end
+      end
+
+      describe "with an existing method" do
+        it "should return valid data" do
+          expect(api.call "server.version").to eq version
+        end
+      end
+    end
+
+    describe "with hash parameters" do
+      describe "with no existing method" do
+        it "should raise an error" do
+          expect { api.call name: "server.ersion" }.to raise_error(Mcjsonapi::APIError)
+        end
+      end
+
+      describe "with an existing method" do
+        describe "without arguments" do
+          it "should return valid data" do
+            expect(api.call name: "server.version").to eq version
+          end
+        end
+
+        describe "with invalid arguments" do
+          it "should raise an error" do
+            expect { api.call name: "chat.broadcast", arguments: [] }.to raise_error(Mcjsonapi::APIError)
+          end
+        end
+
+        describe "with valid arguments" do
+          it "should return valid data" do
+            expect(api.call name: "chat.broadcast", arguments: ["Hello World"]).to eq 1
+          end
+        end
+      end
+    end
+
+    describe "with host timeout" do
+      it "should raise an exception" do
+        expect { api.call "players.online.limit" }.to raise_error(Timeout::Error)
+      end
+    end
+
+    describe "with HTTP error from API" do
+      it "should raise an exception" do
+        expect { api.call "players.online" }.to raise_error(Mcjsonapi::APIError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require "mcjsonapi"
+require "digest/sha2"
+require "webmock/rspec"
+
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  config.before :each do
+    stub_request(:any, "http://localhost:20059/api/2/call?json=%7B%22name%22:%22server.version%22,%22username%22:%22username%22,%22key%22:%228433478ce05d331c743ff69cad00792039396d222d304545bd40f2ccecd714c9%22%7D").
+      to_return(status: 200, body: '[{"result":"success","is_success":true,"source":"server.version","success":"git-Bukkit-1.6.4-R2.0-b2918jnks (MC: 1.6.4)"}]', headers: {})
+
+    stub_request(:any, 'http://localhost:20059/api/2/call?json=%7B%22name%22:%22server.ersion%22,%22username%22:%22username%22,%22key%22:%2280e215e432f1712033c05f19d1aa25809f076f33e109459d74c3638f2054f9dd%22%7D').
+      to_return(status: 200, body: '[{"result":"error","is_success":false,"error":{"message":"The method \'server.ersion\' does not exist!","code":7},"source":"server.ersion"}]', headers: {})
+
+    stub_request(:any, 'http://localhost:20059/api/2/call?json=%7B%22name%22:%22players.online%22,%22username%22:%22username%22,%22key%22:%22a512138b40aa90e62577a05b22e0a8ef1e3642603766c5f175a91b491143ec0a%22%7D').
+      to_return(status: 500, body: "")
+
+    stub_request(:any, 'http://localhost:20059/api/2/call?json=%7B%22name%22:%22players.online.limit%22,%22username%22:%22username%22,%22key%22:%229e13123716483673352415a76bc891649148043111cbffa3374ee192d26e8e34%22%7D').
+      to_timeout
+
+    stub_request(:any, 'http://localhost:20059/api/2/call?json=%7B%22name%22:%22chat.broadcast%22,%22arguments%22:%5B%5D,%22username%22:%22username%22,%22key%22:%2209cb37400a6951f6f69ac62c736c62e8646292a100585bf4412a836b4c507407%22%7D').
+      to_return(status: 200, body: '[{"result":"error","is_success":false,"error":{"message":"Caught exception: java.lang.Exception: Incorrect number of args: gave 0 ([]), expected 1 for method chat.broadcast\n\tat com.alecgorge.minecraft.jsonapi.dynamic.Caller.call(Caller.java:64)\n\tat com.alecgorge.minecraft.jsonapi.api.v2.JSONResponse.serveAPICall(JSONResponse.java:130)\n\tat com.alecgorge.minecraft.jsonapi.api.v2.JSONResponse.getJSONObject(JSONResponse.java:73)\n\tat com.alecgorge.minecraft.jsonapi.api.v2.APIv2Handler.call(APIv2Handler.java:83)\n\tat com.alecgorge.minecraft.jsonapi.api.v2.APIv2Handler.serve(APIv2Handler.java:51)\n\tat com.alecgorge.minecraft.jsonapi.JSONServer.serve(JSONServer.java:257)\n\tat com.alecgorge.minecraft.jsonapi.NanoHTTPD$HTTPSession.run(NanoHTTPD.java:553)\n\tat java.lang.Thread.run(Thread.java:744)\n","code":6},"source":"chat.broadcast"}]') # This is ugly. Like, really ugly.
+
+    stub_request(:any, 'http://localhost:20059/api/2/call?json=%7B%22name%22:%22chat.broadcast%22,%22arguments%22:%5B%22Hello%20World%22%5D,%22username%22:%22username%22,%22key%22:%2209cb37400a6951f6f69ac62c736c62e8646292a100585bf4412a836b4c507407%22%7D').
+      to_return(status: 200, body: '[{"result":"success","is_success":true,"source":"chat.broadcast","success":1}]')
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: mcjsonapi
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- elomatreb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    A gem to interact with a Minecraft (bukkit) server that has the
+  \n    {JSONAPI plugin}[https://github.com/alecgorge/jsonapi] installed. It supports\n
+  \   calling single and multiple methods.\n"
+email:
+- elomatreb@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/mcjsonapi.rb
+- lib/mcjsonapi/api.rb
+- lib/mcjsonapi/version.rb
+- mcjsonapi.gemspec
+- spec/mcjsonapi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/elomatreb/mcjsonapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to interact with a Minecraft server running the JSONAPI plugin.
+test_files:
+- spec/mcjsonapi_spec.rb
+- spec/spec_helper.rb