httpattack-lib 0.0.1 → 0.1.0

data/README

@@ -1 +1,18 @@
 The game library for HTTP Attack.
+
+Item Protocol
+-------------
+Initializer must take two parameters, a username and an optional hash of settings.
+
+  SomeItem.new('luser', :set_this => 'to_this')
+
+The Item must override the following methods:
+
+stat
+------
+This method should return an Integer (or maybe a Float), which will be used to
+determine the Item strength.
+
+  def stat
+    stats['user']['followers_count'].to_i
+  end

data/Rakefile

@@ -45,7 +45,6 @@ namespace :gem do
     Rake::Task['gem:clean'].invoke
     Rake::Task['gem:build'].invoke
     gem = FileList["#{APP_DIR}/#{GEMNAME}-*.gem"].first
-    sudo = RUBY_PLATFORM !~ /win32/ ? "sudo" : ""
-    sh "#{sudo} gem uninstall #{GEMNAME} ; #{sudo} gem install #{gem}"
+    sh "gem uninstall #{GEMNAME} ; gem install #{gem}"
   end
 end

data/lib/httpattack.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
-require 'httpattack/weapons'
+require 'httpattack/items'
 
 module HTTPAttack
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/httpattack/items.rb

@@ -0,0 +1,25 @@
+require 'httpattack/items/base'
+require 'httpattack/items/github'
+require 'httpattack/items/twitter'
+
+module HTTPAttack
+  module Items
+
+    # A list of registered Item types (the actual classes).
+    TYPES = [ Github, Twitter ]
+
+    class InvalidStat < Exception; end
+    class MustOverrideMethod < Exception; end
+
+    # Items enumerator.  Just a wrapper to the TYPES array #each method.
+    def self.each(&block)
+      TYPES.send(:each, &block) if TYPES.respond_to?(:each)
+    end
+
+    # Items enumerator.  Just a wrapper to the TYPES array #map method.
+    def self.map(&block)
+      TYPES.send(:map, &block) if TYPES.respond_to?(:map)
+    end
+
+  end # Items
+end # HTTPAttack

data/lib/httpattack/{weapons → items}/base.rb

@@ -2,20 +2,20 @@ require 'json'
 require 'open-uri'
 
 module HTTPAttack
-  module Weapons
+  module Items
 
     class Base
-      attr_reader :stat, :stats
+      attr_reader :stats
 
-      # This is the strength of the weapon and must be
+      # This is the strength of the Item and must be
       # overridden in a subclass.  It should return
-      # an integer (or float).
-      def attack
+      # an Integer (or Float).
+      def stat
         raise MustOverrideMethod
       end
 
       # This is the URL where the JSON will come from.
-      # Must be overridden in a subclassed weapon.
+      # Must be overridden in a subclassed Item.
       def stats_url
         raise MustOverrideMethod
       end
@@ -40,5 +40,5 @@ module HTTPAttack
 
     end # Base
 
-  end # Weapons
+  end # Items
 end # HTTPAttack

data/lib/httpattack/{weapons → items}/github.rb

@@ -1,19 +1,19 @@
 module HTTPAttack
-  module Weapons
+  module Items
 
-    class Github < HTTPAttack::Weapons::Base
+    class Github < HTTPAttack::Items::Base
       STATS = ['followers_count', 'following_count']
 
       def initialize(username, options = {})
-        options[:stat] ||= 'followers_count'
-        raise Weapons::InvalidStat unless STATS.include?(options[:stat])
+        options[:remote_stat] ||= 'followers_count'
+        raise Items::InvalidStat unless STATS.include?(options[:remote_stat])
         @username = username
-        @stat = options[:stat]
+        @remote_stat = options[:remote_stat]
       end
 
-      def attack
+      def stat
         self.reload_stats! unless stats
-        stats['user'][@stat].to_i
+        stats['user'][@remote_stat].to_i
       end
 
       def stats_url
@@ -22,5 +22,5 @@ module HTTPAttack
 
     end # Github
 
-  end # Weapons
+  end # Items
 end # HTTPAttack

