active_admin_excel_upload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 337bcac793c6bdd8aa517b13808502d69139bb9b
+  data.tar.gz: e43dc70e3611487c96f18feeaa3a74ac68a850cd
+SHA512:
+  metadata.gz: 7a1ba5e0ab1ab2914d46e949bafe303a9a1fec291b47bd788ea3aa5edeafc10edab702bbb4774d9c954ff7ca6326fb921e00820ce0b7ab722a5aa3f67c08b4a2
+  data.tar.gz: 0ecc1def5227899b7147cb14238d2a34268a197a2ca4ab84bf077bcb2a54c5e56da550404bc08d2fd442427f4eb7adcb95d0acd06a95afb4f9d31843dde83a49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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,28 @@
+# ActiveAdminExcelUpload
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_admin_excel_upload'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active_admin_excel_upload
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveAdminExcelUpload'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/active_admin_excel_upload_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/active_admin_excel_upload .js
+//= link_directory ../stylesheets/active_admin_excel_upload .css

data/app/assets/javascripts/active_admin_excel_upload/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/active_admin_excel_upload/cable.js

@@ -0,0 +1,12 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/app/assets/javascripts/active_admin_excel_upload/channels/excel.coffee

@@ -0,0 +1,19 @@
+App.room = App.cable.subscriptions.create "ActiveAdminExcelUpload::ExcelChannel",
+  connected: ->
+    # Called when the subscription is ready for use on the server
+    console.log('connected')
+  disconnected: ->
+    # Called when the subscription has been terminated by the server
+
+  received: (data) ->
+    # Called when there's incoming data on the websocket for this channel
+    para = document.createElement("P");
+    t = document.createTextNode(data["message"]);
+    para.appendChild(t);
+    para.style.borderBottom = "1px solid lightgrey";
+    para.style.margin = "0px";
+    para.style.padding= "10px";
+    document.getElementById("show_status").appendChild(para);
+
+  speak: ->
+    @perform 'speak'

data/app/assets/stylesheets/active_admin_excel_upload/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/channels/active_admin_excel_upload/excel_channel.rb

@@ -0,0 +1,19 @@
+module ActiveAdminExcelUpload
+  class ExcelChannel < ApplicationCable::Channel
+    def subscribed
+      # stream_from "some_channel"
+      if ActiveAdminExcelUpload.configuration.use_default_connecion_authentication
+        stream_from "excel_channel_#{current_admin_user.id}"
+      else
+        stream_from "excel_channel_#{self.send(ActiveAdminExcelUpload.configuration.connection_identifier).send(:id)}"
+      end
+    end
+
+    def unsubscribed
+      # Any cleanup needed when channel is unsubscribed
+    end
+
+    def speak
+    end
+  end
+end

data/app/controllers/active_admin_excel_upload/application_controller.rb

@@ -0,0 +1,5 @@
+module ActiveAdminExcelUpload
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/active_admin_excel_upload/application_helper.rb

@@ -0,0 +1,4 @@
+module ActiveAdminExcelUpload
+  module ApplicationHelper
+  end
+end

data/app/jobs/active_admin_excel_upload/application_job.rb

@@ -0,0 +1,4 @@
+module ActiveAdminExcelUpload
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/active_admin_excel_upload/excel_parser_job.rb

@@ -0,0 +1,15 @@
+module ActiveAdminExcelUpload
+
+  class ExcelParserJob < ApplicationJob
+    queue_as :excels_queue
+
+    before_perform do |job|
+      sleep 5
+    end
+    def perform(klass,file_path,current_admin_user)
+      # Do something later
+      klass.constantize.send(:excel_process_sheet, file_path, current_admin_user)
+      FileUtils.rm(file_path)
+    end
+  end
+end

data/app/mailers/active_admin_excel_upload/application_mailer.rb

@@ -0,0 +1,6 @@
+module ActiveAdminExcelUpload
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/active_admin_excel_upload/application_record.rb

