easy_admin 0.0.1 → 0.1.0

data/README.md

@@ -1,7 +1,7 @@
 # EasyAdmin
 
 A Rails engine containing common admin maintenance screens.
-Currently contains Delayed::Job maintenance screens.
+Currently contains Delayed::Job and Outbound Request maintenance screens
 
 ## Installation
 
@@ -19,18 +19,20 @@ Or install it yourself as:
 
 ## Usage
 
-All you need is a Admin::BaseController (which the EasyAdmin controllers will extend). Define any authentication, layout and before_filter logic in here.
+The gem contains a dummy rails apps (under test/dummy) which you can use to test or extend the functionality (contains no styles!).
 
-### JobsController
+To use it in your Rails app, all you need is a Admin::BaseController (which the EasyAdmin controllers will extend). Define any authentication, layout and before_filter logic in there.
+
+### Delayed::Jobs
 To manage Delayed::Jobs, you need to define a method in your Admin::BaseController called authorize_jobs which will control access to the JobsController.
 
     class Admin::BaseController < ApplicationController
-      layout 'admin'      
+      layout 'admin'
 
       private
-      
+
       def authorize_jobs
-        @current_user.admin?
+        redirect_to root_path unless @current_user.admin?
       end
     end
 
@@ -41,6 +43,48 @@ You will get the following routes:
           admin_job GET    /admin/jobs/:id(.:format)                admin/jobs#show
                     DELETE /admin/jobs/:id(.:format)                admin/jobs#destroy
 
+### Outbound Requests
+#### Setup
+To manage OutboundRequests you need to define a method in your Admin::BaseController called authorize_outbound_requests which will controll access to the OutboundRequestsController.
+
+    class Admin::BaseController < ApplicationController
+      layout 'admin'
+
+      private
+
+      def authorize_outbound_requests
+        redirect_to root_path unless @current_user.admin?
+      end
+    end
+
+You need to run this for generating the outbound_request create table migration:
+
+    $ rails g easy_admin:active_record
+
+You also need to define the outbound services as a hash constant. Put this in an EasyAdmin module in application.rb.
+
+    module ::EasyAdmin
+      OUTBOUND_SERVICES = {webhook: 'Webhook', sailthru: 'Sailthru'}
+    end
+
+You will get the following routes:
+
+    admin_outbound_requests GET    /admin/outbound_requests(.:format)     admin/outbound_requests#index
+    admin_outbound_request GET    /admin/outbound_requests/:id(.:format) admin/outbound_requests#show
+
+You will also get a rake task to delete old outbound requests. `age` is counted in days. Default age = 2:
+
+    rake requests:clean[age]
+
+#### Methods
+If you want to get the request elapse time, you can call `elapsed_time`:
+
+    outbound_request = OutboundRequest.create(service: :twitter, identifier: 'abletech', action: :dm)
+      # do request here
+    outbound_request.update_attribute(:response_code, response.code)
+
+    outbound_request.elapsed_time
+
 ## Contributing
 
 1. Fork it

data/app/controllers/admin/outbound_requests_controller.rb

@@ -0,0 +1,12 @@
+class Admin::OutboundRequestsController < Admin::BaseController
+  before_filter :authorize_outbound_requests
+
+  def index
+    @outbound_requests = OutboundRequest.search(params)
+    @services = EasyAdmin::OUTBOUND_SERVICES.invert
+  end
+
+  def show
+    @outbound_request = OutboundRequest.find(params[:id])
+  end
+end

data/app/models/outbound_request.rb

@@ -0,0 +1,48 @@
+# == Schema Information
+#
+# Table name: outbound_requests
+#
+#  id            :integer         not null, primary key
+#  service       :string(255)
+#  action        :string(255)
+#  identifier    :string(255)
+#  params        :text
+#  response_code :string(255)
+#  response_body :text
+#  error         :text
+#  created_at    :datetime        not null
+#  updated_at    :datetime        not null
+#
+
+class OutboundRequest < ActiveRecord::Base
+  serialize :params
+  serialize :response_body
+
+  attr_accessible :service, :action, :identifier, :params, :response_code, :response_body, :error
+
+  self.per_page = 50
+
+  scope :partial_search, lambda { |column, query|
+    where("lower(#{column}) LIKE lower(?)", "%#{query}%")
+  }
+
+  def self.search(params)
+    identifier = params[:identifier]
+    service = params[:service]
+    action = params[:request_action]
+
+    requests = self.order('created_at desc')
+    requests = requests.partial_search(:identifier, identifier) if identifier.present?
+    requests = requests.where(service: service) if service.present?
+    requests = requests.where(action: action) if action.present?
+    requests = requests.page(params[:page])
+  end
+
+  def self.delete_requests_older_than(age)
+    self.where('created_at < ?', (Time.now - age)).delete_all
+  end
+
+  def elapsed_time
+    updated_at - created_at
+  end
+end

data/app/views/admin/outbound_requests/_pagination.html.erb

@@ -0,0 +1,6 @@
+<div class="apple_pagination">
+  <div class="page_info">
+    <%= page_entries_info rows, :model => model.pluralize(rows.count) %>
+  </div>
+  <%= will_paginate rows, :container => false %>
+</div>

data/app/views/admin/outbound_requests/index.html.erb

@@ -0,0 +1,51 @@
+<h2>Outbound Requests</h2>
+
+<%= form_tag admin_outbound_requests_path, :method => :get  do %>
+  <dl class="field">
+    <dt><%= label_tag :service %></dt>
+    <dd><%= select_tag :service, options_for_select(@services, params[:service]), include_blank: true %></dd>
+  </dl>
+  <dl class="field">
+    <dt><%= label_tag :identifier %></dt>
+    <dd>
+      <%= text_field_tag :identifier, params[:identifier] %>
+      <span class="help">Performs a partial search</span></dd>
+  </dl>
+  <dl class="field">
+    <dt><%= label_tag :request_action, 'Action' %></dt>
+    <dd><%= text_field_tag :request_action, params[:request_action] %></dd>
+  </dl>
+  <div class="buttons">
+    <%= submit_tag "Filter", :class => 'form-submit' %>
+  </div>
+<% end %>
+<br/>
+<%= render 'pagination', rows: @outbound_requests, model: "#{params[:service] || 'Outbound'} request" unless @outbound_requests.empty? %>
+<br>
+<div class="standard">
+  <table class="sortable">
+    <% if @outbound_requests.empty? %>
+      <tr>
+        <td colspan='5'>No requests found</td>
+      </tr>
+    <% else %>
+      <tr>
+        <th class="sorted">Service</th>
+        <th class="sorted">Action</th>
+        <th class="sorted">Identifier</th>
+        <th class="sorted">Response Code</th>
+        <th class="sorted">Created At</th>
+      </tr>
+      <% @outbound_requests.each do |request| %>
+        <tr>
+          <td><%= EasyAdmin::OUTBOUND_SERVICES[request.service.to_sym] %>
+          <td><%= link_to request.action, admin_outbound_request_path(request) %></td>
+          <td><%= request.identifier %></td>
+          <td><%= request.response_code %></td>
+          <td><%= request.created_at.to_s %></td>
+        </tr>
+      <% end %>
+    <% end %>
+  </table>
+</div>
+<%= render 'pagination', rows: @outbound_requests, model: "#{params[:service] || 'Outbound'} request" unless @outbound_requests.empty? %>

data/app/views/admin/outbound_requests/show.html.erb

@@ -0,0 +1,58 @@
+<div class="clear options">
+  <%= link_to "&laquo; Back".html_safe, admin_outbound_requests_path %>
+</div>
+
+<h2><%= EasyAdmin::OUTBOUND_SERVICES[@outbound_request.service.to_sym] %> Request <%= @outbound_request.id %></h2>
+
+<table class="details">
+  <tr>
+    <th>Action</th>
+    <td><%= @outbound_request.action %></td>
+  </tr>
+  <tr>
+    <th>Identifier</th>
+    <td><%= @outbound_request.identifier %></td>
+  </tr>
+  <tr>
+    <th>Created At</th>
+    <td><%= @outbound_request.created_at.to_s(:display) %></td>
+  </tr>
+  <tr>
+    <th>Updated At</th>
+    <td><%= @outbound_request.updated_at.to_s(:display) %></td>
+  </tr>
+</table>
+
+<h3>Request</h3>
+<table class="details">
+  <tr>
+    <th>Request Params</th>
+    <td><%= @outbound_request.params.to_s.gsub(",", "<br>").html_safe %></td>
+  </tr>
+  <tr>
+    <th>Elapsed Time</th>
+    <td><%= @outbound_request.elapsed_time.round(2) %> seconds</td>
+  </tr>
+</table>
+
+<h3>Response</h3>
+<table class="details">
+  <tr>
+    <th>Response Code</th>
+    <td><%= @outbound_request.response_code %></td>
+  </tr>
+  <tr>
+    <th>Response Body</th>
+    <td><%= @outbound_request.response_body %></td>
+  </tr>
+  <% unless @outbound_request.error.blank? %>
+    <tr>
+      <th>Error</th>
+      <td><%= @outbound_request.error %></td>
+    </tr>
+    <% end %>
+</table>
+
+<div class="clear options">
+  <%= link_to "&laquo; Back".html_safe, admin_outbound_requests_path %>
+</div>

