spree_advanced_reporting 2.1.0

data/lib/spree/advanced_report/increment_report/profit.rb

@@ -0,0 +1,41 @@
+class Spree::AdvancedReport::IncrementReport::Profit < Spree::AdvancedReport::IncrementReport
+  def name
+    I18n.t("adv_report.increment_report.profit.name")
+    "Profit"
+  end
+
+  def column
+    I18n.t("adv_report.increment_report.profit.column")
+    "Profit"
+  end
+
+  def description
+    I18n.t("adv_report.increment_report.profit.description")
+  end
+
+  def initialize(params)
+    super(params)
+    self.total = 0
+    self.orders.each do |order|
+      date = {}
+      INCREMENTS.each do |type|
+        date[type] = get_bucket(type, order.completed_at || order.updated_at)
+        data[type][date[type]] ||= {
+          :value => 0, 
+          :display => get_display(type, order.completed_at || order.updated_at),
+        }
+      end
+      profit = profit(order)
+      INCREMENTS.each { |type| data[type][date[type]][:value] += profit }
+      self.total += profit
+    end
+
+    generate_ruport_data
+
+    INCREMENTS.each { |type| ruportdata[type].replace_column(name) { |r| "$%0.2f" % r[name] } }
+  end
+
+  def format_total
+    '$' + ((self.total*100).round.to_f / 100).to_s
+  end
+end

data/lib/spree/advanced_report/increment_report/revenue.rb

@@ -0,0 +1,40 @@
+class Spree::AdvancedReport::IncrementReport::Revenue < Spree::AdvancedReport::IncrementReport
+  def name
+    I18n.t("adv_report.increment_report.revenue.name")
+  end
+
+  def column
+    I18n.t("adv_report.increment_report.revenue.column")
+  end
+
+  def description
+    I18n.t("adv_report.increment_report.revenue.description")
+  end
+
+  def initialize(params)
+    super(params)
+    self.total = 0
+
+    self.orders.each do |order|
+      date = {}
+      INCREMENTS.each do |type|
+        date[type] = get_bucket(type, (order.completed_at || order.updated_at))
+        data[type][date[type]] ||= {
+          :value => 0,
+          :display => get_display(type, (order.completed_at || order.updated_at)),
+        }
+      end
+      rev = revenue(order)
+      INCREMENTS.each { |type| data[type][date[type]][:value] += rev }
+      self.total += rev
+    end
+
+    generate_ruport_data
+
+    INCREMENTS.each { |type| ruportdata[type].replace_column(name) { |r| "$%0.2f" % r[name] } }
+  end
+
+  def format_total
+    '$' + ((self.total*100).round.to_f / 100).to_s
+  end
+end

data/lib/spree/advanced_report/increment_report/units.rb

@@ -0,0 +1,33 @@
+class Spree::AdvancedReport::IncrementReport::Units < Spree::AdvancedReport::IncrementReport
+  def name
+    I18n.t("adv_report.increment_report.units.name")
+  end
+
+  def column
+    I18n.t("adv_report.increment_report.units.column")
+  end
+
+  def description
+    I18n.t("adv_report.increment_report.units.description")
+  end
+
+  def initialize(params)
+    super(params)
+    self.total = 0
+    self.orders.each do |order|
+      date = {}
+      INCREMENTS.each do |type|
+        date[type] = get_bucket(type, order.completed_at)
+        data[type][date[type]] ||= {
+          :value => 0, 
+          :display => get_display(type, order.completed_at),
+        }
+      end
+      units = units(order)
+      INCREMENTS.each { |type| data[type][date[type]][:value] += units }
+      self.total += units
+    end
+
+    generate_ruport_data
+  end
+end

data/lib/spree/advanced_report/top_report.rb

@@ -0,0 +1,2 @@
+class Spree::AdvancedReport::TopReport < Spree::AdvancedReport
+end

data/lib/spree/advanced_report/top_report/top_customers.rb

@@ -0,0 +1,32 @@
+class Spree::AdvancedReport::TopReport::TopCustomers < Spree::AdvancedReport::TopReport
+  def name
+    I18n.t("adv_report.top_report.top_customers.name")
+  end
+
+  def description
+    I18n.t("adv_report.top_report.top_customers.description")
+  end
+
+  def initialize(params, limit)
+    super(params)
+
+    orders.each do |order|
+      if order.user
+        data[order.user.id] ||= {
+          :email => order.user.email,
+          :revenue => 0,
+          :units => 0
+        }
+        data[order.user.id][:revenue] += revenue(order)
+        data[order.user.id][:units] += units(order)
+      end
+    end
+
+    self.ruportdata = Table(I18n.t("adv_report.top_report.top_customers.table"))
+    data.inject({}) { |h, (k, v) | h[k] = v[:revenue]; h }.sort { |a, b| a[1] <=> b [1] }.reverse[0..4].each do |k, v|
+      ruportdata << { "email" => data[k][:email], I18n.t("adv_report.units") => data[k][:units], I18n.t("adv_report.revenue") => data[k][:revenue] } 
+    end
+    ruportdata.replace_column(I18n.t("adv_report.revenue")) { |r| "$%0.2f" % r.send(I18n.t("adv_report.revenue")) }
+    ruportdata.rename_column("email", I18n.t("adv_report.top_report.top_customers.customer_email"))
+  end
+end

