rakismet 0.3.5

data/CHANGELOG

@@ -0,0 +1,8 @@
+= 0.3.5
+* Added gemspec and rails/init.rb so rakismet can work as a gem [michael]
+* Added generator template and manifest [michael]
+= 0.3.0
+* Abstract out Rakismet version string
+* Set default Akismet Host
+* Abstract out the Akismet host [Mike Burns]
+* Started keeping a changelog :P

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Josh French
+
+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,156 @@
+Rakismet
+========
+
+**Akismet** (<http://akismet.com/>) is a collaborative spam filtering service.
+**Rakismet** is easy Akismet integration with your Rails app, including support
+for TypePad's AntiSpam service.
+
+
+Setup
+=====
+
+As a plugin
+-----------
+
+Install with `script/plugin install git://github.com/jfrench/rakismet`
+
+Rakismet installation should have created a file called rakismet.rb in
+config/initializers. If not, you can copy the template from:
+vendor/plugins/rakismet/generators/rakismet/templates/config/initializers/rakismet.rb.
+
+As a gem
+--------
+
+`gem install rakismet` if you're using gemcutter or 
+`gem install jfrench-rakismet` if you're using GitHub.
+
+From your app root, run `./script/generate rakismet` to create the Rakismet
+initializer.
+
+Getting Started
+---------------
+
+Once you've installed Rakismet via your method of choice, you'll need an API 
+key from the folks at WordPress. Head on over to http://wordpress.com/api-keys/ 
+and sign up for a new username.
+
+Edit config/initializers/rakismet.rb and fill in `Rakismet::URL` and
+`Rakismet::KEY` with the URL of your application and the key you received
+from WordPress.
+
+If you wish to use another Akismet-compatible API provider such as TypePad's
+antispam service, you'll also need to change the `Rakismet::HOST`.
+
+Finally, introduce Rakismet to your application. Let's assume you have a Comment
+model and a CommentsController:
+
+    class Comment < ActiveRecord::Base
+      has_rakismet
+    end
+
+    class CommentsController < ActionController::Base
+      has_rakismet
+    end
+
+
+Basic Usage
+===========
+
+Rakismet provides three methods for interacting with Akismet:
+
+  `spam?`
+
+From within a CommentsController action, simply call `@comment.spam?` to get a
+true/false response. True means it's spam, false means it's not. Well,
+usually; it's possible something went wrong and Akismet returned an error
+message. `@comment.spam?` will return false if this happens. You can check
+`@comment.akismet_response` to be certain; anything other than 'true' or
+'false' means you got an error. That said, as long as you're collecting the
+data listed above it's probably sufficient to check `spam?` alone.
+
+  `ham!` and `spam!`
+
+Akismet works best with your feedback. If you spot a comment that was
+erroneously marked as spam, `@comment.ham!` will resubmit to Akismet, marked
+as a false positive. Likewise if they missed a spammy comment,
+`@comment.spam!` will resubmit marked as spam.
+
+
+What's Required in the Comment Model?
+=====================================
+
+Rakismet sends the following information to the spam-hungry robots at Akismet.
+This means these attributes should be stored in your Comment model or
+accessible through that class's associations.
+
+    author        : name submitted with the comment
+    author_url    : URL submitted with the comment
+    author_email  : email submitted with the comment
+    comment_type  : 'comment', 'trackback', 'pingback', or whatever you fancy
+    content       : the content submitted
+    permalink     : the permanent URL for the entry the comment belongs to
+    user_ip       : IP address used to submit this comment
+    user_agent    : user agent string
+    referrer      : http referer
+
+`user_ip`, `user_agent`, and `referrer` are optional; you don't have to store
+them, but it's a good idea. If you omit them from your model (see "Customizing
+Attributes"), the `spam?` method will attempt to extract these values from the
+current request object, if there is one. This means Rakismet can operate
+asynchronously by storing the request attributes and validating the comment at
+a later time. Or it can operate synchronously by plucking the request
+attributes from the environment at the time the comment is initially submitted
+and validating on the spot. The latter could work well with a before_create
+callback.
+
+
+Customizing the Comment Model
+=============================
+
+If your attribute names don't match those listed above, or if some of them
+live on other objects, you can pass `has_rakismet` a hash mapping the default 
+attributes to your own. You can change the names, if your comment attributes
+don't match the defaults:
+
+    class Comment < ActiveRecord::Base
+      has_rakismet :author => :commenter_name,
+                   :author_email => :commenter_email
+    end
+
+Or you can pass in a proc, to access associations:
+
+    class Comment < ActiveRecord::Base
+      belongs_to :author
+      has_rakismet :author => proc { author.name },
+                   :author_email => proc { author.email }
+    end
+
+For any attribute you don't specify, Rakismet will try to find an attribute or 
+method matching the default name. As mentioned above, if `user_ip`,
+`user_agent`, and `referrer` are not present on your model, Rakismet will
+attempt to find them in the request environment when `spam?` is called from
+within a Rakismet-aware controller action.
+
+Customizing the Comments Controller
+===================================
+
+Most of the time you won't be checking for spam on every action defined in
+your controller. If you only call `spam?` within `CommentsController#create` 
+and you'd like to reduce filter overhead, `has_rakismet` takes `:only` and
+`:except` parameters that work like the standard before/around/after filter
+options.
+
+    class CommentsController < ActionController::Base
+      has_rakismet :only => :create
+    end
+
+Forked
+=============================
+
+At the time of forking, the only addition to this project has been to add gemspec 
+and generator templates so rakismet can be used as a gem. This is a better solution
+when working with reloadable plugins as rakismet is not compatible when plugins are
+reloadable.
+    
+--------------------------------------------------------------
+Copyright (c) 2008 Josh French, released under the MIT license

data/generators/rakismet/rakismet_generator.rb

@@ -0,0 +1,7 @@
+class RakismetGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file "config/initializers/rakismet.rb", "config/initializers/rakismet.rb"
+    end
+  end
+end

data/generators/rakismet/templates/config/initializers/rakismet.rb

@@ -0,0 +1,3 @@
+Rakismet::KEY  = ''
+Rakismet::URL  = ''
+Rakismet::HOST = 'rest.akismet.com'

data/lib/rakismet.rb

@@ -0,0 +1,69 @@
+require 'net/http'
+require 'uri'
+
+module Rakismet
+  module Version
+    Major = '0'
+    Minor = '3'
+    Tiny  = '5'
+  end
+
+  def self.version
+    [Version::Major, Version::Minor, Version::Tiny].join('.')
+  end
+
+  class Base
+    cattr_accessor :valid_key, :rakismet_binding
+    
+    class << self
+      def validate_key
+        validate_constants
+        akismet = URI.parse(verify_url)
+        _, valid = Net::HTTP.start(akismet.host) do |http|
+          data = "key=#{Rakismet::KEY}&blog=#{Rakismet::URL}"
+          http.post(akismet.path, data, Rakismet::HEADERS)
+        end
+        self.valid_key = (valid == 'valid')
+      end
+      
+      def valid_key?
+        @@valid_key == true
+      end
+      
+      def akismet_call(function, args={})
+        validate_constants
+        args.merge!(:blog => Rakismet::URL)
+        akismet = URI.parse(call_url(function))
+        _, response = Net::HTTP.start(akismet.host) do |http|
+          data = args.map { |k,v| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
+          http.post(akismet.path, data, Rakismet::HEADERS)
+        end
+        response
+      end
+      
+      protected
+        
+        def verify_url
+          "http://#{Rakismet::HOST}/1.1/verify-key"
+        end
+
+        def call_url(function)
+          "http://#{Rakismet::KEY}.#{Rakismet::HOST}/1.1/#{function}"
+        end
+
+        def validate_constants
+          raise Undefined, "Rakismet::KEY is not defined"  if Rakismet::KEY.blank?
+          raise Undefined, "Rakismet::URL is not defined"  if Rakismet::URL.blank?
+          raise Undefined, "Rakismet::HOST is not defined" if Rakismet::HOST.blank?
+        end
+    end
+  end
+  
+  Undefined = Class.new(NameError)
+  NoBinding = Class.new(NameError)
+  
+  HEADERS = {
+    'User-Agent' => "Rails/#{Rails::VERSION::STRING} | Rakismet/#{Rakismet.version}",
+    'Content-Type' => 'application/x-www-form-urlencoded'
+  }
+end

data/lib/rakismet/controller_extensions.rb

@@ -0,0 +1,26 @@
+module Rakismet
+  module ControllerExtensions
+    
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+    
+    def rakismet(&block)
+      Rakismet::Base.rakismet_binding = binding
+      yield
+      Rakismet::Base.rakismet_binding = nil
+    end
+    private :rakismet
+
+    module ClassMethods
+      def has_rakismet(opts={})
+        skip_filter :rakismet # in case we're inheriting from another Rakismeted controller
+        opts.assert_valid_keys(:only, :except)
+        self.around_filter :rakismet, opts
+      end
+    end
+    
+  end
+end

data/lib/rakismet/model_extensions.rb

@@ -0,0 +1,69 @@
+module Rakismet
+  module ModelExtensions
+   
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :akismet_response
+        class_inheritable_hash :akismet_attrs
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+   
+    module ClassMethods
+      def has_rakismet(args={})
+        self.akismet_attrs ||= {}
+        [:comment_type, :author, :author_url, :author_email, :content].each do |field|
+           # clunky, but throwing around +type+ will break your heart
+           fieldname = field.to_s =~ %r(^comment_) ? field : "comment_#{field}".intern
+           self.akismet_attrs[fieldname] = args.delete(field) || field
+        end
+        [:user_ip, :user_agent, :referrer].each do |field|
+          self.akismet_attrs[field] = (args.delete(field) || field) if args.has_key?(field) or self.public_instance_methods.include?(field.to_s)
+        end
+        args.each_pair do |f,v|
+          self.akismet_attrs[f] = v
+        end
+      end
+    end
+    
+    module InstanceMethods
+      def spam?
+        data = akismet_data
+
+        unless Rakismet::Base.rakismet_binding.nil?
+          { :referrer => 'request.referer', :user_ip => 'request.remote_ip',
+            :user_agent => 'request.user_agent' }.each_pair do |k,v|
+              data[k] = eval(v, Rakismet::Base.rakismet_binding) || ''
+          end
+        end
+
+        self.akismet_response = Rakismet::Base.akismet_call('comment-check', data)
+        self.akismet_response == 'true'
+      end
+
+      def spam!
+        Rakismet::Base.akismet_call('submit-spam', akismet_data)
+      end
+
+      def ham!
+        Rakismet::Base.akismet_call('submit-ham', akismet_data)
+      end
+
+      private
+
+        def akismet_data
+          self.class.akismet_attrs.keys.inject({}) do |data,attr|
+            data.merge attr =>  if self.class.akismet_attrs[attr].is_a?(Proc)
+                                  instance_eval(&self.class.akismet_attrs[attr])
+                                elsif respond_to?(self.class.akismet_attrs[attr])
+                                  send(self.class.akismet_attrs[attr])
+                                else
+                                  self.class.akismet_attrs[attr]
+                                end
+          end
+        end
+    end
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+ActionController::Base.send :include, Rakismet::ControllerExtensions
+ActiveRecord::Base.send :include, Rakismet::ModelExtensions

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: rakismet
+version: !ruby/object:Gem::Version 
+  version: 0.3.5
+platform: ruby
+authors: 
+- Josh French
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-16 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Rakismet is easy Akismet integration with your Rails app, including support for TypePad's AntiSpam service.
+email: systems@inspiredigital.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- MIT-LICENSE
+files: 
+- CHANGELOG
+- README.md
+- MIT-LICENSE
+- rails/init.rb
+- lib/rakismet.rb
+- lib/rakismet/controller_extensions.rb
+- lib/rakismet/model_extensions.rb
+- generators/rakismet/rakismet_generator.rb
+- generators/rakismet/templates/config/initializers/rakismet.rb
+has_rdoc: true
+homepage: http://github.com/jfrench/rakismet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rakismet
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Rakismet is easy Akismet integration with your Rails app, including support for TypePad's AntiSpam service.
+test_files: []
+