nucleo-client 0.1.0

data/lib/nucleo/models/metric_period.rb

@@ -0,0 +1,97 @@
+require File.expand_path('../metric_period_rows', __FILE__)
+
+module Nucleo
+  module Models
+    class MetricPeriod
+      include Comparable
+
+      # Returns an instance of the Metric Period domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriod]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Implement Comparable
+      def <=>(other)
+        if self.current?
+          1
+        elsif self.prior?
+          0
+        else
+          -1
+        end
+      end
+
+      # Returns the type of the metric
+      #
+      # @return [String]
+      def metric
+        @attributes['metric']
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the name of the period
+      #
+      # @return [String]
+      def period_name
+        @attributes['period_name']
+      end
+
+      # Returns true if this is current
+      #
+      # @return [Boolean]
+      def current?
+        'current' == self.period_name
+      end
+
+      # Returns true if this is for the prior period
+      #
+      # @return [Boolean]
+      def prior?
+        'prior' == self.period_name
+      end
+
+      # Returns the totals for this type of metric
+      #
+      # @return [Integer]
+      def totals
+        totals_hash.fetch(self.metric, 0).to_i
+      end
+
+      # Returns the instance of the DateRange domain model
+      #
+      # @return [Nucleo::Models::DateRange]
+      def date_range
+        Nucleo::Models::DateRange.new(@attributes.fetch('date_range', {}))
+      end
+
+      # Returns an instance of the MetricPeriodRows domain model
+      #
+      # @return [Nucleo::Models::MetricPeriodRows]
+      def rows
+        Nucleo::Models::MetricPeriodRows.new(self.metric, self.dimension, self.period_name, @attributes.fetch('rows', []))
+      end
+
+      # Returns true if there are any rows
+      #
+      # @return [Boolean]
+      def rows?
+        self.rows.any?
+      end
+
+      private
+      def totals_hash
+        @attributes.fetch('totals', {})
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_period_row.rb

@@ -0,0 +1,125 @@
+module Nucleo
+  module Models
+    class MetricPeriodRow
+      # Returns an instance of the Metric Period Row domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriodRow]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the type of the row
+      #
+      # @return [String]
+      def metric
+        @attributes['metric']
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the dimension name
+      #
+      # @return [String]
+      def dimension_name
+        if self.page?
+          self.page.title
+        else
+          row.fetch(self.dimension, '')
+        end
+      end
+
+      # Returns the period name
+      #
+      # @return [String]
+      def period_name
+        @attributes['period_name']
+      end
+
+      # Returns true if this is the current period
+      #
+      # @return [Boolean]
+      def current?
+        'current' == self.period_name
+      end
+
+      # Returns true if this is the prior period
+      #
+      # @return [Boolean]
+      def prior?
+        'prior' == self.period_name
+      end
+
+      # Returns an instance of the Page domain model
+      #
+      # @return [Nucleo::Models::Page]
+      def page
+        val = row['page']
+
+        return nil if val.nil? || val.empty?
+
+        Nucleo::Models::Page.new(val)
+      end
+
+      # Returns true if there is a page
+      #
+      # @return [Boolean]
+      def page?
+        !self.page.nil?
+      end
+
+      # Return the value for this metric
+      #
+      # @return [Integer]
+      def value
+        row.fetch(self.metric, 0).to_i
+      end
+
+      # Returns the change
+      #
+      # @return [Float]
+      def change
+        row[translated_key_name(:change)].to_f
+      end
+
+      # Returns the percent total
+      #
+      # @return [Float]
+      def pct_total
+        row[translated_key_name(:pct_total)].to_f
+      end
+      alias :percent_total :pct_total
+
+      # Returns the rank change
+      #
+      # @return [Integer]
+      def rank_change
+        row[translated_key_name(:rank_change)].to_i
+      end
+
+      # Returns the rank
+      #
+      # @return [Integer]
+      def rank
+        row[translated_key_name(:rank)].to_i
+      end
+
+      private
+      def translated_key_name(key)
+        key = key.to_s
+
+        [self.metric, key].join('_')
+      end
+
+      def row
+        @attributes.fetch('row', {})
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_period_rows.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../metric_period_row', __FILE__)
+
+module Nucleo
+  module Models
+    class MetricPeriodRows
+      include Enumerable
+
+      def initialize(metric, dimension, period_name, collection)
+        @metric      = metric
+        @dimension   = dimension
+        @period_name = period_name
+        @collection  = Array(collection)
+      end
+
+      def each(&block)
+        internal_collection.each(&block)
+      end
+
+      private
+      def internal_collection
+        @collection.map do |r|
+          params = {
+            'metric'      => @metric,
+            'dimension'   => @dimension,
+            'period_name' => @period_name,
+            'row'         => r
+          }
+
+          Nucleo::Models::MetricPeriodRow.new(params)
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_period_totals.rb

