unobtainium 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7dfaed7fd3b12c6c2506ec09194c34f9939ef16
+  data.tar.gz: 535afb416ce0449d2d4a96bfc5a57cbcd8a93224
+SHA512:
+  metadata.gz: dec4e9b74f39c887ce315209cd340363eca9b02bc47e9637337b7195b1dabe467ee3a69e66f41fde71400afcfddfa1a453a83a1a9a757fb818f5a81ade292091
+  data.tar.gz: 8599bcf5b567faf0294cd6c1fbb820b06d64a61c413f4979427a3527ed39b97867d9cb4f891b63b55e7a2ea8cfa4aaa030b9803862a0961051b21a613bbe776e

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Editor files
+.*.sw*

data/.rubocop.yml

@@ -0,0 +1,54 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+# Metrics
+
+Metrics/LineLength:
+  Max: 83
+  Details: >-
+    Line length of 80 is ideal for readability and compatibility; we'll accept
+    an extra 3 for minor edge cases.
+
+Metrics/MethodLength:
+  Max: 35
+
+Metrics/BlockNesting:
+  Max: 5
+
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Style
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unobtainium.gemspec
+gemspec
+
+gem 'selenium-webdriver'
+gem 'appium_lib'

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    unobtainium (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appium_lib (8.0.2)
+      awesome_print (~> 1.6)
+      json (~> 1.8)
+      nokogiri (~> 1.6.6)
+      selenium-webdriver (~> 2.49)
+      tomlrb (~> 1.1)
+    ast (2.2.0)
+    awesome_print (1.6.1)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    ffi (1.9.10)
+    json (1.8.3)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    parser (2.3.0.7)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.7.5)
+    rubyzip (1.2.0)
+    selenium-webdriver (2.53.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    tomlrb (1.2.0)
+    unicode-display_width (1.0.3)
+    websocket (1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appium_lib
+  bundler (~> 1.11)
+  rubocop (~> 0.39)
+  selenium-webdriver
+  unobtainium!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) Jens Finkhaeuser (http://finkhaeuser.de/) and other unobtainum
+contributors. All rights not covered below are reserved.
+
+The MIT +no-false-attribs License (MITNFA)
+
+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.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+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,17 @@
+# unobtainium
+*Obtain the unobtainable: test code covering multiple platforms*
+
+Unobtainium wraps [Selenium](https://github.com/SeleniumHQ/selenium) and
+[Appium](https://github.com/appium/ruby_lib) in a simple driver abstraction
+so that test code can more easily cover:
+
+  - Desktop browsers
+  - Mobile browsers
+  - Mobile apps
+
+Some additional useful functionality for the maintenance of test suites is
+also added.
+
+# Credits
+This gem is inspired by [LapisLazuli](https://github.com/spriteCloud/lapis-lazuli),
+but vastly less complex, and aims to stay so.

data/lib/unobtainium.rb

@@ -0,0 +1,12 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+
+require 'unobtainium/version'
+
+require 'unobtainium/driver'

data/lib/unobtainium/driver.rb

@@ -0,0 +1,135 @@
+
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+module Unobtainium
+
+  ##
+  # Creating a Driver instance creates either an Appium or Selenium driver
+  # depending on the arguments, and delegates all else to the underlying
+  # implementation.
+  #
+  # It's possible to add more drivers, but Appium and Selenium are the main
+  # targets.
+  class Driver
+    ############################################################################
+    # Class methods
+    class << self
+      ##
+      # Create a driver instance with the given arguments
+      def create(*args)
+        Driver.new(*args)
+      end
+    end # class << self
+
+    ############################################################################
+    # Public methods
+    attr_reader :label, :options, :impl
+
+    ##
+    # Initializer
+    def initialize(*args)
+      # Sanitize options
+      @label, @options = sanitize_options(*args)
+
+      # Load drivers
+      load_drivers
+
+      # Determine the driver class, if any
+      driver_klass = get_driver(@label)
+      if not driver_klass
+        raise LoadError, "No driver implementation matching #{@label} found, "\
+          "aborting!"
+      end
+
+      # Perform precondition checks of the driver class
+      driver_klass.ensure_preconditions(@label, @options)
+
+      # Great, instanciate!
+      @impl = driver_klass.create(@label, @options)
+    end
+
+    private
+
+    # Class variables have their place, rubocop... still, err on the strict
+    # side and just skip this check here.
+    # rubocop:disable Style/ClassVars
+    @@drivers = {}
+    # rubocop:enable Style/ClassVars
+
+    # Methods that drivers must implement
+    DRIVER_METHODS = [
+      :matches?,
+      :ensure_preconditions,
+      :create
+    ].freeze
+
+    ##
+    # FIXME
+    def sanitize_options(*args)
+      load_drivers
+      require 'pp'
+      pp args
+    end
+
+    ##
+    # Load drivers.
+    def load_drivers
+      # TODO: add load path for external drivers, or let them be specified via
+      #       the driver environment/config variables.
+      pattern = File.join(File.dirname(__FILE__), 'drivers', '*.rb')
+      Dir.glob(pattern).each do |fpath|
+        # Determine class name from file name
+        fname = File.basename(fpath, '.rb')
+        fname = fname.split('_').map(&:capitalize).join
+
+        begin
+          require fpath
+          klassname = 'Unobtainium::Drivers::' + fname
+          klass = Object.const_get(klassname)
+          klass_methods = klass.methods - klass.instance_methods - Object.methods
+
+          if DRIVER_METHODS - klass_methods != []
+            raise LoadError, "Driver #{klassname} is not implementing all of "\
+              "#{DRIVER_METHODS}, aborting!"
+          end
+
+          if @@drivers.include?(klass) and @@drivers[klass] != fpath
+            raise LoadError, "Driver #{klassname} is duplicated in file "\
+              "'#{fpath}'; previous definition is here: "\
+              "'#{@@drivers[klass]}'"
+          end
+          @@drivers[klass] = fpath
+
+        rescue LoadError => err
+          raise LoadError, "#{err.message}: unknown problem loading driver, "\
+            "aborting!"
+        rescue NameError => err
+          raise LoadError, "#{err.message}: unknown problem loading driver, "\
+            "aborting!"
+        end
+      end
+    end
+
+    ##
+    # Out of the loaded drivers, returns the one matching the label (if any)
+    def get_driver(label)
+      # Of all the loaded classes, choose the first (unsorted) to match the
+      # requested driver label
+      impl = nil
+      @@drivers.keys.each do |klass|
+        if klass.matches?(label)
+          impl = klass
+          break
+        end
+      end
+
+      return impl
+    end
+  end # class Driver
+end # module Unobtainium

data/lib/unobtainium/drivers/appium.rb

@@ -0,0 +1,132 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+module Unobtainium
+  module Drivers
+
+    ##
+    # Driver implementation wrapping the appium_lib gem.
+    class Appium
+      # Recognized labels for matching the driver
+      LABELS = {
+        appium: [],
+        ios: [:iphone, :ipad],
+        android: [],
+      }.freeze
+
+      # Browser matches for some platforms
+      # TODO: add many more matches
+      BROWSER_MATCHES = {
+        android: {
+          chrome: {
+            appPackage: 'com.android.chrome',
+            appActivity: 'com.google.android.apps.chrome.Main',
+          },
+        },
+      }.freeze
+
+      class << self
+        ##
+        # Return true if the given label matches this driver implementation,
+        # false otherwise.
+        def matches?(label)
+          return nil != normalize_label(label)
+        end
+
+        ##
+        # Ensure that the driver's preconditions are fulfilled.
+        def ensure_preconditions(_, _)
+          require 'appium_lib'
+        rescue LoadError => err
+          raise LoadError, "#{err.message}: you need to add "\
+                "'appium_lib' to your Gemfile to use this driver!",
+                err.backtrace
+        end
+
+        ##
+        # Create and return a driver instance
+        def create(label, options)
+          # The label specifies the platform, if no other platform is given.
+          normalized = normalize_label(label)
+
+          if not options.is_a? Hash
+            options = {}
+          end
+          if not options['caps'].is_a? Hash
+            options['caps'] = {}
+          end
+
+          if options['caps']['platformName'].nil?
+            options['caps']['platformName'] = normalized.to_s
+          end
+
+          # If no app is given, but a browser is requested, we can supplement
+          # some information
+          options = supplement_browser(options)
+
+          # Create the driver
+          driver = ::Appium::Driver.new(options).start_driver
+          return driver
+        end
+
+        private
+
+        ##
+        # For a recognized label alias, returns a normalized label.
+        def normalize_label(label)
+          LABELS.each do |normalized, aliases|
+            if label == normalized or aliases.include?(label)
+              return normalized
+            end
+          end
+          return nil
+        end
+
+        ##
+        # If the driver options include a request for a browser, we can
+        # supplement some missing specs in the options.
+        def supplement_browser(options)
+          # Can't do anything without a browser request.
+          if options['browser'].nil?
+            return options
+          end
+          browser = options['browser'].downcase.to_sym
+
+          # Platform
+          platform = options['caps']['platformName'].to_s.downcase.to_sym
+
+          # If we have supplement data matching the platform and browser, great!
+          data = BROWSER_MATCHES[platform][browser]
+          if data.nil?
+            return options
+          end
+
+          # We do have to check that we're not overwriting any of the keys.
+          data.keys.each do |key|
+            key_s = key.to_s
+            if not options['caps'].key?(key) and not options['caps'].key?(key_s)
+              next
+            end
+            raise ArgumentError, "You specified the browser option as, "\
+              "'#{options['browser']}', but you also have the key "\
+              "'#{key}' set in your requested capabilities. Use one or the"\
+              "other."
+          end
+
+          # Merge, but also stringify symbol keys
+          data.each do |key, value|
+            options['caps'][key.to_s] = value
+          end
+
+          options
+        end
+      end # class << self
+    end # class Selenium
+
+  end # module Drivers
+end # module Unobtainium

data/lib/unobtainium/drivers/selenium.rb

@@ -0,0 +1,65 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+module Unobtainium
+  module Drivers
+
+    ##
+    # Driver implementation wrapping the selenium-webdriver gem.
+    class Selenium
+      # Recognized labels for matching the driver
+      LABELS = {
+        firefox: [:ff,],
+        internet_explorer: [:internetexplorer, :explorer, :ie,],
+        safari: [],
+        chrome: [],
+        chromium: [],
+      }.freeze
+
+      class << self
+        ##
+        # Return true if the given label matches this driver implementation,
+        # false otherwise.
+        def matches?(label)
+          return nil != normalize_label(label)
+        end
+
+        ##
+        # Ensure that the driver's preconditions are fulfilled.
+        def ensure_preconditions(_, _)
+          require 'selenium-webdriver'
+        rescue LoadError => err
+          raise LoadError, "#{err.message}: you need to add "\
+                "'selenium-webdriver' to your Gemfile to use this driver!",
+                err.backtrace
+        end
+
+        ##
+        # Create and return a driver instance
+        def create(label, _)
+          driver = ::Selenium::WebDriver.for(normalize_label(label))
+          return driver
+        end
+
+        private
+
+        ##
+        # For a recognized label alias, returns a normalized label.
+        def normalize_label(label)
+          LABELS.each do |normalized, aliases|
+            if label == normalized or aliases.include?(label)
+              return normalized
+            end
+          end
+          return nil
+        end
+      end # class << self
+    end # class Selenium
+
+  end # module Drivers
+end # module Unobtainium

data/lib/unobtainium/version.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+module Unobtainium
+  VERSION = "0.0.1".freeze
+end

data/unobtainium.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+#
+# unobtainium
+# https://github.com/jfinkhaeuser/unobtainium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other unobtainium contributors.
+# All rights reserved.
+#
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unobtainium/version'
+
+# rubocop:disable Style/UnneededPercentQ, Style/ExtraSpacing
+# rubocop:disable Style/SpaceAroundOperators
+Gem::Specification.new do |spec|
+  spec.name          = "unobtainium"
+  spec.version       = Unobtainium::VERSION
+  spec.authors       = ["Jens Finkhaeuser"]
+  spec.email         = ["jens@finkhaeuser.de"]
+  spec.description   = %q(
+    Unobtainium wraps Selenium and Appium in a simple driver abstraction so that
+    test code can more easily cover:
+
+      - Desktop browsers
+      - Mobile browsers
+      - Mobile apps
+
+    Some additional useful functionality for the maintenance of test suites is
+    also added.
+  )
+  spec.summary       = %q(
+    Obtain the unobtainable: test code covering multiple platforms
+  )
+  spec.homepage      = "https://github.com/jfinkhaeuser/unobtainium"
+  spec.license       = "MITNFA"
+
+  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.11"
+  spec.add_development_dependency "rubocop", "~> 0.39"
+end
+# rubocop:enable Style/SpaceAroundOperators
+# rubocop:enable Style/UnneededPercentQ, Style/ExtraSpacing

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: unobtainium
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jens Finkhaeuser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+description: "\n    Unobtainium wraps Selenium and Appium in a simple driver abstraction
+  so that\n    test code can more easily cover:\n\n      - Desktop browsers\n      -
+  Mobile browsers\n      - Mobile apps\n\n    Some additional useful functionality
+  for the maintenance of test suites is\n    also added.\n  "
+email:
+- jens@finkhaeuser.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/unobtainium.rb
+- lib/unobtainium/driver.rb
+- lib/unobtainium/drivers/appium.rb
+- lib/unobtainium/drivers/selenium.rb
+- lib/unobtainium/version.rb
+- unobtainium.gemspec
+homepage: https://github.com/jfinkhaeuser/unobtainium
+licenses:
+- MITNFA
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: 'Obtain the unobtainable: test code covering multiple platforms'
+test_files: []
+has_rdoc: