cleanweb 0.0.1 → 0.0.2

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 /.ruby-version
 /.ruby-gemset
+/Guardfile

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+# script: rspec spec

data/README.md

@@ -1,6 +1,9 @@
 # Cleanweb
 
-TODO: Write a gem description
+[![Build Status](https://travis-ci.org/arrowcircle/cleanweb.png?branch=master)](https://travis-ci.org/arrowcircle/cleanweb)
+[![Code Climate](https://codeclimate.com/github/arrowcircle/cleanweb.png)](https://codeclimate.com/github/arrowcircle/cleanweb)
+
+Cleanweb is Ruby gem Yandex Cleanweb service.
 
 ## Installation
 
@@ -8,17 +11,29 @@ Add this line to your application's Gemfile:
 
     gem 'cleanweb'
 
-And then execute:
+Get key here:
 
-    $ bundle
+    http://api.yandex.ru/key/form.xml?service=cw
 
-Or install it yourself as:
+Set key to Cleanweb class:
 
-    $ gem install cleanweb
+    Cleanweb.api_key = "YOUR KEY HERE"
 
 ## Usage
 
-TODO: Write usage instructions here
+To check if content spam or not, create a cleanweb instance and check it for spam:
+
+    cw = Cleanweb.new({:subject = > "My Test Subject", :body => "My Test Body"})
+    cw.spam?
+    => false
+
+You can add more info to initial params. Here is the list:
+
+* `ip` - user IP address,
+* `email` - user email,
+* `name` - user footer signature,
+* `login` - user login,
+* `realname` - user real name
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+task :default => [:spec]
+desc 'run Rspec specs'
+task :spec do
+  sh 'rspec spec'
+end

data/cleanweb.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cleanweb/version'
+require 'cleanweb'
 
 Gem::Specification.new do |spec|
   spec.name          = "cleanweb"
-  spec.version       = Cleanweb::VERSION
+  spec.version       = Cleanweb::Version::VERSION
   spec.authors       = ["Oleg Bovykin"]
   spec.email         = ["oleg.bovykin@gmail.com"]
   spec.description   = %q{Gem for Yandex Cleanweb intergation}
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
 end

data/lib/cleanweb.rb

@@ -1,5 +1,54 @@
-require "cleanweb/version"
+# coding: utf-8
+
+require 'net/http'
+require 'rexml/document'
+require 'open-uri'
+
+class Cleanweb
+  require 'cleanweb/version'
+  require 'cleanweb/spam'
+
+  include Version
+  include Spam
+
+  class KeyError < StandardError; end
+  class NoSubjectError < StandardError; end
+  class NoBodyError < StandardError; end
+
+  SPAM_URL = "http://cleanweb-api.yandex.ru/1.0/check-spam"
+
+  class << self
+    attr_accessor 'api_key'
+  end
+  @@api_key = nil
+
+  def self.api_key= key
+    @@api_key = key
+  end
+
+  def initialize params
+    check_key
+    @params = params
+    check_params
+  end
+
+  def check_key
+    raise KeyError if @@api_key.nil?
+  end
+
+  def check_params
+    check_subject
+    check_body
+  end
+
+  def check_subject
+    @subject = @params[:subject]
+    raise NoSubjectError if @subject.nil?
+  end
+
+  def check_body
+    @body = @params[:body]
+    raise NoBodyError if @body.nil?
+  end
 
-module Cleanweb
-  # Your code goes here...
 end

data/lib/cleanweb/spam.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+module Cleanweb::Spam
+  def parse_xml
+    xml = REXML::Document.new(ask_yandex)
+    res = []
+    begin
+      xml.root.elements.each("text") {|e| res << e.attributes["spam-flag"]}
+      xml.root.elements.each("links") do |links|
+        links.elements.each("link") {|e| res << e.attributes["spam-flag"]}
+      end
+    rescue
+    end
+    res.uniq
+  end
+
+  def spam?
+    results = parse_xml
+    if results == ["no"] && !results.empty?
+      false
+    else
+      true
+    end
+  end
+
+  def spam_params
+    res = {key: @@api_key}
+    @params.slice([:ip, :email, :name, :login, :realname]).each do |k, v|
+      res.merge!(k: v) if @params[k].present?
+    end
+    res["subject-plain"] = @subject
+    res["body-plain"] = @body
+    res
+  end
+
+  def ask_yandex
+    uri = URI.parse(SPAM_URL)
+    Net::HTTP.post_form(uri, spam_params).body
+  end
+end

data/lib/cleanweb/version.rb

@@ -1,3 +1,5 @@
-module Cleanweb
-  VERSION = "0.0.1"
-end
+# coding: utf-8
+
+module Cleanweb::Version
+  VERSION = "0.0.2"
+end

data/spec/mocks/body.xml

@@ -0,0 +1,8 @@
+<check-spam-result>
+    <id>123456789abcd</id>
+    <text spam-flag="yes" />
+    <links>
+        <link href="http://some-url.ru" spam-flag="no" />
+        <link href="http://some-url.ru" spam-flag="no" />
+    </links>
+</check-spam-result>

data/spec/mocks/links.xml

@@ -0,0 +1,8 @@
+<check-spam-result>
+    <id>123456789abcd</id>
+    <text spam-flag="no" />
+    <links>
+        <link href="http://some-url.ru" spam-flag="yes" />
+        <link href="http://some-url.ru" spam-flag="no" />
+    </links>
+</check-spam-result>

data/spec/mocks/no_links.xml

@@ -0,0 +1,6 @@
+<check-spam-result>
+    <id>123456789abcd</id>
+    <text spam-flag="no" />
+    <links>
+    </links>
+</check-spam-result>

data/spec/mocks/no_links_body.xml

@@ -0,0 +1,6 @@
+<check-spam-result>
+    <id>123456789abcd</id>
+    <text spam-flag="yes" />
+    <links>
+    </links>
+</check-spam-result>

data/spec/mocks/ok.xml

@@ -0,0 +1,8 @@
+<check-spam-result>
+    <id>123456789abcd</id>
+    <text spam-flag="no" />
+    <links>
+        <link href="http://some-url.ru" spam-flag="no" />
+        <link href="http://some-url.ru" spam-flag="no" />
+    </links>
+</check-spam-result>

data/spec/models/cleanweb_spec.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Cleanweb do
+  context "initialize" do
+    let(:cleanweb_no_key) { Cleanweb.api_key = nil; Cleanweb.new "text"}
+    let(:cleanweb_no_subject) { Cleanweb.new no_subject}
+    let(:cleanweb_no_body) { Cleanweb.new no_body}
+
+    let(:no_subject) { {subject: nil, body: "body"} }
+    let(:no_body) { {subject: "subject", body: nil} }
+
+    it "проверяет наличие ключа" do
+      lambda { cleanweb_no_key }.should raise_error(Cleanweb::KeyError)
+      Cleanweb.api_key = "123"
+    end
+
+    it "проверяет и задает входные параметры" do
+      lambda { cleanweb_no_subject }.should raise_error(Cleanweb::NoSubjectError)
+      lambda { cleanweb_no_body }.should raise_error(Cleanweb::NoBodyError)
+    end
+  end
+end

data/spec/models/spam_spec.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Cleanweb::Spam do
+  context "spam?" do
+    let(:params) { {subject: "subject", body: "body"} }
+    let(:cleanweb) { Cleanweb.new params }
+    let(:ok_response) { File.read(File.join("spec", "mocks", "ok.xml")) }
+    let(:links_response) { File.read(File.join("spec", "mocks", "links.xml")) }
+    let(:no_links_response) { File.read(File.join("spec", "mocks", "no_links.xml")) }
+    let(:no_links_body_response) { File.read(File.join("spec", "mocks", "no_links_body.xml")) }
+    let(:body_response) { File.read(File.join("spec", "mocks", "body.xml")) }
+
+    it "возвращает false если контент не спам" do
+      cleanweb.should_receive(:ask_yandex).and_return(ok_response)
+      expect(cleanweb.spam?).to eq false
+    end
+
+    it "возвращает true если контент спам, а ссылки ок" do
+      cleanweb.should_receive(:ask_yandex).and_return(body_response)
+      expect(cleanweb.spam?).to eq true
+    end
+
+    it "возвращает true если контент ок, а ссылки спам" do
+      cleanweb.should_receive(:ask_yandex).and_return(links_response)
+      expect(cleanweb.spam?).to eq true
+    end
+
+    it "возвращает false если контент ок, а ссылкок нет" do
+      cleanweb.should_receive(:ask_yandex).and_return(no_links_response)
+      expect(cleanweb.spam?).to eq false
+    end
+
+    it "возвращает true если контент спам, а ссылкок нет" do
+      cleanweb.should_receive(:ask_yandex).and_return(no_links_body_response)
+      expect(cleanweb.spam?).to eq true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'cleanweb'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cleanweb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-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'
 description: Gem for Yandex Cleanweb intergation
 email:
 - oleg.bovykin@gmail.com
@@ -67,13 +83,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - cleanweb.gemspec
 - lib/cleanweb.rb
+- lib/cleanweb/spam.rb
 - lib/cleanweb/version.rb
+- spec/mocks/body.xml
+- spec/mocks/links.xml
+- spec/mocks/no_links.xml
+- spec/mocks/no_links_body.xml
+- spec/mocks/ok.xml
+- spec/models/cleanweb_spec.rb
+- spec/models/spam_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/arrowcircle/cleanweb
 licenses:
 - MIT
@@ -99,4 +126,12 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Yandex Cleanweb
-test_files: []
+test_files:
+- spec/mocks/body.xml
+- spec/mocks/links.xml
+- spec/mocks/no_links.xml
+- spec/mocks/no_links_body.xml
+- spec/mocks/ok.xml
+- spec/models/cleanweb_spec.rb
+- spec/models/spam_spec.rb
+- spec/spec_helper.rb