nucleo-client 0.1.0

data/lib/nucleo/connection.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'faraday/detailed_logger'
+require 'faraday_middleware'
+require 'delegate'
+
+module Nucleo
+  class Connection < SimpleDelegator
+
+    # Decorating the Faraday object
+    #
+    # @return [Nucleo::Connection ] Faraday Conection Delegator
+    def initialize(url, &block)
+      @_connection = Faraday.new(url, &block)
+    end
+
+    # Return the Net::HTTP default adapter from Faraday
+    #
+    # @return [Symbol] Default Adapter
+    def self.default_adapter
+      Faraday.default_adapter
+    end
+
+    # Faraday does not provide an HTTP OPTIONS call. Its
+    # core library utilizes `options` for RequestOptions.
+    #
+    # This allows us to perform an HTTP options request
+    #
+    # @param url [String] The URL for the request
+    # @param params [Hash] Request parameters to send
+    # @param headers [Hash] Request headers to send
+    #
+    # @return [Faraday::Response] Faraday Response
+    def http_options(url=nil, params=nil, headers=nil)
+      @_connection.run_request(:options, url, params, headers)
+    end
+
+    # Specify the class for the Delegator
+    #
+    # @return [Faraday]
+    def __getobj__
+      @_connection
+    end
+  end
+end

data/lib/nucleo/errors.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../errors/record_not_found', __FILE__)
+require File.expand_path('../errors/invalid_uri_error', __FILE__)
+
+module Nucleo
+  module Errors
+  end
+end

data/lib/nucleo/errors/invalid_uri_error.rb

@@ -0,0 +1,6 @@
+module Nucleo
+  module Errors
+    class InvalidUriError < StandardError
+    end
+  end
+end

data/lib/nucleo/errors/record_not_found.rb

@@ -0,0 +1,6 @@
+module Nucleo
+  module Errors
+    class RecordNotFound < StandardError
+    end
+  end
+end

data/lib/nucleo/logger.rb

@@ -0,0 +1,36 @@
+require 'delegate'
+require 'logger'
+
+module Nucleo
+  class Logger < SimpleDelegator
+    DEFAULT_PROGNAME = "NUCLEO_API_CLIENT"
+
+    def initialize(name, shift_age=7, shift_size=1048576)
+      @_logger = ::Logger.new(name, shift_age, shift_size)
+    end
+
+    def warn(progname = nil, &block)
+      @_logger.warn((progname || DEFAULT_PROGNAME), &block)
+    end
+
+    def debug(progname = nil, &block)
+      @_logger.debug((progname || DEFAULT_PROGNAME), &block)
+    end
+
+    def fatal(progname = nil, &block)
+      @_logger.fatal((progname || DEFAULT_PROGNAME), &block)
+    end
+
+    def error(progname = nil, &block)
+      @_logger.error((progname || DEFAULT_PROGNAME), &block)
+    end
+
+    def info(progname = nil, &block)
+      @_logger.info((progname || DEFAULT_PROGNAME), &block)
+    end
+
+    def __getobj__
+      @_logger
+    end
+  end
+end

data/lib/nucleo/models.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../models/site_feed', __FILE__)
+require File.expand_path('../models/page_alerts', __FILE__)
+
+require File.expand_path('../models/feeds', __FILE__)
+require File.expand_path('../models/feed', __FILE__)
+
+require File.expand_path('../models/changes', __FILE__)
+require File.expand_path('../models/change_types', __FILE__)
+
+require File.expand_path('../models/checks', __FILE__)
+require File.expand_path('../models/check_types', __FILE__)
+require File.expand_path('../models/elements', __FILE__)
+require File.expand_path('../models/element', __FILE__)
+
+require File.expand_path('../models/date_range', __FILE__)
+
+require File.expand_path('../models/pages', __FILE__)
+require File.expand_path('../models/page', __FILE__)
+require File.expand_path('../models/page_metric', __FILE__)
+
+require File.expand_path('../models/tags', __FILE__)
+require File.expand_path('../models/tag', __FILE__)
+
+require File.expand_path('../models/metric', __FILE__)
+
+require File.expand_path('../models/metric_period_totals', __FILE__)
+require File.expand_path('../models/metric_periods_totals', __FILE__)
+
+require File.expand_path('../models/metric_period', __FILE__)
+require File.expand_path('../models/metric_periods', __FILE__)
+
+require File.expand_path('../models/metric_periods_comparisons', __FILE__)
+require File.expand_path('../models/metric_periods_comparison', __FILE__)
+
+require File.expand_path('../models/metric_period_rows', __FILE__)
+require File.expand_path('../models/metric_period_row', __FILE__)
+
+require File.expand_path('../models/seo_score', __FILE__)
+require File.expand_path('../models/page_rank', __FILE__)
+
+require File.expand_path('../models/feed_types', __FILE__)
+
+require File.expand_path('../models/check_js', __FILE__)
+
+require File.expand_path('../models/concerns', __FILE__)
+
+module Nucleo
+  module Models
+  end
+end

data/lib/nucleo/models/change_types.rb