@@ -0,0 +1,5 @@
+module ActiveAdminExcelUpload
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/admin/excel/excel_result.html.erb

@@ -0,0 +1,10 @@
+<%= javascript_include_tag "active_admin_excel_upload/application" %>
+<div style="padding:10px" >
+  Processing Excel. Please wait. It may take a while.
+</div>
+<div style="padding:10px" >
+  Please do not go away from this page or you may loose tack of processing.
+</div>
+<div id="show_status" style="margin-top: 30px;border: 1px solid lightgrey">
+
+</div>

data/app/views/admin/excel/upload_excel.html.erb

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

data/app/views/layouts/active_admin_excel_upload/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active admin excel upload</title>
+  <%= stylesheet_link_tag    "active_admin_excel_upload/application", media: "all" %>
+  <%= javascript_include_tag "active_admin_excel_upload/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActiveAdminExcelUpload::Engine.routes.draw do
+end

data/lib/active_admin_excel_upload/authenticable.rb

@@ -0,0 +1,21 @@
+module ActiveAdminExcelUpload
+  module Authenticable
+    def self.included(base)
+      base.send(:identified_by,:current_admin_user)
+      base.include(InstanceMethods)
+    end
+    module InstanceMethods
+      def connect
+        self.current_admin_user = find_verified_user
+      end
+      private
+        def find_verified_user
+          if request.env['warden'].user
+            request.env['warden'].user
+          else
+            reject_unauthorized_connection
+          end
+        end
+    end
+  end
+end

data/lib/active_admin_excel_upload/dsl.rb

@@ -0,0 +1,25 @@
+module ActiveAdminExcelUpload
+  module DSL
+    def excel_importable
+      action_item :only => :index do
+          link_to 'Upload Excel', :action => 'upload_excel'
+      end
+
+      collection_action :upload_excel do
+        render "admin/excel/upload_excel"
+      end
+      collection_action :excel_upload_result do
+        render "admin/excel/excel_result"
+      end
+
+      collection_action :import_excel, :method => :post do
+        file_name = DateTime.now.to_s + params[:dump][:file].original_filename
+        tmp = params[:dump][:file].tempfile
+        final_path = Rails.root.join('tmp', file_name)
+        FileUtils.move tmp.path, final_path
+        ExcelParserJob.perform_later(self.resource_class.to_s,final_path.to_s,self.send(ActiveAdmin.application.current_user_method))
+        redirect_to :action => :excel_upload_result, :notice => "CSV imported successfully!"
+      end
+    end
+  end
+end

data/lib/active_admin_excel_upload/engine.rb

@@ -0,0 +1,5 @@
+module ActiveAdminExcelUpload
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveAdminExcelUpload
+  end
+end

data/lib/active_admin_excel_upload/excel_parsable.rb

@@ -0,0 +1,34 @@
+module ActiveAdminExcelUpload
+  module ExcelParsable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def excel_create_record(row, index, header,channel_name)
+        ActionCable.server.broadcast channel_name, message: "processing for #{row}"
+        object = Hash[header.zip row]
+        record = self.new(object)
+        if record.save
+          ActionCable.server.broadcast channel_name, message: "Successfully cureated record for #{row}, id: #{record.id}"
+        else
+          ActionCable.server.broadcast channel_name, message: "Could not create record for #{row}, error: #{record.errors.messages}"
+        end
+      end
+      def excel_process_sheet(sheet,current_admin_user)
+        xlsx = Roo::Spreadsheet.open(sheet)
+        sheet = xlsx.sheet(xlsx.sheets.index(self.table_name))
+        header = sheet.row(1)
+        channel_name = "excel_channel_#{current_admin_user.id}"
+        header_downcase = header.map(&:parameterize).map(&:underscore)
+        ActionCable.server.broadcast channel_name, message: "Start processing sheet #{self.table_name}"
+        sheet.parse.each_with_index do |row, index|
+          begin
+            self.excel_create_record(row,index,header_downcase,channel_name)
+          rescue StandardError => e
+            ActionCable.server.broadcast channel_name, message: "Exception while processing #{row}, Exception: #{e.message}"
+          end
+        end
+        ActionCable.server.broadcast channel_name, message: "End processing sheet #{self.table_name}"
+      end
+    end
+  end
+end

data/lib/active_admin_excel_upload/railtie.rb

@@ -0,0 +1,8 @@
+module ActiveAdminExcelUpload
+  class Railtie < Rails::Railtie
+    initializer "active_admin_excel_upload_railtie.configure_rails_initialization" do
+      ActiveAdmin::DSL.send(:include, ActiveAdminExcelUpload::DSL)
+      ActiveRecord::Base.send(:include, ActiveAdminExcelUpload::ExcelParsable)
+    end
+  end
+end

data/lib/active_admin_excel_upload/version.rb

@@ -0,0 +1,3 @@
+module ActiveAdminExcelUpload
+  VERSION = '0.1.0'
+end

data/lib/active_admin_excel_upload.rb

@@ -0,0 +1,28 @@
+require "active_admin_excel_upload/engine"
+require "activeadmin"
+require "active_admin_excel_upload/dsl"
+require "active_admin_excel_upload/railtie"
+require "active_admin_excel_upload/authenticable"
+require "active_admin_excel_upload/excel_parsable"
+module ActiveAdminExcelUpload
+  class << self
+   attr_accessor :configuration
+  end
+
+  def self.configure
+   self.configuration ||= Configuration.new
+   yield(configuration)
+   if configuration.use_default_connecion_authentication
+     ApplicationCable::Connection.send(:include, ActiveAdminExcelUpload::Authenticable)
+   end
+  end
+
+  class Configuration
+   attr_accessor :use_default_connecion_authentication
+   attr_accessor :connection_identifier
+   def initialize
+     @use_default_connecion_authentication = true
+     @connection_identifier = :current_admin_user
+   end
+  end
+end

data/lib/tasks/active_admin_excel_upload_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_admin_excel_upload do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: active_admin_excel_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shiv Garg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  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: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: active_admin_excel_upload gem brings convention over configuration for
+  your excel uploads. This gem is designed to process your excel sheet on a active
+  job and display the results live using action cables
+email:
+- shivgarg5676@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_admin_excel_upload_manifest.js
+- app/assets/javascripts/active_admin_excel_upload/application.js
+- app/assets/javascripts/active_admin_excel_upload/cable.js
+- app/assets/javascripts/active_admin_excel_upload/channels/excel.coffee
+- app/assets/stylesheets/active_admin_excel_upload/application.css
+- app/channels/active_admin_excel_upload/excel_channel.rb
+- app/controllers/active_admin_excel_upload/application_controller.rb
+- app/helpers/active_admin_excel_upload/application_helper.rb
+- app/jobs/active_admin_excel_upload/application_job.rb
+- app/jobs/active_admin_excel_upload/excel_parser_job.rb
+- app/mailers/active_admin_excel_upload/application_mailer.rb
+- app/models/active_admin_excel_upload/application_record.rb
+- app/views/admin/excel/excel_result.html.erb
+- app/views/admin/excel/upload_excel.html.erb
+- app/views/layouts/active_admin_excel_upload/application.html.erb
+- config/routes.rb
+- lib/active_admin_excel_upload.rb
+- lib/active_admin_excel_upload/authenticable.rb
+- lib/active_admin_excel_upload/dsl.rb
+- lib/active_admin_excel_upload/engine.rb
+- lib/active_admin_excel_upload/excel_parsable.rb
+- lib/active_admin_excel_upload/railtie.rb
+- lib/active_admin_excel_upload/version.rb
+- lib/tasks/active_admin_excel_upload_tasks.rake
+homepage: https://github.com/shivgarg5676/active_admin_excel_upload
+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.2
+signing_key: 
+specification_version: 4
+summary: Excel upload for active admin resources using background jobs and action
+  cable
+test_files: []