locution-sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf978e5d08a0e9b16b6ad8ceacceaa59b04cc33
+  data.tar.gz: d96796664091584803b099e31194575256f1a96f
+SHA512:
+  metadata.gz: ede25c8ae83372bd1ef4b04863672daec7a57eb0755a84db2178f3a8bedc1ebc0c181aa80f25d2f7e84420e71769c6f9bfce036de6f24295a8703d2db04d3b51
+  data.tar.gz: d2ac9f2e845da997e9ef7efb3fb8394173d6e3f86be5b1b3123c041ffed86b5c5260e4ba174063654d9da8548aba53cac18da001f79a221cde1df04a4e22d4c3

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dave Haeffner
+
+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,41 @@
+# Locution::Sdk
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/locution/sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'locution-sdk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install locution-sdk
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/locution-sdk.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/locution-sdk.rb

@@ -0,0 +1,2 @@
+require 'locution/sdk/version'
+require 'locution/sdk/listener'

data/lib/locution/sdk/listener.rb

@@ -0,0 +1,64 @@
+require 'selenium-webdriver'
+require 'rest-client'
+
+module Locution
+  module Sdk
+    class Listener < ::Selenium::WebDriver::Support::AbstractEventListener
+
+      def initialize(access_token, test_name = "not provided", base_url = 'http://locution.herokuapp.com')
+        @base_url = base_url
+        @access_token = access_token
+        response = ::RestClient.post "#{@base_url}/tests", {
+          access_token: access_token,
+          test_name: test_name,
+          start_time: Time.now
+        }
+        @test_id = response.body
+      end
+
+      def before_find(by, what, driver)
+        @number_of_elements_found = driver.execute_script("return #{get_javascript(by, what)}")
+        @locator_start_time = Time.now
+      end
+
+      def after_find(by, what, driver)
+        ::RestClient.post "#{@base_url}/tests/#{@test_id}/locators", {
+          access_token: @access_token,
+          locator_value: "#{by}, #{what}",
+          locator_count: @number_of_elements_found,
+          start_time: @locator_start_time,
+          end_time: Time.now
+        }
+      end
+
+      def after_quit(driver)
+        ::RestClient.put "#{@base_url}/tests/#{@test_id}", {
+          access_token: @access_token,
+          end_time: Time.now
+        }
+      end
+
+      private
+
+      def get_javascript(by, what)
+        if by.include? 'id'
+          "document.querySelectorAll('##{what}').length"
+        elsif by.include? 'class'
+          "document.getElementsByClassName('#{what}').length"
+        elsif by.include? 'tag'
+          "document.getElementsByTagName('#{what}').length"
+        elsif by.include? 'name'
+          "document.getElementsByName('#{what}').length"
+        elsif by.include? 'css'
+          "document.querySelectorAll('#{what}').length"
+        elsif by.include? 'xpath'
+          "document.evaluate(\"#{what}\", document.documentElement, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null).snapshotLength"
+        elsif by.include? 'text'
+          what = "//a[contains(text(),'#{what}')]"
+          "document.evaluate(\"#{what}\", document.documentElement, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null).snapshotLength"
+        end
+      end
+
+    end
+  end
+end

data/lib/locution/sdk/version.rb

@@ -0,0 +1,5 @@
+module Locution
+  module Sdk
+    VERSION = '0.1.0'
+  end
+end

data/locution-sdk.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locution/sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locution-sdk"
+  spec.version       = Locution::Sdk::VERSION
+  spec.authors       = ["Dave Haeffner"]
+  spec.email         = ["dhaeffner@gmail.com"]
+
+  spec.summary       = %q{An SDK to connect your Selenium tests to Locution to get your tests graded}
+  spec.description   = %q{Find out how reliable your existing Selenium tests are by automatically grading your locators against a battle-tested and curated set of best-practices}
+  spec.homepage      = "https://rubygems.org/gems/locution-sdk"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "selenium-webdriver", "~> 2.53.4"
+  spec.add_dependency "rest-client", "~> 2.0.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: locution-sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Haeffner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.53.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.53.4
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: Find out how reliable your existing Selenium tests are by automatically
+  grading your locators against a battle-tested and curated set of best-practices
+email:
+- dhaeffner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/locution-sdk.rb
+- lib/locution/sdk/listener.rb
+- lib/locution/sdk/version.rb
+- locution-sdk.gemspec
+homepage: https://rubygems.org/gems/locution-sdk
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: An SDK to connect your Selenium tests to Locution to get your tests graded
+test_files: []