nearmiss-ruby 1.0.0

data/lib/nearmiss-ruby/error.rb

@@ -0,0 +1,186 @@
+module Nearmiss
+  # Custom error class for rescuing from all GitHub errors
+  class Error < StandardError
+
+    # Returns the appropriate Nearmiss::Error sublcass based
+    # on status and response message
+    #
+    # @param [Hash] response HTTP response
+    # @return [Nearmiss::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 Nearmiss::BadRequest
+                  when 401      then Nearmiss::Unauthorized
+                  when 403      then Nearmiss::Forbidden
+                  when 404      then Nearmiss::NotFound
+                  when 405      then Nearmiss::MethodNotAllowed
+                  when 406      then Nearmiss::NotAcceptable
+                  when 409      then Nearmiss::Conflict
+                  when 415      then Nearmiss::UnsupportedMediaType
+                  when 422      then Nearmiss::UnprocessableEntity
+                  when 400..499 then Nearmiss::ClientError
+                  when 500      then Nearmiss::InternalServerError
+                  when 501      then Nearmiss::NotImplemented
+                  when 502      then Nearmiss::BadGateway
+                  when 503      then Nearmiss::ServiceUnavailable
+                  when 500..599 then Nearmiss::ServerError
+                  end
+        klass.new(response)
+      end
+    end
+
+    def initialize(response=nil)
+      @response = response
+      super(build_error_message)
+    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 << data[:errors].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 << MultiJson.dump(@response)
+      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 Nearmiss-Field returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+  # Raised when Nearmiss-Field returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 403 HTTP status code
+  # and body matches 'rate limit exceeded'
+  class TooManyRequests < Forbidden; end
+
+  # Raised when Nearmiss-Field returns a 403 HTTP status code
+  # and body matches 'login attempts exceeded'
+  class TooManyLoginAttempts < Forbidden; end
+
+  # Raised when Nearmiss-Field returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
+
+  # Raised when Nearmiss-Field returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when Nearmiss-Field returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when Nearmiss-Field returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when Nearmiss-Field returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when Nearmiss-Field 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
+
+  class MissingParams < Error
+    def initialize(msg)
+
+      msg
+    end
+  end
+
+
+end

data/lib/nearmiss-ruby/raise_error.rb

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

data/lib/nearmiss-ruby/rate_limit.rb

@@ -0,0 +1,33 @@
+module Nearmiss
+
+  # Class for API Rate Limit info
+  #
+  # @!attribute [w] limit
+  #   @return [Fixnum] Max tries per rate limit period
+  # @!attribute [w] remaining
+  #   @return [Fixnum] Remaining tries per rate limit period
+  # @!attribute [w] resets_at
+  #   @return [Time] Indicates when rate limit resets
+  # @!attribute [w] resets_in
+  #   @return [Fixnum] Number of seconds when rate limit resets
+  #
+  # @see https://developer.github.com/v3/#rate-limiting
+  class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)
+
+    # Get rate limit info from HTTP response
+    #
+    # @param response [#headers] HTTP response
+    # @return [RateLimit]
+    def self.from_response(response)
+      info = new
+      if response && !response.headers.nil?
+        info.limit = (response.headers['X-RateLimit-Limit'] || 1).to_i
+        info.remaining = (response.headers['X-RateLimit-Remaining'] || 1).to_i
+        info.resets_at = Time.at((response.headers['X-RateLimit-Reset'] || Time.now).to_i)
+        info.resets_in = [(info.resets_at - Time.now).to_i, 0].max
+      end
+
+      info
+    end
+  end
+end

data/lib/nearmiss-ruby/response.rb

@@ -0,0 +1,7 @@
+module Nearmiss
+
+  module Response
+
+  end
+
+end

data/lib/nearmiss-ruby/util.rb

