deathbycaptcha 5.0.2 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d578d0181a5e858098bc2329884daff5971f7bbd
-  data.tar.gz: b2681b030c07099cc78cb52dfc4382c6015d64b6
+  metadata.gz: 98c633b9bb114866ddf802c7420e8c44d737dffd
+  data.tar.gz: f940fb9797a688edebe3b90da31dbff445c1a27a
 SHA512:
-  metadata.gz: 1eaf72f64a8b7e83d4e7b6933d17d3d48ea14a890cae901c1aa1f3e9693f7bbdac4e85ad23ba075010714a166946668fb60cd8032aa4d3814a31cf228e80a66c
-  data.tar.gz: 2628bb9faeba7ee4e1438d307d3a20357bb69f3b2195afbf804add2c9d1979f48ddbc719c6f01d084e38572c76ec03b7d623f56d96733eec784d96a5e056a327
+  metadata.gz: 8dcf6fe8b34118de125bb698ffeabab7297631cdd7e740a63269e408c76555068a91232814e4e6417b4a83a4fb7db5be911e8273cf2f2f07455be5bab0e74683
+  data.tar.gz: 8fe87517c20ad3bd5bb1a3181c81d2fb2ba02658b4eeadad6e600d2b872ac1136eba1737a163f5bd306f8ebf072f14611e249390a02bbcf3feaa7be22a7dc3de

data/README.md

@@ -24,14 +24,12 @@ Or install it yourself as:
 
     $ gem install deathbycaptcha
 
-
 ## Usage
 
 1. **Create a client**
 
   ```ruby
   # Create a client (:socket and :http clients are available)
-  #
   client = DeathByCaptcha.new('myusername', 'mypassword', :http)
   ```
 
@@ -44,7 +42,7 @@ Or install it yourself as:
   If the solution is not available, an empty captcha object will be returned.
 
   ```ruby
-  captcha = client.decode(url: 'http://bit.ly/1xXZcKo')
+  captcha = client.decode!(url: 'http://bit.ly/1xXZcKo')
   captcha.text        # Solution of the captcha
   captcha.id          # Numeric ID of the captcha solved by DeathByCaptcha
   captcha.is_correct  # true if the solution is correct
@@ -53,16 +51,17 @@ Or install it yourself as:
   You can also specify *path*, *file*, *raw* and *raw64* when decoding an image.
 
   ```ruby
-  client.decode(path: 'path/to/my/captcha/file')
+  client.decode!(path: 'path/to/my/captcha/file')
 
-  client.decode(file: File.open('path/to/my/captcha/file', 'rb'))
+  client.decode!(file: File.open('path/to/my/captcha/file', 'rb'))
 
-  client.decode(raw: File.open('path/to/my/captcha/file', 'rb').read)
+  client.decode!(raw: File.open('path/to/my/captcha/file', 'rb').read)
 
-  client.decode(raw64: Base64.encode64(File.open('path/to/my/captcha/file', 'rb').read))
+  client.decode!(raw64: Base64.encode64(File.open('path/to/my/captcha/file', 'rb').read))
   ```
 
-  > Internally, the gem will always convert the image to raw64 (binary base64 encoded).
+  > Internally, the gem will always convert any image to raw64 (binary base64
+  encoded).
 
 3. **Retrieve a previously solved captcha**
 
@@ -97,6 +96,86 @@ Or install it yourself as:
   status.is_service_overloaded  # true if DeathByCaptcha is overloaded/unresponsive
   ```
 
