mclib 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41a05527f155a74abab8c9a3f67b1900db21d370
+  data.tar.gz: 1eecf5d099846fcdc63248eecc5f17d1bf356c1a
+SHA512:
+  metadata.gz: e33ee8d0c1bc6f0bc18122d9c75d60668dd8bcf2f1c9ac2db8a3613af8e822db4507a1db410fed4d18e6c7e81f44ec9cb96493348a02691d51c9593f5878402d
+  data.tar.gz: cdca88f30a4dc81db854c5c3b8e178c2a5cb6ac7f8fb5fb66ad2731d6e0190b2a83c5563fb93e6ab966cc145a4baec648fbcef7c727178ce91f1b58617cf9621

data/.gitignore

@@ -0,0 +1,24 @@
+*.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
+.DS_Store
+vendor/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Caleb Albritton
+
+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 @@
+# Mclib
+
+This library provides a Ruby API to vanilla minecraft by watching the log file and parsing the lines out into native objects and registering callbacks on server events such as login, chat, warnings and more.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mclib'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mclib
+
+## Usage
+
+	require 'mclib'
+
+	# set your minecraft directory, we'll use this to find the log and json files
+	MCLib::set_mc_dir '/Users/Caleb/Documents/minecraft/'
+	watcher = MCLib::Watcher.new
+
+	watcher.on :all do |event|
+	  puts 'This will always get called'
+	end
+
+	watcher.on :login do |user|
+	  puts "#{user.username} logged in from #{user.ip} at coordinates #{user.coordinates}"
+	end
+
+	watcher.on :chat do |username, text|
+	  puts "User #{username} said #{text}"
+	end
+
+	watcher.on :warning do |warning|
+	  puts "Warning: #{warning}"
+	end
+
+	watcher.start
+
+You can also fetch the whitelist, ops, banned ips, and players as a hash using the MCLib module
+
+	MCLib::get_ops
+	MCLib::get_whitelist
+	MCLib::get_banned_ips
+	MCLib::get_banned_players
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mclib/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 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec
+task :test => :spec

data/lib/mclib.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'mclib/log_parser'
+require 'mclib/watcher'
+require 'mclib/version'
+
+module MCLib
+  @@mc_dir = ''
+
+  def self.set_mc_dir(dir)
+    dir.chomp! '/' # in case of trailing slash
+    @@mc_dir = dir
+  end
+
+  def self.get_mc_dir
+    @@mc_dir
+  end
+
+  def self.get_ops
+    json = JSON.parse(File.open(@@mc_dir + 'ops.json').read)
+    json.collect { |user| user['name'] }
+  end
+
+  def self.get_whitelist
+    json = JSON.parse(File.open(@@mc_dir + 'whitelist.json').read)
+    json.collect { |user| user['name'] }
+  end
+
+  def self.get_banned_ips
+    JSON.parse(File.open(@@mc_dir + 'banned-ips.json').read)
+  end
+
+  def self.get_banned_players
+    JSON.parse(File.open(@@mc_dir + 'banned-players.json').read)
+  end
+end

data/lib/mclib/event_factory.rb

@@ -0,0 +1,91 @@
+require 'mclib'
+
+class MCLib::EventFactory
+
+  Unknown = Struct.new :message, :meta_data
+  Warning = Struct.new :text
+  Login = Struct.new :username, :ip, :coordinates
+  Chat = Struct.new :username, :text
+
+  def build(message, meta_data, type)
+    if type == :warn
+      return Warning.new message
+    end
+
+    @message, @meta_data = message, meta_data
+
+    case detect_event
+    when :chat
+      parse_chat
+    when :login
+      parse_login
+    when :unknown
+      Unknown.new message, meta_data
+    else
+      Unknown.new message, meta_data
+    end
+  end
+
+  private
+
+    def detect_event
+      if @message.chars[0] == '<'
+        :chat
+      elsif @message.include? 'logged in'
+        :login
+      else
+        :unknown
+      end
+    end
+
+    def parse_chat
+      name = ''
+      text = ''
+      stopped_at = 0
+
+      @message.chars.each_with_index do |char, index|
+        if char == '<'
+          next
+        elsif char == '>'
+          text = @message[index + 2..-1] # + 2 to skip trailing angle bracket and space
+          break
+        else
+          name << char
+        end
+      end
+
+      Chat.new name, text
+    end
+
+    def parse_login
+      name = ''
+      ip = ''
+
+      stopped_at = 0
+
+      @message.chars.each_with_index do |char, index|
+        if char != '['
+          name << char
+        else
+          stopped_at = index + 2
+          break
+        end
+      end
+
+      @message.chars[stopped_at..-1].each_with_index do |char, index|
+        if char != ':'
+          ip << char
+        else
+          break
+        end
+      end
+
+      coordinates = @message.match(/\(.*\)/)[0]
+      coordinates.slice! 0
+      coordinates.chomp! ')'
+      coordinates = coordinates.split(', ').map { |point| point.to_i }
+      coordinates = { :x => coordinates[0], :y => coordinates[1], :z => coordinates[2] }
+
+      Login.new name, ip, coordinates
+    end
+end

