screenshooter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcc7e9ea857a9bdf5511474774e2b1ee8b5e05e7
+  data.tar.gz: 006f13db90613982983425a3230fdd696bba1c06
+SHA512:
+  metadata.gz: 32832280a7e64cd71df54025850ff9996a16bf86d66602db826d7fab2b449bd7805f1261f424f295f996fa28026d419254a4948f8b968bb57f25dfb921b1b609
+  data.tar.gz: 73a187fe45318ccb5739aecf9caaae7f0ab1b42e7d037c0dfd28dde03303c2c1d8ae5ba0dddd402110b2374ffce27dda5274c7eda609379eab21b8786dc39ee7

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.DS_Store
+browsers.yaml

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Ben Lopatin
+
+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,42 @@
+# ScreenShooter!
+
+A tool for generating BrowserStack screenshots from the command line.
+
+## Installing
+
+For now, clone the repository.
+
+## Configuration
+
+Set up your credentials in the `.browserstack` file in your home
+directory. It should look like this:
+
+    username:auth_token
+    
+Your authentication token is available under the
+[automation section](https://www.browserstack.com/accounts/automate-keys)
+of your profile.
+
+Next you'll need a browser configuration file. This will be used to
+specify which browser versions under which operating systems to take
+screenshots. You can start with the sample shipped with this project.
+
+## Using
+
+Use is pretty straightforward:
+
+    ruby screenshots.rb path_to/browsers.yaml
+
+Once the request is successfully made, the program will return the URL
+of the screenshot collection.
+
+You don't need to include the URL in your configuration file. It might
+be helpful if you're always taking screenshots of the same URL, but
+chances are you'll probably want to specify this each time you run the
+command.
+
+    ruby screenshots.rb path_to/browsers.yaml -u http://www.github.com
+
+The command accepts an optional boolean flag, `wait`, which will check
+every two seconds on the status of the request and return the URL once
+the job is complete.

data/Rakefile

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

data/bin/screenshooter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'screenshooter'
+ScreenShooter::ShotMaster.start

data/lib/screenshooter.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'thor'
+require 'yaml'
+require 'launchy'
+require 'screenshot'
+require "screenshooter/version"
+
+# Should get the values from the .browserstack file
+def get_credentials
+  keypair = File.open("#{Dir.home}/.browserstack", &:readline)
+  keypair.strip.split(":")
+end
+
+module ScreenShooter
+
+  class ShotMaster < Thor
+    desc "list", "list systems"
+    def list
+      username, password = get_credentials
+      client = Screenshot::Client.new({"username" => username, "password" => password})
+      puts client.get_os_and_browsers
+    end
+
+    desc "shoot", "take a screenshot"
+    method_option :url, :aliases => "-u", :desc => "URL of page to screenshot"
+    method_option :wait, :type => :boolean, :aliases => "-w", :default => false, :desc => "Wait for screenshots to be rendered?"
+    method_option :open, :type => :boolean, :aliases => "-o", :default => false, :desc => "Open the URL in the browser?"
+    def shoot(file="browsers.yaml")
+      username, password = get_credentials
+      client = Screenshot::Client.new({"username" => username, "password" => password})
+      params = YAML::load( File.open( file ) )
+      if options.has_key? "url"
+        params["url"] = options["url"]
+      end
+
+      begin
+        request_id = client.generate_screenshots params
+      rescue Exception => e
+        puts e.message
+      end
+
+      shot_status = "pending"
+      begin
+        shot_status = client.screenshots_status request_id
+        print "."
+        sleep 2
+      end while options["wait"] and shot_status != "done"
+
+      screenshots_url = "http://www.browserstack.com/screenshots/#{request_id}"
+      if options["open"]
+        Launchy.open(screenshots_url)
+      else
+        puts "\n#{screenshots_url}"
+      end
+    end
+  end
+end

data/lib/screenshooter/version.rb

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

data/sample_browsers.yaml

@@ -0,0 +1,22 @@
+url: http://www.github.com
+browsers:
+    -
+      browser: firefox
+      browser_version: "20.0"
+      os: Windows
+      os_version: "7"
+    -
+      browser: firefox
+      browser_version: "19.0"
+      os: Windows
+      os_version: "7"
+    -
+      browser: ie
+      browser_version: "9.0"
+      os: Windows
+      os_version: "7"
+    -
+      browser: chrome
+      browser_version: "28.0"
+      os: Windows
+      os_version: "7"

data/screenshooter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "screenshooter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "screenshooter"
+  s.version     = MyGem::VERSION
+  s.authors     = ["Ben Lopatin"]
+  s.email       = ["ben.lopatin@wellfireinteractive.com"]
+  s.homepage    = "http://www.github.com/bennylope/screenshooter"
+  s.description  = %q{A tool for generating BrowserStack screenshots from the command line.}
+  s.summary     = s.description
+  s.licenses = ['MIT']
+
+  s.rubyforge_project = "screenshooter"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "thor"
+  s.add_runtime_dependency "browserstack-screenshot"
+  s.add_runtime_dependency "launchy"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: screenshooter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Lopatin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: browserstack-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for generating BrowserStack screenshots from the command line.
+email:
+- ben.lopatin@wellfireinteractive.com
+executables:
+- screenshooter
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/screenshooter
+- lib/screenshooter.rb
+- lib/screenshooter/version.rb
+- sample_browsers.yaml
+- screenshooter.gemspec
+homepage: http://www.github.com/bennylope/screenshooter
+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: screenshooter
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: A tool for generating BrowserStack screenshots from the command line.
+test_files: []