daf 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fda2ec5348bcba315e6b234fe2d074ebdff16f1
+  data.tar.gz: 6c59a79b72716fedf16e9724a3c9dcd73ed7a07e
+SHA512:
+  metadata.gz: d2d94f5e13286e1f9be111612bcdd687ad91231d6060b997ffd9383ad88d529804953241c983673faa558680731efb1f84455e2006dde905513ab8c06e97e6bd
+  data.tar.gz: 4bcf8c5103e21bcafb9dc39a98083d251cfae11afe2a12fe667c3a0045d2744a81a9bc0dd1062255805237df81a3665ac97c621eadc709d8de4e5ae6da0be007

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+install:
+  - bundle install
+script:
+  - bundle exec rake validate

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    daf (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    jwt (1.5.0)
+    mime-types (2.6.1)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    parser (2.2.0.pre.8)
+      ast (>= 1.1, < 3.0)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    rainbow (2.0.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.27.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.0.pre.7, < 3.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    twilio-ruby (4.2.0)
+      builder (>= 2.1.2)
+      jwt (~> 1.0)
+      multi_json (>= 1.3.0)
+    washbullet (0.4.0)
+      faraday (~> 0.9.0)
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.6)
+  daf!
+  rake
+  rspec
+  rubocop
+  simplecov
+  twilio-ruby
+  washbullet

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Kayla McArthur
+
+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,37 @@
+## Dynamic Action Framework
+
+[![Gem Version](https://badge.fury.io/rb/daf.svg)](http://badge.fury.io/rb/daf) [![Build Status](https://kayla-ci.org/klmcarthur/DAF.svg?branch=master)](https://kayla-ci.org/klmcarthur/DAF) [![Inline docs](http://inch-ci.org/github/klmcarthur/DAF.svg?branch=master)](http://inch-ci.org/github/klmcarthur/DAF) [![Code Climate](https://codeclimate.com/github/klmcarthur/DAF/badges/gpa.svg)](https://codeclimate.com/github/klmcarthur/DAF)
+
+
+https://rubygems.org/gems/daf
+
+Dynamic Action Framework, or DAF, is a flexible, extensible system to let a user trigger actions based on events, either on a system or through anything else you can write in Ruby.  Some examples of things you can automate using DAF:
+
+* When my bus is 10 minutes away, text me
+* When I get an email from my mother, text me the contents
+* When I'm five minutes away from a meeting, send me the agenda
+* Automatically create a blog entry based on my tweets
+* Automatically download any picture from facebook that has me tagged
+* Alert me when the weather changes via text message
+
+In addition, you could use it as a library to develop other action systems, including things like:
+
+* Server monitoring systems
+* Email filtering systems
+
+DAF integrates with other action systems such as IFTTT in numerous ways, the easiest probably being through use of Dropbox and monitoring file modification times.  Using DAF with these services permits an even greater level of integration and customizability.
+
+### Planned Features
+
+* Additional plugins for input/output
+* A robust Erlang daemon that uses Ruby framework to provide high availability monitor
+* Additional input sources (SQL, Socket/Listening API, etc)
+* REST API layer
+
+## Contributing
+
+If you're interested in contributing custom actions or monitors you've written, please just submit a pull request - http://github.com/klmcarthur/DAF - and I'll happily have a look.
+
+If you're interested in using DAF in something else, or have a different front-end experience, please let me know as well, for front-ends, I'd love to bring it into the core if it's interesting or useful, and for third party projects I'd love to link to you.
+
+Thanks!

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+Bundler.setup(:default, :development)
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :validate
+
+desc 'Validate Package'
+task validate: [:rubocop, :spec]
+
+desc 'Run RuboCop'
+task :rubocop do
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end
+
+desc 'Build Documentation'
+task :yard do
+  require 'yard'
+  YARD::Rake::YardocTask.new
+end

data/bin/dad

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'daf'
+include DAF
+start_dad

data/daf.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'daf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'daf'
+  spec.version       = DAF::VERSION
+  spec.authors       = ['Kayla McArthur']
+  spec.email         = ['kayla@kayla.is']
+  spec.summary       = 'A daemon and framework for monitoring events, '\
+                       'and triggering actions'
+  spec.description   = 'A library and corresponding daemon based on that '\
+                       'library to monitor a number of sources for events '\
+                       'and trigger actions based on those events. '\
+                       'Includes a default set of monitors and actions '\
+                       'and tools to create more'
+  spec.homepage      = 'http://github.com/klmcarthur/DAF'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'twilio-ruby'
+  spec.add_development_dependency 'washbullet'
+
+end

data/examples/config/SendEmail.yaml

@@ -0,0 +1,16 @@
+---
+Monitor:
+  Type: FileUpdateMonitor
+  Options: 
+    path: /tmp/test1
+    frequency: 2
+
+Action:
+  Type: EmailAction
+  Options:
+    to: test@example.com
+    from: test@example.com
+    subject: "File updated at {{time}}"
+    body: "Contents of File: {{contentts}}"
+    server: localhost
+---

data/lib/daf.rb

@@ -0,0 +1,50 @@
+require 'daf/datasources/yaml_data_source'
+
+# Starts the DAF daemon (DAD) - takes a directory
+# containing the YAML files for monitor/action pairs
+# After parsing configuration, will daemonize and continue
+# monitoring until SIGTERM is received
+#
+# @author Kayla McArthur (mailto:kayla@kayla.is)
+# @icense MIT License
+module DAF
+  def start_dad
+    if ARGV[0] && File.directory?(ARGV[0])
+      commands = []
+
+      Dir[ARGV[0] + '/*.yaml'].each do |file|
+        commands << Command.new(YAMLDataSource.new(file))
+      end
+
+      dad = DynamicActionDaemon.new(commands)
+      dad.start
+    else
+      print_usage
+    end
+  end
+
+  def print_usage
+    puts 'DAF not started - please see below'
+    puts 'Usage: daf [path to config folder]'
+    puts 'Directory must contain one or more config'
+    puts 'files with a .yaml extension'
+  end
+
+  # This class represents the Dynamic Action Daemon
+  # it requires a set of commands to be passed in
+  class DynamicActionDaemon
+    # Initializes DAD with a given command set
+    #
+    # @param commands [Array] Array containing Command objects
+    def initialize(commands)
+      @commands = commands
+    end
+
+    # Starts the daemon - this method will block for duration
+    # of execution of program
+    def start
+      @commands.each(&:execute)
+      sleep
+    end
+  end
+end

data/lib/daf/action.rb

@@ -0,0 +1,25 @@
+require 'daf/configurable'
+
+module DAF
+  # Stores information related to actions that can
+  # be taken as a result of a Monitor firing
+  # Exposes only one method, and is a Configurable
+  class Action
+    include Configurable
+
+    # Activate this action using given options - takes an optional
+    # block parameter that will be invoked when action
+    # is complete, with a parameter of if the action was successful
+    # and also returns if action was successful
+    #
+    # @param options [Hash] A hash of options with name/value pairs, must
+    # match types expected for each option or will raise an exception
+    # @yield If successful, will execute the optional block passed in
+    def activate(options)
+      process_options(options)
+      success = invoke
+      yield success if block_given?
+      success
+    end
+  end
+end

data/lib/daf/actions/email_action.rb

@@ -0,0 +1,34 @@
+require 'daf/action'
+require 'net/smtp'
+
+module DAF
+  # An action that sends an email based on parameters
+  class EmailAction < Action
+    attr_option :to, String, :required
+    attr_option :from, String, :required
+    attr_option :subject, String, :required
+    attr_option :body, String, :required
+    attr_option :server, String, :required
+    attr_option :port, Integer
+
+    def invoke
+      message = format_email(@to.value, @from.value,
+                             @subject.value, @body.value)
+      port = self.port.valid? ? self.port.value : 25
+      Net::SMTP.start(@server.value, port) do |smtp|
+        smtp.send_message(message, @from.value, @to.value)
+      end
+      true
+    end
+
+    def format_email(to, from, subject, body)
+      <<TEXT
+  From: #{from}
+  To: #{to}
+  Subject: #{subject}
+
+  #{body}
+TEXT
+    end
+  end
+end

data/lib/daf/actions/pushbullet_action.rb

@@ -0,0 +1,26 @@
+require 'daf/action'
+require 'washbullet'
+
+module DAF
+  # An action that sends an sms using twilio based on parameters
+  class PushbulletAction < Action
+    attr_option :key, String, :required
+    attr_option :identifier, String, :required
+    attr_option :title, String, :required
+    attr_option :message, String, :required
+
+    def client
+      @client ||= Washbullet::Client.new(@key)
+    end
+
+    def invoke
+      client.push_note(receiver:   :device,
+                       identifier: @identifier,
+                       params: {
+                         title: @title,
+                         body:  @message
+                       }
+                      )
+    end
+  end
+end

data/lib/daf/actions/shell_action.rb

@@ -0,0 +1,21 @@
+require 'daf/action'
+require 'English'
+
+module DAF
+  # An action that executes a shell script
+  class ShellAction < Action
+    attr_option :path, String, :required do |value|
+      File.executable?(value)
+    end
+
+    attr_option :arguments, String
+
+    attr_output :results, String
+
+    def invoke
+      arguments = self.arguments.value ? " #{self.arguments.value}" : ''
+      @results = `#{path.value}#{arguments}`
+      $CHILD_STATUS.exitstatus
+    end
+  end
+end