data/config/routes.rb

@@ -5,5 +5,6 @@ Rails.application.routes.draw do
         post :retry
       end
     end
+    resources :outbound_requests, only: [:index, :show]
   end
 end

data/lib/easy_admin/engine.rb

@@ -1,4 +1,18 @@
 module EasyAdmin
   class Engine < ::Rails::Engine
+    require 'will_paginate'
+  end
+
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      namespace :requests do
+        desc "Delete old outbound requests, DEFAULT=2 (days)."
+        task :clean, [:age] => :environment do |task, params|
+          params.with_defaults(age: 2)
+          outbound_request_count = OutboundRequest.delete_requests_older_than(params[:age].to_i.days)
+          puts "Deleted #{outbound_request_count} old Outbound Requests"
+        end
+      end
+    end
   end
 end

data/lib/easy_admin/version.rb

@@ -1,3 +1,3 @@
 module EasyAdmin
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/easy_admin.rb

@@ -1 +1 @@
-require 'easy_admin/engine'
+require 'easy_admin/engine'

data/lib/generators/easy_admin/active_record_generator.rb

@@ -0,0 +1,10 @@
+module EasyAdmin
+  class ActiveRecordGenerator < Rails::Generators::Base
+    desc "Generates the migration for outbound_requests table"
+    source_root File.expand_path('../templates', __FILE__)
+
+    def outbound_request_migration
+      copy_file "create_outbound_requests.rb", "db/migrate/#{Time.now.utc.strftime("%Y%m%d%H%M%S")}_create_outbound_requests.rb"
+    end
+  end
+end

data/lib/generators/easy_admin/templates/create_outbound_requests.rb

@@ -0,0 +1,18 @@
+class CreateOutboundRequests < ActiveRecord::Migration
+  def change
+    create_table :outbound_requests do |t|
+      t.string :service
+      t.string :action
+      t.string :identifier
+      t.text :params
+      t.string :response_code
+      t.text :response_body
+      t.text :error
+      t.timestamps
+    end
+
+    add_index :outbound_requests, :service
+    add_index :outbound_requests, [:service, :action]
+    add_index :outbound_requests, [:service, :identifier]
+  end
+end

data/test/dummy/app/controllers/admin/base_controller.rb

@@ -7,4 +7,8 @@ class Admin::BaseController < ApplicationController
     #    redirect_to root_path unless @current_user
   end
 
+  def authorize_outbound_requests
+    true
+  end
+
 end

data/test/dummy/app/views/admin/welcome/index.html.erb

@@ -1,4 +1,7 @@
 <h1>Welcome to the dummy app</h1>
 <h2>Use this to test changes to the EasyAdmin gem</h1>
 
-<%= link_to 'Delayed Jobs', admin_jobs_path %>
+<ul>
+  <li><%= link_to 'Delayed Jobs', admin_jobs_path %></li>
+  <li><%= link_to 'Outbound Requests', admin_outbound_requests_path %></li>
+</ul>

data/test/dummy/config/application.rb

@@ -55,5 +55,9 @@ module Dummy
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
   end
+
+  module ::EasyAdmin
+    OUTBOUND_SERVICES = {tracking: 'Tracking API', sailthru: 'Sailthru API', twitter: 'Twitter API', webhook: 'Webhook', sms: 'SMS Global API'}
+  end
 end
 

data/test/dummy/db/migrate/20121220022003_create_outbound_requests.rb

@@ -0,0 +1,15 @@
+class CreateOutboundRequests < ActiveRecord::Migration
+  def change
+    create_table :outbound_requests do |t|
+      t.string :service
+      t.string :action
+      t.string :identifier
+      t.text :params
+      t.string :response_code
+      t.text :response_body
+      t.text :error
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20121114025434) do
+ActiveRecord::Schema.define(:version => 20121220022003) do
 
   create_table "delayed_jobs", :force => true do |t|
     t.integer  "priority",   :default => 0
@@ -29,4 +29,16 @@ ActiveRecord::Schema.define(:version => 20121114025434) do
 
   add_index "delayed_jobs", ["priority", "run_at"], :name => "delayed_jobs_priority"
 
+  create_table "outbound_requests", :force => true do |t|
+    t.string   "service"
+    t.string   "action"
+    t.string   "identifier"
+    t.text     "params"
+    t.string   "response_code"
+    t.text     "response_body"
+    t.text     "error"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
 end