beam 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: acd3a8c0a75cf6f919a96814829bbe6d77c05898
-  data.tar.gz: e84bbadfac36ad545ac651725681851d05b15cf6
+  metadata.gz: 58e6c2bf43f67b5f0f1b96c2220babda0120320d
+  data.tar.gz: 8fe1ccd8320c5b03875c9e8ea7de2f2315b9d824
 SHA512:
-  metadata.gz: 3644af866a139d8737ac62a83718768240061849c0ba38d3239aa721e46e4cb3ff3d024f41991950310b65ecacdca1d4a9892fe7f1ce109d035c3113eddf5178
-  data.tar.gz: 4afcf1ad50f32f32eb170f9d466cbb4e163c8a7f1a94a4b2e98d6a206dbf955281250be5b816ca01edf104345092328de3fefb26a7063f67a8014c7c3b439817
+  metadata.gz: 373dc353a9f0f00002a4c4a1df2fde2d3aba08adbc8fc78f0b178618297d9afda5ade0bc7f1800f277d8eb6acc1b919dce7290013a73ffd8b524239d5d0306bc
+  data.tar.gz: f3efa60222fd1d9686aeb3fd0f8fe00ad06389c063faf3fc6f7791af3d02e6fe32c83f4024b8fac5464a7f8e39fe4a4f2dbe19b2caf864d596d2eab620b21594

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.0.3
+- Zipped CSV files are optional now
+- Various configuration options moved to initializers
+
 ### 0.0.2
 - Added batch processing with activerecord-import
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beam (0.0.2)
+    beam (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # Beam
 
-A rubygem to simplifiy repetitive csv upload process for ActiveRecord models. 
+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)
 
 ## Usage
@@ -9,6 +9,18 @@ Supports bulk upload with [activerecord-import](http://rubygems.org/gems/activer
     ```ruby
     gem 'beam'
     ```
+
+    Run the generator
+
+    ```ruby
+    rails g beam:install
+    ```
+
+    This will create a config file for you to over-ride default options of upload process.
+
+    ```ruby
+    create  config/initializers/beam.rb
+    ```
     
     Add [activerecord-import gem](http://rubygems.org/gems/activerecord-import) to the application's Gemfile:
     
@@ -49,6 +61,10 @@ Supports bulk upload with [activerecord-import](http://rubygems.org/gems/activer
 
 See beam/upload.rb for more details
 
+## TO DO
+
+SPECS!
+
 ## Contributing
 
 1. Fork it

data/beam.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.description    = "CSV uploader library for fast and easy upload for Rails applications"
   spec.license        = "MIT"
 
   spec.files          = `git ls-files`.split($/)

data/config/initializers/beam.rb

@@ -0,0 +1,8 @@
+module Beam
+  # @config = {
+  #     error_file_needed:  true,
+  #     batch_process:      true,
+  #     batch_size:         1_000,
+  #     zipped:             false
+  #   }
+end

data/lib/beam/upload.rb

@@ -1,27 +1,55 @@
 require 'csv'
+
 module Beam
+    # error_file_needed:true if you need error file to be created, default is true
+    # batch_process:    default is true, set to false if you do not use activerecord-import 
+    #                   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 = {
+      error_file_needed:  true,
+      batch_process:      true,
+      batch_size:         1_000,
+      zipped:             true
+    }
+
+    @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]
+      @batch_process      = Beam.config[:batch_process]
+      @batch_size         = Beam.config[:batch_size]
+      @zipped             = Beam.config[:zipped]
+    end
+
     # 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
-    #       batch_process:    defailt is true, set to false if you do not use activerecord-import 
-    #                         for batch processing
-    def upload_file(file_name, file_path, error_file_needed=true, callback_method = "parse", batch_process=true)
+    def upload_file(file_name, file_path, callback_method='parse')
       status = {}
+      upload_config
       @file_name          = file_name
-      @file_path          = file_path
-      @error_file_needed  = error_file_needed
+      @file_path          = file_path      
       @original_zip_file  = "#{@file_path}/#{@file_name}"
       @csv_file_name      = @file_name.gsub(/\.zip/,'')
-      @batch_process      = batch_process
-      @batch_size         = 1_1000
 
       begin
-        delete_csv_if_present
-        `unzip #{@file_path}/#{@file_name} -d #{@file_path}`
-
+        if @zipped
+          delete_csv_if_present
+          unzip_file
+        end
+        
         status = self.send(callback_method)
       rescue Exception =>  e
         error_in_upload([[invalid_file_message]]) if @error_file_needed
@@ -31,6 +59,11 @@ module Beam
       status
     end
 
+    # unzips a zipped-csv-file in a given directory
+    def unzip_file
+      `unzip #{@file_path}/#{@file_name} -d #{@file_path}`
+    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}"

data/lib/beam/version.rb

@@ -1,3 +1,3 @@
 module Beam
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/generators/beam/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module Beam
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../../../../config/initializers', __FILE__)
+
+      desc "This generator adds beam.rb to initializers with default config"
+      def copy_beam_config
+        copy_file "beam.rb", "config/initializers/beam.rb"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beam
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gourav Tiwari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: CSV uploader library for fast and easy upload
+description: CSV uploader library for fast and easy upload for Rails applications
 email:
 - gouravtiwari21@gmail.com
 executables: []
@@ -52,10 +52,12 @@ files:
 - README.md
 - Rakefile
 - beam.gemspec
+- config/initializers/beam.rb
 - lib/beam.rb
 - lib/beam/extensions/exception.rb
 - lib/beam/upload.rb
 - lib/beam/version.rb
+- lib/generators/beam/install_generator.rb
 homepage: https://github.com/gouravtiwari/beam
 licenses:
 - MIT