launch 1.0 → 2.0.0

data/lib/launch/errors.rb

@@ -0,0 +1,22 @@
+module Launch
+  class Error < StandardError
+  end
+
+  class JobError < Error
+    attr_reader :job
+
+    def initialize(job, message = nil)
+      @job = job
+      super(message)
+    end
+  end
+
+  class InvalidJob < JobError
+  end
+
+  class JobAlreadyExists < JobError
+  end
+
+  class UnknownJob < JobError
+  end
+end

data/lib/launch/job.rb

@@ -0,0 +1,170 @@
+module Launch
+  require "launch/errors"
+
+  class Job
+    class << self
+      def checkin
+        from_launch Launch.message(Messages::CHECKIN)
+      rescue Errno::EPERM
+        raise JobError.new(nil, "must checkin from process spawned by lauchd for job with sockets")
+      end
+
+      def find(label)
+        from_launch Launch.message(Messages::GETJOB => label)
+      rescue Errno::ESRCH
+        raise UnknownJob.new(nil, "no job exists with the label `#{label}'")
+      end
+
+      private
+        def from_launch(launch)
+          job = allocate
+          job.launch_attributes = launch
+          job
+        end
+
+        @@launch_attributes = Hash.new { |h, k| h[k] = { :lazy_value => lambda { nil } } }
+        def launch_attr(name, launch_key, options = {}, &block)
+          @@launch_attributes[launch_key][:name] = name
+          @@launch_attributes[launch_key][:lazy_value] = block if block
+
+          class_eval <<-EVAL, __FILE__, __LINE__ + 1 unless options[:write_only]
+            def #{name}
+              unless @launch_attributes.key?("#{launch_key}")
+                @launch_attributes["#{launch_key}"] = @@launch_attributes["#{launch_key}"][:lazy_value].call
+              end
+
+              @launch_attributes["#{launch_key}"]
+            end
+          EVAL
+          class_eval <<-EVAL, __FILE__, __LINE__ + 1 unless options[:read_only]
+            def #{name}=(value)
+              @launch_attributes["#{launch_key}"] = value
+            end
+          EVAL
+        end
+    end
+
+    launch_attr :abandon_process_group, ABANDONPROCESSGROUP
+    launch_attr :debug, DEBUG
+    launch_attr :disabled, DISABLED
+    launch_attr :enable_globbing, ENABLEGLOBBING
+    launch_attr :enable_transactions, ENABLETRANSACTIONS
+    launch_attr :environment_variables, ENVIRONMENTVARIABLES do
+      {}
+    end
+    launch_attr :exit_timeout, EXITTIMEOUT
+    launch_attr :group_name, GROUPNAME
+    launch_attr :hard_resource_limits, HARDRESOURCELIMITS
+    launch_attr :hopefully_exits_first, HOPEFULLYEXITSFIRST
+    launch_attr :hopefully_exits_last, HOPEFULLYEXITSLAST
+    launch_attr :ignore_process_group_at_shutdown, IGNOREPROCESSGROUPATSHUTDOWN
+    launch_attr :inetd_compatibility, INETDCOMPATIBILITY
+    launch_attr :init_groups, INITGROUPS
+    launch_attr :keep_alive, KEEPALIVE do
+      {}
+    end
+    launch_attr :label, LABEL
+    launch_attr :last_exit_status, LASTEXITSTATUS, :read_only => true
+    launch_attr :launch_only_once, LAUNCHONLYONCE
+    launch_attr :limit_load_from_hosts, LIMITLOADFROMHOSTS do
+      []
+    end
+    launch_attr :limit_load_to_hosts, LIMITLOADTOHOSTS do
+      []
+    end
+    launch_attr :limit_load_to_session_type, LIMITLOADTOSESSIONTYPE do
+      []
+    end
+    launch_attr :nice, NICE
+    launch_attr :on_demand, ONDEMAND
+    launch_attr :pid, PID, :read_only => true
+    launch_attr :policies, POLICIES
+    launch_attr :program, PROGRAM
+    launch_attr :program_arguments, PROGRAMARGUMENTS do
+      []
+    end
+    launch_attr :queue_directories, QUEUEDIRECTORIES
+    launch_attr :root_directory, ROOTDIRECTORY
+    launch_attr :run_at_load, RUNATLOAD
+    launch_attr :sockets, SOCKETS do
+      Hash.new { |h, k| h[k] = [] }
+    end
+    launch_attr :soft_resource_limits, SOFTRESOURCELIMITS
+    launch_attr :standard_error_path, STANDARDERRORPATH
+    launch_attr :standard_in_path, STANDARDINPATH
+    launch_attr :standard_out_path, STANDARDOUTPATH
+    launch_attr :start_calendar_interval, STARTCALENDARINTERVAL
+    launch_attr :start_interval, STARTINTERVAL
+    launch_attr :start_on_mount, STARTONMOUNT
+    launch_attr :throttle_interval, THROTTLEINTERVAL
+    launch_attr :timeout, TIMEOUT
+    launch_attr :umask, UMASK
+    launch_attr :user_name, USERNAME
+    launch_attr :wait_for_debugger, WAITFORDEBUGGER
+    launch_attr :watch_paths, WATCHPATHS
+    launch_attr :working_directory, WORKINGDIRECTORY
+
+    def attributes=(attributes)
+      attributes.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+
+    def initialize(attributes = {})
+      @launch_attributes = {}
+
+      self.attributes = attributes
+
+      yield self if block_given?
+    end
+
+    def inspect
+      "#<#{self.class} #{attributes_inspect}>"
+    end
+
+    def launch_attributes
+      @launch_attributes
+    end
+
+    def launch_attributes=(attributes)
+      @launch_attributes = attributes
+    end
+
+    def remove
+      message(Messages::REMOVEJOB => label)
+    end
+
+    def start
+      message(Messages::STARTJOB => label)
+    end
+
+    def stop
+      message(Messages::STOPJOB => label)
+    end
+
+    def submit
+      message(Messages::SUBMITJOB => launch_attributes)
+    end
+
+    private
+      def attributes_inspect
+        @@launch_attributes.select do |launch_key, attribute|
+          @launch_attributes.key?(launch_key)
+        end.map do |launch_key, attribute|
+          "#{attribute[:name]}: #{@launch_attributes[launch_key].inspect}"
+        end.join(", ")
+      end
+
+      def message(msg)
+        Launch.message(msg)
+      rescue Errno::ESRCH
+        raise UnknownJob.new(self, "no job exists with the label `#{label}'")
+      rescue Errno::EINVAL
+        raise InvalidJob.new(self, "job is invalid")
+      rescue Errno::EEXIST
+        raise JobAlreadyExists.new(self, "job with label `#{label}' already exists")
+      rescue SystemCallError => e
+        raise JobError.new(self, e.message)
+      end
+  end
+end

