bmc-daemon-lib 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54cb8d5ebed46ef42910b486dd3cb4bb6cf7267d
+  data.tar.gz: 783a704b84e1737b60f495dbda942a4bb5e21d2b
+SHA512:
+  metadata.gz: f939c454cdb4a2b0e95b024448f58aebe910638b4cf093a6de7897c369c4b06f0537c17a9356967e9522734ca23c98344f6d53d9c4d09b518193c792606164f9
+  data.tar.gz: 3bc34da2d06b8573eb8f45ba8a0c3e6d1ef42257352e8cf2cd8fe4cdf7d8f96602e8f46284a105e1a6eaf8b97e88537a0ff4f8a8cbfefbcc5b0964d287caab17

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    bmc-daemon-lib (0.1.1)
+      chamber (~> 2.9)
+      newrelic_rpm
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    chamber (2.9.0)
+      hashie (~> 3.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    hashie (3.4.4)
+    newrelic_rpm (3.16.0.318)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rainbow (2.1.0)
+    rake (11.2.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.1)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.41.2)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    thor (0.19.1)
+    unicode-display_width (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bmc-daemon-lib!
+  bundler (~> 1.6)
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Bruno Medici
+
+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 @@
+# bmc-daemon-lib

data/Rakefile

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require "rubygems"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+# Run specs by default
+desc "Run all tests"
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = false
+end
+
+task default: [:spec, :rubocop]

data/bmc-daemon-lib.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  # Project version
+  spec.version                      = "0.1.1"
+
+  # Project description
+  spec.name                         = "bmc-daemon-lib"
+  spec.authors                      = ["Bruno MEDICI"]
+  spec.email                        = "bmc-daemon-lib@bmconseil.com"
+  spec.description                  = "Shared utilities to build a daemon: logger, configuration, helpers"
+  spec.summary                      = spec.description
+  spec.homepage                     = "http://github.com/bmedici/bmc-daemon-lib"
+  spec.licenses                     = ["MIT"]
+  spec.date                         = Time.now.strftime("%Y-%m-%d")
+
+  # List files and executables
+  spec.files                        = `git ls-files -z`.split("\x0")
+  spec.executables                  = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths                = ["lib"]
+  spec.required_ruby_version        = ">= 2.2"
+
+  # Development dependencies
+  spec.add_development_dependency   "bundler", "~> 1.6"
+  spec.add_development_dependency   "rake"
+  spec.add_development_dependency   "rspec"
+  spec.add_development_dependency   "rubocop"
+
+  # Runtime dependencies
+  spec.add_runtime_dependency       "chamber", "~> 2.9"
+  spec.add_runtime_dependency       "newrelic_rpm"
+end

data/lib/bmc-daemon-lib/conf.rb

@@ -0,0 +1,201 @@
+# FIXME: files named with hyphens will not be found by Chamber for now
+require "chamber"
+
+module BmcDaemonLib
+  class ConfigMissingParameter    < StandardError; end
+  class ConfigOtherError          < StandardError; end
+  class ConfigParseError          < StandardError; end
+  class ConfigMultipleGemspec     < StandardError; end
+  class ConfigMissingGemspec      < StandardError; end
+
+  class Conf
+    extend Chamber
+    PIDFILE_DIR = "/tmp/"
+
+    class << self
+      attr_accessor :app_env
+      attr_reader   :app_root
+      attr_reader   :app_libs
+      attr_reader   :app_name
+      attr_reader   :app_ver
+      attr_reader   :app_started
+      attr_reader   :app_spec
+      attr_reader   :files
+      attr_reader   :host
+    end
+
+    def self.init app_root
+      # Permanent flags
+      @initialized  = true
+      @app_started  = Time.now
+
+      # Default values
+      @files        ||= []
+      @app_name     ||= "app_name"
+      @app_env      ||= "production"
+      @host         ||= `hostname`.to_s.chomp.split(".").first
+
+      # Store and clean app_root
+      @app_root = File.expand_path(app_root)
+
+      # Try to find any gemspec file
+      matches   = Dir["#{@app_root}/*.gemspec"]
+      fail ConfigMissingGemspec, "gemspec file not found: #{gemspec_path}" if matches.size < 1
+      fail ConfigMultipleGemspec, "gemspec file not found: #{gemspec_path}" if matches.size > 1
+
+      # Load Gemspec (just the only match)
+      @spec     = Gem::Specification::load(matches.first)
+      @app_name = @spec.name
+      @app_ver  = @spec.version
+      fail ConfigMissingParameter, "gemspec: missing name" unless @app_name
+      fail ConfigMissingParameter, "gemspec: missing version" unless @app_ver
+
+      # Now we know app_name, initalize app_libs
+      @app_libs = File.expand_path("lib/#{@app_name}/", @app_root)
+
+      # Add other config files
+      #add_default_config
+      add_config generate(:config_defaults)
+      add_config generate(:config_etc)
+
+      # Return something
+      return @app_name
+    end
+
+    def self.prepare args = {}
+      ensure_init
+
+      # Add extra config file and load them all
+      add_config args[:config]
+      reload!
+
+      # Set Rack env
+      ENV["RACK_ENV"] = @app_env.to_s
+
+      # Set up encodings
+      Encoding.default_internal = "utf-8"
+      Encoding.default_external = "utf-8"
+
+      # Init New Relic
+      newrelic_logfile = File.expand_path(Conf[:logs][:newrelic].to_s, Conf[:logs][:path].to_s)
+      prepare_newrelic self[:newrelic], newrelic_logfile
+
+      # Try to access any key to force parsing of the files
+      self[:dummy]
+
+    rescue Psych::SyntaxError => e
+      fail ConfigParseError, e.message
+    rescue StandardError => e
+      fail ConfigOtherError, "#{e.message} \n #{e.backtrace.to_yaml}"
+    end
+
+    # Reload files
+    def self.reload!
+      ensure_init
+      load_files
+    end
+
+    def self.dump
+      ensure_init
+      to_hash.to_yaml(indent: 4, useheader: true, useversion: false )
+    end
+
+    # Direct access to any depth
+    def self.at *path
+      ensure_init
+      path.reduce(Conf) { |m, key| m && m[key.to_s] }
+    end
+
+    def self.newrelic_enabled?
+      ensure_init
+      self[:newrelic] && self[:newrelic][:licence]
+    end
+
+    # Defaults generators
+    def self.generate what
+      ensure_init
+      return case what
+
+      when :user_agent
+        "#{@app_name}/#{@app_ver}" if @app_name && @app_ver
+
+      when :config_defaults
+        "#{@app_root}/defaults.yml" if @app_root
+
+      when :config_etc
+        "/etc/#{@app_name}.yml" if @app_name
+
+      when :process_name
+        parts = [@app_name, @app_env]
+        parts << self[:port] if self[:port]
+        parts.join('-')
+
+      when :pidfile
+        process_name = self.generate(:process_name)
+        File.expand_path "#{process_name}.pid", PIDFILE_DIR
+
+      when :config_message
+        config_defaults = self.generate(:config_defaults)
+        config_etc = self.generate(:config_etc)
+
+        "A default configuration is available (#{config_defaults}) and can be copied to the default location (#{config_etc}): \n sudo cp #{config_defaults} #{config_etc}"
+
+      end
+    end
+
+
+  protected
+
+    def self.load_files
+      load files: @files, namespaces: { environment: @app_env }
+    end
+
+    def self.add_config path
+      @files << File.expand_path(path) if path && File.readable?(path)
+    end
+
+    def self.prepare_newrelic section, logfile
+      # Disable NewRelic if no config present
+      unless self.newrelic_enabled?
+        ENV["NEWRELIC_AGENT_ENABLED"] = "false"
+        return
+      end
+
+      # Enable GC profiler
+      GC::Profiler.enable
+
+      # Enable module
+      ENV["NEWRELIC_AGENT_ENABLED"] = "true"
+      ENV["NEW_RELIC_MONITOR_MODE"] = "true"
+
+      # License
+      ENV["NEW_RELIC_LICENSE_KEY"] = section[:licence].to_s
+
+      # Build NewRelic app_name if not provided as-is
+      if section[:app_name]
+        ENV["NEW_RELIC_APP_NAME"] = section[:app_name].to_s
+      else
+        stack = []
+        stack << (section[:prefix] || @app_name)
+        stack << section[:platform] if section[:platform]
+        stack << @app_env
+        text = stack.join('-')
+        ENV["NEW_RELIC_APP_NAME"] = "#{text}-#{host};#{text}"
+      end
+
+      # Logfile
+      ENV["NEW_RELIC_LOG"] = logfile.to_s if logfile
+    end
+
+  private
+
+    def self.ensure_init
+      # Skip is already done
+      return if @initialized
+
+      # Go through init if not already done
+      self.init
+    end
+
+  end
+end

data/lib/bmc-daemon-lib.rb

@@ -0,0 +1,4 @@
+require_relative "bmc-daemon-lib/logger_formatter"
+require_relative "bmc-daemon-lib/logger_helper"
+require_relative "bmc-daemon-lib/conf"
+require_relative "bmc-daemon-lib/worker_base"

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: bmc-daemon-lib
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Bruno MEDICI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: chamber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: newrelic_rpm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Shared utilities to build a daemon: logger, configuration, helpers'
+email: bmc-daemon-lib@bmconseil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bmc-daemon-lib.gemspec
+- lib/bmc-daemon-lib.rb
+- lib/bmc-daemon-lib/conf.rb
+homepage: http://github.com/bmedici/bmc-daemon-lib
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: 'Shared utilities to build a daemon: logger, configuration, helpers'
+test_files: []