screenshooter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcc7e9ea857a9bdf5511474774e2b1ee8b5e05e7
-  data.tar.gz: 006f13db90613982983425a3230fdd696bba1c06
+  metadata.gz: 425ac2d8befaa4dbe6e00593ac2bd70d07b17fdc
+  data.tar.gz: cc2f14417c715de3c82b341de17d226746d1d2c5
 SHA512:
-  metadata.gz: 32832280a7e64cd71df54025850ff9996a16bf86d66602db826d7fab2b449bd7805f1261f424f295f996fa28026d419254a4948f8b968bb57f25dfb921b1b609
-  data.tar.gz: 73a187fe45318ccb5739aecf9caaae7f0ab1b42e7d037c0dfd28dde03303c2c1d8ae5ba0dddd402110b2374ffce27dda5274c7eda609379eab21b8786dc39ee7
+  metadata.gz: f9d3317ac9ee43ab2b81e9ec10a0ab78a01f34bb01dfe8866ece815513a2b229e5e60b0e62dbe939bb528a3dabf6c471d6eaf338fc76636e476116f242dcb50b
+  data.tar.gz: 8cd94b3167e39ad114be2cc1e658807ae1ce879971ac1f32325fb1b177577d9156549548868bf6b2c4b29850ed6d1838376055f49a7a15cc4dd3c213fccad0ce

data/README.md

@@ -4,12 +4,24 @@ A tool for generating BrowserStack screenshots from the command line.
 
 ## Installing
 
-For now, clone the repository.
+> gem install screenshooter
+
+Or clone the repository and run
+
+> rake install
 
 ## Configuration
 
-Set up your credentials in the `.browserstack` file in your home
-directory. It should look like this:
+You will need to provide username and authentication token credentials
+to use the service. You can do so with environment variables or using a
+file.
+
+To use environment variables (suitable for a CI environment) set
+`BROWSERSTACK_USERNAME` and `BROWSERSTACK_TOKEN`, respectively. If these
+are missing then ScreenShooter will look for a credentials file.
+
+You should set up your credentials in the `.browserstack` file in your
+home directory. It should look like this:
 
     username:auth_token
     
@@ -19,24 +31,41 @@ 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.
+screenshots. You can start with the sample included in this project,
+`sample_browsers.yaml`.
 
 ## Using
 
 Use is pretty straightforward:
 
-    ruby screenshots.rb path_to/browsers.yaml
+    screenshooter path_to/browsers.yaml
 
 Once the request is successfully made, the program will return the URL
-of the screenshot collection.
+of the screenshot collection. The URL output can be piped to another
+service.
+
+### Setting the URL
 
 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
+    screenshooter path_to/browsers.yaml -u http://www.github.com
+
+### Waiting for completion
 
 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
+every 2.5 seconds on the status of the request and return the URL once
 the job is complete.
+
+    screenshooter path_to/browsers.yaml -u http://www.github.com -w
+    screenshooter path_to/browsers.yaml -u http://www.github.com --wait
+    
+### Open the screenshots URL
+
+The command accepts an optional boolean flag, `open`, which will open
+the screenshots URL in your default browser.
+
+    screenshooter path_to/browsers.yaml -u http://www.github.com -o
+    screenshooter path_to/browsers.yaml -u http://www.github.com --open

data/lib/screenshooter.rb

@@ -2,13 +2,18 @@ require 'rubygems'
 require 'thor'
 require 'yaml'
 require 'launchy'
+require 'progress_bar'
 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(":")
+  if ENV['BROWSERSTACK_USERNAME'] and ENV['BROWSERSTACK_TOKEN']
+    [ENV['BROWSERSTACK_USERNAME'], ENV['BROWSERSTACK_TOKEN']]
+  else
+    keypair = File.open("#{Dir.home}/.browserstack", &:readline)
+    keypair.strip.split(":")
+  end
 end
 
 module ScreenShooter
@@ -40,17 +45,18 @@ module ScreenShooter
       end
 
       shot_status = "pending"
+      bar = ProgressBar.new(:elapsed)
       begin
         shot_status = client.screenshots_status request_id
-        print "."
-        sleep 2
+        sleep 2.5
+        bar.increment!
       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}"
+        puts screenshots_url
       end
     end
   end

data/lib/screenshooter/version.rb

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

data/screenshooter.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "thor"
   s.add_runtime_dependency "browserstack-screenshot"
   s.add_runtime_dependency "launchy"
+  s.add_runtime_dependency "progress_bar"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: screenshooter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Lopatin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  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