ruby-stopforumspam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46238cf4be69c6e2b4e4baec594c51bfe6ff85c0
+  data.tar.gz: 7970d43bc00bc301a050c160d7d6033fbdab381f
+SHA512:
+  metadata.gz: e5b42f9b9f6c0d2846330cdc15f04be3d4c0b13879af8667cf97f5782e550fb5774210e2e80edf2a421c9579e002e747361b018e2f19c51ac4d87a0976a97e3e
+  data.tar.gz: ba5200ffab33f34bcddd76b2138441ef96bb4ea2c1c507d53c1c9f0aeaf3bc9eec429854ba1dfb5978aa1fc734ece01c5d4da39d45cd9dd68a6831a62890ae18

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (C) 2015 Warren Guy <warren@guy.net.au>
+
+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,63 @@
+# ruby-stopforumspam
+
+Ruby wrapper for stopforumspam.com API. Check IP addresses, email addresses,
+and usernames for known spam activity.
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'ruby-stopforumspam'
+```
+
+Then in your project:
+
+```ruby
+require 'stopforumspam'
+
+spam_check = StopForumSpam::Check.new(parameters)
+spam.check.spammer? # returns Boolean
+spam.check.result   # returns Hash
+```
+
+Supply a String to check one IP address, e-mail, or username:
+
+```ruby
+spam_check = StopForumSpam::Check.new('198.51.100.1')
+spam_check.spammer? # is this person a spammer?
+=> false
+spam_check.result   # see full results from API
+=> {"ip"=>{"value"=>"198.51.100.1", "frequency"=>"0", "appears"=>"0"}}
+```
+
+Or supply an Array of Strings:
+
+```ruby
+spam_check = StopForumSpam::Check.new(['198.51.100.1', 'test@example.com'])
+spam_check.spammer?
+=> true
+spam_check.result
+=> {"ip"=>{"value"=>"198.51.100.1", "frequency"=>"0", "appears"=>"0"}, "email"=>{"value"=>"test@example.com", "lastseen"=>"2014-10-06 13:33:08", "frequency"=>"3", "appears"=>"1"}}
+```
+
+Or supply an Array of Hashes to override the check type (e.g. to force a
+username check for a string that looks like an IP address):
+
+```ruby
+spam_check = StopForumSpam::Check.new([{check: '198.51.100.1', type: 'username'}])
+spam_check.spammer?
+=> true
+spam_check.result
+=> {"username"=>{"value"=>"198.51.100.1", "frequency"=>"0", "appears"=>"0"}}
+```
+
+## License
+
+MIT license. See LICENSE.
+
+## Author
+
+Warren Guy <warren@guy.net.au>
+
+https://warrenguy.me

data/lib/stopforumspam.rb

@@ -0,0 +1,58 @@
+require 'ipaddr'
+require 'xmlsimple'
+require 'open-uri'
+
+module StopForumSpam
+  class Check
+    def initialize(checks = [])
+      @checks = parse_checks([*checks])
+    end
+
+    def result
+      @result ||= do_check
+    end
+
+    def spammer?
+      result.map{|type, checks| checks}.flatten.map{|check| check['appears']}.include? '1'
+    end
+
+    private
+
+    def do_check
+      response = XmlSimple.xml_in(
+        open(
+          'http://api.stopforumspam.org/api?' + 
+          @checks.map{|check| "#{check[:type]}[]=#{check[:check]}"}.join('&')
+        ), 
+        { 'ForceArray' => false }
+      )
+
+      raise "Unsuccesful response from API" unless response['success'] && (response.delete('success') == '1')
+
+      return response
+    end
+
+    def parse_checks(checks)
+      return checks.map{|check|
+        case check.class.to_s
+        when 'String'
+          {check: check, type: check_type(check)}
+        when 'Hash'
+          {check: check[:check], type: (check[:type] || check_type(check[:check]))}
+        end
+      }
+    end
+
+    def check_type(check)
+      return 'email' if check =~ /.*@.*/
+
+      begin
+        check_ip = IPAddr.new(check)
+        return 'ip' if check_ip.ipv4? or check_ip.ipv6?
+      rescue IPAddr::InvalidAddressError
+      end
+
+      return 'username'
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: ruby-stopforumspam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Warren Guy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for stopforumspam.com API. Check IP addresses, email addresses,
+  and usernames for known spam activity.
+email: warren@guy.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/stopforumspam.rb
+homepage: https://github.com/warrenguy/ruby-stopforumspam
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for stopforumspam.com API.
+test_files: []