supplejack_api 1

data/app/serializers/supplejack_api/record_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class RecordSerializer < ActiveModel::Serializer
+    include SupplejackApi::Concerns::RecordSerializable
+  end
+end

data/app/serializers/supplejack_api/search_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class SearchSerializer < ActiveModel::Serializer
+    include SupplejackApi::Concerns::SearchSerializable
+  end
+end

data/app/serializers/supplejack_api/source_authority_serializer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class SourceAuthoritySerializer < ActiveModel::Serializer
+    attributes :_mn_family_name, :_mn_given_name, :altLabel, :biographicalInformation,
+               :birthYear, :concept_id, :concept_score, :dateOfBirth, :dateOfDeath, :deathYear,
+               :familyName, :givenName, :internal_identifier, :name, :prefLabel, :sameAs,
+               :source_id, :source_name, :url, :updated_at, :created_at
+
+    def serializable_hash
+      hash = {}
+      hash['@type'] = object.concept_type
+      hash = hash.merge!(attributes)
+      hash
+    end
+  end
+end

data/app/serializers/supplejack_api/user_serializer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class UserSerializer < ActiveModel::Serializer
+    attributes :id, :name, :username, :email, :api_key
+  end
+end

data/app/serializers/supplejack_api/user_set_record_serializer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class UserSetRecordSerializer < ActiveModel::Serializer
+    attribute :record_id
+    root :set
+  end
+end

data/app/serializers/supplejack_api/user_set_serializer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class UserSetSerializer < ActiveModel::Serializer
+    attributes :name, :count, :priority, :featured, :approved, :created_at, :updated_at, :tags
+    has_one :record, serializer: UserSetRecordSerializer
+    root :set
+
+    def serializable_hash
+      hash = { id: object.id.to_s }
+      hash.merge! attributes
+
+      options.reverse_merge!(items: true)
+
+      include!(:record, node: hash)
+
+      if options[:items]
+        hash[:description] = object.description
+        hash[:privacy] = object.privacy
+        hash[:tags] = object.tags
+        hash[:records] = records
+      elsif options[:featured]
+        hash[:records] = records(1)
+      else
+        hash[:records] = simple_records
+      end
+
+      hash[:user] = user if options[:user]
+
+      hash
+    end
+
+    # Returns a array of Hashes with the information from each record
+    # included in the Hash
+    #
+    # The values to be added from the record are stored in SetItem::ATTRIBUTES
+    #
+    def records(amount = nil)
+      attributes = [:record_id, :position] + SetItem::ATTRIBUTES
+      object.items_with_records(amount).map do |item|
+        Hash[attributes.map { |attr| [attr, item.send(attr)] }]
+      end
+    end
+
+    # Returns a array of Hashes with only the record_id and position
+    #
+    def simple_records
+      object.set_items.map do |item|
+        { record_id: item.record_id, position: item.position }
+      end
+    end
+
+    # Return the user information about the set, this is only displyed
+    # on the set show endpoint.
+    #
+    # When the user requesting the sets is a admin, also return the API Key
+    # for the owner of the set. This is required in order for applications
+    # to make requests on the user's behalf.
+    #
+    def user
+      hash = { name: object.user.try(:name) }
+
+      admin = options[:user]
+      if admin && admin.respond_to?(:admin?) && admin.try(:admin?)
+        hash[:api_key] = object.user.try(:api_key)
+      end
+
+      hash
+    end
+  end
+end

data/app/services/metrics_api/v3/api.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    # API entry point for V3 of the MetricsAPI
+    #
+    # It takes in the request parameters and
+    # generates the metrics JSON the API should
+    # respond with
+    class Api
+      ENDPOINT_BASE = 'MetricsApi::V3::Endpoints::'
+
+      attr_reader :params, :endpoint
+
+      # @param params [Hash] request parameters hash, passed onto active endpoint
+      # @param endpoint [Symbol] endpoint this API requests is for
+      def initialize(params, endpoint)
+        @params = params
+        @endpoint = (ENDPOINT_BASE + endpoint.to_s.camelize).constantize
+      end
+
+      # Generates an API response using the parameters passed in when the class is created.
+      # This response has already been presented and is ready to deliver to the client
+      #
+      # @return [Array<Hash>] the generated API response
+      def call
+        endpoint.new(params).call
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/endpoints/facets.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Endpoints
+      # Facets endpoint. Returns a list of display_collection names
+      class Facets
+        attr_reader :primary_key
+
+        # All endpoints take in a params hash, this endpoint has no params however
+        def initialize(*)
+          # TODO: maybe this should be a global metrics config? There are now 3+ locations you would need
+          # to update the primary key for metrics
+          @primary_key = 'display_collection'
+        end
+
+        # TODO: Better way of collecting display_collection names
+        def call
+          SupplejackApi::FacetsHelper.get_list_of_facet_values(primary_key)
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/endpoints/global.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Endpoints
+      # Global endpoint. Returns a list of presented DailyMetrics models
+      class Global
+        include Helpers
+
+        attr_reader :start_date, :end_date
+
+        # All endpoints take in a params hash, this endpoint has no params however
+        def initialize(params)
+          @start_date = parse_date_param(params[:start_date]) || Time.zone.yesterday
+          @end_date = parse_date_param(params[:end_date]) || Time.zone.today
+        end
+
+        # TODO: Better way of collecting display_collection names
+        def call
+          metrics = SupplejackApi::DailyMetrics.created_between(start_date, end_date)
+
+          metrics.map(&MetricsApi::V3::Presenters::DailyMetric)
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/endpoints/helpers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Endpoints
+      module Helpers
+        def parse_date_param(date_param)
+          return nil unless date_param.present?
+
+          Date.parse(date_param)
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/endpoints/root.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Endpoints
+      class Root
+        include Helpers
+
+        attr_accessor :facets, :start_date, :end_date, :metrics
+
+        # Mapping of metric names to the model that represents that metric
+        METRICS_TO_MODEL = {
+          'record' => SupplejackApi::FacetedMetrics,
+          'view' => SupplejackApi::UsageMetrics
+        }.freeze
+        # Mapping of metrics to the field on it's respective model that contains
+        # the value to filter against
+        METRIC_TO_MODEL_KEY = {
+          'record' => :name,
+          'view' => :record_field_value
+        }.freeze
+        # Facet limit to return in response
+        MAX_FACETS = 10
+
+        def initialize(params)
+          @facets = parse_csv_param(params[:facets])
+          @start_date = parse_date_param(params[:start_date]) || Date.yesterday
+          @end_date = parse_date_param(params[:end_date]) || Date.yesterday
+          @metrics = parse_csv_param(params[:metrics]) || %w(record view)
+        end
+
+        def call
+          # TODO: Figure out a nicer way of handling error responses
+          unless facets.present?
+            return {
+              exception: {
+                status: 400,
+                message: 'facets parameter is required'
+              }
+            }
+          end
+          if facets.size > MAX_FACETS
+            return {
+              exception: {
+                status: 400,
+                message: "Only up to #{MAX_FACETS} may be requested at once"
+              }
+            }
+          end
+
+          metrics_models = metrics.map(&method(:metric_to_model_bundle))
+          filtered_models = metrics_models.map(&method(:filter_model_bundle))
+          models_grouped_by_date = filtered_models.map(&method(:group_models_in_bundle_by_date))
+
+          MetricsApi::V3::Presenters::ExtendedMetadata.new(models_grouped_by_date, start_date, end_date).to_json
+        end
+
+        private
+
+        def metric_to_model_bundle(metric)
+          model = METRICS_TO_MODEL[metric]
+
+          models_in_range = model.created_between(start_date, end_date).to_a
+
+          { metric: metric, models: models_in_range.flatten }
+        end
+
+        def filter_model_bundle(model_bundle)
+          metric = model_bundle[:metric]
+          key = METRIC_TO_MODEL_KEY[metric]
+
+          models_to_keep = model_bundle[:models].select do |model|
+            facets.include? model.send(key)
+          end
+
+          { metric: metric, models: models_to_keep }
+        end
+
+        def group_models_in_bundle_by_date(model_bundle)
+          metric = model_bundle[:metric]
+          models = model_bundle[:models]
+
+          { metric: metric, models: models.group_by { |m| m.date.to_date } }
+        end
+
+        # Converts csv formatted parameter to an array
+        #
+        # @param param [String] CSV string
+        # @return [Array<String>] split CSV
+        def parse_csv_param(param)
+          return nil unless param.present?
+
+          param.split(',').map(&:strip)
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/presenters/daily_metric.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Presenters
+      class DailyMetric
+        def initialize(daily_metric)
+          @dm = daily_metric
+        end
+
+        def to_json
+          {
+            day: @dm.date,
+            total_public_sets: @dm.total_public_sets
+          }
+        end
+
+        def self.to_proc
+          ->(metric) { new(metric).to_json }
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/presenters/extended_metadata.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Presenters
+      class ExtendedMetadata
+        PRESENTERS_BASE = 'MetricsApi::V3::Presenters::'
+
+        attr_reader :metrics, :start_date, :end_date
+
+        def initialize(metrics, start_date, end_date)
+          @metrics = metrics
+          @start_date = start_date
+          @end_date = end_date
+        end
+
+        def to_json
+          (start_date..end_date).map do |date|
+            base = { date: date }
+
+            todays_metrics = metrics.map do |metric|
+              relavent_models = metric[:models].select { |key| key == date }.values.first
+              presenter = (PRESENTERS_BASE + metric[:metric].camelize).constantize
+
+              next { metric[:metric] => [] } unless relavent_models.present?
+
+              { metric[:metric] => relavent_models.map(&presenter) }
+            end
+
+            todays_metrics.each { |x| base.merge!(x) }
+
+            base
+          end
+        end
+
+        def self.to_proc
+          ->(models) { new(models).to_json }
+        end
+      end
+    end
+  end
+end

data/app/services/metrics_api/v3/presenters/record.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module MetricsApi
+  module V3
+    module Presenters
+      class Record
+        def initialize(faceted_metrics)
+          @m = faceted_metrics
+        end
+
+        def to_json
+          {
+            id: @m.name,
+            total_active_records: @m.total_active_records,
+            total_new_records: @m.total_new_records,
+            category_counts: @m.category_counts || {},
+            copyright_counts: @m.copyright_counts || {}
+          }
+        end
+
+        def self.to_proc
+          ->(metric) { new(metric).to_json }
+        end
+      end
+    end
+  end
+end