shopify_dashboard_plus 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5eec23dd7be2f6961002521056ee0b78c7b16f47
-  data.tar.gz: 9476b25596ca4545fe7700488a54322210408195
+  metadata.gz: f9cb5e599bcb7d985aecabdaa34959e0bd0ac515
+  data.tar.gz: a6ddcb38acf2a363c585ab864b93b62003bd3c5d
 SHA512:
-  metadata.gz: cd5f93de262d3d3a86f49c12d3d8800e6d398372188b6e565d9f6fbbb2ff65185b9dc61a2cb25726b77b1b036ca12106497d174aed3396d48ae1e849bffce3c0
-  data.tar.gz: 8b1526903f8805beaecbb761dae82156c4eecd9fc200950488e7bc74ae2f96cf6448dc05e2bfb703d6cd5299f23e5dc70bebf4adcb95cf83191f32f116e5a660
+  metadata.gz: 698165b5c02d12e72464cf9030dea2ceaeb06ce302d04f442f24a56a71d6b8c165ce9c70c914b1d9a44a51a63c463b71371eb924f46ff2543ccdc671506cc469
+  data.tar.gz: b5e7b6ab374f757618c6f2b8e9026918b0dbe50d7537159554987f527446430af7d578d4388f408f2c11af70242d0eee0e6e2e27b4101f37c23ff40ed109b6cb

data/README.md

@@ -20,6 +20,8 @@ Choose the interval over which to get data and see it displayed as:
 * Proportion of Items Sold Per Price Point
 * Number of Items Sold Per Price Point
 * Revenue per Price Point
+* Total Savings per Discount Code
+* Number of Uses per Discount Code
 
 *Countries*
 * Proportion of Sales per Country
@@ -39,16 +41,14 @@ Choose the interval over which to get data and see it displayed as:
 ## Usage
 * To install manually: 
   * `git clone https://github.com/at1as/Shopify_Dashboard_Plus.git`
-* To install via the gem: 
+* To install using the gem: 
   * `gem install shopify_dashboard_plus`
-  * Note: Gem build will generally trail the repo by days-to-weeks
 * For dependencies see: 
   * `shopify_dashboard_plus.gemfile`
 * Retrieve `API Key`, `Password` and `Shop Name` for your store from Shopify Admin
 * Run (key, password & name can be passed as environment variables, or later thorugh the UI):
   * `SHP_KEY="my_key" SHP_PWD="my_password" SHP_NAME="my_shop" ./lib/shopify_dashboard_plus.rb`
 
-## TODO
+## Notes
+* Tested and developed with Ruby 2.1.2 on Mac OS 10.10
 
-* Not all floats render with a two-digit precision
-* Limited to 250 results

data/lib/shopify_dashboard_plus.rb

@@ -5,19 +5,25 @@ require 'tilt/erubis'
 require 'shopify_api'
 require 'uri'
 require 'chartkick'
+require_relative 'shopify_dashboard_plus/helpers'
+require_relative 'shopify_dashboard_plus/report'
+require_relative 'shopify_dashboard_plus/version'
 
 configure do
-  set :public_dir, File.expand_path('../../public', __FILE__)
-  set :views, File.expand_path('../../views', __FILE__)
+  set :public_dir, "#{__dir__}/../public"
+  set :views, "#{__dir__}/../views"
 
   $connected ||= false
-  $flash ||= nil
   $metrics ||= false
+  $flash ||= nil
 
-  HELP = "Set global environment variables before calling script, or call with ENV variables: \
-  \t\nExample: SHP_KEY=\"<shop_key>\" SHP_PWD=\"<shop_password>\" SHP_NAME=\"<shop_name>\" ./lib/shopify-dashboard.rb\n"
+  HELP = <<-END
+  Set global variables through the WebUI or call with the correct ENV variables:
+    Example: SHP_KEY=\"<shop_key>\" SHP_PWD=\"<shop_password>\" SHP_NAME=\"<shop_name>\" ./lib/shopify-dashboard.rb
+  END
 
-  # Connect if Environment variables were set
+  # If Environment variables were set connect to Shopify Admin immediately
+  # Refuse to start server if variables are passed but incorrect
   if ENV["SHP_KEY"] && ENV["SHP_PWD"] && ENV["SHP_NAME"]
     API_KEY = ENV["SHP_KEY"]
     PASSWORD = ENV["SHP_PWD"]
@@ -30,263 +36,33 @@ configure do
       $shop_name = SHOP_NAME
       $connected = true
     rescue Exception => e
-      puts "\nFailed to connect using provided credentials...(Exception: #{e}\n #{HELP}"
+      puts "\nFailed to connect using provided credentials...(Exception: #{e})\n #{HELP}"
       exit
     end
   end
