nucleo-client 0.1.0

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

@@ -0,0 +1,25 @@
+module Nucleo
+  module Models
+    module CheckTypes
+      class Base
+        include Comparable
+
+        # Return an instance of the Rule Type domain model
+        #
+        # @param attributes [Hash]
+        #
+        # @return [Nucleo::Models::RuleType::Base]
+        def initialize(attributes={})
+          @attributes = attributes
+        end
+
+        # Returns the elements in the rule
+        #
+        # @return [String]
+        def elements
+          Nucleo::Models::Elements.new(@attributes['elements'])
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/check_types/count.rb

@@ -0,0 +1,26 @@
+module Nucleo
+  module Models
+    module CheckTypes
+      class Count < Nucleo::Models::CheckTypes::Base
+
+        def type
+          'count'
+        end
+
+        # Returns the min allowed count
+        #
+        # @return [String]
+        def min_count
+          Integer(@attributes['min_count'])
+        end
+
+        # Returns the max allowed count
+        #
+        # @return [String]
+        def max_count
+          Integer(@attributes['max_count'])
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/check_types/length.rb

@@ -0,0 +1,26 @@
+module Nucleo
+  module Models
+    module CheckTypes
+      class Length < Nucleo::Models::CheckTypes::Base
+
+        def type
+          'length'
+        end
+
+        # Returns the min allowed length
+        #
+        # @return [String]
+        def min_length
+          Integer(@attributes['min_length'])
+        end
+
+        # Returns the max allowed length
+        #
+        # @return [String]
+        def max_length
+          Integer(@attributes['max_length'])
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/check_types/not_exists.rb

@@ -0,0 +1,8 @@
+module Nucleo
+  module Models
+    module CheckTypes
+      class NotExists < Nucleo::Models::CheckTypes::Base
+      end
+    end
+  end
+end

data/lib/nucleo/models/checks.rb

@@ -0,0 +1,56 @@
+module Nucleo
+  module Models
+    class Checks
+      include Enumerable
+
+      # Return an instance of the Rules collection domain model
+      #
+      # @param collection [Array]
+      #
+      # @return [Nucleo::Models::Changes]
+      def initialize(collection)
+        @collection = Array(collection)
+      end
+
+      def each(&block)
+        internal_collection.each(&block)
+      end
+
+      # Retrieve a check by type
+      #
+      # @return [Nucleo::Models::ChangeType]
+      def find_by_type(type)
+        self.find { |record| record.type == type }
+      end
+
+      def find_content
+        content = self.collect { |r| r.elements.find_content }.flatten.first
+        return "" if content.blank?
+
+        content
+      end
+
+      def find_image_src
+        self.collect { |r| r.elements.find_image_src }.flatten
+      end
+
+      private
+      def internal_collection
+        core_collection = []
+
+        @collection.inject(core_collection) do |collection,record|
+          begin
+            const_name = ['nucleo', 'models', 'check_types', record['check']].map(&:camelcase).join('::')
+            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/concerns.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../concerns/count', __FILE__)
+require File.expand_path('../concerns/length', __FILE__)
+
+module Nucleo
+  module Concerns
+  end
+end

data/lib/nucleo/models/concerns/count.rb

@@ -0,0 +1,57 @@
+module Nucleo
+  module Models
+    module Concerns
+      class Count
+        attr_reader :count, :min, :max
+
+        # Returns an instance of the Count concern domain model
+        #
+        # @param total [Integer]
+        # @param min [Integer]
+        # @param max [Integer]
+        #
+        # @return [Nucleo::Concerns::Count]
+        def initialize(count, min, max)
+          @count = count.to_i
+          @min   = min.to_i
+          @max   = max.to_i
+        end
+
+        # Returns true if missing
+        #
+        # @return [Boolean]
+        def missing?
+          (self.count < 1)
+        end
+
+        # Returns true if multiple
+        #
+        # @return [Boolean]
+        def multiple?
+          (self.count > 1)
+        end
+
+        # Returns true if too few
+        #
+        # @return [Boolean]
+        def too_few?
+          (self.count < self.min)
+        end
+
+        # Returns true if there is a max
+        #
+        # @return [Boolean]
+        def max?
+          (self.max > 0)
+        end
+
+        # Returns true if there is too many
+        #
+        # @return [Boolean]
+        def too_many?
+          (self.max? && (self.count > self.max))
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/concerns/length.rb

@@ -0,0 +1,57 @@
+module Nucleo
+  module Models
+    module Concerns
+      class Length
+        attr_reader :length, :min, :max
+
+        # Returns an instance of the Length concern domain model
+        #
+        # @param length [Integer]
+        # @param min [Integer]
+        # @param max [Integer]
+        #
+        # @return [Nucleo::Concerns::Length]
+        def initialize(length, min, max)
+          @length = length.to_i
+          @min    = min.to_i
+          @max    = max.to_i
+        end
+
+        # Returns true if there is a max
+        #
+        # @return [Boolean]
+        def max?
+          (self.max > 0)
+        end
+
+        # Returns true if too short
+        #
+        # @return [Boolean]
+        def too_short?
+          (self.length <= self.min)
+        end
+
+        # Returns the too short length
+        #
+        # @return [Integer]
+        def too_short_length
+          (self.min - self.length)
+        end
+
+        # Returns true if too long
+        #
+        # @return [Boolean]
+        def too_long?
+          (self.max? && (self.length > self.max))
+        end
+
+        # Returns the too long length
+        #
+        # @return [Integer]
+        def too_long_length
+          (self.length - self.max)
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/date_range.rb

@@ -0,0 +1,66 @@
+module Nucleo
+  module Models
+    class DateRange
+      # Returns an instance of the DateRange domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::DateRange]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      # Returns the inclusive days for this range
+      #
+      # @return [Integer]
+      def days
+        return nil unless both_dates?
+
+        ((self.end_date - self.start_date) + 1).to_i
+      end
+
+      # Returns the start date
+      #
+      # @return [Date,nil]
+      def start_date
+        begin
+          Date.parse(start_date_value)
+        rescue
+          nil
+        end
+      end
+
+      # Returns the end date
+      #
+      # @return [Date,nil]
+      def end_date
+        begin
+          Date.parse(end_date_value)
+        rescue
+          nil
+        end
+      end
+
+      private
+      def start_date_value
+        @attributes['startDate']
+      end
+
+      def start_date_value?
+        !start_date_value.nil?
+      end
+
+      def end_date_value
+        @attributes['endDate']
+      end
+
+      def end_date_value?
+        !end_date_value.nil?
+      end
+
+      def both_dates?
+        start_date_value? && end_date_value?
+      end
+    end
+  end
+end

data/lib/nucleo/models/element.rb

@@ -0,0 +1,40 @@
+module Nucleo
+  module Models
+    class Element
+      include Comparable
+
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      def content
+        @attributes.fetch('content', '')
+      end
+
+      def src
+        @attributes.fetch('src', '')
+      end
+
+      def alt
+        @attributes.fetch('alt', '')
+      end
+
+      def content_length
+        self.content.length
+      end
+
+      def content_empty?
+        self.content.empty?
+      end
+
+      def content_present?
+        self.content.present?
+      end
+
+      def html
+        @attributes.fetch('html', '')
+      end
+
+    end
+  end
+end

data/lib/nucleo/models/elements.rb

@@ -0,0 +1,47 @@
+module Nucleo
+  module Models
+    class Elements
+      include Enumerable
+
+      # Return an instance of the Rules collection domain model
+      #
+      # @param collection [Array]
+      #
+      # @return [Nucleo::Models::Changes]
+      def initialize(collection)
+        @collection = Array(collection)
+      end
+
+      def each(&block)
+        internal_collection.each(&block)
+      end
+
+      def find_content
+        self.collect { |r| r.content if r.content_present? }
+      end
+
+      def find_image_src
+        self.collect { |r| r.image_src if r.image? }
+      end
+
+      private
+      def internal_collection
+        core_collection = []
+
+        @collection.inject(core_collection) do |collection,record|
+          const_name = ['nucleo', 'models', 'element'].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/feed.rb

@@ -0,0 +1,141 @@
+require File.expand_path('../page', __FILE__)
+
+module Nucleo
+  module Models
+    class Feed
+      include Comparable
+
+      # Return an instance of the Feed domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::Feed]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      def self.for_record(attributes={})
+        const_name = ['nucleo', 'models', 'feed_types', attributes['category'], attributes['type']].map(&:camelcase).join('::')
+
+        record = nil
+
+        begin
+          record = Object.const_get(const_name).new(attributes)
+        rescue
+          Nucleo::Client.configuration.logger.fatal("Could not instantiate %s" % [const_name])
+        end
+
+        record
+      end
+
+      # Sort by the executed at attribute
+      def <=>(other)
+        self.executed_at <=> other.executed_at
+      end
+
+      # Returns the page id
+      #
+      # @return [String]
+      def page_id
+        @attributes['page_id']
+      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?
+
+        value.merge!('id' => self.page_id)
+
+        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 ID of this recommendation
+      #
+      # @return [String]
+      def id
+        (self.page_recommendation_id || self.site_analytic_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
+    end
+  end
+end