stop_forum_spam 0.0.1 → 0.0.2

data/lib/stop_forum_spam.rb

@@ -1,9 +1,10 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'rubygems'
 require 'httparty'
 require 'stop_forum_spam/spammer'
-
+require 'stop_forum_spam/client'
 
 module StopForumSpam
   VERSION = '0.0.1'

data/lib/stop_forum_spam/client.rb

@@ -0,0 +1,25 @@
+module StopForumSpam
+  class Client
+    include HTTParty
+    format :xml
+    base_uri("http://stopforumspam.com")
+    
+    attr_accessor :api_key
+    
+    def initialize(api_key=nil)
+      @api_key = api_key
+    end
+    
+    def post(options={})
+      self.class.post('/post.php', 
+        :body => {:ip_addr => options[:ip_address], 
+          :email=> options[:email], 
+          :username => options[:username], 
+          :api_key => api_key})
+    end
+    
+    def get(options={})
+      self.class.get('/api', options)
+    end
+  end
+end

data/lib/stop_forum_spam/spammer.rb

@@ -1,38 +1,35 @@
 module StopForumSpam
   class Spammer   
-    include HTTParty
-    format :xml
-    base_uri("http://stopforumspam.com:80")
+    attr_reader :id, :type, :frequency, :last_seen, :appears
     
-    attr_reader :type, :id, :frequency, :last_seen
+    alias_method :count, :frequency
+    alias_method :appears?, :appears
     
     def initialize(id)
-      @id = id
-      
-      if @id.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/)
-        @type = 'ip'
-      elsif @id.match(/.*@.*/)
-        @type = 'email'
-      else
-        @type = 'username'
-      end
-
-      @frequency = response['response']["frequency"]
-      @last_seen = response['response']["lastseen"]
-      @appears   = response['response']['appears'] == 'yes' ? true : false
+      @id         = id
+      @type       = self.class.guess_type(id)
+      @frequency  = response["frequency"]
+      @last_seen  = response["lastseen"]
+      @appears    = response['appears'] == 'yes' ? true : false
     end
     
-    def appears?
-      @appears
-    end
-        
     def self.is_spammer?(id)
-      StopForumSpam::Spammer.new(id).appears?
+      new(id).appears?
+    end
+
+    def self.guess_type(id)
+      return 'ip' if id.match(/\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/)
+      return 'email' if id.match(/.*@.*/)
+      return 'username'
     end
     
-    private
+    private  
       def response
-        @response ||= self.class.get('/api', :query => {@type.to_sym => @id})
+        @response ||= make_request['response']
+      end
+      def make_request
+        client = StopForumSpam::Client.new
+        client.get(:query => {@type.to_sym => @id})
       end
   end
 end