@@ -0,0 +1,10 @@
+require File.expand_path('../change_types/base', __FILE__)
+
+require File.expand_path('../change_types/seo', __FILE__)
+
+module Nucleo
+  module Models
+    module ChangeTypes
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+module Nucleo
+  module Models
+    module ChangeTypes
+      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
+
+        def <=>(other)
+          self.created_at <=> other.created_at
+        end
+
+        # Returns the ID of the rule
+        #
+        # @return [String]
+        def id
+          @attributes['id']
+        end
+
+        # Returns the associated site id
+        #
+        # @return [String]
+        def site_id
+          @attributes['site_id']
+        end
+
+        # Returns the associated page id
+        #
+        # @return [String]
+        def page_id
+          @attributes['page_id']
+        end
+
+        # Returns the context of the rule
+        #
+        # @return [String]
+        def context
+          @attributes['context']
+        end
+
+        # Returns the category of the rule
+        #
+        # @return [String]
+        def category
+          @attributes['category']
+        end
+
+        # Returns the type of the rule
+        #
+        # @return [String]
+        def type
+          @attributes['type']
+        end
+
+        # Returns the created at timestamp
+        # of the rule.
+        #
+        # @return [DateTime]
+        def created_at
+          begin
+            DateTime.parse(@attributes['created_at'])
+          rescue
+            nil
+          end
+        end
+
+        protected
+        def rule
+          @attributes.fetch('rule', {})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require File.expand_path('../../change_types/seo/base', __FILE__)
+
+require File.expand_path('../../change_types/seo/page_title', __FILE__)
+require File.expand_path('../../change_types/seo/meta_description', __FILE__)
+
+module Nucleo
+  module Models
+    module RuleTypes
+      module Seo
+      end
+    end
+  end
+end

data/lib/nucleo/models/change_types/seo/base.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../../../change_types/base', __FILE__)
+
+module Nucleo
+  module Models
+    module ChangeTypes
+      module Seo
+        class Base < Nucleo::Models::ChangeTypes::Base
+          VALID_ACTIONS   = %w( insert update remove ).freeze
+          VALID_SELECTORS = %w( class content id name src ).freeze
+
+          # Returns the action
+          #
+          # @return [String]
+          def action
+            rule['action']
+          end
+
+          # Returns the content to insert/replace
+          #
+          # @return [String]
+          def content
+            rule['content']
+          end
+
+          # Returns the selector
+          #
+          # @return [String]
+          def selector
+            rule['selector']
+          end
+
+          # Returns a string value that uniquely identifies
+          # and item by the `selector` provided.
+          #
+          # @return [String]
+          def selector_content
+            rule['selector_content']
+          end
+
+          # Returns the string value of the content to be replaced
+          #
+          # @return [String]
+          def content
+            rule['content']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/change_types/seo/meta_description.rb

@@ -0,0 +1,10 @@
+module Nucleo
+  module Models
+    module ChangeTypes
+      module Seo
+        class MetaDescription < Nucleo::Models::ChangeTypes::Seo::Base
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/change_types/seo/page_title.rb

@@ -0,0 +1,10 @@
+module Nucleo
+  module Models
+    module ChangeTypes
+      module Seo
+        class PageTitle < Nucleo::Models::ChangeTypes::Seo::Base
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/models/changes.rb

@@ -0,0 +1,50 @@
+module Nucleo
+  module Models
+    class Changes
+      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 push(args)
+        @collection.push(args)
+      end
+
+      # Retrieve a rule by the ID.
+      #
+      # @return [Nucleo::Models::ChangeType]
+      def find_by_id(id)
+        self.find { |record| record.id == id.to_s }
+      end
+
+      private
+      def internal_collection
+        core_collection = []
+
+        @collection.inject(core_collection) do |collection,record|
+          const_name = ['nucleo', 'models', 'change_types', record['category'], 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/check_js.rb

@@ -0,0 +1,41 @@
+
+module Nucleo
+  module Models
+    class CheckJS
+      # Returns an instanc eof the Site Feed domain model
+      #
+      # @param attributes [Hash]
+      #
+      # @return [Nucleo::Models::SiteFeed]
+      def initialize(attributes={})
+        @attributes = attributes
+      end
+
+      def self.check_js(url)
+        response_body = Nucleo::Requests::CheckJS.retrieve({url: url})
+
+        self.new(response_body)
+      end
+
+      def body?
+        @attributes.fetch("body")
+      end
+
+      def head?
+        @attributes.fetch("head")
+      end
+
+      def other?
+        @attributes.fetch("other")
+      end
+
+      def installed?
+        @attributes.fetch("installed")
+      end
+
+      def installed_correctly?
+        self.head? and not (self.body? or self.other?)
+      end
+    end
+  end
+end

data/lib/nucleo/models/check_types.rb

@@ -0,0 +1,11 @@
+require File.expand_path('../check_types/base', __FILE__)
+require File.expand_path('../check_types/count', __FILE__)
+require File.expand_path('../check_types/not_exists', __FILE__)
+require File.expand_path('../check_types/length', __FILE__)
+
+module Nucleo
+  module Models
+    module CheckTypes
+    end
+  end
+end