spamster 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brian Alexander
+
+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,75 @@
+# Spamster [![Build Status](https://secure.travis-ci.org/balexand/spamster.png)](http://travis-ci.org/balexand/spamster)
+
+Simple spam filtering.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spamster'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spamster
+
+## Usage
+
+### Quick start
+
+Start by signing up for an API key [here](https://akismet.com/signup/). Then configure Spamster like:
+
+```ruby
+Spamster.blog = "http://yoursite.com/"
+Spamster.key = "your-api-key"
+```
+
+FIXME middleware
+FIXME usage
+
+### Spamster methods
+
+#### key_valid?
+
+Checks if the key is valid using [verify-key](http://akismet.com/development/api/#verify-key).
+
+```ruby
+Spamster.key_valid?
+```
+
+#### spam?
+
+Checks if a comment is spam using [comment-check](http://akismet.com/development/api/#comment-check)
+
+```ruby
+Spamster.spam?(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
+```
+
+### spam!
+
+Reports a false negative using [submit-spam](http://akismet.com/development/api/#submit-spam)
+
+```ruby
+Spamster.spam!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
+```
+
+### ham!
+
+Reports a false positive using [submit-ham](http://akismet.com/development/api/#submit-ham)
+
+```ruby
+Spamster.ham!(user_ip: "222.222.222.222", user_agent: "Mozilla", comment_author: "viagra-test-123")
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/spamster.rb

@@ -0,0 +1,54 @@
+require 'net/http'
+require 'spamster/version'
+
+module Spamster
+  class <<self
+    attr_accessor :blog, :key
+
+    # see http://akismet.com/development/api/#verify-key
+    def key_valid?
+      check_config
+      params = {:blog => blog, :key => key}
+      response = Net::HTTP.post_form(URI("http://rest.akismet.com/1.1/verify-key"), params)
+      response.body == 'valid'
+    end
+
+    # see http://akismet.com/development/api/#comment-check
+    def spam?(params)
+      submit("comment-check", params) == 'true'
+    end
+
+    # see http://akismet.com/development/api/#submit-spam
+    def spam!(params)
+      submit("submit-spam", params)
+    end
+
+    # see http://akismet.com/development/api/#submit-ham
+    def ham!(params)
+      submit("submit-ham", params)
+    end
+
+  private
+    def check_config
+      raise "'Spamster.blog' must be set" unless blog
+      raise "'Spamster.key' must be set"  unless key
+    end
+
+    def check_required_params(params)
+      # these params are required by spam?, spam!, and ham!
+      [:blog, :user_agent, :user_ip].each do |param|
+        raise "required param #{param.inspect} is missing" unless params[param]
+      end
+    end
+
+    def submit(method, params = {})
+      check_config
+      params = params.merge(:blog => blog)
+      check_required_params(params)
+      response = Net::HTTP.post_form(URI("http://#{key}.rest.akismet.com/1.1/#{method}"), params)
+      response.body
+    end
+  end
+end
+
+# FIXME User-Agent

data/lib/spamster/version.rb

@@ -0,0 +1,3 @@
+module Spamster
+  VERSION = "0.0.1"
+end

data/spamster.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/spamster/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brian Alexander"]
+  gem.email         = ["balexand@gmail.com"]
+  gem.description   = %q{Simple spam filtering that takes minutes to set up.}
+  gem.summary       = %q{Simple spam filtering.}
+  gem.homepage      = "https://github.com/balexand/spamster"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "spamster"
+  gem.require_paths = ["lib"]
+  gem.version       = Spamster::VERSION
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "webmock"
+
+  gem.add_runtime_dependency "jruby-openssl" if RUBY_PLATFORM == "java"
+end

data/spec/spamster_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Spamster do
+  before(:each) do
+    Spamster.blog = "http://example.com/"
+    Spamster.key = "123abc"
+  end
+
+  describe "submit" do
+    before(:each) do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/comment-check")
+    end
+
+    it "should raise exception if :blog is not configured" do
+      Spamster.blog = nil
+      expect do
+        Spamster.send(:submit, "comment-check")
+      end.to raise_exception{ |e| e.message.should == "'Spamster.blog' must be set" }
+    end
+
+    it "should raise exception if :key is not configured" do
+      Spamster.key = nil
+      expect do
+        Spamster.send(:submit, "comment-check")
+      end.to raise_exception{ |e| e.message.should == "'Spamster.key' must be set" }
+    end
+  end
+
+  describe "key_valid?" do
+    it "should return true with valid response" do
+      stub_request(:post, "http://rest.akismet.com/1.1/verify-key").to_return(:body => "valid")
+      Spamster.key_valid?.should == true
+      assert_requested(:post, "http://rest.akismet.com/1.1/verify-key", :times => 1) do |req|
+        CGI.parse(req.body).should == {"blog" => ["http://example.com/"], "key" => ["123abc"]}
+        true
+      end
+    end
+
+    it "should return false with invalid response" do
+      stub_request(:post, "http://rest.akismet.com/1.1/verify-key").to_return(:body => "invalid")
+      Spamster.key_valid?.should == false
+      assert_requested(:post, "http://rest.akismet.com/1.1/verify-key", :times => 1) do |req|
+        CGI.parse(req.body).should == {"blog" => ["http://example.com/"], "key" => ["123abc"]}
+        true
+      end
+    end
+  end
+
+  describe "spam?" do
+    it "should return true if spam" do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/comment-check").to_return(:body => "true")
+      Spamster.spam?(:user_ip => "222.222.222.222", :user_agent => "Mozilla", :comment_author => "viagra-test-123").should == true
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/comment-check", :times => 1) do |req|
+        CGI.parse(req.body).should == {"user_ip"=>["222.222.222.222"], "user_agent"=>["Mozilla"], "comment_author"=>["viagra-test-123"], "blog"=>["http://example.com/"]}
+        true
+      end
+    end
+
+    it "should return false if not spam" do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/comment-check").to_return(:body => "false")
+      Spamster.spam?(:user_ip => "222.222.222.222", :user_agent => "Mozilla").should == false
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/comment-check", :times => 1) do |req|
+        CGI.parse(req.body).should == {"user_ip"=>["222.222.222.222"], "user_agent"=>["Mozilla"], "blog"=>["http://example.com/"]}
+        true
+      end
+    end
+
+    it "should raise exception if required param missing" do
+      expect do
+        Spamster.spam?(:user_ip => "222.222.222.222")
+      end.to raise_exception{ |e| e.message.should == "required param :user_agent is missing" }
+
+      expect do
+        Spamster.spam?(:user_agent => "Mozilla")
+      end.to raise_exception{ |e| e.message.should == "required param :user_ip is missing" }
+    end
+  end
+
+  describe "spam!" do
+    it "should submit request" do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/submit-spam").to_return(:body => "Thanks for making the web a better place.")
+      Spamster.spam!(:user_ip => "222.222.222.222", :user_agent => "Mozilla", :comment_author => "viagra-test-123")
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/submit-spam", :times => 1) do |req|
+        CGI.parse(req.body).should == {"user_ip"=>["222.222.222.222"], "user_agent"=>["Mozilla"], "comment_author"=>["viagra-test-123"], "blog"=>["http://example.com/"]}
+        true
+      end
+    end
+  end
+
+  describe "ham!" do
+    it "should submit request" do
+      stub_request(:post, "http://123abc.rest.akismet.com/1.1/submit-ham").to_return(:body => "Thanks for making the web a better place.")
+      Spamster.ham!(:user_ip => "222.222.222.222", :user_agent => "Mozilla", :comment_author => "viagra-test-123")
+      assert_requested(:post, "http://123abc.rest.akismet.com/1.1/submit-ham", :times => 1) do |req|
+        CGI.parse(req.body).should == {"user_ip"=>["222.222.222.222"], "user_agent"=>["Mozilla"], "comment_author"=>["viagra-test-123"], "blog"=>["http://example.com/"]}
+        true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'cgi'
+require 'rspec'
+require 'webmock/rspec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'spamster'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: spamster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Alexander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple spam filtering that takes minutes to set up.
+email:
+- balexand@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spamster.rb
+- lib/spamster/version.rb
+- spamster.gemspec
+- spec/spamster_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/balexand/spamster
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Simple spam filtering.
+test_files:
+- spec/spamster_spec.rb
+- spec/spec_helper.rb