nucleo-client 0.1.0

data/lib/nucleo/models/feed_types/analytics/site/social.rb

@@ -0,0 +1,61 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Analytics
+        module Site
+          
+          class Social < Nucleo::Models::FeedTypes::Analytics::Base
+            DIMENSION_NAME = 'ga:socialNetwork'.freeze
+            METRIC_NAME    = 'ga:pageviews'.freeze
+
+            # Returns the specific Metric for this page
+            #
+            # @return [Nucleo::Models::Metric]
+            def metric
+              params = {
+                'metric'         => METRIC_NAME,
+                'dimension'      => DIMENSION_NAME,
+                'classification' => @attributes['classification'],
+                'totals'         => data['totals'],
+                'current_period' => data['current_period'],
+                'prior_period'   => data['prior_period']
+              }
+
+              Nucleo::Models::Metric.new(params)
+            end
+
+            # Delegates to the Totals
+            #
+            # @return [Nucleo::Models::MetricPeriodsTotals]
+            def totals
+              self.metric.metric_periods.totals
+            end
+
+            # Delegates to the Metric Period
+            #
+            # @return [Nucleo::Models::MetricPeriod]
+            def current_period
+              self.metric.metric_periods.current_period
+            end
+
+            # Delegates to the Metric Period
+            #
+            # @return [Nucleo::Models::MetricPeriod]
+            def prior_period
+              self.metric.metric_periods.prior_period
+            end
+            alias :previous_period :prior_period
+
+            # Delegates to the Metric Period
+            #
+            # @return [Nucleo::Models::MetricPeriodsComparisons]
+            def periods_comparisons
+              self.metric.metric_periods.periods_comparisons
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/feed_types/base.rb

@@ -0,0 +1,182 @@
+require File.expand_path('../../page', __FILE__)
+
+module Nucleo
+  module Models
+    module FeedTypes
+      class Base
+        include Comparable
+
+        # Return an instance of the Feed domain model
+        #
+        # @param attributes [Hash]
+        #
+        # @return [Nucleo::Models::Feed]
+        def initialize(attributes={})
+          @attributes = attributes
+        end
+
+        # Sort by the executed at attribute
+        def <=>(other)
+          self.executed_at <=> other.executed_at
+        end
+
+        # Returns the page, if present
+        #
+        # @note: We have to inject the ID back in as it's
+        # not present in the `page` response.
+        #
+        # @return [Nucleo::Models::Page,nil]
+        def page
+          value = @attributes['page']
+
+          return nil if value.nil? || value.empty?
+
+          Nucleo::Models::Page.new(value)
+        end
+
+        # Returns true if there is an attached page
+        #
+        # @return [Boolean]
+        def page?
+          !self.page.nil?
+        end
+
+        # Returns the page recommendation ID
+        #
+        # @return [String]
+        def page_recommendation_id
+          @attributes['page_recommendation_id']
+        end
+
+        # Returns the site analytic ID
+        #
+        # @return [String]
+        def site_analytic_id
+          @attributes['site_analytic_id']
+        end
+
+        # Return the record ID
+        #
+        # @note: This is to support instantiation from `children`
+        #
+        # @return [String]
+        def record_id
+          @attributes['id']
+        end
+
+        # Return the ID of this recommendation
+        #
+        # @return [String]
+        def id
+          (self.page_recommendation_id || self.site_analytic_id || self.record_id)
+        end
+
+        # Returns the ID of the site
+        #
+        # @return [Integer]
+        def site_id
+          @attributes['site_id']
+        end
+
+        # Returns the Category of the recommendation
+        #
+        # @todo: Create a Category model that can handle answering
+        # some basic questions.
+        #
+        # @return [String]
+        def category
+          @attributes['category']
+        end
+        alias :category_name :category
+
+        # Returns the Type of the recommendation
+        #
+        # @return [String]
+        def type
+          @attributes['type']
+        end
+        alias :type_name :type
+
+        # Returns the Status of the recommendation
+        #
+        # @return [String]
+        def status
+          @attributes['status']
+        end
+        alias :status_name :status
+
+        # Returns the Context of the recommendation
+        #
+        # @return [String]
+        def context
+          @attributes['context']
+        end
+        alias :context_name :context
+
+        # Return the time of execution of this recommendation
+        #
+        # @return [DateTime,nil]
+        def executed_at
+          begin
+            DateTime.parse(@attributes['executed_at'])
+          rescue
+            nil
+          end
+        end
+
+        # Returns true if this is for seo
+        #
+        # @return [Boolean]
+        def seo_category?
+          'seo' == self.category
+        end
+
+        # Returns true if this is for analytics
+        #
+        # @return [Boolean]
+        def analytics_category?
+          'analytics' == self.category
+        end
+
+        # Returns true if this is a page context
+        #
+        # @return [Boolean]
+        def page_context?
+          'page' == self.context
+        end
+
+        # Returns true if this is a site context
+        #
+        # @return [Boolean]
+        def site_context?
+          'site' == self.context
+        end
+
+        # Return the child recommendations
+        #
+        # @return [Nucleo::Models::Feeds]
+        def children
+          Nucleo::Models::Feeds.new(children_collection)
+        end
+        alias :issues :children
+
+        # Returns true if there are children
+        #
+        # @return [Boolean]
+        def children?
+          self.children.any?
+        end
+        alias :issues? :children?
+
+        protected
+        def data
+          @attributes.fetch('data', {})
+        end
+
+        def children_collection
+          data.fetch('child_recommendations', [])
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/feed_types/seo.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../seo/page/base', __FILE__)
+require File.expand_path('../seo/page/seo_summary', __FILE__)
+require File.expand_path('../seo/page/summary', __FILE__)
+require File.expand_path('../seo/page/img_alt', __FILE__)
+require File.expand_path('../seo/page/meta_description', __FILE__)
+# require File.expand_path('../seo/page/meta_robots', __FILE__)  # TODO: Add back when action for this alert type is available
+require File.expand_path('../seo/page/page_title', __FILE__)
+
+require File.expand_path('../seo/site/base', __FILE__)
+require File.expand_path('../seo/site/img_alt', __FILE__)
+require File.expand_path('../seo/site/meta_description', __FILE__)
+# require File.expand_path('../seo/site/meta_robots', __FILE__)  # TODO: Add back when action for this alert type is available
+require File.expand_path('../seo/site/page_title', __FILE__)
+
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+      end
+    end
+  end
+end

