browserstack-screenshot 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTUyYmVmYzE5MDJmZDA5YjY4MGRhOGVkNzBlZmEyMWZmYTcyNmU2MQ==
+  data.tar.gz: !binary |-
+    N2E2YzM4YzM3Yjk3ODg5NWJiYjY0YzdkYWYxNzk5YTNlZTRhZjk3YQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MTRkODZlN2UwZmFmZjA4ZDRlMjIzN2U2NWU2ZTYwOTQwMzkzMDBmMTY4NzQy
+    MGJlMTU0ZWM3Yzg1MzgyM2IzOGNjYTM4ZTFiMzk0N2RkNWQwNDU0Y2U3Nzcw
+    NmU5M2NkMmVmOGExNzA0OGY5MjdkMzBjZmRkZmI4MzQ5MWVjNDE=
+  data.tar.gz: !binary |-
+    ZWQyMzBiMTY3YjNhYzY0N2M0NWNjZWMwNzc0ODMxMGZmYTc4OWEwZWZkZWMx
+    NDZmODRmOGUxMjIzYzU0NjdkZjI1OGUwMTI2NDQwYzk4OWMxY2Q0MWJmYjk1
+    YWFjNTljNWI3NGU3MWJiMjc3MTNlYzk1N2JhNWE5YThkODgzMmU=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+screenshots

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.8.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahmed1490
+
+MIT License
+
+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,103 @@
+# BrowserStack Screenshots
+
+A ruby gem for [BrowserStack](http://browserstack.com)'s [Screenshot](http://browserstack.com/screenshots) [API](http://www.browserstack.com/screenshots/api).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'browserstack-screenshot'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install browserstack-screenshot
+
+## Example of Use
+
+First, you need to require the screenshot gem:
+
+``` ruby
+require 'screenshot'
+```
+
+### Creating Client
+Creates a new client instance.
+
+* `settings`: A hash of settings that apply to all requests for the new client.
+  * `:username`: The username for the BrowserStack account.
+  * `:password`: The password for the BrowserStack account.
+
+``` ruby
+settings = {:username => "foo", :password => "foobar"}
+client = Screenshot::Client.new(settings)
+```
+
+###API
+
+####Getting available os and browsers
+Fetches all available browsers. [API info](http://www.browserstack.com/screenshots/api#browser-list)
+
+``` ruby
+client.get_os_and_browsers 	#returns a hash
+```
+
+####Generating Screenshots
+Frame the config object according to the format given. [Format info](http://www.browserstack.com/screenshots/api#job-ids)
+
+Eg settings object:
+``` ruby
+params = {
+	:url => "www.google.com",
+	:callback_url => "http://example.com/pingback_url",
+	:win_res => "1024x768",		#Options : "1024x768", "1280x1024"
+	:mac_res => "1920x1080", 	#Options : "1024x768", "1280x960", "1280x1024", "1600x1200", "1920x1080"
+	:quality => "compressed",	#Options : "compressed", "original"
+	:tunnel => false,
+	:browsers => [
+			{:os=>"Windows",:os_version=>"7",:browser=>"ie",:browser_version=>"8.0"},
+			{:os=>"Windows",:os_version=>"XP",:browser=>"ie",:browser_version=>"7.0"}
+	]
+}
+```
+`callback_url`, `win_res`, `mac_res`, `quality` and `tunnel` being optional parameters.
+
+#####For testing Local/Internal Server setup
+* First setup local tunnel using the command line method as mentioned [here](http://www.browserstack.com/local-testing#setup)
+* Pass `:tunnel => true` in the params object
+
+
+
+A request id is returned when a valid request is made.
+
+``` ruby
+request_id = client.generate_screenshots params
+```
+
+####Checking/Polling the status of the request
+Use this method to check if the requested screenshots are complete. 
+``` ruby
+client.screenshots_done? request_id	#returns `true` or `false`
+```
+
+Or you can fetch the request state
+``` ruby
+client.screenshots_status request_id	#returns `queue` or `processing` or `done`
+```
+
+####Fetching the response of the requested screenshots
+``` ruby
+client.screenshots request_id
+```
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/browserstack-screenshot.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'screenshot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "browserstack-screenshot"
+  spec.version       = Screenshot::VERSION
+  spec.authors       = ["ahmed1490"]
+  spec.email         = ["ahmed1490@gmail.com"]
+  spec.description   = %q{Ruby wrapper for Browserstack screenshots API}
+  spec.summary       = %q{Get screenshots from live browsers using this gem}
+  spec.homepage      = "https://github.com/browserstack/ruby-screenshots"
+  spec.license       = ""
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_dependency("yajl-ruby", "1.1.0")
+end

data/lib/screenshot/client.rb

@@ -0,0 +1,98 @@
+module Screenshot
+	class Client
+          
+    API = "http://www.browserstack.com/screenshots"
+    
+    def initialize(options={})
+      options = symbolize_keys options
+      unless options[:username] && options[:password]
+        raise "Expecting Parameters: username and password in the options Hash!"
+      end
+      @authentication = "Basic " + Base64.encode64("#{options[:username]}:#{options[:password]}").strip
+      #authenticate options, AUTH_URI
+      self
+    end
+
+    def get_os_and_browsers
+      res = http_get_request :extend_uri => "browsers.json"
+      parse res
+    end
+    
+    def generate_screenshots configHash={}
+      res = http_post_request :data => Yajl::Encoder.encode(configHash)
+      responseJson = parse res
+      request = responseJson[:job_id]
+    end
+
+    def screenshots_done? job_id
+      (screenshots_status job_id) == "done" ? true : false
+    end
+
+     def screenshots_status job_id
+      res = http_get_request :extend_uri => "#{job_id}.json"
+      responseJson = parse res
+      responseJson[:state]
+    end
+
+    def screenshots job_id
+      res = http_get_request :extend_uri => "#{job_id}.json"
+      responseJson = parse res
+      responseJson[:screenshots]
+    end
+    
+    private
+    def authenticate options, uri=API
+      http_get_request options, uri
+    end
+
+    def http_get_request options={}, uri=API
+      uri = URI.parse uri if uri
+      uri.path = uri.path + "/#{options[:extend_uri].to_s}" if options[:extend_uri]
+      req = Net::HTTP::Get.new uri.request_uri
+      make_request req, options, uri
+    end
+
+    def http_post_request options={}, uri=API
+      uri = URI.parse uri if uri
+      req = Net::HTTP::Post.new uri.request_uri, initheader = {'Content-Type' =>'application/json'}
+      req.body = options[:data] if options[:data]
+      make_request req, options, uri
+    end
+
+    def make_request req, options={}, uri=API
+      conn = Net::HTTP.new uri.host, uri.port
+      add_authentication options, req
+      res = conn.request req
+      http_response_code_check res
+      res
+    end
+    
+    def add_authentication options, req
+      req["Authorization"] = @authentication
+      req
+    end
+
+    def http_response_code_check res
+      case res.code.to_i
+      when 200
+        res
+      when 401
+        raise "401 Unauthorized : Authentication Failed!"
+      when 422
+        raise "Unprocessable entity."+"\n Response Body: "+res.body
+      else
+        raise "Unexpected Response Code : "+res.code+"\n Response Body: "+res.body
+      end
+    end
+
+    def parse(response)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      parser.parse(response.body)
+    end
+
+    def symbolize_keys hash
+      hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+    end
+
+  end #Client
+end #Screenshots

data/lib/screenshot/version.rb

@@ -0,0 +1,3 @@
+module Screenshot
+	VERSION = "0.0.1"
+end

data/lib/screenshot.rb

@@ -0,0 +1,5 @@
+require "base64"
+require "net/http"
+require "yajl"
+require "screenshot/client"
+require "screenshot/version"

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: browserstack-screenshot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ahmed1490
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Ruby wrapper for Browserstack screenshots API
+email:
+- ahmed1490@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LkRTX1N0b3Jl
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJ1YnktZ2Vtc2V0
+- !binary |-
+  LnJ1YnktdmVyc2lvbg==
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRS50eHQ=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  YnJvd3NlcnN0YWNrLXNjcmVlbnNob3QuZ2Vtc3BlYw==
+- !binary |-
+  bGliL3NjcmVlbnNob3QucmI=
+- !binary |-
+  bGliL3NjcmVlbnNob3QvY2xpZW50LnJi
+- !binary |-
+  bGliL3NjcmVlbnNob3QvdmVyc2lvbi5yYg==
+homepage: https://github.com/browserstack/ruby-screenshots
+licenses:
+- ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Get screenshots from live browsers using this gem
+test_files: []