activeadmin-async_exporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e9c289aefbcaad8af51ff0246db57904394a35f
+  data.tar.gz: 447a795995d280e8108aa4a59fd40ed4328f5a4b
+SHA512:
+  metadata.gz: 873deb4aad5fea35066b3611980ef38ad9aaa6618521b8a3084772a662a276792857689bdd6ec3654a08f69e713d45df4ae383e4f19b4bd2fbdec5d72178f030
+  data.tar.gz: '09b210f28ea23c0e74ed46cf35734091489a6fb645d4958eca1e936159ff5d676dc10934763178631e37760cc2104a054bdca2751ec32521c274d78e1e952917'

data/lib/active_admin/async_exporter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_admin'
+
+require 'active_admin/async_exporter/version'
+require 'active_admin/async_exporter/config'
+require 'active_admin/async_exporter/reports/dsl'
+require 'active_admin/async_exporter/reports/worker'
+require 'active_admin/async_exporter/services/storage_service'
+require 'active_admin/async_exporter/services/disk_service'
+require 'active_admin/async_exporter/services/aws_s3_service'
+
+module ActiveAdmin
+  module AsyncExporter
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do
+        ActiveAdmin::ResourceDSL.include ActiveAdmin::AsyncExporter::Reports::DSL
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    class << self
+      def configure
+        yield config
+      end
+
+      def config
+        @config ||= Config.new
+      end
+    end
+
+    class Config
+      attr_accessor :service, :aws_bucket_name, :aws_bucket_folder_path, :disk_folder_path
+
+      def initialize
+        @aws_bucket_name = nil
+        @aws_bucket_folder_path = nil
+        @disk_folder_path = nil
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/reports/dsl.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    module Reports
+      module DSL
+        attr_reader :csv_fields
+
+        def csv_async(decorate_model: false, file_name: nil)
+          @csv_fields ||= {}
+
+          yield
+
+          csv_report(columns: csv_fields, decorate_model: decorate_model, file_name: file_name)
+        end
+
+        def csv_column(column_name, column_value = nil, &block)
+          column_value ||= column_name
+
+          column_value = block.source if block_given?
+
+          raise ActiveAdmin::AsyncExporter::Error, 'No argument given' if block_given? &&
+                                                                          block.parameters.blank?
+
+          csv_fields[column_name.to_sym] = { block: block_given?, value: column_value.to_s }
+        end
+
+        def csv_report(columns:, decorate_model: false, file_name: nil)
+          action_item :download_csv, only: :index do
+            link_to 'Download CSV',
+                    { action: :download_csv, params: params.to_enum.to_h },
+                    method: :post,
+                    data: { confirm: 'Are you sure you want to generate this report?' }
+          end
+
+          collection_action :download_csv, method: :post do
+            admin_report = AdminReport.create!(
+              author_id: current_admin_user.id,
+              entity: current_collection.name,
+              status: :pending
+            )
+
+            options = {
+              admin_report_id: admin_report.id,
+              controller: self.class.name,
+              columns: columns,
+              decorate_model: decorate_model,
+              file_name: file_name,
+              query: params['q']
+            }
+
+            ActiveAdmin::AsyncExporter::Worker.perform_later(options)
+            redirect_to admin_admin_report_path(admin_report)
+          end
+
+          controller do
+            def current_collection
+              scoped_collection
+            end
+          end
+        end
+      end
+    end
+
+    class Error < ActiveAdmin::Error; end
+  end
+end