-end
-
-
-helpers do
-  include Rack::Utils
-  alias_method :h, :escape_html
-
-  ## Connection & Setup Helpers
-  # Bind to Shopify Store
-  def set_connection(key, pwd, name)
-    begin
-      shop_url = "https://#{key}:#{pwd}@#{name}.myshopify.com/admin"
-      ShopifyAPI::Base.site = shop_url
-      shop = ShopifyAPI::Shop.current
-      $shop_name = name
-      connection_open
-    rescue
-      connection_closed
-    end
-  end
-
-  def connection_closed
-    $connected = false
-  end
-
-  def connection_open
-    $connected = true
-  end
-
-  def connected?
-    $connected
-  end
-
-  def shop_name
-    $shop_name
-  end
-
-
-  ## Generic Helpers
-  def hash_to_list(unprocessed_hash)
-    return_list = []
-    unprocessed_hash.each do |key, value|
-      return_list.append([key, value])
-    end
-  end
-
-  def date_today
-    DateTime.now.strftime('%Y-%m-%d')
-  end
-
-  # Validate User Date is valid and start date <= end date
-  def validate_date_range(from, to)
-    interval_start = DateTime.parse(from) rescue nil
-    interval_end = DateTime.parse(to) rescue nil
 
-    if interval_start && interval_end
-      if interval_start <= interval_end
-        return true
-      else
-        return false
-      end
-    end
-    
-    false
-  end
-
-
-  ## Metrics Helpers
-  def get_total_revenue(orders)
-    revenue = orders.collect{|order| order.total_price.to_f }.inject(:+).round(2) rescue 0
-    revenue ||= 0
-  end
   
-  def get_daily_revenues(start_date, end_date, orders)
-    # Create hash entry for total interval over which to inspect sales
-    revenue_per_day = {}
-    days = DateTime.parse(end_date).mjd - DateTime.parse(start_date).mjd
-    (0..days).each{ |day| revenue_per_day[(DateTime.parse(end_date) - day).strftime("%Y-%m-%d")] = 0 }
-
-    # Retreive orders between start and end date (up to 50)
-    revenue = orders.collect{|order| [order.created_at, order.total_price.to_f]}
-    
-    # Filter order details into daily totals and return
-    revenue.each do |sale|
-      revenue_per_day[DateTime.parse(sale[0]).strftime('%Y-%m-%d')] += sale[1]
+  # When adding 44.95.round(2) + 940.6.round(2) the precision of the result will be 985.5500000000001
+  # In a sample of 100_000_000_000 entries, the precision will round up cents
+  # Since all numbers are currency, the plus method will trim to two decimals
+  # Numbers returned as: 44, 44.5, or 44.51
+  class Fixnum
+    def plus(amount)
+      result = self + (amount.to_f rescue 0)
+      result.round(2)
     end
-    revenue_per_day
   end
 
-  def hash_to_graph_format(sales)
-    
-    # ChartKick requires a strange format to build graphs. For instance, an array of
-    #   {:name => <item_name>, :data => [[<customer_id>, <item_price>], [<customer_id>, <item_price>]]}
-    # places <customer_id> on the independent (x) axis, and stacks item each item by y-axis by price
-
-    # This hash will return repeated values (i.e., :data => [["item 1", 6], ["item 1", 6]])
-    # ChartKick will ignore repeated entries. Use `format_hash_for_stacked_graph_repeat` to merge entries before submission
-
-    name_hash = sales.collect{|sale| {:name => sale[:name], :data => []}}.uniq
-    
-    sales.collect do |old_hash|
-      name_hash.collect do |new_hash|
-        if old_hash[:name] == new_hash[:name]
-          new_hash[:data].push(old_hash[:data])
-        end
-      end
+  class Float
+    def plus(amount)
+      result = self + (amount.to_f rescue 0)
+      result.round(2)
     end
-
-    name_hash
   end
+end
 
+helpers ApplicationHelpers
 
