takumi-packet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85dcdf1aec2d1bf95e55f5ad99962d28514ec357
+  data.tar.gz: 9d18168b3d5c24278c7a878313a373cd2a2eeb5f
+SHA512:
+  metadata.gz: d1ed81b1195e676d04ee121168d998f042ba711a5f7751d063ce3cc891564d204dac5ebfa9cb7ad37d5e3aaacae6401d1af8187914513fdceb057d312c80d638
+  data.tar.gz: f6e6c25d25f20e4561fd7b40d980021b22ee2b8d246db1e7947b6973656ec9b4f4e663ff828d26c9bf5d8e2595081b65b0f1fdc21cf709582ed0719e589bbcac

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 block_given?
+
+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,68 @@
+# Takumi::Packet
+
+minecraft protocol packet encode/decode utility.
+
+Details: [Protocol - MinecraftCoalition](http://wiki.vg/Protocol)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'takumi-packet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install takumi-packet
+
+## Usage
+
+### Gems use takumi-packet
+
+- [blockgiven/takumi-server_list_ping](https://github.com/blockgiven/takumi-server_list_ping)
+
+### Define packet
+
+    require 'ostruct'
+    require 'takumi/packet'
+
+    class Handshake < OpenStruct
+      include ::Takumi::Packet::Dsl
+
+      field :packet_id,      :varint
+      field :version,        :varint
+      field :server_address, :string
+      field :port,           :ushort
+      field :next_state,     :varint
+    end
+
+### Encode packet
+    p Handshake.new({
+      packet_id:      0,
+      version:        4,
+      server_address: 'localhost',
+      port:           25565,
+      next_state:     1
+    }).to_s
+
+    # => "\x0F\x00\x04\tlocalhostc\xDD\x01"
+
+### Decode packet
+
+    packet = "\x0F\x00\x04\tlocalhostc\xDD\x01"
+
+    p Handshake.decode(packet)
+    # => #<Handshake packet_id=0, version=4, server_address="localhost", port=[25565], next_state=1>
+
+## Contributing
+
+1. Fork it ( https://github.com/blockgiven/takumi-packet/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,2 @@
+require "bundler/gem_tasks"
+

data/lib/takumi/packet.rb

@@ -0,0 +1,54 @@
+module Takumi
+  module Packet
+    class UnknownField < StandardError; end
+
+    module_function
+
+    def decode(packet_type, packet)
+      packet_size, read = Packet::Varint.decode(packet)
+      packet = packet[read, packet_size]
+
+      fields = {}
+      packet_type.fields.each do |field|
+        case field[:type]
+        when :varint
+          data, read = ::Takumi::Packet::Varint.decode(packet)
+        when :string
+          data, read = ::Takumi::Packet::String.decode(packet)
+        when :ushort
+          data, read = ::Takumi::Packet::Ushort.decode(packet)
+        else
+          raise ::Takumi::Packet::UnknownField, field.inspect
+        end
+        fields[field[:name]] = data
+        packet = packet[read..-1]
+      end
+      fields
+    end
+
+    def encode(packet_type, object)
+      packet = "".encode(Encoding::BINARY)
+      packet_type.fields.each do |field|
+        val = object.send(field[:name])
+
+        case field[:type]
+        when :varint
+          packet << ::Takumi::Packet::Varint.new(val).to_s
+        when :string
+          packet << ::Takumi::Packet::String.new(val).to_s
+        when :ushort
+          packet << ::Takumi::Packet::Ushort.new(val).to_s
+        else
+          raise ::Takumi::Packet::UnknownField, field.inspect
+        end
+      end
+      size = ::Takumi::Packet::Varint.new(packet.size).to_s
+      size + packet
+    end
+  end
+end
+
+require "takumi/packet/dsl"
+require "takumi/packet/varint"
+require "takumi/packet/string"
+require "takumi/packet/ushort"

data/lib/takumi/packet/dsl.rb

@@ -0,0 +1,28 @@
+module Takumi
+  module Packet
+    module Dsl
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def field(name, type)
+          fields << {name: name, type: type}
+        end
+
+        def fields
+          @fields ||= []
+        end
+
+        def decode(packet)
+          attrs = ::Takumi::Packet.decode(self, packet)
+          new(attrs)
+        end
+      end
+
+      def to_s
+        ::Takumi::Packet.encode(self.class, self)
+      end
+    end
+  end
+end

data/lib/takumi/packet/string.rb

@@ -0,0 +1,22 @@
+module Takumi
+  module Packet
+    class String
+      class << self
+        def decode(source)
+          size, read = ::Takumi::Packet::Varint.decode(source)
+          return source[read, size], (size + read)
+        end
+      end
+
+      def initialize(str)
+        @str = str
+      end
+
+      def to_s
+        packet = "".encode(Encoding::BINARY)
+        packet << ::Takumi::Packet::Varint.new(@str.bytesize).to_s
+        packet << @str.dup.force_encoding(Encoding::BINARY)
+      end
+    end
+  end
+end

data/lib/takumi/packet/ushort.rb

@@ -0,0 +1,19 @@
+module Takumi
+  module Packet
+    class Ushort
+      class << self
+        def decode(source)
+          return source[0..1].unpack("n"), 2
+        end
+      end
+
+      def initialize(ushort)
+        @ushort = ushort
+      end
+
+      def to_s
+        [@ushort].pack("n")
+      end
+    end
+  end
+end

data/lib/takumi/packet/varint.rb

@@ -0,0 +1,37 @@
+module Takumi
+  module Packet
+    class Varint
+      class << self
+        def decode(source)
+          int = 0
+          source.chars.each.with_index(1) do |char, index|
+            byte = char.ord
+            int += byte & 0b111_1111
+
+            return int, index if (byte & 0b1000_0000).zero?
+          end
+        end
+      end
+
+      def initialize(int)
+        @int = int
+      end
+
+      def to_s
+        packet = "".encode(Encoding::BINARY)
+        int = @int
+        loop do
+          bits = int & 0b111_1111
+          int = int >> 7
+
+          if int.zero?
+            packet << bits.chr and break
+          else
+            packet << (bits | 0b1000_0000).chr
+          end
+        end
+        packet
+      end
+    end
+  end
+end

data/lib/takumi/packet/version.rb

@@ -0,0 +1,5 @@
+module Takumi
+  module Packet
+    VERSION = "0.0.1"
+  end
+end

data/takumi-packet.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'takumi/packet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "takumi-packet"
+  spec.version       = Takumi::Packet::VERSION
+  spec.authors       = ["block_given?"]
+  spec.email         = ["block_given@outlook.com"]
+  spec.summary       = %q{minecraft protocol packet encode/decode utility.}
+  spec.homepage      = "https://github.com/blockgiven/takumi-packet"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: takumi-packet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- block_given?
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- block_given@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/takumi/packet.rb
+- lib/takumi/packet/dsl.rb
+- lib/takumi/packet/string.rb
+- lib/takumi/packet/ushort.rb
+- lib/takumi/packet/varint.rb
+- lib/takumi/packet/version.rb
+- takumi-packet.gemspec
+homepage: https://github.com/blockgiven/takumi-packet
+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 protocol packet encode/decode utility.
+test_files: []
+has_rdoc: