nucleo-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28f0fb4588cdd64759b7cee6f5dec135ddedb46a
+  data.tar.gz: 49c64dd421a6cdb6a90a96dfac485a5cbd22b8ca
+SHA512:
+  metadata.gz: 90641445aa873945cd638637d1bb58d433787c7ea4e77d637662772414e9710e243b9075dcd49486a7feefd2c651e40271e2f59f43fedfccd803e93a51dfc72b
+  data.tar.gz: 94dca77dad3b290e2de9774765b15748e6962e7762bdf43a66546abe4587fae4396030668b24cad354e0278b0cc63a146c75f4132f17f91285e54a5278a2d9b9

data/.env.sample

@@ -0,0 +1,2 @@
+export NUCLEO_API_HOST=''
+export NUCLEO_API_TOKEN=''

data/.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nucleo-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Nate Klaiber
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# Nucleo::Client
+
+Ruby client for interacting with the Nucleo Service
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nucleo-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nucleo-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/quicksprout/nucleo-client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,37 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = Dir["lib/**/*.rb"]
+end
+
+desc "Run tests"
+task default: [:spec]
+
+desc "Document the Library"
+task doc: [:yard]
+
+desc "List out API Routes"
+task(:routes) do
+  require 'nucleo/client'
+  require 'terminal-table'
+
+  route_definitions = Nucleo::Client.routes
+
+  row_display = ->(row) do
+    [row.name, row.path]
+  end
+
+  title    = "Nucleo API Routes"
+  headings = ['Route Name', 'Route']
+  rows     = route_definitions.map { |r| row_display.call(r) }
+
+  table = Terminal::Table.new(title: title, headings: headings, rows: rows)
+  puts "\n"
+  puts table.to_s
+  puts "\n"
+end
+

data/lib/nucleo/client.rb

@@ -0,0 +1,172 @@
+require 'dotenv'
+require 'json'
+require 'logger'
+require 'multi_json'
+require 'restless_router'
+
+Dotenv.load
+
+require File.expand_path('../../nucleo/client/version', __FILE__)
+
+require File.expand_path('../../nucleo/logger', __FILE__)
+require File.expand_path('../../nucleo/configuration', __FILE__)
+require File.expand_path('../../nucleo/connection', __FILE__)
+require File.expand_path('../../nucleo/requests', __FILE__)
+require File.expand_path('../../nucleo/response', __FILE__)
+require File.expand_path('../../nucleo/errors', __FILE__)
+
+require File.expand_path('../../nucleo/utilities', __FILE__)
+
+require File.expand_path('../../nucleo/models', __FILE__)
+
+require File.expand_path('../configuration', __FILE__)
+
+
+module Nucleo
+  class Client
+
+    # Class accessor methods to be
+    # utilities throughout the client.
+    class << self
+      attr_accessor :configuration
+      attr_accessor :routes
+    end
+
+    # Create a default configuration to use
+    #
+    # @return [Nucleo::Configuration]
+    def self.configuration
+      @configuration ||= Nucleo::Configuration.new
+    end
+
+    # Specify configuration options. This will be
+    # applied to our memoized Configuration.
+    #
+    # @return [Nucleo::Configuration]
+    def self.configure
+      yield(self.configuration)
+    end
+
+    # Helper method to access the Connection object
+    #
+    # @return [Nucleo::Connection]
+    def self.connection
+      @connection ||= Nucleo::Connection.new(url: self.configuration.api_host) do |builder|
+        builder.use(:gzip)
+
+        builder.response(:json, content_type: /\bjson$/)
+
+        builder.response(:logger, self.configuration.request_logger)
+        builder.response(:detailed_logger, self.configuration.detailed_logger)
+
+        builder.request(:retry, max: 10, interval: 1, interval_randomness: 0.5, backoff_factor: 2)
+
+        builder.options[:timeout] = 600
+
+        builder.adapter(Nucleo::Connection.default_adapter)
+      end
+
+      # Inject the Authorization via the API key
+      @connection.headers['x-api-key'] = self.configuration.access_token
+
+      # Merge in the default headers
+      @connection.headers.merge!(self.configuration.connection_options[:headers])
+
+      @connection
+    end
+
+    # Helper method to perform a GET request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.get(url, data={}, headers={})
+      request = self.connection.get(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform a HEAD request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.head(url, data={}, headers={})
+      request = self.connection.head(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform an OPTIONS request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.options(url, headers={})
+      request = self.connection.http_options(url, nil, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform an POST request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.post(url, data={}, headers={})
+      request = self.connection.post(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform an PUT request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.put(url, data={}, headers={})
+      request = self.connection.put(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform an PATCh request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.patch(url, data={}, headers={})
+      request = self.connection.patch(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Helper method to perform an DELETE request
+    #
+    # @return [Nucleo::Response] Faraday Response Delegator
+    def self.delete(url, data={}, headers={})
+      request = self.connection.delete(url, data, headers)
+
+      Nucleo::Response.new(request)
+    end
+
+    # Define the API routes. This will return a collection of
+    # available routes.
+    def self.routes
+      return @routes if @routes
+
+      @routes = RestlessRouter::Routes.new
+
+      @routes.add_route(RestlessRouter::Route.new('analyzer', ("%sanalyzer" % [self.api_host])))
+      @routes.add_route(RestlessRouter::Route.new('analyzer-site-page', ("%sanalyzer/sites/{site_id}/pages/{id}" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('sites', ("%ssites" % [self.api_host])))
+      @routes.add_route(RestlessRouter::Route.new('site', ("%ssites/{id}{?includes,metrics.per_page,metrics.page,alerts.per_page,alerts.page,pages.per_page,pages.page,changes.per_page,changes.page}" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-process', ("%ssites/{id}/process" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-pages', ("%ssites/{id}/pages" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-page-detail', ("%ssites/{site_id}/pages/{id}" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-page-alerts', ("%ssites/{site_id}/alerts/{type}" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-feed', ("%ssites/{id}/feed{?max_feed_items}" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-page-changes', ("%ssites/{site_id}/pages/{page_id}/changes" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-changes-batch', ("%ssites/{site_id}/changes/batch" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('site-changes', ("%ssites/{site_id}/changes" % [self.api_host]), templated: true))
+      @routes.add_route(RestlessRouter::Route.new('util-checkjs', ("%sutil/checkjs?url={url}" % [self.api_host]), templated: true))
+
+      @routes
+    end
+
+    # Helper method to return the API host
+    #
+    # @return [String] API Base URL
+    def self.api_host
+      self.configuration.api_host
+    end
+  end
+end

data/lib/nucleo/client/version.rb

@@ -0,0 +1,5 @@
+module Nucleo
+  class Client
+    VERSION = "0.1.0"
+  end
+end

data/lib/nucleo/configuration.rb

@@ -0,0 +1,83 @@
+require File.expand_path('../configurations', __FILE__)
+
+module Nucleo
+  class Configuration
+    # Connection
+    attr_accessor :api_host
+    attr_accessor :access_token
+    attr_accessor :connection_options
+
+    # Request
+    attr_accessor :user_agent
+    attr_accessor :media_type
+    attr_accessor :content_type
+
+    # Logging
+    attr_accessor :detailed_logger
+    attr_accessor :request_logger
+    attr_accessor :cache_logger
+    attr_accessor :logger
+
+    # Returns the set of allowed configuration
+    # options
+    #
+    # @return [Array<Symbol>] Configuration Keys
+    def self.keys
+      @keys ||= [
+        :api_host,
+        :access_token,
+        :connection_options,
+        :user_agent,
+        :media_type,
+        :content_type,
+        :request_logger,
+        :detailed_logger,
+        :cache_logger,
+        :logger
+      ]
+    end
+
+    # Create a new instance of the Configuration Object
+    #
+    # @param attributes [Hash] Hash of configuration keys and values
+    #
+    # @return [Nucleo::Configuration] Instance of the object
+    def initialize(attributes={})
+      self.class.keys.each do |key|
+        instance_variable_set(:"@#{key}", (attributes[key] || Nucleo::Configurations::Default.options[key]))
+      end
+    end
+
+    # The final set of connection options
+    #
+    # @return [Hash] Connection options
+    def connection_options
+      {
+        :headers => {
+          :accept       => self.media_type,
+          :user_agent   => self.user_agent,
+          :content_type => self.content_type
+        }
+      }
+    end
+
+    # Allows you to configure the object after it's been
+    # initialized.
+    #
+    # @return [Nucleo::Configuration] The configuration instance
+    def configure(&block)
+      yield(self)
+    end
+
+    # Allows you to reset your configuration back to the default
+    # state.
+    #
+    # @return [Nucleo::Configuration] The configuration with Defaults applied
+    def reset!
+      self.class.keys.each do |key|
+        instance_variable_set(:"@#{key}", Nucleo::Configurations::Default.options[key])
+      end
+    end
+    alias :setup :reset!
+  end
+end

data/lib/nucleo/configurations.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../configurations/default', __FILE__)
+
+module Nucleo
+  module Configurations
+  end
+end

data/lib/nucleo/configurations/default.rb

@@ -0,0 +1,100 @@
+require File.expand_path('../../logger', __FILE__)
+require File.expand_path('../../client', __FILE__)
+
+module Nucleo
+  module Configurations
+    module Default
+      API_HOST     = "https//api.quicksprout.com".freeze
+      USER_AGENT   = ("Nucleo Web Application Gem %s" % [Nucleo::Client::VERSION]).freeze
+      MEDIA_TYPE   = "application/json".freeze
+      CONTENT_TYPE = "application/json".freeze
+
+      # Return the collection of default options and values
+      #
+      # @return [Hash] Keys and values of default configuration
+      def self.options
+        Hash[Nucleo::Configuration.keys.map { |key| [key, __send__(key)] }]
+      end
+
+      # Return the ENV access token or nil
+      #
+      # @return [String, Nil]
+      def self.access_token
+        ENV['NUCLEO_ACCESS_TOKEN']
+      end
+
+      # Return the ENV API Host or the default production
+      # API host.
+      #
+      # @return [String]
+      def self.api_host
+        ENV.fetch('NUCLEO_API_HOST', API_HOST)
+      end
+
+      # Return the ENV Accept header or
+      # default constant.
+      #
+      # @return [String]
+      def self.media_type
+        ENV.fetch('NUCLEO_MEDIA_TYPE', MEDIA_TYPE)
+      end
+
+      # Return the ENV Content-Type header or
+      # default constant.
+      #
+      # @return [String]
+      def self.content_type
+        ENV.fetch('NUCLEO_CONTENT_TYPE', CONTENT_TYPE)
+      end
+
+      # REturn the ENV User-Agent header or
+      # default constant.
+      #
+      # @return [String]
+      def self.user_agent
+        ENV.fetch('NUCLEO_USER_AGENT', USER_AGENT)
+      end
+
+      # Return the default logger to STDOUT
+      #
+      # @return [Nucleo::Logger] Logger Delegator
+      def self.request_logger
+        Nucleo::Logger.new(STDOUT)
+      end
+
+      # Return the default logger to STDOUT
+      #
+      # @return [Nucleo::Logger] Logger Delegator
+      def self.detailed_logger
+        Nucleo::Logger.new(STDOUT)
+      end
+
+      # Return the default logger to STDOUT
+      #
+      # @return [Nucleo::Logger] Logger Delegator
+      def self.cache_logger
+        Nucleo::Logger.new(STDOUT)
+      end
+
+      # Return the default logger to STDOUT
+      #
+      # @return [Nucleo::Logger] Logger Delegator
+      def self.logger
+        Nucleo::Logger.new(STDOUT)
+      end
+
+      # Returns a set of default connection options
+      #
+      # @return [Hash] Connection Options
+      def self.connection_options
+        {
+          :headers => {
+            :accept       => self.media_type,
+            :user_agent   => self.user_agent,
+            :content_type => self.content_type
+          }
+        }
+      end
+    end
+  end
+end