shopify_dashboard_plus 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f04778d9e66992f8c93809acf37f63d10d8902e
-  data.tar.gz: 7b4c66c846e7f039763ede2bc032048c3d429385
+  metadata.gz: 9fdfd548de3a3601bf7e6b95a270e47cf5ceaa27
+  data.tar.gz: a1d785b1ac756ff95eafd897167ae39ed0035429
 SHA512:
-  metadata.gz: 60b1b059c9e554cb51c0f0924e5d6c419ed37da972141c4998005137ce82d3e6fea528a57ede81d13905b9b1f352de57c860751711999977720e1725bdb8ec63
-  data.tar.gz: 8238bcb96f56b2b95b3326cb5f7383378179d147076c3a90206503ffda42c6587d12d4eda574ad57f0733f26a09823562dff1f327f2b1989dc9780e18da5a56d
+  metadata.gz: 2024bcd98be9ced7b9c41a68fdeecf114c0556d7f7a13b2d9dfbe8d39dea0e8bfa2565ef0da7c359332812b3a72d6cab3fbefc10bc9b3052aa4b8f5f204c8ec2
+  data.tar.gz: bd114f9ed38cc8ad8f71241835518977db22e486839db4f8ef38a031e64b1bceb94493c59b77ee058349e64af043267221c4bf91aaec6bbc7aee649829736bf5

data/README.md

@@ -1,4 +1,4 @@
-# Shopify_Dashboard_Plus[![Gem Version](https://badge.fury.io/rb/shopify_dashboard_plus.svg)](http://badge.fury.io/rb/shopify_dashboard_plus)
+# Shopify_Dashboard_Plus [![Gem Version](https://badge.fury.io/rb/shopify_dashboard_plus.svg)](http://badge.fury.io/rb/shopify_dashboard_plus)
 Pretty Dashboard for Shopify Admin with lots of graphs.
 
 ## Screenshots
@@ -43,12 +43,12 @@ Choose the interval over which to get data and see it displayed as:
   * `git clone https://github.com/at1as/Shopify_Dashboard_Plus.git`
 * To install using the gem: 
   * `gem install shopify_dashboard_plus`