data/lib/nucleo/models/feed_types/seo/page/base.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../../../base', __FILE__)
+
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class Base < Nucleo::Models::FeedTypes::Base
+
+            # Returns the checks
+            #
+            # @return [Array]
+            def checks
+              Nucleo::Models::Checks.new(data.fetch('checks',[]))
+            end
+
+            def check_count
+              checks.count
+            end
+
+            def element
+              Nucleo::Models::Element.new(data.fetch('element',{}))
+            end
+
+            def element_content
+              self.element.content
+            end
+
+            def element_content?
+              self.element_content.present?
+            end
+
+            def points
+              data.fetch('points', 0).to_i
+            end
+
+            def find_content
+              self.checks.find_content
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/feed_types/seo/page/img_alt.rb

@@ -0,0 +1,90 @@
+require 'uri'
+
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class ImgAlt < Nucleo::Models::FeedTypes::Seo::Page::Base
+
+            def image_src(site_url = nil)
+              url_template = '%{scheme}://%{host}/%{path}?%{query}#%{fragment}'
+
+              if site_url.present?
+                begin
+                  site_host = URI(site_url).host
+                rescue
+                  Nucleo::Client.configuration.logger.fatal("Unable to parse site_url %s" % [site_url])
+                end
+              end
+
+              img = self.element.src
+              begin
+                url = URI(img)
+
+                # Check if url is a valid http/https url
+                if url.kind_of?(URI::HTTP)
+                  return url.to_s
+                end
+
+                # Attempt to create new url from fragments
+                new_url = URI(url_template % {
+                  scheme: (url.scheme or 'http'),
+                  host: (url.host or site_host),
+                  path: url.path,
+                  query: url.query,
+                  fragment: url.fragment
+                })
+                return new_url.to_s if new_url.kind_of?(URI::HTTP)
+
+              rescue
+                Nucleo::Client.configuration.logger.fatal("Could not validate image url %s" % [img])
+              end
+            end
+
+            def alt_content
+              self.element.alt
+            end
+
+            # Returns the class level feed summary title
+            #
+            # @return [String]
+            def self.feed_summary
+              "<strong>img alt</strong> feed summary"
+            end
+
+            # Delegate to the class level feed summary
+            #
+            # @return [String]
+            def feed_summary
+              self.class.feed_summary
+            end
+
+            # Returns the headline based on the length of the content
+            #
+            # @return [String]
+            def headline
+              "img alt headline"
+            end
+
+            # Returns the detailed summary
+            #
+            # @return [String]
+            def long_summary
+              "img alts long summary"
+            end
+
+            # Returns the short summary
+            #
+            # @return [String]
+            def short_summary
+              "Images with <strong>Alt</strong> text are searchable with images search."
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/feed_types/seo/page/meta_description.rb

@@ -0,0 +1,49 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class MetaDescription < Nucleo::Models::FeedTypes::Seo::Page::Base
+
+            # Returns the class level feed summary title
+            #
+            # @return [String]
+            def self.feed_summary
+              "<strong>Meta Description</strong> feed summary"
+            end
+
+            # Delegate to the class level feed summary
+            #
+            # @return [String]
+            def feed_summary
+              self.class.feed_summary
+            end
+
+            # Returns the headline based on the length of the content
+            #
+            # @return [String]
+            def headline
+              "Meta description headline"
+            end
+
+            # Returns the detailed summary
+            #
+            # @return [String]
+            def long_summary
+              "Meta descriptions long summary"
+            end
+
+            # Returns the short summary
+            #
+            # @return [String]
+            def short_summary
+              "Meta descriptions improve how your site looks in search results."
+            end
+          end
+
+        end
+      end
+    end
+  end
+end