nucleo-client 0.1.0

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

@@ -0,0 +1,48 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class MetaRobots < Nucleo::Models::FeedTypes::Seo::Page::Base
+            # Returns the class level feed summary title
+            #
+            # @return [String]
+            def self.feed_summary
+              "<strong>Meta robot</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 robot headline"
+            end
+
+            # Returns the detailed summary
+            #
+            # @return [String]
+            def long_summary
+              "Meta robots long summary"
+            end
+
+            # Returns the short summary
+            #
+            # @return [String]
+            def short_summary
+              "Meta robots <strong>noindex</strong> will block search engines."
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class PageTitle < Nucleo::Models::FeedTypes::Seo::Page::Base
+            # Returns the class level feed summary title
+            #
+            # @return [String]
+            def self.feed_summary
+              "<strong>page title</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
+              "page title headline"
+            end
+
+            # Returns the detailed summary
+            #
+            # @return [String]
+            def long_summary
+              "page titles long summary"
+            end
+
+            # Returns the short summary
+            #
+            # @return [String]
+            def short_summary
+              "Page titles are customers first impression in search results."
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class SeoSummary < Nucleo::Models::FeedTypes::Seo::Page::Base
+
+            # Returns an instance of the SeoScore domain model
+            #
+            # @return [Nucleo::Models::SeoScore]
+            def seo_score
+              params = {
+                'score' => data['seo_score'],
+                'grade' => data['seo_grade']
+              }
+
+              Nucleo::Models::SeoScore.new(params)
+            end
+
+            # Returns an instance of the PageRank domain model
+            #
+            # @return [Nucleo::Models::PageRank]
+            def page_rank
+              params = {
+                'rank'     => data['page_rank'],
+                'rank_max' => data['page_rank_max']
+              }
+
+              Nucleo::Models::PageRank.new(params)
+            end
+
+            # Returns the number of page views
+            #
+            # @return [Integer]
+            def page_views
+              data['page_views'].to_i
+            end
+            alias :pageviews :page_views
+
+            # Returns the count of issues (children recommendations)
+            #
+            # @return [Integer]
+            def issue_count
+              data['issue_count'].to_i
+            end
+          end
+          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Page
+
+          class Summary < Nucleo::Models::FeedTypes::Seo::Page::Base
+            # Returns an instance of the SeoScore domain model
+            #
+            # @return [Nucleo::Models::SeoScore]
+            def seo_score
+              params = {
+                'score' => data['seo_score'],
+                'grade' => data['seo_grade']
+              }
+
+              Nucleo::Models::SeoScore.new(params)
+            end
+
+            # Returns an instance of the PageRank domain model
+            #
+            # @return [Nucleo::Models::PageRank]
+            def page_rank
+              params = {
+                'rank'     => data['page_rank'],
+                'rank_max' => data['page_rank_max']
+              }
+
+              Nucleo::Models::PageRank.new(params)
+            end
+
+            # Returns the number of page views
+            #
+            # @return [Integer]
+            def page_views
+              data['page_views'].to_i
+            end
+            alias :pageviews :page_views
+
+            # Returns the count of issues (children recommendations)
+            #
+            # @return [Integer]
+            def issue_count
+              data['issue_count'].to_i
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require File.expand_path('../../../base', __FILE__)
+
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Site
+
+          class Base < Nucleo::Models::FeedTypes::Base
+            # Returns the count of checks
+            #
+            # @return [Array]
+            def count
+              data['count']
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Site
+
+          class ImgAlt < Nucleo::Models::FeedTypes::Seo::Site::Base
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Site
+
+          class MetaDescription < Nucleo::Models::FeedTypes::Seo::Site::Base
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Site
+
+          class MetaRobots < Nucleo::Models::FeedTypes::Seo::Site::Base
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Nucleo
+  module Models
+    module FeedTypes
+      module Seo
+        module Site
+
+          class PageTitle < Nucleo::Models::FeedTypes::Seo::Site::Base
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/feeds.rb

