ar_report 0.0.1.alpha

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Manish Puri
+
+MIT License
+
+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,72 @@
+# ArReport
+
+Install, Generate and email.. cant get simpler than this.. Generate basic ActiveRecord Report with ease. 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar_report'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar_report
+
+## Usage
+
+This gem uses the spreadsheet and mail gem to send out reports to a email specified email address.
+
+Once you install the gem, Use it as follows.
+
+Run, 
+
+	$ rails g ar_report:install
+
+This will generate a config/ar_report.yml in your application directory. 
+
+When you open this file, you can specify various options fir your report like models, report_name, report_from and report_to. Following is the structure for the yml: 
+<pre>
+	ar_report: 
+	  models: #specify model name here for eg 'User' or array of models ['User', 'Post'] 
+
+    file_name: #specify name of the xls report to be attached  
+
+    report_from: # specify email address of user from which you want to send the email. 
+
+    report_to:   # specify email address of users/group to whom you want to send an email to. 
+</pre>
+
+Fill in al the required details and.. hey.. you are done..! 
+
+Just run the rake provided by the gem:
+
+    $ rake ar_report:generate 
+
+ This will generate a xls file in your public folder. 
+
+You could also run:
+
+    $ rake ar_report:generate_and_email 
+
+ This will not only generate an xls fie but will also mail it to the emai address specified in the ar_report.yml file.
+
+ Note: This gem depends on Mail gem to send out emails. So, Please specify the configs for the mail gem. Refer https://github.com/mikel/mail for details. 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+#ToDo 
+
+Specs.
+
+:collision: :collision: :collision:

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/ar_report.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ar_report/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Manish Puri"]
+  gem.email         = ["manishspuri@gmail.com"]
+  gem.description   = %q{A wrapper to send model reports using using spreadsheet and mail gem}
+  gem.summary       = %q{This gem will extract an excel report from a activerecord model and send a report to a specified email}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ar_report"
+  gem.require_paths = ["lib"]
+  gem.version       = ArReport::VERSION
+
+  gem.add_dependency 'rails'
+  gem.add_dependency 'spreadsheet'  
+
+  gem.add_dependency 'mail'
+  gem.add_development_dependency 'rspec'
+  #gem.add_development_dependency 'sqlite3'
+end

data/lib/ar_report/version.rb

@@ -0,0 +1,3 @@
+module ArReport
+  VERSION = "0.0.1.alpha"
+end

data/lib/ar_report.rb

@@ -0,0 +1,79 @@
+require "ar_report/version"
+require 'yaml'
+require 'settings'
+require 'spreadsheet'
+
+module ArReport
+  require "railtie" if defined?(Rails)
+
+class << self
+  def start(options={})
+    Settings.load!
+  	generate_report
+    email_report if options[:mail]
+    schedule_report if options[:schedule]
+  end
+
+  private
+  def generate_report
+    begin
+      p 'Generating excel report...'
+      book = Spreadsheet::Workbook.new
+      get_valid_model_names.each do |class_name_str|
+        p 'Exporting.. '+ class_name_str.pluralize
+        sheet = book.create_worksheet :name => class_name_str
+        class_name=class_name_str.constantize
+        columns=class_name.column_names
+        columns.each { |x| sheet.row(0).push x}
+   
+        class_eval(class_name_str).all.each_with_index do |record,i|
+          row_values =[] 
+    
+          columns.each do |column|
+            row_values << record.send(column)
+          end
+        
+          row_values.each { |x|sheet.row(i+1).push x}
+        end
+      end
+      spreadsheet = StringIO.new 
+      p "Report Generated at 'public/#{get_file_name}'. Thankyou for using Ar_Report.!"
+      book.write "public/#{get_file_name}"
+    rescue
+    #   raise "ArReport::Error: No models specified. Please add model names to config/ar_report.yml"
+    end
+
+
+  end
+
+  def email_report
+    raise "ArReport::Error: Please specify report_to and report_from email addresses in config/ar_report.yml" if (Settings.ar_report[:report_from].nil? || Settings.ar_report[:report_to].nil? )
+    
+    file_name=get_file_name
+    mail = Mail.new do
+      from Settings.ar_report[:report_from]
+      to Settings.ar_report[:report_to]
+      subject Settings.ar_report[:report_to]
+      attachments[file_name] = File.read("#{Rails.root}/public/#{file_name}")
+    end
+    mail.deliver!
+  end
+
+  def get_valid_model_names
+    raise "No models specified. Please add model names to config/ar_report.yml" if Settings.ar_report[:models].nil?
+    Settings.ar_report[:models].gsub(/\s+/, "").split(',').delete_if{|a| class_eval(a).superclass!=ActiveRecord::Base rescue true}
+  end
+
+  def get_file_name
+    (Settings.ar_report[:file_name] || "ar_report_#{Date.today}") + '.xls'
+  end
+end
+
+end
+
+
+
+
+
+
+

data/lib/generators/ar_report/install_generator.rb

@@ -0,0 +1,15 @@
+module ArReport
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates config file to your application."
+
+      def copy_initializer
+        require 'rails'
+        template '../templates/ar_report.yml', 'config/ar_report.yml'
+      end
+    
+    end
+  end
+end

data/lib/generators/ar_report/templates/ar_report.yml

@@ -0,0 +1,13 @@
+ar_report: 
+  models: #specify model name here for eg 'User' or array of models ['User'.'Post'] 
+
+  file_name: #specify name of the report to be attached
+
+  subject: #specify subject of the email to be sent.
+
+  report_from: # specify email addresses of the users/group to receive an email. 
+
+  report_to:   # specify email address from which you want to receive an email. 
+
+
+

data/lib/railtie.rb

@@ -0,0 +1,10 @@
+require 'ar_report'
+require 'rails'
+module ArReport
+  class Railtie < Rails::Railtie
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'/../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/settings.rb

@@ -0,0 +1,25 @@
+module Settings
+  
+  
+  extend self
+  # again - it's a singleton, thus implemented as a self-extended module
+@_settings = {}
+
+def load!(options={})
+    @_settings = YAML::load(ERB.new(Rails.root.join("config", "ar_report.yml").read).result).with_indifferent_access
+    @_settings = newsets[options[:env].to_sym] if \
+                                               options[:env] && \
+                                               newsets[options[:env].to_sym]
+
+  end
+
+
+
+ def method_missing(name, *args, &block)
+    @_settings.with_indifferent_access[name.to_sym] ||
+    fail(NoMethodError, "unknown configuration root #{name}", caller)
+  end
+
+
+
+end

data/tasks/ar_report.rake

@@ -0,0 +1,14 @@
+# Author Manish Puri
+# Task to setup mailer
+namespace :ar_report do
+  task :generate => :environment do
+     ArReport.start
+  end
+
+  task :generate_and_mail => :environment do
+    p 'Please note ar_report relies on mail gem to send out emails. Please make sure you have specified the SMTP settings 
+       as required by the mail gem.'
+     ArReport.start(:mail=>true)
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: ar_report
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Manish Puri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spreadsheet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper to send model reports using using spreadsheet and mail gem
+email:
+- manishspuri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ar_report.gemspec
+- lib/ar_report.rb
+- lib/ar_report/version.rb
+- lib/generators/ar_report/install_generator.rb
+- lib/generators/ar_report/templates/ar_report.yml
+- lib/railtie.rb
+- lib/settings.rb
+- tasks/ar_report.rake
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This gem will extract an excel report from a activerecord model and send
+  a report to a specified email
+test_files: []