data/lib/spree/advanced_report/top_report/top_products.rb

@@ -0,0 +1,35 @@
+class Spree::AdvancedReport::TopReport::TopProducts < Spree::AdvancedReport::TopReport
+  def name
+    I18n.t("adv_report.top_report.top_products.name")
+  end
+
+  def description
+    I18n.t("adv_report.top_report.top_products.description")
+  end
+
+  def initialize(params, limit)
+    super(params)
+
+    orders.each do |order|
+      order.line_items.each do |li|
+        if !li.product.nil?
+          data[li.product.id] ||= {
+            :name => li.product.name.to_s,
+            :revenue => 0,
+            :units => 0
+          }
+          data[li.product.id][:revenue] += li.quantity*li.price 
+          data[li.product.id][:units] += li.quantity
+        end
+      end
+    end
+
+    self.ruportdata = Table(I18n.t("adv_report.top_report.top_products.table"))
+    data.inject({}) { |h, (k, v) | h[k] = v[:revenue]; h }.sort { |a, b| a[1] <=> b [1] }.reverse[0..limit].each do |k, v|
+      ruportdata << { "name" => data[k][:name], I18n.t("adv_report.units") => data[k][:units], I18n.t("adv_report.revenue") => data[k][:revenue] } 
+    end
+
+    ruportdata.replace_column(I18n.t("adv_report.revenue")) { |r| "$%0.2f" % r.send(I18n.t("adv_report.revenue")) }
+    ruportdata.rename_column("name", I18n.t("adv_report.top_report.top_products.product_name"))
+  end
+end

data/lib/spree/advanced_report/transaction_report.rb

@@ -0,0 +1,79 @@
+class Spree::AdvancedReport::TransactionReport < Spree::AdvancedReport
+  include ActionView::Helpers::NumberHelper
+  include ActionView::Helpers::UrlHelper
+
+  def name
+    "Transaction Report"
+  end
+
+  def description
+    "Top purchasing customers, calculated by revenue"
+  end
+
+  def initialize(params)
+    super(params)
+
+    self.ruportdata = Ruport::Data::Group.new({
+      :name => "#{self.name} #{self.date_range}",
+      :column_names => %w[date type id total state]
+    })
+
+    card_listing = {}
+
+    orders.each do |order|
+      order.payments.each do |payment|
+        # create a direct link for easy inspection
+        gateway_link = payment.response_code
+
+        if payment.payment_method.type == "Spree::Gateway::AuthorizeNetCim" and payment.response_code.present?
+          gateway_link = link_to(payment.response_code, "https://account.authorize.net/UI/themes/anet/transaction/transactiondetail.aspx?transID=#{payment.response_code}", target: '_blank')
+        end
+
+        if payment.source.class == Spree::Creditcard
+          credit_cart_type = payment.source.cc_type
+        else
+          # it seems as though a previous payment can be used a payment type
+          # links to the previous payment's credit card
+          credit_cart_type = payment.source.source.cc_type
+        end
+
+        (card_listing[credit_cart_type] ||= []) << {
+          "date" => payment.source.created_at.to_formatted_s(:db),
+          "type" => credit_cart_type.humanize.titlecase,
+          "id" => gateway_link,
+          "total" => payment.amount,
+          "state" => payment.state,
+        }
+      end
+    end
+
+    @sales_total = 0
+
+    card_listing.keys.sort.each do |card_name|
+      card_total = card_listing[card_name].map { |c| c["total"] * (c["state"] == 'void' ? 0 : 1) }.sum
+      @sales_total += card_total
+
+      ruportdata << {
+        "date" => "<b>#{card_name.humanize.titlecase} (#{card_listing[card_name].count}): #{number_to_currency(card_total)}</b>"
+      }
+
+      card_listing[card_name].each do |transaction|
+        transaction["total"] = number_to_currency(transaction["total"])
+        ruportdata << transaction
+      end
+    end
+    
+    ruportdata << { "date" => "<b>Sales Total: #{number_to_currency(@sales_total)}</b>" }
+
+    # spaces don't seem to work in column names (ruport is old...)
+    ruportdata.rename_column("date", "Transaction Date")
+    ruportdata.rename_column("type", "Card Type")
+    ruportdata.rename_column("id", "Transaction ID")
+    ruportdata.rename_column("total", "Payment Total")
+    ruportdata.rename_column("state", "Payment State")
+  end
+
+  def sales_total
+    @sales_total
+  end
+end

