urlkit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c01849efef01a221786b63d39aa7f98750db719
+  data.tar.gz: 741380265c598a9a91adf4ba5c693914efcbe932
+SHA512:
+  metadata.gz: f9fe27f07812a6ea3a28c74bcdf85a2eeff748d5815a8af95a43a9ec2297b5a7640e0e181354b45a95f7302ef141162db796ef1a09ddf236b5e979f984dafc88
+  data.tar.gz: dbd0b5068712cf46a784d10345e5f6990c217a672aea35ecdf180bb08e76da987958aa7d403f415e61ee8c7712ea98218103175ea21f44c9b82faa3e46cc878f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 UrlKit
+
+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,82 @@
+[![Build Status](https://travis-ci.org/UrlKit/urlkit-ruby.svg?branch=master)](https://travis-ci.org/UrlKit/urlkit-ruby)
+
+
+# UrlKit
+
+## Perfect Screenshots Anywhere
+
+Get high quality screenshots using a real browser in seconds using our reliable CDN backed service
+
+## Requirements
+
+Works with Ruby 1.x 2.x and Jruby
+
+## Installation
+
+Install via gem
+
+```bash
+gem install urlkit
+```
+
+Once installed you can generate screenshots as follows:
+
+```ruby
+from urlkit import UrlKit
+
+urlkit = UrlKit.new('URLKIT_KEY', 'URLKIT_SECRET')
+
+screenshotUrl = urlkit.screenshotUrl({
+	"url": "bbc.com/news",
+	"width": 800
+})
+```
+
+## Parameters
+
+These are the options you can use to customize your screenshot.
+
+| Parameter | Default | Description |
+| --- | --- | --- |
+| url | | **Required.** The website address that you want to take a screenshot of. |
+| width | 1920 | Width of the thumbnail. |
+| viewport_width | 1920 | Width of the browser viewport this is the actual width of the page before we resize it for the thumbnail. |
+| viewport_height | (1200) | Height of the browser viewport, if you do not give this parameter we will calculate it for you based on viewport_width in 16:10 ratio. |
+| full_page | false | Capture a full length screenshot of the requested page. |
+| delay | 250 | Amount of time to wait before taking a screenshot of the page after it is fully loaded. Maximum 120000ms (2 minutes), minimum 250ms. |
+| cache_time | 2592000 | Amount of time in milliseconds to wait before taking the screenshot again. Maximum 2592000ms (30 days), minimum 1ms. |
+| user_agent | Latest Firefox User Agent | Set the user agent this screenshot will identify as. Useful for identifying as a mobile or tablet browser or to identify as a specific browser if the website pretends it needs Internet Explorer to view it's contents. |
+| language | false | Trim the outer color of the screenshot, useful for SVG's. |
+| transparent | false | Remove the background from the page, PNG format required. |
+| language | en | Accept-Language header customization for websites that support it, set ja for Japanese, de for German etc. |
+| cookie | | Semi colon separated list of cookies e.g. fruit=apple; drink=tea |
+| disable_javascript | false | Don't execute javascript on this page. |
+| disable_images | false | Don't download images on this page. |
+| timeout | 300000 | Amount of time in milliseconds to wait before taking screenshot anyway. Maximum 300000ms (5 minutes). |
+| mobile | false | Shortcut to set pixel_ratio, user_agent, viewport_width, viewport_height and width to that of the latest iPhone. |
+| pixel_ratio | 1 | Multiplier that sets the pixel density of the page relative to the resolution, useful for taking retina screenshots (2). |
+| format | png | Output the screenshot as a PNG (png) or JPEG (jpg) image. |
+| quality | 92 (if format=jpg) | Set the jpeg quality of the screenshot if jpeg is set as the format. |
+| click_selector | | Accepts valid DOM selector (#wantedselector). Rendered screenshot will only display contents of DOM selector. |
+| wait_selector | | Accepts valid DOM selector (.valid_selector > .another_class). We will not take the screenshot until .valid_selector appears on this screen and is not display:none; or timeout is reached. |
+| clip_selector | | Accepts valid DOM selector (.valid_selector:not(div)). Rendered screenshot will only display contents of DOM selector. |
+
+More documentation about this package and other language implementations can be found at https://urlk.it/documentation.
+
+## Support
+
+Contact us at support@brushd.com if you have any issues or questions about this package.
+
+## Other implementations
+
+Need an implementation for another language?
+
+| Language | Address |
+| --- | --- |
+| C# | https://github.com/UrlKit/urlkit-cs |
+| Java | https://github.com/UrlKit/urlkit-java |
+| Node.js |https://github.com/UrlKit/urlkit-node |
+| PHP | https://github.com/UrlKit/urlkit-php |
+| Python |https://github.com/UrlKit/urlkit-python |
+| Ruby | https://github.com/UrlKit/urlkit-ruby |
+| Shell Script | https://github.com/UrlKit/urlkit-sh |

data/lib/urlkit.rb

@@ -0,0 +1,17 @@
+require 'openssl'
+require 'open-uri'
+
+class UrlKit
+	def initialize(apiKey, apiSecret)
+	  @apiKey = apiKey
+	  @apiSecret = apiSecret
+    end
+
+	def screenshotUrl(options={})
+	  parameters = options.map {|option| option.map {|value| URI.escape(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")) }.join('=') }.join('&')
+
+	  token = OpenSSL::HMAC.hexdigest('sha1', @apiSecret, parameters)
+
+	  "https://api.urlk.it/v1/screenshot/#{@apiKey}/#{token}?#{parameters}"
+	end
+end

data/urlkit.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'urlkit'
+  spec.version     = '1.0.0'
+  spec.date        = '2017-05-01'
+  spec.summary     = "Get high quality screenshots using a real browser in seconds using our reliable CDN backed service"
+  spec.description = "UrlKit ruby screenshot generator"
+  spec.authors     = ["Chris Hutchinson"]
+  spec.email       = 'chris@brushd.com'
+  spec.files       = %w(LICENSE README.md urlkit.gemspec) + Dir['lib/*.rb']
+  spec.homepage    = 'https://urlk.it/'
+  spec.license     = 'MIT'
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: urlkit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Hutchinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies: []
+description: UrlKit ruby screenshot generator
+email: chris@brushd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- urlkit.gemspec
+- lib/urlkit.rb
+homepage: https://urlk.it/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Get high quality screenshots using a real browser in seconds using our reliable
+  CDN backed service
+test_files: []