nucleo-client 0.1.0

data/lib/nucleo/models/metric_periods_comparison.rb

@@ -0,0 +1,80 @@
+require File.expand_path('../metric_period', __FILE__)
+
+module Nucleo
+  module Models
+    class MetricPeriodsComparison
+      include Comparable
+
+      # Creates a new instance of the Metric Periods Comparison domain model.
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriodsComparison]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the current period value
+      #
+      # @return [Float]
+      def current_value
+        @attributes['current_value'].to_f
+      end
+
+      # Returns the prior period value
+      #
+      # @return [Float]
+      def prior_value
+        @attributes['prior_value'].to_f
+      end
+
+      # Returns the percent change
+      #
+      # @return [Integer]
+      def change
+        @attributes['change'].to_f
+      end
+
+      # Returns true if there is no change
+      #
+      # @return [Boolean]
+      def no_change?
+        self.change == 0
+      end
+
+      # Returns true if there is a positive change
+      #
+      # @return [Boolean]
+      def positive_change?
+        self.change > 0
+      end
+
+      # Returns true if the change is negative
+      #
+      # @return [Boolean]
+      def negative_change?
+        self.change < 0
+      end
+
+      # Returns the direcction of change
+      #
+      # @return [String]
+      def direction
+        if self.positive_change?
+          'up'
+        elsif self.no_change?
+          'same'
+        elsif self.negative_change?
+          'down'
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_periods_comparisons.rb

@@ -0,0 +1,73 @@
+require File.expand_path('../metric_periods_comparison', __FILE__)
+
+module Nucleo
+  module Models
+    class MetricPeriodsComparisons
+      include Enumerable
+
+      # Returns a Metrics Comparison domain model
+      #
+      # @param first_period [Nucleo::Models::MetricPeriod]
+      # @param second_period [Nucleo::Models::MetricPeriod]
+      #
+      # @return [Nucleo::Models::MetricPeriodComparison]
+      def initialize(first_period, second_period)
+        @first_period  = first_period
+        @second_period = second_period
+      end
+
+      def each(&block)
+        internal_collection.each(&block)
+      end
+
+      private
+      def internal_collection
+        grouped_periods.map do |dimension, periods|
+          current_period = periods.find(&:current?)
+          prior_period   = periods.find(&:prior?)
+
+          attributes = {
+            'dimension'     => dimension,
+            'current_value' => 0,
+            'prior_value'   => 0,
+            'change'        => 0,
+          }
+
+          if current_period
+            attributes.merge!('current_value' => current_period.value, 'change' => current_period.change)
+          end
+
+          if prior_period
+            attributes.merge!('prior_value' => prior_period.value)
+          end
+
+          Nucleo::Models::MetricPeriodsComparison.new(attributes)
+        end
+      end
+
+      def grouped_periods
+        all_rows.group_by(&:dimension_name)
+      end
+
+      def first_period
+        @first_period
+      end
+
+      def first_period_rows
+        first_period.rows
+      end
+
+      def second_period
+        @second_period
+      end
+
+      def second_period_rows
+        second_period.rows
+      end
+
+      def all_rows
+        (first_period_rows.to_a + second_period_rows.to_a)
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric_periods_totals.rb

@@ -0,0 +1,58 @@
+module Nucleo
+  module Models
+    class MetricPeriodsTotals
+      # Returns an instance of the MetricPeriodsTotals domain model
+      #
+      # These are the totals across both `current_period`
+      # and `prior_period`.
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::MetricPeriodsTotals]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the metric type for the totals
+      #
+      # @return [String]
+      def metric
+        @attributes['metric']
+      end
+
+      # Returns the dimension
+      #
+      # @return [String]
+      def dimension
+        @attributes['dimension']
+      end
+
+      # Returns the current period totals
+      #
+      # @return [Nucleo::Models::MetricPeriodTotals]
+      def current_period
+        params = {
+          'metric'    => self.metric,
+          'dimension' => self.dimension,
+          'period'    => @attributes['totals']['current_period']
+        }
+
+        Nucleo::Models::MetricPeriodTotals.new(params)
+      end
+
+      # Returns the prior period totals
+      #
+      # @return [Nucleo::Models::MetricPeriodTotals]
+      def prior_period
+        params = {
+          'metric'    => self.metric,
+          'dimension' => self.dimension,
+          'period'    => @attributes['totals']['prior_period']
+        }
+
+        Nucleo::Models::MetricPeriodTotals.new(params)
+      end
+      alias :previous_period :prior_period
+    end
+  end
+end

data/lib/nucleo/models/page.rb

