nucleo-client 0.1.0

data/lib/nucleo/requests/page_alerts.rb

@@ -0,0 +1,36 @@
+module Nucleo
+  module Requests
+    class PageAlerts
+      def self.retrieve(site_id, params={})
+        type = params.fetch(:type)
+
+        route = Nucleo::Client.routes.route_for('site-page-alerts')
+        url   = route.url_for(site_id: site_id, type: type)
+
+        request = Nucleo::Client.get(url)
+
+        request.on(:success) do |resp|
+          response_body = resp.body
+
+          return response_body
+        end
+
+        request.on(:failure) do |resp|
+          Nucleo::Client.configuration.logger.error do
+            "App Error: %s" % [resp.body]
+          end
+
+          return nil
+        end
+
+        request.on(:server_error) do |resp|
+          Nucleo::Client.configuration.logger.error do
+            "Server Error: %s" % [resp.body]
+          end
+
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/requests/page_changes.rb

@@ -0,0 +1,44 @@
+module Nucleo
+  module Requests
+    class PageChanges
+      def self.create(site_id, page_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id, page_id: page_id)
+
+        request_params = attributes
+
+        request = Nucleo::Client.post(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.update(site_id, page_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id, page_id: page_id)
+
+        request = Nucleo::Client.patch(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.delete(site_id, page_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id, page_id: page_id)
+
+        request = Nucleo::Client.delete(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.index(site_id, page_id)
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id, page_id: page_id)
+
+        request = Nucleo::Client.get(url)
+
+        request
+      end
+
+    end
+  end
+end

data/lib/nucleo/requests/site.rb

@@ -0,0 +1,26 @@
+module Nucleo
+  module Requests
+    class Site
+      def self.register(attributes={})
+        route = Nucleo::Client.routes.route_for('sites')
+        url   = route.url_for
+
+        request_params = attributes
+
+        request = Nucleo::Client.post(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.process(site_id)
+        route = Nucleo::Client.routes.route_for('site-process')
+        url   = route.url_for(id: site_id)
+
+        request = Nucleo::Client.get(url)
+
+        request
+      end
+
+    end
+  end
+end

data/lib/nucleo/requests/site_changes.rb

@@ -0,0 +1,56 @@
+module Nucleo
+  module Requests
+    class SiteChanges
+      def self.create(site_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id)
+
+        request_params = attributes
+
+        request = Nucleo::Client.post(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.batch(site_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-changes-batch')
+        url   = route.url_for(site_id: site_id)
+        request_params = attributes
+
+        request = Nucleo::Client.post(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.update(site_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id)
+        request_params = attributes
+
+        request = Nucleo::Client.patch(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.delete(site_id, attributes={})
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id)
+        request_params = attributes
+
+        request = Nucleo::Client.delete(url, MultiJson.dump(request_params))
+
+        request
+      end
+
+      def self.index(site_id)
+        route = Nucleo::Client.routes.route_for('site-page-changes')
+        url   = route.url_for(site_id: site_id)
+
+        request = Nucleo::Client.get(url)
+
+        request
+      end
+
+    end
+  end
+end

data/lib/nucleo/requests/site_feed.rb

@@ -0,0 +1,41 @@
+module Nucleo
+  module Requests
+    class SiteFeed
+      def self.retrieve(id, params={})
+        included_models = params.fetch(:includes, [])
+        includes        = "[%s]" % [included_models.join(';')]
+
+        route = Nucleo::Client.routes.route_for('site')
+        url   = route.url_for(id: id, includes: includes)
+
+        request = Nucleo::Client.get(url)
+
+        request.on(:success) do |resp|
+          response_body = resp.body
+
+          if response_body.has_key?('pages') && response_body['pages'].kind_of?(Array)
+            response_body.merge!({ 'pages' => {} })
+          end
+
+          return response_body
+        end
+
+        request.on(:failure) do |resp|
+          Nucleo::Client.configuration.logger.error do
+            "App Error: %s" % [resp.body]
+          end
+
+          return nil
+        end
+
+        request.on(:server_error) do |resp|
+          Nucleo::Client.configuration.logger.error do
+            "Server Error: %s" % [resp.body]
+          end
+
+          return nil
+        end
+      end
+    end
+  end
+end

data/lib/nucleo/response.rb

@@ -0,0 +1,52 @@
+require File.expand_path('../utilities/status_code_mapper', __FILE__)
+require 'faraday_middleware'
+require 'delegate'
+
+module Nucleo
+  class Response < SimpleDelegator
+
+    def initialize(response)
+      @_response = response
+    end
+
+    # Returns true if the method is allowed
+    #
+    # @return [Boolean]
+    def allowed?(method)
+      self.allowed_methods.include?(method.upcase)
+    end
+
+    def on(*statuses, &block)
+      status_code_mapper = Nucleo::Utilities::StatusCodeMapper.new(statuses)
+
+      return unless status_code_mapper.includes?(@_response.status)
+
+      if block_given?
+        yield(self) and return
+      else
+        self
+      end
+    end
+
+    # Specify the class for Simple Delegator
+    #
+    # @return [Faraday::Response]
+    def __getobj__
+      @_response
+    end
+
+    # Extracts the ALLOW header from the HTTP Response
+    #
+    # @return [String]
+    def allow_header
+      self.headers.fetch('allow', '')
+    end
+
+    # Returns an array of allowed methods
+    #
+    # @return [Array]
+    def allowed_methods
+      self.allow_header.split(',').map(&:strip).map(&:upcase)
+    end
+  end
+end

data/lib/nucleo/utilities.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../utilities/status_code_mapper', __FILE__)
+
+module Nucleo
+  module Utilities
+  end
+end
+

data/lib/nucleo/utilities/status_code_mapper.rb

@@ -0,0 +1,53 @@
+module Nucleo
+  module Utilities
+    class StatusCodeMapper
+      STATUS_MAP = {
+        :failure      => (400...500),
+        :redirect     => (300...400),
+        :success      => (200...300),
+        :server_error => (500...600)
+      }
+
+      # Returns a utility object to map HTTP
+      # status codes to their corresponding
+      # ranges
+      #
+      # @param statuses [Array] Symbols or status codes
+      #
+      # @return [Nucleo::StatusCodeMapper] Instance of the object
+      def initialize(*statuses)
+        @statuses = Array(statuses).flatten
+      end
+
+      # Returns a collection of all available codes
+      #
+      # This merges the STATUS_MAP with specified codes
+      #
+      # @return [Array] Collection of status codes
+      def codes
+        all_codes = []
+        @statuses.inject(all_codes) do |collection,status|
+          if status.is_a?(Symbol)
+            collection.concat(STATUS_MAP[status].to_a)
+          else
+            collection.concat([status.to_i])
+          end
+
+          collection
+        end
+
+        Set.new(all_codes).to_a
+      end
+
+      # Checks to see if the codes includes a specific code
+      #
+      # @param code [String,Integer] An HTTP code
+      #
+      # @return [Boolean]
+      def includes?(code)
+        self.codes.include?(code.to_i)
+      end
+    end
+  end
+end
+

data/lib/nucleo/webhook.rb

@@ -0,0 +1,26 @@
+module Nucleo
+  class Webhook
+    # Registers a new site.  Responds true or false if the webhook was successful.
+    #
+    # @param Hash :site  (dump of Site model expected)
+    #
+    # @return [Boolean]
+    def self.register_site(site)
+      method = :post
+      path = 'sites'
+
+      # Convert id into site_id (as expected from Site model)
+      site['site_id'] = site['id']
+
+      body = site.to_json
+
+      begin
+        response = Nucleo::request(method, path, body)
+      rescue NucleoRequestError => e
+        print e.message
+      end
+
+      response
+    end
+  end
+end

data/nucleo-client.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nucleo/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nucleo-client"
+  spec.version       = Nucleo::Client::VERSION
+  spec.authors       = ["Nate Klaiber"]
+  spec.email         = ["nate@deviceindependent.com"]
+  spec.summary       = %q{ Ruby client for interacting with the Nucleo service.}
+  spec.description   = %q{ Ruby client for interacting with the Nucleo service.}
+  spec.homepage      = "https://github.com/quicksprout/ruby-nucleo-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("bundler", "~> 1.7")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("terminal-table")
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("yard")
+  spec.add_development_dependency("webmock")
+
+  spec.add_dependency('faraday')
+  spec.add_dependency('faraday_middleware')
+  spec.add_dependency('faraday-detailed_logger')
+  spec.add_dependency('multi_json')
+  spec.add_dependency('dotenv')
+  spec.add_dependency('addressable')
+  spec.add_dependency('restless_router')
+end

data/spec/data/models/feed_types/seo/heading_tag_length.json

@@ -0,0 +1,55 @@
+{
+  "category": "seo",
+  "page_recommendation_id": "e968f4ca1eba27230ec501d68e843b3ed87bfcc9d8a2e17757e166ad0b302661",
+  "data": {
+    "min_length": 15,
+    "identified_at": "2016-10-11T04:05:57.444550",
+    "tags": [
+      {
+      "content_length": 73,
+      "full_tag": "<h3>Liking other people&#8217;s photos generates more followers and likes for you</h3>\n",
+      "tag_content": "Liking other people’s photos generates more followers and likes for you"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<h3>Conclusion</h3>\n",
+      "tag_content": "Conclusion"
+    },
+    {
+      "content_length": 8,
+      "full_tag": "<h3>Comments</h3>",
+      "tag_content": "Comments"
+    },
+    {
+      "content_length": 78,
+      "full_tag": "<h3><strong>Free Course:</strong> \"Double Your Traffic<br /> in 30 Days\" <strong>+ Secret Bonus</strong> <br /> (Valued at $300)</h3>\n\t\t\n\t\t",
+      "tag_content": "Free Course: \"Double Your Traffic in 30 Days\" + Secret Bonus  (Valued at $300)"
+    },
+    {
+      "content_length": 6,
+      "full_tag": "<h4 class=\"widget-title widgettitle\">Search</h4>\n",
+      "tag_content": "Search"
+    },
+    {
+      "content_length": 9,
+      "full_tag": "<h4 class=\"widget-title widgettitle\">Subscribe</h4>\n\t\t\t",
+      "tag_content": "Subscribe"
+    }
+    ],
+    "last_checked_at": "2016-10-11T04:05:57.444582",
+    "points": 1,
+    "max_length": 65
+  },
+  "site_id": 292,
+  "executed_at": "2016-10-11T04:05:57.444620",
+  "status": "unresolved",
+  "context": "page",
+  "page_id": "2fe54e1ad6fc42ea86b804dd376e30763efbe53f981d14b2f40ccdf857e749ea",
+  "type": "heading_tag_length",
+  "page": {
+    "path": "/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes",
+    "hostname": "www.quicksprout.com",
+    "id": "2fe54e1ad6fc42ea86b804dd376e30763efbe53f981d14b2f40ccdf857e749ea",
+    "title": "The Science of Instagram: How to Get More Followers and Likes"
+  }
+}

data/spec/data/models/feed_types/seo/internal_link_count.json

@@ -0,0 +1,149 @@
+{
+  "category": "seo",
+  "page_recommendation_id": "defab3f6a1957c3a3d710c0c7f21a8ede8f07768329e211c32961bcb64aec439",
+  "data": {
+    "count": 1316,
+    "identified_at": "2016-10-11T04:05:59.221997",
+    "tags": [
+      {
+      "content_length": 12,
+      "full_tag": "<a href=\"https://www.quicksprout.com/\">Quick Sprout</a>",
+      "tag_content": "Quick Sprout"
+    },
+    {
+      "content_length": 4,
+      "full_tag": "<a href=\"https://www.quicksprout.com/blog/\">Blog</a>",
+      "tag_content": "Blog"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"https://www.quicksprout.com/pro/\">Start Here</a>",
+      "tag_content": "Start Here"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"http://www.quicksprout.com/pro/\">Consulting</a>",
+      "tag_content": "Consulting"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a title=\"University\" href=\"http://www.quicksprout.com/university/\">University</a>",
+      "tag_content": "University"
+    },
+    {
+      "content_length": 7,
+      "full_tag": "<a href=\"https://www.quicksprout.com/webinar/\">Webinar</a>",
+      "tag_content": "Webinar"
+    },
+    {
+      "content_length": 7,
+      "full_tag": "<a title=\"Contact\" href=\"https://www.quicksprout.com/contact/\">Contact</a>",
+      "tag_content": "Contact"
+    },
+    {
+      "content_length": 68,
+      "full_tag": "<a href=\"http://www.quicksprout.com/2007/10/24/the-difference-between-marketing-pr-advertising-and-personal-branding/\">personal brand</a>, but you can use it to promote your business as well.",
+      "tag_content": "personal brand, but you can use it to promote your business as well."
+    },
+    {
+      "full_tag": "<a href=\"#\" onclick=\"javascript: document.getElementById('YesGiveMe').submit(); return false;\"></a>"
+    },
+    {
+      "content_length": 28,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-137898\">November 19, 2012 at 8:02 AM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "November 19, 2012 at 8:02 AM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=137898#respond\" onclick=\"return addComment.moveForm( &quot;comment-137898&quot;, &quot;137898&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Leith\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"http://www.quicksprout.com\" rel=\"external nofollow\" class=\"url\">Neil Patel</a>",
+      "tag_content": "Neil Patel"
+    },
+    {
+      "content_length": 28,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-137942\">November 19, 2012 at 5:47 PM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "November 19, 2012 at 5:47 PM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=137942#respond\" onclick=\"return addComment.moveForm( &quot;comment-137942&quot;, &quot;137942&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Neil Patel\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 28,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-137991\">November 19, 2012 at 8:41 PM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "November 19, 2012 at 8:41 PM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=137991#respond\" onclick=\"return addComment.moveForm( &quot;comment-137991&quot;, &quot;137991&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Lorna\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"http://www.quicksprout.com\" rel=\"external nofollow\" class=\"url\">Neil Patel</a>",
+      "tag_content": "Neil Patel"
+    },
+    {
+      "content_length": 29,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-137998\">November 19, 2012 at 10:39 PM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "November 19, 2012 at 10:39 PM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=137998#respond\" onclick=\"return addComment.moveForm( &quot;comment-137998&quot;, &quot;137998&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Neil Patel\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"http://www.quicksprout.com\" rel=\"external nofollow\" class=\"url\">Neil Patel</a>",
+      "tag_content": "Neil Patel"
+    },
+    {
+      "content_length": 24,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-214516\">April 7, 2013 at 9:42 PM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "April 7, 2013 at 9:42 PM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=214516#respond\" onclick=\"return addComment.moveForm( &quot;comment-214516&quot;, &quot;214516&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Neil Patel\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 27,
+      "full_tag": "<a href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/#comment-2461656\">February 4, 2016 at 3:39 PM</a>&#13;\n\t\t\t\t\t\t\t",
+      "tag_content": "February 4, 2016 at 3:39 PM"
+    },
+    {
+      "content_length": 5,
+      "full_tag": "<a rel=\"nofollow\" class=\"comment-reply-link\" href=\"https://www.quicksprout.com/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes/?replytocom=2461656#respond\" onclick=\"return addComment.moveForm( &quot;comment-2461656&quot;, &quot;2461656&quot;, &quot;respond&quot;, &quot;6201&quot; )\" aria-label=\"Reply to Annamonnika\">Reply</a>\t\t",
+      "tag_content": "Reply"
+    },
+    {
+      "content_length": 10,
+      "full_tag": "<a href=\"http://www.quicksprout.com\" rel=\"external nofollow\" class=\"url\">Neil Patel</a>",
+      "tag_content": "Neil Patel"
+    }
+    ],
+    "last_checked_at": "2016-10-11T04:05:59.222022",
+    "max_count": 100,
+    "points": 5,
+    "min_count": 5
+  },
+  "site_id": 292,
+  "executed_at": "2016-10-11T04:05:59.222055",
+  "status": "unresolved",
+  "context": "page",
+  "page_id": "2fe54e1ad6fc42ea86b804dd376e30763efbe53f981d14b2f40ccdf857e749ea",
+  "type": "internal_link_count",
+  "page": {
+    "path": "/2012/11/19/the-science-of-instagram-how-to-get-more-followers-and-likes",
+    "hostname": "www.quicksprout.com",
+    "id": "2fe54e1ad6fc42ea86b804dd376e30763efbe53f981d14b2f40ccdf857e749ea",
+    "title": "The Science of Instagram: How to Get More Followers and Likes"
+  }
+}