data/lib/httpattack/{weapons → items}/twitter.rb

@@ -1,19 +1,19 @@
 module HTTPAttack
-  module Weapons
+  module Items
 
-    class Twitter < HTTPAttack::Weapons::Base
+    class Twitter < HTTPAttack::Items::Base
       STATS = ['followers_count', 'friends_count']
 
       def initialize(username, options = {})
-        options[:stat] ||= 'followers_count'
-        raise Weapons::InvalidStat unless STATS.include?(options[:stat])
+        options[:remote_stat] ||= 'followers_count'
+        raise Items::InvalidStat unless STATS.include?(options[:remote_stat])
         @username = username
-        @stat = options[:stat]
+        @remote_stat = options[:remote_stat]
       end
 
-      def attack
+      def stat
         self.reload_stats! unless stats
-        stats[@stat].to_i
+        stats[@remote_stat].to_i
       end
 
       def stats_url
@@ -22,6 +22,6 @@ module HTTPAttack
 
     end # Twitter
 
-  end # Weapons
+  end # Items
 end # HTTPAttack
 

data/spec/httpattack/{weapons → items}/base_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
 
-include HTTPAttack::Weapons
+include HTTPAttack::Items
 describe Base do
   before(:each) do
     @remote_api = 'http://localhost:3000/users.json'
@@ -8,43 +8,43 @@ describe Base do
   end
 
   it 'should fetch some JSON from the URL' do
-    @weapon = Base.new
-    data = @weapon.reload_stats(@remote_api)
+    @item = Base.new
+    data = @item.reload_stats(@remote_api)
     data.should_not be_nil
     data.should be_kind_of(Hash)
   end
 
   it 'should fetch some JSON from the file path' do
-    @weapon = Base.new
-    data = @weapon.reload_stats(@local_file)
+    @item = Base.new
+    data = @item.reload_stats(@local_file)
     data.should_not be_nil
     data.should be_kind_of(Hash)
   end
 
   it 'should return an error hash' do
-    @weapon = Base.new
-    data = @weapon.reload_stats('invalid path')
+    @item = Base.new
+    data = @item.reload_stats('invalid path')
     data.should have_key('error')
     data['error'].should_not be_nil
   end
 
   it 'should force a subclass to override stats_url' do
-    @weapon = Base.new
+    @item = Base.new
     lambda do
-      @weapon.stats_url
-    end.should raise_error(HTTPAttack::Weapons::MustOverrideMethod)
+      @item.stats_url
+    end.should raise_error(HTTPAttack::Items::MustOverrideMethod)
   end
 
   it 'should load the stats with #fetch_json!' do
-    @weapon = Base.new
-    @weapon.reload_stats!(@local_file)
-    @weapon.stats.should_not be_nil
+    @item = Base.new
+    @item.reload_stats!(@local_file)
+    @item.stats.should_not be_nil
   end
 
-  it 'should force a subclass to override attack' do
-    @weapon = Base.new
+  it 'should force a subclass to override stat' do
+    @item = Base.new
     lambda do
-      @weapon.attack
-    end.should raise_error(HTTPAttack::Weapons::MustOverrideMethod)
+      @item.stat
+    end.should raise_error(HTTPAttack::Items::MustOverrideMethod)
   end
 end

data/spec/httpattack/items/github_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+include HTTPAttack::Items
+
+describe Github do
+  before(:each) do
+    @username   = 'Oshuma'
+    @stats_file = File.dirname(__FILE__) + '/responses/github-oshuma.json'
+    @stats_url  = "http://github.com/api/v2/json/user/show/#{@username}"
+
+    @item = Github.new(@username)
+    @item.reload_stats!(@stats_file)
+  end
+
+  it 'should form the API URL' do
+    @item.stats_url.should == @stats_url
+  end
+
+  it 'should load the item stats' do
+    stats = @item.reload_stats(@stats_file)
+    stats.should_not be_nil
+    stats.should be_kind_of(Hash)
+  end
+
+  it 'should default to the followers_count remote_stat' do
+    @item.instance_variable_get(:@remote_stat).should == 'followers_count'
+  end
+
+  it 'should have a (followers_count) stat of 15' do
+    @item = Github.new(@username, :stat => 'followers_count')
+    @item.reload_stats!(@stats_file) # test data
+    @item.stat.should == 15
+  end
+
+  it 'should have a (following_count) stat of 37' do
+    @item = Github.new(@username, :remote_stat => 'following_count')
+    @item.reload_stats!(@stats_file) # test data
+    @item.stat.should == 37
+  end
+
+  it 'should raise InvalidStat' do
+    lambda do
+      Github.new(@username, :remote_stat => 'invalid')
+    end.should raise_error(HTTPAttack::Items::InvalidStat)
+  end
+end

