desk_api 0.1.0 → 0.1.1

data/lib/{desk → desk_api}/default.rb

@@ -1,22 +1,22 @@
-require 'desk/version'
+require 'desk_api/version'
 
-module Desk
+module DeskApi
   module Default
     CONNECTION_OPTIONS = {
       headers: {
         accept: 'application/json',
-        user_agent: "desk.com Ruby Gem v#{Desk::VERSION}"
+        user_agent: "desk.com Ruby Gem v#{DeskApi::VERSION}"
       },
       request: {
         open_timeout: 5,
         timeout: 10
       }
-    } unless defined? Desk::Default::CONNECTION_OPTIONS
+    } unless defined? DeskApi::Default::CONNECTION_OPTIONS
 
     class << self
       # @return [Hash]
       def options
-        Hash[Desk::Configuration.keys.map{|key| [key, send(key)]}]
+        Hash[DeskApi::Configuration.keys.map{|key| [key, send(key)]}]
       end
 
       # @return [String]

data/lib/{desk → desk_api}/error.rb

@@ -1,6 +1,6 @@
-require 'desk/rate_limit'
+require 'desk_api/rate_limit'
 
-module Desk
+module DeskApi
   # Custom error class for rescuing from all desk.com errors
   class Error < StandardError
     attr_reader :rate_limit
@@ -10,9 +10,9 @@ module Desk
     # @param exception [Exception, String]
     # @param response_headers [Hash]
     # @param code [Integer]
-    # @return [Desk::Error]
+    # @return [DeskApi::Error]
     def initialize(exception=$!, response_headers={}, code = nil)
-      @rate_limit = Desk::RateLimit.new(response_headers)
+      @rate_limit = DeskApi::RateLimit.new(response_headers)
       @wrapped_exception = exception
       @code = code
       exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
@@ -26,7 +26,7 @@ module Desk
       # Create a new error from an HTTP response
       #
       # @param response [Hash]
-      # @return [Desk::Error]
+      # @return [DeskApi::Error]
       def from_response(response = {})
         error, code = parse_error(response[:body]), response[:status]
         new(error, response[:response_headers], code)

data/lib/{desk → desk_api}/error/bad_gateway.rb

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

data/lib/{desk → desk_api}/error/bad_request.rb

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

data/lib/{desk → desk_api}/error/client_error.rb

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

data/lib/{desk → desk_api}/error/configuration_error.rb

@@ -1,6 +1,6 @@
-require 'desk/error'
+require 'desk_api/error'
 
-module Desk
+module DeskApi
   class Error
     class ConfigurationError < ::ArgumentError
     end

data/lib/{desk → desk_api}/error/conflict.rb

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

data/lib/{desk → desk_api}/error/forbidden.rb

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

data/lib/{desk → desk_api}/error/gateway_timeout.rb

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

data/lib/desk_api/error/internal_server_error.rb

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

data/lib/{desk → desk_api}/error/method_not_allowed.rb

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

data/lib/{desk → desk_api}/error/method_not_supported.rb

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

data/lib/{desk → desk_api}/error/not_acceptable.rb

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

data/lib/{desk → desk_api}/error/not_found.rb

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

data/lib/desk_api/error/parse_error.rb

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

data/lib/desk_api/error/parser_error.rb

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

data/lib/{desk → desk_api}/error/server_error.rb

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

data/lib/desk_api/error/service_unavailable.rb

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

data/lib/{desk → desk_api}/error/too_many_requests.rb

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

data/lib/{desk → desk_api}/error/unauthorized.rb

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

data/lib/{desk → desk_api}/error/unprocessable_entity.rb

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

data/lib/{desk → desk_api}/error/unsupported_media_type.rb

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

data/lib/{desk → desk_api}/rate_limit.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   class RateLimit
     def initialize(attrs = {})
       @attrs = attrs

data/lib/{desk → desk_api}/request/retry.rb

@@ -1,4 +1,4 @@
-module Desk
+module DeskApi
   module Request
     class Retry < Faraday::Request::Retry
       def initialize(app, options = {})
@@ -13,7 +13,7 @@ module Desk
         
         begin
           @app.call(env)
-        rescue Desk::Error::TooManyRequests => e
+        rescue DeskApi::Error::TooManyRequests => e
           if retries > 0 and e.rate_limit.reset_in
             retries = 0
             sleep e.rate_limit.reset_in

data/lib/{desk → desk_api}/resource.rb

@@ -1,19 +1,19 @@
-require 'desk/action/create'
-require 'desk/action/delete'
-require 'desk/action/embedded'
-require 'desk/action/field'
-require 'desk/action/link'
-require 'desk/action/resource'
-require 'desk/action/search'
-require 'desk/action/update'
-
-require 'desk/error/method_not_supported'
-
-module Desk
+require 'desk_api/action/create'
+require 'desk_api/action/delete'
+require 'desk_api/action/embedded'
+require 'desk_api/action/field'
+require 'desk_api/action/link'
+require 'desk_api/action/resource'
+require 'desk_api/action/search'
+require 'desk_api/action/update'
+
+require 'desk_api/error/method_not_supported'
+
+module DeskApi
   class Resource
-    include Desk::Action::Resource
-    include Desk::Action::Link
-    include Desk::Action::Field
+    include DeskApi::Action::Resource
+    include DeskApi::Action::Link
+    include DeskApi::Action::Field
 
     def initialize(client, definition = {}, loaded = false)
       @client, @loaded, @_changed = client, loaded, {}
@@ -46,7 +46,7 @@ module Desk
 
     def method_missing(method, *args, &block)
       self.exec! if !loaded
-      raise Desk::Error::MethodNotSupported unless self.respond_to?(method.to_sym)
+      raise DeskApi::Error::MethodNotSupported unless self.respond_to?(method.to_sym)
       self.send(method, *args, &block) 
     end
   end

data/lib/desk_api/resource/article.rb

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

data/lib/desk_api/resource/article_translation.rb

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

data/lib/desk_api/resource/attachment.rb

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

data/lib/desk_api/resource/case.rb

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

data/lib/desk_api/resource/company.rb

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