ops_script 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDQ4N2U3MDJmYjlkNTdhMzliZGMwYTE5MzAwYmQ4M2YzYTFhYmZmYw==
+  data.tar.gz: !binary |-
+    ZDUwYTY1ZDE0YTUyMjFmMGEzZTUwOWM2ZjgzNjM2ODY3Yjc1ODNiMA==
+SHA512:
+  metadata.gz: !binary |-
+    YjFhMzhmZWYzNmM3YzA3ZTkyZDU4MjI4NzA5ZDRhZDAwMTlmZWNkYzk0MzFk
+    NWMxNGY3YzEwYzBhMmQxZGY3ZjNlYjIzZjIxMzE3ZDAxNDBkYTI3ZjI3Nzlj
+    NWQ1ZGY0NTliMTAxODE3ZWU2ZGI3ODJiYzg5YzQxOGY4MmJjZjQ=
+  data.tar.gz: !binary |-
+    MzI4Y2FjZGFhMGI1ZDA0MTk0NmFkYzBjMGFhY2YwNTY2M2EwZTA1ZWM0ZGMz
+    NzU4YjBiZWViYzBmMTliODA1ZmM3MTllMjNhOTU5ZDhjY2UzNDE4NGMyNDk0
+    ZTI0MzU2NTIzMDI2YWExZGU0YjE4YjIyZTdlNzY2Nzk2NjJkOTI=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sanjiv Patel
+
+MIT License
+
+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 @@
+# OpsScript
+
+Module to provide basic functionality common to many operations scripts. Specifically:
+- Create and manage log file
+- Use PID file to insure only one instance runs at a time
+- Provide basic command line options such as --debug to log debug messages
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ops_script'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ops_script
+
+## Usage
+
+require 'ops_script'
+include OpsScript
+
+OpsScript.run
+	log.info "This is my script running!"
+end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ops_script/version.rb

@@ -0,0 +1,3 @@
+module OpsScript
+  VERSION = "1.0.0"
+end

data/lib/ops_script.rb