data/lib/active_admin/async_exporter/reports/worker.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    class Worker < ApplicationJob
+      def perform(options = {})
+        controller = options[:controller].classify.constantize.new
+        columns = options[:columns]
+        file_name = filename(options[:file_name], controller)
+
+        path = Rails.root.join('tmp', file_name)
+
+        CSV.open(path, 'wb', headers: true) do |csv|
+          build_csv(csv, columns, controller, options)
+        end
+
+        file = Services::StorageService.call(path: path, name: file_name).store
+        AdminReport.find(options[:admin_report_id]).update_attributes!(
+          status: :ready,
+          location_url: file.url
+        )
+      end
+
+      private
+
+      def proc_from_string(code_string)
+        proc_string = code_from_string(code_string)
+        Proc.class_eval("proc #{proc_string}")
+      end
+
+      def code_from_string(code_string)
+        code_string.scan(%r{/(do|{)\s+(\|.*\|)(.*)(end|})/m}).flatten.join('')
+      end
+
+      def collection(controller, options)
+        controller.current_collection.ransack(options[:query]).result
+      end
+
+      def filename(file_name, controller)
+        file_name ||= controller.current_collection.name.pluralize.downcase
+        [file_name, Time.current.to_i].join('_') + '.csv'
+      end
+
+      def build_csv(csv, columns, controller, options)
+        headers = columns.keys
+        evaluators = columns.values
+
+        csv << headers.map(&:to_s)
+
+        collection(controller, options).find_in_batches do |group|
+          group.each do |model|
+            model = model.decorate if options[:decorate_model]
+
+            csv << csv_field_value(model, evaluators)
+          end
+        end
+      end
+
+      def csv_field_value(model, evaluators)
+        evaluators.collect do |ev|
+          value = ev[:value]
+
+          if ev[:block]
+            code_proc = proc_from_string(value)
+            code_proc.yield(model)
+          else
+            model.send(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/services/aws_s3_service.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    module Services
+      class AwsS3Service
+        attr_accessor :file, :s3, :bucket, :object
+
+        def initialize(file)
+          @file = file
+          @s3 = Aws::S3::Resource.new
+          @bucket = s3.bucket(ActiveAdmin::AsyncExporter.config.aws_bucket_name)
+        end
+
+        def store
+          @object = bucket.object(filename)
+          object.upload_file(Pathname.new(file[:path]), { acl: 'public-read' })
+          self
+        end
+
+        def url
+          object.public_url.to_s
+        end
+
+        def delete
+          bucket.delete_objects({ delete: { objects: [{ key: filename }] } })
+        end
+
+        private
+
+        def filename
+          @filename ||= "#{bucket_folder}#{file[:name]}"
+        end
+
+        def bucket_folder
+          path = ActiveAdmin::AsyncExporter.config.aws_bucket_folder_path
+          return '' if path.blank?
+
+          "#{path}/"
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/services/disk_service.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    module Services
+      class DiskService
+        attr_accessor :file, :folder
+
+        def initialize(file)
+          @file = file
+          @folder = ActiveAdmin::AsyncExporter.config.disk_folder_path
+        end
+
+        def store
+          make_dir
+          @object = IO.copy_stream(file[:path], filename)
+          self
+        end
+
+        def url
+          filename
+        end
+
+        def delete
+          File.delete(filename)
+        end
+
+        private
+
+        def make_dir
+          FileUtils.mkdir_p(folder)
+        end
+
+        def filename
+          @filename ||= "#{folder}/#{file[:name]}"
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/services/storage_service.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    module Services
+      class StorageService
+        private_class_method :new
+
+        def self.call(*args)
+          case ActiveAdmin::AsyncExporter.config.service
+          when :amazon
+            Services::AwsS3Service.new(*args)
+          else
+            Services::DiskService.new(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/async_exporter/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveAdmin
+  module AsyncExporter
+    VERSION = '0.1.0'
+  end
+end

data/lib/activeadmin-async_exporter.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'active_admin/async_exporter'

data/lib/generators/active_admin/async_exporter/config/config_generator.rb

@@ -0,0 +1,13 @@
+module ActiveAdmin
+  module AsyncExporter
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        source_root File.join(__dir__, 'templates')
+
+        def copy_config_file
+          template 'async_exporter_config.rb', 'config/initializers/activeadmin-async_exporter.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_admin/async_exporter/config/templates/async_exporter_config.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+ActiveAdmin::AsyncExporter.configure do |config|
+  ## Storage Service
+  # The available options are :local, :amazon
+  # default option: :local
+  # config.service = :local
+
+  ## AWS S3
+  # config.aws_bucket_name = nil
+  # config.aws_bucket_folder_path = nil
+
+  ## Disk
+  config.disk_folder_path = Rails.root.join('exporter')
+end

data/lib/generators/active_admin/async_exporter/install/install_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module ActiveAdmin
+  module AsyncExporter
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        include ActiveRecord::Generators::Migration
+
+        argument :user_class, type: :string, default: 'User'
+
+        source_root File.join(__dir__, 'templates')
+
+        def configure
+          create_admin_reports_migration
+          create_admin_reports_model
+          create_active_admin_view
+        end
+
+        private
+
+        def create_admin_reports_migration
+          migration_template(
+            'migration.rb',
+            'db/migrate/add_admin_reports.rb',
+            user_table_name: user_table_name
+          )
+        end
+
+        def create_admin_reports_model
+          template(
+            'admin_report.rb',
+            'app/models/admin_report.rb',
+            user_class: user_class
+          )
+        end
+
+        def create_active_admin_view
+          template(
+            'admin_reports.rb',
+            'app/admin/admin_reports.rb'
+          )
+        end
+
+        def user_class_name
+          user_class.underscore.singularize
+        end
+
+        def user_table_name
+          user_class_name.pluralize
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_admin/async_exporter/install/templates/admin_report.rb.tt

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AdminReport < ApplicationRecord
+  enum status: { pending: 0, ready: 1, error: 2 }
+
+  belongs_to :author, class_name: '<%= user_class %>'
+end

data/lib/generators/active_admin/async_exporter/install/templates/admin_reports.rb.tt

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'open-uri'
+
+ActiveAdmin.register AdminReport do
+  actions :index, :show, :destroy
+
+  filter :entity
+  filter :format
+  filter :created_at
+  filter :location_url
+
+  index do
+    id_column
+    column :author
+    column :entity
+    column :format
+    column :status
+    column :file do |report|
+      link_to 'Download CSV', download_file_admin_admin_report_path(report) if report.ready?
+    end
+    column :created_at
+
+    actions
+  end
+
+  show do
+    attributes_table_for(admin_report) do
+      row :id
+      row :author
+      row :entity
+      row :format
+      row 'Status' do
+        status_tag (admin_report.ready? ? 'green' : 'orange'), label: admin_report.status
+      end
+      row :file do
+        link_to 'Download CSV', download_file_admin_admin_report_path if admin_report.ready?
+      end
+      row :created_at
+    end
+  end
+
+  member_action :download_file, method: :get do
+    send_data(open(resource.location_url).read, disposition: 'attachment', filename: /(?!.*\/).+/.match(resource.location_url)[0])
+  end
+
+  controller do
+    def scoped_collection
+      AdminReport.includes(:author)
+    end
+  end
+end

data/lib/generators/active_admin/async_exporter/install/templates/migration.rb.tt

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    create_table :admin_reports do |t|
+      t.references :author
+      t.foreign_key :<%= user_table_name %>, column: :author_id, primary_key: 'id'
+
+      t.string :entity, null: false
+      t.string :format, null: false, default: :csv
+      t.integer :status, null: false
+      t.string :location_url
+
+      t.timestamps
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin-async_exporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Franco Pariani
+- Horacio Bertorello
+- Ricardo Cortio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rootstrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: Async exporter for Active Admin using ActiveJob
+email: franco@rootstrap.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_admin/async_exporter.rb
+- lib/active_admin/async_exporter/config.rb
+- lib/active_admin/async_exporter/reports/dsl.rb
+- lib/active_admin/async_exporter/reports/worker.rb
+- lib/active_admin/async_exporter/services/aws_s3_service.rb
+- lib/active_admin/async_exporter/services/disk_service.rb
+- lib/active_admin/async_exporter/services/storage_service.rb
+- lib/active_admin/async_exporter/version.rb
+- lib/activeadmin-async_exporter.rb
+- lib/generators/active_admin/async_exporter/config/config_generator.rb
+- lib/generators/active_admin/async_exporter/config/templates/async_exporter_config.rb.tt
+- lib/generators/active_admin/async_exporter/install/install_generator.rb
+- lib/generators/active_admin/async_exporter/install/templates/admin_report.rb.tt
+- lib/generators/active_admin/async_exporter/install/templates/admin_reports.rb.tt
+- lib/generators/active_admin/async_exporter/install/templates/migration.rb.tt
+homepage: https://rubygems.org/gems/activeadmin-async_exporter
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rootstrap/activeadmin-async_exporter
+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.3
+signing_key: 
+specification_version: 4
+summary: Async exporter for Active Admin using ActiveJob
+test_files: []