botscout 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--backtrace
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7

data/README.md

@@ -1,6 +1,5 @@
-# Botscout
+# Botscout [![Build Status](https://travis-ci.org/parallel588/botscout.png?branch=master)](https://travis-ci.org/parallel588/botscout)
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -18,7 +17,14 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    botscout = Botscout::Client.new("key")
+    result = botscout.test mail: email
+    if result.success?
+        Logger.info "Email address is spam: #{email}" if result.bot?
+    else
+        Logger.info "Servis is not available: #{result.error}"
+    end
+
 
 ## Contributing
 

data/Rakefile

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

data/botscout.gemspec

@@ -19,5 +19,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.13.0'
+  spec.add_development_dependency "vcr", "~> 2.4.0"
+  spec.add_development_dependency "webmock", "~> 1.11.0"
+
   spec.add_dependency "httparty", "~> 0.11.0"
 end

data/lib/botscout.rb

@@ -1,4 +1,5 @@
 require "botscout/version"
+require  'httparty'
 
 module Botscout
   class Client
@@ -12,20 +13,38 @@ module Botscout
     end
 
     def test(options ={})
-      _options = (@key.present? ? { :key => @key } : {}).merge(options)
-      @response = self.class.get('/test', :query => _options)
+      _options = ((@key.nil? || @key.empty?)  ? {} : { :key => @key } ).merge(options)
+      @response = self.class.get('/test/', :query => _options)
 
       Result.new(@response.body)
     end
 
     class Result
-      attr_accessor :response, :result, :matched
+      attr_reader :response, :result, :matched
 
-      def initialize(xml_response = "")
-        @response = xml_response
+      def initialize(response = "")
+        @response = response.to_s
         parse!
       end
 
+      def bot?
+        @result.to_s == "Y"
+      end
+
+      def success?
+        !has_error?
+      end
+
+      def error
+        @response.match(/\A!(.*)/) && $1
+      end
+
+      def has_error?
+        !!@response.match(/\A!/)
+      end
+
+      private
+
       def parse!
         if has_error?
           @result = nil
@@ -45,23 +64,7 @@ module Botscout
         self
       end
 
-      def bot?
-        @result.to_s == "Y"
-      end
 
-      def success?
-        !has_error?
-      end
-
-      def error
-        @response.match(/\A!(.*)/) && $1
-      end
-
-      def has_error?
-        !!@response.match(/\A!/)
-      end
-
-      private
       def parse_standart(response_array)
         {
           :count => response_array[2].to_i,

data/lib/botscout/version.rb

@@ -1,3 +1,3 @@
 module Botscout
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/boutscout_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe Botscout::Client do
+  describe "#test" do
+    it "should return Botscout::Client::Result" do
+      VCR.use_cassette("test-spam-req") do
+        @client = Botscout::Client.new
+        @result = @client.test(:mail => "krasnhello@mail.ru")
+        expect(@result.is_a?(Botscout::Client::Result)).to be_true
+      end
+
+    end
+  end
+  describe "Result" do
+
+    describe "#bot?" do
+      context "when data is matched" do
+        it "should be true" do
+          VCR.use_cassette("test-spam-req") do
+            @client = Botscout::Client.new
+            @result = @client.test(:mail => "krasnhello@mail.ru")
+            expect(@result.bot?).to be_true
+          end
+        end
+      end
+      context "when data is not matched" do
+        it "should be false" do
+          VCR.use_cassette("test-not-pam-req") do
+            @client = Botscout::Client.new
+            @result = @client.test(:mail => "promotion@aliexpress.com")
+            expect(@result.bot?).to be_false
+          end
+        end
+      end
+
+    end
+
+    context "when response is has error" do
+      before{
+        VCR.use_cassette("test-error-req") do
+          @client = Botscout::Client.new
+          @result = @client.test(:mail => "promotion@aliexpress.com")
+
+        end
+      }
+
+      it "#error should return the error message" do
+        expect(@result.error).to eq(" Sorry, but that doesn't appear to be a valid API key.")
+      end
+      it "#has_error? should return true" do
+        expect(@result.has_error?).to be_true
+      end
+      it "#success? should return false" do
+        expect(@result.success?).to be_false
+      end
+    end
+
+    context "when response is has not error" do
+      before{
+        VCR.use_cassette("test-spam-req") do
+          @client = Botscout::Client.new
+          @result = @client.test(:mail => "krasnhello@mail.ru")
+        end
+      }
+
+      it "#error should return nil" do
+        expect(@result.error).to be_nil
+      end
+      it "#has_error? should return false" do
+        expect(@result.has_error?).to be_false
+      end
+      it "#success? should return true" do
+        expect(@result.success?).to be_true
+      end
+    end
+
+  end
+end

data/spec/cassettes/test-error-req.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://botscout.com/test/?mail=promotion@aliexpress.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 08 Jun 2013 18:51:22 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - PHP/5.3.10-1~dotdeb.1
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - text/html
+    body:
+      encoding: UTF-8
+      string: "! Sorry, but that doesn't appear to be a valid API key."
+    http_version: 
+  recorded_at: Sat, 08 Jun 2013 18:51:21 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/test-not-pam-req.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://botscout.com/test/?mail=promotion@aliexpress.com
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 08 Jun 2013 18:50:02 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - PHP/5.3.10-1~dotdeb.1
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - text/html
+    body:
+      encoding: UTF-8
+      string: N|MAIL|0
+    http_version: 
+  recorded_at: Sat, 08 Jun 2013 18:50:01 GMT
+recorded_with: VCR 2.4.0

data/spec/cassettes/test-spam-req.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://botscout.com/test/?mail=krasnhello@mail.ru
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sat, 08 Jun 2013 18:48:28 GMT
+      Server:
+      - Apache/2.2.16 (Debian)
+      X-Powered-By:
+      - PHP/5.3.10-1~dotdeb.1
+      Vary:
+      - Accept-Encoding
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - text/html
+    body:
+      encoding: UTF-8
+      string: Y|MAIL|0
+    http_version: 
+  recorded_at: Sat, 08 Jun 2013 18:48:27 GMT
+recorded_with: VCR 2.4.0

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+require 'webmock/rspec'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir     = 'spec/cassettes'
+  c.hook_into                :webmock
+  c.default_cassette_options = { :record => :once }
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,65 +1,129 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: botscout
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
-authors:
+authors: 
 - Maxim Pechnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-06-14 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 2
+        - 13
+        - 0
+        version: 2.13.0
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: vcr
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.11.0
-  type: :runtime
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 1
+        - 11
+        - 0
+        version: 1.11.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 11
+        - 0
         version: 0.11.0
+  type: :runtime
+  version_requirements: *id006
 description: BotScout
-email:
+email: 
 - parallel588@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -67,27 +131,48 @@ files:
 - botscout.gemspec
 - lib/botscout.rb
 - lib/botscout/version.rb
+- spec/boutscout_spec.rb
+- spec/cassettes/test-error-req.yml
+- spec/cassettes/test-not-pam-req.yml
+- spec/cassettes/test-spam-req.yml
+- spec/spec_helper.rb
+has_rdoc: true
 homepage: http://botscout.com/
 licenses: []
-metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 1.6.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby bindings for the botscout.com API
-test_files: []
+test_files: 
+- spec/boutscout_spec.rb
+- spec/cassettes/test-error-req.yml
+- spec/cassettes/test-not-pam-req.yml
+- spec/cassettes/test-spam-req.yml
+- spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 5315f17aa32c90d89fb237b492e17a072d89d0a1
-  data.tar.gz: b3672a5b70eee46b683c11d2010b95171e3310ab
-SHA512:
-  metadata.gz: 0823893f9e1c48e15e14b182278443191f380d0861af1bd3fb28f13717713cdf2e173e68c4a2a0c6fe3f69a637a31f4d92bfcf7cc9d6a91e8b4ea575573e5665
-  data.tar.gz: d7966e10defcf31b5a04e1a4f1555a6e2355e5e1d4a67bfc8b1159a9bf66f84d6964d6b9482641b5d8cc5059d10889c21d20a072fd2e5719d0904422e806647c