data/spec/spammer_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe StopForumSpam::Spammer do
+  FakeWeb.allow_net_connect = false
+  
+  context 'initializing a spammer by ip, email, and username' do
+    { :ip => '127.0.0.1', 
+      :email => 'test@tester.com', 
+      :username => 'testuser'
+    }.each do |id_type, v|
+      
+      it "initializes with an #{id_type}" do
+        fake_get_response(id_type => v)
+        StopForumSpam::Spammer.new(v).class.should == StopForumSpam::Spammer
+      end
+    end
+  end
+
+  it "should initialize a spammer by ip" do
+    fake_get_response(:ip => '127.0.0.1')
+    spammer = StopForumSpam::Spammer.new('127.0.0.1')
+    spammer.type.should == 'ip'
+  end
+
+  it 'should initialize a spammer by email' do
+    fake_get_response(:email => 'test%40tester.com')
+    spammer = StopForumSpam::Spammer.new('test@tester.com')
+    spammer.type.should == 'email'
+  end
+
+  it 'should initialize a spammer by username' do
+    fake_get_response(:username => 'testuser')
+    spammer = StopForumSpam::Spammer.new('testuser')
+    spammer.type.should == 'username'
+  end
+
+  it 'should have attributes from the response' do
+    last_seen = "2009-04-16 23:11:19"
+    fake_get_response(:ip => '127.0.0.1', :last_seen => last_seen, :appears => true)
+    spammer = StopForumSpam::Spammer.new('127.0.0.1')
+    spammer.type.should == "ip"
+    spammer.appears?.should be_true
+    spammer.last_seen.should == last_seen
+  end
+
+  context '#count' do
+    it 'should count the amount of times the spammer has been added' do
+      fake_get_response(:ip => '127.0.0.1', :frequency => 41)
+      spammer = StopForumSpam::Spammer.new('127.0.0.1')
+      spammer.count.should == '41'
+    end
+  end
+
+  it 'should have an id' do
+    fake_get_response(:ip => '127.0.0.1')
+    spammer = StopForumSpam::Spammer.new('127.0.0.1')
+    spammer.id.should == '127.0.0.1'
+  end
+
+  it "should find a spammer by ip" do
+    fake_get_response(:ip => '127.0.0.1', :appears => true)
+    StopForumSpam::Spammer.is_spammer?("127.0.0.1").should be_true
+  end
+
+  it "should return false when the spammer is not found by ip" do
+    fake_get_response(:ip => '127.0.0.1', :appears => false)
+    StopForumSpam::Spammer.is_spammer?('127.0.0.1').should be_false
+  end
+
+  it "should find a spammer by email" do
+    fake_get_response(:email => 'test%40tester.com', :appears => true)
+    StopForumSpam::Spammer.is_spammer?("test@tester.com").should be_true
+  end
+
+  it "should return false when a spammer is not found by email" do
+    fake_get_response(:email => 'test%40tester.com', :appears => false)
+    StopForumSpam::Spammer.is_spammer?('test@tester.com').should be_false
+  end
+
+  it "should find a spammer by username" do
+    fake_get_response(:username => 'testuser', :appears => true)
+    StopForumSpam::Spammer.is_spammer?('testuser').should be_true
+  end
+
+  it "should return false when a spammer is not found by username" do
+    fake_get_response(:username => 'testuser', :appears => false)
+    StopForumSpam::Spammer.is_spammer?('testuser').should be_false
+  end
+
+  context '#guess_type' do
+    it 'should return the ip type' do
+      StopForumSpam::Spammer.guess_type('127.0.0.1').should.eql? "ip"
+    end
+
+    it 'should return the email type ' do
+      StopForumSpam::Spammer.guess_type('test@testuser.com').should.eql? "email"
+    end
+
+    it 'should return the username type' do
+      StopForumSpam::Spammer.guess_type("testuser").should.eql? 'username'
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,4 +1,25 @@
+require 'rubygems'
+require 'active_support'
 require 'spec'
 require 'fakeweb'
 
-require File.join(File.dirname(__FILE__), '..', 'lib', 'stop_forum_spam')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'stop_forum_spam')
+
+def fake_get_response(options={})
+  id_type = [:ip, :email, :username].select { |k| options.has_key?(k) }.first.to_s
+  url = "http://stopforumspam.com/api?#{id_type}=#{options[id_type.to_sym]}"
+  options[:type] = id_type
+  options[:string] = format_options(options)
+  FakeWeb.register_uri(:get, url, options)
+end
+
+def fake_post_response(api_key, ip_addr, email, username, options={})
+  FakeWeb.register_uri(:post, "http://stopforumspam.com:80/post.php", options)
+end
+
+def format_options(options)
+  appears = options[:appears]
+  frequency = options[:frequency]
+  last_seen = options[:last_seen]
+  "<response success='true'><type>#{options[:type]}</type><appears>#{appears ? 'yes' : 'no'}</appears><frequency>#{appears ? '0' : frequency}</frequency><lastseen>#{last_seen}</lastseen></response>"
+end

data/spec/stop_forum_spam_spec.rb

