mgmt_console 0.4.1

data/lib/mgmt_console/client.rb

@@ -0,0 +1,257 @@
+require 'sawyer'
+require 'mgmt_console/api_error'
+require 'mgmt_console/authentication'
+require 'mgmt_console/configurable'
+require 'mgmt_console/client/server_environments'
+require 'mgmt_console/client/engage_environments'
+require 'mgmt_console/client/engage_communities'
+require 'mgmt_console/client/engage_servers'
+require 'mgmt_console/client/engage_instances'
+require 'mgmt_console/client/spigit_configs'
+
+module MgmtConsole
+
+  # Client for the Mgmt Console API
+  #
+  # @see https://console.mindjet.com
+  class Client
+
+    include MgmtConsole::Authentication
+    include MgmtConsole::Configurable
+    include MgmtConsole::Client::ServerEnvironments
+    include MgmtConsole::Client::EngageEnvironments
+    include MgmtConsole::Client::EngageCommunities
+    include MgmtConsole::Client::EngageServers
+    include MgmtConsole::Client::EngageInstances
+    include MgmtConsole::Client::SpigitConfigs
+
+    # Header keys that can be passed in options hash to {#get},{#head}
+    CONVENIENCE_HEADERS = Set.new([:accept, :content_type])
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      MgmtConsole::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", resolve_opt(options, key))
+      end
+    end
+
+    # Compares client options to a Hash of requested options
+    #
+    # @param opts [Hash] Options to compare with current client options
+    # @return [Boolean]
+    def same_options?(opts)
+      opts.hash == options.hash
+    end
+
+    # Text representation of the client, masking tokens and passwords
+    #
+    # @return [String]
+    def inspect
+      inspected = super
+
+      # Only show last 4 of token, secret
+      if @access_token
+        inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
+      end
+
+      inspected
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def get(url, options = {})
+      request :get, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make a HTTP POST request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def post(url, options = {})
+      request :post, url, options
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def put(url, options = {})
+      request :put, url, options
+    end
+
+    # Make a HTTP PATCH request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Body and header params for request
+    # @return [Sawyer::Resource]
+    def patch(url, options = {})
+      request :patch, url, options
+    end
+
+    # Make a HTTP DELETE request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def delete(url, options = {})
+      request :delete, url, options
+    end
+
+    # Make a HTTP HEAD request
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @return [Sawyer::Resource]
+    def head(url, options = {})
+      request :head, url, parse_query_and_convenience_headers(options)
+    end
+
+    # Make one or more HTTP GET requests, optionally fetching
+    # the next page of results from URL in Link response header based
+    # on value in {#auto_paginate}.
+    #
+    # @param url [String] The path, relative to {#api_endpoint}
+    # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatination of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response.
+    # @return [Sawyer::Resource]
+    def paginate(url, options = {}, &block)
+      opts = parse_query_and_convenience_headers(options.dup)
+      if @auto_paginate || @per_page
+        opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
+      end
+
+      data = request(:get, url, opts)
+
+      if @auto_paginate
+        while @last_response.rels[:next]# && rate_limit.remaining > 0
+          @last_response = @last_response.rels[:next].get
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          end
+        end
+
+      end
+
+      data
+    end
+
+    # Hypermedia agent for the GitHub API
+    #
+    # @return [Sawyer::Agent]
+    def agent
+      @agent ||= Sawyer::Agent.new(api_endpoint, sawyer_options) do |http|
+        http.headers[:accept] = default_media_type
+        http.headers[:content_type] = "application/json"
+        http.headers[:user_agent] = user_agent
+        http.ssl[:verify] = ssl_verify
+
+        if token_authenticated?
+          http.headers['X-User-Token'] = @access_token
+        end
+      end
+    end
+
+    # Fetch the root resource for the API
+    #
+    # @return [Sawyer::Resource]
+    def root
+      get "/"
+    end
+
+    # Response for last HTTP request
+    #
+    # @return [Sawyer::Response]
+    def last_response
+      @last_response if defined? @last_response
+    end
+
+    # Set OAuth access token for authentication
+    #
+    # @param value [String] 40 character GitHub OAuth access token
+    def access_token=(value)
+      reset_agent
+      @access_token = value
+    end
+
+    # Wrapper around Kernel#warn to print warnings unless
+    # OCTOKIT_SILENT is set to true.
+    #
+    # @return [nil]
+    def octokit_warn(*message)
+      unless ENV['OCTOKIT_SILENT']
+        warn message
+      end
+    end
+
+    private
+
+    def resolve_opt(options, key)
+      !options[key].nil? ? options[key] : MgmtConsole.instance_variable_get(:"@#{key}")
+    end
+
+    def reset_agent
+      @agent = nil
+    end
+
+    def request(method, path, data, options = {})
+      if data.is_a?(Hash)
+        options[:query]   = data.delete(:query) || {}
+        options[:headers] = data.delete(:headers) || {}
+        if accept = data.delete(:accept)
+          options[:headers][:accept] = accept
+        end
+      end
+
+      @last_response = response = agent.call(method, URI::Parser.new.escape(path.to_s), data, options)
+      response.data
+    end
+
+    # Executes the request, checking if it was successful
+    #
+    # @return [Boolean] True on success, false otherwise
+    def boolean_from_response(method, path, options = {})
+      request(method, path, options)
+      @last_response.status == 204
+    rescue MgmtConsole::NotFound
+      false
+    end
+
+
+    def sawyer_options
+      opts = {
+        :links_parser => Sawyer::LinkParsers::Simple.new
+      }
+      conn_opts = @connection_options
+      conn_opts[:builder] = @middleware if @middleware
+      conn_opts[:proxy] = @proxy if @proxy
+      opts[:faraday] = Faraday.new(conn_opts)
+
+      opts
+    end
+
+    def parse_query_and_convenience_headers(options)
+      headers = options.fetch(:headers, {})
+      CONVENIENCE_HEADERS.each do |h|
+        if header = options.delete(h)
+          headers[h] = header
+        end
+      end
+      query = options.delete(:query)
+      opts = {:query => options}
+      opts[:query].merge!(query) if query && query.is_a?(Hash)
+      opts[:headers] = headers unless headers.empty?
+
+      opts
+    end
+  end
+end

data/lib/mgmt_console/configurable.rb

@@ -0,0 +1,110 @@
+module MgmtConsole
+
+  # Configuration options for {Client}, defaulting to values
+  # in {Default}
+  module Configurable
+    # @!attribute [w] access_token
+    #   @see https://developer.github.com/v3/oauth/
+    #   @return [String] OAuth2 access token for authentication
+    # @!attribute api_endpoint
+    #   @return [String] Base URL for API requests. default: https://api.github.com/
+    # @!attribute auto_paginate
+    #   @return [Boolean] Auto fetch next page of results until rate limit reached
+    # @!attribute client_id
+    #   @see https://developer.github.com/v3/oauth/
+    #   @return [String] Configure OAuth app key
+    # @!attribute [w] client_secret
+    #   @see https://developer.github.com/v3/oauth/
+    #   @return [String] Configure OAuth app secret
+    # @!attribute default_media_type
+    #   @see https://developer.github.com/v3/media/
+    #   @return [String] Configure preferred media type (for API versioning, for example)
+    # @!attribute connection_options
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Hash] Configure connection options for Faraday
+    # @!attribute login
+    #   @return [String] GitHub username for Basic Authentication
+    # @!attribute middleware
+    #   @see https://github.com/lostisland/faraday
+    #   @return [Faraday::Builder or Faraday::RackBuilder] Configure middleware for Faraday
+    # @!attribute ssl_verify
+    #   @return [Boolean] Configure SSL verification for Faraday
+    # @!attribute netrc
+    #   @return [Boolean] Instruct MgmtConsole to get credentials from .netrc file
+    # @!attribute netrc_file
+    #   @return [String] Path to .netrc file. default: ~/.netrc
+    # @!attribute [w] password
+    #   @return [String] GitHub password for Basic Authentication
+    # @!attribute per_page
+    #   @return [String] Configure page size for paginated results. API default: 30
+    # @!attribute proxy
+    #   @see https://github.com/lostisland/faraday
+    #   @return [String] URI for proxy server
+    # @!attribute user_agent
+    #   @return [String] Configure User-Agent header for requests.
+    # @!attribute web_endpoint
+    #   @return [String] Base URL for web URLs. default: https://github.com/
+
+    attr_accessor :access_token, :auto_paginate,
+                  :default_media_type, :connection_options,
+                  :middleware, :ssl_verify,
+                  :per_page, :proxy, :user_agent
+    attr_writer :web_endpoint, :api_endpoint
+
+    class << self
+
+      # List of configurable keys for {MgmtConsole::Client}
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :access_token,
+          :api_endpoint,
+          :auto_paginate,
+          :connection_options,
+          :default_media_type,
+          :middleware,
+          :per_page,
+          :proxy,
+          :ssl_verify,
+          :user_agent,
+          :web_endpoint
+        ]
+      end
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    # Reset configuration options to default values
+    def reset!
+      MgmtConsole::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", MgmtConsole::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+    def api_endpoint
+      File.join(@api_endpoint, "")
+    end
+
+    def ssl_verify
+      @ssl_verify
+    end
+
+    # Base URL for generated web URLs
+    #
+    # @return [String] Default: https://github.com/
+    def web_endpoint
+      File.join(@web_endpoint, "")
+    end
+
+    private
+
+    def options
+      Hash[MgmtConsole::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+  end
+end

data/lib/mgmt_console/default.rb

@@ -0,0 +1,125 @@
+require 'mgmt_console/response/raise_error'
+require 'mgmt_console/response/feed_parser'
+require 'mgmt_console/version'
+
+module MgmtConsole
+
+  # Default configuration options for {Client}
+  module Default
+
+    # Default API endpoint
+    API_ENDPOINT = "https://console.mindjet.com/api/v1".freeze
+
+    # Default User Agent header string
+    USER_AGENT   = "Mgmt Console Ruby Gem #{MgmtConsole::VERSION}".freeze
+
+    # Default SSL verify
+    SSL_VERIFY   = true.freeze
+
+    # Default media type
+    MEDIA_TYPE   = "application/json".freeze
+
+    # Default WEB endpoint
+    WEB_ENDPOINT = "https://console.mindjet.com".freeze
+
+    # In Faraday 0.9, Faraday::Builder was renamed to Faraday::RackBuilder
+    RACK_BUILDER_CLASS = defined?(Faraday::RackBuilder) ? Faraday::RackBuilder : Faraday::Builder
+
+    # Default Faraday middleware stack
+    MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use MgmtConsole::Response::RaiseError
+      builder.use MgmtConsole::Response::FeedParser
+      builder.adapter Faraday.default_adapter
+    end
+
+    class << self
+
+      # Configuration options
+      # @return [Hash]
+      def options
+        Hash[MgmtConsole::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # Default access token from ENV
+      # @return [String]
+      def access_token
+        ENV['MGMT_CONSOLE_ACCESS_TOKEN']
+      end
+
+      # Default API endpoint from ENV or {API_ENDPOINT}
+      # @return [String]
+      def api_endpoint
+        ENV['MGMT_CONSOLE_API_ENDPOINT'] || API_ENDPOINT
+      end
+
+      # Default pagination preference from ENV
+      # @return [String]
+      def auto_paginate
+        ENV['MGMT_CONSOLE_AUTO_PAGINATE']
+      end
+
+      # Default options for Faraday::Connection
+      # @return [Hash]
+      def connection_options
+        {
+          :headers => {
+            :accept => default_media_type,
+            :user_agent => user_agent
+          }
+        }
+      end
+
+      # Default ssl verify from ENV or {SSL_VERIFY}
+      # @return [Boolean]
+      def ssl_verify
+        ENV['MGMT_CONSOLE_SSL_VERIFY'] || SSL_VERIFY
+      end
+
+      # Default media type from ENV or {MEDIA_TYPE}
+      # @return [String]
+      def default_media_type
+        ENV['MGMT_CONSOLE_DEFAULT_MEDIA_TYPE'] || MEDIA_TYPE
+      end
+
+      # Default middleware stack for Faraday::Connection
+      # from {MIDDLEWARE}
+      # @return [String]
+      def middleware
+        MIDDLEWARE
+      end
+
+      # Default GitHub password for Basic Auth from ENV
+      # @return [String]
+      def password
+        ENV['MGMT_CONSOLE_PASSWORD']
+      end
+
+      # Default pagination page size from ENV
+      # @return [Fixnum] Page size
+      def per_page
+        page_size = ENV['MGMT_CONSOLE_PER_PAGE']
+
+        page_size.to_i if page_size
+      end
+
+      # Default proxy server URI for Faraday connection from ENV
+      # @return [String]
+      def proxy
+        ENV['MGMT_CONSOLE_PROXY']
+      end
+
+      # Default User-Agent header string from ENV or {USER_AGENT}
+      # @return [String]
+      def user_agent
+        ENV['MGMT_CONSOLE_USER_AGENT'] || USER_AGENT
+      end
+
+      # Default web endpoint from ENV or {WEB_ENDPOINT}
+      # @return [String]
+      def web_endpoint
+        ENV['MGMT_CONSOLE_WEB_ENDPOINT'] || WEB_ENDPOINT
+      end
+
+    end
+  end
+end