beam 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58e6c2bf43f67b5f0f1b96c2220babda0120320d
-  data.tar.gz: 8fe1ccd8320c5b03875c9e8ea7de2f2315b9d824
+  metadata.gz: 5c4e5a271a4c1f2ef66f9f168b3f4345eafde0ad
+  data.tar.gz: 437c2586fe8b5e86d0abab316919140edf088a62
 SHA512:
-  metadata.gz: 373dc353a9f0f00002a4c4a1df2fde2d3aba08adbc8fc78f0b178618297d9afda5ade0bc7f1800f277d8eb6acc1b919dce7290013a73ffd8b524239d5d0306bc
-  data.tar.gz: f3efa60222fd1d9686aeb3fd0f8fe00ad06389c063faf3fc6f7791af3d02e6fe32c83f4024b8fac5464a7f8e39fe4a4f2dbe19b2caf864d596d2eab620b21594
+  metadata.gz: 0090185c4e8d80a8fb0423e1745e1bd71e2e924523f24462b745093730d54de3703605fe185bc14c91a191f64f01db6582882ceacf9cd1dd1727079bc8574312
+  data.tar.gz: 4bec5391d891d18baded2a0d6dca88f916b01481f07e8f5c8bdf7b93f3f19d9b78c673f92fdf2072075d9e0962e7c223f3456d516c2dcca2157ea383b87b158b

data/.gitignore

