paperbin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ab37ed5abe9f64b0012d4ecdb5fe84ec604e124
+  data.tar.gz: 5fcf761a96a85066ae001471764abbfe86d199f3
+SHA512:
+  metadata.gz: d0dc66a0a125025a854697a089dddd6dcb4f04e122876851719ef3e43274cb5ff9b3df9a09a7c926584329b23ecc8b2209186ae270d3d58dd54c8e13ace92c57
+  data.tar.gz: 29e6765658c20f2086fee30fd1ca2e09e01561d2acf73ffff8d8bcc9b1a8ff4346aedcaf1ef7c3957a178788f37ebf12fe4c390857bf391afc931df95983bbd8

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paperbin.gemspec
+gemspec
+gem 'rspec'
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Krzysztof Kotlarek
+
+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,30 @@
+# Paperbin
+
+TODO: 
+To move papertrail's version records to file system as JSON format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paperbin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperbin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/paperbin/check_worker.rb

@@ -0,0 +1,8 @@
+class Paperbin::CheckWorker
+  include Sidekiq::Worker
+
+  def perform(item_id, item_type)
+    paperbin_handler = Paperbin::Handler.new(item_id, item_type)
+    paperbin_handler.check_versions
+  end
+end

data/lib/paperbin/config.rb

@@ -0,0 +1,5 @@
+class Paperbin::Config < Struct.new(:options)
+  def self.default_options
+    @default_options ||= {}
+  end
+end

data/lib/paperbin/handler.rb

@@ -0,0 +1,120 @@
+class Paperbin::Handler < Struct.new(:id, :type)
+
+  require 'zlib'
+  require 'tempfile'
+
+  def formatted_id
+    "%012d" % id
+  end
+
+  def split_id
+    formatted_id.scan(/.{4}/)
+  end
+
+  def current_path
+  end
+
+  def options
+    Paperbin::Config.default_options
+  end
+
+  def item
+    scope = type.constantize
+    scope = scope.with_deleted if scope.respond_to?(:with_deleted)
+    scope.where(id: id).first
+  end
+
+  def directory_path
+    dirs = []
+    dirs << options[:path]
+    dirs << item.send(options[:base_scope])
+    dirs << type
+    dirs += split_id
+    File.join(dirs.map(&:to_s))
+  end
+
+  def versions
+    Version.where(item_type: type, item_id: id)
+  end
+
+  def save_versions
+    return true unless item
+    create_directory
+    generate_files
+    Paperbin::CheckWorker.perform_async(id, type)
+  end
+
+  def create_directory
+    FileUtils.mkdir_p(directory_path) unless Dir.exists?(directory_path)
+  end
+
+  def md5_file(version)
+    File.join(directory_path, "#{version.id}.md5")
+  end
+
+  def gz_file(version, checked = false)
+    File.join(directory_path, "#{version.id}.gz#{checked ? '' : '.unchecked'}")
+  end
+
+  def files_exist?(*args)
+    Array(args).map{|file| File.exist?(file)}.all?
+  end
+
+  def md5_valid?(version)
+    record_md5 = File.read(md5_file(version))
+    data = Zlib::GzipReader.open(gz_file(version)) {|gz| gz.read }
+    check_md5 = Digest::MD5.hexdigest(data)
+    record_md5 == check_md5
+  end
+
+  def process_valid_records(version, last_item)
+    # remove records from db expcet the lastest one
+    unless version == last_item
+      version.delete
+      options[:callback].call(gz_file(version, true)) if options[:callback]
+    end
+    # rename file extension
+    File.rename(gz_file(version), gz_file(version, true))
+
+  end
+
+  def generate_files
+    versions.each do |version|
+      data = version.to_json
+      unless files_exist?(gz_file(version))
+        Zlib::GzipWriter.open(gz_file(version)) do |gz|
+          gz.write data
+        end
+      end
+
+      File.open(md5_file(version), "w") do |file|
+        file.write(Digest::MD5.hexdigest(data))
+      end
+
+    end
+  end
+
+  def check_versions
+    valid = true
+    versions.each_with_index do |version, index|
+      # check both file exist or not
+      next unless files_exist?(md5_file(version), gz_file(version))
+
+      if md5_valid?(version)
+        process_valid_records(version, versions.last)
+      else
+        valid = false
+        # remove both files
+        [gz_file(version), md5_file(version)].each do |f|
+          File.delete(f)
+        end
+      end
+    end
+
+    # lodge worker unless valid
+    Paperbin::WriteWorker.perform_async(version.item_id, version.item_type) unless valid
+
+  end
+end
+
+

data/lib/paperbin/version.rb

@@ -0,0 +1,3 @@
+module Paperbin
+  VERSION = "0.0.1"
+end

data/lib/paperbin/version_mixin.rb

@@ -0,0 +1,15 @@
+require "active_support/concern"
+
+module Paperbin::VersionMixin
+  extend ActiveSupport::Concern
+
+  included do
+    after_create :perform_worker
+  end
+
+  def perform_worker
+    Paperbin::WriteWorker.perform_async(item_id, item_type)
+  end
+
+end
+

data/lib/paperbin/write_worker.rb

@@ -0,0 +1,8 @@
+class Paperbin::WriteWorker
+  include Sidekiq::Worker
+
+  def perform(item_id, item_type)
+    paperbin_handler = Paperbin::Handler.new(item_id, item_type)
+    paperbin_handler.save_versions
+  end
+end

data/lib/paperbin.rb

@@ -0,0 +1,17 @@
+require 'rails'
+require 'sidekiq/worker'
+
+module Paperbin
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      Version.send(:include, Paperbin::VersionMixin)
+    end
+  end
+end
+
+require 'paperbin/version'
+require 'paperbin/handler'
+require 'paperbin/check_worker'
+require 'paperbin/write_worker'
+require 'paperbin/version_mixin'
+require 'paperbin/config'

data/paperbin.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperbin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperbin"
+  spec.version       = Paperbin::VERSION
+  spec.authors       = ["morhekil","sameera207", "noma4i", "lis2", "halhenke", "gzzengwei"]
+  spec.email         = ["kotlarek.krzysztof@gmail.com"]
+  spec.description   = %q{Paperbin removes paper_trail versions and move them to filesystem}
+  spec.summary       = %q{,Paperbin removes paper_trail versions and move them to filesyste}
+  spec.homepage      = "https://github.com/jnsolutions/paperbin"
+  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"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "sidekiq"
+  spec.add_runtime_dependency "paper_trail"
+  spec.add_runtime_dependency "railties", "~> 3.2"
+  spec.add_runtime_dependency "activesupport", "~> 3.2"
+end

data/spec/paperbin_handler_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Paperbin::Handler do
+
+  let(:item) { double(organisation_id: "org1") }
+
+  subject { Paperbin::Handler.new("123456789", "client") }
+  before(:each) do
+    Paperbin::Config.default_options[:path] = '/path'
+    Paperbin::Config.default_options[:base_scope] = 'organisation_id'
+    subject.stub(item: item)
+  end
+
+  it "return correct formatted_id" do
+    subject.formatted_id.should == "000123456789"
+  end
+
+  it "split formatted_id into 3 sections" do
+    subject.split_id.should == ['0001', '2345', '6789']
+  end
+
+  it 'return options', focus: true do
+    subject.options.should == {path: '/path', base_scope: 'organisation_id'}
+  end
+
+  it "return directory" do
+    subject.directory_path.should == "/path/org1/client/0001/2345/6789"
+  end
+
+  context 'directories' do
+
+    it 'generate directory when no exists' do
+      Dir.stub(exists?: false)
+      FileUtils.should_receive(:mkdir_p)
+      subject.create_directory
+    end
+
+    it 'dont generate directory when exists' do
+      Dir.stub(exists?: true)
+      FileUtils.should_not_receive(:mkdir_p)
+      subject.create_directory
+    end
+
+  end
+
+  context 'generate_files' do
+
+    let(:version_1) { double(id: 1, to_json: "json") }
+    let(:version_2) { double(id: 2, to_json: "json") }
+    let(:file) { double(write: true) }
+
+    before do
+      subject.stub(versions: [version_1, version_2])
+      File.stub(open: file)
+    end
+
+    it 'create correct Gzip files' do
+      Zlib::GzipWriter.should_receive(:open).twice
+      subject.generate_files
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'paperbin'
+

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: paperbin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- morhekil
+- sameera207
+- noma4i
+- lis2
+- halhenke
+- gzzengwei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-16 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'
+- !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: sidekiq
+  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: paper_trail
+  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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Paperbin removes paper_trail versions and move them to filesystem
+email:
+- kotlarek.krzysztof@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperbin.rb
+- lib/paperbin/check_worker.rb
+- lib/paperbin/config.rb
+- lib/paperbin/handler.rb
+- lib/paperbin/version.rb
+- lib/paperbin/version_mixin.rb
+- lib/paperbin/write_worker.rb
+- paperbin.gemspec
+- spec/paperbin_handler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jnsolutions/paperbin
+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.1.11
+signing_key: 
+specification_version: 4
+summary: ',Paperbin removes paper_trail versions and move them to filesyste'
+test_files:
+- spec/paperbin_handler_spec.rb
+- spec/spec_helper.rb