data/lib/launch/test_helper.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+
+begin
+  gem "launch"
+rescue Gem::LoadError
+  raise "You must install the launch gem to use the test helper."
+end
+
+require "launch"
+require "minitest/autorun"
+require "minitest/spec"

data/lib/launch/version.rb

@@ -0,0 +1,3 @@
+module Launch
+  VERSION = "2.0.0"
+end

data/lib/launch/webrick.rb

@@ -1,5 +1,6 @@
-require 'launch'
-require 'webrick'
+require "rubygems"
+require "webrick"
+require "launch"
 
 ##
 # Launch::WEBrickHTTPServer adds launchd support to WEBrick.
@@ -46,33 +47,26 @@ require 'webrick'
 #     </dict>
 #   </dict>
 #   </plist>
+module Launch
+  class WEBrickHTTPServer < WEBrick::HTTPServer
+    ##
+    # Initializes an HTTP server with +options+ and set the server's listeners
+    # using Launch.  A TERM handler to shut down the server is automatically
+    # set.
+    #
+    # +:LaunchdSockets+ may be set to change the socket key from the default of
+    # <tt>'WEBrickSockets'</tt>
+    def initialize(options = {})
+      options[:DoNotListen] = true
+      sockets_key = options.delete(:LaunchdSockets) || 'WEBrickSockets'
 
-class Launch::WEBrickHTTPServer < WEBrick::HTTPServer
-  
-  include Launch
+      super
 
-  ##
-  # Initializes an HTTP server with +options+ and set the server's listeners
-  # using Launch.  A TERM handler to shut down the server is automatically
-  # set.
-  #
-  # +:LaunchdSockets+ may be set to change the socket key from the default of
-  # <tt>'WEBrickSockets'</tt>
+      @job = Launch::Job.checkin
+      sockets = @job.sockets[sockets_key]
+      listeners.replace(socket)
 
-  def initialize options = {}
-    options[:DoNotListen] = true
-    sockets_key = options.delete(:LaunchdSockets) || 'WEBrickSockets'
-
-    super
-
-    launch_checkin
-
-    servers = launch_sockets sockets_key, TCPServer
-
-    listeners.replace servers
-
-    trap 'TERM' do shutdown end
+      trap("TERM") { shutdown }
+    end
   end
-
 end
-

data/test/launch/job_test.rb

@@ -0,0 +1,9 @@
+require "launch/test_helper"
+
+describe Launch::Job do
+  describe "when checking in from a process not spawned by launchd" do
+    it "should raise an error" do
+      lambda { Launch::Job.checkin }.must_raise(Launch::JobError)
+    end
+  end
+end

data/test/launch/service_test.rb

@@ -0,0 +1,23 @@
+require "launch/test_helper"
+
+describe "launch_service" do
+  before do
+    @job = Launch::Job.new
+    @job.label = "org.launch.test"
+    @job.environment_variables = ENV.to_hash
+    @job.program_arguments << Gem.ruby
+    @job.program_arguments << "-e"
+    @job.program_arguments << <<-PROGRAM
+      requrie "rubygems"
+      require "launch"
+
+
+    PROGRAM
+  end
+
+  describe "when submitting job" do
+    it "should return true" do
+      lambda { Launch::Job.checkin }.must_raise(Launch::JobError)
+    end
+  end
+end

data/test/launch_test.rb

@@ -0,0 +1,11 @@
+require "launch/test_helper"
+
+describe Launch do
+  describe "when listing jobs" do
+    it "should return an array of Launch::Jobs" do
+      jobs = Launch.jobs
+      jobs.must_be_instance_of Array
+      jobs.first.must_be_instance_of Launch::Job if jobs.first
+    end
+  end
+end

metadata

@@ -1,153 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: launch
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  version: "1.0"
 platform: ruby
-authors: 
+authors:
 - Eric Hodel
+- Samuel Kadolph
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
-  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
-  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
-  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
-  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
-  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
-  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
-  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
-  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
-  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
-  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
-  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
-  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
-  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
-  x52qPcexcYZR7w==
-  -----END CERTIFICATE-----
+cert_chain: []
+date: 2011-08-07 00:00:00.000000000Z
+dependencies: []
+description: ! 'launch is a wrapper for liblaunch which lets you load, unload, reload,
+  submit, remove, start, stop and list jobs for
 
-date: 2011-02-27 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 0
-        - 2
-        version: 2.0.2
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake-compiler
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 7
-        version: "0.7"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
-        version: 2.9.0
-  type: :development
-  version_requirements: *id003
-description: |-
-  Launch allows agents and daemons launched by launchd to retrieve their list of
-  sockets.  Launchd is an open source framework for launching and managing
-  daemons, programs and scripts provided by Apple.
-email: 
+  launchd as well as checkin from a process spawned by launchd and retrieve the sockets
+  for the job that spawned the process.
+
+'
+email:
 - drbrain@segment7.net
+- samuel@kadolph.com
 executables: []
-
-extensions: 
-- ext/launch/extconf.rb
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
-files: 
-- .autotest
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- ext/launch/extconf.rb
-- ext/launch/launch.c
-- lib/launch.rb
+extensions:
+- ext/extconf.rb
+extra_rdoc_files: []
+files:
+- ext/extconf.rb
+- ext/launch.c
+- lib/launch/errors.rb
+- lib/launch/job.rb
+- lib/launch/test_helper.rb
+- lib/launch/version.rb
 - lib/launch/webrick.rb
-- sample/echo.rb
-- test/test_launch.rb
-- .gemtest
-has_rdoc: true
-homepage: https://github.com/drbrain/launch
+- lib/launch.bundle
+- lib/launch.rb
+- CHANGELOG.md
+- LICENSE
+- README.md
+- test/launch/job_test.rb
+- test/launch/service_test.rb
+- test/launch_test.rb
+homepage: https://github.com/samuelkadolph/ruby-launch
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --main
-- README.txt
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 55
-      segments: 
-      - 1
-      - 9
-      - 2
-      version: 1.9.2
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: launch
-rubygems_version: 1.5.3
+rubyforge_project: 
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Launch allows agents and daemons launched by launchd to retrieve their list of sockets
-test_files: 
-- test/test_launch.rb
+summary: Wrapper for liblaunch which allows you to manage jobs and checkin from processes
+  spawned by launchd.
+test_files:
+- test/launch/job_test.rb
+- test/launch/service_test.rb
+- test/launch_test.rb