data/lib/spree_advanced_reporting.rb

@@ -0,0 +1,25 @@
+require "ruport"
+require 'wicked_pdf'
+
+module Spree
+  module AdvancedReporting
+    class Engine < Rails::Engine
+      engine_name "spree_advanced_reporting"
+
+      config.autoload_paths += %W(#{config.root}/lib)
+
+      initializer :assets do |config|
+        Rails.application.config.assets.precompile += %w( admin/advanced_reporting/advanced_reporting.css )
+      end
+
+      def self.activate
+        Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator.rb")).each do |c|
+          Rails.env.production? ? require(c) : load(c)
+        end
+      end
+
+      config.to_prepare &method(:activate).to_proc
+    end
+  end
+end
+

data/spree_advanced_reporting.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_advanced_reporting'
+  s.version     = '2.1.0'
+  s.summary     = 'Advanced Reporting for Spree'
+  s.description = 'Adds many useful reports, with PDF and CSV output, to Spree'
+  s.homepage    = 'https://github.com/iloveitaly/spree_advanced_reporting'
+  s.authors	    = ['Steph Skardal', 'Michael Bianco']
+  s.email	      = ['steph@endpoint.com', 'info@cliffsidedev.com']
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.has_rdoc = true
+
+  s.add_dependency 'spree_core', '>= 1.1.2'
+
+  # use https://github.com/iloveitaly/ruport/tree/wicked-pdf
+  s.add_dependency 'ruport', '>= 1.8'
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: spree_advanced_reporting
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Steph Skardal
+- Michael Bianco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: ruport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Adds many useful reports, with PDF and CSV output, to Spree
+email:
+- steph@endpoint.com
+- info@cliffsidedev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- TODO.txt
+- app/assets/images/admin/advanced_reporting/asc.gif
+- app/assets/images/admin/advanced_reporting/barchart.png
+- app/assets/images/admin/advanced_reporting/bg.gif
+- app/assets/images/admin/advanced_reporting/close.png
+- app/assets/images/admin/advanced_reporting/desc.gif
+- app/assets/images/admin/advanced_reporting/menu-current-opposite.png
+- app/assets/images/admin/advanced_reporting/open.png
+- app/assets/images/admin/advanced_reporting/save.png
+- app/assets/images/admin/advanced_reporting/search.png
+- app/assets/images/admin/advanced_reporting/usa.png
+- app/assets/images/admin/advanced_reporting/world.png
+- app/assets/javascripts/.DS_Store
+- app/assets/javascripts/admin/.DS_Store
+- app/assets/javascripts/admin/advanced_reporting/advanced_reporting.js
+- app/assets/javascripts/admin/advanced_reporting/jquery.tablesorter.min.js
+- app/assets/stylesheets/admin/.DS_Store
+- app/assets/stylesheets/admin/advanced_reporting/advanced_reporting.css.erb
+- app/assets/stylesheets/pdf.css
+- app/controllers/spree/admin/advanced_report_overview_controller.rb
+- app/controllers/spree/admin/reports_controller_decorator.rb
+- app/helpers/advanced_report_helper.rb
+- app/models/ruport/formatter/html_decorator.rb
+- app/models/ruport/formatter/wicked_pdf_decorator.rb
+- app/views/spree/admin/advanced_report_overview/index.html.erb
+- app/views/spree/admin/reports/_advanced_report_criteria.html.erb
+- app/views/spree/admin/reports/geo_base.html.erb
+- app/views/spree/admin/reports/increment_base.html.erb
+- app/views/spree/admin/reports/outstanding.html.erb
+- app/views/spree/admin/reports/top_base.html.erb
+- config/locales/en.yml
+- config/locales/pt-BR.yml
+- config/routes.rb
+- lib/spree/advanced_report.rb
+- lib/spree/advanced_report/geo_report.rb
+- lib/spree/advanced_report/geo_report/geo_profit.rb
+- lib/spree/advanced_report/geo_report/geo_revenue.rb
+- lib/spree/advanced_report/geo_report/geo_units.rb
+- lib/spree/advanced_report/increment_report.rb
+- lib/spree/advanced_report/increment_report/count.rb
+- lib/spree/advanced_report/increment_report/profit.rb
+- lib/spree/advanced_report/increment_report/revenue.rb
+- lib/spree/advanced_report/increment_report/units.rb
+- lib/spree/advanced_report/top_report.rb
+- lib/spree/advanced_report/top_report/top_customers.rb
+- lib/spree/advanced_report/top_report/top_products.rb
+- lib/spree/advanced_report/transaction_report.rb
+- lib/spree_advanced_reporting.rb
+- spree_advanced_reporting.gemspec
+homepage: https://github.com/iloveitaly/spree_advanced_reporting
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Advanced Reporting for Spree
+test_files: []