activeadmin_jobs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 247bf751fb99e82fa5102afb73e50bd748c427ed
+  data.tar.gz: 5da929cd88a48ed17bedf8b290a78a16ed378578
+SHA512:
+  metadata.gz: ec4dd211b6c1de9e73b07931088c9b95ae28a66832d14ddda515265ecbeaf280487c4161c22fcc75389a0a93bacdff1fc5d81ee580ac13046e88ee6c615754b9
+  data.tar.gz: e0737dccf487852412e95177695d6a78eaa660681fefda1059b63c78f966597bae20fbb450cf0a1a827527c344f0d998a183d80bc6a78fa55457ae7bdf2f1e61

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rails_helper
+--format=doc

data/.ruby-version

@@ -0,0 +1 @@
+2.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+### v0.1.0
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+source 'https://rails-assets.org' do
+  gem 'rails-assets-growl'
+end
+
+# Declare your gem's dependencies in activeadmin_jobs.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,280 @@
+PATH
+  remote: .
+  specs:
+    activeadmin_jobs (0.1.0)
+      activeadmin (~> 1.0.0.pre2)
+      activeadmin_addons (~> 0.9, >= 0.9.2)
+      devise (~> 3.5, >= 3.5.0)
+      job_notifier (~> 1.1, >= 1.1.1)
+      rails (~> 4.2, >= 4.2.0)
+      rails-assets-growl (~> 1.3, >= 1.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  remote: https://rails-assets.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activeadmin (1.0.0.pre4)
+      arbre (~> 1.0, >= 1.0.2)
+      bourbon
+      coffee-rails
+      formtastic (~> 3.1)
+      formtastic_i18n
+      inherited_resources (~> 1.6)
+      jquery-rails
+      jquery-ui-rails
+      kaminari (~> 0.15)
+      rails (>= 3.2, < 5.1)
+      ransack (~> 1.3)
+      sass-rails
+      sprockets (< 4)
+    activeadmin_addons (0.9.3)
+      railties
+      select2-rails (~> 3.5.9)
+      xdan-datetimepicker-rails (~> 2.5.1)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    arbre (1.1.1)
+      activesupport (>= 3.0.0)
+    arel (6.0.3)
+    bcrypt (3.1.11)
+    bourbon (4.2.7)
+      sass (~> 3.4)
+      thor (~> 0.19)
+    builder (3.2.2)
+    capybara (2.7.0)
+      addressable
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.1)
+    coffee-rails (4.2.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.2.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.10.0)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.2)
+    daemons (1.2.3)
+    database_cleaner (1.5.3)
+    delayed_job (4.1.2)
+      activesupport (>= 3.0, < 5.1)
+    delayed_job_active_record (4.1.1)
+      activerecord (>= 3.0, < 5.1)
+      delayed_job (>= 3.0, < 5)
+    devise (3.5.10)
+      bcrypt (~> 3.0)
+      orm_adapter (~> 0.1)
+      railties (>= 3.2.6, < 5)
+      responders
+      thread_safe (~> 0.1)
+      warden (~> 1.2.3)
+    diff-lcs (1.2.5)
+    enumerize (1.0.0)
+      activesupport (>= 3.2)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    ffi (1.9.10)
+    formtastic (3.1.4)
+      actionpack (>= 3.2.13)
+    formtastic_i18n (0.6.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    has_scope (0.6.0)
+      actionpack (>= 3.2, < 5)
+      activesupport (>= 3.2, < 5)
+    i18n (0.7.0)
+    inherited_resources (1.6.0)
+      actionpack (>= 3.2, < 5)
+      has_scope (~> 0.6.0.rc)
+      railties (>= 3.2, < 5)
+      responders
+    job_notifier (1.1.1)
+      colorize (~> 0.7, >= 0.7.7)
+      enumerize (~> 1.0.0, ~> 1.0)
+      rails (~> 4.2, >= 4.2.0)
+      silencer (= 1.0.0.rc3)
+    jquery-rails (4.1.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jquery-ui-rails (5.0.5)
+      railties (>= 3.2.16)
+    json (1.8.3)
+    kaminari (0.17.0)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.9.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    orm_adapter (0.5.0)
+    polyamorous (1.3.1)
+      activerecord (>= 3.0)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-rails (0.3.4)
+      pry (>= 0.9.10)
+    quiet_assets (1.1.0)
+      railties (>= 3.1, < 5.0)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-assets-growl (1.3.1)
+      rails-assets-jquery
+    rails-assets-jquery (2.2.4)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    ransack (1.8.0)
+      actionpack (>= 3.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+      i18n
+      polyamorous (~> 1.3)
+    responders (2.2.0)
+      railties (>= 4.2.0, < 5.1)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubyzip (1.2.0)
+    sass (3.4.22)
+    sass-rails (5.0.5)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    select2-rails (3.5.10)
+      thor (~> 0.14)
+    selenium-webdriver (2.53.0)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+      websocket (~> 1.0)
+    silencer (1.0.0.rc3)
+    slop (3.6.0)
+    sprockets (3.6.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    warden (1.2.6)
+      rack (>= 1.0)
+    websocket (1.2.3)
+    xdan-datetimepicker-rails (2.5.4)
+      jquery-rails
+      rails (>= 3.2.16)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activeadmin_jobs!
+  capybara
+  daemons
+  database_cleaner
+  delayed_job_active_record
+  pry-rails
+  quiet_assets
+  rails-assets-growl!
+  rspec-rails (~> 3.4.0)
+  selenium-webdriver
+  sqlite3
+
+BUNDLED WITH
+   1.12.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Platanus
+
+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,272 @@
+# Active Admin Jobs
+
+It's a Rails engine that allows you to play nice with [Active Job](https://github.com/rails/activejob) in [Active Admin](https://github.com/activeadmin/activeadmin) providing user feedback.
+
+- An Active Admin's index view to list jobs.
+- An Active Admin's show view to see job details with a special panel to show success/error feedback. To achieve this we are going to use the [Job Notifier](https://github.com/platanus/job_notifier) gem.
+- A way to customize the success and error partials.
+- A mechanism to listen job status changes and notify them using [jQuery Growl](http://ksylvest.github.io/jquery-growl/)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "activeadmin_jobs"
+```
+
+```bash
+bundle install
+```
+
+```bash
+rails generate job_notifier:install
+```
+
+If you use `AdminUser` class in `ActiveAdmin` you will need to add the following code:
+
+```ruby
+class AdminUser < ActiveRecord::Base
+  include JobNotifier::Identifier
+  identify_job_through(:id, :email)
+
+  # more code...
+end
+
+```
+
+## Usage
+
+To make it easy I'm going to explain how to use this gem with an example.
+
+Example:
+
+As an **admin user**:
+
+1. From a form, I want to pick a big .xls file containing users information.
+2. In the endpoint pointed by the form, I want to create a job to parse that heavy file in background to create users in the system.
+3. I need a way to know when the process is completed.
+4. Also, I want to see success and error feedback.
+
+<img src="./docs/images/jobs-example.gif" height="500" />
+
+Next, I will explain how to solve each step:
+
+#### Step 1: pick the file.
+
+Suppose you want to go to the import form from the `AdminUser`'s index page. To do that, you can add an `action_item` with a `collection_action`:
+
+*/your_app/app/admin/admin_users.rb*
+
+```ruby
+ActiveAdmin.register AdminUser do
+  # more code...
+  action_item :import_users, only: :index do
+    link_to "Import Users", import_form_admin_admin_users_path
+  end
+
+  collection_action :import_form, title: "Import Users" do
+    # Nothing here. We just want to render the form.
+  end
+end
+```
+
+With the related wiew:
+
+*your_app/app/views/admin/admin_users/import_form.html.erb*
+
+```erb
+<%= semantic_form_for :data, url: { action: :import }, method: :post do |f| %>
+  <%= f.inputs "Form" do %>
+    <%= f.input :source, as: :file, label: "File", :hint => "Excel file with thousands rows that need to be processed in background..." %>
+  <% end %>
+  <%= f.actions do %>
+    <%= f.action :submit, as: :button, label: "Import" %>
+  <% end %>
+<% end %>
+```
+
+<img src="./docs/images/import-form.png" height="300" />
+
+You need to add the endpoint pointed in the form action too.
+
+*/your_app/app/admin/admin_users.rb*
+
+```ruby
+ActiveAdmin.register AdminUser do
+  # more code...
+  collection_action :import, title: "Import Users", method: :post do
+    # We fill this in the next step.
+  end
+end
+```
+
+#### Step 2: create a job.
+
+Inside the import action definition, you need to call the job in charge of parsing the .xls file. To do this:
+
+First, we need to create the job. We need to do it using `perform_with_feedback` method provided by [Job Notifier](https://github.com/platanus/job_notifier) gem. You can see how it works reading the **Third and Fourth Steps** of the [usage section](https://github.com/platanus/job_notifier#usage).
+
+*/your_app/app/jobs/user_upload_job.rb*
+
+```ruby
+class UserUploadJob < ActiveJob::Base
+  def perform_with_feedback(xls_path)
+    # Here you need to process the file an return a success or error result.
+    #
+    # Lets say I'm going to return this message:
+    #
+    # "Users successfully loaded"
+    #
+    # with a successful result and something like this:
+    #
+    # errors = [
+    #   { row: 4, errors: ["Invalid First Name", "Invalid Category"] },
+    #   { row: 6, errors: ["Invalid Last Name"] },
+    #   { row: 84, errors: ["Invalid ID"] }
+    # ]
+    #
+    # raise JobNotifier::Error::Validation.new(errors)
+    #
+    # with unsuccessful result.
+  end
+end
+
+```
+
+Then, we call the job in the import action:
+
+*/your_app/app/admin/admin_users.rb*
+
+```ruby
+ActiveAdmin.register AdminUser do
+  # more code...
+  collection_action :import, title: "Import Users", method: :post do
+    file_path = get_file_path(params[:data][:source]) # I'm not going to implement this. It's just an example.
+    UserUploadJob.perform_later(current_admin_user.job_identifier, file_path)
+  end
+end
+```
+
+#### Step 3: notify process completion.
+
+You don't need to do nothing here, the gem will do it for you using [jQuery Growl](http://ksylvest.github.io/jquery-growl/).
+
+On success...
+
+<img src="./docs/images/success-notification.png" height="300" />
+
+On error...
+
+<img src="./docs/images/error-notification.png" height="300" />
+
+#### Step 4: show success and error feedback.
+
+The gem includes an index view for jobs. There, you can see a jobs list with the current state of each job.
+
+<img src="./docs/images/jobs-list.png" height="400" />
+
+To show feedback, you need to add one partial by possible job state prefixed by the job's class name in snake_case. For example:
+If you have the `UserUploadJob` job, following the convention: `_[job_class_name].[job_state].html.erb`, you will need two partials:
+
+One for success...
+
+*/your_app/app/views/admin/jobs/_user_upload_job.finished.html.erb*
+
+```erb
+<%= result %>
+```
+
+> Remember: we get this: "Users successfully loaded" as `result` on success.
+
+<img src="./docs/images/success-view.png" height="400" />
+
+One for error...
+
+*/your_app/app/views/admin/jobs/_user_upload_job.failed.html.erb*
+
+```erb
+<h2>Errors :(</h2>
+
+<% result.each do |record| %>
+  <h3>Row #<%= record[:row] %>:</h3>
+  <ul>
+    <% record[:errors].each do |error| %>
+      <li><%= error %></li>
+    <% end %>
+  </ul>
+<% end %>
+```
+
+> Remember: we get something like this:
+```ruby
+[
+  { row: 4, errors: ["Invalid First Name", "Invalid Category"] },
+  { row: 6, errors: ["Invalid Last Name"] },
+  { row: 84, errors: ["Invalid ID"] }
+]
+```
+as `result` on error.
+
+<img src="./docs/images/error-view.png" height="600" />
+
+Those partials will be rendered in the job's show view depending on its state.
+
+## I18n
+
+If you want to translate your notifications, you can do it following this convention:
+
+**/your_app/config/locales/en.yml**
+
+```yml
+en:
+  activeadmin_jobs:
+    [job_class_name]:
+      description: "XXX"
+      finished:
+        title: "XXX"
+        one: "XXX"
+        other: "XXX"
+      failed:
+        title: "XXX"
+        one: "XXX"
+        other: "XXX"
+```
+
+For example:
+
+```yml
+en:
+  activeadmin_jobs:
+    user_upload_job:
+      description: "Users upload through .xls file"
+      finished:
+        title: "Users have been uploaded! :)"
+        one: "One .xls file was completed with no errors. Click here to see the result"
+        other: ".xls files were completed with no errors. Click here to see the result"
+      failed:
+        title: "Error trying to upload users :("
+        one: "One .xls file could not be uploaded. Click here to see errors"
+        other: ".xls files could not be uploaded. Click here to see errors"
+```
+
+
+## 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
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/activeadmin_jobs/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Active Admin Jobs is maintained by [platanus](http://platan.us).
+
+## License
+
+Active Admin Jobs is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.