calliper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6744c434f323e9ef6685ecb0ac6eb918fa8c5711
+  data.tar.gz: 3384b9224c9767b45edc52233c707ecd060ca059
+SHA512:
+  metadata.gz: 07b6681def6e25bfb470f39f4250b3a904fa0fd20067ca3c9da52e35dffc42b41719573f3668ce57706b11a2a533b914c76eb52cbade3f50786d94b4ccb31ae3
+  data.tar.gz: b62ef597f198e12f311487a2b6d5131ccdafbc771e9145913355b075ef27335cf0cd85213cc927993ae0d434bf54556ef3b00da5dbc31bd9451ac794cb0c39ee

data/.gitignore

@@ -0,0 +1 @@
+*.log

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+script: bundle exec rake test
+
+rvm:
+  - 2.0.0
+  - 2.1.0
+
+env:
+  global:
+    - secure: "naP+5ZG38Ie1/QGxMfrI9kLnGPnqRbIuNw0rFebCOcqeKj9MadBSSQjOi7c0gZBmNaV+js01R9U7RClNFWqHY+tGDWWlYL4gGDT0I2vIgCmnjGnIprD+iuS7ry1tISKjTOn7nfDvVxppK7R2xpuFFjrQgLmYyloPJMacT/n5E9Q="
+    - secure: "Q6wwGwwGfrKBEzoSwylLFjIKj8B5FNHoYEtEtivmHQYrqG+OyiL4YAOxFjpuaiWUJCYKeo6CWhTG9V0NVDgOZY54gxmJhqUpQCFZ53B1MylxANOykADOiXr5xHC9O2VBBF5OU1rkLL5fR8daA/pBOmoidXSD+Psn53ZWnReqZOc="
+
+addons:
+  sauce_connect: true
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Julien Portalier
+
+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,11 @@
+# Calliper
+
+Protractor for Ruby, or testing your Angular application with elegance.
+
+Thought this is only but a (working) hack for now.
+
+## Support
+
+It currently supports Rack and Rails applications with Minitest, but it should
+be possible to hack in support for other frameworks (eg: Sinatra, RSpec).
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+desc 'Test the Janus rack middleware.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**_test.rb'
+  t.verbose = true
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/calliper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/calliper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Julien Portalier"]
+  gem.email         = ["julien@portalier.com"]
+  gem.description   = gem.summary = "Protractor for Ruby, or testing your Angular application with elegance."
+  gem.homepage      = "http://github.com/ysbaddaden/calliper"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files | grep -Ev '^(Gemfile|test)'`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.name          = "calliper"
+  gem.require_paths = ["lib"]
+  gem.version       = Calliper::VERSION::STRING
+
+  gem.cert_chain    = ['certs/ysbaddaden.pem']
+  gem.signing_key   = File.expand_path('~/.ssh/gem-private_key.pem') if $0 =~ /gem\z/
+
+  gem.add_dependency 'selenium-webdriver'
+  gem.add_development_dependency 'rack'
+  gem.add_development_dependency 'minitest'
+end

data/certs/ysbaddaden.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZqdWxp
+ZW4xGTAXBgoJkiaJk/IsZAEZFglwb3J0YWxpZXIxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMTQwMTE0MjIzMTQ4WhcNMTUwMTE0MjIzMTQ4WjBBMQ8wDQYDVQQDDAZq
+dWxpZW4xGTAXBgoJkiaJk/IsZAEZFglwb3J0YWxpZXIxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDpxWuWRJXEz2+p
+2EW4NOPzkKloRLWoj+WQnqhQKT46GbH3ToDId8AMELTDIKpTQFiG2ty6D7S4IBFv
+7ceFKNk/EJc17mSYE1DzrtItor2/eeGC1zeNfvLjyDtyHKyKUZ891C1D0so5coUx
+2YbDW5npFkJkPaA5GneH7DFaCoIFLrD7ekbzaZAjlH+EH2fhd1XLhSsPEIiE+OnD
+ilWnsPoRJAZwQOiVAtvh7xuc+29uSNndIIm2rU00SxbJnzsAq9ZddwPpMU/UcQpD
+4gCBCaNGzrLz4+upQdYEOuggM7rR3P934qfhIwb+aRGglqdNunmUrdCuhsGXrxq2
+FvqwDvFZAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBQoESDCnNz3LmbpUzOrGeXOpk9sqjAfBgNVHREEGDAWgRRqdWxpZW5AcG9ydGFs
+aWVyLmNvbTAfBgNVHRIEGDAWgRRqdWxpZW5AcG9ydGFsaWVyLmNvbTANBgkqhkiG
+9w0BAQUFAAOCAQEAML4w0F/VF0gi5JqMqYSO05TakAauG8jQX0hov5H8M0Xhl79G
+BdUllH0QEw0cP6J2g46zAk0FGHIGthx0OKKi5YMYTs/KPqOVIAcJslt2sGIC1Ukm
+wpOWIg1XMe68+JVTktBKcBFAvc0pLtty1TgdSd2wr7KQgfmBU9I8G6AoPYhJOhkG
+SHTTSX3ms2/XePuSnyOfir/AQC7U0NalnKLNdwY9gkEdNwiTf5Ga/lZVDQ607bow
+KVqCN//9bevjMk5OiMi9X3Wu/GtVWDwC6OTWFWKd54KgbuWlakO8LC1SMmStnCIF
+W4qpyMWMZMcB4ZN/0mUVzY5xwrislBtsmQVUSw==
+-----END CERTIFICATE-----

data/lib/calliper.rb

@@ -0,0 +1,17 @@
+require 'selenium/webdriver'
+require 'calliper/config'
+require 'calliper/page'
+require 'calliper/server'
+require 'calliper/webdriver'
+require 'calliper/rails' if defined?(Rails)
+require 'calliper/minitest' if defined?(Minitest)
+
+module Calliper
+  def self.server?
+    false
+  end
+
+  def self.enable!
+    server.start
+  end
+end

data/lib/calliper/config.rb

@@ -0,0 +1,44 @@
+module Calliper
+  module Config
+    extend self
+
+    attr_accessor :application
+    attr_accessor :base_host
+    attr_accessor :base_url
+    attr_accessor :browser_name
+    attr_accessor :capabilities
+    attr_accessor :driver
+    attr_accessor :port
+    attr_accessor :remote_url
+
+    def base_url
+      @base_url ||= if base_host
+                      build_base_url_from_host
+                    else
+                      Calliper.server.url
+                    end
+    end
+
+    def browser_name
+      @browser_name ||= :firefox
+    end
+
+    private
+
+      def build_base_url_from_host
+        url = "http://#{base_host}"
+
+        if Calliper.server?
+          url + ":#{Calliper.server.port}"
+        elsif port
+          url + ":#{port}"
+        else
+          url
+        end
+      end
+  end
+
+  def self.setup
+    yield Config
+  end
+end

data/lib/calliper/minitest.rb

@@ -0,0 +1,11 @@
+begin
+  block = lambda do
+    Calliper.driver.quit if Calliper.driver?
+  end
+
+  if Minitest.respond_to?(:after_run)
+    Minitest.after_run(&block)
+  else
+    Minitest::Unit.after_tests(&block)
+  end
+end

data/lib/calliper/page.rb

@@ -0,0 +1,37 @@
+module Calliper
+  class Page
+    attr_writer :base_url
+
+    def self.get(*args)
+      page = new
+      page.get(*args)
+      page
+    end
+
+    def get(path, sync: true)
+      url = path =~ %r(^http://) ? path : "#{base_url}#{path}"
+      driver.get(url)
+
+      if sync
+        wait = Selenium::WebDriver::Wait.new(timeout: 10)
+        wait.until { driver.find_element(css: "[ng-app]") }
+      end
+    end
+
+    def base_url
+      @base_url ||= Config.base_url
+    end
+
+    def driver
+      Calliper.driver
+    end
+
+    def method_missing(method_name, *args)
+      if driver.respond_to?(method_name)
+        driver.__send__(method_name, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/calliper/rack.rb

@@ -0,0 +1,19 @@
+require 'calliper/server'
+
+module Calliper
+  def self.application
+    @app
+  end
+
+  def self.application=(app)
+    @app = app
+  end
+
+  def self.server
+    @server ||= Server.new(application)
+  end
+
+  def self.server?
+    !!@server
+  end
+end

data/lib/calliper/rails.rb

@@ -0,0 +1,2 @@
+require 'calliper/server'
+Calliper::Config.application = Rails.application

data/lib/calliper/server.rb

@@ -0,0 +1,60 @@
+require 'calliper/config'
+
+module Calliper
+  def self.server
+    @server ||= Server.new(Config.application)
+  end
+
+  def self.server?
+    !!@server
+  end
+
+  # NOTE: Borrows code from the fantastic Teaspoon gem:
+  #   http://github.com/modeset/teaspoon
+  class Server
+    attr_reader :application, :port, :logger
+
+    def initialize(application, port = Config.port, logger = nil)
+      @application = application
+      @port = port
+      @logger = logger
+    end
+
+    def start
+      @thread = Thread.new do
+        server = Rack::Server.new(rack_options)
+        server.start
+      end
+
+      Timeout.timeout(60) do
+        @thread.join(0.1) until responsive?
+      end
+    rescue Timeout::Error
+      raise "Server failed to start within 60 seconds."
+    rescue => e
+      raise "Cannot start server: #{e.message}"
+    end
+
+    def responsive?
+      return false if @thread && @thread.join(0)
+      TCPSocket.new('127.0.0.1', port).close
+      return true
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+      return false
+    end
+
+    def rack_options
+      {
+        app: application,
+        environment: 'test',
+        Port: port,
+        AccessLog: [],
+        Logger: logger
+      }
+    end
+
+    def url
+      "http://127.0.0.1:#{port}"
+    end
+  end
+end

data/lib/calliper/version.rb

@@ -0,0 +1,10 @@
+module Calliper
+  def self.version
+    Gem::Version.new File.read(File.expand_path('../../../VERSION', __FILE__))
+  end
+
+  module VERSION
+    MAJOR, MINOR, TINY, PRE = Calliper.version.segments
+    STRING = Calliper.version.to_s
+  end
+end

data/lib/calliper/webdriver.rb

@@ -0,0 +1,76 @@
+require 'socket'
+
+module Calliper
+  # TODO: connect to any remote server (eg: custom, saucelabs, browserstack)
+  # FIXME: only firefox quits correctly when used directly
+  def self.driver
+    @driver ||= if local_server_running?
+                  Selenium::WebDriver.for(:remote,
+                    url: "http://localhost:4444/wd/hub",
+                    desired_capabilities: { browserName: Config.driver.to_s }
+                  )
+                elsif Config.driver == :remote
+                  Selenium::WebDriver.for(:remote,
+                    url: Config.remote_url,
+                    desired_capabilities: Config.capabilities
+                  )
+                else
+                  Selenium::WebDriver.for(Config.driver)
+                end
+  end
+
+  def self.local_server_running?
+    begin
+      TCPSocket.new('localhost', 4444).close
+      true
+    rescue
+      false
+    end
+  end
+
+  def self.driver?
+    !!@driver
+  end
+end
+
+# We're hacking our way into WebDriver locators in order to emulate some
+# nice Protractor locators.
+#
+# FIXME: use real locators that use protractor's client-side finders:
+#   https://github.com/angular/protractor/blob/master/lib/clientsidescripts.js
+module Selenium::WebDriver::SearchContext
+  %i(find_element find_elements).each do |name|
+    alias_method "#{name}_without_angular", name
+
+    define_method name do |*args|
+      __send__("#{name}_without_angular", *angular_custom_locator(args))
+    end
+  end
+
+  private
+
+    def angular_custom_locator(args)
+      case args.size
+      when 2
+        how, what = args
+      when 1
+        how = args.first.keys.first
+        what = args.first[how]
+      else
+        return args
+      end
+
+      case how
+      when :model
+        [:css, angular_prefixes.map { |prefix| "[#{prefix}model='#{what}']"  }.join(", ")]
+      when :repeater
+        [:css, angular_prefixes.map { |prefix| "[#{prefix}repeat^='#{what}']"  }.join(", ")]
+      else
+        args
+      end
+    end
+
+    def angular_prefixes
+      @angular_prefixes ||= %w(ng- ng_ data-ng- x-ng- ng\\:)
+    end
+end

data/test/sample/application.rb

@@ -0,0 +1,22 @@
+require 'sinatra/base'
+require 'json'
+
+class SampleApplication < Sinatra::Base
+  configure do
+    disable :protection
+    disable :sessions
+    enable  :static
+
+    set :public_folder, File.expand_path('../public', __FILE__)
+    set :view, File.expand_path('../views', __FILE__)
+  end
+
+  get '/' do
+    erb :index
+  end
+
+  get '/notifications.json' do
+    content_type 'application/json'
+    (1..20).map { |id| { id: id, message: "this is notification ##{id}" } }.reverse.to_json
+  end
+end

data/test/sample/config.ru

@@ -0,0 +1,2 @@
+require './application'
+run SampleApplication