data/spec/httpattack/items/twitter_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+include HTTPAttack::Items
+
+describe Twitter do
+  before(:each) do
+    @username   = 'oshuma_dev'
+    @stats_file = File.dirname(__FILE__) + '/responses/twitter-oshuma_dev.json'
+    @stats_url  = "http://twitter.com/users/show/#{@username}.json"
+
+    @item = Twitter.new(@username)
+    @item.reload_stats!(@stats_file)
+  end
+
+  it 'should form the API URL' do
+    @item.stats_url.should == @stats_url
+  end
+
+  it 'should load the item stats' do
+    stats = @item.reload_stats(@stats_file)
+    stats.should_not be_nil
+    stats.should be_kind_of(Hash)
+  end
+
+  it 'should default to the followers_count remote_stat' do
+    @item.instance_variable_get(:@remote_stat).should == 'followers_count'
+  end
+
+  it 'should have a (followers_count) stat of 19' do
+    @item = Twitter.new(@username, :stat => 'followers_count')
+    @item.reload_stats!(@stats_file) # test data
+    @item.stat.should == 19
+  end
+
+  it 'should have a (friends_count) stat of 1' do
+    @item = Twitter.new(@username, :remote_stat => 'friends_count')
+    @item.reload_stats!(@stats_file) # test data
+    @item.stat.should == 1
+  end
+
+  it 'should raise InvalidStat' do
+    lambda do
+      Twitter.new(@username, :remote_stat => 'invalid')
+    end.should raise_error(HTTPAttack::Items::InvalidStat)
+  end
+end

data/spec/httpattack/items_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include HTTPAttack
+describe Items do
+  it 'should have a TYPES array containing weapon classes' do
+    Items::TYPES.should be_kind_of(Array)
+    Items::TYPES.each do |type|
+      type.class.should == Class
+    end
+  end
+
+  it 'should have an each method pointing to TYPES' do
+    Items.each do |type|
+      type.class.should == Class
+    end
+  end
+
+  it 'should have a map method pointing to TYPES' do
+    Items.map { |weapon| weapon }.should == Items::TYPES
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: httpattack-lib
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Dale Campbell
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-03 00:00:00 -05:00
+date: 2009-09-11 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: 
+description: Contains core functionality of the HTTPAttack web game.
 email: 
 - oshuma@gmail.com
 executables: []
@@ -25,17 +25,18 @@ extra_rdoc_files: []
 files: 
 - README
 - Rakefile
-- lib/httpattack/weapons/base.rb
-- lib/httpattack/weapons/github.rb
-- lib/httpattack/weapons/twitter.rb
-- lib/httpattack/weapons.rb
+- lib/httpattack/items/base.rb
+- lib/httpattack/items/github.rb
+- lib/httpattack/items/twitter.rb
+- lib/httpattack/items.rb
 - lib/httpattack.rb
-- spec/httpattack/weapons/base_spec.rb
-- spec/httpattack/weapons/github_spec.rb
-- spec/httpattack/weapons/responses/base.json
-- spec/httpattack/weapons/responses/github-oshuma.json
-- spec/httpattack/weapons/responses/twitter-oshuma_dev.json
-- spec/httpattack/weapons/twitter_spec.rb
+- spec/httpattack/items/base_spec.rb
+- spec/httpattack/items/github_spec.rb
+- spec/httpattack/items/responses/base.json
+- spec/httpattack/items/responses/github-oshuma.json
+- spec/httpattack/items/responses/twitter-oshuma_dev.json
+- spec/httpattack/items/twitter_spec.rb
+- spec/httpattack/items_spec.rb
 - spec/httpattack_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -62,10 +63,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: httpattack-lib
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: The game library for HTTPAttack
+summary: The game library for HTTPAttack.
 test_files: []
 

