web_minion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf7a988efff88355bcdc557cdf6824061e883bbd
+  data.tar.gz: 43361685a55294c9d4c21f13d5bd273b749fe5e7
+SHA512:
+  metadata.gz: fdb3412034e560b84953577ecf12f11962c41f402d442df73a81016bf73beee5f133b395f0cdadc85631f93223364d8165b0e2a86737bba9dc63d8096ff0a2f1
+  data.tar.gz: acfee494e048cd9f65f05ddffc5b381f4a8af92bb6ba9b8163d5daf353a09710323bc20dadfb5e5edd212984d092c7c6b6a7d0b4f7883c5a04d9f1f59b34640c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,243 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.2.5
+  - 2.1.9
+  - 2.0.0
+  - 1.9.3-p551
+  - ruby-head

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at aparrish@jibe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gem "mechanize"
+
+group :development do
+  gem "pry"
+end
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "coveralls", require: false
+end
+
+# Specify your gem"s dependencies in web_minion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Andrew Parrish
+
+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,102 @@
+# WebMinion
+- [![Build](http://img.shields.io/travis-ci/jibeinc/web_minion.svg?style=flat-square)](https://travis-ci.org/jibeinc/web_minion)
+- [![Quality](http://img.shields.io/codeclimate/github/jibeinc/web_minion.svg?style=flat-square)](https://codeclimate.com/github/jibeinc/web_minion)
+- [![Coveralls](https://img.shields.io/coveralls/jibeinc/web_minion.svg?style=flat-square)](https://img.shields.io/coveralls/jibeinc/web_minion.svg)
+- [![Issues](http://img.shields.io/github/issues/jibeinc/web_minion.svg?style=flat-square)](http://github.com/jibeinc/web_minion/issues)
+- [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](http://opensource.org/licenses/MIT)
+
+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/web_minion`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'web_minion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install web_minion
+
+## Usage
+
+### Sample Flow
+
+Here's a sample login flow:
+
+    {
+      "config": {},
+      "flow": {
+        "name": "Login Flow",
+        "actions": [
+          {
+            "name": "Login",
+            "key": "load_login_page",
+            "starting": true,
+            "steps":
+            [
+              {
+                "name": "Go to accounts login page",
+                "target": "https://example.com/login",
+                "method": "go"
+              },
+              {
+                "name": "Get login form",
+                "method": "get_form",
+                "target": {
+                  "name": "login"
+                }
+              },
+              {
+                "name": "Fill in email",
+                "method": "fill_in_input",
+                "retain_element": true,
+                "target": {
+                  "id": "email"
+                },
+                "value": "PUT USERNAME HERE"
+              },
+              {
+                "name": "Fill in password",
+                "method": "fill_in_input",
+                "retain_element": true,
+                "target": {
+                  "id": "password"
+                },
+                "value": "PUT PASSWORD HERE"
+              },
+              {
+                "name": "Submit login",
+                "method": "submit"
+              },
+              {
+                "name": "Verify logged in page",
+                "is_validator": true,
+                "method": "body_includes",
+                "value": "Welcome Back"
+              }
+            ]
+          }
+        ]
+      }
+    }
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jibeinc/web_minion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "web_minion"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/jibe_ruleset_bot/version.rb

@@ -0,0 +1,3 @@
+module WebMinion
+  VERSION = "0.1.0".freeze
+end

data/lib/web_minion.rb

@@ -0,0 +1,6 @@
+require "web_minion/bots/bot"
+require "web_minion/bots/mechanize_bot"
+require "web_minion/step"
+require "web_minion/action"
+require "web_minion/flow"
+require "web_minion/histories/history"

data/lib/web_minion/action.rb

@@ -0,0 +1,73 @@
+require "web_minion/step"
+
+module WebMinion
+  # Represents a group of steps that the bot can perform and valdiate have
+  # performed as expected
+  class Action
+    attr_reader :name, :key, :steps, :starting_action
+    attr_accessor :on_success, :on_failure
+
+    def initialize(fields = {})
+      @name = fields[:name]
+      @key = fields[:key] || @name
+      @starting_action = fields[:starting]
+      @on_success = fields[:on_success]
+      @on_failure = fields[:on_failure]
+      send("steps=", fields[:steps])
+    end
+
+    def self.build_from_hash(fields = {})
+      steps = fields["steps"].map { |step| Step.new(step) }
+      starting = (fields["starting"] || "false") == "false" ? false : true
+      new(name: fields["name"], steps: steps, key: fields["key"],
+          starting: starting, on_success: fields["on_success"],
+          on_failure: fields["on_failure"])
+    end
+
+    def starting_action?
+      @starting_action
+    end
+
+    def ending_action?
+      @on_success.nil?
+    end
+
+    def next_actions
+      [on_success, on_failure].compact
+    end
+
+    def generate_edges(all_actions)
+      @on_success = all_actions[on_success]
+      @on_failure = all_actions[on_failure]
+    end
+
+    def steps=(steps)
+      unless steps.last.validator?
+        warn "WARNING: Action: #{@name}'s final step is not a validation step!"
+        warn "An action can not confirm its success without a validation step!"
+      end
+      @steps = steps
+    end
+
+    # Again, boilerplate for initial setup
+    def perform(bot)
+      element = nil
+      status = @steps.map do |step|
+        if step.validator?
+          step.perform(bot, element)
+        else
+          if step.retain?
+            step.perform(bot, element)
+          else
+            element = step.perform(bot, element)
+          end
+          nil
+        end
+      end
+      !status.reject(&:nil?).include?(false)
+    rescue StandardError => e
+      puts e
+      return false
+    end
+  end
+end

data/lib/web_minion/bots/bot.rb

@@ -0,0 +1,14 @@
+module WebMinion
+  class Bot
+    attr_reader :config
+    attr_accessor :bot
+
+    def initialize(config = {})
+      @config = config
+    end
+
+    def execute_step(method, target, value = nil, element = nil)
+      method(method).call(target, value, element)
+    end
+  end
+end

data/lib/web_minion/bots/mechanize_bot.rb

@@ -0,0 +1,109 @@
+require "mechanize"
+require "web_minion/bots/bot"
+
+class MultipleOptionsFoundError < StandardError; end
+class NoInputFound < StandardError; end
+# Mechanize driven bot. More efficient, but can"t handle any dynamic js-driven
+# pages
+module WebMinion
+  class MechanizeBot < WebMinion::Bot
+    def initialize(config = {})
+      super(config)
+      @bot = Mechanize.new
+    end
+
+    def page
+      @bot.page
+    end
+
+    def body
+      page.body.to_s
+    end
+
+    def go(target, _value, _element)
+      @bot.get(target)
+    end
+
+    def click(target, _value, _element)
+      button = @bot.page.at(target)
+      @bot.click(button)
+    end
+
+    def click_button_in_form(target, _value, element)
+      element.button_with(target).click
+    end
+
+    def save_page_html(_target, value, _element)
+      write_html_file(value)
+    end
+
+    ## FORM METHODS ##
+    # Must have an element passed to them (except get form)
+
+    def get_form_in_index(target, _value, _element)
+      @bot.page.forms[target]
+    end
+
+    def get_form(target, _value, _element)
+      @bot.page.form_with(target)
+    end
+
+    def get_field(target, _value, element)
+      element.field_with(target)
+    end
+
+    def fill_in_input(target, value, element)
+      input = element[target]
+      raise(NoInputFound, "For target: #{target}") unless input
+      element[target] = value
+      element
+    end
+
+    # Element should be an instance of a form
+    def submit(_target, _value, element)
+      @bot.submit element
+    end
+
+    def select_field(target, _value, element)
+      options = element.options_with(target)
+      raise(MultipleOptionsFoundError, "For target: #{target}") if options.count > 1
+      options.first.click
+    end
+
+    def select_checkbox(target, _value, element)
+      element.checkbox_with(target).check
+    end
+
+    def select_radio_button(target, _value, element)
+      radio = element.radiobutton_with(target)
+      radio.checked = true
+      radio
+    end
+
+    def select_first_radio_button(_target, _value, element)
+      radio = element.radiobuttons.first
+      radio.checked = true
+      radio
+    end
+
+    ## VALIDATION METHODS ##
+
+    def url_equals(_target, value, _element)
+      !!(@bot.page.uri.to_s == value)
+    end
+
+    def body_includes(_target, value, _element)
+      !!(body.index(value) && body.index(value) > 0)
+    end
+
+    def value_equals(_target, value, element)
+      !!(element && (element.value == value))
+    end
+
+    private
+
+    def write_html_file(filename)
+      File.open(filename, "w") { |f| f.puts body }
+    end
+  end
+end

data/lib/web_minion/cycle_checker.rb

@@ -0,0 +1,35 @@
+module WebMinion
+  class CycleChecker
+    attr_accessor :checked, :on_stack, :actions, :starting_action, :cyclical
+
+    def initialize(starting_action)
+      @checked = []
+      @on_stack = []
+      @starting_action = starting_action
+      @cyclical = false
+      check_for_cycle(starting_action)
+    end
+
+    def cycle?
+      @cyclical && !@cyclical.nil?
+    end
+
+    private
+
+    def check_for_cycle(action)
+      @checked << action
+      @on_stack << action
+
+      action.next_actions.each do |act|
+        if !@checked.include?(act)
+          check_for_cycle(act)
+        elsif @on_stack.include?(act)
+          @cyclical = true
+          return nil
+        end
+      end
+
+      @on_stack.delete(action)
+    end
+  end
+end

data/lib/web_minion/flow.rb

@@ -0,0 +1,101 @@
+require "json"
+require "web_minion/bots/mechanize_bot"
+require "web_minion/action"
+require "web_minion/cycle_checker"
+require "web_minion/histories/flow_history"
+require "web_minion/histories/action_history"
+
+module WebMinion
+  # A flow represents the top level watcher of a series of actions that are to
+  # be performed. It tracks the sucess or failure, where to go next given an
+  # outcome, and a history of all actions performed.
+  class Flow
+    class NoStartingActionError < StandardError; end
+    class CyclicalFlowError < StandardError; end
+
+    attr_accessor :actions, :bot, :history
+    attr_writer :name
+    attr_reader :curr_action, :starting_action
+
+    def initialize(actions, bot, name = "")
+      @actions = actions
+      @bot = bot
+      @name = name
+      @history = nil
+    end
+
+    def self.build_via_json(rule_json)
+      ruleset = JSON.parse(rule_json)
+      bot = MechanizeBot.new(ruleset["config"])
+      build_from_hash(ruleset["flow"].merge(bot: bot))
+    end
+
+    def self.build_from_hash(fields = {})
+      flow = new([], nil, nil)
+      fields.each_pair do |k, v|
+        flow.send("#{k}=", v)
+      end
+      flow
+    end
+
+    def actions=(actions)
+      @actions = {}
+      actions.each do |act|
+        action = Action.build_from_hash(act)
+        @actions[action.key] = action
+        @starting_action = action if action.starting_action?
+      end
+
+      set_next_actions
+      validate_actions
+    end
+
+    def all_actions
+      @actions.values
+    end
+
+    def perform
+      @history = FlowHistory.new
+      status = execute_action(@starting_action)
+      @history.end_time = Time.now
+      @history.status = status
+      @history
+    end
+
+    private
+
+    def execute_action(action)
+      @curr_action = action
+      @history.action_history << ActionHistory.new(action.name, action.key)
+      status = action.perform(@bot)
+      update_action_history(status)
+      if status
+        action.ending_action? ? true : execute_action(action.on_success)
+      else
+        action.on_failure ? execute_action(action.on_failure) : false
+      end
+    end
+
+    def update_action_history(status)
+      @history.action_history.last.end_time = Time.now
+      @history.action_history.last.status = status
+    end
+
+    def set_next_actions
+      all_actions.each { |act| act.generate_edges(@actions) }
+    end
+
+    def validate_actions
+      if all_actions.count(&:starting_action?) == 0
+        raise(NoStartingActionError, "Flow: #{@name} has no starting action!")
+      end
+
+      if CycleChecker.new(@starting_action).cycle?
+        raise(CyclicalFlowError,
+              "Flow: #{@name} is cyclical and could enter an infinite loop")
+      end
+
+      true
+    end
+  end
+end

data/lib/web_minion/histories/action_history.rb

@@ -0,0 +1,13 @@
+require "web_minion/histories/action_history"
+
+module WebMinion
+  class ActionHistory < WebMinion::History
+    attr_reader :action_name, :action_key
+
+    def initialize(action_name, action_key)
+      super()
+      @action_name = action_name
+      @action_key = action_key
+    end
+  end
+end

data/lib/web_minion/histories/flow_history.rb

@@ -0,0 +1,12 @@
+require "web_minion/histories/history"
+
+module WebMinion
+  class FlowHistory < WebMinion::History
+    attr_reader :action_history
+
+    def initialize
+      super()
+      @action_history = []
+    end
+  end
+end

data/lib/web_minion/histories/history.rb

@@ -0,0 +1,21 @@
+module WebMinion
+  # Histories are used to log the events as the bot performs its flows, steps,
+  # and actions
+  class History
+    attr_reader :runtime, :status, :start_time, :end_time
+
+    def initialize(start_time = nil)
+      @start_time = start_time || Time.now
+      @status = nil
+    end
+
+    def status=(status)
+      @status = status ? "Successful" : "Unsuccessful"
+    end
+
+    def end_time=(end_time)
+      @end_time = end_time
+      @runtime = @end_time - @start_time if @start_time && @end_time
+    end
+  end
+end

data/lib/web_minion/step.rb

@@ -0,0 +1,57 @@
+module WebMinion
+  class InvalidMethodError < StandardError; end
+
+  # A Step represents the individual operation that the bot will perform. This
+  # often includes grabbing an element from the DOM tree, or performing some
+  # operation on an element that has already been found.
+  class Step
+    attr_accessor :name, :target, :method, :value, :is_validator, :retain_element
+
+    VALID_METHODS = [
+      :go,
+      :select,
+      :click,
+      :click_button_in_form,
+      :get_form,
+      :get_form_in_index,
+      :get_field,
+      :select_field,
+      :select_radio_button,
+      :select_first_radio_button,
+      :select_checkbox,
+      :submit,
+      :fill_in_input,
+      :url_equals,
+      :value_equals,
+      :body_includes,
+      :save_page_html
+    ].freeze
+
+    def initialize(fields = {})
+      fields.each_pair do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
+    def perform(bot, element = nil)
+      bot.execute_step(@method, @target, @value, element)
+    end
+
+    def method=(method)
+      raise(InvalidMethodError, "Method: #{method} is not valid") unless valid_method?(method.to_sym)
+      @method = method.to_sym
+    end
+
+    def retain?
+      retain_element
+    end
+
+    def validator?
+      is_validator
+    end
+
+    def valid_method?(method)
+      VALID_METHODS.include?(method)
+    end
+  end
+end

data/lib/web_minion/version.rb

@@ -0,0 +1,3 @@
+module WebMinion
+  VERSION = "0.1.0".freeze
+end

data/web_minion.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "web_minion/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "web_minion"
+  spec.version       = WebMinion::VERSION
+  spec.authors       = ["Andrew Parrish"]
+  spec.email         = ["m.andrewparrish@gmail.com"]
+
+  spec.summary       = "A metadata-driven browser automation."
+  spec.description   = "A metadata-driven browser automation."
+  spec.homepage      = "https://github.com/jibeinc/web_minion"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: web_minion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Parrish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A metadata-driven browser automation.
+email:
+- m.andrewparrish@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/jibe_ruleset_bot/version.rb
+- lib/web_minion.rb
+- lib/web_minion/action.rb
+- lib/web_minion/bots/bot.rb
+- lib/web_minion/bots/mechanize_bot.rb
+- lib/web_minion/cycle_checker.rb
+- lib/web_minion/flow.rb
+- lib/web_minion/histories/action_history.rb
+- lib/web_minion/histories/flow_history.rb
+- lib/web_minion/histories/history.rb
+- lib/web_minion/step.rb
+- lib/web_minion/version.rb
+- web_minion.gemspec
+homepage: https://github.com/jibeinc/web_minion
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A metadata-driven browser automation.
+test_files: []