launch-agent 0.2.0 → 0.3.0

data/README.rdoc

@@ -14,6 +14,10 @@ A library to use launchd easily
  # unload
  agent.unload
 
+== CLI
+
+ $ launchagent -h
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/bin/launchagent-periodic

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'git-style-binary/command'
+
+GitStyleBinary.command do
+  short_desc "load/unload a periodic agent"
+  banner <<-EOS
+Usage: #{command.full_name} #{all_options_string} {full command}
+
+Load/Unload a periodic launchd agent
+
+
+EOS
+  opt :interval, "causes the job to be started every N seconds", :required => true, :type => Integer
+  opt :env, "additional environmental variables to be set before running the job. can specify multiple times", :type => String, :multi => true
+
+  run do |command|
+    abort 'full command must be supplised' if command.argv.empty?
+
+    agent = LaunchAgent::Periodic.new(command.opts[:interval], *command.argv)
+
+    agent['EnvironmentVariables'] = command.opts[:env].inject({}) do |memo, env|
+      k, v = env.split('=')
+      memo[k] = v
+      memo
+    end
+
+    action = agent.loaded? ? :unload : :load
+    agent.send(action)
+
+    puts '%s "%s"' % [action, command.argv.join(' ')]
+  end
+end

data/lib/launch_agent.rb

@@ -6,3 +6,4 @@ end
 require 'launch_agent/version'
 require 'launch_agent/base'
 require 'launch_agent/daemon'
+require 'launch_agent/periodic'

data/lib/launch_agent/periodic.rb

@@ -0,0 +1,14 @@
+module LaunchAgent
+  class Periodic < Base
+    def initialize(interval_sec, *args)
+      super(*args)
+      @interval_sec = interval_sec
+    end
+
+    def build_params
+      @params['Label'] = job_id
+      @params['StartInterval'] = @interval_sec
+      @params['ProgramArguments'] = @args
+    end
+  end
+end

data/lib/launch_agent/version.rb

@@ -1,4 +1,4 @@
 module LaunchAgent
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end
 

data/spec/periodic_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe LaunchAgent::Periodic do
+  before do
+    @plist_filename = File.expand_path('~/Library/LaunchAgents/com.buycheapviagraonlinenow.ruby__foo_rb.plist')
+    @agent = LaunchAgent::Periodic.new(120, 'ruby', 'foo.rb')
+
+    # key exists
+    @agent['WorkingDirectory'] = '/foo/bar'
+
+    # key does not exists
+    @agent['XXX'] = 'YYY'
+  end
+
+  after do
+    `launchctl unload -w #{@plist_filename}` if `launchctl list | grep ruby__foo_rb` =~ /ruby__foo.rb/
+    File.unlink(@plist_filename) if File.exists?(@plist_filename)
+  end
+
+  it 'should load and unload' do
+    @agent.should_not be_loaded
+
+    @agent.load
+
+    @agent.should be_loaded
+
+    File.exists?(@plist_filename).should be_true
+    open(@plist_filename).read.should eql(<<PLIST)
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Label</key>
+	<string>com.buycheapviagraonlinenow.ruby__foo_rb</string>
+	<key>ProgramArguments</key>
+	<array>
+		<string>ruby</string>
+		<string>foo.rb</string>
+	</array>
+	<key>StartInterval</key>
+	<integer>120</integer>
+	<key>WorkingDirectory</key>
+	<string>/foo/bar</string>
+</dict>
+</plist>
+PLIST
+
+    (`launchctl list | grep ruby__foo_rb` =~ /ruby__foo.rb/).should_not be_nil
+
+    @agent.unload
+
+    File.exists?(@plist_filename).should be_false
+    (`launchctl list | grep ruby__foo_rb` =~ /ruby__foo.rb/).should be_nil
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: launch-agent
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
-  requirement: &70217570899260 !ruby/object:Gem::Requirement
+  requirement: &70105443982460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217570899260
+  version_requirements: *70105443982460
 - !ruby/object:Gem::Dependency
   name: git-style-binaries
-  requirement: &70217570898840 !ruby/object:Gem::Requirement
+  requirement: &70105443982040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70217570898840
+  version_requirements: *70105443982040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70217570898320 !ruby/object:Gem::Requirement
+  requirement: &70105443981520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,13 +43,14 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *70217570898320
+  version_requirements: *70105443981520
 description: A library to use launchd easily
 email:
 - youpy@buycheapviagraonlinenow.com
 executables:
 - launchagent
 - launchagent-daemon
+- launchagent-periodic
 extensions: []
 extra_rdoc_files: []
 files:
@@ -61,12 +62,15 @@ files:
 - Rakefile
 - bin/launchagent
 - bin/launchagent-daemon
+- bin/launchagent-periodic
 - launch-agent.gemspec
 - lib/launch_agent.rb
 - lib/launch_agent/base.rb
 - lib/launch_agent/daemon.rb
+- lib/launch_agent/periodic.rb
 - lib/launch_agent/version.rb
 - spec/daemon_spec.rb
+- spec/periodic_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -82,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2630477314402493584
+      hash: 3385802500364367716
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2630477314402493584
+      hash: 3385802500364367716
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -100,4 +104,5 @@ specification_version: 3
 summary: A library to use launchd easily
 test_files:
 - spec/daemon_spec.rb
+- spec/periodic_spec.rb
 - spec/spec_helper.rb