webdriver_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7677bbe78788e01f7eacec87fc247829a5a55968
+  data.tar.gz: acd6dd72a257c110468ea7503afa9bb8c4c053df
+SHA512:
+  metadata.gz: af079cad1c149027b36063f93b400ec5eb521d1001ec78843e669a67c17def14a8b84305ee785473820db0979a125511479d70cf7029898242ef666b806d6f58
+  data.tar.gz: c1054ad6c585ddef438545f0c0a93712c73425386809617d1d76c4e1ec36520799b75019cab7278144412dac0bb123cf6ffbcc00a16d0f086b85f3f90d538323

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+spec/actual_stub/
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/Rakefile

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

data/Thorfile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'appium_thor'
+
+Appium::Thor::Config.set do
+  gem_name 'webdriver_utils'
+  github_owner 'bootstraponline'
+end
+
+# Must use '::' otherwise Default will point to Thor::Sandbox::Default
+# Debug by calling Thor::Base.subclass_files via Pry
+#
+# https://github.com/erikhuda/thor/issues/484
+#
+class ::Default < Thor
+  desc 'spec', 'Run RSpec tests'
+  def spec
+    exec 'rspec spec'
+  end
+end

data/lib/webdriver_utils/page.rb

@@ -0,0 +1,22 @@
+module WebDriverUtils
+  class << self
+    def require_all_pages glob_path=nil
+      glob_path ||= File.join(Rake.application.original_dir, 'page', '**', '*.rb')
+      Dir.glob(glob_path) { |file| require_relative file }
+    end
+
+    def define_page_methods opts={}
+      page_module   = opts[:page_module] || raise('must set page_module')
+      target_class  = opts[:target_class] || raise('must set target_class')
+      driver_object = opts[:driver] || raise('must set driver')
+      page_module.constants.each do |page_class|
+        # ButtonsPage => buttons_page
+        # https://github.com/rails/rails/blob/daaa21bc7d20f2e4ff451637423a25ff2d5e75c7/activesupport/lib/active_support/inflector/methods.rb#L96
+        page_name = page_class.to_s.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+        target_class.send(:define_singleton_method, page_name) do
+          page_module.const_get(page_class).new driver_object
+        end
+      end
+    end
+  end # class << self
+end # module WebDriverUtils

data/lib/webdriver_utils/sauce.rb

@@ -0,0 +1,17 @@
+# top level sauce helper methods
+
+def sauce_user
+  ENV['SAUCE_USERNAME']
+end
+
+def sauce_key
+  ENV['SAUCE_ACCESS_KEY']
+end
+
+def sauce?
+  sauce_user && sauce_key
+end
+
+def jenkins?
+  !!ENV['JENKINS_SERVER_COOKIE']
+end

data/lib/webdriver_utils/silence_gem_warnings.rb

@@ -0,0 +1,11 @@
+module WebDriverUtils
+  class << self
+    def silence_gem_warnings
+      # https://github.com/appium/ruby_console/blob/1049c515432212f164cfbabd413d6e3d82e4aada/lib/appium_console.rb#L5
+      Gem::Specification.class_eval do
+        def self.warn args
+        end
+      end
+    end
+  end # class << self
+end # module WebDriverUtils

data/lib/webdriver_utils/version.rb

@@ -0,0 +1,4 @@
+module WebDriverUtils
+  VERSION = '0.0.1' unless defined? ::WebDriverUtils::VERSION
+  DATE    = '2015-05-10' unless defined? ::WebDriverUtils::DATE
+end

data/lib/webdriver_utils/wait.rb

@@ -0,0 +1,111 @@
+# https://github.com/SeleniumHQ/selenium/blob/b12ff650686cd88a0709f6181a015dad1062591e/rb/lib/selenium/webdriver/common/wait.rb
+#
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module WebDriverUtils
+  class Wait
+
+    DEFAULT_TIMEOUT  = 5
+    DEFAULT_INTERVAL = 0.2
+
+    #
+    # Create a new Wait instance
+    #
+    # @param [Hash] opts Options for this instance
+    # @option opts [Numeric] :timeout (5) Seconds to wait before timing out.
+    # @option opts [Numeric] :interval (0.2) Seconds to sleep between polls.
+    # @option opts [String] :message Exception mesage if timed out.
+    # @option opts [Array, Exception] :ignore Exceptions to ignore while polling (default: Error::NoSuchElementError)
+    #
+
+    def initialize(opts = {})
+      # Validate all options to prevent typos such as 'ignored'
+      # instead of 'ignore'
+
+      # code from my appium gem
+      # https://github.com/appium/ruby_lib/blob/252e83806318df7df28e9060d3f8e1e56dc732ba/lib/appium_lib/common/wait.rb#L10
+      valid_keys   = [:timeout, :interval, :message, :ignore]
+      invalid_keys = []
+      opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
+      # [:one, :two] => :one, :two
+      fail "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}" unless invalid_keys.empty?
+
+      @timeout  = opts.fetch(:timeout, DEFAULT_TIMEOUT)
+      @interval = opts.fetch(:interval, DEFAULT_INTERVAL)
+      @message  = opts[:message]
+      @ignored  = Array(opts[:ignore] || ::Selenium::WebDriver::Error::NoSuchElementError)
+    end
+
+    #
+    # Wait until the given block returns a true value.
+    #
+    # @raise [Error::TimeOutError]
+    # @return [Object] the result of the block
+    #
+
+    def until(&blk)
+      end_time   = Time.now + @timeout
+      last_error = nil
+
+      until Time.now > end_time
+        begin
+          result = yield
+          return result if result
+        rescue *@ignored => last_error
+          # swallowed
+        end
+
+        sleep @interval
+      end
+
+
+      if @message
+        msg = @message.dup
+      else
+        msg = "timed out after #{@timeout} seconds"
+      end
+
+      msg << " (#{last_error.message})" if last_error
+
+      raise ::Selenium::WebDriver::Error::TimeOutError, msg
+    end
+
+  end # class Wait
+end # module WebDriverUtils
+
+#
+# Define generic top level wait method
+#
+# Wait until the block returns a truthy value.
+#
+# See wait class above for docs
+#
+
+def wait opts={}, &block
+  timeout        = opts.fetch(:timeout, 30)
+  interval       = opts.fetch(:interval, 0.2)
+  message        = opts[:message]
+  ignored        = Array(opts[:ignore])
+  default_ignore = [Exception, RSpec::Expectations::ExpectationNotMetError]
+  ignored        = default_ignore if ignored.empty?
+
+  WebDriverUtils::Wait.new(timeout:  timeout,
+                           interval: interval,
+                           message:  message,
+                           ignore:   ignored).until &block
+end

data/lib/webdriver_utils.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+
+require_relative 'webdriver_utils/page'
+require_relative 'webdriver_utils/sauce'
+require_relative 'webdriver_utils/silence_gem_warnings'
+require_relative 'webdriver_utils/version'
+require_relative 'webdriver_utils/wait'
+
+WebDriverUtils.silence_gem_warnings

data/readme.md

@@ -0,0 +1,16 @@
+# webdriver_utils
+
+WebDriver utility methods.
+
+- `require 'webdriver_utils'`
+
+method | description
+   --- | ---
+**sauce_user**                         | returns ENV['SAUCE_USERNAME']
+**sauce_key**                          | returns ENV['SAUCE_ACCESS_KEY']
+**sauce?**                             | returns true if both sauce_user and sauce_key are true
+**jenkins?**                           | returns true if running on jenkins
+**WebDriverUtils.require_all_pages**   | requires all page files from Rakefile root dir
+**WebDriverUtils.define_page_methods** | defines page methods
+**wait**                               | generic wait until truthy method
+**WebDriverUtils::Wait.new**           | selenium webdriver wait with extra validation

data/webdriver_utils.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/webdriver_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.name    = 'webdriver_utils'
+  spec.version = WebDriverUtils::VERSION
+  spec.date    = WebDriverUtils::DATE
+  spec.license = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+  spec.authors = spec.email = ['code@bootstraponline.com']
+
+  spec.summary     = spec.description = 'WebDriver utility methods'
+  spec.description += '.' # avoid identical warning
+  spec.homepage    = 'https://github.com/bootstraponline/webdriver_utils'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'appium_thor', '~> 0.0.7'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: webdriver_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- code@bootstraponline.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: appium_thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: WebDriver utility methods.
+email:
+- code@bootstraponline.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- Rakefile
+- Thorfile
+- lib/webdriver_utils.rb
+- lib/webdriver_utils/page.rb
+- lib/webdriver_utils/sauce.rb
+- lib/webdriver_utils/silence_gem_warnings.rb
+- lib/webdriver_utils/version.rb
+- lib/webdriver_utils/wait.rb
+- readme.md
+- webdriver_utils.gemspec
+homepage: https://github.com/bootstraponline/webdriver_utils
+licenses:
+- http://www.apache.org/licenses/LICENSE-2.0.txt
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: WebDriver utility methods
+test_files: []
+has_rdoc: