shopify_dashboard_plus 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9139b59933b6f2262aba299e495cc9d904f0440
-  data.tar.gz: f1591d0a5b5bfb257717c42f6e5cb1a5f535ad1e
+  metadata.gz: 5eec23dd7be2f6961002521056ee0b78c7b16f47
+  data.tar.gz: 9476b25596ca4545fe7700488a54322210408195
 SHA512:
-  metadata.gz: f72d5fa774c17603b524e52616ded3b59b06abbff5d075437496836f1b6bae310f138258b6cbd349e1ed7b9efe425be4e1cf39e659b57b2a4d22955e9f7daf70
-  data.tar.gz: d5bcded1fd4a0c8a3165083d1c6ba3ec3a15b964b88f955246f851beccdab81374d353d635162c5c52de1821852568c31f89c1f61176c7435642ceff7d589d49
+  metadata.gz: cd5f93de262d3d3a86f49c12d3d8800e6d398372188b6e565d9f6fbbb2ff65185b9dc61a2cb25726b77b1b036ca12106497d174aed3396d48ae1e849bffce3c0
+  data.tar.gz: 8b1526903f8805beaecbb761dae82156c4eecd9fc200950488e7bc74ae2f96cf6448dc05e2bfb703d6cd5299f23e5dc70bebf4adcb95cf83191f32f116e5a660

data/README.md

@@ -1,22 +1,13 @@
-# 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.
 
-## Usage
-* `git clone https://github.com/at1as/Shopify-Dashboard-Plus.git`
-* See `shopify-dashboard-plus.gemfile` for dependencies: shopify_api, sinatra, and chartkick
-* Assign RWX permissions on `lib/shopify-dashboard-plus.rb`
-* Retrieve `Key, Password and Shop Name for your store from Shopify Admin
-* `SHP_KEY="my_key" SHP_PWD="my_password" SHP_NAME="my_shop" ./lib/shopify-dashboard-plus.rb`
+## Screenshots
+
+![screenshot](https://github.com/at1as/at1as.github.io/blob/master/github_repo_assets/dashboard-plus1.jpg)
 
 ## Metrics
 Choose the interval over which to get data and see it displayed as:
 
-*Currency*
-* Currencies Used per Purchase
-
-*Countries*
-* Proportion of Sales per Country
-
 *Sales*
 * Daily Sales
 * Total Sales
@@ -30,6 +21,12 @@ Choose the interval over which to get data and see it displayed as:
 * Number of Items Sold Per Price Point
 * Revenue per Price Point
 
+*Countries*
+* Proportion of Sales per Country
+
+*Currency*
+* Currencies Used per Purchase
+
 *Customers*
 * Purchases per Customer
 
@@ -39,6 +36,19 @@ Choose the interval over which to get data and see it displayed as:
 * Revenue Per Referral Site
 * Revenue Per Specific Referral Site Page
 
-## Screenshots
-
-* ![screenshot](https://github.com/at1as/at1as.github.io/blob/master/github_repo_assets/dashboard-plus1.jpg)
+## Usage
+* To install manually: 
+  * `git clone https://github.com/at1as/Shopify_Dashboard_Plus.git`
+* To install via 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
+
+* Not all floats render with a two-digit precision
+* Limited to 250 results

data/lib/shopify_dashboard_plus.rb

@@ -11,6 +11,8 @@ configure do
   set :views, File.expand_path('../../views', __FILE__)
 
   $connected ||= false
+  $flash ||= nil
+  $metrics ||= false
 
   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"
@@ -39,7 +41,8 @@ helpers do
   include Rack::Utils
   alias_method :h, :escape_html
 
-  # Connection & Setup Helpers
+  ## Connection & Setup Helpers
+  # Bind to Shopify Store
   def set_connection(key, pwd, name)
     begin
       shop_url = "https://#{key}:#{pwd}@#{name}.myshopify.com/admin"
@@ -69,7 +72,7 @@ helpers do
   end
 
 
-  # Generic Helpers
+  ## Generic Helpers
   def hash_to_list(unprocessed_hash)
     return_list = []
     unprocessed_hash.each do |key, value|
@@ -81,8 +84,24 @@ helpers do
     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
 
-  # Metrics Helpers
+    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
@@ -212,17 +231,24 @@ helpers do
         else
           host = URI(order.referring_site).host.downcase
           host = host.start_with?('www.') ? host[4..-1] : host
-          referring_pages[order.referring_site] += 1
+          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
-            revenue_per_referral_site['None'] += line_item.price.to_f
+            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
-            revenue_per_referral_page[order.referring_site] += line_item.price.to_f
-            revenue_per_referral_site[host] += line_item.price.to_f
+            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
@@ -230,8 +256,8 @@ helpers do
       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
