yandex_cleanweb 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+notifications:
+  email:
+    - shatrov@me.com

data/README.md

@@ -1,7 +1,11 @@
 # Yandex Cleanweb
 
+[![Build Status](https://travis-ci.org/evrone/yandex-cleanweb.png?branch=master)](https://travis-ci.org/evrone/yandex-cleanweb)
+
 Ruby wrapper for [Yandex Cleanweb](http://api.yandex.ru/cleanweb/) spam detector.
 
+Unfortunatelly, this gem *is not capable with MRI 1.8.7* because of MRI 1.8.7 doesn't have `URI.encode_www_form` method.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,6 +36,22 @@ YandexCleanweb.spam?(body_html: "some spam <a href='http://spam.com'>spam link</
   => { id: "request id", links: [ ['http://spam.com', true] ] }
 ```
 
+More complex example:
+
+```ruby
+
+user_input = "download free porn <a>...</a>"
+if spam_check = YandexCleanweb.spam?(user_input, ip: current_user.ip)
+  captcha = YandexCleanweb.get_captcha(spam_check[:id])
+
+  # now you can show captcha[:url] to user
+  # but remember to write captcha[:captcha] to session
+
+  # to check is captcha enterred by user is valid:
+  captcha_valid = YandexCleanweb.valid_captcha?(result[:id], captcha[:captcha], user_captcha)
+end
+```
+
 If you use Yandex Cleanweb in Rails app, we recommend to set up the api key in `config/initializers/yandex_cleanweb.rb`
 
 ## Contributing

data/Rakefile

@@ -1 +1,13 @@
+#!/usr/bin/env rake
+
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/yandex_cleanweb/version.rb

@@ -1,3 +1,3 @@
 module YandexCleanweb
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/yandex_cleanweb.rb

@@ -17,15 +17,17 @@ module YandexCleanweb
       request_id_tag = doc.xpath('//check-spam-result/id')
       spam_flag_tag = doc.xpath('//check-spam-result/text')
 
-      request_id = request_id_tag[0]
+      request_id = request_id_tag[0].content
       spam_flag = spam_flag_tag[0].attributes["spam-flag"].content
 
       if spam_flag == 'yes'
-        links = doc.xpath('//check-spam-result/links').map { |el|
-          [attributes["url"], attributes["spam_flag"] == 'yes']
-        }
+        links = doc.xpath('//check-spam-result/links')[0].children
 
-        { id: request_id, links: links }
+        links.map do |el|
+          [el.attributes["url"], el.attributes["spam_flag"] == 'yes']
+        end
+
+        { :id => request_id, :links => links }
       else
         false
       end
@@ -38,10 +40,7 @@ module YandexCleanweb
       url = doc.xpath('//get-captcha-result/url').text
       captcha_id = doc.xpath('//get-captcha-result/captcha').text
 
-      {
-        url: url,
-        captcha: captcha_id
-      }
+      { :url => url, :captcha => captcha_id }
     end
 
     def valid_captcha?(request_id, captcha_id, value)
@@ -55,10 +54,10 @@ module YandexCleanweb
     def api_check_captcha(request_id, captcha_id, value)
       check_captcha_url = "#{API_URL}/check-captcha"
       params = {
-        key: api_key,
-        id: request_id,
-        captcha: captcha_id,
-        value: value
+        :key => api_key,
+        :id => request_id,
+        :captcha => captcha_id,
+        :value => value
       }
 
       uri = URI.parse(check_captcha_url)
@@ -69,7 +68,7 @@ module YandexCleanweb
 
     def api_get_captcha(request_id)
       get_captcha_url = "#{API_URL}/get-captcha"
-      params = {key: api_key, id: request_id}
+      params = { :key => api_key, :id => request_id }
 
       uri = URI.parse(get_captcha_url)
       uri.query = URI.encode_www_form(params)
@@ -77,30 +76,14 @@ module YandexCleanweb
       Net::HTTP.get(uri)
     end
 
-    def api_check_spam(*options)
-      cleanweb_options = {}
-      cleanweb_options["key"] = api_key
+    def api_check_spam(options)
+      cleanweb_options = { :key => api_key }
 
-      if options[0][0].is_a?(String) # fast check
-        cleanweb_options["body-plain"] = options[0][0]
+      if options[0].is_a?(String) # quick check
+        cleanweb_options[:body_plain] = options[0]
       else
-        options = options[0][0]
-
-        cleanweb_options.merge!({
-          "body-plain" => options[:body_plain],
-          "body-html" => options[:body_html],
-          "body-bbcode" => options[:body_bbcode],
-
-          "subject-html" => options[:subject_html],
-          "subject-plain" => options[:subject_plain],
-          "subject-bbcode" => options[:subject_bbcode],
-
-          "ip" => options[:ip],
-          "email" => options[:email],
-          "name" => options[:name],
-          "login" => options[:login],
-          "realname" => options[:realname]
-        })
+        options = options[0]
+        cleanweb_options.merge!(Hash[options.map{ |k,v| [k.to_s.gsub("_","-"), v] }])
       end
 
       check_spam_url = "#{API_URL}/check-spam"

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+ENV["RAILS_ENV"] = "test"
+
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/pride"
+
+require "yandex_cleanweb"

data/test/yandex_cleanweb_test.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require "test_helper"
+
+describe YandexCleanweb do
+  before do
+    YandexCleanweb.api_key = "cw.1.1.20121227T080449Z.51de1ee126e5ced6.f4f417fb55727520d7e39b00cf5393d4b1ca5e78"
+  end
+
+  describe "#spam?" do
+
+    describe "simple check" do
+      it "works" do
+        YandexCleanweb.spam?("фраза").must_equal false
+        YandexCleanweb.spam?("недорого увеличение пениса проститутки").must_equal false
+      end
+    end
+
+    describe "advanced mode" do
+      it "workd" do
+        YandexCleanweb.spam?(:body_plain => "my text", :ip => "80.80.40.3").must_equal false
+      end
+
+      it "for some html" do
+        result = YandexCleanweb.spam?(:body_html => "some spam <a href='http://spam.com'>spam link</a>")
+
+        result[:id].wont_be_empty
+        result[:links].must_be_empty
+      end
+
+    end
+
+  end
+
+  describe "#get_captcha + #valid_captcha?" do
+
+    it "works for not valid captchas" do
+      result = YandexCleanweb.spam?(:body_html => "some spam <a href='http://spam.com'>spam link</a>")
+      captcha = YandexCleanweb.get_captcha(result[:id])
+
+      captcha[:url].wont_be_empty
+      captcha[:captcha].wont_be_empty
+
+      valid = YandexCleanweb.valid_captcha?(result[:id], captcha[:captcha], "1234")
+      valid.must_equal false
+    end
+
+  end
+end

data/yandex_cleanweb.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'nokogiri'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_cleanweb
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Ruby wrapper for Yandex.Cleanweb
 email:
 - shatrov@me.com
@@ -35,12 +67,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yandex_cleanweb.rb
 - lib/yandex_cleanweb/version.rb
+- test/test_helper.rb
+- test/yandex_cleanweb_test.rb
 - yandex_cleanweb.gemspec
 homepage: ''
 licenses: []
@@ -66,4 +101,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for Yandex.Cleanweb spam detector
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/yandex_cleanweb_test.rb