keypic 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar 
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keypic.gemspec
+gemspec
+
+gem "rspec", "~> 2.13.0"
+gem "fuubar"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fodojo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Keypic
+
+It just client fot Keypic API http://ws.keypic.com/?op=help
+How does it work? More info here: http://keypic.com/?tid=homepage_how_does_it_work
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'keypic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keypic
+
+## Configuration
+
+    Keypic.configure do |config|
+      config.endpoint = "http://ws.keypic.com"
+      config.form_id = "secret_token_here"
+    end
+
+## Usage
+
+    @keypic = Keypic::Proxy.new(env)
+    
+    @keypic.token
+
+    @keypic.valid?({email: "", message: "", name: ""})
+
+You can provide a numeric value (%):
+
+    @keypic.spam?({email: "", message: "", name: ""}, 90)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Copyright (c) 2013 Fodojo, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/keypic.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keypic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keypic"
+  spec.version       = Keypic::VERSION
+  spec.authors       = ["Igor Galeta"]
+  spec.email         = ["galeta.igor@gmail.com"]
+  spec.description   = %q{Client for Keypic Web Service API}
+  spec.summary       = %q{Keypic is a Web Service for avoid the use of CAPTCHAs}
+  spec.homepage      = "http://keypic.com/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httpi"
+  spec.add_dependency "multi_json"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/keypic.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require "keypic/version"
+require "keypic/config"
+require "keypic/client"
+require "keypic/proxy"
+
+module Keypic
+
+  def self.configuration
+    @configuration ||= Keypic::Config.new
+  end
+
+  def self.configure
+    block_given? ? yield(configuration) : configuration
+  end
+end

data/lib/keypic/client.rb

@@ -0,0 +1,63 @@
+require "httpi"
+require "multi_json"
+
+module Keypic
+  class Client
+    attr_reader :last_response, :parsed_response
+
+    @@methods = {
+      :new_token => "RequestNewToken",
+      :validate => "RequestValidation",
+      :spam => "ReportSpam",
+      :check_form => "checkFormID"
+    }.freeze
+
+    @@types = {
+      :csv => 1,
+      :json => 2,
+      :php => 3,
+      :xml => 4
+    }.freeze
+
+    def initialize(method_name, options = {})
+      @method_name = method_name.to_sym
+
+      @options = {
+        "FormID" => Keypic.configuration.form_id,
+        "ResponseType" => format,
+        "RequestType" => method
+      }.merge(options)
+    end
+
+    def method
+      @method ||= @@methods[@method_name]
+    end
+
+    def format
+      @format ||= @@types[Keypic.configuration.format.to_sym]
+    end
+
+    def invoke(options = {})
+      request.body = @options.merge(options)
+      parse_response(HTTPI.post(request))
+    end
+
+    def request
+      @request ||= ::HTTPI::Request.new(:url => Keypic.configuration.endpoint)
+    end
+
+    protected
+
+      def parse_response(response)
+        @last_response = response
+
+        if response.error?
+          @parsed_response = nil
+        else
+          @parsed_response = ::MultiJson.load(response.body)
+        end
+
+        @parsed_response
+      end
+  end
+end

data/lib/keypic/config.rb

@@ -0,0 +1,12 @@
+module Keypic
+  class Config
+    attr_accessor :endpoint, :form_id, :format, :quantity
+
+    def initialize
+      @endpoint = "http://ws.keypic.com"
+      @form_id = "secret_token_here"
+      @format = :json
+      @quantity = 1
+    end
+  end
+end

data/lib/keypic/proxy.rb

@@ -0,0 +1,91 @@
+module Keypic
+  class Proxy
+    attr_reader :env
+
+    def initialize(env)
+      @env = env
+    end
+
+    def token
+      @token ||= (fetch_token_from_session || fetch_token_form_server)
+    end
+
+    def valid?(options = {}, rank = 80)
+      fetch_rank(options) >= rank.to_f
+    end
+
+    def spam?(options = {}, rank = 80)
+      !valid?(options, rank)
+    end
+
+    def fetch_rank(options = {})
+      params = normalize_message(options)
+      params = { 'Token' => token }.merge(client_params).merge(params)
+
+      body = Keypic::Client.new(:validate).invoke(params)
+
+      if body && body["status"] == 'response'
+        body["spam"].to_f
+      else
+        0.0
+      end
+    end
+
+    def client_params
+      {
+        'ServerName' => env['SERVER_NAME'],
+        'ClientIP' => env['REMOTE_ADDR'],
+        'ClientUserAgent' => env['HTTP_USER_AGENT'],
+        'ClientAccept' => env['HTTP_ACCEPT'],
+        'ClientAcceptEncoding' => env['HTTP_ACCEPT_ENCODING'],
+        'ClientAcceptLanguage' => env['HTTP_ACCEPT_LANGUAGE'],
+        'ClientAcceptCharset' => env['HTTP_ACCEPT_CHARSET'],
+        'ClientHttpReferer' => env['HTTP_REFERER']
+      }
+    end
+
+    def check!
+      body = Keypic::Client.new(:check_form).invoke
+
+      if body && body["status"] == 'response'
+        body["report"]
+      end
+    end
+
+    def clear!
+      session.delete("keypic.token")
+      @token = nil
+    end
+
+    def session
+      env["rack.session"] || {}
+    end
+
+    protected
+
+      def fetch_token_from_session
+        session["keypic.token"]
+      end
+
+      def fetch_token_form_server
+        params = { 'Quantity' => Keypic.configuration.quantity }.merge(client_params)
+
+        body = Keypic::Client.new(:new_token).invoke(params)
+
+        if body && body["status"] == 'new_token'
+          body["Token"]
+        end
+      end
+
+      def normalize_message(options)
+        params = options.symbolize_keys
+
+        {
+          "ClientEmailAddress" => params[:email],
+          "ClientUsername" => params[:name],
+          "ClientMessage" => params[:message]
+        }
+      end
+
+  end
+end

data/lib/keypic/version.rb

@@ -0,0 +1,3 @@
+module Keypic
+  VERSION = "0.0.1"
+end

data/spec/models/keypic_spec.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Keypic do
+  it "should be a module" do
+    Keypic.should be_a(Module)
+  end
+
+  context "configuration" do
+    it "should read default config values" do
+      Keypic.configuration.endpoint.should == "http://ws.keypic.com"
+      Keypic.configuration.form_id.should == "secret_token_here"
+    end
+
+    it "should set config value" do
+      Keypic.configure do |c|
+        c.endpoint = "endpoint"
+        c.form_id = "form_id"
+      end
+
+      Keypic.configuration.endpoint.should == "endpoint"
+      Keypic.configuration.form_id.should == "form_id"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require "rspec"
+require "keypic"
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # Remove this line if you don't want RSpec's should and should_not
+  # methods or matchers
+  require 'rspec/expectations'
+  config.include RSpec::Matchers
+
+  # == Mock Framework
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: keypic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Igor Galeta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !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
+    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: Client for Keypic Web Service API
+email:
+- galeta.igor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- keypic.gemspec
+- lib/keypic.rb
+- lib/keypic/client.rb
+- lib/keypic/config.rb
+- lib/keypic/proxy.rb
+- lib/keypic/version.rb
+- spec/models/keypic_spec.rb
+- spec/spec_helper.rb
+homepage: http://keypic.com/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Keypic is a Web Service for avoid the use of CAPTCHAs
+test_files:
+- spec/models/keypic_spec.rb
+- spec/spec_helper.rb