minecraft_jsonapiv2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e53ffa2e43cefecd7267720543ba1d55acc93feb
+  data.tar.gz: a65f73e05a2e38053f91b0357b54a0c8d526785e
+SHA512:
+  metadata.gz: d0d6b8fdc72e407db27cf7c0f98a290d55f79c77c1451451fe9fa12887a769ff8a536c01ebce81eba10d8735fc803fc9c8930dadbad4325d7300e886c047767e
+  data.tar.gz: 090007701dc7fb3cf599436b98eaf9bb71022f0cf3fc16cca2db703b09a59575cdcc7c06c33a8676841774fc9b3370ea9f75bf3ec108ee6a4860d8e95d9164f4

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/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) 2014 Patrick Neff
+
+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,62 @@
+# Minecraft JSONAPIv2
+
+A ruby API wrapper for the [JSONAPI Plugin](http://mcjsonapi.com/) for Minecraft
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minecraft_jsonapiv2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minecraft_jsonapiv2
+
+## Usage
+
+```ruby
+require 'minecraft_jsonapiv2'
+
+api = Minecraft::JSONAPIv2.new(host: '127.0.0.1', port: 20059, user: 'admin', password: 'changme', salt: 'mmm')
+
+#Call a non namespaced method
+api.server
+
+#Replace dots with underscores in namespaced method names
+api.server_version
+
+#If the method name itself contains underscores call it as a block
+api.worlds_world do |world|
+  world.save_off
+end
+
+#Call a method with arguments
+chat_broadcast('Hello World')
+
+#Call a method with arguments in a block
+api.worlds_world do |world|
+  world.set_time('world', 6000)
+end
+
+#Or call a method manally
+options = {
+  name: 'worlds.world.set_time'
+  args: ['world', 6000]
+}
+api.call(options)
+
+```
+
+See [JSONAPI Method Documentation](http://mcjsonapi.com/apidocs/) for more information
+
+## Contributing
+
+1. Fork it ( https://github.com/masterodie/minecraft_jsonapiv2/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rubygems'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :test

data/lib/core_ext/hash.rb

@@ -0,0 +1,14 @@
+class Hash
+    # Converts all of the keys to strings, optionally formatting key name
+    def rubyify_keys!
+        keys.each{|k|
+            v = delete(k)
+            new_key = k.to_s.underscore
+            self[new_key] = v
+            v.rubyify_keys! if v.is_a?(Hash)
+            v.each{|p| p.rubyify_keys! if p.is_a?(Hash)} if v.is_a?(Array)
+        }
+        self
+    end
+end
+

data/lib/core_ext/string.rb

@@ -0,0 +1,10 @@
+class String
+    def underscore
+        self.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+    end
+end
+

data/lib/minecraft_jsonapiv2/api.rb

@@ -0,0 +1,42 @@
+module Minecraft
+    module JSONAPIv2
+        class API
+            attr_reader :user
+
+            def initialize(options={})
+                @user= options[:user]
+                @conn = Minecraft::JSONAPIv2::Request.new(options)
+            end
+
+            def call(method)
+                response = Minecraft::JSONAPIv2::Response.new( @conn.make_request(method) ).response[method[:name].gsub(/\./, '_')]
+                response = Mash.new(response) if response.is_a? Hash or response.is_a? Array
+                begin
+                    unless response.nil?
+                        response
+                    else
+                        raise NoResponseError
+                    end
+                end
+            end
+
+            def method_missing(name, *args, &block)
+                if block_given?
+                    block.call Minecraft::JSONAPIv2::Namespace.new(self, name.to_s)
+                else
+                    response = Minecraft::JSONAPIv2::Response.new( @conn.make_request(name: name.to_s.gsub(/_/, '.'), args: args) ).response[name.to_s]
+
+                    super if (response.nil?)
+                    response = Mash.new(response) if response.is_a? Hash or response.is_a? Array
+                    response
+                end
+            end
+        end
+    end
+end
+
+# Custom Error classes
+class NoResponseError < StandardError
+end
+
+

data/lib/minecraft_jsonapiv2/authorization.rb

@@ -0,0 +1,21 @@
+module Minecraft
+    module JSONAPIv2
+        class Authorization
+            attr_reader :username, :key
+
+            def initialize(options={})
+                raise "No username given" if options[:user].nil?
+                raise "No password given" if options[:password].nil?
+                raise "No salt given" if options[:salt].nil?
+                @user = options[:user]
+                @pass = options[:password]
+                @salt = options[:salt]
+                @key = nil
+            end
+
+            def key_for(method)
+                @key = Digest::SHA256.new.update([@user, method, @pass, @salt].join).to_s
+            end
+        end
+    end
+end

data/lib/minecraft_jsonapiv2/namespace.rb

@@ -0,0 +1,21 @@
+module Minecraft
+    module JSONAPIv2
+        class Namespace
+            def initialize(parent, namespace, options={})
+                @parent = parent
+                @namespace = namespace
+            end
+
+            def method_missing(method, *args)
+                method = [@namespace.gsub(/_/,'.'), method.to_s].join('.')
+                opts = {name: method, args: args}
+
+                @parent.call(opts)
+            end
+
+            def call(method)
+                @parent.call(methodd)
+            end
+        end
+    end
+end

data/lib/minecraft_jsonapiv2/request.rb

@@ -0,0 +1,68 @@
+module Minecraft
+    module JSONAPIv2
+        class Request
+            def initialize(options={})
+                @host = options[:host].nil? ? '127.0.0.1' : options[:host]
+                @port = options[:port].nil? ? 20059 : options[:port]
+                @user = options[:user]
+                @auth = Minecraft::JSONAPIv2::Authorization.new(options)
+                @json = []
+                @req = []
+            end
+
+            def make_request(options)
+                url = Minecraft::JSONAPIv2::BASE_URI % {host: @host, port: @port}
+                request = generate_array_for_json( generate_request(options) ).to_json
+                response = HTTParty.post(url, body: request, headers: {'Content-Type' => 'application/json'} )
+                @json = []
+                @req = []
+                response.body
+            end
+
+            def generate_request(method)
+                if method.is_a? Array
+                    method.each do |m|
+                        generate_request m
+                    end
+                else
+                    @req.push(
+                        user: @user,
+                        method: method,
+                        key: @auth.key_for(method[:name])
+                    )
+                end
+                @req
+            end
+
+            def map_to_array(arguments)
+                if arguments.nil?
+                    []
+                elsif arguments.is_a?(Array) || arguments.is_a?(Hash)
+                    arguments
+                else
+                    [arguments]
+                end
+            end
+
+            def generate_array_for_json(options={})
+                if options.is_a? Array
+                    options.each do |o|
+                        generate_array_for_json o
+                    end
+                else
+                raise 'No username given' if options[:user].nil?
+                raise 'No key given' if options[:key].nil?
+                raise 'No method given' if options[:method].nil?
+                raise 'No method name given' if options[:method][:name].nil?
+                @json.push({
+                    name: options[:method][:name],
+                    username: options[:user],
+                    arguments: map_to_array(options[:method][:args]),
+                    key: options[:key],
+                })
+                end
+                @json
+            end
+        end
+    end
+end

data/lib/minecraft_jsonapiv2/response.rb

@@ -0,0 +1,20 @@
+module Minecraft
+    module JSONAPIv2
+        class Response
+            attr_reader :response, :raw_response
+            def initialize(data)
+                @response = {}
+                data = JSON.parse(data)
+                @raw_response = data
+                if data.is_a? Array
+                    data.each do |d|
+                        @response[d['source'].gsub(/\./, '_')] = d['success']
+                    end
+                else
+                    @response[data['source'].gsub(/\./, '_')] = data['success']
+                end
+                @response.rubyify_keys!
+            end
+        end
+    end
+end

data/lib/minecraft_jsonapiv2/version.rb

@@ -0,0 +1,5 @@
+module Minecraft
+    module JSONAPIv2
+        VERSION = "0.0.1"
+    end
+end

data/lib/minecraft_jsonapiv2.rb

@@ -0,0 +1,18 @@
+require 'json'
+require 'digest/sha2'
+require 'httparty'
+require 'yaml'
+require 'mash'
+
+
+module Minecraft
+    module JSONAPIv2
+        BASE_URI = 'http://%{host}:%{port}/api/2/call'
+
+        Dir[File.join(File.dirname(__FILE__),  '**', '*.rb')].each { |f| require f }
+
+        def self.new(options={})
+            Minecraft::JSONAPIv2::API.new(options)
+        end
+    end
+end

data/minecraft_jsonapiv2.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minecraft_jsonapiv2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minecraft_jsonapiv2"
+  spec.version       = Minecraft::JSONAPIv2::VERSION
+  spec.authors       = ["Patrick Neff"]
+  spec.email         = ["odie86@gmail.com"]
+  spec.summary       = %q{Minecraft JSONAPI Wrapper}
+  spec.description   = %q{Simple Minecraft JSONAPI Wrapper}
+  spec.homepage      = "https://github.com/masterodie/minecraft_jsonapiv2"
+  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", ">= 10.0.0"
+
+  spec.add_dependency "json", "~> 1.8.0"
+  spec.add_dependency "httparty", "~> 0.13.0"
+  spec.add_dependency "mash", "~> 0.1.0"
+end

data/spec/lib/minecraft_jsonapiv2/api_spec.rb

@@ -0,0 +1,51 @@
+require_relative '../../spec_helper'
+
+describe Minecraft::JSONAPIv2::API do
+    before do
+       @api = Minecraft::JSONAPIv2::API.new(host: '10.10.0.10', port: 20059, user: 'admin', password: 'changeme', salt: 'mmm')
+    end
+
+    describe 'method' do
+        it 'must raise method not found' do
+            lambda { @api.foobar }.must_raise NoMethodError
+        end
+
+        it 'must be String if response is String' do
+            @api.server_version.must_be_instance_of String
+        end
+
+        it 'must be Mash when API response is Hash' do
+            @api.server.must_be_instance_of Mash
+        end
+    end
+
+    describe 'methhod with arguments' do
+        it 'must equal called arguments' do
+            @api.players_name('masterodie').name.must_equal 'masterodie'
+        end
+
+        it 'must be Mash response is Hash' do
+            @api.server.must_be_instance_of Mash
+        end
+    end
+
+    describe 'block' do
+        it 'must respond' do
+            @api.server {|s| s.version }.must_be_instance_of String
+        end
+    end
+
+    describe 'manual call' do
+        it 'must raise no response' do
+            lambda { @api.call(name: 'foobar') }.must_raise NoResponseError
+        end
+
+        it 'must be String response is string' do
+            @api.call(name: 'server.version').must_be_instance_of String
+        end
+
+        it 'must be Mash when response is Hash' do
+            @api.call(name: 'server').must_be_instance_of Mash
+        end
+    end
+end

data/spec/lib/minecraft_jsonapiv2/authorization_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../../spec_helper.rb'
+
+describe Minecraft::JSONAPIv2::Authorization do
+    describe 'key_for' do
+        before do
+            @auth = Minecraft::JSONAPIv2::Authorization.new(user: 'admin', password: 'changeme', salt: 'mmm')
+        end
+
+        it 'must be String' do
+            @auth.key_for(name: 'server.version').must_be_instance_of String
+        end
+
+        it 'must have the right length' do
+            @auth.key_for(name: 'server.version').length.must_equal 64
+        end
+    end
+end

data/spec/lib/minecraft_jsonapiv2_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../spec_helper.rb'
+
+describe Minecraft::JSONAPIv2 do
+    describe 'shortcut' do
+        before do
+           @api = Minecraft::JSONAPIv2.new(host: '10.10.0.10', port: 20059, user: 'admin', password: 'changeme', salt: 'mmm')
+        end
+
+        it 'should work' do
+            @api.must_be_instance_of Minecraft::JSONAPIv2::API
+        end
+    end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'minecraft_jsonapiv2'
+
+require 'minitest/autorun'
+require 'minitest/spec'
+
+if __FILE__ == $0
+  $LOAD_PATH.unshift('lib', 'spec')
+  Dir.glob('./spec/**/*_spec.rb') { |f| require f }
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: minecraft_jsonapiv2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick Neff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-25 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: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: mash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Simple Minecraft JSONAPI Wrapper
+email:
+- odie86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_ext/hash.rb
+- lib/core_ext/string.rb
+- lib/minecraft_jsonapiv2.rb
+- lib/minecraft_jsonapiv2/api.rb
+- lib/minecraft_jsonapiv2/authorization.rb
+- lib/minecraft_jsonapiv2/namespace.rb
+- lib/minecraft_jsonapiv2/request.rb
+- lib/minecraft_jsonapiv2/response.rb
+- lib/minecraft_jsonapiv2/version.rb
+- minecraft_jsonapiv2.gemspec
+- spec/lib/minecraft_jsonapiv2/api_spec.rb
+- spec/lib/minecraft_jsonapiv2/authorization_spec.rb
+- spec/lib/minecraft_jsonapiv2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/masterodie/minecraft_jsonapiv2
+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: Minecraft JSONAPI Wrapper
+test_files:
+- spec/lib/minecraft_jsonapiv2/api_spec.rb
+- spec/lib/minecraft_jsonapiv2/authorization_spec.rb
+- spec/lib/minecraft_jsonapiv2_spec.rb
+- spec/spec_helper.rb