mgmt_console 0.4.1

data/lib/mgmt_console/error.rb

@@ -0,0 +1,241 @@
+module MgmtConsole
+  # Custom error class for rescuing from all GitHub errors
+  class Error < StandardError
+
+    # Returns the appropriate MgmtConsole::Error subclass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [MgmtConsole::Error]
+    def self.from_response(response)
+      status  = response[:status].to_i
+      body    = response[:body].to_s
+      headers = response[:response_headers]
+
+      if klass =  case status
+                  when 400      then MgmtConsole::BadRequest
+                  when 401      then error_for_401(headers)
+                  when 403      then error_for_403(body)
+                  when 404      then MgmtConsole::NotFound
+                  when 405      then MgmtConsole::MethodNotAllowed
+                  when 406      then MgmtConsole::NotAcceptable
+                  when 409      then MgmtConsole::Conflict
+                  when 415      then MgmtConsole::UnsupportedMediaType
+                  when 422      then MgmtConsole::UnprocessableEntity
+                  when 400..499 then MgmtConsole::ClientError
+                  when 500      then MgmtConsole::InternalServerError
+                  when 501      then MgmtConsole::NotImplemented
+                  when 502      then MgmtConsole::BadGateway
+                  when 503      then MgmtConsole::ServiceUnavailable
+                  when 500..599 then MgmtConsole::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    end
+
+    # Documentation URL returned by the API for some errors
+    #
+    # @return [String]
+    def documentation_url
+      data[:documentation_url] if data.is_a? Hash
+    end
+
+    # Returns most appropriate error for 401 HTTP status code
+    # @private
+    def self.error_for_401(headers)
+      if MgmtConsole::OneTimePasswordRequired.required_header(headers)
+        MgmtConsole::OneTimePasswordRequired
+      else
+        MgmtConsole::Unauthorized
+      end
+    end
+
+    # Returns most appropriate error for 403 HTTP status code
+    # @private
+    def self.error_for_403(body)
+      if body =~ /rate limit exceeded/i
+        MgmtConsole::TooManyRequests
+      elsif body =~ /login attempts exceeded/i
+        MgmtConsole::TooManyLoginAttempts
+      elsif body =~ /abuse/i
+        MgmtConsole::AbuseDetected
+      elsif body =~ /repository access blocked/i
+        MgmtConsole::RepositoryUnavailable
+      else
+        MgmtConsole::Forbidden
+      end
+    end
+
+    # Array of validation errors
+    # @return [Array<Hash>] Error info
+    def errors
+      if data && data.is_a?(Hash)
+        data[:errors] || []
+      else
+        []
+      end
+    end
+
+    private
+
+    def data
+      @data ||=
+        if (body = @response[:body]) && !body.empty?
+          if body.is_a?(String) &&
+            @response[:response_headers] &&
+            @response[:response_headers][:content_type] =~ /json/
+
+            Sawyer::Agent.serializer.decode(body)
+          else
+            body
+          end
+        else
+          nil
+        end
+    end
+
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def response_error_summary
+      return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
+
+      summary = "\nError summary:\n"
+      summary << data[:errors].map do |hash|
+        hash.map { |k,v| "  #{k}: #{v}" }
+      end.join("\n")
+
+      summary
+    end
+
+    def build_error_message
+      return nil if @response.nil?
+
+      message =  "#{@response[:method].to_s.upcase} "
+      message << redact_url(@response[:url].to_s) + ": "
+      message << "#{@response[:status]} - "
+      message << "#{response_message}" unless response_message.nil?
+      message << "#{response_error}" unless response_error.nil?
+      message << "#{response_error_summary}" unless response_error_summary.nil?
+      message << " // See: #{documentation_url}" unless documentation_url.nil?
+      message
+    end
+
+    def redact_url(url_string)
+      %w[client_secret access_token].each do |token|
+        url_string.gsub!(/#{token}=\S+/, "#{token}=(redacted)") if url_string.include? token
+      end
+      url_string
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when GitHub returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when GitHub returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when GitHub returns a 401 HTTP status code
+  # and headers include "X-GitHub-OTP"
+  class OneTimePasswordRequired < ClientError
+    #@private
+    OTP_DELIVERY_PATTERN = /required; (\w+)/i
+
+    #@private
+    def self.required_header(headers)
+      OTP_DELIVERY_PATTERN.match headers['X-GitHub-OTP'].to_s
+    end
+
+    # Delivery method for the user's OTP
+    #
+    # @return [String]
+    def password_delivery
+      @password_delivery ||= delivery_method_from_header
+    end
+
+    private
+
+    def delivery_method_from_header
+      if match = self.class.required_header(@response[:response_headers])
+        match[1]
+      end
+    end
+  end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'rate limit exceeded'
+  class TooManyRequests < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'login attempts exceeded'
+  class TooManyLoginAttempts < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'abuse'
+  class AbuseDetected < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'repository access blocked'
+  class RepositoryUnavailable < Forbidden; end
+
+  # Raised when GitHub returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when GitHub returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when GitHub returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when GitHub returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when GitHub returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when GitHub returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when GitHub returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when GitHub returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when GitHub returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when GitHub returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+
+  # Raised when client fails to provide valid Content-Type
+  class MissingContentType < ArgumentError; end
+
+  # Raised when a method requires an application client_id
+  # and secret but none is provided
+  class ApplicationCredentialsRequired < StandardError; end
+end

data/lib/mgmt_console/response/feed_parser.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+
+module MgmtConsole
+
+  module Response
+
+    # Parses RSS and Atom feed responses.
+    class FeedParser < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(env)
+        if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
+          require 'rss'
+          env[:body] = RSS::Parser.parse env[:body]
+        end
+      end
+
+    end
+  end
+end

data/lib/mgmt_console/response/raise_error.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+require 'mgmt_console/error'
+
+module MgmtConsole
+  # Faraday response middleware
+  module Response
+
+    # This class raises an MgmtConsole-flavored exception based
+    # HTTP status codes returned by the API
+    class RaiseError < Faraday::Response::Middleware
+
+      private
+
+      def on_complete(response)
+        if error = MgmtConsole::Error.from_response(response)
+          raise error
+        end
+      end
+    end
+  end
+end

data/lib/mgmt_console/version.rb

@@ -0,0 +1,3 @@
+module MgmtConsole
+  VERSION = "0.4.1"
+end

data/lib/mgmt_console.rb

@@ -0,0 +1,33 @@
+require 'mgmt_console/client'
+require 'mgmt_console/default'
+
+# Ruby toolkit for the Mgmt Console API
+module MgmtConsole
+
+  class << self
+    include MgmtConsole::Configurable
+
+    # API client based on configured options {Configurable}
+    #
+    # @return [MgmtConsole::Client] API wrapper
+    def client
+      @client = MgmtConsole::Client.new(options) unless defined?(@client) && @client.same_options?(options)
+      @client
+    end
+
+    # @private
+    def respond_to_missing?(method_name, include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    # @private
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end
+
+MgmtConsole.setup

data/mgmt_console_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mgmt_console/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mgmt_console"
+  spec.version       = MgmtConsole::VERSION
+  spec.authors       = ["Jason Barnett"]
+  spec.email         = ["jason.w.barnett@gmail.com"]
+
+  spec.summary       = "Ruby toolkit for working with the Mgmt Console API"
+  spec.description   = %q{Simple wrapper for the Mgmt Console API}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  spec.add_runtime_dependency "sawyer", "~> 0.6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: mgmt_console
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Jason Barnett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple wrapper for the Mgmt Console API
+email:
+- jason.w.barnett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/query_engage_.md
+- lib/mgmt_console.rb
+- lib/mgmt_console/api_error.rb
+- lib/mgmt_console/authentication.rb
+- lib/mgmt_console/client.rb
+- lib/mgmt_console/client/engage_communities.rb
+- lib/mgmt_console/client/engage_environments.rb
+- lib/mgmt_console/client/engage_instances.rb
+- lib/mgmt_console/client/engage_servers.rb
+- lib/mgmt_console/client/server_environments.rb
+- lib/mgmt_console/client/spigit_configs.rb
+- lib/mgmt_console/configurable.rb
+- lib/mgmt_console/default.rb
+- lib/mgmt_console/error.rb
+- lib/mgmt_console/response/feed_parser.rb
+- lib/mgmt_console/response/raise_error.rb
+- lib/mgmt_console/version.rb
+- mgmt_console_client.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.5
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby toolkit for working with the Mgmt Console API
+test_files: []