yinxiangma 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG

@@ -0,0 +1,11 @@
+== 0.0.3 / 2012-01-04
+
+* Added Basic Validation
+
+== 0.0.2 / 2012-01-04
+
+* Added tests & error handles
+
+== 0.0.1 / 2012-01-03
+
+* Just display

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in yinxiangma.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,113 @@
+= YinXiangMa CAPTCHA
+
+Author::    SouthWolf
+Copyright:: Copyright (c) 2011 SouthWolf, Yinxiangma Inc.
+License::   {MIT}[http://creativecommons.org/licenses/MIT/]
+Info::      http://github.com/southwolf/yinxiangma
+Git::       http://github.com/southwolf/yinxiangma/tree/master
+Bugs::      http://github.com/southwolf/yinxiangma/issues
+
+This plugin adds helpers for the {YinXiangMa CAPTCHA API}[http://www.yinxiangma.com]. In your
+views you can use the +yinxiangma_tags+ method to embed the needed javascript,
+and you can validate in your controllers with +yinxiangma_valid+.
+
+Beforehand you need to configure YinXiangMa with your custom publisher
+key. You may find detailed examples below. Exceptions will be raised if you
+call these methods and the keys can't be found.
+
+== About this gem
+
+This gem tries to introduces a more convenient way to configure YinXiangMa's
+settings. The structure & style are inspired by {reCAPTCHA gem}[http://ambethia.com/recaptcha] 
+
+== Rails Installation
+
+YinXiangMa for Rails, add this to your Gemfile:
+
+  gem "yinxiangma", :require => "yinxiangma/rails"
+
+Or, it can be installed as a gem:
+
+  config.gem "yinxiangma", :lib => "yinxiangma/rails"
+
+Or, as a standard rails plugin:
+
+  script/plugin install git://github.com/southwolf/yinxiangma.git
+
+== Setting up your API Keys
+
+There are multiple ways to setup your YinXiangMa API key once you
+{obtain}[http://www.yinxiangma.com] one.
+
+=== YinXiangMa.configure
+
+You may use the block style configuration. The following code could be placed
+into a +config/initializers/yinxiangma.rb+ when used in a Rails project.
+
+  Yinxiangma.configure do |config|
+    config.publisher_key  = 'cb9d0fe8dabdea89019d845be3059973'
+    config.mode ='live'
+  end
+  
+
+This way, you may also set additional options to fit YinXiangMa into your
+deployment environment.
+
+=== Shell environment
+
+Or, you can keep your keys out of your code base by exporting the following
+environment variables. You might do this in the .profile/rc, or equivalent for
+the user running your application:
+
+  export YINXIANGMA_PUBLISHER_KEY  = 'cb9d0fe8dabdea89019d845be3059973'
+
+=== Per call
+
+You can also pass in your keys as options at runtime, for example:
+
+  yinxiangma_tags :publisher_key  => 'cb9d0fe8dabdea89019d845be3059973'
+
+This option might be useful, if the same code base is used for multiple
+YinXiangMa setups.
+
+== To use 'YinXiangMa'
+
+Add +yinxiangma_tags+ to each form you want to protect.
+
+And, add +yinxiangma_valid+ logic to each form action that you've protected.
+
+=== +yinxiangma_tags+
+
+This method generate HTML tag including YinXiangMa widget.
+
+=== +yinxiangma_valid+
+
+This method returns +true+ or +false+ after processing the parameters from the YinXiangMa widget. 
+
+== TODO
+
+* Validation Error handlings
+* Better documentation
+* Switch back to local CAPTCHA or reCAPTHA when YinXiangMa is unavailable
+
+= 印象码 动态验证码
+
+{印象码}[http://www.yinxiangma.com]是目前中国国内推出的第一款视频广告验证码云服务平台，不仅提供了安全的基于云计算的视频验证码服务，为网站提供了良好的验证码用户体验，并且提出了新一代的基于用户反馈的广告计费商业模式概念。
+
+本gem提供了Rails下的印象码功能，配置简单。
+
+首先请注册{印象码}[http://www.yinxiangma.com]服务，获取API key
+建立+config/initializers/yinxiangma.rb+ 内容如下(请将publisher_key替换成您的key)
+
+  Yinxiangma.configure do |config|
+    config.publisher_key  = 'cb9d0fe8dabdea89019d845be3059973'
+    config.mode ='live'
+  end
+
+
+在Gemfile添加
+  gem "yinxiangma", :require => "yinxiangma/rails"
+  
+建立
+
+在View中插入<%= yinxiangma_tags %>， 在View中需要进行验证处插入yinxiangma_valid() 即可

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new :test do |test|
+  test.libs << "lib"
+  test.pattern = "test/*_test.rb"
+end
+
+task :default => :test

data/lib/yinxiangma.rb

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+require "yinxiangma/configuration"
+require "yinxiangma/client_helper"
+require "yinxiangma/valid"
+
+module Yinxiangma
+  
+  
+  YINXIANGMA_API_SERVER_URL = 'http://www.yinxiangma.com/api/'
+  YINXIANGMA_REGISTER_URL   = 'http://www.yinxiangma.com/server/register.php'
+  YINXIANGMA_TOKEN_URL      = 'yzm.token.php'
+  YINXIANGMA_VALID_URL      = 'yzm.valid.php'  
+  YINXIANGMA_DISPLAY_MODE   = 'live'
+  YINXIANGMA_PUBLISHER_KEY  = 'cb9d0fe8dabdea89019d845be3059973'
+  
+  SKIP_VALID_ENV = 'test'
+  
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  
+  def self.configure
+    config = configuration
+    yield(config)
+  end
+    
+  class YinxiangmaError < StandardError
+  end
+end
+
+if defined?(Rails)
+  require "yinxiangma/rails"
+end

data/lib/yinxiangma/client_helper.rb

@@ -0,0 +1,65 @@
+# -*- encoding : utf-8 -*-
+module Yinxiangma
+  module ClientHelper
+    def yinxiangma_tags(options = {})
+      html  = ""      
+      api_server_url   = Yinxiangma.configuration.api_server_url
+      reg_url = Yinxiangma.configuration.reg_url
+      key   = options[:publisher_key] ||= Yinxiangma.configuration.publisher_key
+      raise YinxiangmaError, "No publisher key specified." unless key
+      error = options[:error] ||= (defined? flash ? flash[:yinxiangma_error] : "")
+      token = request_token(key)
+      if(token[0] != 'false')
+        html << <<-EOS
+          <script type='text/javascript'>
+            var YinXiangMaDataString ='#{token[0]}';
+          </script>
+          <script type='text/javascript' 
+            src='http://www.yinxiangma.com/widget/YinXiangMa.php' charset='utf-8'>
+          </script>
+        EOS
+      elsif(token[1] == 'null key')
+        html << <<-EOS
+          为了使用<strong>印象码</strong>视频验证码广告系统， 你必须注册并拥有一个 KEY. <br /><a href='#{reg_url}'>点击注册</a>
+        EOS
+      elsif(token[1] == 'key_invalid')
+        html << <<-EOS
+          您的<strong>印象码</strong>插件配置有误，请检查您的配置文件！
+        EOS
+      end
+            
+      return (html.respond_to?(:html_safe) && html.html_safe) || html
+    end
+    
+    def request_token(publisher_key)
+      token_uri = Yinxiangma.configuration.api_server_url + Yinxiangma.configuration.token_url
+    
+      #TODO Resolve Rails depedency for request.env
+
+      # userAgent = request.env["HTTP_USER_AGENT"] ||= "unknown"
+      # ip = request.env["HTTP_REMOTE_ADDR"] ||= "127.0.0.1"
+      # page = request.env["HTTP_REQUEST_URI"] ||= "Ruby Hosts"
+      
+      userAgent = "unknown"
+      ip = "127.0.0.1"
+      page = "Ruby Hosts"
+      
+      cookie = "YinXiangMa_Cookies"
+      version = "YinXiangMa_Ruby_v0.1"
+      mode = "live"
+    
+    
+      yxm = Net::HTTP.post_form(URI.parse(token_uri), {
+        "s" => publisher_key,
+        "u" => userAgent,
+        "i" => ip,
+        "p" => page,
+        "o" => cookie,
+        "v" => version,
+        "m" => mode
+        }).body.split('+')
+    
+      return yxm
+    end
+  end
+end

data/lib/yinxiangma/configuration.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Yinxiangma
+  class Configuration
+    attr_accessor :api_server_url,
+                  :token_url,
+                  :valid_url,
+                  :reg_url,
+                  :skip_valid_env,
+                  :publisher_key,
+                  :mode
+    
+    def initialize
+      @api_server_url = YINXIANGMA_API_SERVER_URL
+      @token_url      = YINXIANGMA_TOKEN_URL
+      @valid_url      = YINXIANGMA_VALID_URL
+      @skip_valid_env = SKIP_VALID_ENV
+      @reg_url        = YINXIANGMA_REGISTER_URL
+
+      @publisher_key  = ENV['YINXIANGMA_PUBLISHER_KEY']
+      @mode           = ENV['YINXIANGMA_DISPLAY_MODE'] ||= YINXIANGMA_DISPLAY_MODE
+    end
+    
+  end
+end

data/lib/yinxiangma/rails.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'net/http'
+require 'yinxiangma'
+
+ActionView::Base.send(:include, Yinxiangma::ClientHelper)
+ActionController::Base.send(:include, Yinxiangma::Valid)

data/lib/yinxiangma/valid.rb

@@ -0,0 +1,20 @@
+# -*- encoding : utf-8 -*-
+module Yinxiangma
+  module Valid
+    def yinxiangma_valid
+      valid_uri = "http://www.yinxiangma.com/api/yzm.valid.php"
+      http = Net::HTTP
+      answer, error = http.post_form(URI.parse(valid_uri), {
+        "s" => "cb9d0fe8dabdea89019d845be3059973",
+        "t" => params[:YinXiangMa_challenge],
+        "i" => params[:YinXiangMa_response]
+        }).body.split('+')
+    
+      if(answer == 'true')
+        return true
+      elsif(answer == 'false')
+        return false
+      end
+    end
+  end
+end

data/lib/yinxiangma/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module Yinxiangma
+  VERSION = '0.0.3'
+end

data/test/yinxiangma_test.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+require 'test/unit'
+require 'net/http'
+
+require File.dirname(File.expand_path(__FILE__)) + '/../lib/yinxiangma'
+
+class YinxiangmaClientHelperTest < Test::Unit::TestCase
+  include Yinxiangma
+  include Yinxiangma::ClientHelper
+  
+  def setup
+    Yinxiangma.configure do |config|
+      config.publisher_key = 'cb9d0fe8dabdea89019d845be3059973'
+    end
+  end
+    
+  # def test_yinxiangma_request_token_with_null_key
+  #   assert_match /null key/, request_token('')[1]
+  # end
+  # 
+  # def test_yinxiangma_request_token_with_invalid_key
+  #   assert_match /key_invalid/, request_token('123456')[1]
+  # end
+  # 
+  # def test_yinxiangma_request_token_with_valid_key
+  #   assert_match /^\{\"token\":\"[0-9a-f]{32}\"/, request_token('cb9d0fe8dabdea89019d845be3059973')[0]
+  # end
+  
+  def test_yinxiangma_tags_with_null_key
+    assert_raise YinxiangmaError do
+      Yinxiangma.configuration.publisher_key = nil      
+      assert_match /你必须注册并拥有一个 KEY/, yinxiangma_tags()
+    end
+  end
+  
+  def test_yinxiangma_tags_with_invalid_key
+    Yinxiangma.configuration.publisher_key = '123456'      
+    assert_match /请检查您的配置文件/, yinxiangma_tags()
+  end
+  
+  def test_yinxiangma_tags_with_default_key
+    assert_match /var YinXiangMaDataString ='{\"token\":\"[0-9a-f]{32}\"/, yinxiangma_tags()
+  end
+end

data/yinxiangma.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yinxiangma/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["SouthWolf"]
+  gem.email         = ["wp.southwolf@gmail.com"]
+  gem.summary       = %q{Helpers for the YinXiangMa CAPTCHA API}
+  gem.description   = %q{This plugin adds helpers for the YinXiangMa CAPTCHA API}
+  gem.homepage      = "http://www.yinxiangma.com"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "yinxiangma"
+  gem.require_paths = ["lib"]
+  gem.version       = Yinxiangma::VERSION
+  
+  gem.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: yinxiangma
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- SouthWolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70132404212460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70132404212460
+description: This plugin adds helpers for the YinXiangMa CAPTCHA API
+email:
+- wp.southwolf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/yinxiangma.rb
+- lib/yinxiangma/client_helper.rb
+- lib/yinxiangma/configuration.rb
+- lib/yinxiangma/rails.rb
+- lib/yinxiangma/valid.rb
+- lib/yinxiangma/version.rb
+- test/yinxiangma_test.rb
+- yinxiangma.gemspec
+homepage: http://www.yinxiangma.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -307653484978211841
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -307653484978211841
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Helpers for the YinXiangMa CAPTCHA API
+test_files:
+- test/yinxiangma_test.rb