-* For dependencies see: 
-  * `shopify_dashboard_plus.gemfile`
+  * `shopify_dashboard_plus.rb`
 * 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`
-
+  * `SHP_KEY="API KEY" SHP_PWD="PASSWORD" SHP_NAME="SHOP NAME" ./lib/shopify_dashboard_plus.rb`
+ 
 ## Notes
-* Tested and developed with Ruby 2.1.2 on Mac OS 10.10
-
+* Tested and developed with Ruby 2.0.0, 2.1.2, 2.2.0 on Mac OS 10.10
+* Tested against [Learning Photography](http://learning.photography)
+* Requires >= Ruby 2.0.0

data/lib/shopify_dashboard_plus/helpers.rb

@@ -49,8 +49,8 @@ module ApplicationHelpers
     DateTime.now.strftime('%Y-%m-%d')
   end
 
-  def days(num)
-    num.to_i == 1 ? "#{num} Day" : "#{num} Days"
+  def pluralize(num, singular, plural)
+    num.to_i == 1 ? "#{num} #{singular.capitalize}" : "#{num} #{plural.capitalize}"
   end
 
   def strip_protocol(page)
@@ -70,6 +70,10 @@ module ApplicationHelpers
 
   ## Metrics Helpers
 
+  def max_hash_key_exclude_value(unsorted_hash, exclude_value)
+    unsorted_hash.sort_by{ |k, v| v }.map{ |k, v| [k, v] unless k.downcase == exclude_value }.compact.last
+  end
+
   def display_as_currency(value)
     ShopifyAPI::Shop.current.money_with_currency_format.gsub("{{amount}}", value.to_s)
   rescue

data/lib/shopify_dashboard_plus/report.rb

@@ -69,9 +69,13 @@ module ShopifyDashboardPlus
     def to_h
       {
         :currencies_per_sale => currencies_per_sale,
+        :most_used_currency => currencies_per_sale.sort_by{ |k, v| v }.last,
         :sales_per_country => sales_per_country,
+        :most_sales_per_country => sales_per_country.sort_by{ |k, v| v }.last,
         :sales_per_price => sales_per_price_point,
+        :top_selling_price_point => sales_per_price_point.sort_by{ |k, v| v }.last,
         :sales_per_product => sales_per_product,
+        :top_selling_product => sales_per_product.sort_by{ |k, v| v }.last,
         :sales_per_customer => sales_per_customer,
         :number_of_sales => number_of_sales
       }
@@ -111,7 +115,9 @@ module ShopifyDashboardPlus
       {
         :revenue_per_country => revenue_per_country,
         :revenue_per_product => revenue_per_product,
+        :top_grossing_product => revenue_per_product.sort_by{ |k, v| v }.last,
         :revenue_per_price_point => revenue_per_price_point,
+        :top_grossing_price_point => revenue_per_price_point.sort_by{ |k, v| v}.last
       }
     end
   end
@@ -132,7 +138,9 @@ module ShopifyDashboardPlus
       end
       {
         :discount_savings => discount_value,
-        :discount_quantity => discount_used
+        :top_discount_savings => discount_value.sort_by{ |k, v| v }.last,
+        :discount_quantity => discount_used,
+        :most_used_discount_code => discount_used.sort_by{ |k, v| v }.last
       }
     end
 
@@ -159,8 +167,10 @@ module ShopifyDashboardPlus
         end
       end
       {
-        :referral_sites => (referring_sites.sort().to_h rescue {}),
-        :referral_pages => (referring_pages.sort().to_h rescue {})
+        :referral_sites => referring_sites.sort().to_h,
+        :top_referral_site => max_hash_key_exclude_value(referring_sites, 'none'),
+        :referral_pages => referring_pages.sort().to_h,
+        :top_referral_page => max_hash_key_exclude_value(referring_pages, 'none')
       }
     end
 
@@ -181,8 +191,10 @@ module ShopifyDashboardPlus
         end
       end
       {
-        :revenue_per_referral_site => (revenue_per_referral_site.sort().to_h rescue {}),
-        :revenue_per_referral_page => (revenue_per_referral_page.sort().to_h rescue {})
+        :revenue_per_referral_site => revenue_per_referral_site.sort().to_h,
+        :top_referral_site_revenue => max_hash_key_exclude_value(revenue_per_referral_site, 'none'),
+        :revenue_per_referral_page => revenue_per_referral_page.sort().to_h,
+        :top_referral_page_revenue => max_hash_key_exclude_value(revenue_per_referral_page, 'none')
       }
     end
 

data/lib/shopify_dashboard_plus/version.rb

@@ -1,3 +1,3 @@
 module ShopifyDashboardPlus
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/public/css/common.css

@@ -62,6 +62,10 @@ h4.graph-heading{
 	font-weight:400;
 	font-size:22px;
 }
+h4.stats{
+	font-weight:300;
+	color:#337ab7;
+}
 .flash{
 	color:red;
 }

data/views/report.erb

@@ -27,10 +27,11 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:daily_revenue], library: {hAxis: {direction: -1}} %>
+      <hr class="graph-seperator">
       <div class="graph-metrics">
         <div class="graph-metric">
           <h5 class="grey">Duration</h5>
-          <h3 class="money"><%= days(@metrics[:duration]) %></h3>
+          <h3 class="money"><%= pluralize @metrics[:duration], "day", "days" %></h3>
         </div>
         <div class="graph-metric">
           <h5 class="grey">Number of Sales</h5>
@@ -65,6 +66,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:sales_per_product] %>
+      <% if @metrics[:top_selling_product] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Best Selling Product</h5>
+          <h4 class="stats"><%= @metrics[:top_selling_product][0] %> : <b><%= pluralize @metrics[:top_selling_product][1], "Sale", "Sales" %></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -73,6 +83,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_product] %>
+      <% if @metrics[:top_grossing_product] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Most Profitable Product</h5>
+          <h4 class="stats"><%= @metrics[:top_grossing_product][0] %> : <b><%= display_as_currency @metrics[:top_grossing_product][1] %></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
   </div>
 
@@ -93,6 +112,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:sales_per_price] %>
+      <% if @metrics[:top_selling_price_point] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Top Selling Price Point</h5>
+          <h4 class="stats"><b><%= @metrics[:top_selling_price_point][0] %></b> : <%= pluralize @metrics[:top_selling_price_point][1], "Sale", "Sales" %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -101,6 +129,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_price_point] %>
+      <% if @metrics[:top_grossing_price_point] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Top Grossing Price Point</h5>
+          <h4 class="stats"><b><%= @metrics[:top_grossing_price_point][0] %></b> : <%= display_as_currency @metrics[:top_grossing_price_point][1] %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -109,6 +146,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:discount_savings] %>
+      <% if @metrics[:top_discount_savings] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Greatest Value Redeemed per Discount Code</h5>
+          <h4 class="stats"><%= @metrics[:top_discount_savings][0] %> : <b><%= display_as_currency @metrics[:top_discount_savings][1] %></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -117,6 +163,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:discount_quantity] %>
+      <% if @metrics[:most_used_discount_code] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Most Used Discount Code</h5>
+          <h4 class="stats"><%= @metrics[:most_used_discount_code][0] %> : <b><%= pluralize @metrics[:most_used_discount_code][1], "Time", "Times" %></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
   </div>
 
@@ -129,6 +184,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= pie_chart @metrics[:sales_per_country] %>
+      <% if @metrics[:most_sales_per_country] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Most Sales Per Country</h5>
+          <h4 class="stats"><%= @metrics[:most_sales_per_country][0] %> : <b><%= pluralize @metrics[:most_sales_per_country][1], "Time", "Times"%></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -149,6 +213,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= pie_chart @metrics[:currencies_per_sale] %>
+      <% if @metrics[:most_used_currency] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Most Used Currency</h5>
+          <h4 class="stats"><%= @metrics[:most_used_currency][0] %> : <b><%= pluralize @metrics[:most_used_currency][1], "Time", "Times" %></b></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
   </div>
 
@@ -173,6 +246,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:referral_sites] %>
+      <% if @metrics[:top_referral_site] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Top Referral Site</h5>
+          <h4 class="stats"><b><%= @metrics[:top_referral_site][0] %></b> : <%= pluralize @metrics[:top_referral_site][1], "Referral", "Referrals" %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -181,6 +263,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:referral_pages] %>
+      <% if @metrics[:top_referral_page] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Top Referral Page</h5>
+          <h4 class="stats"><b><%= @metrics[:top_referral_page][0] %></b> : <%= pluralize @metrics[:top_referral_page][1], "Referral", "Referrals" %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -189,6 +280,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_referral_site] %>
+      <% if @metrics[:top_referral_site_revenue] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Highest Revenue per Referral Site</h5>
+          <h4 class="stats"><b><%= @metrics[:top_referral_site_revenue][0] %></b> : <%= display_as_currency @metrics[:top_referral_site_revenue][1] %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
 
     <div class="graph-border">
@@ -197,6 +297,15 @@
       </h4>
       <hr class="graph-seperator">
       <%= column_chart @metrics[:revenue_per_referral_page] %>
+      <% if @metrics[:top_referral_page_revenue] %>
+      <hr class="graph-seperator">
+      <div class="graph-metrics">
+        <div class="graph-metric">
+          <h5 class="grey">Highest Revenue per Referral Page</h5>
+          <h4 class="stats"><b><%= @metrics[:top_referral_page_revenue][0] %></b> : <%= display_as_currency @metrics[:top_referral_page_revenue][1] %></h4>
+        </div>
+      </div>
+      <% end %>
     </div>
   </div>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_dashboard_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Jason Willems
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-02 00:00:00.000000000 Z
+date: 2015-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra