active_admin_importer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4469bf0e26ddf3c84800aed672a1729c0893b06
+  data.tar.gz: b85ef234d5ed264bb327f2d4936a79e245032827
+SHA512:
+  metadata.gz: 8f84bb74980ef292b9946ec7bf1105f81ff1ee574becf5389e41e317d38d2a6d9623d1de016a26f00233781e2f0daee81f51795336f6ebe8dd3e02c318322dfb
+  data.tar.gz: d6d117b5e3f695b6f56d17c30676961e661457b76aff559244fac8db8cdf72fd31a202fb226d8aab401901b2f49c42a021de5e665b74a8adaeeebbdc1eb41bfb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jason Ayre
+
+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,68 @@
+# ActiveAdminImporter
+
+Simple CSV imports for active_admin, that (shouldn't) destroy your servers memory.
+
+### Features / differences from similar gems
+1. Parses the CSV file one row at a time
+2. Allows you to override the view to customize the form
+3. Access to the current controller from the import definition
+4. Can define any number of imports per resource
+
+### Examples
+
+``` ruby
+::ActiveAdmin.register Product do
+  define_import_for :products do |model, import_params, controller|
+    product_attributes = import_params.slice(*[:name, :price])
+    product_attributes[:user_id] = controller.current_user.id
+    model.create!(product_attributes)
+  end
+
+  #Example: require headers to be present
+  define_import_for :products_on_sale, :required_headers => ["sale_price"] do |model, import_params, controller|
+    product_attributes = import_params.slice(*[:name, :price, :sale_price])
+    product_attributes[:user_id] = controller.current_user.id
+    model.create!(product_attributes)
+  end
+
+  # Example: using a custom view
+  # assume the view has a dropdown which allows you to select a particular store during import
+  define_import_for :products_for_store, :view => "myactiveadmin/products/upload_products_for_store_csv"
+  do |model, import_params, controller|
+    product_attributes = import_params.slice(*[:name, :price, :sale_price])
+    product_attributes[:user_id] = controller.current_user.id
+    product_attributes[:store_id] = controller.params["store_id"]
+    model.create!(product_attributes)
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_admin_importer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_admin_importer
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_admin_importer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_admin_importer.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_admin_importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_admin_importer"
+  spec.version       = ActiveAdminImporter::VERSION
+  spec.authors       = ["Jason Ayre"]
+  spec.email         = ["jayre@peer60.com"]
+
+  spec.summary       = %q{ActiveAdmin CSV Importer gem}
+  spec.description   = %q{Import CSV's into activeadmin}
+  spec.homepage      = "https://github.com/jasonayre/active_admin_importer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", "~> 4.2"
+  spec.add_development_dependency "activeadmin", "~> 1.0.0.pre5"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-pride"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_dependency "activesupport"
+end

data/app/views/admin/csv/upload.html.erb

@@ -0,0 +1,17 @@
+<%= form_for :dump, :url => {:action => target_action}, :html => {:multipart => true} do |f| %>
+ <table>
+   <tr>
+     <td>
+       <%= label_tag  "dump_file", "Select a CSV File" %>
+       </td>
+     <td>
+       <%= f.file_field :file %>
+     </td>
+   </tr>
+   <tr>
+     <td>
+       <%= submit_tag 'Submit' %>
+     </td>
+   </tr>
+ </table>
+<% end %>

data/app/views/admin/csv/upload_csv.html.erb

@@ -0,0 +1,17 @@
+<%= form_for :dump, :url => {:action => "import_csv"}, :html => {:multipart => true} do |f| %>
+  <table>
+    <tr>
+     <td>
+       <%= label_tag  "dump_file", "Select a CSV File" %>
+       </td>
+     <td>
+       <%= f.file_field :file %>
+     </td>
+    </tr>
+    <tr>
+     <td>
+       <%= submit_tag 'Submit' %>
+     </td>
+    </tr>
+  </table>
+<% end %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_admin_importer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_admin_importer/csv_file.rb

@@ -0,0 +1,46 @@
+require 'csv'
+require 'digest'
+
+module ActiveAdminImporter
+  class CsvFile < SimpleDelegator
+    CSV_READ_OPTIONS = { :headers => true, :header_converters => :symbol }.freeze
+
+    def self.read(path)
+      new(::File.new(path))
+    end
+
+    def initialize(descriptor)
+      @descriptor = descriptor
+    end
+
+    def __getobj__
+      @descriptor
+    end
+
+    def each_row(&block)
+      ::CSV.parse(self, CSV_READ_OPTIONS, &block)
+    end
+
+    def find_row_by_number(number)
+      result = ::CSV.foreach(self, CSV_READ_OPTIONS).with_index do |row, i|
+        return row if i == number - 1
+      end
+
+      result
+    end
+
+    def headers
+      @headers ||= ::CSV.open(@descriptor, 'r') { |csv| csv.first }
+    end
+
+    # read file in chunks for memory efficiency
+    def md5
+      @md5 ||= ::File.open(@descriptor, "rb") do |io|
+        _md5 = ::Digest::MD5.new
+        buffer = ""
+        _md5.update(buffer) while io.read(4096, buffer)
+        _md5
+      end
+    end
+  end
+end

data/lib/active_admin_importer/dsl.rb

@@ -0,0 +1,29 @@
+module ActiveAdminImporter
+  module DSL
+    def define_import_for(name='records', **options, &block)
+      options[:action] ||= "import_#{name}"
+      options[:form_action] ||= "upload_#{name}"
+      options[:view] ||= "admin/csv/upload"
+      options[:required_headers] ||= []
+
+      action_item :edit, :only => :index do
+        link_to options[:action].titleize, :action => options[:form_action]
+      end
+
+      collection_action(options[:form_action]) do
+        render options[:view], :locals => { :target_action => options[:action] }
+      end
+
+      collection_action(options[:action], :method => :post) do
+        parent if parent?
+        import = ::ActiveAdminImporter.import(params[:dump][:file],
+                                              :model => active_admin_config.resource_class,
+                                              :controller => self,
+                                              :required_headers => options[:required_headers],
+                                              &block)
+
+        redirect_to collection_path(), alert: import.result
+      end
+    end
+  end
+end

data/lib/active_admin_importer/engine.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module ActiveAdminImporter
+  class Engine < ::Rails::Engine
+    config.mount_at = '/'
+
+    config.after_initialize do
+      require "active_admin"
+      ::ActiveAdmin::DSL.send(:include, ActiveAdminImporter::DSL)
+    end
+  end
+end

data/lib/active_admin_importer/import.rb

@@ -0,0 +1,82 @@
+module ActiveAdminImporter
+  class Import
+    attr_reader :current_row, :csv_file
+
+    def initialize(csv_file, controller:, model:, required_headers:[], &block)
+      @csv_file = ::ActiveAdminImporter::CsvFile.new(csv_file)
+      @controller = controller
+      @model = model
+      @required_headers = required_headers
+      @current_row = 0
+      @block = block if block_given?
+    end
+
+    def failed_rows
+      @failed_rows ||= []
+    end
+
+    def headers
+      @headers ||= @csv_file.headers
+    end
+
+    def run
+      log_info("STARTING IMPORT")
+
+      ::CSV.parse(@csv_file, :headers => true, :header_converters => :symbol) do |row|
+        begin
+          process_row(row)
+        rescue => e
+          record_failure(row, e)
+        end
+      end
+
+      log_error("FAILED TO PARSE ROWS #{failed_rows}") if failed_rows.any?
+      log_info("FINISHED IMPORT")
+    end
+
+    def result
+      @result ||= begin
+        _result = []
+        _result << "Bad column headers, expected #{@required_headers} got #{@csv_file.headers}" unless self.valid?
+        _result << "Failed to import rows: #{failed_rows.join(',')}" if failed_rows.any?
+        _result << "#{current_row - failed_rows.length} / #{current_row} imported successfully" if current_row > 0
+        _result.join("\n")
+      end
+    end
+
+    def valid?
+      @required_headers.all?{ |header| self.headers.include?(header) }
+    end
+
+    private
+
+    def process_row(row)
+      @current_row += 1
+      log_info("IMPORTING ROW - #{current_row}")
+      data = row.to_hash
+
+      if data.present?
+        if @block
+          @block.call(@model, data, @controller)
+        else
+          @model.create!(data)
+        end
+      end
+    end
+
+    def record_failure(row, e)
+      log_error("FAILED TO PARSE ROW #{current_row}")
+      failed_rows << current_row
+      log_error("ERROR_ON_ROW\##{current_row} - #{e.message}")
+      ::Rails.logger.error(e.message)
+    end
+
+    def log_error(message)
+      ::Rails.logger.error("[IMPORT: #{@csv_file.md5}]: #{message}")
+    end
+
+    def log_info(message)
+      ::Rails.logger.info("[IMPORT: #{@csv_file.md5}]: #{message}")
+    end
+  end
+end

data/lib/active_admin_importer/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdminImporter
+  VERSION = "0.1.0"
+end

data/lib/active_admin_importer.rb

@@ -0,0 +1,25 @@
+require "active_admin_importer/version"
+require "active_support/all"
+require "active_admin_importer/engine"
+
+module ActiveAdminImporter
+  extend ::ActiveSupport::Autoload
+
+  autoload :DSL
+  autoload :Engine
+  autoload :CsvFile
+  autoload :Import
+
+  def self.import(csv_file, **options, &block)
+    io = csv_file.is_a?(::ActionDispatch::Http::UploadedFile) ? csv_file.tempfile : csv_file
+
+    _import = if block_given?
+      ::ActiveAdminImporter::Import.new(io, **options, &block)
+    else
+      ::ActiveAdminImporter::Import.new(io, **options)
+    end
+
+    _import.run if _import.valid?
+    _import
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: active_admin_importer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Ayre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-pride
+  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: pry-nav
+  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: activesupport
+  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: Import CSV's into activeadmin
+email:
+- jayre@peer60.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_admin_importer.gemspec
+- app/views/admin/csv/upload.html.erb
+- app/views/admin/csv/upload_csv.html.erb
+- bin/console
+- bin/setup
+- lib/active_admin_importer.rb
+- lib/active_admin_importer/csv_file.rb
+- lib/active_admin_importer/dsl.rb
+- lib/active_admin_importer/engine.rb
+- lib/active_admin_importer/import.rb
+- lib/active_admin_importer/version.rb
+homepage: https://github.com/jasonayre/active_admin_importer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveAdmin CSV Importer gem
+test_files: []