launchd 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eb4f58d9f4e2f2a13283946c5ed6daf978ef441
-  data.tar.gz: 62837d74534dc815513129b957d3a051a05f3ef0
+  metadata.gz: 8fb752b754bb2198fdadd8ebbf74280e6f79aeaf
+  data.tar.gz: 1ec69bbdf2d510e349c1bfe4041cdebc8fcdd8fe
 SHA512:
-  metadata.gz: 3964fa06b8d10448933e1a8be4cc21ad765be7141274bcc9c09ccc5d897f56f93cf92ca3b37c82bdaa1bc620033008f065a4e662f5abb741e1e267bf051d68fa
-  data.tar.gz: fa878a6fea4541c4d67d601605f6356af2c207d6a342f1b42ff0fc43702be968a732053b8614c2c1ee2d18d3bd89b379bc37d53351c68a7acf3e11fb80d9f55b
+  metadata.gz: e74098bed3e054e22185f09bf27528d1858186ca3042a05b4a3a69b4d0027ddc473a21e82f2ceae57bf31c27551653d9c8bdccc7ee592c13c43c0e3fcf74722d
+  data.tar.gz: a6fc55dcf1d6cbce2aa3726df13afb5b85bbd07364c0b8174c2f8dc07055e9e3107a8b4b2354eef26f93ac65019376634272532b53b64e473103ec7c79d43cc5

data/.ruby-version

@@ -0,0 +1 @@
+system

data/README.md

@@ -3,8 +3,6 @@
 Ruby-Launchd is like launchctl (or the famous lunchy). It lets you easily
 create, start and stop services on Mac OS X, but with Ruby. 
 
-**NOTE: This is currently just the README without any code!**
-
 
 ## Installation
 
@@ -22,29 +20,19 @@ Or install it yourself as:
 
     $ gem install launchd
 
-## Usage
-
-A new service requires a label (in reverse-domain-notation) and the actual
-command to run as array:
 
-```Ruby
-service = Launchd.new 'com.example.chunkybacon', %w(/usr/sbin/chunkyd --bacon)
-```
+## Usage
 
-Then start and stop it with...
+Deploy (install & restart) a service:
 
 ```Ruby
-service.start # Starts the service if not already running.
-service.stop  # Stops the service unless already stopped.
+service = Launchd::Service.new 'com.example.chunkybacon', # Label of service
+  program_arguments: %w(/usr/sbin/chunkyd --bacon), # command line as array
+  keep_alive: true # Shall launchd keep it running?
+service.deploy
 ```
 
-Both return `true` on success or `false` otherwise, i.e. if a job was already running.
-
-Use the bang-version to forcefully overwrite an already running service:
-
-```Ruby
-service.start! # Stops, updates and starts service, no matter if it's running or not.
-```
+**NOTE: All options are also required!**
 
 
 ## Development

data/launchd.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'plist', '~> 3.1'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'

data/lib/launchd.rb

@@ -1,4 +1,7 @@
-require "launchd/version"
+require 'plist'
+
+require 'launchd/version'
+require 'launchd/service'
 
 module Launchd
   # Your code goes here...

data/lib/launchd/service.rb

@@ -0,0 +1,70 @@
+module Launchd
+  class Service
+    attr_reader :label
+
+    def initialize(label, opts = {})
+      @label = label
+      @opts = opts
+    end
+
+    # Deploy (install & restart) the service.
+    #
+    # If running as root, it will get installed as system-wide daemon,
+    # otherwise as agent.
+    #
+    def deploy
+      stop if running?
+      write_plist
+      start
+    end
+
+    # Stops the service.
+    def stop
+      system("launchctl unload -w #{label}")
+    end
+
+    # Starts the service.
+    def start
+      system("launchctl load -w #{label}")
+    end
+
+    # Returns true, when this service is runnung (loaded), otherwise false.
+    def running?
+      !!system("launchctl list #{label}")
+    end
+
+    private
+
+    # Save actual plist to disk.
+    def write_plist
+      File.open(plist_path, 'w') do |file|
+        file.puts properties.to_plist
+      end
+    end
+
+    # Returns path to plist.
+    def plist_path
+      plist_dir.join "#{label}.plist"
+    end
+
+    # Returns directory where plist is stored.
+    def plist_dir
+      Pathname.new(
+        root? ? '/Library/LaunchDaemons' : '~/Library/LaunchAgents')
+    end
+
+    # Returns true, when running as root, otherwise false.
+    def root?
+      Process.euid.zero?
+    end
+
+    # Returns hash of plist properties.
+    def properties
+      {
+        'Label' => label,
+        'ProgramArguments' => @opts[:program_arguments],
+        'KeepAlive' => @opts[:keep_alive]
+      }
+    end
+  end
+end

data/lib/launchd/version.rb

@@ -1,3 +1,3 @@
 module Launchd
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: launchd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Björn Albers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +76,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .ruby-version
 - .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -72,6 +87,7 @@ files:
 - bin/setup
 - launchd.gemspec
 - lib/launchd.rb
+- lib/launchd/service.rb
 - lib/launchd/version.rb
 homepage: https://github.com/bjoernalbers/ruby-launchd
 licenses: