rotozipper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63527da537d574aced414d7e36c022b3936a76798fed10e00cc124fbbfc27a4a
+  data.tar.gz: 1e904b2778d018deded7678d5a0d20dd642ccbcc39c86a945d0284601fa77afa
+SHA512:
+  metadata.gz: e6a38d2628870f8c5a36b2328caf3f339d50c358926f43ed1919529c788977b886295a3228b8a0a46b02efeb4c99e3870a808a0f97fc8f36f0d435cc55161438
+  data.tar.gz: ff02fe2a50d7ff1a26e1987cb5360fc5ccca4fee698940657c1405c6e72ccf383eab2d2e03c82ebecaf7f31c8c067363a16c229ca91aa1e0fac053b5f6a30dfb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,55 @@
+# Rotozipper
+
+Rotozipper is a simple Ruby gem which aims to simplify log rotation and zipping.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rotozipper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rotozipper
+
+## Usage
+
+Usage is simple.
+The gem provides a method `launch` of the `Rotozipper` module which takes three arguments:
+
+* `glob_path` (required): the path in glob form of the folder where your logs are stored. For example, in a Rails application, you can set it to `log/*.log`.
+* `output_path` (optional): the path where you want to save the rotozipped logs. Defaults to a relative `history` folder.
+* `logger_path` (optional): the path of a log file where you want to store Rotozipper's operative logs. Defaults to `STDOUT`.
+
+For example, to rotozip logs of a Rails application, you can execute:
+
+```ruby
+Rotozipper.launch 'log/*.log', 'log/history'
+```
+
+This command will compress all the `*.log` files in the `log` folder, and the move them to `log/history` folder, adding a timestamp to keep track of the moment. The original files will be truncated to 0 bytes.
+
+## Scheduling - Rails
+
+Rotozipper has `whenever` as a gem dependency, so if you need to schedule the rotozipping of your logs, you can simply create a file named `config/schedule.rb` in your Rails application, and then add the following lines:
+
+```ruby
+# config/schedule.rb
+
+every :week, at: '00:00' do
+  runner %{ Rotozipper.launch 'log/*.log', 'log/history' }
+end
+```
+
+And then schedule it by running the command `whenever --update-crontab`.
+Please refer to [whenever](https://github.com/javan/whenever) documentation to know more about it features.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Pluve/ruby-rotozipper.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rotozipper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rotozipper.rb

@@ -0,0 +1,60 @@
+require "zlib"
+require "active_support/core_ext/array"
+require "rotozipper/version"
+require "rotozipper/rainbow"
+
+module Rotozipper
+  class Error < StandardError; end
+
+  class Logger
+    
+    attr_accessor :logger
+
+    def initialize(logger_path)
+      @logger = ::Logger.new logger_path
+    end
+
+    def puts(message)
+      @logger.info message
+    end
+
+  end
+  
+  ##
+  # Rotates and zips each file in specified directory.
+  #
+  # @param [String] glob_path source directory glob path.
+  # @param [String] output_path directory which contains zipped and rotates files.
+  # @param [String] logger_path an optional logger file as output.
+  #
+  # @return [nil]
+  def self.launch(glob_path, output_path = 'history', logger_path = nil)
+    logger = logger_path.present? ? Rotozipper::Logger.new(logger_path) : $stdout
+    logger.puts "Beginning to rotozip folder #{glob_path}..".darkorchid
+    unless Dir.exists? output_path
+      logger.puts "Creating output folder '#{output_path}'..".darkorchid
+      FileUtils.mkdir_p output_path
+    end
+    
+    log_files = Dir.glob(glob_path)
+    logger.puts "Found #{log_files.count} files.".darkorchid
+    log_files.each do |log_file|
+      unless File.file? log_file
+        logger.puts "Skipping resource '#{log_file}' as it is not a file.".darkorchid
+        next
+      end
+      log_file_basename = File.basename log_file, File.extname(log_file)
+      zipped_file = "#{output_path}/#{log_file_basename}-#{Time.current.strftime('%Y%m%d-%H%M%S-%L')}.gz"
+      Zlib::GzipWriter.open(zipped_file) do |gz|
+        gz.mtime = File.mtime(log_file)
+        gz.orig_name = log_file
+        gz.write IO.binread(log_file)
+      end
+      File.truncate(log_file, 0)
+      logger.puts "Rotozipped file '#{log_file}' to '#{zipped_file}'.".darkorchid
+    end
+
+    logger.puts "Rotozip completed!".darkorchid
+  end
+
+end

data/lib/rotozipper/rainbow.rb

@@ -0,0 +1,25 @@
+##
+# Crea un metodo per ogni colore da poter chiamare su un'istanza di una stringa.
+
+class String
+
+  %i( aliceblue antiquewhite aqua aquamarine azure beige bisque blanchedalmond blue blueviolet brown burlywood
+    cadetblue chartreuse chocolate coral cornflower cornsilk crimson cyan darkblue darkcyan darkgoldenrod
+    darkgray darkgreen darkkhaki darkmagenta darkolivegreen darkorange darkorchid darkred darksalmon
+    darkseagreen darkslateblue darkslategray darkturquoise darkviolet deeppink deepskyblue dimgray
+    dodgerblue firebrick floralwhite forestgreen fuchsia gainsboro ghostwhite gold goldenrod gray
+    green greenyellow honeydew hotpink indianred indigo ivory khaki lavender lavenderblush lawngreen
+    lemonchiffon lightblue lightcoral lightcyan lightgoldenrod lightgray lightgreen lightpink lightsalmon
+    lightseagreen lightskyblue lightslategray lightsteelblue lightyellow lime limegreen linen magenta maroon
+    mediumaquamarine mediumblue mediumorchid mediumpurple mediumseagreen mediumslateblue mediumspringgreen
+    mediumturquoise mediumvioletred midnightblue mintcream mistyrose moccasin navajowhite navyblue oldlace
+    olive olivedrab orange orangered orchid palegoldenrod palegreen paleturquoise palevioletred papayawhip
+    peachpuff peru pink plum powderblue purple rebeccapurple red rosybrown royalblue saddlebrown salmon sandybrown
+    seagreen seashell sienna silver skyblue slateblue slategray snow springgreen steelblue tan teal
+    thistle tomato turquoise violet webgray webgreen webmaroon webpurple wheat whitesmoke yellow yellowgreen ).each do |color|
+      self.define_method color do
+        Rainbow(self).send(:color, color)
+      end
+    end
+
+end

data/lib/rotozipper/version.rb

@@ -0,0 +1,3 @@
+module Rotozipper
+  VERSION = "0.1.0"
+end

data/rotozipper.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rotozipper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rotozipper"
+  spec.version       = Rotozipper::VERSION
+  spec.authors       = ["Francesco Ballardin"]
+  spec.email         = ["francesco.ballardin@gmail.com"]
+
+  spec.summary       = %q{A tool to help you rotate and zip your ruby app logs.}
+  spec.description   = %q{A tool to help you rotate and zip your ruby app logs.}
+  spec.homepage      = "https://github.com/Pluvie/ruby-rotozipper"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "whenever"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rotozipper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francesco Ballardin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A tool to help you rotate and zip your ruby app logs.
+email:
+- francesco.ballardin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rotozipper.rb
+- lib/rotozipper/rainbow.rb
+- lib/rotozipper/version.rb
+- rotozipper.gemspec
+homepage: https://github.com/Pluvie/ruby-rotozipper
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A tool to help you rotate and zip your ruby app logs.
+test_files: []