desk_api 0.1.0

data/lib/desk/default.rb

@@ -0,0 +1,67 @@
+require 'desk/version'
+
+module Desk
+  module Default
+    CONNECTION_OPTIONS = {
+      headers: {
+        accept: 'application/json',
+        user_agent: "desk.com Ruby Gem v#{Desk::VERSION}"
+      },
+      request: {
+        open_timeout: 5,
+        timeout: 10
+      }
+    } unless defined? Desk::Default::CONNECTION_OPTIONS
+
+    class << self
+      # @return [Hash]
+      def options
+        Hash[Desk::Configuration.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def username
+        ENV['DESK_USERNAME']
+      end
+
+      # @return [String]
+      def password
+        ENV['DESK_PASSWORD']
+      end
+
+      # @return [String]
+      def consumer_key
+        ENV['DESK_CONSUMER_KEY']
+      end
+
+      # @return [String]
+      def consumer_secret
+        ENV['DESK_CONSUMER_SECRET']
+      end
+
+      # @return [String]
+      def token
+        ENV['DESK_TOKEN']
+      end
+
+      # @return [String]
+      def token_secret
+        ENV['DESK_TOKEN_SECRET']
+      end
+
+      # @return [String]
+      def subdomain
+        ENV['DESK_SUBDOMAIN']
+      end
+
+      # @return [String]
+      def endpoint
+        ENV['DESK_ENDPOINT']
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+    end
+  end
+end

data/lib/desk/error/bad_gateway.rb

@@ -0,0 +1,10 @@
+require 'desk/error/server_error'
+
+module Desk
+  class Error
+    # Raised when Desk returns the HTTP status code 502
+    class BadGateway < Desk::Error::ServerError
+      HTTP_STATUS_CODE = 502
+    end
+  end
+end

data/lib/desk/error/bad_request.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 400
+    class BadRequest < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 400
+    end
+  end
+end

data/lib/desk/error/client_error.rb

@@ -0,0 +1,9 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < Desk::Error
+    end
+  end
+end

data/lib/desk/error/configuration_error.rb

@@ -0,0 +1,8 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/desk/error/conflict.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 409
+    class Conflict < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 409
+    end
+  end
+end

data/lib/desk/error/forbidden.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 403
+    class Forbidden < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 403
+    end
+  end
+end

data/lib/desk/error/gateway_timeout.rb

@@ -0,0 +1,10 @@
+require 'desk/error/server_error'
+
+module Desk
+  class Error
+    # Raised when Desk returns the HTTP status code 504
+    class GatewayTimeout < Desk::Error::ServerError
+      HTTP_STATUS_CODE = 504
+    end
+  end
+end

data/lib/desk/error/internal_server_error.rb

@@ -0,0 +1,10 @@
+require 'desk/error/server_error'
+
+module Desk
+  class Error
+    # Raised when Desk returns the HTTP status code 500
+    class InternalServerError < Desk::Error::ServerError
+      HTTP_STATUS_CODE = 500
+    end
+  end
+end

data/lib/desk/error/method_not_allowed.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 405
+    class MethodNotAllowed < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 405
+    end
+  end
+end

data/lib/desk/error/method_not_supported.rb

@@ -0,0 +1,9 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    # Raised when trying to search a resource that doesn't support search
+    class MethodNotSupported < Desk::Error
+    end
+  end
+end

data/lib/desk/error/not_acceptable.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 406
+    class NotAcceptable < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 406
+    end
+  end
+end

data/lib/desk/error/not_found.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 404
+    class NotFound < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 404
+    end
+  end
+end

data/lib/desk/error/parse_error.rb

@@ -0,0 +1,9 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    # Raised when JSON parsing fails
+    class ParserError < Desk::Error
+    end
+  end
+end

data/lib/desk/error/parser_error.rb

@@ -0,0 +1,9 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    # Raised when JSON parsing fails
+    class ParserError < Desk::Error
+    end
+  end
+end

data/lib/desk/error/server_error.rb

@@ -0,0 +1,9 @@
+require 'desk/error'
+
+module Desk
+  class Error
+    # Raised when Desk returns a 5xx HTTP status code
+    class ServerError < Desk::Error
+    end
+  end
+end

data/lib/desk/error/service_unavailable.rb

@@ -0,0 +1,10 @@
+require 'desk/error/server_error'
+
+module Desk
+  class Error
+    # Raised when Desk returns the HTTP status code 503
+    class ServiceUnavailable < Desk::Error::ServerError
+      HTTP_STATUS_CODE = 503
+    end
+  end
+end

data/lib/desk/error/too_many_requests.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 429
+    class TooManyRequests < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 429
+    end
+  end
+end

data/lib/desk/error/unauthorized.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 401
+    class Unauthorized < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 401
+    end
+  end
+end

data/lib/desk/error/unprocessable_entity.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 422
+    class UnprocessableEntity < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 422
+    end
+  end
+end

data/lib/desk/error/unsupported_media_type.rb

@@ -0,0 +1,10 @@
+require 'desk/error/client_error'
+
+module Desk
+  class Error
+    # Raised when desk.com returns the HTTP status code 415
+    class UnsupportedMediaType < Desk::Error::ClientError
+      HTTP_STATUS_CODE = 415
+    end
+  end
+end

data/lib/desk/error.rb

@@ -0,0 +1,61 @@
+require 'desk/rate_limit'
+
+module Desk
+  # Custom error class for rescuing from all desk.com errors
+  class Error < StandardError
+    attr_reader :rate_limit
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @param response_headers [Hash]
+    # @param code [Integer]
+    # @return [Desk::Error]
+    def initialize(exception=$!, response_headers={}, code = nil)
+      @rate_limit = Desk::RateLimit.new(response_headers)
+      @wrapped_exception = exception
+      @code = code
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param response [Hash]
+      # @return [Desk::Error]
+      def from_response(response = {})
+        error, code = parse_error(response[:body]), response[:status]
+        new(error, response[:response_headers], code)
+      end
+
+      # @return [Hash]
+      def errors
+        @errors ||= descendants.each_with_object({}) do |klass, hash|
+          hash[klass::HTTP_STATUS_CODE] = klass
+        end
+      end
+
+      # @return [Array]
+      def descendants
+        @descendants ||= []
+      end
+
+      # @return [Array]
+      def inherited(descendant)
+        descendants << descendant
+      end
+
+    private
+
+      def parse_error(body)
+        if body['message']
+          body['message']
+        end
+      end
+    end
+  end
+end

data/lib/desk/rate_limit.rb

@@ -0,0 +1,26 @@
+module Desk
+  class RateLimit
+    def initialize(attrs = {})
+      @attrs = attrs
+    end
+    
+    # @return [Integer]
+    def limit
+      limit = @attrs['x-rate-limit-limit']
+      limit.to_i if limit
+    end
+
+    # @return [Integer]
+    def remaining
+      remaining = @attrs['x-rate-limit-remaining']
+      remaining.to_i if remaining
+    end
+
+    # @return [Integer]
+    def reset_in
+      reset_in = @attrs['x-rate-limit-reset']
+      reset_in.to_i if reset_in
+    end
+    alias retry_after reset_in
+  end
+end

data/lib/desk/request/retry.rb

@@ -0,0 +1,51 @@
+module Desk
+  module Request
+    class Retry < Faraday::Request::Retry
+      def initialize(app, options = {})
+        @max = options[:max] || 3
+        @interval = options[:interval] || 10
+        super(app)
+      end
+
+      def call(env)
+        retries   = @retries
+        interval  = @interval
+        
+        begin
+          @app.call(env)
+        rescue Desk::Error::TooManyRequests => e
+          if retries > 0 and e.rate_limit.reset_in
+            retries = 0
+            sleep e.rate_limit.reset_in
+            retry
+          end
+          raise
+        rescue exception_matcher
+          if retries > 0
+            retries -= 1
+            sleep @interval
+            retry
+          end
+          raise
+        end
+      end
+
+      def exception_matcher
+        exceptions = [Errno::ETIMEDOUT, 'Timeout::Error', Faraday::Error::TimeoutError]
+        matcher = Module.new
+        (class << matcher; self; end).class_eval do
+          define_method(:===) do |error|
+            exceptions.any? do |ex|
+              if ex.is_a? Module then error.is_a? ex
+              else error.class.to_s == ex.to_s
+              end
+            end
+          end
+        end
+        matcher
+      end
+    end
+
+    Faraday.register_middleware :request, retry: lambda { Retry }
+  end
+end

data/lib/desk/resource/article.rb

@@ -0,0 +1,10 @@
+module Desk
+  class Resource
+    class Article < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+      include Desk::Action::Search
+    end
+  end
+end

data/lib/desk/resource/article_translation.rb

@@ -0,0 +1,8 @@
+module Desk
+  class Resource
+    class ArticleTranslation < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+    end
+  end
+end

data/lib/desk/resource/attachment.rb

@@ -0,0 +1,8 @@
+module Desk
+  class Resource
+    class Attachment < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/case.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class Case < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Search
+    end
+  end
+end

data/lib/desk/resource/company.rb

@@ -0,0 +1,8 @@
+module Desk
+  class Resource
+    class Company < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+    end
+  end
+end

data/lib/desk/resource/customer.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class Customer < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Search
+    end
+  end
+end

data/lib/desk/resource/integration_url.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class IntegrationUrl < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/job.rb

@@ -0,0 +1,7 @@
+module Desk
+  class Resource
+    class Job < Desk::Resource
+      include Desk::Action::Create
+    end
+  end
+end

data/lib/desk/resource/label.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class Article < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/macro.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class Macro < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/macro_action.rb

@@ -0,0 +1,7 @@
+module Desk
+  class Resource
+    class MacroAction < Desk::Resource
+      include Desk::Action::Update
+    end
+  end
+end

data/lib/desk/resource/note.rb

@@ -0,0 +1,7 @@
+module Desk
+  class Resource
+    class Note < Desk::Resource
+      include Desk::Action::Create
+    end
+  end
+end

data/lib/desk/resource/page.rb

@@ -0,0 +1,81 @@
+module Desk
+  class Resource
+    class Page < Desk::Resource
+      include Enumerable
+      include Desk::Action::Embedded
+
+      [
+        :all?, :any?,
+        :collect, :each, :entries, :find, :find_all,
+        :find_index, :first, :first, :group_by, :last,
+        :map, :map!, :none?, :one?, :partition, :reduce,
+        :reject, :select, :sort, :sort_by, :taken, :zip
+      ].each do |method|
+        define_method(method) do |*args, &block|
+          exec!.records.send(method, *args, &block)
+        end
+      end
+
+      def search(params)
+        raise Desk::Error::MethodNotSupported unless base_class.respond_to?(:search)
+        url = Addressable::URI.parse(clean_base_url + '/search')
+        url.query_values = params
+        base_class.search(client, url.to_s).exec!
+      end
+
+      def create(params)
+        raise Desk::Error::MethodNotSupported unless base_class.respond_to?(:create)
+        base_class.create(client, clean_base_url, params)
+      end
+
+      [:page, :per_page].each do |method|
+        define_method(method) do |value = nil|
+          if not value
+            self.exec! if self.query_params(method.to_s) == nil
+            return self.query_params(method.to_s).to_i
+          end
+          self.query_params = Hash[method.to_s, value.to_s]
+          self
+        end
+      end
+
+      def by_id(id)
+        by_url("#{clean_base_url}/#{id}")
+      end
+
+    protected
+    
+      attr_reader :records
+
+      def setup(definition)
+        setup_embedded(definition._embedded['entries']) if definition._embedded?
+        super(definition)
+      end
+
+      def query_params(param)
+        params = Addressable::URI.parse(@_links.self.href).query_values || {}
+        params.include?(param) ? params[param] : nil
+      end
+
+      def query_params=(params = {})
+        return @_links.self.href if params.empty?
+
+        uri = Addressable::URI.parse(@_links.self.href)
+        params = (uri.query_values || {}).merge(params)
+
+        @loaded = false unless params == uri.query_values
+
+        uri.query_values = params
+        @_links.self.href = uri.to_s
+      end
+
+      def clean_base_url
+        Addressable::URI.parse(@_links.self.href).path.gsub(/\/search$/, '') 
+      end
+
+      def base_class
+        resource(clean_base_url[/\w+$/].singularize)
+      end
+    end
+  end
+end

data/lib/desk/resource/reply.rb

@@ -0,0 +1,8 @@
+module Desk
+  class Resource
+    class Reply < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+    end
+  end
+end

data/lib/desk/resource/topic.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class Topic < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/topic_translation.rb

@@ -0,0 +1,9 @@
+module Desk
+  class Resource
+    class TopicTranslation < Desk::Resource
+      include Desk::Action::Create
+      include Desk::Action::Update
+      include Desk::Action::Delete
+    end
+  end
+end

data/lib/desk/resource/user_preference.rb

@@ -0,0 +1,7 @@
+module Desk
+  class Resource
+    class UserPreference < Desk::Resource
+      include Desk::Action::Update
+    end
+  end
+end