yandex_captcha 0.4.3.4 → 0.4.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be95e31ba3d6a68c33cdfa89570809b3fd91014c
-  data.tar.gz: f1911ec28d4c92681ef7f577796d5c2ecc2a0c66
+  metadata.gz: dec49d32aa312a91762b280c934c38aa8fc44890
+  data.tar.gz: 42b4f188c419dc203b5742e5bbbd0c8d5f0e560f
 SHA512:
-  metadata.gz: aa809606627cf397ab5ebcb9b21ed99c4066612b968d668b120c5753ed7e9e28e69cc0bab09a913db81d2995a73f9c17b8a6128271e552549280329f17908992
-  data.tar.gz: 5737ae2fa966463222ae144b33ae74ca532e8a1982f97335d133efd7ac4ce0c3e2564f3ef205b629fb33205a9cd421bafe5356233bed38040b45d60565f44707
+  metadata.gz: ba4557d65c6bbd374c806e01c846f6ff3c0e4f8e1df1523ced84905d754bb43af1afed921f52e300ca0cc18b3636b0789de68031dd6167d055daad3df0b9cc74
+  data.tar.gz: 0b64cb323d9b11471b83c648b20263159e6436b35911cbce215e3a6fd8995ec16ddb34f755a4946994428336cbaa766878149917c72be7945876cd9a7d0b445a

data/.travis.yml

@@ -1,9 +1,7 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - 2.1.0
   - 2.1.1
 notifications:
   email:

data/README.md

@@ -2,6 +2,8 @@
 
 [![Code Climate](https://codeclimate.com/github/merqlove/yandex-captcha.png)](https://codeclimate.com/github/merqlove/yandex-captcha)
 [![Build Status](https://travis-ci.org/merqlove/yandex-captcha.svg)](https://travis-ci.org/merqlove/yandex-captcha)
+[![Inline docs](http://inch-ci.org/github/merqlove/yandex-captcha.svg)](http://inch-ci.org/github/merqlove/yandex-captcha)
+[![Dependency Status](https://gemnasium.com/merqlove/yandex-captcha.svg)](https://gemnasium.com/merqlove/yandex-captcha)
 
 Ruby wrapper for [Yandex Cleanweb](http://api.yandex.ru/cleanweb/) spam detector.
 
@@ -35,6 +37,17 @@ Tested:
 
 Get the api key: [http://api.yandex.ru/cleanweb/getkey.xml](http://api.yandex.ru/cleanweb/getkey.xml)
 
+### Configuration options
+
+| Name        | Value           |
+| :------------- |:-------------|
+| api_key  | Yandex.CleanWeb API key. (default `nil`) |
+| captcha_type (optional)  | Type of captcha (std,estd,lite,elite,rus,latl,elatl,latu,elatu,latm, elatm). (default `std`) |
+| api_server_url (optional) | Yandex.CleanWeb API server URL. (default `http://cleanweb-api.yandex.ru/1.0`) |
+| skip_verify_env (optional) | Custom error provider for non ajax mode. (default `['test', 'cucumber']`) |
+| handle_timeouts_gracefull (optional) | Graceful error's on timeouts. (default `true`) |
+| current_env (optional) | Current environment (default `ENV['RACK_ENV'] || ENV['RAILS_ENV']`) |
+
 ### Code
 
 ```ruby
@@ -52,10 +65,13 @@ end
 
 ### In Views
 
-#### View Helper Options
+#### `captcha_tag` options
 
-- `ajax` = `true/false`
-- `noscript` = `true/false` Only for non ajax version.
+| Name        | Value           |
+| :------------- |:-------------|
+| :ajax (optional)  | Ajaxify your captcha, don't wait for it on any page. (default `false`) |
+| :noscript (optional)  | Adding <noscript></noscript> wrap around captcha. Works only for non ajax mode. (default `false`) |
+| :error (optional) | Custom error provider for non ajax mode. (default `flash` or `nil`) |
 
 #### Code
 
@@ -75,6 +91,22 @@ or
 
 ### In Controllers
 
+#### `valid_captcha?` options
+
+| Name        | Value           |
+| :------------- |:-------------|
+| :captcha_id  | Yandex.CleanWeb captcha id. (default `nil`) |
+| :value  | User response value. (default `nil`) |
+| :request_id (optional) | Some unique request id (default `nil`) |
+
+#### `get_captcha` options
+
+| Name        | Value           |
+| :------------- |:-------------|
+| :request_id (optional) | Some unique request id (default `nil`) |
+
+#### Example
+
 ```ruby
 # Rails / Sinatra / or if you included helpers
 if valid_captcha?(params[:captcha_response_id], params[:captcha_response_field])
@@ -133,4 +165,4 @@ If you use Yandex Captcha in Rails app, we recommend to set up the api key in `c
 
 ---
 
-Special respect to Evrone which gem `yandex-cleanweb` include most of code in `lib/yandex_captcha/verify.rb` and some examples on this page.
+Special respect to Evrone which gem `yandex-cleanweb` include most of code in `lib/yandex_captcha/verify.rb` and some examples on this page.

data/lib/yandex_captcha.rb

@@ -3,7 +3,6 @@ require 'yandex_captcha/verify'
 require 'yandex_captcha/helpers/base'
 
 module YandexCaptcha
-  module Helpers ; end
   class NoApiKeyException < Exception; end
   class BadResponseException < Exception; end
   class YandexCaptchaError < StandardError; end
@@ -24,6 +23,14 @@ module YandexCaptcha
   def self.configuration
     @configuration ||= Configuration.new
   end
+
+  def self.skip_env
+    if configuration.skip_verify_env.include? configuration.current_env
+      true
+    else
+      false
+    end
+  end
 end
 
 if defined?(Rails)

data/lib/yandex_captcha/configuration.rb

@@ -25,6 +25,10 @@ module YandexCaptcha
   #   YandexCaptcha.configure do |config|
   #     config.api_key  = 'cw.1.1.gsdjdgskjhsdgjkgsdjsdjgkskhsgjkgsjhdkgsdghskd.sdgjhgsdsgdkjgdshkgds'
   #     config.captcha_type  = 'elite'
+  #     config.api_server_url = 'http://cleanweb-api.yandex.ru/1.0'
+  #     config.skip_verify_env = ["test", "cucumber"]
+  #     config.handle_timeouts_gracefull = true'
+  #     config.current_env = "test"
   #   end
   #
   class Configuration
@@ -32,14 +36,16 @@ module YandexCaptcha
                   :api_key,
                   :skip_verify_env,
                   :handle_timeouts_gracefully,
-                  :captcha_type
+                  :captcha_type,
+                  :current_env
 
     def initialize #:nodoc:
-      @api_server_url      = API_URL
-      @captcha_type = CAPTCHA_TYPE
-      @api_key           = ENV['CAPTCHA_KEY']
+      @api_server_url             = API_URL
+      @captcha_type               = CAPTCHA_TYPE
+      @api_key                    = ENV['CAPTCHA_KEY']
       @skip_verify_env            = SKIP_VERIFY_ENV
       @handle_timeouts_gracefully = HANDLE_TIMEOUTS_GRACEFULLY
+      @current_env                = ENV['RACK_ENV'] || ENV['RAILS_ENV']
     end
 
   end

data/lib/yandex_captcha/helpers/rails.rb

@@ -2,16 +2,16 @@ module YandexCaptcha
   module Helpers
     module Rails
       def captcha_tags(options = {})
+        return if YandexCaptcha.skip_env
 
-        error = options[:error] ||= ((defined? flash) ? flash[:captcha_error] : "")
         if options[:ajax]
           render partial: "yandex_captcha/captcha_ajax"
         else
+          error = options[:error] ||= ((defined? flash) ? flash[:yandex_captcha_error] : "")
           captcha = YandexCaptcha::Verify.get_captcha
           render partial: "yandex_captcha/captcha", locals: { captcha: captcha, error: error, noscript: options[:noscript] } if captcha
         end
       end
-
     end
   end
 end

data/lib/yandex_captcha/helpers/sinatra.rb

@@ -2,12 +2,15 @@ module YandexCaptcha
   module Helpers
     module Sinatra
       def captcha_tags(options = {})
+        return if YandexCaptcha.skip_env
+
         template = settings.captcha_ajax_template.to_s.to_sym
         if options[:ajax]
           render(current_engine, template, {layout: false}).to_s.html_safe
         else
+          error = options[:error] ||= ((defined? flash) ? flash[:yandex_captcha_error] : "")
           captcha = YandexCaptcha::Verify.get_captcha
-          render(current_engine, template, {layout: false}, { captcha: captcha, noscript: options[:noscript] }).to_s.html_safe if captcha
+          render(current_engine, template, {layout: false}, { captcha: captcha, error: error, noscript: options[:noscript] }).to_s.html_safe if captcha
         end
       end
 

data/lib/yandex_captcha/verify.rb

@@ -11,15 +11,18 @@ module YandexCaptcha
         doc = Nokogiri::XML(response)
 
         spam_result = doc.xpath('//check-spam-result')
+
+        raise BadResponseException unless spam_result
+
         request_id_tag = spam_result.xpath('id')
         spam_flag_tag = spam_result.xpath('text')
 
         raise BadResponseException if request_id_tag.size.zero?
 
-        request_id = request_id_tag.first
-        spam_flag = spam_flag_tag.first.attributes["spam-flag"]
+        request_id = request_id_tag.first.content
+        spam_flag = spam_flag_tag.first.attributes["spam-flag"].content
 
-        spam_check request_id.content, spam_result, spam_flag.content
+        spam_flag_check request_id, spam_result, spam_flag
       end
 
       def get_captcha(request_id=nil)
@@ -33,6 +36,8 @@ module YandexCaptcha
       end
 
       def valid_captcha?(captcha_id=nil, value=nil, request_id=nil)
+        true if YandexCaptcha.skip_env
+
         response = api_check_captcha(request_id, captcha_id, value)
         doc = Nokogiri::XML(response)
         doc.xpath('//check-captcha-result/ok').any?
@@ -62,7 +67,7 @@ module YandexCaptcha
         uri = URI.parse(get_captcha_url)
         uri.query = URI.encode_www_form(params)
 
-        Net::HTTP.get(uri)
+        request_uri(uri)
       end
 
       def api_check_spam(options)
@@ -78,12 +83,12 @@ module YandexCaptcha
 
         check_spam_url = "#{API_URL}/check-spam"
         uri = URI.parse(check_spam_url)
-        response = Net::HTTP.post_form(uri, cleanweb_options)
+        response = request_uri(uri, cleanweb_options, :post)
         response.body
       end
 
-      def spam_check(request_id, spam_result, spam_flag)
-        return false unless request_id or spam_result or spam_flag
+      def spam_flag_check(request_id, spam_result, spam_flag)
+        return {id: request_id, links: []} unless spam_flag
 
         if spam_flag == 'yes'
           links = spam_result.xpath('links')
@@ -99,6 +104,31 @@ module YandexCaptcha
         end
       end
 
+      def request_uri(uri, options={}, type=:get)
+        begin
+          case type
+            when :post
+              Net::HTTP.post_form(uri, options)
+            else
+              Net::HTTP.get(uri)
+          end
+        rescue Timeout::Error
+          if YandexCaptcha.configuration.handle_timeouts_gracefully
+            if defined?(flash)
+              flash[:captcha_error] = if defined?(I18n)
+                I18n.translate('yandex_captcha.errors.cleanweb_unreachable', {:default => 'Yandex.CleanWeb unreachable.'})
+              else
+                'Yandex.CleanWeb unreachable.'
+              end
+            end
+          else
+            raise YandexCaptchaError, "Yandex.CleanWeb unreachable."
+          end
+        rescue Exception => e
+          raise YandexCaptchaError, e.message, e.backtrace
+        end
+      end
+
       def prepare_api_key
         raise NoApiKeyException if YandexCaptcha.configuration.api_key.nil? || YandexCaptcha.configuration.api_key.empty?
 

data/lib/yandex_captcha/version.rb

@@ -1,3 +1,3 @@
 module YandexCaptcha
-  VERSION = "0.4.3.4"
+  VERSION = "0.4.3.5"
 end

data/test/yandex_captcha_test.rb

@@ -2,6 +2,33 @@
 require "test_helper"
 
 describe YandexCaptcha do
+  context "with test environment" do
+    before do
+      YandexCaptcha.configure do |config|
+        config.current_env = "test"
+      end
+    end
+
+    describe "#skip_env" do
+      it "skipping" do
+        YandexCaptcha.skip_env.must_equal true
+      end
+    end
+  end
+
+  context "with dev environment" do
+    before do
+      YandexCaptcha.configure do |config|
+        config.current_env = "development"
+      end
+    end
+
+    describe "#skip_env" do
+      it "working" do
+        YandexCaptcha.skip_env.must_equal false
+      end
+    end
+  end
 
   context "without api key" do
     before do
@@ -29,7 +56,7 @@ describe YandexCaptcha do
     describe "#valid_captcha?" do
       it "raise an error" do
         -> {
-          YandexCaptcha::Verify.valid_captcha?("anything", "anything", 123)
+          YandexCaptcha::Verify.valid_captcha?("anything", 123, "anything")
         }.must_raise YandexCaptcha::NoApiKeyException
       end
     end
@@ -58,39 +85,38 @@ describe YandexCaptcha do
       end
     end
 
-    describe "#spam?" do
-
-      describe "simple check" do
-        it "works" do
-          YandexCaptcha::Verify.spam?("фраза").must_equal false
-          YandexCaptcha::Verify.spam?("недорого увеличение пениса проститутки").must_equal false
-        end
-      end
-
-      describe "advanced mode" do
-        it "works" do
-          YandexCaptcha::Verify.spam?(body_plain: "my text", ip: "80.80.40.3").must_equal false
-        end
-
-        it "with some html" do
-          result = YandexCaptcha::Verify.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 "#spam?" do
+    #
+    #   describe "simple check" do
+    #     it "works" do
+    #       YandexCaptcha::Verify.spam?("фраза").must_equal false
+    #       YandexCaptcha::Verify.spam?("недорого увеличение пениса проститутки").must_equal false
+    #     end
+    #   end
+    #
+    #   describe "advanced mode" do
+    #     it "works" do
+    #       YandexCaptcha::Verify.spam?(body_plain: "my text", ip: "80.80.40.3").must_equal false
+    #     end
+    #
+    #     it "with some html" do
+    #       result = YandexCaptcha::Verify.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 = YandexCaptcha::Verify.spam?(body_html: "some spam <a href='http://spam.com'>spam link</a>")
-        captcha = YandexCaptcha::Verify.get_captcha(result[:id])
+        captcha = YandexCaptcha::Verify.get_captcha
 
         captcha[:url].wont_be_empty
         captcha[:captcha].wont_be_empty
 
-        valid = YandexCaptcha::Verify.valid_captcha?(result[:id], captcha[:captcha], "1234")
+        valid = YandexCaptcha::Verify.valid_captcha?(captcha[:captcha], "1234")
         valid.must_equal false
       end
     end

data/yandex_captcha.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'nokogiri'
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest", "~> 3.0"
+  gem.add_development_dependency "minitest", "~> 5.0"
   gem.add_development_dependency "minitest-spec-context"
   gem.add_development_dependency "fakeweb"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_captcha
 version: !ruby/object:Gem::Version
-  version: 0.4.3.4
+  version: 0.4.3.5
 platform: ruby
 authors:
 - Alexander Merkulov
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-spec-context
   requirement: !ruby/object:Gem::Requirement