@@ -0,0 +1,32 @@
+module Nearmiss
+  module Util
+    def url_encode(hash)
+      hash.to_a.map {|p| p.map {|e| CGI.escape get_string(e)}.join '='}.join '&'
+    end
+
+    def get_string(obj)
+      if obj.respond_to?(:strftime)
+        obj.strftime('%Y-%m-%d')
+      else
+        obj.to_s
+      end
+    end
+
+    # Validate if argument is a UUID 
+    #
+    # @param uuid [String] the string to test against
+    # @return [Boolean]
+    # @example
+    #   Nearmiss.uuid?("31817811-dce4-48c4-aa5f-f49603c5abee") => true
+    #   Nearmiss.uuid?("test@gmail.com") => false
+    #
+    def uuid?(uuid)
+      return true if uuid =~ /\A[\da-f]{32}\z/i
+      return true if
+        uuid =~ /\A(urn:uuid:)?[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i
+      return false
+    end
+
+
+  end
+end

data/lib/nearmiss-ruby/version.rb

@@ -0,0 +1,3 @@
+module Nearmiss
+  VERSION = "0.0.1"
+end

data/lib/nearmiss-ruby.rb

@@ -0,0 +1,46 @@
+require "set"
+require "faraday"
+require "sawyer"
+
+require "nearmiss-ruby/response"
+require "nearmiss-ruby/error"
+require "nearmiss-ruby/raise_error"
+require "nearmiss-ruby/version"
+
+require "nearmiss-ruby/configurable"
+require "nearmiss-ruby/response"
+require "nearmiss-ruby/client"
+require "nearmiss-ruby/default"
+require "nearmiss-ruby/util"
+
+module Nearmiss
+
+  class << self
+
+    include Nearmiss::Configurable
+    include Nearmiss::Util
+
+    # API client based on configured options {Configurable}
+    #
+    # @return [Nearmiss::Client] API wrapper
+    def client
+      @client = Nearmiss::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
+
+  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
+Nearmiss.setup

data/nearmiss-ruby.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name              = %q{nearmiss-ruby}
+  s.version           = "1.0.0"
+  s.platform          = Gem::Platform::RUBY
+  s.license           = 'MIT'
+
+  s.authors           = ["Markus Klooth"]
+  s.date              = Time.now.strftime "%Y-%m-%d"
+  s.description       = %q{A wrapper around the nearmissapp.com API.}
+  s.email             = %q{support@nearmissapp.com}
+  s.extra_rdoc_files  = ["README.md"]
+  s.files             = `git ls-files -z`.split("\x0")
+  s.executables       = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.homepage          = %q{https://github.com/nearmiss/nearmiss-ruby}
+  s.rdoc_options      = ["--charset=UTF-8"]
+  s.require_paths     = ["lib"]
+  s.rubyforge_project = %q{nearmiss-ruby}
+  s.rubygems_version  = %q{1.0.0}
+  s.summary           = %q{A wrapper around the nearmiss.com API.}
+  s.test_files        = Dir.glob("spec/**/*")
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency("sawyer", ">= 0.5.5")
+  s.add_dependency("multi_json", '>= 1.3.0')
+
+  s.add_development_dependency 'bundler', '~> 1.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: nearmiss-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Markus Klooth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sawyer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A wrapper around the nearmissapp.com API.
+email: support@nearmissapp.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- AUTHORS.md
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nearmiss-ruby.rb
+- lib/nearmiss-ruby/arguments.rb
+- lib/nearmiss-ruby/authentication.rb
+- lib/nearmiss-ruby/client.rb
+- lib/nearmiss-ruby/client/account.rb
+- lib/nearmiss-ruby/client/bookmarks.rb
+- lib/nearmiss-ruby/client/categories.rb
+- lib/nearmiss-ruby/client/incidents.rb
+- lib/nearmiss-ruby/client/notifications.rb
+- lib/nearmiss-ruby/client/projects.rb
+- lib/nearmiss-ruby/client/rate_limit.rb
+- lib/nearmiss-ruby/client/users.rb
+- lib/nearmiss-ruby/configurable.rb
+- lib/nearmiss-ruby/default.rb
+- lib/nearmiss-ruby/error.rb
+- lib/nearmiss-ruby/raise_error.rb
+- lib/nearmiss-ruby/rate_limit.rb
+- lib/nearmiss-ruby/response.rb
+- lib/nearmiss-ruby/util.rb
+- lib/nearmiss-ruby/version.rb
+- nearmiss-ruby.gemspec
+homepage: https://github.com/nearmiss/nearmiss-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nearmiss-ruby
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper around the nearmiss.com API.
+test_files: []
+has_rdoc: