desk_api 0.1.0

data/lib/desk/resource.rb

@@ -0,0 +1,53 @@
+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
+  class Resource
+    include Desk::Action::Resource
+    include Desk::Action::Link
+    include Desk::Action::Field
+
+    def initialize(client, definition = {}, loaded = false)
+      @client, @loaded, @_changed = client, loaded, {}
+      setup(definition)
+    end
+
+    def by_url(url)
+      definition = client.get(url).body
+      resource(definition._links.self['class']).new(client, definition, true)
+    end
+
+    def get_self
+      @_links.self
+    end
+
+  protected
+    attr_accessor :client, :loaded, :_changed
+
+    def setup(definition)
+      setup_links(definition._links) if definition._links?
+      setup_fields(definition)
+      self
+    end
+
+    def exec!(reload = false)
+      return self if loaded and !reload
+      definition, @loaded = client.get(@_links.self.href).body, true
+      setup(definition)
+    end
+
+    def method_missing(method, *args, &block)
+      self.exec! if !loaded
+      raise Desk::Error::MethodNotSupported unless self.respond_to?(method.to_sym)
+      self.send(method, *args, &block) 
+    end
+  end
+end

data/lib/desk/resources.json

@@ -0,0 +1,76 @@
+{
+  "_links": {
+    "articles": {
+      "href": "/api/v2/articles",
+      "class": "page"
+    },
+    "cases": {
+      "href": "/api/v2/cases",
+      "class": "page"
+    },
+    "companies": {
+      "href": "/api/v2/companies",
+      "class": "page"
+    },
+    "custom_fields": {
+      "href": "/api/v2/custom_fields",
+      "class": "page"
+    },
+    "customers": {
+      "href": "/api/v2/customers",
+      "class": "page"
+    },
+    "filters": {
+      "href": "/api/v2/filters",
+      "class": "page"
+    },
+    "groups": {
+      "href": "/api/v2/groups",
+      "class": "page"
+    },
+    "inbound_mailboxes": {
+      "href": "/api/v2/inbound_mailboxes",
+      "class": "page"
+    },
+    "integration_urls": {
+      "href": "/api/v2/integration_urls",
+      "class": "page"
+    },
+    "jobs": {
+      "href": "/api/v2/jobs",
+      "class": "page"
+    },
+    "labels": {
+      "href": "/api/v2/labels",
+      "class": "page"
+    },
+    "macros": {
+      "href": "/api/v2/macros",
+      "class": "page"
+    },
+    "rules": {
+      "href": "/api/v2/rules",
+      "class": "page"
+    },
+    "site_settings": {
+      "href": "/api/v2/site_settings",
+      "class": "page"
+    },
+    "system_message": {
+      "href": "/api/v2/system_message",
+      "class": "system_message"
+    },
+    "topics": {
+      "href": "/api/v2/topics",
+      "class": "page"
+    },
+    "twitter_accounts": {
+      "href": "/api/v2/twitter_accounts",
+      "class": "page"
+    },
+    "users": {
+      "href": "/api/v2/users",
+      "class": "page"
+    }
+  }
+}

data/lib/desk/response/raise_error.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'desk/error/bad_gateway'
+require 'desk/error/bad_request'
+require 'desk/error/conflict'
+require 'desk/error/forbidden'
+require 'desk/error/gateway_timeout'
+require 'desk/error/internal_server_error'
+require 'desk/error/method_not_allowed'
+require 'desk/error/not_acceptable'
+require 'desk/error/not_found'
+require 'desk/error/service_unavailable'
+require 'desk/error/too_many_requests'
+require 'desk/error/unauthorized'
+require 'desk/error/unprocessable_entity'
+require 'desk/error/unsupported_media_type'
+
+module Desk
+  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/version.rb

@@ -0,0 +1,3 @@
+module Desk
+  VERSION = '0.1.0'
+end

data/lib/desk.rb

@@ -0,0 +1,35 @@
+require 'uri'
+require 'json'
+require 'forwardable'
+require 'addressable/uri'
+
+require 'hashie/mash'
+require 'active_support/inflector'
+
+require 'desk/configuration'
+require 'desk/client'
+require 'desk/version'
+
+module Desk
+  class << self
+    include Desk::Configuration
+
+    # Delegate to a Desk::Client
+    #
+    # @return [Desk::Client]
+    def client
+      return @client if instance_variable_defined?(:@client) && @client.hash == options.hash
+      @client = Desk::Client.new(options)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return super unless respond_to_missing?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      client.respond_to?(method_name, include_private)
+    end
+  end
+  setup
+end

