DeathByCaptcha is recommended for solving the most popular CAPTCHA types, such as image to text, reCAPTCHA v2, reCAPTCHA v3, hCaptcha and FunCaptcha.
DeathByCaptcha is a Ruby API for DeathByCaptcha - http://www.deathbycaptcha.com
Add this line to your application's Gemfile:
gem 'deathbycaptcha', '~> 6.0.0'
And then execute:
$ bundle
Or install it yourself as:
$ gem install deathbycaptcha
client = DeathByCaptcha.new('myusername', 'mypassword')
There are two types of methods available: decode_* and decode_*!:
decode_* does not raise exceptions.decode_*! may raise a DeathByCaptcha::Error if something goes wrong.If the solution is not available, an empty CAPTCHA object will be returned.
captcha = client.decode_image!(url: 'http://bit.ly/1xXZcKo')
captcha.text # CAPTCHA solution
captcha.id # CAPTCHA numeric id
You can specify url, path, file, raw and raw64 when decoding an image.
client.decode_image!(url: 'http://bit.ly/1xXZcKo')
client.decode_image!(path: 'path/to/my/captcha/file')
client.decode_image!(file: File.open('path/to/my/captcha/file', 'rb'))
client.decode_image!(raw: File.open('path/to/my/captcha/file', 'rb').read)
client.decode_image!(raw64: Base64.encode64(File.open('path/to/my/captcha/file', 'rb').read))
captcha = client.decode_recaptcha_v2!(
googlekey: "6Ld2sf4SAAAAAKSgzs0Q13IZhY02Pyo31S2jgOB5",
pageurl: "https://patrickhlauke.github.io/recaptcha/",
# proxy: "http://user:password@127.0.0.1:3128", # OPTIONAL
# proxytype: "HTTP", # OPTIONAL
)
# The response will be a text (token), which you can access with `text` or `token` methods.
captcha.text
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd..."
captcha.token
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd..."
Parameters:
googlekey: The Google key for the reCAPTCHA.pageurl: The URL of the page with the reCAPTCHA challenge.proxy: optional parameter. Proxy URL and credentials (if any).proxytype: optional parameter. Proxy connection protocol.captcha = client.decode_recaptcha_v3!(
googlekey: "6LdyC2cUAAAAACGuDKpXeDorzUDWXmdqeg-xy696",
pageurl: "https://recaptcha-demo.appspot.com/recaptcha-v3-request-scores.php",
action: "examples/v3scores",
# min_score: 0.3, # OPTIONAL
# proxy: "http://user:password@127.0.0.1:3128", # OPTIONAL
# proxytype: "HTTP", # OPTIONAL
)
# The response will be a text (token), which you can access with `text` or `token` methods.
captcha.text
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd..."
captcha.token
"03AOPBWq_RPO2vLzyk0h8gH0cA2X4v3tpYCPZR6Y4yxKy1s3Eo7CHZRQntxrd..."
Parameters:
googlekey: The Google key for the reCAPTCHA.pageurl: The URL of the page with the reCAPTCHA challenge.action: The action name used by the CAPTCHA.min_score: optional parameter. The minimal score needed for the CAPTCHA resolution. Defaults to 0.3.proxy: optional parameter. Proxy URL and credentials (if any).proxytype: optional parameter. Proxy connection protocol.About the
actionparameter: in order to find out what this is, you need to inspect the JavaScript code of the website looking for a call to thegrecaptcha.executefunction.// Example grecaptcha.execute('6Lc2fhwTAAAAAGatXTzFYfvlQMI2T7B6ji8UVV_f', { action: "examples/v3scores" })
captcha = client.decode_h_captcha!(
sitekey: "56489210-0c02-58c0-00e5-1763b63dc9d4",
pageurl: "https://www.site.with.hcaptcha/example",
# proxy: "http://user:password@127.0.0.1:3128", # OPTIONAL
# proxytype: "HTTP", # OPTIONAL
)
# The response will be a text (token), which you can access with `text` or `token` methods.
captcha.text
"P0_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXNza2V5IjoiNnpWV..."
captcha.token
"P0_eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXNza2V5IjoiNnpWV..."
Parameters:
sitekey: The site key for the hCatpcha.pageurl: The URL of the page with the hCaptcha challenge.proxy: optional parameter. Proxy URL and credentials (if any).proxytype: optional parameter. Proxy connection protocol.captcha = client.decode_fun_captcha!(
publickey: "12345678-0000-1111-2222-123456789012",
pageurl: "https://www.site.with.funcaptcha/example",
# proxy: "http://user:password@127.0.0.1:3128", # OPTIONAL
# proxytype: "HTTP", # OPTIONAL
)
# The response will be a text (token), which you can access with `text` or `token` methods.
captcha.text
"380633616d817f2b8.2351188603|r=ap-southeast-2|met..."
captcha.token
"380633616d817f2b8.2351188603|r=ap-southeast-2|met..."
Parameters:
publickey: The public key for the FunCaptcha.pageurl: The URL of the page with the hCaptcha challenge.proxy: optional parameter. Proxy URL and credentials (if any).proxytype: optional parameter. Proxy connection protocol.captcha = client.captcha('28624378') # with 28624378 being the CAPTCHA id
captcha = client.report!('28624378') # with 28624378 being the CAPTCHA id
Warning: abusing on this method may get you banned.
user = client.user
user.is_banned # true if the user is banned
user.balance # Credit balance in USD cents
user.rate # CAPTCHA rate, i.e. charges for one solved CAPTCHA in USD cents
user.id # Numeric id of your account
status = client.status
status.todays_accuracy # Current accuracy of DeathByCaptcha
status.solved_in # Estimated seconds to solve a CAPTCHA right now
status.is_service_overloaded # true if DeathByCaptcha is overloaded/unresponsive
The API is thread-safe, which means it is perfectly fine to share a client instance between multiple threads.
The API supports HTTP (recommended) and socket-based connections.
# HTTP-based connection.
client = DeathByCaptcha.new('myusername', 'mypassword')
# or
client = DeathByCaptcha.new('myusername', 'mypassword', :http)
# Socket-based connection.
client = DeathByCaptcha.new('myusername', 'mypassword', :socket)
When using the socket client, make sure that outgoing TCP traffic to
api.dbcapi.me to the ports in range 8123-8130 is not blocked by your
firewall.
We strongly recommend using the HTTP client (default) because only image CAPTCHAs (
decode_image!) are supported by the socket client in this gem. Other CAPTCHA types, such as reCAPTCHA v2, reCAPTCHA v3, hCaptcha and FunCaptcha are supported by the HTTP client only.
DeathByCaptcha >= 5.0.0 does not require specific dependencies. That saves you memory and avoid conflicts with other gems.
Any format you use in the decode_image! method (url, file, path, raw or raw64) will
always be converted to a raw64, which is a base64-encoded binary string. So, if
you already have this format on your end, there is no need for 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, memory and IO).
We no longer follow the versioning system of the official clients of
DeathByCaptcha. From 5.0.0 onwards, we will use
Semantic Versioning.
git checkout -b my-new-feature)git commit -am 'Add some feature')git push origin my-new-feature)All contributors: https://github.com/infosimples/deathbycaptcha/graphs/contributors
MIT License. Copyright (C) 2011-2022 Infosimples. https://infosimples.com/
FAQs
Unknown package
We found that deathbycaptcha demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.