battle-on 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
-# Battle::On
+# BattleOn
 
-TODO: Write a gem description
+A little weapon to help fight Platform45's Battleship API
 
 ## Installation
 
@@ -16,9 +16,38 @@ Or install it yourself as:
 
     $ gem install battle-on
 
+Now you're ready to attack!
+
 ## Usage
 
-TODO: Write usage instructions here
+When you're in the middle of game of Battleship you want to focus on
+your attack - we help you do that. 
+
+First, require 'battle-on'
+
+    require 'battle_on'
+
+Now you're ready to begin the game. To start a new game, all that's
+required is your name and email:
+
+    BattleOn.begin("Johnny Johnson", "Johnny@example.com")
+
+This will return a hash with your game id and Platform45's first attack:
+
+    {:id => 101, :x => 3, :y => 8}
+
+Once you've started a game, you can launch your attacks. It expects your
+game id and the attack coordinates as two arguments passed to the attack
+method:
+
+    BattleOn.attack(101, {:x => 1, :y => 7})
+
+This will return a hash with the status of your last attack, whether it
+was a hit or miss, and Platform45's next attack. Expect it to look like
+this:
+
+    {:status => "hit", :x => 5, :y => 5}
+
 
 ## Contributing
 

data/lib/battle_on/register_game.rb

@@ -6,8 +6,8 @@ module BattleOn
   #Start the game
   #
   #mandatory parameters
-  #email: my@email.com
   #name: My Name
+  #email: my@email.com
 
   class RegisterGame
     attr_reader :name, :email
@@ -31,5 +31,4 @@ module BattleOn
     end
 
   end
-
 end

data/lib/battle_on/send_attack.rb

@@ -1,3 +1,5 @@
+require 'JSON'
+
 module BattleOn
 
   #mandatory parameters:
@@ -29,9 +31,11 @@ module BattleOn
     private
 
     def attack
-      RestClient.post "http://battle.platform45.com/nuke", { x:  x_axis,
-                                                             y:  y_axis,
-                                                             id: game_id}.to_json
+      RestClient.post "http://battle.platform45.com/nuke", attack_params
+    end
+
+    def attack_params
+      { x: x_axis, y: y_axis, id: game_id}.to_json 
     end
 
     def get_x(args)
@@ -41,5 +45,4 @@ module BattleOn
     end
 
   end
-
 end

data/lib/battle_on/version.rb

@@ -1,3 +1,3 @@
 module BattleOn
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/battle_on.rb

@@ -1,19 +1,15 @@
 require "battle_on/version"
-
-#module Battle
-  #module On
+require "battle_on/register_game"
+require "battle_on/send_attack"
 
 module BattleOn
 
   def self.begin(name, email)
-    RegisterGame.execute(name: name, email: email)
+    RegisterGame.execute(name, email)
   end
 
   def self.attack(game_id, attack={})
-    SendAttack.execute(game_id: game_id, attack: attack)
+    SendAttack.execute(game_id, attack)
   end
 
 end
-
-  #end
-#end

data/spec/battle_on_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper_base'
+
+describe BattleOn do
+
+  describe ".begin" do
+
+    it "delegates to RegisterGame" do
+      #expect
+      BattleOn::RegisterGame.should_receive(:execute).with("foo bar", "foo@bar.com")
+      #when
+      BattleOn.begin("foo bar", "foo@bar.com")
+    end
+  end
+
+  describe ".attack" do
+
+    it "delegates to SendAttack" do
+      #expect
+      BattleOn::SendAttack.should_receive(:execute).with(101, {:x_axis => 3, :y_axis => 2})
+      #when
+      BattleOn.attack(101, {:x_axis => 3, :y_axis => 2})
+    end
+  end
+
+end

data/spec/spec_helper_base.rb

@@ -4,5 +4,6 @@ require 'webmock/rspec'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 
+require 'lib/battle_on'
 require 'lib/battle_on/register_game'
 require 'lib/battle_on/send_attack'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: battle-on
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,10 +77,11 @@ files:
 - lib/battle_on/register_game.rb
 - lib/battle_on/send_attack.rb
 - lib/battle_on/version.rb
+- spec/battle_on/register_game_spec.rb
+- spec/battle_on/send_attack_spec.rb
+- spec/battle_on_spec.rb
 - spec/helpers/register_game_spec_helper.rb
 - spec/helpers/send_attack_spec_helper.rb
-- spec/register_game_spec.rb
-- spec/send_attack_spec.rb
 - spec/spec_helper_base.rb
 homepage: ''
 licenses: []
@@ -107,8 +108,9 @@ signing_key:
 specification_version: 3
 summary: A little weapon to help fight Platform45's Battleship API.
 test_files:
+- spec/battle_on/register_game_spec.rb
+- spec/battle_on/send_attack_spec.rb
+- spec/battle_on_spec.rb
 - spec/helpers/register_game_spec_helper.rb
 - spec/helpers/send_attack_spec_helper.rb
-- spec/register_game_spec.rb
-- spec/send_attack_spec.rb
 - spec/spec_helper_base.rb