lmk 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Luke Winikates
+
+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,31 @@
+[![Code Climate](https://codeclimate.com/github/LukeWinikates/lmk.png)](https://codeclimate.com/github/LukeWinikates/lmk)
+[![Build Status](https://travis-ci.org/LukeWinikates/lmk.png?branch=master)](https://travis-ci.org/LukeWinikates/lmk)
+LMK
+===========
+
+Don't sit around waiting for rake/make/tests/etc to finish. Let the machine tell you when it's done.
+
+## PREREQUISITES:
+You need a twilio account, including API Key and Account SID for sending [SMSes](http://www.twilio.com/sms).
+
+## USAGE:
+`$ lmk exec [command]`
+
+executes [command], sending a digest of the result as an SMS to the specified phone number and creating a private, anonymous gist with the full command output.
+
+For example:
+`$ lmk exec bundle install`
+
+## INSTALLATION/CONFIGURATION:
+LMK requires a ~/.lmkrc file in order to run. The .lmkrc is a simple YAML file with four required values: 
+- phone_number: The number at which you want to receive a message when the command has finished running.
+- from: a number associated with your Twilio account & set up for SMS sending
+- account_sid: from your Twilio Account
+- auth_token: from your Twilio Account
+
+You can validate your .lmkrc at any time by running LMK's `config` command:
+
+`$ lmk config`
+
+## LICENSE:
+MIT Licensed. See LICENSE file.

data/bin/lmk

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+require 'lmk'
+require 'thor'
+
+LMK::CLI.start

data/lib/lmk.rb

@@ -0,0 +1,8 @@
+require 'lmk/config'
+require 'lmk/version'
+require 'lmk/twilio_client_wrapper'
+require 'lmk/twilio_sender'
+require 'lmk/shell_command'
+require 'lmk/runner'
+require 'lmk/gist_sender'
+require 'lmk/cli'

data/lib/lmk/cli.rb

@@ -0,0 +1,28 @@
+require 'thor'
+
+module LMK
+  class CLI < ::Thor
+    desc "exec COMMAND", "run a command and get an SMS with its result"
+    def exec(*command)
+      command = command.join ' '
+      Runner.run(command, options)
+    end
+
+    desc "config", "read the current twilio config file"
+    def config
+      Kernel.puts Config.from_file.debug
+    end
+
+    desc "debug COMMAND", "view template output for the given command"
+    def debug(*command)
+      command = command.join ' '
+      cmd = ShellCommand.new(command).tap do |c|
+        c.html_url = "http://gist.example.com"
+      end
+      puts "concise"
+      puts cmd.concise_output
+      puts "\n\nfull"
+      puts cmd.full_output
+    end
+  end
+end

data/lib/lmk/config.rb

@@ -0,0 +1,52 @@
+require 'yaml'
+require 'hashie'
+
+module LMK
+  class Config
+    def self.default_path
+      "#{ENV['HOME']}/.lmkrc"
+    end
+
+    def self.from_file(path = default_path)
+      attrs = ::YAML.load_file(path) if File.exists?(path)
+      new(attrs, path)
+    end
+
+    def initialize(attributes, file = nil) 
+      (attributes || {}).each do |k, v|
+        setter = "#{k}=".to_sym
+        send(setter, v) if respond_to?(setter)
+      end
+      @file = file
+    end
+
+    def valid? 
+      required_attributes.map { |attr| send(attr) }.all?
+    end
+
+    def required_attributes
+      [:auth_token, :from, :phone_number, :account_sid]
+    end
+
+    def missing_values
+      required_attributes.select { |method| send(method).nil? }
+    end
+
+    def debug
+      <<-RESULT
+LMK Configuration #{valid? ? 'valid' : 'invalid'} 
+#{'Config file missing, create ' + @file  + ' with required values.' if @file && !File.exists?(@file) }
+missing values: #{valid? ? 'none' : missing_values }
+#{raw}
+      RESULT
+    end
+
+    def raw
+      instance_variables.map do |ivar|
+        "#{ivar.to_s.gsub("@", "")}: #{instance_variable_get ivar}"
+      end.join "\n"
+    end
+    
+    attr_accessor :auth_token, :from, :phone_number, :account_sid
+  end
+end

data/lib/lmk/gist_sender.rb

@@ -0,0 +1,27 @@
+require 'octokit'
+
+module LMK
+  class GistSender
+    def send(commmand)
+      result = client.create_gist options(commmand)
+      commmand.html_url = result[:html_url]
+      commmand
+    end
+
+    def options(command)
+      { 
+        :description => command.command, 
+        :public => false, 
+        :files => {
+          "#{command.timestamp.strftime '%FT%R'}.lmk" => { 
+            :content => command.full_output 
+          }
+        }
+      }
+    end
+
+    def client
+      Octokit::Client.new
+    end
+  end
+end

data/lib/lmk/runner.rb

@@ -0,0 +1,64 @@
+module LMK
+  class Runner
+    class Configuration
+      attr_accessor :sms_service, :gist_service, :console_service, :shell_service
+
+      def initialize
+        @sms_service = LMK::TwilioSender.new
+        @gist_service = LMK::GistSender.new
+        @console_service = Kernel
+        @shell_service = LMK::ShellCommand
+      end
+    end
+
+    def self.configure
+      yield self.configuration
+    end
+
+    def self.configuration
+      @@default_configuration ||= Configuration.new
+    end
+
+    def self.run(command, options)
+      new.run(command, options)
+    end
+
+    def initialize(configuration = Runner.configuration)
+      @configuration = configuration
+    end
+
+    def console(message)
+      @configuration.console_service.puts(message)
+    end
+
+    def shell(command)
+      @configuration.shell_service.exec(command)
+    end
+
+    def sms(command)
+      @configuration.sms_service.send(command)
+    end
+
+    def post_to_web(command)
+      @configuration.gist_service.send(command)
+    end
+
+    def run(command, options)
+      return unless validate!
+      console("running command `#{command}`")
+      result = shell(command)
+      result = post_to_web(result)
+      result = sms(result)
+      console(result.output)
+    end
+
+    def validate! 
+      unless @configuration.sms_service.runnable?
+        console("Configuration invalid. Run `lmk config` for more info")
+        false
+      else
+        true
+      end
+    end
+  end
+end

data/lib/lmk/shell_command.rb

@@ -0,0 +1,70 @@
+require 'popen4'
+require 'erb'
+
+module LMK
+  class ShellCommand
+    attr_reader :command, :timestamp
+    attr_accessor :html_url
+
+    def initialize(command)
+      @timestamp = Time.now
+      @command = command
+      @status = ::POpen4.popen4(command) do |stdout, stderr, stdin, pid| 
+        @error = stderr.read 
+        @output = stdout.read
+      end
+    end
+
+    def get_binding
+      binding
+    end
+
+    def self.exec(command)
+      new(command)
+    end
+
+    def success?
+      status == 0
+    end
+
+    def status
+      @status.exitstatus
+    end
+
+    def output
+      if success?
+        @output
+      else
+        @error
+      end
+    end
+
+    def concise_output
+      concise_template.result get_binding
+    end
+
+    def full_output
+      full_template.result get_binding
+    end 
+
+    def full_template
+      ERB.new %q{
+%%% LMK Command Result: %%%
+> <%= command %>
+<% if success? %>succeeded 
+<% else %> failed (<%=status%>)<% end %>
+full output:
+----------------------------
+<%=output%>
+      }
+    end
+
+    def concise_template
+      ERB.new %q{LMK Command Result:
+> <%=command%>
+<% if success? %>succeeded 
+<% else %>failed (<%=status%>)<% end %>
+<% if html_url %>full result @ <%= html_url %><% end %>}
+    end
+  end
+end

data/lib/lmk/twilio_client_wrapper.rb

@@ -0,0 +1,26 @@
+require 'twilio-ruby'
+
+module LMK
+  class TwilioClientWrapper
+    def initialize(config = Config.from_file)
+      @config = config
+      @client = ::Twilio::REST::Client.new(@config.account_sid, @config.auth_token) if runnable?
+    end
+
+    def runnable?
+      @config.valid?
+    end
+
+    def send(message)
+      @client.account.sms.messages.create options.merge(:body => message)
+    end
+
+    private
+    def options
+      {
+        :from => @config.from, 
+        :to => @config.phone_number 
+      }
+    end
+  end
+end

data/lib/lmk/twilio_sender.rb

@@ -0,0 +1,16 @@
+module LMK
+  class TwilioSender
+    def initialize(client = TwilioClientWrapper.new)
+      @client = client
+    end
+
+    def runnable?
+      !!@client && @client.runnable?
+    end
+
+    def send(command)
+      @client.send command.concise_output
+      command
+    end
+  end
+end

data/lib/lmk/version.rb

@@ -0,0 +1,3 @@
+module LMK
+  VERSION = "0.0.1"
+end

data/lmk.gemspec

@@ -0,0 +1,15 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'lmk/version'
+
+Gem::Specification.new do |s|
+  s.name = 'lmk'
+  s.summary = 'runs a command and sends the output via sms'
+  s.authors = ["Luke Winikates"]
+  s.version = LMK::VERSION
+  s.executables << 'lmk'
+  s.files = %w(LICENSE README.md lmk.gemspec)
+  s.files += Dir.glob("bin/**/*")
+  s.files += Dir.glob("lib/**/*.rb")
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: lmk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Luke Winikates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables:
+- lmk
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lmk.gemspec
+- bin/lmk
+- lib/lmk/cli.rb
+- lib/lmk/config.rb
+- lib/lmk/gist_sender.rb
+- lib/lmk/runner.rb
+- lib/lmk/shell_command.rb
+- lib/lmk/twilio_client_wrapper.rb
+- lib/lmk/twilio_sender.rb
+- lib/lmk/version.rb
+- lib/lmk.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: runs a command and sends the output via sms
+test_files: []
+has_rdoc: