beam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4537b1cefd669c45e4db6e2feee8ba8644405fc7
+  data.tar.gz: aea8de9386ece2ccf66636201dd97c43ebf00830
+SHA512:
+  metadata.gz: 571b1f9e6e89fde10ace7122e58425248a3ba14e13414b7fdf19cee2a3aeb7e328a19f3b5cbf8d0eaf4a1edbffbd1f292fc7a52133948b25dfb04af771cac0f7
+  data.tar.gz: 25b4e17a6e0bf135e5343cf54bf84a29e8987f248afbfcb3623ea2f8b3f238c4a295dd015b630d9a0fb6c1e7d06c42d0ae880e210113eebfacce1e886a497374

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### 0.0.1
+- Basic version of csv uploader

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    beam (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  beam!
+  bundler (~> 1.3)
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gourav Tiwari
+
+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,37 @@
+# Beam
+
+A rubygem to simplifiy repetitive csv upload process for ActiveRecord models
+
+## Usage
+
+1. Add it to the model you want to import csv file
+
+    extend Beam::Upload
+
+2. Upload zipped csv file, e.g. users.csv.zip
+
+    Model.upload_file(file_name, file_path)
+    
+    # where users.csv has headers and rows, e.g.:
+    # name,email
+    # Test1,
+    # Test2,test2@test.com
+    # Test3,test3@test.com
+    # Test4,test4@test.com
+
+3. Get the output as:
+
+    - 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
+
+See beam/upload.rb for more details
+
+## 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/beam.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beam/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = "beam"
+  spec.version        = Beam::VERSION
+  spec.authors        = ["Gourav Tiwari"]
+  spec.email          = ["gouravtiwari21@gmail.com"]
+  spec.homepage       = "https://github.com/gouravtiwari/beam"
+  spec.summary        = "CSV uploader library for fast and easy upload"
+  spec.description    = "CSV uploader library for fast and easy upload"
+  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"
+end

data/lib/beam.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "beam/version"
+require 'beam/extensions/exception'
+require 'beam/upload'

data/lib/beam/extensions/exception.rb

@@ -0,0 +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
+  end
+end

data/lib/beam/upload.rb

@@ -0,0 +1,118 @@
+require 'csv'
+module Beam
+  module Upload
+    # params:
+    #       file_name:        zip file name, e.g. users.csv.zip
+    #       file_path:        path/to/zip-file, e.g. Rails.root/tmp
+    #       error_file_needed:true if you need error file to be created, default is true
+    #       callback_method:  method which does the job to load records, default is parse method
+    def upload_file(file_name, file_path, error_file_needed=true, callback_method = "parse")
+      status = {}
+      @file_name = file_name
+      @file_path = file_path
+      @error_file_needed  = error_file_needed
+      @original_zip_file  = "#{@file_path}/#{@file_name}"
+      @csv_file_name      = @file_name.gsub(/\.zip/,'')
+
+      begin
+        delete_csv_if_present
+        `unzip #{@file_path}/#{@file_name} -d #{@file_path}`
+
+        status = self.send(callback_method)
+      rescue Exception =>  e
+        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}
+      end
+      status
+    end
+
+    # deletes csv file upfront before we unzip the file
+    def delete_csv_if_present
+      File.delete "#{@file_path}/#{@csv_file_name}" if File.exists? "#{@file_path}/#{@csv_file_name}"
+    end
+
+    # Creates error file with error rows, e.g.
+    # for users.csv file, it creates errors_users.csv
+    def error_in_upload(rows)
+      csv_file_path = "#{@file_path}/errors_#{@csv_file_name}"
+      begin
+        CSV.open(csv_file_path, "wb") do |csv|
+          rows.each do |row|
+            csv << row
+          end
+        end
+      rescue Exception => e
+        Rails.logger.error e.formatted_exception("Building error file for #{@file_name} failed!")
+      end
+    end
+
+    # Validates each record and returns error count if record is invalid
+    def validate_record(errors_count, row_hash, index)
+      record = new(row_hash)
+      unless record.valid?
+        errors_count += 1
+        [nil, errors_count, log_and_return_validation_error(record, row_hash, index)]
+      else
+        [record, errors_count, nil]
+      end
+    end
+
+    # parses the csv file, creates record for the model and returns response hash,e.g.
+    # {:errors=>1, :status=>200, :total_rows=>4, :error_rows=>[["Test1", nil, "is invalid"]]}
+    # also, it creates error file to consume
+    def parse
+      response  = { errors: 0, status: 200, total_rows: 0, error_rows: []}
+      index = 0
+
+      begin
+        CSV.foreach("#{@file_path}/#{@csv_file_name}", :encoding => 'iso-8859-1:UTF-8', headers: true) do |row|
+          index += 1
+          row_hash = row.to_hash
+          response[:total_rows] += 1
+          begin
+            record, response[:errors], error_row = validate_record(response[:errors], row_hash, index)
+            if error_row
+              response[:error_rows] << error_row
+            else
+              record.save!
+            end
+          rescue Exception => e
+            response[:errors] +=1
+            response[:error_rows] << log_and_return_error(row_hash, e, index)
+          end
+        end
+      rescue Exception => e
+        response[:errors] = 1
+        log_and_return_error({}, e, '')
+      end
+
+      if response[:error_rows].blank?
+        post_parse_success_calls 
+      elsif @error_file_needed
+        error_in_upload(response[:error_rows])
+      end
+
+      response
+    end
+
+    def log_and_return_validation_error(record, row_hash, index)
+      error_msg = record.errors.messages.values.join(', ')
+      Rails.logger.error("Error on #{index}: \n #{row_hash.values + [error_msg]}")
+      row_hash.values + [error_msg]
+    end
+
+    def log_and_return_error(row_hash, e, index)
+      Rails.logger.error e.formatted_exception("Error on #{index}: \n #{row_hash.values}")
+      row_hash.values + [invalid_file_message]
+    end
+
+    def invalid_file_message
+      "Please upload the right template and verify data before upload"
+    end
+
+    def post_parse_success_calls
+      # abstract method
+    end
+  end
+end

data/lib/beam/version.rb

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: beam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gourav Tiwari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-15 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'
+description: CSV uploader library for fast and easy upload
+email:
+- gouravtiwari21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- beam.gemspec
+- lib/beam.rb
+- lib/beam/extensions/exception.rb
+- lib/beam/upload.rb
+- lib/beam/version.rb
+homepage: https://github.com/gouravtiwari/beam
+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.0.6
+signing_key: 
+specification_version: 4
+summary: CSV uploader library for fast and easy upload
+test_files: []