shoot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7f66f4f6cbb2bfc395676753d9caf658eea2a2f
+  data.tar.gz: 30a61b20f76d2a68d9eac98675f145c056fa1b6d
+SHA512:
+  metadata.gz: 26b92ed0a68cf7e763bd0850326580eecc22984d230a924cdc98f934896b66c78fa6e7fec5743c33bc21ed5a154321e6aeef50702ed50bdb90ebf127cf4cc94e
+  data.tar.gz: b8b77da37f0600c7ff6eccb5e6d57d16876dced267345dcb83d93ae50ea598c2f9caf3220ccbf8d3280c18d152c45c45a27bbfe856cd70b9ca1644aa1dbd2aa9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2015, Juan Lulkin <maiz at lulk in>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Juan Lulkin
+
+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,70 @@
+# Shoot
+
+Shoot is a helper library to take screenshots using BrowserStack. If you don't need a full integration test coupled with screenshots, it's a simpler choice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+	gem 'shoot'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Shoot installs a binary. To inspect it, just run:
+
+    $ shoot
+    
+The first thing you should do is:
+ 
+    $ shoot list
+	ID   OS #                Browser #     Device
+	0    OS X Snow Leopard   safari 5.1
+	1    OS X Snow Leopard   chrome 14.0
+	2    OS X Snow Leopard   chrome 16.0
+	...
+	537  ios 7.0             ipad          iPad mini Retina
+	538  ios 7.0             iphone        iPhone 5S
+	539  ios 7.0             iphone        iPhone 5C
+	
+The `list` command basically fetches all browsers available on BrowserStack and caches them locally on `.browsers.json`. You can choose to add this file on yout `.gitignore`.
+
+Then, you can choose to activate the browsers you wanna use, based on id. Example:
+
+	$ shoot activate 2
+
+This will activate (given your output is the same as above) chrome 16 on OS X Snow Leopard.
+
+Now, create a scenario. Here's an example:
+
+```ruby
+class MyScenario < Shoot::Scenario
+	def login
+		visit "http://url.to.login"
+	end
+end
+```
+
+As you can see, it follows [capybara's](https://github.com/jnicklas/capybara) syntax, so you can visit pages, fill forms, click links and so on...
+
+Now run:
+
+	$ shoot scenario my_scenario.rb
+	
+This will run all the methods of MyScenario and generate screenshots for all active browsers.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/joaomilho/shoot/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

data/Rakefile

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

data/bin/shoot

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'shoot'
+
+Shoot::CLI.start(ARGV)

data/lib/shoot/cli.rb

@@ -0,0 +1,90 @@
+require 'thor'
+require 'json'
+require 'colorize'
+
+module Shoot
+  class CLI < Thor
+    BROWSERS_PATH = '.browsers.json'
+
+    desc 'list', 'List all platforms. Optionally pass a filter (e.g. browserstack list ie)'
+    def list(filter = nil)
+      table json.select { |p| p.inspect =~ /#{filter}/i }
+    end
+
+    desc 'active', 'List active platforms.'
+    def active
+      table _active
+    end
+
+    desc 'scenario', 'Runs the given scenario on all active platforms or one platform, based on ID'
+    def scenario(file, id = nil, test = 'all')
+      require Dir.pwd + '/' + file
+      klass_name = File.basename(file, '.rb').split('_').map(&:capitalize).join
+      klass = Kernel.const_get(klass_name)
+
+      runners = id ? [json[id.to_i]] : _active
+      runners.each do |config|
+        instance = klass.new(config)
+        klass.instance_methods(false).each do |method|
+          instance.shoot(method)
+        end
+        instance.ok
+      end
+    end
+
+    desc 'activate', 'Activate one platform, based on ID or interval'
+    def activate(from_id, to_id = from_id)
+      ids = (from_id.to_i..to_id.to_i).to_a
+      ids.each { |id| json[id]['active'] = true }
+      save_json
+      table json[from_id.to_i - 2, ids.size + 4]
+    end
+
+    desc 'deactivate', 'Deactivate one platform, based on ID'
+    def deactivate(id)
+      json[id.to_i]['active'] = false
+      save_json
+      table json[id.to_i - 2, 5]
+    end
+
+    no_commands do
+      def table(browsers)
+        table = browsers.map do |p|
+          to_row(p)
+        end.unshift(['ID', 'OS #', 'Browser #', 'Device'])
+        print_table table, truncate: true
+      end
+
+      def to_row(p)
+        [
+          p['id'].to_s.colorize(p['active'] ? :green : :red),
+          "#{p['os']} #{p['os_version']}",
+          "#{p['browser']} #{p['browser_version']}",
+          p['device']
+        ]
+      end
+
+      def json
+        File.write(BROWSERS_PATH, JSON.dump(fetch_json_and_prepare)) unless File.exist?(BROWSERS_PATH)
+        @json ||= JSON.parse(File.read(BROWSERS_PATH))
+      end
+
+      def _active
+        @active ||= json.select { |p| p['active'] }
+      end
+
+      def save_json
+        File.write(BROWSERS_PATH, JSON.dump(json))
+      end
+
+      def fetch_json_and_prepare
+        require 'rest_client'
+        JSON.parse(RestClient.get("https://juanlulkin1:NDswkopCqKPmA9wWAQws@www.browserstack.com/automate/browsers.json")).tap do |json|
+          json.each_with_index do |browser, index|
+            browser['id'] = index
+          end
+        end
+      end
+    end
+  end
+end

data/lib/shoot/scenario.rb

@@ -0,0 +1,58 @@
+require 'selenium-webdriver'
+require 'capybara'
+
+class Shoot::Scenario
+  URL = sprintf 'http://%s:%s@hub.browserstack.com/wd/hub',
+                ENV['BROWSERSTACK_USER'],
+                ENV['BROWSERSTACK_KEY']
+
+  include Capybara::DSL
+
+  def initialize(platform)
+    @platform = platform
+    config_capabilities
+
+    Capybara.register_driver platform_name do |app|
+      Capybara::Selenium::Driver.new(app,
+                                     browser: :remote,
+                                     url: URL,
+                                     desired_capabilities: @capabilities)
+    end
+
+    puts "Running #{platform_name}"
+    Capybara.current_driver = platform_name
+  end
+
+  def platform_name
+    @platform_name ||= if @platform['device']
+                         @platform['device']
+                       else
+                         name_items = %w(browser browser_version os os_version)
+                         @platform.values_at(*name_items).join(' ')
+                       end
+  end
+
+  def ok
+    puts 'OK'
+    page.driver.quit
+  end
+
+  def config_capabilities # rubocop:disable AbcSize
+    @capabilities = Selenium::WebDriver::Remote::Capabilities.new
+    @capabilities[:browser] = @platform['browser']
+    @capabilities[:browser_version] = @platform['browser_version']
+    @capabilities[:os] = @platform['os']
+    @capabilities[:os_version] = @platform['os_version']
+    @capabilities['browserstack.debug'] = 'true'
+    @capabilities[:name] = "Digital Goods - #{@platform}"
+    @capabilities[:browserName] = @platform['browser']
+    @capabilities[:platform] = @platform['os']
+    @capabilities[:device] = @platform['device'] if @platform['device']
+  end
+
+  def shoot(method)
+    send(method)
+    sleep(1) # Just in case
+    save_screenshot("shoot/screenshots/#{method} #{platform_name}.png")
+  end
+end

data/lib/shoot/version.rb

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

data/lib/shoot.rb

@@ -0,0 +1,5 @@
+module Shoot
+  autoload :CLI, "shoot/cli"
+  autoload :Scenario, "shoot/scenario"
+  autoload :Version, "shoot/version"
+end

data/shoot.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shoot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shoot"
+  spec.version       = Shoot::VERSION
+  spec.authors       = ["Juan Lulkin"]
+  spec.email         = ["juan.lulkin@klarna.com"]
+  spec.summary       = %q{A helper to take shots on BrowserStack}
+  spec.description   = %q{A helper to take shots on BrowserStack. Run the shoot binary for more info.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "selenium-webdriver", "~> 2.44"
+  spec.add_dependency "capybara", "~> 2.4"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "rest_client"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: shoot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Juan Lulkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.44'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.44'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rest_client
+  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 helper to take shots on BrowserStack. Run the shoot binary for more
+  info.
+email:
+- juan.lulkin@klarna.com
+executables:
+- shoot
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shoot
+- lib/shoot.rb
+- lib/shoot/cli.rb
+- lib/shoot/scenario.rb
+- lib/shoot/version.rb
+- shoot.gemspec
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A helper to take shots on BrowserStack
+test_files: []