data/lib/mclib/log_parser.rb

@@ -0,0 +1,52 @@
+require 'mclib'
+require 'mclib/event_factory'
+require 'logger'
+
+class MCLib::LogParser
+
+  def initialize
+    @factory = MCLib::EventFactory.new
+  end
+
+  def parse(line)
+    meta_data, message = split_data line
+    type = type? meta_data
+    @factory.build message, meta_data, type
+  end
+
+  private
+
+    def type?(meta_data)
+      if meta_data.include? 'INFO'
+        return :info
+      elsif meta_data.include? 'WARN'
+        return :warn
+      else
+        return :unknown
+        # fail ArgumentError, "Unable to determine message type #{meta_data}"
+      end 
+    end
+
+    def split_data(line)
+      buffer = []
+      occurences = 0
+      stopped_at = 0
+
+      line.chars.each_with_index do |char, i|
+        if char == ':' && occurences == 2
+          # this is the third time we've seen the colon so this is the message delimeter
+          stopped_at = i
+          break
+        elsif char == ':'
+          buffer << char
+          occurences += 1
+        else
+          buffer << char
+        end 
+      end
+
+      stopped_at += 2 # removes trailing colon and space
+
+      return buffer.join, line[stopped_at..-1]
+    end
+end

data/lib/mclib/version.rb

@@ -0,0 +1,3 @@
+module MCLib
+  VERSION = "0.0.1"
+end

data/lib/mclib/watcher.rb

@@ -0,0 +1,56 @@
+require 'mclib'
+require 'mclib/log_parser'
+require 'eventmapper'
+require 'filewatch/tail'
+
+class MCLib::Watcher
+
+  include EventMapper
+
+  attr_accessor :watch_thread
+
+  def initialize(mc_dir = nil)
+    if mc_dir.nil?
+      mc_dir = MCLib::get_mc_dir
+    end
+    
+    @log_file = mc_dir + '/logs/latest.log'
+    @log_watcher = FileWatch::Tail.new
+    @parser = MCLib::LogParser.new
+  end
+
+  def start
+    @watch_thread = Thread.new do
+      @log_watcher.tail @log_file
+      @log_watcher.subscribe do |path, line|
+        if !line.empty? && !line.nil?
+          event = @parser.parse line
+
+          # fire the event with the correct event handler api parameters
+          delegate_parameters event
+
+          # always fire the :all handlers
+          fire :all, event
+        end
+      end
+    end
+  end
+
+  def stop
+    @watch_thread.kill
+  end
+
+  private
+
+    def delegate_parameters(event)
+      type = event.class.name.split('::').last.downcase.to_sym
+      case type
+      when :chat
+        fire :chat, event.username, event.text
+      when :login
+        fire :login, event
+      when :warning
+        fire :warning, event.text
+      end
+    end
+end

data/mclib.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mclib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mclib"
+  spec.version       = MCLib::VERSION
+  spec.authors       = ["Caleb Albritton"]
+  spec.email         = ["ithinkincode@gmail.com"]
+  spec.summary       = %q{Provides a pure Ruby API to vanilla minecraft.}
+  spec.description   = %q{This library provides a Ruby API to vanilla minecraft by watching the log file and parsing the lines out into native objects and registering callbacks on server events such as login, chat, warnings and more.}
+  spec.homepage      = "https://github.com/C0deMaver1ck/MCLib"
+  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_runtime_dependency "filewatch"
+  spec.add_runtime_dependency "eventmapper"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/mclib_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+# I can't figure out how to test threaded stuff without it leaving a zombie process behind
+describe MCLib do
+  it 'should emit events from server log' do
+    MCLib::set_mc_dir '/Users/Caleb/Documents/minecraft/'
+    watcher = MCLib::Watcher.new
+
+    watcher.on :all do |event|
+      puts "This will always get called"
+    end
+
+    watcher.on :login do |user|
+      puts "#{user.username} logged in from #{user.ip} at coordinates #{user.coordinates}"
+    end
+
+    watcher.on :chat do |username, text|
+      puts "User #{username} said #{text}"
+    end
+
+    watcher.on :warning do |warning|
+      puts "Warning: #{warning}"
+    end
+
+    watcher.start
+
+    sleep 10
+
+    watcher.stop
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'pry'
+require 'mclib'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: mclib
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caleb Albritton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: filewatch
+  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'
+- !ruby/object:Gem::Dependency
+  name: eventmapper
+  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'
+- !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: pry
+  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: This library provides a Ruby API to vanilla minecraft by watching the
+  log file and parsing the lines out into native objects and registering callbacks
+  on server events such as login, chat, warnings and more.
+email:
+- ithinkincode@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mclib.rb
+- lib/mclib/event_factory.rb
+- lib/mclib/log_parser.rb
+- lib/mclib/version.rb
+- lib/mclib/watcher.rb
+- mclib.gemspec
+- spec/mclib_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/C0deMaver1ck/MCLib
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Provides a pure Ruby API to vanilla minecraft.
+test_files:
+- spec/mclib_spec.rb
+- spec/spec_helper.rb