hyrax 3.2.0 → 3.3.0

data/app/services/hyrax/analytics/google/visits.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Hyrax
+  module Analytics
+    module Google
+      module Visits
+        extend Legato::Model
+
+        dimensions :user_type
+        metrics :sessions
+
+        def self.results_array(response)
+          results = []
+          response.to_a.each do |result|
+            results.push([result.date.to_date, result.result.sessions.to_i])
+          end
+          Hyrax::Analytics::Results.new(results)
+        end
+
+        def self.new_visits(profile, start_date, end_date)
+          x = Visits.results(profile,
+            start_date: start_date,
+            end_date: end_date).to_a
+          x.first.sessions.to_i
+        end
+
+        def self.return_visits(profile, start_date, end_date)
+          x = Visits.results(profile,
+            start_date: start_date,
+            end_date: end_date).to_a
+          x.last.sessions.to_i
+        end
+
+        def self.total_visits(profile, start_date, end_date)
+          x = Visits.results(profile,
+            start_date: start_date,
+            end_date: end_date).to_a
+          new_visits = x.first.sessions.to_i
+          returning_visits = x.last.sessions.to_i
+          new_visits + returning_visits
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/analytics/google/visits_daily.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module Hyrax
+  module Analytics
+    module Google
+      module VisitsDaily
+        extend Legato::Model
+
+        dimensions :date, :user_type
+        metrics :sessions
+
+        filter(:returning) { |_user_type| matches(:userType, 'Returning Visitor') }
+        filter(:new_visit) { |_user_type| matches(:userType, 'New Visitor') }
+
+        def self.new_visits(profile, start_date, end_date)
+          response = VisitsDaily.results(profile,
+            start_date: start_date,
+            end_date: end_date).new_visit.to_a
+          dates = (start_date.to_date...end_date.to_date)
+          results_array(response, dates)
+        end
+
+        def self.return_visits(profile, start_date, end_date)
+          response = VisitsDaily.results(profile,
+            start_date: start_date,
+            end_date: end_date).returning.to_a
+          dates = (start_date.to_date...end_date.to_date)
+          results_array(response, dates)
+        end
+
+        def self.results_array(response, dates)
+          results = []
+          response.to_a.each do |result|
+            results.push([result.date.to_date, result.sessions.to_i])
+          end
+          new_results = []
+          dates.each do |date|
+            match = results.detect { |a, _b| a == date }
+            if match
+              new_results.push(match)
+            else
+              new_results.push([date, 0])
+            end
+          end
+          Hyrax::Analytics::Results.new(new_results)
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/analytics/google.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+require 'oauth2'
+require 'signet/oauth_2/client'
+
+# rubocop:disable Metrics/ModuleLength
+module Hyrax
+  module Analytics
+    module Google
+      extend ActiveSupport::Concern
+      # rubocop:disable Metrics/BlockLength
+      class_methods do
+        # Loads configuration options from config/analytics.yml. Expected structure:
+        # `analytics:`
+        # `  google:`
+        # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
+        # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
+        # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
+        # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
+        # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
+        # @return [Config]
+        def config
+          @config ||= Config.load_from_yaml
+        end
+
+        class Config
+          def self.load_from_yaml
+            filename = Rails.root.join('config', 'analytics.yml')
+            yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
+            unless yaml
+              Rails.logger.error("Unable to fetch any keys from #{filename}.")
+              return new({})
+            end
+            config = yaml.fetch('analytics')&.fetch('google', nil)
+            unless config
+              Deprecation.warn("Deprecated analytics configuration format found. Please update config/analytics.yml.")
+              config = yaml.fetch('analytics')
+              # this has to exist here with a placeholder so it can be set in the Hyrax initializer
+              # it is only for backward compatibility
+              config['analytics_id'] = '-'
+            end
+            new config
+          end
+
+          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
+
+          def initialize(config)
+            @config = config
+          end
+
+          # @return [Boolean] are all the required values present?
+          def valid?
+            config_keys = @config.keys
+            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
+          end
+
+          REQUIRED_KEYS.each do |key|
+            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
+          end
+
+          # This method allows setting the analytics id in the initializer
+          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
+          def analytics_id=(value)
+            @config['analytics_id'] = value
+          end
+        end
+
+        # Generate an OAuth2 token for Google Analytics
+        # @return [OAuth2::AccessToken] An OAuth2 access token for GA
+        def token(scope = 'https://www.googleapis.com/auth/analytics.readonly')
+          access_token = auth_client(scope).fetch_access_token!
+          OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
+        end
+
+        def oauth_client
+          OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+                                     token_url: 'https://accounts.google.com/o/oauth2/token')
+        end
+
+        def auth_client(scope)
+          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
+          private_key = File.read(config.privkey_path)
+          Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
+                                     audience: 'https://accounts.google.com/o/oauth2/token',
+                                     scope: scope,
+                                     issuer: config.client_email,
+                                     signing_key: OpenSSL::PKCS12.new(private_key, config.privkey_secret).key,
+                                     sub: config.client_email
+        end
+
+        # Return a user object linked to a Google Analytics account
+        # @return [Legato::User] A user account with GA access
+        def user
+          Legato::User.new(token)
+        end
+
+        # Return a Google Analytics profile matching specified ID
+        # @ return [Legato::Management::Profile] A user profile associated with GA
+        def profile
+          return unless config.valid?
+          @profile = user.profiles.detect do |profile|
+            profile.web_property_id == config.analytics_id
+          end
+          raise 'User does not have access to this property' unless @profile
+          @profile
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def to_date_range(period)
+          case period
+          when "day"
+            start_date = Time.zone.today
+            end_date = Time.zone.today
+          when "week"
+            start_date = Time.zone.today - 7.days
+            end_date = Time.zone.today
+          when "month"
+            start_date = Time.zone.today - 1.month
+            end_date = Time.zone.today
+          when "year"
+            start_date = Time.zone.today - 1.year
+            end_date = Time.zone.today
+          end
+
+          [start_date, end_date]
+        end
+        # rubocop:enabl e Metrics/MethodLength
+
+        def keyword_conversion(date)
+          case date
+          when "last12"
+            start_date = Time.zone.today - 11.months
+            end_date = Time.zone.today
+
+            [start_date, end_date]
+          else
+            date.split(",")
+          end
+        end
+
+        def date_period(period, date)
+          if period == "range"
+            date.split(",")
+          else
+            to_date_range(period)
+          end
+        end
+
+        # Configure analytics_start_date in ENV file
+        def default_date_range
+          "#{Hyrax.config.analytics_start_date},#{Time.zone.today + 1.day}"
+        end
+
+        # The number of events by day for an action
+        def daily_events(action, date = default_date_range)
+          date = date.split(",")
+          EventsDaily.summary(profile, date[0], date[1], action)
+        end
+
+        # The number of events by day for an action and ID
+        def daily_events_for_id(id, action, date = default_date_range)
+          date = date.split(",")
+          EventsDaily.by_id(profile, date[0], date[1], id, action)
+        end
+
+        # A list of events sorted by highest event count
+        def top_events(action, date = default_date_range)
+          date = date.split(",")
+          Events.send('list', profile, date[0], date[1], action)
+        end
+
+        def unique_visitors(date = default_date_range); end
+
+        def unique_visitors_for_id(id, date = default_date_range); end
+
+        def new_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.new_visits(profile, date[0], date[1])
+        end
+
+        def new_visits_by_day(date = default_date_range, _period = 'day')
+          date = date.split(",")
+          VisitsDaily.new_visits(profile, date[0], date[1])
+        end
+
+        def returning_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.return_visits(profile, date[0], date[1])
+        end
+
+        def returning_visits_by_day(date = default_date_range, _period = 'day')
+          date = date.split(",")
+          VisitsDaily.return_visits(profile, date[0], date[1])
+        end
+
+        def total_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.total_visits(profile, date[0], date[1])
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/matomo.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ModuleLength
+module Hyrax
+  module Analytics
+    module Matomo
+      extend ActiveSupport::Concern
+
+      # rubocop:disable Metrics/BlockLength
+      class_methods do
+        # Loads configuration options from config/analytics.yml. Expected structure:
+        # `analytics:`
+        # `  matomo:`
+        # `    base_url: <%= ENV['MATOMOT_BASE_URL']`
+        # `    site_id: <%= ENV['MATOMOT_SITE_ID']`
+        # `    auth_token: <%= ENV['MATOMOT_AUTH_TOKEN']`
+        # @return [Config]
+        def config
+          @config ||= Config.load_from_yaml
+        end
+
+        class Config
+          def self.load_from_yaml
+            filename = Rails.root.join('config', 'analytics.yml')
+            yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
+            unless yaml
+              Rails.logger.error("Unable to fetch any keys from #{filename}.")
+              return new({})
+            end
+            new yaml.fetch('analytics')&.fetch('matomo')
+          end
+
+          REQUIRED_KEYS = %w[base_url site_id auth_token].freeze
+
+          def initialize(config)
+            @config = config
+          end
+
+          # @return [Boolean] are all the required values present?
+          def valid?
+            config_keys = @config.keys
+            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
+          end
+
+          REQUIRED_KEYS.each do |key|
+            class_eval %{ def #{key}; @config.fetch('#{key}'); end }
+          end
+        end
+
+        # Period Options = "day, week, month, year, range"
+        # Date Format = "2021-01-01,2021-01-31"
+
+        def default_date_range
+          "#{Hyrax.config.analytics_start_date},#{Time.zone.today}"
+        end
+
+        # Returns a total count of an event action over a date range
+        def total_events(action, date = default_date_range)
+          additional_params = { label: action }
+          response = api_params('Events.getAction', 'range', date, additional_params)
+          response&.first ? response.first["nb_events"] : 0
+        end
+
+        # Returns a total count of an event action for an id over a date range
+        def total_events_for_id(id, action, date = default_date_range)
+          additional_params = {
+            flat: 1,
+            label: "#{id} - #{action}"
+          }
+          response = api_params('Events.getName', 'range', date, additional_params)
+          response&.first ? response.first["nb_events"] : 0
+        end
+
+        def daily_events(action, date = default_date_range)
+          additional_params = { label: action }
+          response = api_params('Events.getAction', 'day', date, additional_params)
+          results_array(response, 'nb_events')
+        end
+
+        # Pass in an action name and an id and get back the daily count of events for that id. [date, event_count]
+        def daily_events_for_id(id, action, date = default_date_range)
+          additional_params = {
+            flat: 1,
+            label: "#{id} - #{action}"
+          }
+          response = api_params('Events.getName', 'day', date, additional_params)
+          results_array(response, 'nb_events')
+        end
+
+        #  Returns a list of the total of events by id in the format of [["id", event_count]]
+        def top_events(action, date = default_date_range)
+          additional_params = {
+            flat: '1',
+            filter_column: 'Events_EventAction',
+            filter_pattern: action.to_s,
+            filter_limit: '-1',
+            filter_sort_column: 'nb_events',
+            filter_sort_order: 'desc'
+          }
+          response = api_params('Events.getName', 'range', date, additional_params)
+          response.map { |res| [res['Events_EventName'], res['nb_events']] }
+        end
+
+        # Filter the daily events by a specific action and get back the daily count of number of events.
+        # TODO(geezy): NOT IN USE BUT SAVING FOR POTENTIAL REFACTOR
+        def filter_by_action(action, response)
+          results = []
+          response.each do |result|
+            if result[1].empty?
+              results.push([result[0].to_date, 0])
+            elsif result[1].is_a?(Array)
+              result[1].each do |subtable|
+                results.push([result[0].to_date, subtable["nb_events"].to_i]) if subtable["label"] == action
+              end
+            end
+          end
+          Hyrax::Analytics::Results.new(results)
+        end
+
+        def unique_visitors(date = default_date_range)
+          response = api_params('Actions.get', 'day', date)
+          results_array(response, 'nb_uniq_pageviews')
+        end
+
+        def unique_visitors_for_id(url, date = default_date_range)
+          # additional_params = { pageUrl: url }
+          # response = api_params('Actions.getPageUrl', 'day', date, additional_params)
+          # results_array(response, 'nb_uniq_visitors')
+        end
+
+        def new_visitors(period = 'month', date = 'today')
+          response = api_params('VisitFrequency.get', period, date)
+          response["nb_visits_new"]
+        end
+
+        def new_visits_by_day(date = default_date_range, period = 'day')
+          result = api_params('VisitFrequency.get', period, date)
+          results_array(result, 'nb_visits_new')
+        end
+
+        def returning_visitors(period = 'month', date = 'today')
+          response = api_params('VisitFrequency.get', period, date)
+          response["nb_visits_returning"]
+        end
+
+        def returning_visits_by_day(date = default_date_range, period = 'day')
+          result = api_params('VisitFrequency.get', period, date)
+          results_array(result, 'nb_visits_returning')
+        end
+
+        def total_visitors(period = 'month', date = 'today')
+          response = api_params('VisitFrequency.get', period, date)
+          response["nb_visits_returning"].to_i + response["nb_visits_new"].to_i
+        end
+
+        def results_array(response, metric)
+          results = []
+          response.each do |result|
+            if result[1].empty?
+              results.push([result[0].to_date, 0])
+            elsif result[1].is_a?(Array)
+              results.push([result[0].to_date, result[1].first[metric]])
+            else
+              results.push([result[0].to_date, result[1][metric].presence || 0])
+            end
+          end
+          Hyrax::Analytics::Results.new(results)
+        end
+
+        def get(params)
+          response = Faraday.get(config.base_url, params)
+          return [] if response.status != 200
+          JSON.parse(response.body)
+        end
+
+        def api_params(method, period, date, additional_params = {})
+          params = {
+            module: "API",
+            idSite: config.site_id,
+            method: method,
+            period: period,
+            date: date,
+            format: "JSON",
+            token_auth: config.auth_token
+          }
+          params.merge!(additional_params)
+          get(params)
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/results.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+module Hyrax
+  module Analytics
+    class Results
+      require 'csv'
+
+      attr_accessor :results
+
+      def initialize(results)
+        @results ||= results
+      end
+
+      def all
+        results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def day(date = Time.zone.today)
+        start_date = date.at_beginning_of_day
+        end_date = date.at_end_of_day
+        range_results = []
+        results.each do |result|
+          range_results.push(result) if (start_date..end_date).cover?(result[0])
+        end
+        range_results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def week(date = Time.zone.today)
+        start_date = date.at_beginning_of_week
+        end_date = date.at_end_of_week
+        range_results = []
+        results.each do |result|
+          range_results.push(result) if (start_date..end_date).cover?(result[0])
+        end
+        range_results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def month(date = Time.zone.today)
+        start_date = date.at_beginning_of_month
+        end_date = date.at_end_of_month
+        range_results = []
+        results.each do |result|
+          range_results.push(result) if (start_date..end_date).cover?(result[0])
+        end
+        range_results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def year(date = Time.zone.today)
+        start_date = date.at_beginning_of_year
+        end_date = date.at_end_of_year
+        range_results = []
+        results.each do |result|
+          range_results.push(result) if (start_date..end_date).cover?(result[0])
+        end
+        range_results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def range(start_date = Time.zone.today - 1.month, end_date = Time.zone.today)
+        range_results = []
+        results.each do |result|
+          range_results.push(result) if (start_date..end_date).cover?(result[0])
+        end
+        range_results.inject(0) { |sum, a| sum + a[1] }
+      end
+
+      def to_csv
+        results.inject([]) { |csv, row| csv << CSV.generate_line(row) }.join("")
+      end
+
+      def list
+        results.inject([]) { |line, row| line << row }.reverse
+      end
+
+      def to_flot
+        fields = [:date, :pageviews]
+        results.map { |row| fields.zip(row).to_h }
+      end
+    end
+  end
+end

data/app/services/hyrax/analytics.rb

@@ -1,89 +1,19 @@
 # frozen_string_literal: true
-require 'oauth2'
-require 'signet/oauth_2/client'
-
 module Hyrax
   module Analytics
-    # Loads configuration options from config/analytics.yml. Expected structure:
-    # `analytics:`
-    # `  app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
-    # `  app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
-    # `  privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
-    # `  privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
-    # `  client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
-    # @return [Config]
-    def self.config
-      @config ||= Config.load_from_yaml
-    end
-    private_class_method :config
-
-    class Config
-      def self.load_from_yaml
-        filename = Rails.root.join('config', 'analytics.yml')
-        yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
-        unless yaml
-          Rails.logger.error("Unable to fetch any keys from #{filename}.")
-          return new({})
-        end
-        new yaml.fetch('analytics')
-      end
-
-      REQUIRED_KEYS = %w[app_name app_version privkey_path privkey_secret client_email].freeze
-
-      def initialize(config)
-        @config = config
-      end
-
-      # @return [Boolean] are all the required values present?
-      def valid?
-        config_keys = @config.keys
-        REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
-      end
-
-      REQUIRED_KEYS.each do |key|
-        class_eval %{ def #{key};  @config.fetch('#{key}'); end }
-      end
-    end
-
-    # Generate an OAuth2 token for Google Analytics
-    # @return [OAuth2::AccessToken] An OAuth2 access token for GA
-    def self.token(scope = 'https://www.googleapis.com/auth/analytics.readonly')
-      access_token = auth_client(scope).fetch_access_token!
-      OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
+    ##
+    # a completely empty module to include if no parser is configured
+    module NullAnalyticsParser; end
+
+    def self.provider_parser
+      "Hyrax::Analytics::#{Hyrax.config.analytics_provider.to_s.capitalize}".constantize
+    rescue NameError => err
+      Hyrax.logger.warn("Couldn't find an Analytics provider matching "\
+                        " #{Hyrax.config.analytics_provider}. Loading " \
+                        " NullAnalyticsProvider.\n#{err.message}")
+      NullAnalyticsParser
     end
 
-    def self.oauth_client
-      OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
-                                 token_url: 'https://accounts.google.com/o/oauth2/token')
-    end
-
-    def self.auth_client(scope)
-      raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
-      private_key = File.read(config.privkey_path)
-      Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
-                                 audience: 'https://accounts.google.com/o/oauth2/token',
-                                 scope: scope,
-                                 issuer: config.client_email,
-                                 signing_key: OpenSSL::PKCS12.new(private_key, config.privkey_secret).key,
-                                 sub: config.client_email
-    end
-
-    private_class_method :token
-
-    # Return a user object linked to a Google Analytics account
-    # @return [Legato::User] A user account wit GA access
-    def self.user
-      Legato::User.new(token)
-    end
-    private_class_method :user
-
-    # Return a Google Analytics profile matching specified ID
-    # @ return [Legato::Management::Profile] A user profile associated with GA
-    def self.profile
-      return unless config.valid?
-      user.profiles.detect do |profile|
-        profile.web_property_id == Hyrax.config.google_analytics_id
-      end
-    end
+    include provider_parser
   end
 end