cloudscrape-client 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6375b7739448506067f0932c14912302609a4e5
+  data.tar.gz: ccc04537a0f4b383a5621e77a0ea4d5fcc0eb993
+SHA512:
+  metadata.gz: 5dd4731ecaa4864740d9d52598ab633c6cbc375729f07bc012525b4c6eb637bc3ace2a2e790e912e8e36db68832fadd8c8d9b7c3b4a62bb352f65f4547d5eb5d
+  data.tar.gz: 0f99b0ee8a3ea4816998094ab6bd2d120e2d7701390970d152e75eeadf595c280413030b9c5701f55b3b12d36c20d7aab86f1d5ccc1295dd305cd444263b25c5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false
+AllCops:
+  Exclude:
+    - 'bin/*'

data/.simplecov

@@ -0,0 +1,13 @@
+SimpleCov.configure do
+  start("rails") do
+    formatter SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter
+    ]
+
+    add_group "Long files" do |src_file|
+      src_file.lines.count > 100
+    end
+
+    add_filter "spec/*"
+  end
+end

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.2.3
+before_install: gem install bundler -v 1.10.6
+deploy:
+  provider: rubygems
+  api_key:
+    secure: ccDpQE6KaSKvdi4mv8CvoqF3rxRxRhpzlfs7VpcOfeyk1CGwINyH1H7fUYTcgHYikYaW0SQHSQ2lpIchUVonLQThYatdBuadmgWeNQS0lUJeGv7nmjEwCfqjGQDBmQnr+MBih3UvMUBmQFZUjVFQBhu9PXh8Mzde1P/hPcPHCvFWHCyhLDkezAHi3RIIWm7jQqtk/ogJfg/xCKOVQLJV1LMmR9HMnE3x0cSR+2dBRc19+hSVvwFaQAhVGdITYB8Kz7ayz7kmgPDFW/5fwnpnUiiul/fud+N/++yGg9x9dqXOF2h9axq8mDaa/21IzV7u8B5VYRSPGHH8EpYRJ4dGpNqVGXuUh97OBDCXRx32W9tDXqitbgxOgtfHgCGMnl+2h8tOirv/+y2CqQeoWHIIcPUzT6SFLOP5i76kEwv719skmMriw/yJQKv5ypazUvChx4b04rE32x7pAYmFOLCAcfAEdEMA7pykAoUgq7kFZ9dMmVX+gAYmlTZ4sQPUZiJR14GfnkovZAOCUZ3tPBbkdwrQq9AlW0KH6pZBv3xg5Ln/M28Qz/DS6MYTXV79Cmgq1aq4beE4eXt1CN0Nwfvd2niof/0KewR29wmPOaJNPCXlxTnatX10Badz29LOzGD0cxEdPPut/yUgHze0Fl9h+ZlRBQTJtugVGf89B/l/EH0=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Charles J Hardy
+
+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,154 @@
+# CloudScrape Ruby Client [![Build Status](https://travis-ci.org/cloudscrape/cloudscrape-client-ruby.svg?branch=master)](https://travis-ci.org/cloudscrape/cloudscrape-client-ruby)
+
+Wrapper for CloudScrape API.
+
+* [API Documentation](https://app.cloudscrape.com/#/api)
+* [Support](https://cloudscrape.zendesk.com/hc/en-us)
+
+
+
+## Requirements
+
+* Ruby `> 1.9.x`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloud_scrape'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cloud_scrape
+
+## Configuration
+
+``` ruby
+CloudScrape.configure do |config|
+  config.base_url = "https://app.cloudscrape.com/api/"
+  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:
+
+``` bash
+CLOUD_SCRAPE_CLIENT_BASE_URL="https://app.cloudscrape.com/api/"
+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://app.cloudscrape.com/api/`
+* `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 CloudScrape `1.0`
+* `timeout` sets the CloudScrape API request timeout `3600`
+* `verbose` should all output be printed to STDOUT `false`
+* `logger` Logger object. `Logger`
+
+## Usage
+
+``` ruby
+# Create client (optional arguments to override configuration)
+client = CloudScrape.new(
+  api_key: "pol6BFzsASYw4gQBl02b24nt",
+  account_id: "a814a8r2-a664-4rcb-759c-9de21744117a"
+)
+```
+
+#### Runs (Execute) [Docs](https://app.cloudscrape.com/#/api/sections/runs/execute)
+
+``` ruby
+execution_id = client.runs(run_id).execute
+```
+
+#### Runs (Execute with Input) [Docs](https://app.cloudscrape.com/#/api/sections/runs/executeWithInput)
+
+When `connect: true` is passed execution will upload it's result to configured integrations for this run.
+
+``` ruby
+execution_id = client.runs(run_id).execute(input: { url: 'http://google.com' }, connect: true)
+```
+
+#### Executions (Get) [Docs](https://app.cloudscrape.com/#/api/sections/executions/get)
+
+``` ruby
+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](https://app.cloudscrape.com/#/api/sections/executions/remove)
+
+``` ruby
+client.executions(execution_id).remove
+```
+
+#### Executions (Get Result) [Docs](https://app.cloudscrape.com/#/api/sections/executions/getResult)
+
+Methods are dynamically defined based on headers.
+
+``` ruby
+execution = client.executions(execution_id).result
+execution.response # => { headers: [...], rows: [...] }
+execution.as_hash # => { ... }
+```
+
+#### Executions (Stop) [Docs](https://app.cloudscrape.com/#/api/sections/executions/stop)
+
+``` ruby
+client.executions(execution_id).stop
+```
+
+#### Executions (Continue) [Docs](https://app.cloudscrape.com/#/api/sections/executions/continue)
+
+``` ruby
+client.executions(execution_id).continue
+```
+
+## Postman File
+
+[Download](./postman_collection) 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](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/cloudscrape/cloudscrape-client-ruby/fork )
+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 a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloud_scrape"
+
+# 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/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/ruby-parse

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('parser', 'ruby-parse')

data/bin/ruby-rewrite

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('parser', 'ruby-rewrite')

data/bin/safe_yaml

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'safe_yaml' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('safe_yaml', 'safe_yaml')

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/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+./bin/rubocop
+./bin/rspec