-  def hash_to_graph_format_merge(sales)
-    
-    # ChartKick requires an annoying format to build graphs. For instance, an array of entries formated as
-    #   { :name => <item_name>, :data => [[<customer_id>, <item_price>], [<customer_id>, <item_price>]] }
-    # places <customer_id> on the independent (x) axis, and stacks item each item by y-axis by price
-
-    name_hash = sales.collect{|sale| {:name => sale[:name], :data => []}}.uniq
-    
-    sales.collect do |old_hash|
-      name_hash.collect do |new_hash|
-        if old_hash[:name] == new_hash[:name]
-          new_hash[:data].push(old_hash[:data])
-        end
-      end
-    end
-
-    # name_hash may contain repeated values (i.e., :data => [["item 1", 6], ["item 1", 6]])
-    # ChartKick will ignore repeated entries, so they need to be consolidated
-    # i.e., :data => [["item1", 12]]
-
-    name_hash.each_with_index do |item, index|
-      consolidated_data = Hash.new(0)
-      item[:data].each do |purchase_entry|
-        consolidated_data[purchase_entry[0]] += purchase_entry[1]
-      end
-      name_hash[index][:data] = hash_to_list(consolidated_data)
-    end
-
-    name_hash
-  end
-  
-
-  def get_detailed_revenue_metrics(start_date, end_date = DateTime.now)
-    desired_fields = ["total_price", "created_at", "billing_address", "currency", "line_items", "customer", "referring_site"]
-    revenue_metrics = ShopifyAPI::Order.find(:all, :params => { :created_at_min => start_date, 
-                                                                :created_at_max => end_date,
-                                                                :page => 1,
-                                                                :limit => 250,
-                                                                :fields => desired_fields })
-
-    # Revenue
-    total_revenue = get_total_revenue(revenue_metrics)
-    avg_revenue = (total_revenue/(DateTime.parse(end_date).mjd - DateTime.parse(start_date).mjd + 1)).round(2) rescue "N/A"
-    daily_revenue = get_daily_revenues(start_date, end_date, revenue_metrics)
-
-    # Countries & Currencies
-    currencies = Hash.new(0)
-    sales_per_country = Hash.new(0)
-    revenue_per_country = []
-    revenue_per_country_uniq = []
-
-    # Products
-    products = Hash.new(0)
-    revenue_per_product = Hash.new(0)
-
-    # Prices
-    prices = Hash.new(0)
-    revenue_per_price_point = Hash.new(0)
-    
-    # Customers
-    customers = []
-    customer_sales = []
-    customer_sales_uniq = []
-
-    # Referrals
-    referring_pages = Hash.new(0)
-    referring_sites = Hash.new(0)
-    revenue_per_referral_page = Hash.new(0)
-    revenue_per_referral_site = Hash.new(0)
-
-    revenue_metrics.each do |order|
-      
-      if order.attributes['currency']
-        currencies[order.currency] += 1
-      end
-      if order.attributes['billing_address']
-        sales_per_country[order.billing_address.country] += 1
-      end
-      if order.attributes['referring_site']
-        if order.attributes['referring_site'].empty?
-          referring_pages['None'] += 1
-          referring_sites['None'] += 1
-        else
-          host = URI(order.referring_site).host.downcase
-          host = host.start_with?('www.') ? host[4..-1] : host
-          page = order.referring_site
-          page = page.start_with?('http://') ? page[7..-1] : page
-          page = page.start_with?('https://') ? page[8..-1] : page
-          referring_pages[page] += 1
-          referring_sites[host] += 1
-        end
-        order.line_items.each do |line_item|
-          if order.attributes['referring_site'].empty?
-            revenue_per_referral_page['None'] += line_item.price.to_f.round(2) rescue 0
-            revenue_per_referral_site['None'] += line_item.price.to_f.round(2) rescue 0
-          else
-            host = URI(order.referring_site).host
-            host = host.start_with?('www.') ? host[4..-1] : host
-            page = order.referring_site
-            page = page.start_with?('http://') ? page[7..-1] : page
-            page = page.start_with?('https://') ? page[8..-1] : page
-            revenue_per_referral_site[host] += line_item.price.to_f.round(2) rescue 0
-            revenue_per_referral_page[page] += line_item.price.to_f.round(2) rescue 0
-          end
-        end
-      end
-
-      order.line_items.each do |line_item|
-        products[line_item.title] += 1
-        prices[line_item.price] += 1
-        revenue_per_price_point[line_item.price] += line_item.price.to_f.round(2) rescue 0
-        revenue_per_product[line_item.title] += line_item.price.to_f.round(2) rescue 0
-        
-        revenue_per_country.push({:name => line_item.title, :data => [order.billing_address.country, line_item.price.to_f]})
-        customer_sales.push({:name => line_item.title, :data => [order.customer.id.to_s, line_item.price.to_f]})
-      end
-
-      customer_sales_uniq = hash_to_graph_format(customer_sales)
-      revenue_per_country_uniq = hash_to_graph_format_merge(revenue_per_country)
-    end
-
-    metrics = { :currencies => currencies,
-                :sales_per_country => sales_per_country,
-                :revenue_per_country => revenue_per_country_uniq,
-                :products => products,
-                :prices => (prices.sort_by{|x,y| x.to_f }.to_h rescue {}),
-                :customer_sales => customer_sales_uniq,
-                :referring_sites => (referring_sites.sort().to_h rescue {}),
-                :referring_pages => (referring_pages.sort().to_h rescue {}),
-                :revenue_per_referral_site => (revenue_per_referral_site.sort().to_h rescue {}),
-                :revenue_per_referral_page => (revenue_per_referral_page.sort().to_h rescue {}),
-                :total_revenue => total_revenue,
-                :average_revenue => avg_revenue,
-                :daily_revenue => daily_revenue,
-                :revenue_per_product => revenue_per_product,
-                :revenue_per_price_point => (revenue_per_price_point.sort_by{|x,y| x.to_f }.to_h rescue {})
-              }
-
-    return metrics
-  end
-end
 
 before do
   $flash = nil
@@ -300,11 +76,12 @@ get '/' do
   # If no start date is set, default to match end date
   # If no date parameters are set, default both to today
   @today = date_today
