eff_matomo 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0919a5f8c95ff41737d832f9055262230a4d377ad1ed4ff4d4c1549e6cd49021
-  data.tar.gz: bd14a94d8484777a0081de23e7366513f17aab67cd5a7bccab4726ee6b405a32
+  metadata.gz: a7acc3a74ee56d8a406372034ee391cbcdcea3b8b45906fc3f4766be453041a0
+  data.tar.gz: ce930d0b254878f3047e9b7467bb24420b33720f514a1a5c5f6c0cbacad7b074
 SHA512:
-  metadata.gz: 0adcbe9d7bf799fb9e11f0a7cb48d0d2ff7543a8b770dc96780082aebe76c8b3109518bfa9e5f1be382e87a0ad78b17715f527f8495b60cd070d881ad5ed2dbf
-  data.tar.gz: 6aa1698f1643997c1134933783fafa56faee12fedbeb0a7d2c0c0b09a18ce2f1757102f94801fbfd64706d7a5dc64b487ade41f13e51aa75d6711e393bcc75b2
+  metadata.gz: 5e4be46b925b9a2df0c7a252d8cbd07084343cdbc710e256c60f1139c694e2569fbbdd0fcdf8858061eea422fa252d714c05b599eb0c38d872a38fc09aa6be77
+  data.tar.gz: cbbe856f841c2afec25db810fed9400a9124bb77ea645026f2b3622e41a31e59e6bb20ed74607fffdbb9ca27da61842c2c5bb05d7fd2e10d03488a0a5a69d47f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eff_matomo (0.1.0)
+    eff_matomo (0.2.1)
       activesupport
       httparty
 
@@ -22,7 +22,7 @@ GEM
     hashdiff (0.3.7)
     httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    i18n (1.1.0)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     multi_xml (0.6.0)

data/README.md

@@ -7,7 +7,7 @@ The EFF Matomo gem provides utilities for integrating our Ruby applications with
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'eff_matomo'
+gem 'eff_matomo', require 'matomo'
 ```
 
 And then execute:
@@ -35,7 +35,7 @@ Add `<%= matomo_tracking_embed %>` to the footer of your application layout temp
 This gem provides allows users to import site usage data from Matomo to display in their application. It currently supports two types of data:
 
 **Referrers** show how users are reaching the application. Usage example:
-```
+```ruby
 # Get the top five referrers for the site
 referrers = Matomo::Referrer.top
 
@@ -45,18 +45,18 @@ referrers = Matomo::Referrer.where(start_date: Time.now - 1.month, end_date: Tim
 # Only show referrers for a certain page within the app
 referrers = Matomo::Referrer.where(path: "/action/my-important-action")
 
-# Access information about each referrers
+# Access information about each referrer
 referrers.each() do |referrer|
   puts referrer.label             # eg. "facebook.com"
   puts referrer.visits            # Number of times a visit came from this referrer
-  puts referrer.actions_per_visit # Average number of actions that occured during a visit
+  puts referrer.actions_per_visit # Average number of actions that occurred during a visit
 end
 ```
 
 **Visited Pages** show the top pages within the application, both in terms of unique page views and overall number of hits. Usage example:
-```
+```ruby
 # Get the top pages under a certain path, for example under "/articles"
-pages = Matomo::VisitedPage.where(base_path: "/articles")
+pages = Matomo::Page.under_path("/articles")
 
 # Access information about each page
 pages.each() do |page|
@@ -65,6 +65,11 @@ pages.each() do |page|
   puts page.hits # Overall number of hits on the page
   puts page.visits # The number of distinct visits to the page
 end
+
+# Get views for a certain page, grouped by day
+# Return format eg. { "2018-10-03": <Matomo::Page>, "2018-10-04": <Matomo::Page>, etc. }
+pages = Matomo::Page.group_by_day("/articles/harm-reduction",
+                                      start_date: Time.now - 1.month, end_date: Time.now)
 ```
 
 ## Development

data/lib/matomo.rb

@@ -34,32 +34,47 @@ module Matomo
     end
   end
 
-  class VisitedPage
-    attr_accessor :label, :hits, :visits
+  class Page
+    attr_accessor :hits, :visits, :path
 
-    def initialize(base_path, params)
-      @base_path = base_path
-      @label = params["label"].sub!(/^\//, "") if params["label"]
+    def initialize(path, params)
+      @path = path
+      @label = params["label"]
       @hits = params["nb_hits"]
       @visits = params["nb_visits"]
     end
 
-    def path
-      "/#{@base_path}/#{@label}"
+    def label
+      return nil unless @label
+      @label.sub(/^\//, "").sub(/\?.*$/, "")
     end
 
-    def self.where(**args)
+    def self.under_path(base_path, **args)
       get_subtables unless @subtables
       # Remove leading and trailing slashes to match Matomo label format.
-      base_path = args[:base_path].gsub(/^\/|\/$/, "")
+      base_path = base_path.gsub(/^\/|\/$/, "")
       return [] unless @subtables[base_path]
 
       resp = Matomo.get({
         method: "Actions.getPageUrls",
-        idSubtable: @subtables[base_path],
+        idSubtable: @subtables[base_path]
       })
       return [] if resp.response.code != "200"
-      resp.map{ |x| new(base_path, x) }
+      resp.map{ |x| new("/#{base_path}#{x["label"]}", x) }
+    end
+
+    ##
+    # Return format eg: { "2018-10-03": <Matomo::Page> }
+    def self.group_by_day(path, **args)
+      params = {
+        method: "Actions.getPageUrls",
+        segment: "pageUrl==#{Matomo.tracked_site_url}#{path}",
+        period: "day"
+      }.merge(Matomo.date_range_params(args[:start_date], args[:end_date]))
+
+      resp = Matomo.get(params)
+      return {} if resp.response.code != "200"
+      resp.transform_values{ |v| new(path, v.first || {}) }
     end
 
     def self.get_subtables
@@ -135,7 +150,6 @@ module Matomo
     end_date = end_date || Date.today
     start_date = start_date || end_date - 30.days
     {
-      period: "range",
       date: start_date.strftime(date_format) + "," + end_date.strftime(date_format)
     }
   end

data/lib/matomo/version.rb

@@ -1,3 +1,3 @@
 module Matomo
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/matomo/view_helpers.rb

@@ -1,7 +1,7 @@
 module Matomo
   module ViewHelpers
     def matomo_tracking_url
-      "https://anon-stats.eff.org/js/?" + {
+      "#{Matomo.base_url}/js/?" + {
         idsite: Matomo.site_id,
         rec: 1,
         action_name: page_title,
@@ -13,7 +13,7 @@ module Matomo
       content_tag(:div, id: "anon-stats") do
         content_tag(:noscript) do
           content_tag(:img, src: matomo_tracking_url, style: "border:0", alt: "")
-        end
+        end +
         javascript_tag do
           "document.getElementById('anon-stats').innerHTML = '<img src=\"#{matomo_tracking_url}\"?urlref=' + encodeURIComponent(document.referrer) + 'style=\"border:0\" alt=\"\" />';".html_safe
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eff_matomo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - vivian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport