paperbin 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf1cd912977e0f0847d562a7812fc4b5e3399968
-  data.tar.gz: 124ee2cfe0f4268eaddac9ed35ce692896c7cc14
+  metadata.gz: cd1734e70bdbdbb87410b3620a0d73bbc89e520a
+  data.tar.gz: db80f4440568848b7009025c23d3caaa472f8ad2
 SHA512:
-  metadata.gz: 21307c488260585d7a632144d23635bd9c8faaa070ad5935446f7efd8ff5c4a3ccaba02696275a1d9dbfc598321f9685d719b7cfd888c07f3b439f2f5532b7e3
-  data.tar.gz: 97468df41f6899cf2aca5fd6024c784a1e2344baf11758da243b56db6f3b94f6e0662963228f415ad2d22412183e7f42dd9428ecf5bb903bad948a5c7c0dd121
+  metadata.gz: 5ef75f0bcb767a1047f0c5ea506b8467722f25fb10328e14a95435121e3c64c04e8e5a4f356d4ccc112a309c052c6f5220d9d556a533f92ba84f07b2eecbf6d0
+  data.tar.gz: af7f8fdb2076f5457457b5700ed7291c4023e7b0ec760aa044d2cfe7da22dcdcf944b3394a48b07ae1d87e22910cf052d7f8fd97141148bce55cdd261f27120f

data/README.md

@@ -17,9 +17,10 @@ Or install it yourself as:
 
     $ gem install paperbin
 
-## Usage
+### Queues
 
-TODO: Write usage instructions here
+check worker - ENV['PAPERBIN_CHECK_QUEUE'] || 'default'
+write worker - ENV['PAPERBIN_WRITE_QUEUE'] || 'default'
 
 ## Contributing
 

data/lib/paperbin/check_worker.rb

@@ -1,5 +1,6 @@
 class Paperbin::CheckWorker
   include Sidekiq::Worker
+  sidekiq_options queue: (ENV['PAPERBIN_CHECK_QUEUE'] || 'default')
 
   def perform(item_id, item_type)
     paperbin_handler = Paperbin::Handler.new(item_id, item_type)

data/lib/paperbin/handler.rb

@@ -1,5 +1,4 @@
 class Paperbin::Handler < Struct.new(:id, :type)
-
   require 'zlib'
   require 'tempfile'
 
@@ -7,11 +6,16 @@ class Paperbin::Handler < Struct.new(:id, :type)
     "%012d" % id
   end
 
-  def split_id
+  def split
     formatted_id.scan(/.{4}/)
   end
 
-  def current_path
+  def dir_split_id
+    split[0...-1]
+  end
+
+  def archive_split_id
+    split.last
   end
 
   def options
@@ -29,10 +33,39 @@ class Paperbin::Handler < Struct.new(:id, :type)
     dirs << options[:path]
     dirs << item.send(options[:base_scope])
     dirs << type
-    dirs += split_id
+    dirs += dir_split_id
     File.join(dirs.map(&:to_s))
   end
 
+  def old_directory_path
+    File.join(directory_path, archive_split_id)
+  end
+
+  def archive_path
+    File.join(directory_path, "#{archive_split_id}.zip")
+  end
+
+  def create_archive_file
+    unless File.exists?(archive_path)
+      Zippy.create archive_path do |z|
+        z["created_at.txt"] = Date.today.to_s
+        handle_old_files(z)
+      end
+    end
+  end
+
+  def handle_old_files(z)
+    if File.directory?(old_directory_path)
+      Dir.new(old_directory_path).each do |file|
+        if file =~ /\.gz/
+          name = file.split(".").first
+          z["#{name}.json"] = Zlib::GzipReader.open(File.join(old_directory_path, file)) {|gz| gz.read }
+        end
+      end
+      FileUtils.remove_dir(old_directory_path)
+    end
+  end
+
   def versions
     Version.where(item_type: type, item_id: id)
   end
@@ -40,6 +73,7 @@ class Paperbin::Handler < Struct.new(:id, :type)
   def save_versions
     return true unless item
     create_directory
+    create_archive_file
     generate_files
     Paperbin::CheckWorker.perform_async(id, type)
   end
@@ -49,11 +83,19 @@ class Paperbin::Handler < Struct.new(:id, :type)
   end
 
   def md5_file(version)
-    File.join(directory_path, "#{version.id}.md5")
+    "#{version.id}.md5"
+  end
+
+  def md5_file_path(version)
+    File.join(directory_path, "#{md5_file(version)}")
+  end
+
+  def json_file(version)
+    "#{version.id}.json"
   end
 
-  def gz_file(version, checked = false)
-    File.join(directory_path, "#{version.id}.gz#{checked ? '' : '.unchecked'}")
+  def json_file_path(version, checked = false)
+    File.join(directory_path, "#{json_file(version)}#{checked ? '' : '.unchecked'}")
   end
 
   def files_exist?(*args)
@@ -61,8 +103,8 @@ class Paperbin::Handler < Struct.new(:id, :type)
   end
 
   def md5_valid?(version)
-    record_md5 = File.read(md5_file(version))
-    data = Zlib::GzipReader.open(gz_file(version)) {|gz| gz.read }
+    record_md5 = File.read(md5_file_path(version))
+    data = File.open(json_file_path(version), "r") { |f| f.read }
     check_md5 = Digest::MD5.hexdigest(data)
     record_md5 == check_md5
   end
@@ -71,29 +113,33 @@ class Paperbin::Handler < Struct.new(:id, :type)
     # remove records from db expcet the lastest one
     version.delete unless version == last_item
     # rename file extension
-    File.rename(gz_file(version), gz_file(version, true))
-    options[:callback].call(gz_file(version, true)) if options[:callback]
+    File.rename(json_file_path(version), json_file_path(version, true))
+    Zippy.open(archive_path) do |z|
+      z["#{json_file(version).to_s}"] = File.open(json_file_path(version, true)) { |f| f.read }
+    end
+    File.delete(md5_file_path(version))
+    File.delete(json_file_path(version, true))
+    options[:callback].call(json_file_path(version, true)) if options[:callback]
   end
 
   def generate_files
     versions.each do |version|
-      write_gz_file version
+      write_json_file version
       write_md5_file version
     end
   end
 
-  def write_gz_file(version)
-    path = gz_file version
+  def write_json_file(version)
+    path = json_file_path version
     unless files_exist?(path)
-      Zlib::GzipWriter.open(path) { |gz| gz.write string_data(version) }
-
+      File.open(path, "w") { |f| f.write(string_data(version)) }
       timestamp = version.created_at.to_time
       File.utime timestamp, timestamp, path
     end
   end
 
   def write_md5_file(version)
-    File.open(md5_file(version), "w") do |file|
+    File.open(md5_file_path(version), "w") do |file|
       md5 = Digest::MD5.hexdigest(string_data(version))
       file.write md5
     end
@@ -105,18 +151,18 @@ class Paperbin::Handler < Struct.new(:id, :type)
 
   def check_versions
     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
-          # remove both files
-          [gz_file(version), md5_file(version)].each do |f|
-            File.delete(f)
-          end
-          raise Errno::ENOENT
+      # check both file exist or not
+      next unless files_exist?(md5_file_path(version), json_file_path(version))
+
+      if md5_valid?(version)
+        process_valid_records(version, versions.last)
+      else
+        # remove both files
+        [json_file_path(version), md5_file_path(version)].each do |f|
+          File.delete(f)
         end
+        raise Errno::ENOENT
+      end
     end
   rescue Errno::ENOENT
     # lodge worker unless valid

data/lib/paperbin/version.rb

@@ -1,3 +1,3 @@
 module Paperbin
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/paperbin/write_worker.rb

@@ -1,5 +1,6 @@
 class Paperbin::WriteWorker
   include Sidekiq::Worker
+  sidekiq_options queue: (ENV['PAPERBIN_WRITE_QUEUE'] || 'default')
 
   def perform(item_id, item_type)
     paperbin_handler = Paperbin::Handler.new(item_id, item_type)

data/lib/paperbin.rb

@@ -1,5 +1,7 @@
 require 'rails'
-require 'sidekiq/worker'
+require 'sidekiq'
+require 'zippy'
+require 'fileutils'
 
 module Paperbin
   class Railtie < Rails::Railtie

data/paperbin.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "paper_trail"
   spec.add_runtime_dependency "railties", "~> 3.2"
   spec.add_runtime_dependency "activesupport", "~> 3.2"
+  spec.add_runtime_dependency "zippy"
+  spec.add_runtime_dependency "zip"
 end

data/spec/paperbin_handler_spec.rb

@@ -1,7 +1,6 @@
-require "spec_helper"
+require "./spec_helper"
 
 describe Paperbin::Handler do
-
   let(:item) { double(organisation_id: "org1") }
   let(:target_id) { '123456789' }
   let(:target_type) { 'Client' }
@@ -17,19 +16,26 @@ describe Paperbin::Handler do
     handler.formatted_id.should == "000123456789"
   end
 
-  it "split formatted_id into 3 sections" do
-    handler.split_id.should == ['0001', '2345', '6789']
+  it "split formatted_id into 2 sections" do
+    handler.dir_split_id.should == ['0001', '2345']
   end
 
-  it 'return options' do
-    handler.options.should == {path: '/path', base_scope: 'organisation_id'}
+  it "give proper file name" do
+    handler.archive_split_id.should == '6789'
   end
 
-  it "return directory" do
-    handler.directory_path.should == "/path/org1/Client/0001/2345/6789"
+  it 'return options' do
+    handler.options.should == {path: '/path', base_scope: 'organisation_id'}
   end
 
   context 'directories' do
+    it "return directory" do
+      handler.directory_path.should == "/path/org1/Client/0001/2345"
+    end
+
+    it "return old directory" do
+      handler.old_directory_path.should == "/path/org1/Client/0001/2345/6789"
+    end
 
     it 'generate directory when no exists' do
       Dir.stub(exists?: false)
@@ -42,7 +48,6 @@ describe Paperbin::Handler do
       FileUtils.should_not_receive(:mkdir_p)
       handler.create_directory
     end
-
   end
 
   context 'generate_files' do
@@ -57,7 +62,7 @@ describe Paperbin::Handler do
     end
 
     it 'create correct Gzip files' do
-      Zlib::GzipWriter.should_receive(:open).twice
+      File.should_receive(:open).exactly(4).times
       expect(File).to receive(:utime).twice.with(
         timestamp, timestamp, an_instance_of(String)
       )
@@ -76,6 +81,7 @@ describe Paperbin::Handler do
       handler.stub files_exist?: true
       File.stub rename: true, delete: true
       Paperbin::WriteWorker.stub perform_async: true
+      Zippy.stub :open
     end
 
     subject(:check_versions) { handler.check_versions }
@@ -109,7 +115,48 @@ describe Paperbin::Handler do
         check_versions
       end
     end
-
   end
 
+  context 'old folders' do
+    let(:timestamp) { Time.now }
+    let(:version_1) { double(id: 1, to_json: "json", created_at: timestamp) }
+    let(:version_2) { double(id: 2, to_json: "json", created_at: timestamp) }
+    let(:file) { double(write: true) }
+
+    before(:each) do
+      handler.stub(versions: [version_1, version_2])
+      handler.stub(:old_directory_path).and_return("./tmp1")
+      handler.stub(:directory_path).and_return("./tmp2")
+      FileUtils.mkdir_p(handler.old_directory_path)
+      FileUtils.mkdir_p(handler.directory_path)
+      Zlib::GzipWriter.open(File.join(handler.old_directory_path, "12.gz")) { |gz| gz.write "Very important json" }
+      handler.create_directory
+      handler.create_archive_file
+    end
+
+    after(:each) do
+      FileUtils.remove_dir(handler.old_directory_path) if File.directory?(handler.old_directory_path)
+      FileUtils.remove_dir(handler.directory_path) if File.directory?(handler.directory_path)
+    end
+
+    it 'should create archive file' do
+      File.exists?(handler.archive_path).should be_true
+    end
+
+    it 'archive should not be empty' do
+      Zippy.list(handler.archive_path).detect { |f| f == "12.json" }.should be_true
+    end
+
+    it "json file should be correct" do
+      data = ""
+      Zippy.open(handler.archive_path) do |z|
+        data = z["12.json"]
+      end
+      data.should == "Very important json"
+    end
+
+    it "should remove old directory" do
+      File.directory?(handler.old_directory_path).should be_false
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperbin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - morhekil
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-23 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: zippy
+  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: zip
+  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: Paperbin removes paper_trail versions and move them to filesystem
 email:
 - kotlarek.krzysztof@gmail.com