+## New reCAPTCHA
+
+> It's currently available only with the :http client.
+
+To solve captchas similar to
+[reCAPTCHA v2](https://support.google.com/recaptcha/?hl=en#6262736), you can use
+both the DeathByCaptcha's **Coordinates API** or **Image Group API**.
+
+Please, read the oficial documentation at
+http://www.deathbycaptcha.com/user/api/newrecaptcha.
+
+### Using the Coordinates API
+
+```ruby
+# Read above all the instructions on how to solve a captcha.
+captcha = client.decode!(type: 2, url: 'http://bit.ly/1VCUuzk')
+```
+
+You should specify arguments with *type = 2* and an image similar to a screenshot of
+the captcha. See an example:
+
+**Captcha (screenshot)**
+
+> the argument is passed as *url*, *path*, *file*, *raw* or *raw64*
+
+![Example of a captcha based on image clicks](captchas/2.jpg)
+
+The response will be an array containing coordinates (x, y) where the human
+clicked to solve the captcha. For the captcha above it should look something
+like:
+
+```ruby
+# captcha.text
+"[[30,143],[241,325]]"
+
+# captcha.coordinates
+[[30, 143], [241, 325]]
+```
+
+### Using the Image Group API
+
+```ruby
+# Read above all the instructions on how to solve a captcha.
+captcha = client.decode!(
+  type: 3,
+  url: 'http://bit.ly/1i1CIaB', # single image with the clickable grid
+  banner: { url: 'http://bit.ly/1JTG4T3' }, # the banner image
+  banner_text: 'Click all images with bananas' # the banner text
+)
+```
+
+You should specify arguments with *type = 3* and the decomposed captcha as seen in the
+example below:
+
+**Captcha: images grid**
+
+> the argument is passed as *url*, *path*, *file*, *raw* or *raw64*
+
+![Example of a grid of a captcha based on image clicks](captchas/3-grid.jpg)
+
+**Captcha: banner**
+
+![Example of a banner of a captcha based on image clicks](captchas/3-banner.jpg)
+
+**Captcha: banner text**
+
+> Click all images with bananas
+
+The response will be an array containing the indexes for each image that should
+be clicked counting from left to right. For the captcha above it should look
+something like:
+
+```ruby
+# captcha.text
+"[1,9]"
+
+# captcha.indexes
+[1, 9]
+```
+
 ## Notes
 
 #### Thread-safety
@@ -121,7 +200,7 @@ firewall.
 #### Ruby dependencies
 
 DeathByCaptcha >= 5.0.0 don't require specific dependencies. That saves you
-memmory and avoid conflicts with other gems.
+memory and avoid conflicts with other gems.
 
 #### Input image format
 
@@ -131,7 +210,7 @@ you already have this format available on your side, there's no need to do
 convertions before calling the API.
 
 > Our recomendation is to never convert your image format, unless needed. Let
-> the gem convert internally. It may save you resources (CPU, memmory and IO).
+> the gem convert internally. It may save you resources (CPU, memory and IO).
 
 #### Versioning
 
@@ -156,6 +235,7 @@ This gem has been tested on the following versions of Ruby:
 # Maintainers
 
 * [Débora Setton Fernandes](http://github.com/deborasetton)
+* [Marcelo Mita](http://github.com/marcelomita)
 * [Rafael Barbolo](http://github.com/barbolo)
 * [Rafael Ivan Garcia](http://github.com/rafaelivan)
 

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deathbycaptcha"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/deathbycaptcha/client.rb

@@ -87,16 +87,17 @@ module DeathByCaptcha
       raw64 = load_captcha(options)
       raise DeathByCaptcha::InvalidCaptcha if raw64.to_s.empty?
 
-      _captcha = self.upload(raw64)
-      while _captcha.text.to_s.empty?
+      decoded_captcha = self.upload(options.merge(raw64: raw64))
+
+      while decoded_captcha.text.to_s.empty?
         sleep(self.polling)
-        _captcha = self.captcha(_captcha.id)
+        decoded_captcha = self.captcha(decoded_captcha.id)
         raise DeathByCaptcha::Timeout if (Time.now - started_at) > self.timeout
       end
 
-      raise DeathByCaptcha::IncorrectSolution if !_captcha.is_correct
+      raise DeathByCaptcha::IncorrectSolution if !decoded_captcha.is_correct
 
-      _captcha
+      decoded_captcha
     end
 
     # Retrieve information from an uploaded captcha.

data/lib/deathbycaptcha/client/http.rb

@@ -53,8 +53,20 @@ module DeathByCaptcha
     #
     # @return [DeathByCaptcha::Captcha] The captcha object (not solved yet).
     #
-    def upload(raw64)
-      response = perform('captcha', :post_multipart, captchafile: "base64:#{raw64}")
+    def upload(options = {})
+      payload = {}
+      payload[:captchafile] = "base64:#{options[:raw64]}"
+      payload[:type] = options[:type] if options[:type].to_i > 0
+
+      if options[:type].to_i == 3
+        banner64 = load_captcha(options[:banner])
+        raise DeathByCaptcha::InvalidCaptcha if banner64.to_s.empty?
+
+        payload[:banner] = "base64:#{banner64}"
+        payload[:banner_text] = options[:banner_text].to_s
+      end
+
+      response = perform('captcha', :post_multipart, payload)
       DeathByCaptcha::Captcha.new(response)
     end
 
@@ -84,7 +96,6 @@ module DeathByCaptcha
         boundary, body = prepare_multipart_data(payload)
         req.content_type = "multipart/form-data; boundary=#{boundary}"
         req.body = body
-
       else
         uri = URI("#{BASE_URL}/#{action}?#{URI.encode_www_form(payload)}")
         req = Net::HTTP::Get.new(uri.request_uri, headers)

data/lib/deathbycaptcha/client/socket.rb

@@ -54,8 +54,12 @@ module DeathByCaptcha
     #
     # @return [DeathByCaptcha::Captcha] The captcha object (not solved yet).
     #
-    def upload(raw64)
-      response = perform('upload', captcha: raw64)
+    def upload(options = {})
+      if options[:type] && options[:type].to_i != 1
+        # Socket client implementation currently supports only text captchas.
+        raise DeathByCaptcha::InvalidCaptcha
+      end
+      response = perform('upload', captcha: options[:raw64])
       DeathByCaptcha::Captcha.new(response)
     end
 

data/lib/deathbycaptcha/models/captcha.rb

@@ -16,5 +16,13 @@ module DeathByCaptcha
     def captcha=(value)
       @captcha = value.to_i
     end
+
+    def parsed_text
+      JSON.parse(text)
+    rescue
+      []
+    end
+    alias_method :coordinates, :parsed_text
+    alias_method :indexes, :parsed_text
   end
 end

data/lib/deathbycaptcha/version.rb

@@ -1,4 +1,4 @@
 module DeathByCaptcha
-  VERSION = "5.0.2"
+  VERSION = "5.0.3"
   API_VERSION = "DBC/Ruby v#{VERSION}"
 end

data/spec/lib/image_captcha_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+username      = CREDENTIALS['username']
+password      = CREDENTIALS['password']
+path2         = './captchas/2.jpg' # path of the captcha (Coordinates API)
+path3_grid    = './captchas/3-grid.jpg' # path of the grid (Image Group API)
+path3_banner  = './captchas/3-banner.jpg' # path of the grid (Image Group API)
+banner_text3  = 'Click all images with bananas'
+
+describe 'Solving an image based captcha' do
+  before(:all) { @client = DeathByCaptcha.new(username, password, :http) }
+
+  context 'Coordinates API' do
+    describe '#decode!' do
+      before(:all) { @captcha = @client.decode!(type: 2, path: path2) }
+      it { expect(@captcha).to be_a(DeathByCaptcha::Captcha) }
+      it { expect(@captcha.text).to match(/\A\[\[.*\]\]\Z/) }
+      it { expect(@captcha.coordinates).to be_a(Array) }
+      it { expect(@captcha.coordinates.size).to be > 0 }
+      it 'expect coordinates to be valid' do
+        @captcha.coordinates.each do |coordinate|
+          expect(coordinate).to be_a(Array)
+          expect(coordinate.size).to eq(2)
+        end
+      end
+      it { expect(@captcha.is_correct).to be true }
+      it { expect(@captcha.id).to be > 0 }
+      it { expect(@captcha.id).to eq(@captcha.captcha) }
+    end
+  end
+
+  context 'Image Group API' do
+    describe '#decode!' do
+      before(:all) do
+        @captcha = @client.decode!(
+          type: 3,
+          path: path3_grid,
+          banner: { path: path3_banner },
+          banner_text: banner_text3
+        )
+      end
+      it { expect(@captcha).to be_a(DeathByCaptcha::Captcha) }
+      it { expect(@captcha.text).to match(/\A\[.*\]\Z/) }
+      it { expect(@captcha.indexes).to be_a(Array) }
+      it { expect(@captcha.indexes.size).to be > 0 }
+      it 'expect indexes to be valid' do
+        @captcha.indexes.each do |index|
+          expect(index).to be_a(Numeric)
+        end
+      end
+      it { expect(@captcha.is_correct).to be true }
+      it { expect(@captcha.id).to be > 0 }
+      it { expect(@captcha.id).to eq(@captcha.captcha) }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deathbycaptcha
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
 platform: ruby
 authors:
 - Débora Setton Fernandes, Rafael Barbolo, Rafael Ivan Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,9 @@ dependencies:
 description: DeathByCaptcha allows you to solve captchas with manual labor
 email:
 - team@infosimples.com.br
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,7 +67,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - captchas/1.png
+- captchas/2.jpg
+- captchas/3-banner.jpg
+- captchas/3-grid.jpg
 - deathbycaptcha.gemspec
 - lib/deathbycaptcha.rb
 - lib/deathbycaptcha/client.rb
@@ -80,6 +87,7 @@ files:
 - lib/deathbycaptcha/version.rb
 - spec/credentials.yml.example
 - spec/lib/client_spec.rb
+- spec/lib/image_captcha_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/infosimples/deathbycaptcha
 licenses:
@@ -108,4 +116,5 @@ summary: Ruby API for DeathByCaptcha (Captcha Solver as a Service)
 test_files:
 - spec/credentials.yml.example
 - spec/lib/client_spec.rb
+- spec/lib/image_captcha_spec.rb
 - spec/spec_helper.rb