@@ -1,78 +1,29 @@
-require 'spec_helper'
-
-describe StopForumSpam::Spammer do
-  
-  it "should initialize a spammer by ip" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?username=127.0.0.1", 
-      :string => "<response success='true'><type>ip</type><appears>yes</appears><frequency>10</frequency></response>")
-    spammer = StopForumSpam::Spammer.new('127.0.0.1')
-  end
-  
-  it 'should initialize a spammer by email' do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?username=test@tester.com", 
-      :string => "<response success='true'><type>email</type><appears>yes</appears><frequency>10</frequency></response>")
-    spammer = StopForumSpam::Spammer.new('test@tester.com')
-    spammer.type.should == 'email'
-  end
-  
-  it 'should initialize a spammer by username' do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?username=testuser", 
-      :string => "<response success='true'><type>username</type><appears>yes</appears><frequency>10</frequency></response>")
-    spammer = StopForumSpam::Spammer.new('testuser')
-    spammer.type.should == 'username'
-  end
-  
-  it 'should have attributes from the response' do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?ip=127.0.0.1", 
-      :string => "<response success='true'><type>ip</type><appears>yes</appears><lastseen>2009-04-16 23:11:19</lastseen><frequency>41</frequency></response>")
-    spammer = StopForumSpam::Spammer.new('127.0.0.1')
-    spammer.type.should == "ip"
-    spammer.appears?.should be_true
-    spammer.last_seen.should == "2009-04-16 23:11:19"
-    spammer.frequency == '41'
-  end
-  
-  it 'should have an id' do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?ip=127.0.0.1", 
-      :string => "<response success='true'><type>ip</type><appears>yes</appears><lastseen>2009-04-16 23:11:19</lastseen><frequency>41</frequency></response>")
-    spammer = StopForumSpam::Spammer.new('127.0.0.1')
-    spammer.id.should == '127.0.0.1'
-  end
-  
-  it "should find a spammer by ip" do
-    FakeWeb.allow_net_connect = false
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?ip=127.0.0.1", 
-      :string => "<response success='true'><type>ip</type><appears>yes</appears><lastseen>2009-04-16 23:11:19</lastseen><frequency>41</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?("127.0.0.1").should be_true
-  end
-  
-  it "should return false when the spammer is not found by ip" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?ip=127.0.0.1", 
-      :string => "<response success='true'><type>ip</type><appears>no</appears><frequency>0</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?('127.0.0.1').should be_false
-  end
-  
-  it "should find a spammer by email" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?email=test%40tester.com", 
-      :string => "<response success='true'><type>email</type><appears>yes</appears><lastseen>2009-06-25 00:24:29</lastseen><frequency>2</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?("test@tester.com").should be_true
-  end
-  
-  it "should return false when a spammer is not found by email" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?email=test%40tester.com", 
-      :string => "<response success='true'><type>email</type><appears>no</appears><frequency>0</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?('test@tester.com').should be_false
-  end
-  
-  it "should find a spammer by username" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?username=testuser", 
-      :string => "<response success='true'><type>username</type><appears>yes</appears><frequency>10</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?('testuser')
-  end
-  
-  it "should return false when a spammer is not found by username" do
-    FakeWeb.register_uri(:get, "http://stopforumspam.com/api?username=testuser", 
-      :string => "<response success='true'><type>username</type><appears>no</appears><frequency>0</frequency></response>")
-    StopForumSpam::Spammer.is_spammer?('testuser')
-  end  
+require 'spec_helper'
+
+describe StopForumSpam::Client do
+
+  context "a new client" do
+    it "should instantiate" do
+      StopForumSpam::Client.new.class.should == StopForumSpam::Client
+    end
+
+    it "should initialize with an optional api key" do
+      client = StopForumSpam::Client.new('123456789')
+      client.api_key.should == '123456789'
+    end
+  end
+  
+  context 'posts a spammer' do
+    context 'with a valid ip address, email address, and username' do
+      before do
+        fake_post_response('123456789', '127.0.0.1', 'spammer%40ru.com', 'spammer500', :string => "valid post")
+        client = StopForumSpam::Client.new('123456789')
+        @response = client.post(:id_address => '127.0.0.1', :email => 'spammer@ru.com', :username => 'spammer500')
+      end
+    
+      it "should return true " do
+        @response.should be_true
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stop_forum_spam
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Lake Denman
@@ -9,11 +9,11 @@ autorequire: httparty
 bindir: bin
 cert_chain: []
 
-date: 2009-11-07 00:00:00 -05:00
+date: 2010-01-09 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: Small api wrapper for querying a spammer based on ip, email, or username information stored on http://stopforumspam.com
+description: Small api wrapper for getting and posting data to http://stopforumspam.com
 email: lake@lakedenman.com
 executables: []
 
@@ -22,8 +22,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/stop_forum_spam/client.rb
 - lib/stop_forum_spam/spammer.rb
 - lib/stop_forum_spam.rb
+- spec/spammer_spec.rb
 - spec/spec_helper.rb
 - spec/stop_forum_spam_spec.rb
 has_rdoc: true