data/spec/cassettes/Desk_Client/_delete/deletes_a_resource.yml

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://devel.desk.com/api/v2/topics/556401
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+  response:
+    status:
+      code: 204
+      message: 
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - no-cache
+      Date:
+      - Thu, 15 Aug 2013 21:25:38 GMT
+      Status:
+      - 204 No Content
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '59'
+      X-Rate-Limit-Reset:
+      - '22'
+      X-Request-Id:
+      - 207b551751f30fa3c1f74de6c8439d47
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Thu, 15 Aug 2013 21:25:38 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/Desk_Client/_get/fetches_resources.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://devel.desk.com/api/v2/cases/3014
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - must-revalidate, private, max-age=0
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 15 Aug 2013 21:20:31 GMT
+      ETag:
+      - '"31cb249bf0be971be83b891b995e19f4"'
+      Status:
+      - 200 OK
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '58'
+      X-Rate-Limit-Reset:
+      - '29'
+      X-Request-Id:
+      - 8b43d4f91183871f761bee73f9bca5a7
+      Content-Length:
+      - '942'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      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_with: VCR 2.5.0

data/spec/cassettes/Desk_Client/_patch/updates_a_resource.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://devel.desk.com/api/v2/topics/556402
+    body:
+      encoding: UTF-8
+      string: '{"name":"Test Updated Topic"}'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 15 Aug 2013 21:26:17 GMT
+      ETag:
+      - '"02ad91e6c4bff038228c0649f84e02f2"'
+      Server:
+      - nginx
+      Status:
+      - 200 OK
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rack-Cache:
+      - invalidate, pass
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '59'
+      X-Rate-Limit-Reset:
+      - '43'
+      X-Request-Id:
+      - 7f096fa617be76a27a19e8681eb4ce1c
+      X-Runtime:
+      - '0.109308'
+      X-UA-Compatible:
+      - IE=Edge,chrome=1
+      Content-Length:
+      - '408'
+      Connection:
+      - keep-alive
+    body:
+      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_with: VCR 2.5.0

data/spec/cassettes/Desk_Client/_post/creates_a_resource.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://devel.desk.com/api/v2/topics
+    body:
+      encoding: UTF-8
+      string: '{"name":"Test Topic"}'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: 
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 15 Aug 2013 21:20:31 GMT
+      ETag:
+      - '"3c4f0bfe1c766352a73767947ef10d16"'
+      Location:
+      - https://devel.desk.com/api/v2/topics/556907
+      Status:
+      - 201 Created
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '57'
+      X-Rate-Limit-Reset:
+      - '29'
+      X-Request-Id:
+      - 5674ba3810d8890b8a42aee61fd07310
+      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"}}}'
+    http_version: 
+  recorded_at: Thu, 15 Aug 2013 21:20:31 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/Desk_Error/_from_response/can_be_created_from_a_faraday_response.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://devel.desk.com/api/v2/articles
+    body:
+      encoding: UTF-8
+      string: '{"subject":"Testing","body":"Testing"}'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 422
+      message: 
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 15 Aug 2013 21:20:33 GMT
+      Status:
+      - 422 Unprocessable Entity
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '41'
+      X-Rate-Limit-Reset:
+      - '27'
+      X-Request-Id:
+      - ea7ad37529e40967a818f50ff549a92f
+      Content-Length:
+      - '71'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Validation Failed","errors":{"_links":{"topic":["blank"]}}}'
+    http_version: 
+  recorded_at: Thu, 15 Aug 2013 21:20:33 GMT
+recorded_with: VCR 2.5.0

data/spec/cassettes/Desk_Error/_from_response/uses_the_body_message_if_present.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://devel.desk.com/api/v2/articles
+    body:
+      encoding: UTF-8
+      string: '{"subject":"Testing","body":"Testing"}'
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - desk.com Ruby Gem v0.1.0
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 422
+      message: 
+    headers:
+      Accept-Ranges:
+      - bytes
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Thu, 15 Aug 2013 21:20:34 GMT
+      Status:
+      - 422 Unprocessable Entity
+      Vary:
+      - X-AppVersion
+      X-AppVersion:
+      - '7.9'
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Rate-Limit-Limit:
+      - '60'
+      X-Rate-Limit-Remaining:
+      - '40'
+      X-Rate-Limit-Reset:
+      - '26'
+      X-Request-Id:
+      - 9329fb9e911477d8a2527a0fc833461a
+      Content-Length:
+      - '71'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"message":"Validation Failed","errors":{"_links":{"topic":["blank"]}}}'
+    http_version: 
+  recorded_at: Thu, 15 Aug 2013 21:20:34 GMT
+recorded_with: VCR 2.5.0