locution-sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daf978e5d08a0e9b16b6ad8ceacceaa59b04cc33
-  data.tar.gz: d96796664091584803b099e31194575256f1a96f
+  metadata.gz: 06840405aeef0508666e777619ca3cc8bd79b6b7
+  data.tar.gz: b0facd57a104ed7b79029622330c78fbe6788ed6
 SHA512:
-  metadata.gz: ede25c8ae83372bd1ef4b04863672daec7a57eb0755a84db2178f3a8bedc1ebc0c181aa80f25d2f7e84420e71769c6f9bfce036de6f24295a8703d2db04d3b51
-  data.tar.gz: d2ac9f2e845da997e9ef7efb3fb8394173d6e3f86be5b1b3123c041ffed86b5c5260e4ba174063654d9da8548aba53cac18da001f79a221cde1df04a4e22d4c3
+  metadata.gz: 07902190ed72416874804827facf02d71c057596b87c77fa1eaa6fd4008d302e5156711bc6b9c764c512db9049235604d06e654a5eca6bfe958ddeadfd53e64d
+  data.tar.gz: e1b2b251e2708bac4b309f10ce92188642ff05036ab960e1f8f5704aa3c7cc0c5cfb7ffe81f7643f749e9211ba5be4eabf953a90d3a679e9cd7a850575f632ec

data/README.md

@@ -1,8 +1,6 @@
 # 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
+Find out how reliable your existing Selenium tests are by automatically grading your locators against a battle-tested and curated set of heuristics.
 
 ## Installation
 
@@ -22,13 +20,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Locution works by using Selenium's Abstract Event Listener. You just need to create a new instance of our listener and pass it as an argument to Selenium when creating a browser instance.
+
+You just need to provide your API Access Token (which is listed on your Account page) and the test name (which should be available dynamically through your test runner).
+
+### A Simple Example
+
+```ruby
+require 'locution-sdk'
+
+listener = Locution::Sdk::Listener.new('your-access-token', 'your-test-name')
+@driver = Selenium::WebDriver.for :firefox, listener: listener)
+```
 
-## Development
+### An RSpec Example
 
-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.
+```ruby
+require 'locution-sdk'
 
-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).
+RSpec.configure do |config|
+
+  config.before(:each) do |example|
+    listener = Locution::Sdk::Listener.new('your-access-token', example.metadata[:full_description])
+    @driver = Selenium::WebDriver.for :firefox, listener: listener)
+  end
+end
+```
+
+### A Cucumber Example
+
+```ruby
+require 'locution-sdk'
+
+Before do |scenario|
+  test_name = "#{scenario.feature.name} - #{scenario.name}"
+  listener = Locution::Sdk::Listener.new('your-access-token', test_name)
+  @driver = Selenium::WebDriver.for :firefox, listener: listener)
+end
+```
 
 ## Contributing
 

data/lib/locution/sdk/version.rb

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

data/locution-sdk.gemspec

@@ -9,19 +9,10 @@ Gem::Specification.new do |spec|
   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.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 heuristics.}
   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"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locution-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dave Haeffner
@@ -67,7 +67,7 @@ dependencies:
       - !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
+  grading your locators against a battle-tested and curated set of heuristics.
 email:
 - dhaeffner@gmail.com
 executables: []
@@ -106,5 +106,5 @@ 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
+summary: An SDK to connect your Selenium tests to Locution to get your tests graded.
 test_files: []