@@ -0,0 +1,5 @@
+/coverage
+/spec/dummy/log/*
+/tmp/*
+/spec/dummy/db/*.sqlite3
+Guardfile

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "1.9.3"
+env:
+  - DB=sqlite
+script:
+  - bundle exec rake db:migrate
+  - bundle exec rake spec

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 1.0.0
+- Added upload_controller_methods for easy controller integration
+- Refactored configuration options
+- View snippet for ease in upload file
+- Complete test suite
+
 ### 0.0.3
 - Zipped CSV files are optional now
 - Various configuration options moved to initializers

data/Gemfile.lock

@@ -1,17 +1,181 @@
 PATH
   remote: .
   specs:
-    beam (0.0.3)
+    beam (1.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activerecord-import (0.4.0)
+      activerecord (>= 3.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.1)
+    atomic (1.1.14)
+    builder (3.1.4)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.0.9)
+    columnize (0.3.6)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    debugger (1.6.5)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.1)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.1)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-bundler (1.0.0)
+      bundler (~> 1.0)
+      guard (~> 1.1)
+    guard-rspec (3.0.3)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    guard-spork (1.5.1)
+      childprocess (>= 0.2.3)
+      guard (>= 1.1)
+      spork (>= 0.8.4)
+    hike (1.2.3)
+    i18n (0.6.9)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
     rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rspec-rails (2.14.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+    spork (1.0.0rc4)
+    sprockets (2.10.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.8)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tilt (1.4.1)
+    tins (0.12.0)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord-import (= 0.4.0)
   beam!
   bundler (~> 1.3)
+  coveralls
+  debugger (~> 1.6.5)
+  guard-bundler
+  guard-rspec
+  guard-spork
+  rails
   rake
+  rb-fsevent
+  rspec
+  rspec-rails
+  shoulda-matchers
+  spork (~> 1.0rc)
+  sqlite3

data/README.md

@@ -1,4 +1,5 @@
 # Beam
+[![Gem Version](https://badge.fury.io/rb/beam.png)](http://badge.fury.io/rb/beam) [![Build Status](https://travis-ci.org/gouravtiwari/beam.png?branch=master)](https://travis-ci.org/gouravtiwari/beam) [![Coverage Status](https://coveralls.io/repos/gouravtiwari/beam/badge.png?branch=master)](https://coveralls.io/r/gouravtiwari/beam?branch=master)
 
 A rubygem to simplifiy repetitive csv upload process for ActiveRecord models in rails applications. 
 Supports bulk upload with [activerecord-import](http://rubygems.org/gems/activerecord-import)
@@ -49,21 +50,50 @@ Supports bulk upload with [activerecord-import](http://rubygems.org/gems/activer
     # Test4,test4@test.com
     ```
 
-4. Get the output as:
+4. Only if you would like to use upload_controller_methods (to help you upload files zipped-csv files, as fake.csv.zip) include below routes in config/routes.rb (for fake_controller):
+    ```ruby
+    post "fake/upload", to: "fake#upload"
+    get  "fake/error_file", to: "fake#error_file"
+    ```
+    include these methods in the controller:
+    ```ruby
+    class FakeController < ApplicationController
+      include Beam::UploadControllerMethods
+    end
+    ...
+    ...
+    ```
+    and add view snippet to app/views/fake/upload_form.html.erb
+    ```ruby
+    <%= form_tag users_upload_path, :multipart => true do %>
+    <%= file_field_tag 'upload[upload_file]'%>
+      <%= submit_tag "Upload" %>
+    <% end %>
+    ```
+
+5. Get the output as:
   
     ```ruby
     # response hash, e.g. 
       {:errors=>1, :status=>200, :total_rows=>4, :error_rows=>[["Test1", nil, "is invalid"]]}
     # error file, e.g.
-      for users.csv file, it creates errors_users.csv at the same path
+    # for users.csv file, it creates errors_users.csv at the same path specified in Beam.config (Rails.root+'/tmp')
     # see records being saved in batch(by default) of 1_000 with activerecord-import gem
     ```
 
-See beam/upload.rb for more details
+## Configuration options:
+
+Default configurations, to change these, update config/initializers/beam.rb:
+Beam.config[:error_file_needed] = true
+Beam.config[:batch_process]     = true
+Beam.config[:batch_size]        = 1_000
+Beam.config[:zipped]            = true
+Beam.config[:data_upload_path]  = "#{Rails.root}/tmp"
+
 
 ## TO DO
 
-SPECS!
+SideKiq & DelayedJob options
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,36 @@
 require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AuditRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/beam.gemspec

@@ -20,5 +20,18 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord-import", '0.4.0'
 
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "spork", '~>1.0rc'
+  spec.add_development_dependency "guard-spork"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "rb-fsevent"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "debugger", "~> 1.6.5"
+  spec.add_development_dependency "coveralls"
 end

data/lib/beam.rb

@@ -1,4 +1,24 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require "beam/version"
 require 'beam/extensions/exception'
+
+module Beam
+  def self.root
+    File.expand_path '../..', __FILE__
+  end
+
+  def self.lib
+    File.join root, 'lib'
+  end
+
+  def self.tmp
+    File.join root, 'tmp'
+  end
+
+  def self.spec
+    File.join root, 'spec'
+  end
+end
+
 require 'beam/upload'
+require 'beam/upload_controller_methods'

data/lib/beam/extensions/exception.rb

@@ -1,10 +1,10 @@
 class Exception
   def formatted_exception(error_message)
-    <<-ERROR
-      An error occurred while #{error_message}:
-      Type: #{self.class.name}
-      Message:  #{self.message}
-      Backtrace:\n#{self.backtrace.join("\n")}
-    ERROR
+<<-ERROR
+  An error occurred while #{error_message}:
+  Type: #{self.class.name}
+  Message:  #{self.message}
+  Backtrace:\n#{self.backtrace.join("\n")}
+ERROR
   end
 end

data/lib/beam/upload.rb

@@ -6,24 +6,16 @@ module Beam
     #                   for batch processing
     # batch_size:       default is 1_000, change it to batch of records you want to upload
     # zipped:           set it to true if uploaded file is zipped
-    @config = {
+    # data_upload_path: should be set to Rails.root + '/tmp'
+    mattr_accessor :config
+    @@config = {
       error_file_needed:  true,
       batch_process:      true,
       batch_size:         1_000,
-      zipped:             true
+      zipped:             true,
+      data_upload_path:   Rails.root ? Rails.root + '/tmp' : Beam.tmp
     }
 
-    @valid_config_keys = @config.keys
-
-    # Configure through hash
-    def self.configure(opts = {})
-      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
-    end
-
-    def self.config
-      configure(@config)
-    end
-
   module Upload
     def upload_config
       @error_file_needed  = Beam.config[:error_file_needed]
@@ -35,7 +27,7 @@ module Beam
     # params:
     #       file_name:        zip file name, e.g. users.csv.zip
     #       file_path:        path/to/zip-file, e.g. Rails.root/tmp
-    #       callback_method:  method which does the job to load records, default is parse method
+    #       callback_method:  method which does the job to parse CSV and load records, default is parse method
     def upload_file(file_name, file_path, callback_method='parse')
       status = {}
       upload_config
@@ -55,6 +47,8 @@ module Beam
         error_in_upload([[invalid_file_message]]) if @error_file_needed
         Rails.logger.error e.formatted_exception("Uploading file #{@file_name} failed!")
         status = { errors: 1, status: 500}
+      ensure
+        File.delete @original_zip_file if File.exists?(@original_zip_file)
       end
       status
     end
@@ -125,7 +119,8 @@ module Beam
         import_from_batch(batch)
       rescue Exception => e
         response[:errors] = 1
-        log_and_return_error({}, e, '')
+        response[:error_rows] = log_and_return_error({}, e, '')
+        response[:status] = 500
       end
 
       if response[:error_rows].blank?

data/lib/beam/upload_controller_methods.rb

@@ -0,0 +1,112 @@
+module Beam
+  module UploadControllerMethods
+    attr_accessor :model, :upload_method  
+
+    def upload
+      @upload_status = file_upload_status(params)
+      @upload_status.merge!(additional_params_on_success) if @upload_status[:success_msg]
+
+      respond_to do |format|
+        format.json { render json: @upload_status }
+        format.html { redirect_to :back }
+      end
+    end
+
+    def error_file
+      send_file "#{Beam.config[:data_upload_path]}/errors_#{self.controller_name.downcase}.csv"
+    end
+    
+    def self.included(base)
+      private
+
+      # hook for post successful upload, in case additional parameters need to be send
+      def additional_params_on_success
+        {}
+      end
+
+      def zip_file?(file)
+        ["application/zip", "application/x-zip-compressed", "application/octet-stream"].include?(file.content_type)  && file.original_filename.include?(".zip")
+      end
+
+      def file_upload_status(params)
+        file_obj = params[:upload] ? params[:upload][:upload_file] : params[:files][0]
+
+        status = file_obj ? file_status(file_obj) : not_file_status
+        status[:message] = status[:num_errors] && status[:num_errors].zero? ? status[:success_msg] : status[:error_msg]
+        status[:status] = status[:message] == status[:success_msg] ? "success" : "failure"
+        status[:status_code] = status[:message] == status[:success_msg] ? 200 : 500
+        status
+      end
+
+      def file_status(file)
+        zip_file?(file) ? csv_file_status(file) : not_csv_file_status
+      end
+
+      def not_file_status
+        {error_msg: "No file detected, please upload a file"}
+      end
+
+      def csv_file_status(file)
+        response = upload_file(file)
+        upload_status_by_response(response)
+      end
+
+      def upload_file(file)
+        require 'fileutils'
+        @model ||= controller_name.classify.constantize
+        tmp = file.tempfile
+        file_path = File.join(Beam.config[:data_upload_path], file.original_filename)
+        FileUtils.cp_r tmp.path, file_path, remove_destination: true
+
+        @upload_method ? 
+          @model.upload_file(file.original_filename, Beam.config[:data_upload_path], @upload_method) :
+          @model.upload_file(file.original_filename, Beam.config[:data_upload_path])
+      end
+
+      def not_csv_file_status
+        {error_msg: "Only zipped csv files are allowed"}
+      end
+
+      def upload_status_by_response(response)
+        if response[:status] == 500
+          failure_status
+        else
+        response[:errors].zero? ? 
+          upload_without_queue_success_status :
+          upload_without_queue_failure_status(response[:errors])
+        end
+      end
+
+      def failure_status
+        {num_errors: 1, controller_name: self.controller_name, error_msg: "Please check the format of zipped file"}
+      end
+
+      def upload_through_queue_status(errors)
+        { 
+          num_errors:      nil,
+          controller_name: self.controller_name,
+          success_msg:     "In Progress"
+        }   
+      end
+
+      def upload_without_queue_success_status
+        { 
+          num_errors:      0,
+          controller_name: self.controller_name,
+          success_msg:     "File uploaded successfully"
+        }
+      end
+
+      def upload_without_queue_failure_status(errors)
+        { 
+          num_errors:      errors,
+          controller_name: self.controller_name,
+          error_msg:       "There are #{errors} row(s) with errors while uploading config file." + 
+                            " Please check whether you have selected correct module or you have valid data in the file."
+        }
+      end
+      
+    end
+   
+  end
+end