@@ -0,0 +1,126 @@
+require File.expand_path('../feed', __FILE__)
+require File.expand_path('../../requests/feed', __FILE__)
+
+module Nucleo
+  module Models
+    class Feeds
+      include Enumerable
+
+      # Return an instance of the Feeds Collection domain model
+      #
+      # @param collection [Array]
+      #
+      # @return [Nucleo::Models::Feeds]
+      def initialize(collection)
+        @collection = Array(collection)
+      end
+
+      # Retrieve a record by the ID.
+      #
+      # @return [Nucleo::Models::Feed, nil]
+      def find_by_id(id)
+        self.find { |record| record.id == id.to_s }
+      end
+
+      # Returns only SEO category items
+      #
+      # @return [Array]
+      def seo_category
+        self.select(&:seo_category?)
+      end
+
+      # Returns only the Analytics category items
+      #
+      # @return [Array]
+      def analytics_category
+        self.select(&:analytics_category?)
+      end
+
+      # Returns only the page context items
+      #
+      # @return [Array]
+      def page_context
+        self.select(&:page_context?)
+      end
+
+      # REturns only the site context items
+      #
+      # @return [Array]
+      def site_context
+        self.select(&:site_context?)
+      end
+
+      # Returns all records that match the site id
+      #
+      # @return [Array]
+      def find_all_by_site_id(id)
+        self.select { |record| record.site_id == id.to_i }
+      end
+
+      # Returns all records that match the category name
+      #
+      # @return [Array]
+      def find_all_by_category_name(name)
+        self.select { |record| record.category_name == name.to_s }
+      end
+
+      # Returns all records that match the type name
+      #
+      # @return [Array]
+      def find_all_by_type_name(name)
+        self.select { |record| record.type_name == name.to_s }
+      end
+
+      # Returns all records that match the status name
+      #
+      # @return [Array]
+      def find_all_by_status_name(name)
+        self.select { |record| record.status_name == name.to_s }
+      end
+
+      # Retrieve a feed with the specified params and return
+      # the model as an instance of Feeds.
+      #
+      # @param site_id [String,Integer] The ID of the site for the feed
+      # @param max_feed_items [Integer] Max number of feed items
+      #
+      # @return [Nucleo::Models::Feeds]
+      def self.retrieve(site_id, params={})
+        response_body = Nucleo::Requests::Feed.retrieve(site_id, params)
+
+        self.new(response_body)
+      end
+
+      def each(&block)
+        internal_collection.each(&block)
+      end
+
+      # Delegate sample to the array
+      #
+      # @todo: Ensure this delegates properly
+      #
+      # @return [Array]
+      def sample(n)
+        self.to_a.sample(n)
+      end
+
+      private
+      def internal_collection
+        core_collection = []
+        @collection.inject(core_collection) do |collection,record|
+          const_name = ['nucleo', 'models', 'feed_types', record['category'], record['context'], record['type']].map(&:camelcase).join('::')
+
+          begin
+            collection.push(Object.const_get(const_name).new(record))
+          rescue
+            Nucleo::Client.configuration.logger.fatal("Could not instantiate %s" % [const_name])
+          end
+
+          collection
+        end
+
+        Array(core_collection)
+      end
+    end
+  end
+end

data/lib/nucleo/models/metric.rb

@@ -0,0 +1,54 @@
+require File.expand_path('../metric_periods', __FILE__)
+
+module Nucleo
+  module Models
+    class Metric
+      # Returns an instance of the Metric domain model. This is
+      # the core domain model for a specific metric `type` and
+      # `classification`.
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::Metric]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the classification of the metric
+      #
+      # @return [String]
+      def classification
+        @attributes['classification']
+      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 periods used for comparison
+      #
+      # @return [Nucleo::Models::MetricPeriods]
+      def metric_periods
+        params = {
+          'metric'         => self.metric,
+          'dimension'      => self.dimension,
+          'totals'         => @attributes['totals'],
+          'current_period' => @attributes['current_period'],
+          'prior_period'   => @attributes['prior_period']
+        }
+
+        Nucleo::Models::MetricPeriods.new(params)
+      end
+    end
+  end
+end