-
   from = (params[:from] if not params[:from].empty? rescue nil) || (params[:to] if not params[:to].empty? rescue nil) || @today
   to = (params[:to] if not params[:to].empty? rescue nil) || @today
 
-  if validate_date_range(from, to)
+  to = @today if to > @today
+
+  if date_range_valid?(from, to)
     @metrics = get_detailed_revenue_metrics(from, to)
     $metrics = true
   else
@@ -331,7 +108,7 @@ end
 
 post '/disconnect' do
   API_KEY, API_PWD, SHP_NAME = "", "", ""
-  connection_closed
+  close_connection
 
   erb :connect
 end

data/lib/shopify_dashboard_plus/helpers.rb

@@ -0,0 +1,202 @@
+module ApplicationHelpers
+
+  include Rack::Utils
+  alias_method :h, :escape_html
+
+  DESIRED_FIELDS = [
+    "total_price",
+    "created_at",
+    "billing_address",
+    "currency",
+    "line_items",
+    "customer",
+    "referring_site",
+    "discount_codes"
+  ]
+
+  ## Connection & Setup Helpers
+  
+  def set_connection(key, pwd, name)
+    shop_url = "https://#{key}:#{pwd}@#{name}.myshopify.com/admin"
+    ShopifyAPI::Base.site = shop_url
+    shop = ShopifyAPI::Shop.current
+    $shop_name = name
+    open_connection
+  rescue
+    close_connection
+  end
+
+  def close_connection
+    $connected = false
+  end
+
+  def open_connection
+    $connected = true
+  end
+
+  def connected?
+    $connected
+  end
+
+  def shop_name
+    $shop_name
+  end
+
+
+  ## Generic Helpers
+
+  def date_today
+    DateTime.now.strftime('%Y-%m-%d')
+  end
+
+  def days(num)
+    num.to_i == 1 ? "#{num} Day" : "#{num} Days"
+  end
+
+  def strip_protocol(page)
+    page.sub(/\Ahttps?:\/\//, "")
+  end
+
+  def get_host(site)
+    URI(site).host.downcase.sub(/\Awww\./, "")
+  end
+
+  def date_range_valid?(from, to)
+    DateTime.parse(from) <= DateTime.parse(to)
+  rescue ArgumentError
+    false
+  end
+
+
+  ## Metrics Helpers
+
+  def display_as_currency(value)
+    ShopifyAPI::Shop.current.money_with_currency_format.gsub("{{amount}}", value.to_s)
+  rescue
+    'N/A'
+  end
+
+  def get_date_range(first, last)
+    DateTime.parse(last).mjd - DateTime.parse(first).mjd
+  end
+
+  def get_total_revenue(orders)
+    totals = orders.map { |order| order.total_price.to_f }
+    totals.inject(:+).round(2)
+  rescue
+    0
+  end
+
+  def get_average_revenue(total_revenue, duration)
+    (total_revenue/duration).round(2)
+  rescue
+    'N/A'
+  end
+  
+  def get_daily_revenues(start_date, end_date, orders)
+    # Create hash entry for every day within interval over which to inspect sales
+    revenue_per_day = {}
+    days = get_date_range(start_date, end_date)
+    (0..days).each{ |day| revenue_per_day[(DateTime.parse(end_date) - day).strftime("%Y-%m-%d")] = 0 }
+
+    # Retreive array of ActiveRecord::Collections, each containing orders between the start and end date
+    order_details = orders.map{ |order| [order.created_at, order.total_price.to_f] }
+    
+    # Filter order details into daily totals and return
+    order_details.each do |(date, total)|
+      day_index = DateTime.parse(date).strftime('%Y-%m-%d')
+      revenue_per_day[day_index] = revenue_per_day[day_index].plus(total)
+    end
+    revenue_per_day
+  end
+
+  def hash_to_graph_format(sales, merge_results: false)
+    
+    # ChartKick requires a strange format to build graphs. For instance, an array of
+    #   {:name => <item_name>, :data => [[<customer_id>, <item_price>], [<customer_id>, <item_price>]]}
+    # places <customer_id> on the independent (x) axis, and stacks each item (item_name) on the y-axis by price (item_price)
+
+    name_hash = sales.map{ |sale| {:name => sale[:name], :data => []} }.uniq
+    
+    sales.map do |old_hash|
+      name_hash.map do |new_hash|
+        if old_hash[:name] == new_hash[:name]
+          new_hash[:data].push(old_hash[:data])
+        end
+      end
+    end
+
+    # This hash will return repeated values (i.e., :data => [["item 1", 6], ["item 1", 6]])
+    # ChartKick will ignore repeated entries, so the totals need to be merged
+    # i.e., :data => [["item1", 12]]
+    if merge_results
+      name_hash.each_with_index do |item, index|
+        consolidated_data = Hash.new(0)
+        item[:data].each do |purchase_entry|
+          consolidated_data[purchase_entry[0]] = consolidated_data[purchase_entry[0]].plus(purchase_entry[1])
+        end
+        name_hash[index][:data] = consolidated_data.to_a
+      end
+    end
+
+    name_hash
+  end
+
+  # Return order query parameters hash
+  def order_parameters_paginate(start_date, end_date, page)
+    {  
+      :created_at_min => start_date + " 0:00", 
+      :created_at_max => end_date + " 23:59:59", 
+      :limit => 250,
+      :page => page,
+      :fields => DESIRED_FIELDS 
+    }
+  end
+
+
+  # Return array of ActiveRecord::Collections, each containing up to :limit (250) orders
+  # Continue to query next page until less than :limit orders are returned, indicating no next pages with orders matching query
+  def get_list_of_orders(start_date, end_date)
+
+    # Get first 250 results matching query
+    params = order_parameters_paginate(start_date, end_date, 1)
+    revenue_metrics = [ShopifyAPI::Order.find(:all, :params => params)]
+    
+    # If the amount of results equal to the limit (250) were returned, pass the query on to the next page (orders 251 to 500)
+    while revenue_metrics.last.length == 250
+      params = order_parameters_paginate(start_date, end_date, revenue_metrics.length + 1)
+      revenue_metrics << ShopifyAPI::Order.find(:all, :params => params)
+    end
+
+    revenue_metrics.flat_map{ |orders| orders.map{ |order| order }}
+  end
+  
+
+  def get_detailed_revenue_metrics(start_date, end_date = DateTime.now)
+
+    order_list = get_list_of_orders(start_date, end_date)
+
+    # Revenue
+    total_revenue = get_total_revenue(order_list)
+    duration = get_date_range(start_date, end_date) + 1
+    avg_revenue = get_average_revenue(total_revenue, duration)
+    daily_revenue = get_daily_revenues(start_date, end_date, order_list)
+    max_daily_revenue = daily_revenue.max_by{ |k,v| v }[1]
+    
+    # Retrieve Metrics
+    sales_report = ShopifyDashboardPlus::SalesReport.new(order_list).to_h
+    revenue_report = ShopifyDashboardPlus::RevenueReport.new(order_list).to_h
+    traffic_report = ShopifyDashboardPlus::TrafficReport.new(order_list).to_h
+    discounts_report = ShopifyDashboardPlus::DiscountReport.new(order_list).to_h
+    metrics = { 
+      :total_revenue => total_revenue,
+      :average_revenue => avg_revenue,
+      :daily_revenue => daily_revenue,
+      :max_daily_revenue => max_daily_revenue,
+      :duration => duration
+    }
+
+    [sales_report, revenue_report, traffic_report, discounts_report, metrics].inject(&:merge)
+  end
+
+end

data/lib/shopify_dashboard_plus/report.rb

@@ -0,0 +1,194 @@
+require_relative 'helpers'
+
+module ShopifyDashboardPlus
+
+  class Report
+    include ApplicationHelpers
+
+    def initialize(orders)
+      @orders = orders
+      @line_items = orders.flat_map{ |order| order.line_items.map { |line_item| line_item }}
+    end
+  end
+
+
+  class SalesReport < Report
+    def sales_per_country
+      sales_per_country = Hash.new(0)
+
+      @orders.each do |order|
+        sales_per_country[order.billing_address.country] += 1 if order.attributes['billing_address']
+      end
+      sales_per_country
+    end
+
+    def sales_per_product
+      sales_per_product = Hash.new(0)
+
+      @line_items.each do |item|
+        sales_per_product[item.title] += 1
+      end
+
+      sales_per_product
+    end
+
+    def sales_per_customer
+      customer_sales = []
+      @orders.each do |order|
+        order.line_items.each do |item|
+          customer_name = "#{order.customer.first_name} #{order.customer.last_name} (#{order.customer.email})"
+          customer_sales.push({ :name => item.title,
+                                :data => [customer_name, item.price.to_f]})
+        end
+      end
+      hash_to_graph_format(customer_sales)
+    end
+
+    def sales_per_price_point
+      sales_per_price_point = Hash.new(0)
+
+      @line_items.each do |item|
+        sales_per_price_point[item.price] += 1
+      end
+      sales_per_price_point.sort_by{ |x,y| x.to_f }.to_h rescue {}
+    end
+
+    def number_of_sales
+      @orders.length
+    end
+
+    def currencies_per_sale
+      currencies = Hash.new(0)
+
+      @orders.each do |order|
+        currencies[order.currency] += 1 if order.attributes['currency']
+      end
+      currencies
+    end
+
+    def to_h
+      {
+        :currencies_per_sale => currencies_per_sale,
+        :sales_per_country => sales_per_country,
+        :sales_per_price => sales_per_price_point,
+        :sales_per_product => sales_per_product,
+        :sales_per_customer => sales_per_customer,
+        :number_of_sales => number_of_sales
+      }
+    end
+  end
+
+
+  class RevenueReport < Report
+    def revenue_per_country
+      revenue_per_country = []
+      @orders.each do |order|
+        order.line_items.each do |item|
+          revenue_per_country.push({:name => item.title, 
+                                    :data => [order.billing_address.country, item.price.to_f]})
+        end
+      end
+      hash_to_graph_format(revenue_per_country, merge_results: true)
+    end
+
+    def revenue_per_price_point
+      revenue_per_price_point = Hash.new(0)
+      @line_items.each do |item|
+        revenue_per_price_point[item.price] = revenue_per_price_point[item.price].plus(item.price)
+      end
+      revenue_per_price_point.sort_by{ |x,y| x.to_f }.to_h rescue {}
+    end
+
+    def revenue_per_product
+      revenue_per_product = Hash.new(0.0)
+      @line_items.each do |item|
+        revenue_per_product[item.title] = revenue_per_product[item.title].plus(item.price)
+      end
+      revenue_per_product
+    end
+
+    def to_h
+      {
+        :revenue_per_country => revenue_per_country,
+        :revenue_per_product => revenue_per_product,
+        :revenue_per_price_point => revenue_per_price_point,
+      }
+    end
+  end
+
+
+  class DiscountReport < Report
+
+    def discount_usage
+      discount_value, discount_used = Hash.new(0.0), Hash.new(0)
+
+      @orders.each do |order|
+        if order.attributes['discount_codes']
+          order.discount_codes.each do |discount_code|
+            discount_value[discount_code.code] = discount_value[discount_code.code].plus(discount_code.amount)
+            discount_used[discount_code.code] += 1
+          end
+        end
+      end
+      {
+        :discount_savings => discount_value,
+        :discount_quantity => discount_used
+      }
+    end
+
+    def to_h
+      discount_usage
+    end
+  end
+
+
+  class TrafficReport < Report
+
+    def number_of_referrals
+      referring_sites, referring_pages = Hash.new(0), Hash.new(0)
+
+      @orders.each do |order|
+        if order.attributes['referring_site'].empty?
+          referring_pages['None'] += 1
+          referring_sites['None'] += 1
+        else
+          host = get_host(order.referring_site)
+          page = strip_protocol(order.referring_site)
+          referring_pages[page] += 1
+          referring_sites[host] += 1
+        end
+      end
+      {
+        :referral_sites => (referring_sites.sort().to_h rescue {}),
+        :referral_pages => (referring_pages.sort().to_h rescue {})
+      }
+    end
+
+    def traffic_revenue
+      revenue_per_referral_page, revenue_per_referral_site = Hash.new(0.0), Hash.new(0.0)
+
+      @orders.each do |order|
+        order.line_items.each do |item|
+          if order.attributes['referring_site'].empty?
+            revenue_per_referral_page['None'] = revenue_per_referral_page['None'].plus(item.price)
+            revenue_per_referral_site['None'] = revenue_per_referral_site['None'].plus(item.price)
+          else
+            host = get_host(order.referring_site)
+            page = strip_protocol(order.referring_site)
+            revenue_per_referral_site[host] = revenue_per_referral_site[host].plus(item.price)
+            revenue_per_referral_page[page] = revenue_per_referral_page[page].plus(item.price)
+          end
+        end
+      end
+      {
+        :revenue_per_referral_site => revenue_per_referral_site.sort().to_h,
+        :revenue_per_referral_page => revenue_per_referral_page.sort().to_h
+      }
+    end
+
+    def to_h
+      traffic_revenue.merge(number_of_referrals)
+    end
+  end
+
+end

data/lib/{version/shopify_dashboard_plus.rb → shopify_dashboard_plus/version.rb}

@@ -1,3 +1,3 @@
 module ShopifyDashboardPlus
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/public/css/common.css

@@ -1,3 +1,6 @@
+body{
+	background-color:#444;
+}
 .graph-container{
 	width:100%;
 	text-align:center;
@@ -5,7 +8,7 @@
 .graph-border{
   border:1px solid #e3e3e3;
   border-radius:4px;
-  background-color:#f5f5f5;
+  background-color:#fff;
   padding-right:10px;
   padding-left:10px;
   margin-left:auto;
@@ -14,6 +17,26 @@
   margin-bottom:10px;
   max-width:1200px;
 }
+.graph-seperator{
+	margin-top:0px;
+	margin-bottom:0px;
+	margin-left:40px;
+	margin-right:40px;
+}
+.graph-metrics{
+	margin-left:20px;
+	margin-right:20px;
+	text-align:center;
+	display:inline-block;
+}
+.graph-metric{
+	margin-left:20px;
+	margin-right:20px;
+	display:inline-block;
+}
+.grey{
+	color:#666;
+}
 h3.section-divider{
   background-color: #666;
   color: white;
@@ -21,13 +44,32 @@ h3.section-divider{
   margin-bottom:15px;
   margin-left: -10px;
   margin-right: -10px;
-  padding-bottom: 5px;
-  padding-top: 5px;
+  padding-bottom: 10px;
+  padding-top: 10px;
   text-align: center;
 }
+h3.money{
+	margin-top:0px;
+	color:#337ab7;
+}
+h3{
+	font-weight:300;
+}
+h4{
+	color:#555;
+}
+h4.graph-heading{
+	font-weight:400;
+	font-size:22px;
+}
 .flash{
 	color:red;
 }
+.date-input{
+	width:100px;
+	margin-left:auto;
+	margin-right:auto;
+}
 
 /*
 // NOTE: media queries not working will chartkick, 

data/shopify_dashboard_plus.gemspec

@@ -4,11 +4,12 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'date'
+require 'shopify_dashboard_plus/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "shopify_dashboard_plus"
   spec.date          = Date.today.to_s
-  spec.version       = "0.0.3"
+  spec.version       = ShopifyDashboardPlus::VERSION
   spec.authors       = ["Jason Willems"]
   spec.email         = ["jason@willems.ca"]
   spec.summary       = "Extended dashboard for shopify admin"

data/views/layout.erb

@@ -5,8 +5,9 @@
     <script>
       var Chartkick = {"language": "en"};
     </script>
-    <script src="http://www.google.com/jsapi"></script>
-    <script src="js/chartkick.min.js"></script>
+    <script src="http://www.google.com/jsapi"></script> <!-- Chart library dependency for chartkick -->
+    <script src="js/chartkick.min.js"></script> <!-- Front end chart library -->
+    <script src="/js/spin.min.js"></script> <!-- Spinner Animation -->
   </head>
   <body>
     <%= yield %>

data/views/report.erb

@@ -1,16 +1,15 @@
 <div id="table_bounds" style="margin-left:10px; margin-right:10px; margin-bottom:40px">
   <div class="well" style="text-align:center; max-width:600px; margin-left:auto; margin-right:auto; margin-top:30px">
     <h2 style="margin-top:10px; margin-bottom:20px">Shopify Dashboard Plus</h2>
-    <hr>
     <% if $flash %><p class="flash"><%= $flash %></p><% end %>
     <div style="margin-bottom:20px;">
       Retrieve metrics over the following period <% if shop_name %>for: <br/><i><b><%= shop_name %>.myshopify.com/admin</b></i><% end %>
     </div>
     <form class="form-inline" id="set-date" method="get" action="/">
       <h4 style="margin-bottom:10px">
-        <input id="from" name="from" class="form-control form-field-small" value="<%= h(params[:from]) %>" pattern="^[1-2][0-9]{3}-[0-3][0-9]-[0-3][0-9]$" placeholder="<%= @today %>">
+        <input id="from" name="from" class="form-control form-field-small date-input" value="<%= h(params[:from]) %>" pattern="^[1-2][0-9]{3}-[0-3][0-9]-[0-3][0-9]$" placeholder="<%= @today %>">
         to
-        <input id="to" name="to" class="form-control form-field-small" value="<%= h(params[:to]) %>" pattern="^[1-2][0-9]{3}-[0-3][0-9]-[0-3][0-9]$"% placeholder="<%= @today %>">
+        <input id="to" name="to" class="form-control form-field-small date-input" value="<%= h(params[:to]) %>" pattern="^[1-2][0-9]{3}-[0-3][0-9]-[0-3][0-9]$"% placeholder="<%= @today %>">
       </h4>
         <input type="submit" class="btn btn-primary" value="Get Data" style="width:200px">
     <form>
@@ -23,52 +22,120 @@
   <h3 class="section-divider">Sales</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div id="daily_revenue" onclick="fullscreen_graph(this)" style="text-align:center"><h4>Daily Sales</h4></div>
+      <h4 class="graph-heading">
+        Daily Sales
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:daily_revenue], library: {hAxis: {direction: -1}} %>
-      <div style="text-align:center"><h5>Total Sales: <%= @metrics[:total_revenue] %></h5></div>
-      <div style="text-align:center"><h5>Average Per Day: <%= @metrics[:average_revenue] %></h5></div>
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Duration</h5>
+          <h3 class="money"><%= days(@metrics[:duration]) %></h3>
+        </div>
+        <div class="graph-metric">
+          <h5 class="grey">Number of Sales</h5>
+          <h3 class="money"><%= @metrics[:number_of_sales] %></h3>
+        </div>
+        <div class="graph-metric">
+          <h5 class="grey">Total Revenue</h5> 
+          <h3 class="money"><%= display_as_currency @metrics[:total_revenue] %></h3>
+        </div>
+        <div class="graph-metric">
+          <h5 class="grey">Average Daily Revenue</h5>
+          <h3 class="money"><%= display_as_currency @metrics[:average_revenue] %></h3>
+        </div>
+          <div class="graph-metric">
+          <h5 class="grey">Max Daily Revenue</h5>
+          <h3 class="money"><%= display_as_currency @metrics[:max_daily_revenue] %></h3>
+        </div>
+      </div>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Proportion of Sales per Product</h4></div>
-      <%= pie_chart @metrics[:products] %>
+      <h4 class="graph-heading">
+        Proportion of Sales per Product
+      </h4>
+      <hr class="graph-seperator">
+      <%= pie_chart @metrics[:sales_per_product] %>
     </div>
 
     <div class="graph-border">
-      <div style="text-align:center"><h4>Number of Sales per Product</h4></div>
-      <%= column_chart @metrics[:products] %>
+      <h4 class="graph-heading">
+        Number of Sales per Product
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:sales_per_product] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Revenue per Product</h4></div>
+      <h4 class="graph-heading">
+        Revenue per Product
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_product] %>
     </div>
   </div>
 
   
-  <h3 class="section-divider">Prices</h3>
+  <h3 class="section-divider">Prices &amp; Discounts</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div style="text-align:center"><h4>Proportion of Items Sold Per Price Point</h4></div>
-      <%= pie_chart @metrics[:prices] %>
+      <h4 class="graph-heading">
+        Proportion of Items Sold Per Price Point
+      </h4>
+      <hr class="graph-seperator">
+      <%= pie_chart @metrics[:sales_per_price] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Number of Items Sold Per Price Point</h4></div>
-      <%= column_chart @metrics[:prices] %>
+      <h4 class="graph-heading">
+        Number of Items Sold Per Price Point
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:sales_per_price] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Revenue per Price Point</h4></div>
+      <h4 class="graph-heading">
+        Revenue per Price Point
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_price_point] %>
     </div>
+
+    <div class="graph-border">
+      <h4 class="graph-heading">
+        Total Savings per Discount Code
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:discount_savings] %>
+    </div>
+
+    <div class="graph-border">
+      <h4 class="graph-heading">
+        Number of Uses per Discount Code
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:discount_quantity] %>
+    </div>
   </div>
 
 
   <h3 class="section-divider">Countries</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div style="text-align:center"><h4>Proportion of Sales per Country</h4></div>
+      <h4 class="graph-heading">
+        Proportion of Sales per Country
+      </h4>
+      <hr class="graph-seperator">
       <%= pie_chart @metrics[:sales_per_country] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Revenue per Country</h4></div>
+      <h4 class="graph-heading">
+        Revenue per Country
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_country], stacked: true %>
     </div>
   </div>
@@ -77,8 +144,11 @@
   <h3 class="section-divider">Currencies</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div style="text-align:center"><h4>Currencies Used per Purchase</h4></div>
-      <%= pie_chart @metrics[:currencies] %>
+      <h4 class="graph-heading">
+        Currencies Used per Purchase
+      </h4>
+      <hr class="graph-seperator">
+      <%= pie_chart @metrics[:currencies_per_sale] %>
     </div>
   </div>
 
@@ -86,8 +156,11 @@
   <h3 class="section-divider">Customers</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div style="text-align:center"><h4>Purchases per Customer</h4></div>
-      <%= column_chart @metrics[:customer_sales], stacked: true %>
+      <h4 class="graph-heading">
+        Purchases per Customer
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:sales_per_customer], stacked: true %>
     </div>
   </div>
 
@@ -95,23 +168,48 @@
   <h3 class="section-divider">Traffic Metrics</h3>
   <div class="graph-container">
     <div class="graph-border">
-      <div style="text-align:center"><h4>Referrals per Site</h4></div>
-      <%= column_chart @metrics[:referring_sites] %>
+      <h4 class="graph-heading">
+        Referrals per Site
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:referral_sites] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Referrals per Site Pages</h4></div>
-      <%= column_chart @metrics[:referring_pages] %>
+      <h4 class="graph-heading">
+        Referrals per Site Pages
+      </h4>
+      <hr class="graph-seperator">
+      <%= column_chart @metrics[:referral_pages] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Revenue Per Referral Site</h4></div>
+      <h4 class="graph-heading">
+        Revenue Per Referral Site
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_referral_site] %>
     </div>
+
     <div class="graph-border">
-      <div style="text-align:center"><h4>Revenue Per Referral Site Page</h4></div>
+      <h4 class="graph-heading">
+        Revenue Per Referral Site Page
+      </h4>
+      <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_referral_page] %>
     </div>
   </div>
 
+
+  <div style="margin-top:30px; margin-left:auto; margin-right:auto; text-align:center; color:#999">
+    Generated <%= Time.now %>
+  </div>
+
+  <script type="text/javascript">
+    window.onload = function(){ 
+      //document.getElementById("loading").style.display = "none" 
+    }
+  </script>
   <!--
   <div id="fullscreen-graph" style="z-index:10; margin-left:auto; margin-right:auto;"></div>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_dashboard_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jason Willems
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-24 00:00:00.000000000 Z
+date: 2015-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -147,7 +147,9 @@ files:
 - README.md
 - bin/shopify_dashboard_plus.rb
 - lib/shopify_dashboard_plus.rb
-- lib/version/shopify_dashboard_plus.rb
+- lib/shopify_dashboard_plus/helpers.rb
+- lib/shopify_dashboard_plus/report.rb
+- lib/shopify_dashboard_plus/version.rb
 - public/css/bootstrap.min.css
 - public/css/common.css
 - public/js/chartkick.min.js