-        revenue_per_product[line_item.title] += line_item.price.to_f
+        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]})
@@ -262,6 +288,11 @@ helpers do
   end
 end
 
+before do
+  $flash = nil
+  $metrics = false
+end
+
 
 get '/' do
   redirect '/connect' unless connected?
@@ -273,7 +304,12 @@ get '/' do
   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
 
-  @metrics = get_detailed_revenue_metrics(from, to)
+  if validate_date_range(from, to)
+    @metrics = get_detailed_revenue_metrics(from, to)
+    $metrics = true
+  else
+    $flash = "Invalid Dates. Please use format YYYY-MM-DD"
+  end
   
   erb :report
 end
@@ -288,6 +324,7 @@ post '/connect' do
   if connected?
     redirect '/'
   else
+    $flash = "Failed to Connect..."
     erb :connect
   end
 end
@@ -308,4 +345,3 @@ after '/quit' do
   puts "\nExiting..."
   exit!
 end
-

data/public/css/common.css

@@ -25,6 +25,9 @@ h3.section-divider{
   padding-top: 5px;
   text-align: center;
 }
+.flash{
+	color:red;
+}
 
 /*
 // NOTE: media queries not working will chartkick, 

data/shopify_dashboard_plus.gemspec

@@ -8,7 +8,7 @@ require 'date'
 Gem::Specification.new do |spec|
   spec.name          = "shopify_dashboard_plus"
   spec.date          = Date.today.to_s
-  spec.version       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Jason Willems"]
   spec.email         = ["jason@willems.ca"]
   spec.summary       = "Extended dashboard for shopify admin"

data/views/connect.erb

@@ -2,6 +2,7 @@
   <h2 style="margin-top:10px; margin-bottom:20px">Connect to your Shopify Admin</h2>
   <hr>
   <% if not connected? %>
+    <% if $flash %><p class="flash"><%= $flash %><% end %>
     <form class="form-inline" id="connect" method="post" action="/connect">
       <div class="form-group">
         <input id="api_key" name="api_key" class="form-control form-field-small" value="<%= h(params[:api_key]) %>" pattern="^[0-9a-z]*$" placeholder="API_KEY">
@@ -9,21 +10,23 @@
         <input id="shop_name" name="shop_name" class="form-control form-field-small" value="<%= h(params[:shop_name]) %>" pattern="^[0-9a-z]*$" placeholder="SHOP NAME">
       </div>
       <div class="form-group" style="margin-top:20px">
-        <input type="submit" class="btn btn-primary" value="Set Connection">
+        <input type="submit" class="btn btn-primary" style="width:200px" value="Set Connection">
       </div>
     </form>
   <% else %>
     <form class="form-inline" id="connect" method="post" action="/disconnect">
-      Currently connected as <%= shop_name %><br/>
-      <a href="/">Back to Metrics</a>
+      Currently connected as <b><%= shop_name %></b><br/>
+      <div style="margin-top:10px">
+        <a href="/">Back to Metrics</a>
+      </div>
       <div class="form-group" style="display:block; margin-top:20px">
-        <input type="submit" class="btn btn-primary" value="Disconnect">
+        <input type="submit" class="btn btn-primary" style="width:200px" value="Disconnect">
       </div>
     </form>
   <% end %>
   <form class="form-inline" id="connect" method="post" action="/quit">
     <div class="form-group" style="display:block; margin-top:20px">
-      <input type="submit" class="btn btn-primary" value="Quit Application">
+      <input type="submit" class="btn btn-primary" style="width:200px" value="Quit Application">
     </div>
   </form>
 </div>

data/views/report.erb

@@ -2,21 +2,24 @@
   <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>
-    <div style="margin-bottom:10px;">
-      Retrieve metrics over the following period <% if shop_name %>for: <br/><i><%= shop_name %>.myshopify.com/admin</i><% end %>
+    <% 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>
+      <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 %>">
         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 type="submit" class="btn btn-primary" value="Get Data">
       </h4>
+        <input type="submit" class="btn btn-primary" value="Get Data" style="width:200px">
     <form>
-    <a href="/connect">Application Configuration</a>
+    <div style="margin-top:10px">
+      <a href="/connect">Application Configuration</a>
+    </div>
   </div>
 
-
+  <% if $metrics %>
   <h3 class="section-divider">Sales</h3>
   <div class="graph-container">
     <div class="graph-border">
@@ -125,6 +128,6 @@
     }
   </script>
   -->
-
+  <% end %>
 </div>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_dashboard_plus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Jason Willems