minecraft_api 0.0.1 → 0.1.0

data/History.md

@@ -0,0 +1,15 @@
+History
+-------
+
+0.1.0 (in progress)
+-----
+Bumped minor version because of backward-incompatible changes
+
+  * 
+  * allow creation of wool with color
+  * renamed block_type to block
+  * factored out classes to seperate api components
+
+0.0.1
+-----
+  * Initial Release

data/README.md

@@ -1,4 +1,25 @@
-minecraft_api
-==================
+Minecraft API for the Raspberry Pi
+----------------------------------
 
 An API for the Raspberry Pi version of minecraft
+
+Prerequisites:
+
+  * A [Raspberry Pi](http://www.raspberrypi.org)
+  * [Prerelease version of Minecraft](https://dl.dropbox.com/s/hqk8wsdzlyyujli/minecraft-pi-0.1.tar.gz)
+
+To install:
+
+    gem install minecraft-api
+
+and in your code:
+
+    require 'minecraft-api'
+
+    api = MinecraftApi.new(hostname, 4711) # <-- where ever your server is
+    api.world.block(5,10,15,Block::WOOD)
+    api.player.go(20,40,60)
+
+    etc...
+
+

data/lib/block.rb

@@ -0,0 +1,94 @@
+class Block
+
+  @@all_blocks = {}
+
+  attr_reader :id
+
+  def initialize(id)
+    @id = id
+    @@all_blocks[id] = self
+  end
+
+  AIR                 = Block.new(0)
+  STONE               = Block.new(1)
+  GRASS               = Block.new(2)
+  DIRT                = Block.new(3)
+  COBBLESTONE         = Block.new(4)
+  WOOD_PLANKS         = Block.new(5)
+  SAPLING             = Block.new(6)
+  BEDROCK             = Block.new(7)
+  WATER_FLOWING       = Block.new(8)
+  WATER_STATIONARY    = Block.new(9)
+  LAVA_FLOWING        = Block.new(10)
+  LAVA_STATIONARY     = Block.new(11)
+  SAND                = Block.new(12)
+  GRAVEL              = Block.new(13)
+  GOLD_ORE            = Block.new(14)
+  IRON_ORE            = Block.new(15)
+  COAL_ORE            = Block.new(16)
+  WOOD                = Block.new(17)
+  LEAVES              = Block.new(18)
+  GLASS               = Block.new(20)
+  LAPIS_LAZULI_ORE    = Block.new(21)
+  LAPIS_LAZULI_BLOCK  = Block.new(22)
+  SANDSTONE           = Block.new(24)
+  BED                 = Block.new(26)
+  COBWEB              = Block.new(30)
+  GRASS_TALL          = Block.new(31)
+  FLOWER_YELLOW       = Block.new(37)
+  FLOWER_CYAN         = Block.new(38)
+  MUSHROOM_BROWN      = Block.new(39)
+  MUSHROOM_RED        = Block.new(40)
+  GOLD_BLOCK          = Block.new(41)
+  IRON_BLOCK          = Block.new(42)
+  STONE_SLAB_DOUBLE   = Block.new(43)
+  STONE_SLAB          = Block.new(44)
+  BRICK_BLOCK         = Block.new(45)
+  TNT                 = Block.new(46)
+  BOOKSHELF           = Block.new(47)
+  MOSS_STONE          = Block.new(48)
+  OBSIDIAN            = Block.new(49)
+  TORCH               = Block.new(50)
+  FIRE                = Block.new(51)
+  STAIRS_WOOD         = Block.new(53)
+  CHEST               = Block.new(54)
+  DIAMOND_ORE         = Block.new(56)
+  DIAMOND_BLOCK       = Block.new(57)
+  CRAFTING_TABLE      = Block.new(58)
+  FARMLAND            = Block.new(60)
+  FURNACE_INACTIVE    = Block.new(61)
+  FURNACE_ACTIVE      = Block.new(62)
+  DOOR_WOOD           = Block.new(64)
+  LADDER              = Block.new(65)
+  STAIRS_COBBLESTONE  = Block.new(67)
+  DOOR_IRON           = Block.new(71)
+  REDSTONE_ORE        = Block.new(73)
+  SNOW                = Block.new(78)
+  ICE                 = Block.new(79)
+  SNOW_BLOCK          = Block.new(80)
+  CACTUS              = Block.new(81)
+  CLAY                = Block.new(82)
+  SUGAR_CANE          = Block.new(83)
+  FENCE               = Block.new(85)
+  GLOWSTONE_BLOCK     = Block.new(89)
+  BEDROCK_INVISIBLE   = Block.new(95)
+  STONE_BRICK         = Block.new(98)
+  GLASS_PANE          = Block.new(102)
+  MELON               = Block.new(103)
+  FENCE_GATE          = Block.new(107)
+  GLOWING_OBSIDIAN    = Block.new(246)
+  NETHER_REACTOR_CORE = Block.new(247)
+
+  def as_parameter_list
+    @id
+  end
+
+  def self.find(id)
+    @@all_blocks[id]
+  end
+
+  def ==(another_block)
+    @id == another_block.id
+  end
+
+end

data/lib/camera.rb

@@ -0,0 +1,19 @@
+class Camera
+
+  def initialize(api)
+    @api = api
+  end
+
+  def mode(mode,x=nil,y=nil,z=nil)
+    case mode
+    when :normal then command = "setNormal()"
+    when :third_person then command = "setThirdPerson()"
+    when :fixed then command = "setFixed()"
+    when :position then command = "setPos(#{x},#{y},#{z})"
+    else raise RuntimeError.new("valid camera settings are: :normal, :third_person, :fixed, and :position")
+    end
+    
+    @api.send("camera.mode.#{command}")
+  end
+
+end

data/lib/color.rb

@@ -0,0 +1,18 @@
+class Color
+  WHITE      = 0
+  ORANGE     = 1
+  MAGENTA    = 2
+  LIGHT_BLUE = 3
+  YELLOW     = 4
+  LIME       = 5
+  PINK       = 6
+  GRAY       = 7
+  LIGHT_GRAY = 8
+  CYAN       = 9
+  PURPLE     = 10
+  BLUE       = 11
+  BROWN      = 12
+  GREEN      = 13
+  RED        = 14
+  BLACK      = 15
+end

data/lib/minecraft_api.rb

@@ -1,17 +1,28 @@
 require 'socket'
 require 'io/wait'
 
+require_relative 'world'
+require_relative 'camera'
+require_relative 'player'
+
 class MinecraftApi
 
+  attr_reader :world
+  attr_reader :camera
+  attr_reader :player
+
   def initialize(host = 'localhost', port = 4711)
     @socket = TCPSocket.new host, port
+    @world = World.new(self)
+    @camera = Camera.new(self)
+    @player = Player.new(self)
   end
 
   # The other api's have a method like this
   # I haven't seen it be invoked yet. Perhaps it is not needed
   def drain()
     while @socket.ready?
-      puts "**** READ A CHARACTER [#{@socket.gets}]"
+      puts "DRAINING DATA FROM SOCKET [#{@socket.gets}]"
     end
   end
 
@@ -25,54 +36,6 @@ class MinecraftApi
     @socket.gets.chomp
   end
 
-  def get_block_type(x,y,z)
-    response = send_and_receive("world.getBlock(#{x},#{y},#{z})")
-    BlockType.find(response.to_i) 
-  end
-
-  def set_block(x,y,z,block_type)
-    send("world.setBlock(#{x},#{y},#{z},#{block_type.id})")
-  end
-
-  def set_blocks(x1,y1,z1,x2,y2,z2,block_type)
-    send("world.setBlocks(#{x1},#{y1},#{z1},#{x2},#{y2},#{z2},#{block_type.id})")
-  end
-
-  def get_height(x,z)
-    send_and_receive("world.getHeight(#{x},#{z})").to_i
-  end
-
-  def checkpoint_save
-    send("word.checkpoint.save()")
-  end
-
-  def checkpoint_restore
-    send("word.checkpoint.restore()")
-  end
-
-  def chat_post(message)
-    send("chat.post(#{message})")
-  end
-
-  def camera_mode(mode,x=nil,y=nil,z=nil)
-    case mode
-    when :normal then send("camera.mode.setNormal()")
-    when :third_person then send("camera.mode.setThirdPerson()")
-    when :fixed then send("camera.mode.setFixed()")
-    when :position then send("camera.mode.setPos(#{x},#{y},#{z})")
-    else raise RuntimeError.new("valid camera settings are: :normal, :third_person, :fixed, and :position")
-    end
-  end
-
-  def player_set_tile(x,y,z)
-    send("player.setTile(#{x},#{y},#{z})")
-  end
-
-  def player_get_tile
-    response = send_and_receive("player.getTile()")
-    response.split(',').map { |s| s.to_i }
-  end    
-
   def close
     @socket.close
   end

data/lib/player.rb

@@ -0,0 +1,14 @@
+class Player
+  def initialize(api)
+    @api = api
+  end
+
+  def go(x,y,z)
+    @api.send("player.setTile(#{x},#{y},#{z})")
+  end
+
+  def location
+    response = @api.send_and_receive("player.getTile()")
+    response.split(',').map { |s| s.to_i }
+  end    
+end

data/lib/wool.rb

@@ -0,0 +1,23 @@
+require_relative 'block'
+require_relative 'color'
+
+class Wool < Block
+  WOOL_BLOCK_ID = 35
+  private_constant :WOOL_BLOCK_ID
+
+  attr_reader :color
+
+  def initialize(color)
+    super(WOOL_BLOCK_ID)
+    @color = color
+  end
+
+  def as_parameter_list
+    "#{@id},#{@color}"
+  end
+
+  def ==(another_wool)
+    @id == another_wool.id && @color == another_wool.color
+  end
+
+end

data/lib/world.rb

@@ -0,0 +1,36 @@
+require_relative 'block'
+
+class World
+  def initialize(api)
+    @api = api
+  end
+
+  def block_at(x,y,z)
+    response = @api.send_and_receive("world.getBlock(#{x},#{y},#{z})")
+    Block.find(response.to_i) 
+  end
+
+  def block(x,y,z,block)
+    @api.send("world.setBlock(#{x},#{y},#{z},#{block.as_parameter_list})")
+  end
+
+  def cube(x1,y1,z1,x2,y2,z2,block)
+    @api.send("world.setBlocks(#{x1},#{y1},#{z1},#{x2},#{y2},#{z2},#{block.as_parameter_list})")
+  end
+
+  def height(x,z)
+    @api.send_and_receive("world.getHeight(#{x},#{z})").to_i
+  end
+
+  def save
+    @api.send("world.checkpoint.save()")
+  end
+
+  def restore
+    @api.send("world.checkpoint.restore()")
+  end
+
+  def chat_post(message)
+    @api.send("chat.post(#{message})")
+  end
+end

data/minecraft_api.gemspec

@@ -2,8 +2,8 @@ $:.push File.expand_path("../lib", __FILE__)
 Gem::Specification.new do |s|
   s.name          = 'minecraft_api'
   s.description   = 'An API for the Raspberry Pi version of Minecraft'
-  s.version       = '0.0.1'
-  s.date          = '2013-01-25'
+  s.version       = '0.1.0'
+  s.date          = '2013-02-14'
   s.summary       = 'Minecraft API'
   s.homepage      = 'https://github.com/nhajratw/minecraft_api'
   s.authors       = ["Nayan Hajratwala"]

data/spec/block_spec.rb

@@ -0,0 +1,10 @@
+require 'block'
+
+describe 'Block' do
+
+  it 'is equivalent to another type with the same id' do
+    b1 = Block.new(0)
+    b2 = Block.new(0)
+    b1.should eq(b2)
+  end
+end

data/spec/minecraft_api_spec.rb

@@ -1,6 +1,6 @@
 require 'minecraft_api'
 
-describe "Minecraft server" do
+describe "Minecraft API", :integration => true do
 
   before(:each) do
     @mcapi = MinecraftApi.new('10.0.1.129', 4711)
@@ -15,76 +15,93 @@ describe "Minecraft server" do
     response.should eq('Fail')
   end
 
-  it "can create a block" do
-    @mcapi.set_block(0,0,0,BlockType::WOOD)
-    block_type = @mcapi.get_block_type(0,0,0)
-    block_type.should eq(BlockType::WOOD)
-  end
+  describe "The World" do
 
-  it "can create a block of a different type" do
-    @mcapi.set_block(0,0,0,BlockType::SAND)
-    block_type = @mcapi.get_block_type(0,0,0)
-    block_type.should eq(BlockType::SAND)
-  end
+    let(:world) { @mcapi.world }
 
-  it "can create multiple blocks" do
-    @mcapi.set_blocks(0,0,0,2,2,2,BlockType::SAND)
-    # need to figure out assertion here.
-    # The assertions on each vector come too fast and end up returning
-    # types of 0.
-  end
+    it "can have blocks placed in it" do
+      world.block(0,0,0,Block::WOOD)
+      block = world.block_at(0,0,0)
+      block.should eq(Block::WOOD)
+    end
 
-  it "can get the height of the world" do
-    y = @mcapi.get_height(5,5)
-    y.should eq(2)
-  end
+    it "can create a block of a different type" do
+      world.block(0,0,0,Block::SAND)
+      block = world.block_at(0,0,0)
+      block.should eq(Block::SAND)
+    end
 
-  it "can checkpoint save" do
-    @mcapi.checkpoint_save
-  end
+    it "can create a block colored wool" do
+      wool = Wool.new(Color::RED)
+      world.block(0,0,0,wool)
+      block = world.block_at(0,0,0)
+      block.should eq(wool)
+    end
 
-  it "can checkpoint restore" do
-    @mcapi.checkpoint_restore
-  end
+    it "can create cubes" do
+      world.cube(0,0,0,2,2,2,Block::SAND)
+      # need to figure out assertion here.
+      # The assertions on each vector come too fast and end up returning
+      # types of 0.
+    end
 
-  it "can send chats" do
-    @mcapi.chat_post("hello")
+    it "can get the height of the world" do
+      y = world.height(5,5)
+      y.should eq(7)
+    end
+
+    it "can checkpoint save" do
+      world.save
+    end
+
+    it "can checkpoint restore" do
+      world.restore
+    end
+
+    it "can send chats" do
+      world.chat_post("hello")
+    end
   end
 
-  describe "Camera API" do
+  describe "Camera" do
+    let(:camera) { @mcapi.camera }
+
     it "can be set to normal" do
-      @mcapi.camera_mode(:normal)
+      camera.mode(:normal)
     end
 
     it "can be set to third person" do
-      @mcapi.camera_mode(:third_person)
+      camera.mode(:third_person)
     end
 
     it "can be set to fixed" do
-      @mcapi.camera_mode(:fixed)
+      camera.mode(:fixed)
     end
 
     it "can be set to a certain position" do
-      @mcapi.camera_mode(:position,10,20,30)
+      camera.mode(:position,10,20,30)
     end
 
     it "throws an error when an invalid mode is specified" do
       expect {
-        @mcapi.camera_mode(:fake)
+        camera.mode(:fake)
       }.to raise_error(RuntimeError, "valid camera settings are: :normal, :third_person, :fixed, and :position")
     end
   end
 
-  describe "Player API" do
-    it "can put the player on a particular tile" do
-      @mcapi.player_set_tile(20,40,60)
-      vector = @mcapi.player_get_tile
+  describe "Player" do
+
+    let(:player) { @mcapi.player }
+
+    it "can go to a particular tile" do
+      player.go(20,40,60)
+      vector = player.location
       vector.should eq([20,40,60])
     end
 
-    it "can put the player somewhere else" do
-      @mcapi.player_set_tile(-5,10,15)
-      vector = @mcapi.player_get_tile
+    it "can go to another tile" do
+      player.go(-5,10,15)
+      vector = player.location
       vector.should eq([-5,10,15])
     end
   end

data/spec/wool_spec.rb

@@ -0,0 +1,21 @@
+require 'wool'
+
+describe 'Wool' do
+  it 'can be created with color' do
+    wool = Wool.new(Color::RED)
+    wool.color.should == Color::RED
+  end
+
+  it 'wool instances should be equal' do
+    wool1 = Wool.new(Color::RED)
+    wool2 = Wool.new(Color::RED)
+    wool1.should == wool2
+  end
+
+  it 'wool instances should be equal' do
+    wool1 = Wool.new(Color::RED)
+    wool2 = Wool.new(Color::BLACK)
+    wool1.should_not == wool2
+  end
+end
+

data/spec/world_spec.rb

@@ -0,0 +1,36 @@
+describe 'the World' do
+  let(:api) { double() }
+  let(:world) { World.new(api) }
+
+  it 'sends the proper setBlock command for normal blocks' do
+    api.should_receive(:send).with("world.setBlock(10,20,30,20)")
+    world.block(10,20,30,Block::GLASS)
+  end
+
+  it 'sends the proper setBlock command for blocks with extra data' do
+    api.should_receive(:send).with("world.setBlock(5,6,7,35,14)")
+    world.block(5,6,7,Wool.new(Color::RED))
+  end
+
+  it 'sends the proper setBlocks command for normal blocks' do
+    api.should_receive(:send).with("world.setBlocks(10,20,30,40,50,60,20)")
+    world.cube(10,20,30,40,50,60,Block::GLASS)
+  end
+
+  it 'sends the proper setBlocks command for blocks with extra data' do
+    api.should_receive(:send).with("world.setBlocks(5,6,7,9,9,9,35,14)")
+    world.cube(5,6,7,9,9,9,Wool.new(Color::RED))
+  end
+
+  it 'translates data into blocks' do
+    api.stub(:send_and_receive).with("world.getBlock(5,6,7)") { "10" }
+    block = world.block_at(5,6,7)
+    block.should == Block::LAVA_FLOWING
+  end
+
+  it 'translates data into blocks with extra data' do
+    api.stub(:send_and_receive).with("world.getBlock(5,6,7)") { "35,14" }
+    block = world.block_at(5,6,7)
+    block.should == Wool.new(Color::RED)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minecraft_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies: []
 description: An API for the Raspberry Pi version of Minecraft
 email:
@@ -19,12 +19,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- History.md
 - README.md
-- lib/block_type.rb
+- lib/block.rb
+- lib/camera.rb
+- lib/color.rb
 - lib/minecraft_api.rb
+- lib/player.rb
+- lib/wool.rb
+- lib/world.rb
 - minecraft_api.gemspec
-- spec/block_type_spec.rb
+- spec/block_spec.rb
 - spec/minecraft_api_spec.rb
+- spec/wool_spec.rb
+- spec/world_spec.rb
 homepage: https://github.com/nhajratw/minecraft_api
 licenses: []
 post_install_message: 
@@ -45,7 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Minecraft API

data/lib/block_type.rb

@@ -1,91 +0,0 @@
-class BlockType
-
-  @@all_block_types = {}
-
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-    @@all_block_types[id] = self
-  end
-
-  def self.find(id)
-    @@all_block_types[id]
-  end
-
-  AIR                 = BlockType.new(0)
-  STONE               = BlockType.new(1)
-  GRASS               = BlockType.new(2)
-  DIRT                = BlockType.new(3)
-  COBBLESTONE         = BlockType.new(4)
-  WOOD_PLANKS         = BlockType.new(5)
-  SAPLING             = BlockType.new(6)
-  BEDROCK             = BlockType.new(7)
-  WATER_FLOWING       = BlockType.new(8)
-  WATER_STATIONARY    = BlockType.new(9)
-  LAVA_FLOWING        = BlockType.new(10)
-  LAVA_STATIONARY     = BlockType.new(11)
-  SAND                = BlockType.new(12)
-  GRAVEL              = BlockType.new(13)
-  GOLD_ORE            = BlockType.new(14)
-  IRON_ORE            = BlockType.new(15)
-  COAL_ORE            = BlockType.new(16)
-  WOOD                = BlockType.new(17)
-  LEAVES              = BlockType.new(18)
-  GLASS               = BlockType.new(20)
-  LAPIS_LAZULI_ORE    = BlockType.new(21)
-  LAPIS_LAZULI_BLOCK  = BlockType.new(22)
-  SANDSTONE           = BlockType.new(24)
-  BED                 = BlockType.new(26)
-  COBWEB              = BlockType.new(30)
-  GRASS_TALL          = BlockType.new(31)
-  WOOL                = BlockType.new(35)
-  FLOWER_YELLOW       = BlockType.new(37)
-  FLOWER_CYAN         = BlockType.new(38)
-  MUSHROOM_BROWN      = BlockType.new(39)
-  MUSHROOM_RED        = BlockType.new(40)
-  GOLD_BLOCK          = BlockType.new(41)
-  IRON_BLOCK          = BlockType.new(42)
-  STONE_SLAB_DOUBLE   = BlockType.new(43)
-  STONE_SLAB          = BlockType.new(44)
-  BRICK_BLOCK         = BlockType.new(45)
-  TNT                 = BlockType.new(46)
-  BOOKSHELF           = BlockType.new(47)
-  MOSS_STONE          = BlockType.new(48)
-  OBSIDIAN            = BlockType.new(49)
-  TORCH               = BlockType.new(50)
-  FIRE                = BlockType.new(51)
-  STAIRS_WOOD         = BlockType.new(53)
-  CHEST               = BlockType.new(54)
-  DIAMOND_ORE         = BlockType.new(56)
-  DIAMOND_BLOCK       = BlockType.new(57)
-  CRAFTING_TABLE      = BlockType.new(58)
-  FARMLAND            = BlockType.new(60)
-  FURNACE_INACTIVE    = BlockType.new(61)
-  FURNACE_ACTIVE      = BlockType.new(62)
-  DOOR_WOOD           = BlockType.new(64)
-  LADDER              = BlockType.new(65)
-  STAIRS_COBBLESTONE  = BlockType.new(67)
-  DOOR_IRON           = BlockType.new(71)
-  REDSTONE_ORE        = BlockType.new(73)
-  SNOW                = BlockType.new(78)
-  ICE                 = BlockType.new(79)
-  SNOW_BLOCK          = BlockType.new(80)
-  CACTUS              = BlockType.new(81)
-  CLAY                = BlockType.new(82)
-  SUGAR_CANE          = BlockType.new(83)
-  FENCE               = BlockType.new(85)
-  GLOWSTONE_BLOCK     = BlockType.new(89)
-  BEDROCK_INVISIBLE   = BlockType.new(95)
-  STONE_BRICK         = BlockType.new(98)
-  GLASS_PANE          = BlockType.new(102)
-  MELON               = BlockType.new(103)
-  FENCE_GATE          = BlockType.new(107)
-  GLOWING_OBSIDIAN    = BlockType.new(246)
-  NETHER_REACTOR_CORE = BlockType.new(247)
-
-  def ==(another_block_type)
-    @id == another_block_type.id
-  end
-
-end

data/spec/block_type_spec.rb

@@ -1,10 +0,0 @@
-require 'block_type'
-
-describe 'BlockType' do
-
-  it 'is equivalent to another block type with the same id' do
-    bt1 = BlockType.new(0)
-    bt2 = BlockType.new(0)
-    bt1.should eq(bt2)
-  end
-end