data/lib/httpattack/weapons.rb

@@ -1,10 +0,0 @@
-require 'httpattack/weapons/base'
-require 'httpattack/weapons/github'
-require 'httpattack/weapons/twitter'
-
-module HTTPAttack
-  module Weapons
-    class InvalidStat < Exception; end
-    class MustOverrideMethod < Exception; end
-  end # Weapons
-end # HTTPAttack

data/spec/httpattack/weapons/github_spec.rb

@@ -1,45 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
-include HTTPAttack::Weapons
-
-describe Github do
-  before(:each) do
-    @username   = 'Oshuma'
-    @stats_file = File.dirname(__FILE__) + '/responses/github-oshuma.json'
-    @stats_url  = "http://github.com/api/v2/json/user/show/#{@username}"
-
-    @weapon = Github.new(@username)
-    @weapon.reload_stats!(@stats_file)
-  end
-
-  it 'should form the API URL' do
-    @weapon.stats_url.should == @stats_url
-  end
-
-  it 'should load the weapon stats' do
-    stats = @weapon.reload_stats(@stats_file)
-    stats.should_not be_nil
-    stats.should be_kind_of(Hash)
-  end
-
-  it 'should default to the followers_count stat' do
-    @weapon.stat.should == 'followers_count'
-  end
-
-  it 'should have a (followers_count) attack of 15' do
-    @weapon = Github.new(@username, :stat => 'followers_count')
-    @weapon.reload_stats!(@stats_file) # test data
-    @weapon.attack.should == 15
-  end
-
-  it 'should have a (following_count) attack of 37' do
-    @weapon = Github.new(@username, :stat => 'following_count')
-    @weapon.reload_stats!(@stats_file) # test data
-    @weapon.attack.should == 37
-  end
-
-  it 'should raise InvalidStat' do
-    lambda do
-      Github.new(@username, :stat => 'invalid')
-    end.should raise_error(HTTPAttack::Weapons::InvalidStat)
-  end
-end

data/spec/httpattack/weapons/twitter_spec.rb

@@ -1,45 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
-include HTTPAttack::Weapons
-
-describe Twitter do
-  before(:each) do
-    @username   = 'oshuma_dev'
-    @stats_file = File.dirname(__FILE__) + '/responses/twitter-oshuma_dev.json'
-    @stats_url  = "http://twitter.com/users/show/#{@username}.json"
-
-    @weapon = Twitter.new(@username)
-    @weapon.reload_stats!(@stats_file)
-  end
-
-  it 'should form the API URL' do
-    @weapon.stats_url.should == @stats_url
-  end
-
-  it 'should load the weapon stats' do
-    stats = @weapon.reload_stats(@stats_file)
-    stats.should_not be_nil
-    stats.should be_kind_of(Hash)
-  end
-
-  it 'should default to the followers_count stat' do
-    @weapon.stat.should == 'followers_count'
-  end
-
-  it 'should have a (followers_count) attack of 19' do
-    @weapon = Twitter.new(@username, :stat => 'followers_count')
-    @weapon.reload_stats!(@stats_file) # test data
-    @weapon.attack.should == 19
-  end
-
-  it 'should have a (friends_count) attack of 1' do
-    @weapon = Twitter.new(@username, :stat => 'friends_count')
-    @weapon.reload_stats!(@stats_file) # test data
-    @weapon.attack.should == 1 
-  end
-
-  it 'should raise InvalidStat' do
-    lambda do
-      Twitter.new(@username, :stat => 'invalid')
-    end.should raise_error(HTTPAttack::Weapons::InvalidStat)
-  end
-end