CloudScrape Ruby Client

Wrapper for CloudScrape API.

Requirements

For dependencies see spec.add_runtime_dependency in the Gemspec

Ruby > 1.9.x

Installation

Add this line to your application's Gemfile:

gem 'cloudscrape-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cloudscrape-client

Configuration

CloudscrapeClient.configure do |config|
  config.base_url = "https://api.dexi.io/"
  config.api_key = "pol6BFzsASYw4gQBl02b24nt"
  config.account_id = "a814a8r2-a664-4rcb-759c-9de21744117a"
  config.user_agent_app = "MY-AGENT"
  config.user_agent_version = "1.0"
  config.timeout = 60000
  config.verbose = true
  config.logger = Rails.logger
end

Some configuration can be set by environment variables:

CLOUD_SCRAPE_CLIENT_BASE_URL="https://api.dexi.io/"
CLOUD_SCRAPE_CLIENT_API_KEY="pol6BFzsASYw4gQBl02b24nt"
CLOUD_SCRAPE_CLIENT_ACCOUNT_ID="a814a8r2-a664-4rcb-759c-9de21744117a"
CLOUD_SCRAPE_CLIENT_USER_AGENT_APP="MY-AGENT"
CLOUD_SCRAPE_CLIENT_USER_AGENT_VERSION="1.0"
CLOUD_SCRAPE_CLIENT_TIMEOUT=60000
CLOUD_SCRAPE_CLIENT_VERBOSE=true

base_url sets the CloudScrape API url https://api.dexi.io/
api_key sets the CloudScrape API Key nil
user_agent_app sets the UserAgent app sent to CloudScrape CS-RUBY-CLIENT
user_agent_version sets the UserAgent version sent to CloudscrapeClient 1.0
timeout sets the CloudScrape API request timeout 3600
verbose should all output be printed to STDOUT false
logger Logger object. Logger

Usage

# Create client (optional arguments to override configuration)
client = CloudscrapeClient.new(
  api_key: "pol6BFzsASYw4gQBl02b24nt",
  account_id: "a814a8r2-a664-4rcb-759c-9de21744117a"
)

Runs (Execute) Docs

execution_id = client.runs(run_id).execute

Runs (Execute with Input) Docs

When connect: true is passed execution will upload it's result to configured integrations for this run.

execution_id = client.runs(run_id).execute(input: { url: 'http://google.com' }, connect: true)

Executions (Get) Docs

execution = client.executions(execution_id).get
execution.queued? # => false
execution.pending? # => true
execution.running? # => false
execution.failed? # => false
execution.stopped? # => false
execution.ok? # => false

Executions (Remove) Docs

client.executions(execution_id).remove

Executions (Get Result) Docs

execution = client.executions(execution_id).results
execution.response # => { headers: [...], rows: [...] }
execution.as_hash # => [ { ... } ]
result = execution.collection.first # => #<CloudscrapeClient::Executions::Result:0x007ffd7d132950>

# Methods are dynamically defined based on headers. For example:
result.methods.sort # => [..., :id, :screenshot]

result.id # => "ae101b8f-1326-451c-ada7-3eab3c0f8a91"

file = result.screenshot # => #<CloudscrapeClient::Executions::Result::File:0x007ffd7d817161>
file.id # => "11fed7f0-a508-4dc8-956a-481535c6f88a"
file.content_type # => "image/png"

Executions (Get Result File) Docs

execution.collection.first # => #<CloudscrapeClient::Executions::Result:0x007ffd7d132950>
result_file = result.screenshot # => #<CloudscrapeClient::Executions::Result::File:0x007ffd7d817161>

result_file.id # => "11fed7f0-a508-4dc8-956a-481535c6f88a"
result_file.provider_id # => 21607
result_file.content_type # => "image/png"
result_file.file_name # => "<ID>-<PROVIDER_ID>.png"

# Returns content of file
content = client.executions(execution_id).file(result_file) # => "..."

# Example content usage
newFile = File.open(result_file.file_name, "w")
newFile.write(content)
newFile.close

Executions (Stop) Docs

client.executions(execution_id).stop

Executions (Continue) Docs

client.executions(execution_id).continue

Postman File

Download and add the Postman File for API endpoints.

Testing

Ensure CLOUD_SCRAPE_CLIENT_API_KEY_OVERRIDE and CLOUD_SCRAPE_CLIENT_ACCOUNT_ID_OVERRIDE environment variable is set when recording VCR cassettes.

# Includes Rubocop
$ bin/test

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Fork it ( https://github.com/cloudscrape/cloudscrape-client-ruby/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

License

The gem is available as open source under the terms of the MIT License.