@@ -0,0 +1,147 @@
+module Nucleo
+  module Models
+    class Page
+      # Return an instance of the Page domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::Page]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the ID of the page
+      #
+      # @return [String]
+      def id
+        @attributes['id']
+      end
+
+      # Returns the title of the page
+      #
+      # @return [String]
+      def title
+        @attributes['title']
+      end
+
+      # Returns the path of the page
+      #
+      # @return [String]
+      def path
+        @attributes['path']
+      end
+
+      # Returns the hostname of the page
+      #
+      # @return [String]
+      def hostname
+        @attributes['hostname']
+      end
+
+      # Returns the URI of the resolved URL
+      #
+      # @return [URI]
+      def url
+        URI(self.resolved_url)
+      end
+
+      # Returns the resolved URL of the page
+      #
+      # @return [String]
+      def resolved_url
+        @attributes['resolved_url'].to_s
+      end
+
+      # Returns the date the page was crawled
+      #
+      # @return [DateTime,nil]
+      def crawled_at
+        begin
+          DateTime.parse(@attributes['crawled_at'])
+        rescue
+          nil
+        end
+      end
+
+      # Returns a set of rules
+      #
+      # @return [Nucleo::Models::Rules]
+      def rules
+        Nucleo::Models::Rules.new(@attributes.fetch('rules', []))
+      end
+
+      # Returns a Feeds collection of recommendations for this page
+      #
+      # @return [Nucleo::Models::Feeds]
+      def recommendations
+        Nucleo::Models::Feeds.new(@attributes.fetch('recommendations', []))
+      end
+
+      # Returns true if there are any recommendations
+      #
+      # @return [Boolean]
+      def recommendations?
+        self.recommendations.any?
+      end
+
+      # Returns a Feeds collection of alerts for this page
+      #
+      # @return [Nucleo::Models::Feeds]
+      def alerts
+        Nucleo::Models::Feeds.new(@attributes.fetch('alerts', []))
+      end
+
+      # Returns true if there are any alerts
+      #
+      # @return [Boolean]
+      def alerts?
+        self.alerts.any?
+      end
+
+      # Returns a collection of Analytics
+      #
+      # @return [Array]
+      def analytics
+        Nucleo::Models::Feeds.new(@attributes.fetch('analytics', []))
+      end
+
+      # Returns true if there are any analytics
+      #
+      # @return [Boolean]
+      def analytics?
+        self.analytics.any?
+      end
+
+      # Returns metrics for this page
+      #
+      # @return [Nucleo::Models::PageMetric]
+      def metrics
+        Nucleo::Models::PageMetric.new(@attributes.fetch('metrics', []))
+      end
+
+      # Returns true if there are any metrics
+      #
+      # @return [Boolean]
+      def metrics?
+        self.metrics.any?
+      end
+
+      # Returns the SeoScore domain model for this page
+      #
+      # @return [Nucleo::Models::SeoScore]
+      def seo_score
+        Nucleo::Models::SeoScore.new(seo_score_params)
+      end
+
+      private
+      def seo_score_params
+        reference = @attributes.fetch('seo_score', {})
+
+        {
+          'score' => reference['seo_score'],
+          'grade' => reference['seo_grade']
+        }
+      end
+    end
+  end
+end

data/lib/nucleo/models/page_alerts.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../feeds', __FILE__)
+
+module Nucleo
+  module Models
+    class PageAlerts
+      # Returns an instance of Page Alerts
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::PageAlerts]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      def self.retrieve(id, params={})
+        response_body = Nucleo::Requests::PageAlerts.retrieve(id, params)
+
+        self.new(response_body)
+      end
+
+      def alerts
+        Nucleo::Models::Feeds.new(@attributes)
+      end
+
+    end
+  end
+end

data/lib/nucleo/models/page_metric.rb

@@ -0,0 +1,58 @@
+module Nucleo
+  module Models
+    class PageMetric
+      METRIC_NAME = 'ga:pageviews'.freeze
+
+      # Returns an instance of the PageRank domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::PageRank]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the metric value
+      #
+      # @return [Integer]
+      def value
+        @attributes[METRIC_NAME].to_i
+      end
+
+      # Returns the change
+      #
+      # @return [Integer]
+      def change
+        @attributes[translated_key_name(:change)].to_f
+      end
+
+      # Returns the pct total
+      #
+      # @return [Integer]
+      def pct_total
+        @attributes[translated_key_name(:pct_total)].to_f
+      end
+
+      # Returns the rank
+      #
+      # @return [Integer]
+      def rank
+        @attributes[translated_key_name(:rank)].to_i
+      end
+
+      # Returns the rank
+      #
+      # @return [Integer]
+      def rank_change
+        @attributes[translated_key_name(:rank_change)].to_i
+      end
+
+      private
+      def translated_key_name(key)
+        key = key.to_s
+
+        [METRIC_NAME, key].join('_')
+      end
+    end
+  end
+end