bbc_cucumber_salad 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    cucumber_salad (0.0.1)
+      capybara (>= 2.0.2)
+      cucumber (>= 1.2.1)
+      poltergeist (>= 1.1.0)
+      redis (>= 3.0.2)
+      rspec (>= 2.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.0)
+    capybara (2.0.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 1.0.0)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.2.2)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.6)
+      multi_json (~> 1.3)
+    diff-lcs (1.2.1)
+    eventmachine (1.0.1)
+    faye-websocket (0.4.7)
+      eventmachine (>= 0.12.0)
+    ffi (1.4.0)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    http_parser.rb (0.5.3)
+    json (1.7.7)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    nokogiri (1.5.6)
+    poltergeist (1.1.0)
+      capybara (~> 2.0, >= 2.0.1)
+      faye-websocket (~> 0.4, >= 0.4.4)
+      http_parser.rb (~> 0.5.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    redis (3.0.3)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.31.0)
+      childprocess (>= 0.2.5)
+      multi_json (~> 1.0)
+      rubyzip
+      websocket (~> 1.0.4)
+    websocket (1.0.7)
+    xpath (1.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cucumber_salad!

data/lib/cucumber_salad.rb

@@ -0,0 +1,4 @@
+require 'capybara'
+require 'capybara/poltergeist'
+require 'cucumber_salad/helpers'
+require 'cucumber_salad/drivers'

data/lib/cucumber_salad/before.rb

@@ -0,0 +1,11 @@
+Before do
+  Helper::Stub.clear
+end
+
+Before "@sleep" do
+  @sleep_enabled = true
+end
+
+After "@sleep" do
+  @sleep_enabled = false
+end

data/lib/cucumber_salad/drivers.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/drivers/*.rb"].each {|driver| require driver }

data/lib/cucumber_salad/drivers/blackberry.rb

@@ -0,0 +1,14 @@
+Capybara.register_driver :blackberry do |app|
+  driver = Capybara::Poltergeist::Driver.new(app, 
+    window_size: [220,200],
+    phantomjs_options: %w(--load-images=no --local-storage-quota=0 --proxy-type=none),
+    inspector: true,
+    js_errors: true
+  )
+  Helper::Driver.register(
+    :blackberry,
+    :poltergeist,
+    "BlackBerry8530/5.0.0.337 Profile/MIDP-2.1 Configuration/CLDC-1.1 VendorID/105"
+  )
+  driver
+end

data/lib/cucumber_salad/drivers/firefox.rb

@@ -0,0 +1,3 @@
+Capybara.register_driver :firefox do |app|
+  Capybara::Selenium::Driver.new(app, browser: :firefox)
+end

data/lib/cucumber_salad/drivers/phantomjs.rb

@@ -0,0 +1,14 @@
+Capybara.register_driver :phantomjs do |app|
+  driver = Capybara::Poltergeist::Driver.new(app, 
+    phantomjs_options: %w(--load-images=no --local-storage-quota=0 --proxy-type=none),
+    inspector: true,
+    js_errors: true,
+    extensions: Helper::Driver.phantomjs_extensions
+  )
+  Helper::Driver.register(
+    :smartphone,
+    :poltergeist,
+    "Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B141 Safari/8536.25"
+  )
+  driver
+end

data/lib/cucumber_salad/drivers/safari.rb

@@ -0,0 +1,10 @@
+Capybara.register_driver :safari do |app|
+  driver = Capybara::Selenium::Driver.new(app,
+    browser: :safari
+  )
+  Helper::Driver.register(
+    :smartphone,
+    :selenium
+  )
+  driver
+end

data/lib/cucumber_salad/drivers/smartphone.rb

@@ -0,0 +1,29 @@
+Capybara.register_driver :smartphone do |app|
+  driver = Capybara::Poltergeist::Driver.new(app, 
+    window_size: [320,480],
+    phantomjs_options: %w(--load-images=no --local-storage-quota=0 --proxy-type=none),
+    inspector: true,
+    js_errors: true
+  )
+  Helper::Driver.register(
+    :smartphone,
+    :poltergeist,
+    "Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B141 Safari/8536.25"
+  )
+  driver
+end
+
+Capybara.register_driver :smartphone_landscape do |app|
+  driver = Capybara::Poltergeist::Driver.new(app, 
+    window_size: [480, 320],
+    phantomjs_options: %w(--load-images=no --local-storage-quota=0 --proxy-type=none),
+    inspector: true,
+    js_errors: true
+  )
+  Helper::Driver.register(
+    :smartphone_landscape,
+    :poltergeist,
+    "Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10B141 Safari/8536.25"
+  )
+  driver
+end

data/lib/cucumber_salad/drivers/tablet.rb

@@ -0,0 +1,14 @@
+Capybara.register_driver :tablet do |app|
+  driver = Capybara::Poltergeist::Driver.new(app, 
+    window_size: [1024,768],
+    phantomjs_options: %w(--load-images=no --local-storage-quota=0 --proxy-type=none),
+    inspector: true,
+    js_errors: true
+  )
+  Helper::Driver.register(
+    :tablet,
+    :poltergeist,
+    "Mozilla/5.0 (iPad; CPU OS 6_0 like Mac OS X) AppleWebKit/536.26 (KHTML, like Gecko) Version/6.0 Mobile/10A5355d Safari/8536.25"
+  )
+  driver
+end

data/lib/cucumber_salad/helper/cookie.rb

@@ -0,0 +1,62 @@
+require 'cgi'
+module Helper
+  module Cookie
+    def self.init_cookies
+      @cookies ||= {}
+    end
+    
+    def self.all
+      @cookies
+    end
+    
+    def self.add(key, value, options = {})
+      self.init_cookies
+      @cookies[key] = {
+        value: value,
+        options: options
+      }
+    end
+    
+    def self.add_test_cookie(key, value)
+      key = 'test-' + self.base64_encode(key)
+      value = base64_encode value
+      self.add(key, value)
+    end
+    
+    def self.send_to_driver(driver)
+      driver = Helper::Driver.get(driver)
+      if driver
+        self.set_cookies(driver)
+      end
+    end
+    
+    def self.set_cookies(driver)
+      self.init_cookies
+      if driver[:driver] == :poltergeist
+        @cookies.keys.each do |key|
+          cookie = @cookies[key]
+          Capybara.current_session.driver.set_cookie(
+            key,
+            cookie[:value],
+            domain: self.domain_for_cookie(cookie)
+          )
+        end
+      end
+    end
+    
+    def self.domain_for_cookie(cookie)
+      if cookie[:options][:domain]
+        cookie[:options][:domain]
+      end
+    end
+    
+    def self.base64_encode(key)
+      CGI.escape(Base64.encode64(key).gsub("\n", ""))
+    end
+    
+    def self.reset
+      @cookies = nil
+    end
+    
+  end
+end

data/lib/cucumber_salad/helper/device.rb

@@ -0,0 +1,29 @@
+module Helper
+  module Device
+    def use_device(device)
+      driver = driver_for_device(device)
+      self.set_driver(driver)
+    end
+    
+    protected
+    
+    def set_driver(driver)
+      Capybara.current_driver = driver
+    end
+    
+    def default_drivers
+      {
+        desktop: :firefox,
+        tablet: :ipad,
+        smartphone: :smartphone,
+        feature_phone: :blackberry
+      }
+    end
+    
+    def driver_for_device(device)
+      driver = ENV[device.to_s] || default_drivers[device]
+      raise "Driver '#{driver}' does not exist. Please define a driver for :#{driver} in drivers/#{driver}.rb" unless Capybara.drivers.keys.include?(driver)
+      driver
+    end
+  end
+end

data/lib/cucumber_salad/helper/driver.rb

@@ -0,0 +1,37 @@
+module Helper
+  module Driver
+    def self.register(name, driver, useragent = '')
+      @drivers ||= {}
+      @drivers[name] = {
+        driver: driver,
+        useragent: useragent
+      }
+    end
+    
+    def self.setup(driver)
+      driver = self.get(driver)
+      if driver
+        self.init_driver(driver)
+      end
+    end
+    
+    def self.init_driver(driver)
+      if driver[:driver] == :poltergeist and driver[:useragent]
+        Capybara.current_session.driver.headers = {"User-Agent" => driver[:useragent]}
+      end
+    end
+    
+    def self.get(driver)
+      if @drivers and @drivers[driver]
+        @drivers[driver]
+      end
+    end
+    
+    def self.phantomjs_extensions
+      extension_path = File.expand_path('../../../../src/phantomjs/extensions', __FILE__)
+      [
+        "#{extension_path}/geolocation.js"
+      ]
+    end
+  end
+end

data/lib/cucumber_salad/helper/environment.rb

@@ -0,0 +1,70 @@
+module Helper
+  module Environment
+    
+    def host(prefix = 'pal')
+      app_host = "http://"
+      if self.env == "sandbox"
+       app_host << "#{prefix}.sandbox.dev"
+      else
+        if prefix == 'pal'
+          host_prefix = 'www'
+        else
+          host_prefix = 'm'
+        end
+        app_host << "#{host_prefix}.#{self.env}"
+      end
+      "#{app_host}.bbc.co.uk"
+    end
+    
+    def env
+      ENV["TARGET_ENV"] || "sandbox"
+    end
+    
+    def stub_path
+      raise "Please set your stub path using Helper::Environment.stub_path = '/path'" unless @stub_path
+      FileUtils.mkdir_p(@stub_path) unless Dir.exists?(@stub_path)
+      @stub_path
+    end
+    
+    def stub_path=(path)
+      @stub_path = path
+    end
+    
+    def default_stub_path
+      raise "Please set your default stub path using Helper::Environment.default_stub_path = '/path'" unless @default_stub_path
+      FileUtils.mkdir_p(@default_stub_path) unless Dir.exists?(@default_stub_path)
+      @default_stub_path
+    end
+    
+    def default_stub_path=(path)
+      @default_stub_path = path
+    end
+    
+    def proxy
+      ENV["http_proxy"] || ""
+    end
+    
+    def syd_proxy
+      "http://www-cache-syd.reith.bbc.co.uk:80"
+    end
+    
+    def allow_driver_override?
+      true if ENV["device_override"]
+    end
+    
+    def remote?
+      self.env != "sandbox"
+    end
+    
+    module_function :host,
+                    :env,
+                    :stub_path,
+                    :stub_path=,
+                    :default_stub_path,
+                    :default_stub_path=,
+                    :proxy,
+                    :syd_proxy,
+                    :allow_driver_override?,
+                    :remote?
+  end
+end

data/lib/cucumber_salad/helper/flagpole.rb

@@ -0,0 +1,7 @@
+module Helper
+  module Flagpole
+    def self.set(flagpole, value)
+      Helper::Cookie.add_test_cookie("fp-#{flagpole}", value)
+    end
+  end
+end

data/lib/cucumber_salad/helper/sleep.rb

@@ -0,0 +1,21 @@
+module Helper
+  module Sleep
+    
+    def enable
+      @enable_sleep = true
+    end
+    
+    def disable
+      @enable_sleep = false
+    end
+    
+    def enable?
+      sleep 10000 if @enable_sleep
+    end
+    
+    module_function :enable,
+                    :disable,
+                    :enable?
+    
+  end
+end

data/lib/cucumber_salad/helper/stub.rb

@@ -0,0 +1,84 @@
+require 'json'
+module Helper
+  module Stub
+    
+    def self.clear
+      Dir.foreach self.stub_file_path do |file|
+        next if file == '.' or file == '..' or file == '.svn'
+        if File.exists?(file)
+          File.delete(File.join(self.stub_file_path, file))
+        end
+      end
+    end
+    
+    def self.init_stubs
+      @stubs ||= {}
+    end
+    
+    def self.register(key, value)
+      self.init_stubs
+      @stubs[key] = value
+    end
+    
+    def self.register_default(key, value)
+      self.init_stubs
+      unless @stubs[key]
+        self.register(key, value)
+      end
+    end
+    
+    def self.load_defaults
+      Dir.glob(File.join(Helper::Environment.default_stub_path, '**/*')).each do |file|
+        unless File.directory?(file)
+          value = JSON.load(File.read(file))
+          key = file.split('/').last
+          self.register_default(key, value)
+        end
+      end
+    end
+    
+    def self.create_key(class_name, method, parameters = nil)
+      Digest::MD5.hexdigest([
+        class_name,
+        method,
+        parameters
+      ].delete_if{|value| value == nil}.to_json)
+    end
+    
+    def self.write
+      if @stubs and @stubs.size > 0
+        self.write_to_store
+      end
+    end
+    
+    def self.write_to_store
+      if Helper::Environment.remote?
+        self.write_to_redis
+      else
+        self.write_to_file
+      end
+    end
+    
+    def self.write_to_redis
+      @redis ||= Redis.new(host: '176.34.255.217', port: 6379)
+      @redis.flushall
+      @redis.pipelined do
+        @stubs.each_pair do |key, value|
+          @redis.set key, value.to_json
+        end
+      end
+    end
+    
+    def self.write_to_file
+      @stubs.each_pair do |key, value|
+        path = self.stub_file_path + '/' + key
+        File.open(path, 'w') {|f| f.write(value.to_json) }
+      end
+    end
+    
+    def self.stub_file_path
+      Helper::Environment.stub_path
+    end
+    
+  end
+end

data/lib/cucumber_salad/helper/visit.rb

@@ -0,0 +1,14 @@
+module Helper
+  module Visit
+    def visit(*args)
+      current_driver = Capybara.current_driver
+      Helper::Stub.load_defaults
+      Helper::Stub.write
+      Capybara.current_session.visit "/"
+      Helper::Driver.setup current_driver
+      Helper::Cookie.send_to_driver current_driver
+      Helper::Sleep.enable?
+      Capybara.current_session.visit *args
+    end
+  end
+end

data/lib/cucumber_salad/helpers.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/helper/*.rb"].each {|helper| require helper }

data/lib/cucumber_salad/world.rb

@@ -0,0 +1,8 @@
+require 'cucumber_salad/before'
+World(Helper::Cookie)
+World(Helper::Device)
+World(Helper::Environment)
+World(Helper::Flagpole)
+World(Helper::Sleep)
+World(Helper::Stub)
+World(Helper::Visit)

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: bbc_cucumber_salad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Crouch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.3
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+description: A gem to manage the usage of cucumber/mocking/multiple devices
+email:
+- Matthew.Crouch@bbc.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cucumber_salad/before.rb
+- lib/cucumber_salad/drivers/blackberry.rb
+- lib/cucumber_salad/drivers/firefox.rb
+- lib/cucumber_salad/drivers/phantomjs.rb
+- lib/cucumber_salad/drivers/safari.rb
+- lib/cucumber_salad/drivers/smartphone.rb
+- lib/cucumber_salad/drivers/tablet.rb
+- lib/cucumber_salad/drivers.rb
+- lib/cucumber_salad/helper/cookie.rb
+- lib/cucumber_salad/helper/device.rb
+- lib/cucumber_salad/helper/driver.rb
+- lib/cucumber_salad/helper/environment.rb
+- lib/cucumber_salad/helper/flagpole.rb
+- lib/cucumber_salad/helper/sleep.rb
+- lib/cucumber_salad/helper/stub.rb
+- lib/cucumber_salad/helper/visit.rb
+- lib/cucumber_salad/helpers.rb
+- lib/cucumber_salad/world.rb
+- lib/cucumber_salad.rb
+- Gemfile
+- Gemfile.lock
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem to ease the pain of managing capybara driver config and provide a home
+  for common utils and patches
+test_files: []