shopify_dashboard_plus 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fdfd548de3a3601bf7e6b95a270e47cf5ceaa27
-  data.tar.gz: a1d785b1ac756ff95eafd897167ae39ed0035429
+  metadata.gz: 368458584f187d4a84965649cdef6626a22b9d2b
+  data.tar.gz: b5bee8a64a3565bd2ba4cc647a0c448616ef9cf1
 SHA512:
-  metadata.gz: 2024bcd98be9ced7b9c41a68fdeecf114c0556d7f7a13b2d9dfbe8d39dea0e8bfa2565ef0da7c359332812b3a72d6cab3fbefc10bc9b3052aa4b8f5f204c8ec2
-  data.tar.gz: bd114f9ed38cc8ad8f71241835518977db22e486839db4f8ef38a031e64b1bceb94493c59b77ee058349e64af043267221c4bf91aaec6bbc7aee649829736bf5
+  metadata.gz: '06321384b8a0c88ed08f3acaeef748686720b36ba00edbc7642769ad290ad0a895e494644bc5e05be684d3ab8d4d3556c94ee1c94898a479e8352c7ed57d8575'
+  data.tar.gz: 607ea7132f9ba3252c153105d574687951949a71e2fa5b265771f64365436eb53d1241fc0f6b33e8af32544f37969d69a4e0c82e0200a673b498594ebaeb768a

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - Gemfile
+    - shopify_dashboard_plus.gemspec
+
+Metrics/LineLength:
+  Exclude:
+    - test/**/*
+  Max: 120
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+script: bundle exec xvfb-run rake

data/Gemfile.lock

@@ -1,58 +1,122 @@
 PATH
   remote: .
   specs:
-    shopify_dashboard_plus (0.0.1)
-      chartkick (~> 1.3, >= 1.3.2)
-      shopify_api (~> 4.0, >= 4.0.3)
-      sinatra (~> 1.4, >= 1.4.5)
-      tilt
+    shopify_dashboard_plus (1.0.0)
+      chartkick (~> 2.3)
+      shopify_api (= 4.9.1)
+      sinatra (~> 2.0)
       vegas (~> 0.1, >= 0.1.11)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.1)
-      activesupport (= 4.2.1)
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
       builder (~> 3.1)
-    activeresource (4.0.0)
-      activemodel (~> 4.0)
-      activesupport (~> 4.0)
-      rails-observers (~> 0.1.1)
-    activesupport (4.2.1)
+    activeresource (5.0.0)
+      activemodel (>= 5.0, < 6)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 5.0, < 6)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    builder (3.2.2)
-    chartkick (1.3.2)
-    i18n (0.7.0)
-    json (1.8.2)
-    minitest (5.6.1)
-    rack (1.6.1)
-    rack-protection (1.5.3)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (10.0.0)
+    capybara (2.18.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (>= 2.0, < 4.0)
+    capybara-webkit (1.15.0)
+      capybara (>= 2.3, < 4.0)
+      json
+    chartkick (2.3.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    hashdiff (0.3.7)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    mustermann (1.0.2)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    parallel (1.12.1)
+    parser (2.5.0.3)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    public_suffix (3.0.2)
+    rack (2.0.4)
+    rack-protection (2.0.1)
       rack
-    rails-observers (0.1.2)
-      activemodel (~> 4.0)
-    rake (10.4.2)
-    shopify_api (4.0.3)
-      activeresource
+    rack-test (0.8.3)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (12.3.0)
+    rubocop (0.53.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    safe_yaml (1.0.4)
+    shopify_api (4.9.1)
+      activeresource (>= 3.0.0)
       rack
-    sinatra (1.4.6)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    thread_safe (0.3.5)
-    tilt (2.0.1)
-    tzinfo (1.2.2)
+    sinatra (2.0.1)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.1)
+      tilt (~> 2.0)
+    thread_safe (0.3.6)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.3.0)
+    vcr (3.0.3)
     vegas (0.1.11)
       rack (>= 1.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    xpath (3.0.0)
+      nokogiri (~> 1.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
-  rake (~> 10.0)
+  bundler (~> 1.16)
+  byebug (~> 10.0)
+  capybara (~> 2.18)
+  capybara-webkit (~> 1.15)
+  faker (~> 1.8)
+  minitest (~> 5.11)
+  rack-test (~> 0.8)
+  rake (~> 12.3)
+  rubocop (~> 0.53.0)
   shopify_dashboard_plus!
+  tilt (~> 2.0)
+  vcr (~> 3.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

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) [![Build Status](https://travis-ci.org/at1as/Shopify_Dashboard_Plus.svg?branch=master)](https://travis-ci.org/at1as/Shopify_Dashboard_Plus) <a href="https://codeclimate.com/github/at1as/Shopify_Dashboard_Plus"><img src="https://codeclimate.com/github/at1as/Shopify_Dashboard_Plus/badges/gpa.svg" /></a>
 Pretty Dashboard for Shopify Admin with lots of graphs.
 
 ## Screenshots
@@ -38,17 +38,26 @@ Choose the interval over which to get data and see it displayed as:
 * Revenue Per Referral Site
 * Revenue Per Specific Referral Site Page
 
-## Usage
+## Installation
 * To install manually: 
   * `git clone https://github.com/at1as/Shopify_Dashboard_Plus.git`
 * To install using the gem: 
   * `gem install shopify_dashboard_plus`
-  * `shopify_dashboard_plus.rb`
+* Or, if you just want to try it out, head over to [Heroku](https://shopifydashboardplus.herokuapp.com/)
+  * Generally it's unwise to pass your API key & password through some hosted website. The code run on Heroku is taken automatically from this repo and you can check the source to see that the keys aren't being saved, but if you're in doubt, either create new credentials for this app and then revoke them after you're finished, or just install run locally with either option listed above instead.
+
+## Usage
 * 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="API KEY" SHP_PWD="PASSWORD" SHP_NAME="SHOP NAME" ./lib/shopify_dashboard_plus.rb`
+* Run with environment variables
+  * `SHP_KEY="API KEY" SHP_PWD="PASSWORD" SHP_NAME="SHOP NAME" ./lib/shopify_dashboard_plus.rb` [manual installation]
+  * `SHP_KEY="API KEY" SHP_PWD="PASSWORD" SHP_NAME="SHOP NAME" shopify_dashboard_plus.rb` [Gem]
+* Run without environment variables (and pass these later thorugh the UI)
+  * `./lib/shopify_dashboard_plus.rb`
+  * `shopify_dashboard_plus.rb`
  
 ## Notes
-* Tested and developed with Ruby 2.0.0, 2.1.2, 2.2.0 on Mac OS 10.10
+* Tested with:
+  * Ruby 2.3.6, 2.4.3, 2.5.0 on Mac OS 10.10 (Locally)
+  * Ruby 2.3.6, 2.4.3, 2.5.0 on Ubuntu Linux (TravisCI)
+* Support for unmaintained versions of Ruby have been dropped. This gem requires >= Ruby 2.3.0
 * Tested against [Learning Photography](http://learning.photography)
-* Requires >= Ruby 2.0.0

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+desc "Run all tests..."
+task :default => :test

data/bin/shopify_dashboard_plus.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require File.expand_path('../../lib/shopify_dashboard_plus.rb', __FILE__)
 require 'vegas'
 
 Vegas::Runner.new(Sinatra::Application, 'shopify_dashboard_plus')
-

data/config.ru

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require './lib/shopify_dashboard_plus.rb'
+run Sinatra::Application

data/lib/shopify_dashboard_plus.rb

@@ -1,96 +1,81 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'sinatra'
-require 'tilt/erubis'
+require 'tilt/erb'
 require 'shopify_api'
 require 'uri'
 require 'chartkick'
+require_relative 'shopify_dashboard_plus/currency'
 require_relative 'shopify_dashboard_plus/helpers'
-require_relative 'shopify_dashboard_plus/report'
+require_relative 'shopify_dashboard_plus/discount_report'
+require_relative 'shopify_dashboard_plus/revenue_report'
+require_relative 'shopify_dashboard_plus/sales_report'
+require_relative 'shopify_dashboard_plus/traffic_report'
 require_relative 'shopify_dashboard_plus/version'
 
-configure do
-  set :public_dir, "#{__dir__}/../public"
-  set :views, "#{__dir__}/../views"
 
-  $connected ||= false
-  $metrics ||= false
-  $flash ||= nil
+HELP = <<-USAGE
+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
+USAGE
+
 
-  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
+configure do
+  enable :sessions
+  
+  set :public_dir, Proc.new { File.join(root, "../public") }
+  set :views, Proc.new { File.join(root, "../views") }
+  
+  $connected ||= false
+  $flash     ||= nil
 
-  # If Environment variables were set connect to Shopify Admin immediately
+  # 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"]
+    API_KEY   = ENV["SHP_KEY"]
+    PASSWORD  = ENV["SHP_PWD"]
     SHOP_NAME = ENV["SHP_NAME"]
     
     begin
-      shop_url = "https://#{API_KEY}:#{PASSWORD}@#{SHOP_NAME}.myshopify.com/admin"
-      ShopifyAPI::Base.site = shop_url
+      ShopifyAPI::Base.site = "https://#{API_KEY}:#{PASSWORD}@#{SHOP_NAME}.myshopify.com/admin"
       shop = ShopifyAPI::Shop.current
+      
       $shop_name = SHOP_NAME
+      $currency  = shop.money_with_currency_format
       $connected = true
-    rescue Exception => e
-      puts "\nFailed to connect using provided credentials...(Exception: #{e})\n #{HELP}"
+    rescue URI::InvalidURIError, ActiveResource::ResourceNotFound => e
+      puts "\nFailed to connect using provided credentials for API KEY #{API_KEY} : #{e})\n #{HELP}"
       exit
     end
   end
-
-  
-  # 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
-  end
-
-  class Float
-    def plus(amount)
-      result = self + (amount.to_f rescue 0)
-      result.round(2)
-    end
-  end
-
-  # For < Ruby 2.1 Compatability
-  class Array
-    def to_h
-      Hash[*self.flatten]
-    end
-  end
 end
 
 helpers ApplicationHelpers
 
 
 before do
-  $flash = nil
-  $metrics = false
+  $flash   = ''
+  @metrics = false
 end
 
 
 get '/' do
-  redirect '/connect' unless connected?
+  redirect '/connect' unless connected? && authenticated?
 
   # 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
+  from   = (params[:from] unless params[:from].empty? rescue nil) || (params[:to] unless params[:to].empty? rescue nil) || @today
+  to     = (params[:to] unless params[:to].empty? rescue nil) || @today
 
   to = @today if to > @today
 
   if date_range_valid?(from, to)
     @metrics = get_detailed_revenue_metrics(from, to)
-    $metrics = true
   else
     $flash = "Invalid Dates. Please use format YYYY-MM-DD"
   end
@@ -114,7 +99,9 @@ post '/connect' do
 end
 
 post '/disconnect' do
-  API_KEY, API_PWD, SHP_NAME = "", "", ""
+  API_KEY  = ''
+  API_PWD  = ''
+  SHP_NAME = ''
   close_connection
 
   erb :connect
@@ -129,3 +116,4 @@ after '/quit' do
   puts "\nExiting..."
   exit!
 end
+

data/lib/shopify_dashboard_plus/currency.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# 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
+# Note that Numbers are class Fixnum in Ruby < 2.4 and Integer from 2.4 onwards
+module Currency
+  if 0.class.to_s == "Fixnum"
+    refine Fixnum do
+      def plus(amount)
+        result = self + (amount.to_f rescue 0)
+        result.round(2)
+      end
+    end
+  else
+    refine Integer do
+      def plus(amount)
+        result = self + (amount.to_f rescue 0)
+        result.round(2)
+      end
+    end
+  end
+
+  refine Float do
+    def plus(amount)
+      result = self + (amount.to_f rescue 0)
+      result.round(2)
+    end
+  end
+end

data/lib/shopify_dashboard_plus/discount_report.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'currency'
+require_relative 'helpers'
+require_relative 'report'
+
+module ShopifyDashboardPlus
+  class DiscountReport < Report
+    using Currency
+
+    def discount_usage
+      discount_value = Hash.new(0.0)
+      discount_used  = Hash.new(0)
+
+      @orders.each do |order|
+        next unless 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
+      
+      {
+        :discount_savings => discount_value,
+        :top_discount_savings => discount_value.sort_by { |_, v| v }.last,
+        :discount_quantity => discount_used,
+        :most_used_discount_code => discount_used.sort_by { |_, v| v }.last
+      }
+    end
+
+    def to_h
+      discount_usage
+    end
+  end
+end