desk_api 0.1.0 → 0.1.1

data/lib/desk_api/resource/customer.rb

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

data/lib/desk_api/resource/integration_url.rb

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

data/lib/desk_api/resource/job.rb

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

data/lib/desk_api/resource/label.rb

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

data/lib/desk_api/resource/macro.rb

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

data/lib/desk_api/resource/macro_action.rb

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

data/lib/desk_api/resource/note.rb

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

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

@@ -1,8 +1,8 @@
-module Desk
+module DeskApi
   class Resource
-    class Page < Desk::Resource
+    class Page < DeskApi::Resource
       include Enumerable
-      include Desk::Action::Embedded
+      include DeskApi::Action::Embedded
 
       [
         :all?, :any?,
@@ -17,14 +17,14 @@ module Desk
       end
 
       def search(params)
-        raise Desk::Error::MethodNotSupported unless base_class.respond_to?(:search)
+        raise DeskApi::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)
+        raise DeskApi::Error::MethodNotSupported unless base_class.respond_to?(:create)
         base_class.create(client, clean_base_url, params)
       end
 

data/lib/desk_api/resource/reply.rb

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

data/lib/desk_api/resource/topic.rb

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

data/lib/desk_api/resource/topic_translation.rb

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

data/lib/desk_api/resource/user_preference.rb

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

data/lib/desk_api/response/raise_error.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'desk_api/error/bad_gateway'
+require 'desk_api/error/bad_request'
+require 'desk_api/error/conflict'
+require 'desk_api/error/forbidden'
+require 'desk_api/error/gateway_timeout'
+require 'desk_api/error/internal_server_error'
+require 'desk_api/error/method_not_allowed'
+require 'desk_api/error/not_acceptable'
+require 'desk_api/error/not_found'
+require 'desk_api/error/service_unavailable'
+require 'desk_api/error/too_many_requests'
+require 'desk_api/error/unauthorized'
+require 'desk_api/error/unprocessable_entity'
+require 'desk_api/error/unsupported_media_type'
+
+module DeskApi
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+      def on_complete(env)
+        status_code = env[:status].to_i
+        error_class = @klass.errors[status_code]
+        raise error_class.from_response(env) if error_class
+      end
+
+      def initialize(app, klass)
+        @klass = klass
+        super(app)
+      end
+    end
+
+    Faraday.register_middleware :response, raise_error: lambda { RaiseError}
+  end
+end

data/lib/desk_api/version.rb

@@ -0,0 +1,3 @@
+module DeskApi
+  VERSION = '0.1.1'
+end

data/spec/cassettes/{Desk_Client → DeskApi_Client}/_delete/deletes_a_resource.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: delete
-    uri: https://devel.desk.com/api/v2/topics/556401
+    uri: https://devel.desk.com/api/v2/topics/558245
     body:
       encoding: US-ASCII
       string: ''
@@ -21,7 +21,7 @@ http_interactions:
       Cache-Control:
       - no-cache
       Date:
-      - Thu, 15 Aug 2013 21:25:38 GMT
+      - Mon, 19 Aug 2013 23:53:31 GMT
       Status:
       - 204 No Content
       Vary:
@@ -35,14 +35,14 @@ http_interactions:
       X-Rate-Limit-Remaining:
       - '59'
       X-Rate-Limit-Reset:
-      - '22'
+      - '29'
       X-Request-Id:
-      - 207b551751f30fa3c1f74de6c8439d47
+      - d699571cf1eeca0714f02b9ee61bcbd8
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
       string: ''
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:25:38 GMT
+  recorded_at: Mon, 19 Aug 2013 23:53:31 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Client → DeskApi_Client}/_get/fetches_resources.yml

@@ -23,7 +23,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:31 GMT
+      - Mon, 19 Aug 2013 23:51:35 GMT
       ETag:
       - '"31cb249bf0be971be83b891b995e19f4"'
       Status:
@@ -37,11 +37,11 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '58'
+      - '36'
       X-Rate-Limit-Reset:
-      - '29'
+      - '25'
       X-Request-Id:
-      - 8b43d4f91183871f761bee73f9bca5a7
+      - c57375cb946f6c499ce01ecdc8e35527
       Content-Length:
       - '942'
       Connection:
@@ -51,5 +51,5 @@ http_interactions:
       string: '{"external_id":"","subject":"Testing Quick Case","priority":8,"locked_until":null,"description":"Some
         additional Description regarding this email.","status":"resolved","type":"email","labels":[],"language":"de","active_at":"2013-05-10T19:08:27Z","created_at":"2013-05-10T19:08:10Z","updated_at":"2013-05-10T19:08:10Z","received_at":null,"custom_fields":{"my_new_custom_field":null,"my_new_number_field":null,"my_new_date_field":null,"my_new_boolean_field":null,"my_new_list_field":null},"_links":{"self":{"href":"/api/v2/cases/3014","class":"case"},"message":{"href":"/api/v2/cases/3014/message","class":"email"},"customer":{"href":"/api/v2/customers/37823480","class":"customer"},"assigned_user":null,"assigned_group":null,"locked_by":null,"replies":{"href":"/api/v2/cases/3014/replies","class":"reply"},"notes":{"href":"/api/v2/cases/3014/notes","class":"note"},"attachments":{"href":"/api/v2/cases/3014/attachments","class":"attachment"}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:31 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:35 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Client → DeskApi_Client}/_patch/updates_a_resource.yml

@@ -23,7 +23,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:26:17 GMT
+      - Mon, 19 Aug 2013 23:51:35 GMT
       ETag:
       - '"02ad91e6c4bff038228c0649f84e02f2"'
       Server:
@@ -41,13 +41,13 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '59'
+      - '37'
       X-Rate-Limit-Reset:
-      - '43'
+      - '25'
       X-Request-Id:
-      - 7f096fa617be76a27a19e8681eb4ce1c
+      - 2cf01c7ab3a9ebb4c876b80ad417570f
       X-Runtime:
-      - '0.109308'
+      - '0.120622'
       X-UA-Compatible:
       - IE=Edge,chrome=1
       Content-Length:
@@ -58,5 +58,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"name":"Test Updated Topic","description":null,"position":2,"allow_questions":true,"in_support_center":null,"created_at":"2013-08-14T19:37:08Z","updated_at":"2013-08-15T21:26:17Z","_links":{"self":{"href":"/api/v2/topics/556402","class":"topic"},"articles":{"href":"/api/v2/topics/556402/articles","class":"article"},"translations":{"href":"/api/v2/topics/556402/translations","class":"topic_translation"}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:26:17 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:35 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Client → DeskApi_Client}/_post/creates_a_resource.yml

@@ -25,11 +25,11 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:31 GMT
+      - Mon, 19 Aug 2013 23:51:35 GMT
       ETag:
-      - '"3c4f0bfe1c766352a73767947ef10d16"'
+      - '"d2a4b62bd50a12b48e02ab932b328c01"'
       Location:
-      - https://devel.desk.com/api/v2/topics/556907
+      - https://devel.desk.com/api/v2/topics/558245
       Status:
       - 201 Created
       Vary:
@@ -41,18 +41,18 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '57'
+      - '38'
       X-Rate-Limit-Reset:
-      - '29'
+      - '25'
       X-Request-Id:
-      - 5674ba3810d8890b8a42aee61fd07310
+      - 54760404a640fbfe0a3bff1656fee0a0
       Content-Length:
       - '400'
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"name":"Test Topic","description":null,"position":4,"allow_questions":true,"in_support_center":null,"created_at":"2013-08-15T21:20:31Z","updated_at":"2013-08-15T21:20:31Z","_links":{"self":{"href":"/api/v2/topics/556907","class":"topic"},"articles":{"href":"/api/v2/topics/556907/articles","class":"article"},"translations":{"href":"/api/v2/topics/556907/translations","class":"topic_translation"}}}'
+      string: '{"name":"Test Topic","description":null,"position":5,"allow_questions":true,"in_support_center":null,"created_at":"2013-08-19T23:51:35Z","updated_at":"2013-08-19T23:51:35Z","_links":{"self":{"href":"/api/v2/topics/558245","class":"topic"},"articles":{"href":"/api/v2/topics/558245/articles","class":"article"},"translations":{"href":"/api/v2/topics/558245/translations","class":"topic_translation"}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:31 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:35 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Error → DeskApi_Error}/_from_response/can_be_created_from_a_faraday_response.yml

@@ -25,7 +25,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:33 GMT
+      - Mon, 19 Aug 2013 23:51:35 GMT
       Status:
       - 422 Unprocessable Entity
       Vary:
@@ -37,11 +37,11 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '41'
+      - '35'
       X-Rate-Limit-Reset:
-      - '27'
+      - '25'
       X-Request-Id:
-      - ea7ad37529e40967a818f50ff549a92f
+      - becf179db61ace2d1f037a1bfdd58c86
       Content-Length:
       - '71'
       Connection:
@@ -50,5 +50,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"Validation Failed","errors":{"_links":{"topic":["blank"]}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:33 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:35 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Error → DeskApi_Error}/_from_response/uses_the_body_message_if_present.yml

@@ -25,7 +25,7 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:34 GMT
+      - Mon, 19 Aug 2013 23:51:35 GMT
       Status:
       - 422 Unprocessable Entity
       Vary:
@@ -37,11 +37,11 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '40'
+      - '34'
       X-Rate-Limit-Reset:
-      - '26'
+      - '25'
       X-Request-Id:
-      - 9329fb9e911477d8a2527a0fc833461a
+      - 6cc0437c55b08577a71d1791c92732d1
       Content-Length:
       - '71'
       Connection:
@@ -50,5 +50,5 @@ http_interactions:
       encoding: UTF-8
       string: '{"message":"Validation Failed","errors":{"_links":{"topic":["blank"]}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:34 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:35 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Resource → DeskApi_Resource}/_by_url/finds_resources_by_url.yml

@@ -23,9 +23,9 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:32 GMT
+      - Mon, 19 Aug 2013 23:51:34 GMT
       ETag:
-      - '"13b3639ad423f0298f52f6782b69c3d1"'
+      - '"9c195d070361a74830027d6597f70068"'
       Status:
       - 200 OK
       Vary:
@@ -37,11 +37,11 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '48'
+      - '41'
       X-Rate-Limit-Reset:
-      - '28'
+      - '26'
       X-Request-Id:
-      - ae8df696c5ba322cc0780cf21f677630
+      - 873b3d92ff9101126801b0ad2e6576dc
       Content-Length:
       - '20825'
       Connection:
@@ -307,7 +307,7 @@ http_interactions:
         Latin words, combined with a handful of model sentence structures, to generate
         Lorem Ipsum which looks reasonable. The generated Lorem Ipsum is therefore
         always free from repetition, injected humour, or non-characteristic words
-        etc.","body_facebook_auto":true,"keywords":"","position":1,"quickcode":null,"in_support_center":true,"internal_notes":"","publish_at":"2013-08-05T01:13:36Z","created_at":"2013-07-05T15:45:25Z","updated_at":"2013-08-15T21:20:32Z","_links":{"self":{"href":"/api/v2/articles/1213277","class":"article"},"topic":{"href":"/api/v2/topics/498301","class":"topic"},"translations":{"href":"/api/v2/articles/1213277/translations","class":"article_translation"}}}'
+        etc.","body_facebook_auto":true,"keywords":"","position":1,"quickcode":null,"in_support_center":true,"internal_notes":"","publish_at":"2013-08-05T01:13:36Z","created_at":"2013-07-05T15:45:25Z","updated_at":"2013-08-19T23:51:33Z","_links":{"self":{"href":"/api/v2/articles/1213277","class":"article"},"topic":{"href":"/api/v2/topics/498301","class":"topic"},"translations":{"href":"/api/v2/articles/1213277/translations","class":"article_translation"}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:32 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:34 GMT
 recorded_with: VCR 2.5.0

data/spec/cassettes/{Desk_Resource → DeskApi_Resource}/_create/creates_a_new_topic.yml

@@ -25,11 +25,11 @@ http_interactions:
       Content-Type:
       - application/json; charset=utf-8
       Date:
-      - Thu, 15 Aug 2013 21:20:32 GMT
+      - Mon, 19 Aug 2013 23:51:34 GMT
       ETag:
-      - '"c0bf83a9a262a8d228d6fe2561304ffa"'
+      - '"bab2dddbec638f47dbb9481cc01e4659"'
       Location:
-      - https://devel.desk.com/api/v2/topics/556908
+      - https://devel.desk.com/api/v2/topics/558244
       Status:
       - 201 Created
       Vary:
@@ -41,18 +41,18 @@ http_interactions:
       X-Rate-Limit-Limit:
       - '60'
       X-Rate-Limit-Remaining:
-      - '49'
+      - '42'
       X-Rate-Limit-Reset:
-      - '28'
+      - '26'
       X-Request-Id:
-      - 66ac5d2b40d3acf6a840deea8cfe1da0
+      - 0b7a3ccc86a35ef7a27b131fd03aab84
       Content-Length:
       - '402'
       Connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"name":"My new topic","description":null,"position":5,"allow_questions":true,"in_support_center":null,"created_at":"2013-08-15T21:20:32Z","updated_at":"2013-08-15T21:20:32Z","_links":{"self":{"href":"/api/v2/topics/556908","class":"topic"},"articles":{"href":"/api/v2/topics/556908/articles","class":"article"},"translations":{"href":"/api/v2/topics/556908/translations","class":"topic_translation"}}}'
+      string: '{"name":"My new topic","description":null,"position":4,"allow_questions":true,"in_support_center":null,"created_at":"2013-08-19T23:51:34Z","updated_at":"2013-08-19T23:51:34Z","_links":{"self":{"href":"/api/v2/topics/558244","class":"topic"},"articles":{"href":"/api/v2/topics/558244/articles","class":"article"},"translations":{"href":"/api/v2/topics/558244/translations","class":"topic_translation"}}}'
     http_version: 
-  recorded_at: Thu, 15 Aug 2013 21:20:32 GMT
+  recorded_at: Mon, 19 Aug 2013 23:51:34 GMT
 recorded_with: VCR 2.5.0