@@ -0,0 +1,121 @@
+module Nucleo
+  module Models
+    class MetricPeriodTotals
+      # Returns an instance of the Metric Period Totals
+      #
+      # This is specific to the period being returned.
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriodTotals]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the type of metric
+      #
+      # @return [String]
+      def metric
+        @attributes['metric']
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the period for the totals
+      #
+      # @return [Hash]
+      def period
+        @attributes.fetch('period', {})
+      end
+
+      # Returns the site change totals
+      #
+      # @return [Float]
+      def site_change
+        self.period[translated_key_name(:site_change)].to_f
+      end
+
+      # Returns true if there is a site change
+      #
+      # @return [Boolean]
+      def site_change?
+        self.site_change > 0
+      end
+
+      # Returns the site change percentage
+      #
+      # @return [Float]
+      def site_change_percent
+        if self.site_change?
+          self.site_change
+        else
+          (self.site_change * -1)
+        end
+      end
+
+      # Returns the dimension change
+      #
+      # @return [Float]
+      def dimension_change
+        self.period[translated_key_name(:dimension_change)].to_f
+      end
+
+      # Returns the site total
+      #
+      # @return [Float]
+      def site
+        self.period[translated_key_name(:site)].to_f
+      end
+
+      # Returns the dimension percentage of site change
+      #
+      # @return [Float]
+      def dimension_pct_of_site_change
+        self.period[translated_key_name(:dimension_pct_of_site_change)].to_f
+      end
+      alias :dimension_percent_of_site_change :dimension_pct_of_site_change
+
+      # Returns true if there is a dimension percent of site change
+      #
+      # @return [Boolean]
+      def dimension_percent_of_site_change?
+        self.dimension_percent_of_site_change > 0
+      end
+
+      def dimension_percent_of_site_change_percent
+        if self.dimension_percent_of_site_change?
+          self.dimension_percent_of_site_change
+        else
+          (self.dimension_percent_of_site * -1)
+        end
+      end
+
+      # Returns the dimension percentage of site
+      #
+      # @return [Float]
+      def dimension_pct_of_site
+        self.period[translated_key_name(:dimension_pct_of_site)].to_f
+      end
+      alias :dimension_percent_of_site :dimension_pct_of_site
+
+      # Returns the dimension total
+      #
+      # @return [Float]
+      def dimension
+        self.period[translated_key_name(:dimension)].to_f
+      end
+
+      private
+      def translated_key_name(key)
+        key = key.to_s
+
+        [self.metric, key].join('_')
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_periods.rb

@@ -0,0 +1,78 @@
+require File.expand_path('../metric_period', __FILE__)
+require File.expand_path('../metric_periods_totals', __FILE__)
+
+module Nucleo
+  module Models
+    class MetricPeriods
+      # Returns an instance of the Metric Periods domain models
+      #
+      # This takes in the `totals`, `current_period`, and `prior_period`
+      # and wraps their response bodies in specific objects for comparisons.
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriods]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the type of metric for period
+      #
+      # @return [String]
+      def type
+        @attributes['type']
+      end
+
+      # Returns the type of the metric
+      #
+      # @return [String]
+      def metric
+        @attributes['metric']
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the metric period totals
+      #
+      # @return [Nucleo::Models::MetricPeriodTotals]
+      def totals
+        params = {
+          'metric'    => self.metric,
+          'dimension' => self.dimension,
+          'totals'    => @attributes['totals']
+        }
+
+        Nucleo::Models::MetricPeriodsTotals.new(params)
+      end
+
+      # Returns the metric period
+      #
+      # @return [Nucleo::Models::MetricPeriod]
+      def current_period
+        params = @attributes.fetch('current_period', {}).merge!('metric' => self.metric, 'dimension' => self.dimension, 'period_name' => 'current')
+        Nucleo::Models::MetricPeriod.new(params)
+      end
+
+      # Returns the prior metric period
+      #
+      # @return [Nucleo::Models::MetricPeriod]
+      def prior_period
+        params = @attributes.fetch('prior_period', {}).merge!('metric' => self.metric, 'dimension' => self.dimension, 'period_name' => 'prior')
+        Nucleo::Models::MetricPeriod.new(params)
+      end
+      alias :previous_period :prior_period
+
+      # Returns a metric periods comparisons collection domain model
+      #
+      # @return [Array]
+      def periods_comparisons
+        Nucleo::Models::MetricPeriodsComparisons.new(self.current_period, self.prior_period)
+      end
+    end
+  end
+end