@@ -0,0 +1,172 @@
+require "ops_script/version"
+
+#
+# This module provides some basic features common to many operational unix scripts
+#
+# * Log file
+# * PID file used to insure only one instance is running, handy if running from cron multiple times
+# * Options processing with basic options for overriding default log attributes and logfile and pidfile location
+#
+# == Example
+# 
+#   require 'ops_script'
+#   include OpsScript
+#   # Add your own custom options
+#   option_parser.on "--bar", "The bar option" do
+#     options[:bar] = true
+#   end
+#   # Run your code
+#   OpsScript.run do 
+#     puts "BAR" if options[:bar]
+#     log.info "My informational message"
+#     log.debug "This is a debug message"
+#     # do some stuff
+#   end
+#
+# The module provides these options
+#    foo.rb -h
+#    Usage: foo.rb [options]
+#            --debug                      enable debug output
+#            --logfile log_file           specify a different log file
+#                                         default is ../log/foo.log
+#            --log-retention retention    Number of old log files to keep,
+#                                         or frequency of rotation (daily, weekly or monthly). Defaults to monthly.
+#            --log-size size              Max size in bytes for logfile before rotating.
+#                                         Specify number of files to keep with log-retention option.
+#            --pidfile pid_file           specify a different pid file
+#                                         default is ../tmp/foo.pid
+#        -h, -?, --help                   Display this help
+#
+#
+module OpsScript
+
+  require 'date'
+  require 'fileutils'
+  require 'logger'
+  require 'optparse'
+  
+  def script_basename
+    File.basename $0, '.*'
+  end
+  module_function :script_basename
+  
+  def options
+    OpsScript.options
+  end
+  
+  def self.options
+    @options ||= {}
+  end
+  
+  def option_parser
+    OpsScript.option_parser
+  end
+  
+  def self.option_parser
+    @option_parser ||= OptionParser.new
+  end
+  
+  def process_options
+    options[:log_file] = File.expand_path("../../log/#{script_basename}.log", $0)
+    options[:pid_file] = File.expand_path("../../tmp/#{script_basename}.pid", $0)
+    
+    option_parser.banner = "Usage: #{File.basename($0)} [options]"
+    
+    option_parser.on_tail("-h","-?","--help", "Display this help") do
+      puts option_parser
+      exit
+    end
+    
+    option_parser.on("--debug", "enable debug output") do
+      options[:debug] = true
+    end
+    
+    option_parser.on("--logfile log_file", "specify a different log file", "default is #{options[:log_file]}") do |p|
+      options[:log_file] = p
+    end
+    
+    option_parser.on("--log-retention retention", "Number of old log files to keep,",
+    "or frequency of rotation (daily, weekly or monthly). Defaults to monthly.") do |r|
+      options[:log_retention] = r
+    end
+    
+    option_parser.on("--log-size size", "Max size in bytes for logfile before rotating.", 
+    "Specify number of files to keep with log-retention option.") do |s|
+      options[:log_size] = s
+    end
+    
+    option_parser.on_tail("-h","-?","--help", "Display this help") do
+      puts option_parser
+      exit
+    end
+        
+    option_parser.on("--pidfile pid_file", "specify a different pid file", "default is #{options[:pid_file]}") do |p|
+      options[:pid_file] = p
+    end
+    
+    option_parser.parse!
+  end
+  private :process_options
+  
+  def create_directories
+    FileUtils.mkdir_p File.dirname(File.expand_path(options[:log_file]))
+    FileUtils.mkdir_p File.dirname(File.expand_path(options[:pid_file]))
+  end
+  private :create_directories
+  
+  def already_running?
+    File.exists?(options[:pid_file])
+  end
+  private :already_running?
+  
+  def create_pid
+    ::File.open(options[:pid_file], 'w' ){ |f| f.write("#{Process.pid}")}
+  end
+  private :create_pid
+  
+  def remove_pid
+    File.unlink(options[:pid_file])
+  end
+  private :remove_pid
+  
+  # Use log in your script to log messages
+  def log
+    OpsScript.log
+  end
+  
+  def self.log
+    @log ||= Logger.new(options[:log_file], options[:log_retention] || 'monthly', options[:log_size])
+  end
+  
+  def script
+    File.basename $0
+  end
+  private :script
+  
+  def self.run(&block)
+    process_options
+    log.level = Logger::INFO unless options[:debug]
+    log.info "#{script} starting"
+    if already_running?
+      puts "Found #{options[:pid_file]} file. Must be running already. Exiting."
+      exit
+    else
+      create_directories
+      create_pid
+    end
+    begin
+      if block_given?
+        yield
+      else
+        raise "No block given. Nothing to run."
+      end
+    rescue => e
+      log.error e.message
+      log.debug e.backtrace.join('\n')
+    ensure
+      log.info "#{script} exiting"
+      log.close
+      remove_pid
+    end
+  end
+end

data/ops_script.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ops_script/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ops_script"
+  spec.version       = OpsScript::VERSION
+  spec.authors       = ["Sanjiv Patel"]
+  spec.email         = ["sanjp2.0@gmail.com"]
+  spec.description   = %q{Gem providing log, options, and pid file handling for operational scripts}
+  spec.summary       = %q{Common features of operational scripts exctracted to a gem.  Provides a log file, options processing and pid file with decent defaults.}
+  spec.homepage      = "https://github.com/sanjp/ops_script"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: ops_script
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sanjiv Patel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem providing log, options, and pid file handling for operational scripts
+email:
+- sanjp2.0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ops_script.rb
+- lib/ops_script/version.rb
+- ops_script.gemspec
+homepage: https://github.com/sanjp/ops_script
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Common features of operational scripts exctracted to a gem.  Provides a log
+  file, options processing and pid file with decent defaults.
+test_files: []