desk 0.3.3 → 1.0.0

data/lib/desk/client/mailbox.rb

@@ -0,0 +1,26 @@
+module Desk
+  class Client
+    module Mailbox
+
+      def mailbox_list_inbound(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        get("mailboxes/inbound", options)
+      end
+      alias_method :inbound_mailboxes, :mailbox_list_inbound
+      alias_method :list_inbound_mailboxes, :mailbox_list_inbound
+
+      def mailbox_show_inbound(mailbox_id)
+        get("mailboxes/inbound/#{mailbox_id}")
+      end
+      alias_method :inbound_mailbox, :mailbox_show_inbound
+      alias_method :show_inbound_mailbox, :mailbox_show_inbound
+
+      def mailbox_id_inbound(href, parent_id = false)
+        return nil if parent_id
+        href.split("/")[5].to_i
+      end
+      alias_method :inbound_mailbox_id, :mailbox_id_inbound
+
+    end
+  end
+end

data/lib/desk/client/rule.rb

@@ -0,0 +1,14 @@
+module Desk
+  class Client
+    module Rule
+
+      def rule_endpoints
+        [ :list, :show ]
+        # PLANNED
+        # [ :list_actions, :show_actions,
+        #   :list_conditions, :show_conditions ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/site_setting.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module SiteSetting
+
+      def site_setting_endpoints
+        [ :list, :show ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/system_message.rb

@@ -0,0 +1,16 @@
+module Desk
+  class Client
+    module SystemMessage
+
+      def show_system_message
+        get("system_message")
+      end
+      alias_method :system_message, :show_system_message
+
+      def system_message_id(href, parent_id = false)
+        nil
+      end
+
+    end
+  end
+end

data/lib/desk/client/topic.rb

@@ -1,90 +1,13 @@
 module Desk
   class Client
-    # Defines methods related to topics
     module Topic
-      # Returns extended information of topics
-      #
-      #   @option options [Boolean, String, Integer]
-      #   @example Return extended information for 12345
-      #     Desk.topics
-      #     Desk.topics(:count => 5)
-      #     Desk.topics(:count => 5, :page => 3)
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/topics/show
-      def topics(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("topics",options)
-        response
-      end
-
-      # Returns extended information on a single topic
-      #
-      #   @param id [Integer] a topic ID
-      #   @option options [Hash]
-      #   @example Return extended information for 12345
-      #     Desk.topic(12345)
-      #     Desk.topic(12345, :by => "external_id")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/topics/show
-      def topic(id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("topics/#{id}",options)
-        response.topic
-      end
 
-      # Creates a new topic
-      #
-      #   @param name [String] A topic name
-      #   @option options [Hash]
-      #   @example Creates a new topic
-      #     Desk.create_topic("name")
-      #     Desk.create_topic("name", :description => "description")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/topics/create
-      def create_topic(name, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = post("topics",options)
-        if response['success']
-          return response['results']['topic']
-        else
-          return response
-        end
+      def topic_endpoints
+        [ :list, :show, :create, :update, :delete,
+          :list_translations, :show_translation, :create_translation,
+          :update_translation, :delete_translation ]
       end
 
-      # Updates a single topic
-      #
-      #   @param id [Integer] a topic ID
-      #   @option options [String]
-      #   @example Updates information for topic 12345
-      #     Desk.update_topic(12345, :subject => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/topics/update
-      def update_topic(id, *args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = put("topics/#{id}",options)
-        if response['success']
-          return response['results']['topic']
-        else
-          return response
-        end
-      end
-
-      # Deletes a single topic
-      #
-      #   @param id [Integer] a topic ID
-      #   @example Deletes topic 12345
-      #     Desk.update_topic(12345, :subject => "New Subject")
-      # @format :json
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/topics/update
-      def delete_topic(id)
-        response = delete("topics/#{id}")
-        response
-      end
     end
   end
 end

data/lib/desk/client/twitter_account.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module TwitterAccount
+
+      def twitter_account_endpoints
+        [ :list, :show, :list_tweets, :show_tweet, :create_tweet ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/twitter_user.rb

@@ -0,0 +1,11 @@
+module Desk
+  class Client
+    module TwitterUser
+
+      def twitter_user_endpoints
+        [ :list, :show, :create ]
+      end
+
+    end
+  end
+end

data/lib/desk/client/user.rb

@@ -1,38 +1,11 @@
 module Desk
   class Client
-    # Defines methods related to users
     module User
-      # Returns extended information of a given user
-      #
-      # @overload user(user, options={})
-      #   @param user [Integer] An Assitely user ID
-      #   @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
-      #   @return [Hashie::Mash] The requested user.
-      #   @example Return extended information for 12345
-      #     Desk.user(12345)
-      # @format :json, :xml
-      # @authenticated true
-      # @see http://dev.desk.com/docs/api/users/show
-      def user(id,*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get("users/#{id}",options)
-        response.user
-      end
 
-      # Returns extended information for up to 100 users
-      #
-      # @format :json, :xml
-      # @authenticated true
-      # @rate_limited true
-      # @return [Array] The requested users.
-      # @see http://dev.desk.com/docs/api/users
-      # @example Return extended information account users
-      #   Desk.users
-      def users(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        response = get('users', options)
-        response
+      def user_endpoints
+        [ :list, :show, :list_preferences, :show_preference, :update_preference ]
       end
+
     end
   end
 end

data/lib/desk/configuration.rb

@@ -64,7 +64,7 @@ module Desk
     DEFAULT_USER_AGENT = "Desk.com Ruby Gem #{Desk::VERSION}".freeze
 
     # The user agent that will be sent to the API endpoint if none is set
-    DEFAULT_VERSION = "v1".freeze
+    DEFAULT_VERSION = "v2".freeze
 
     # By default, don't set a support email address
     DEFAULT_SUPPORT_EMAIL = nil

data/lib/desk/connection.rb

@@ -1,5 +1,6 @@
 require 'faraday_middleware'
 require 'faraday/request/multipart_with_file'
+require 'faraday/response/deashify'
 require 'faraday/response/raise_http_4xx'
 require 'faraday/response/raise_http_5xx'
 
@@ -22,7 +23,7 @@ module Desk
         builder.use Faraday::Request::Multipart
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Response::RaiseHttp4xx
-        builder.use Faraday::Response::Rashify unless raw
+        builder.use FaradayMiddleware::Deashify unless raw
         unless raw
           case format.to_s.downcase
           when 'json'

data/lib/desk/deash.rb

@@ -0,0 +1,100 @@
+require 'hashie/mash'
+
+module Hashie
+  class Links
+
+    def initialize(links)
+      @links = links
+    end
+
+    def method_missing(method, *args, &block)
+      if @links.key?(method)
+        return nil if !@links[method]
+        return Desk.get(@links[method].href.sub("/api/#{Desk.version}/", ""))
+      end
+      return super
+    end
+  end
+
+  class Deash < Mash
+    # Object#type is deprecated 
+    Mash.send :undef_method, :type
+
+    def count
+      if includes_key_chain?("raw._embedded.entries")
+        self.raw._embedded['entries'].count
+      else
+        super
+      end
+    end
+
+    def each
+      if includes_key_chain?("raw._embedded.entries")
+        self.raw._embedded['entries'].each do |entry|
+          yield entry
+        end
+      else
+        super
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      return self.[](method) if key?(method)
+      # TODO: Make this DRY
+      if includes_key_chain?("_links."+method.to_s)
+        return nil if !self._links[method]
+        return Desk.get(self._links[method].href.sub(Desk.api_path, ""))
+      elsif includes_key_chain?("raw._links."+method.to_s)
+        return nil if !self.raw._links[method]
+        return Desk.get(self.raw._links[method].href.sub(Desk.api_path, ""))
+      elsif includes_key_chain?("raw."+method.to_s)
+        return nil if !self.raw[method]
+        return self.raw[method]
+      end
+      return super
+    end
+
+    def id(parent_id = false)
+      id = nil
+      if includes_key_chain?("raw._links.self.href") ||
+         includes_key_chain?("_links.self.href")
+        c = self._links.self['class']
+        if Desk.respond_to? "#{c}_id"
+          id = Desk.send("#{c}_id", self._links.self.href, parent_id)
+        else
+          p = self._links.self.href.split("/")
+          if p.size > 5 && !parent_id
+            id = p[6]
+          elsif (p.size < 6 && !parent_id) || (p.size > 5 && parent_id)
+            id = p[4]
+          end
+          id = id.to_i if id.to_i != 0
+        end
+      end
+      id
+    end
+
+    def parent_id
+      id(true)
+    end
+
+    def includes_key_chain?(chain)
+      current_chain = self
+      chain.split(".").each do |k|
+        return false if !current_chain.key?(k)
+        current_chain = current_chain[k]
+      end
+      true
+    end
+
+    def links
+      Links.new(self._links) if key?("_links")
+      Links.new(self.raw._links) if includes_key_chain?("raw._links")
+    end
+
+    def results
+      self._embedded['entries'] if key?('_embedded') && self._embedded.key?('entries')
+    end
+
+  end
+end

data/lib/desk/request.rb

@@ -1,34 +1,42 @@
 module Desk
   # Defines HTTP request methods
   module Request
-    # Perform an HTTP GET request
-    def get(path, options={}, raw=false)
-      request(:get, path, options, raw)
-    end
-
-    # Perform an HTTP POST request
-    def post(path, options={}, raw=false)
-      request(:post, path, options, raw)
-    end
+    require 'json' unless defined?(::JSON)
+    REQUEST_METHODS = [
+      'get',
+      'patch',
+      'post',
+      'put',
+      'delete'
+    ].freeze
 
-    # Perform an HTTP PUT request
-    def put(path, options={}, raw=false)
-      request(:put, path, options, raw)
+    def method_missing(method_name, *args, &block)
+      if (REQUEST_METHODS.include? method_name.to_s) && (args.length > 0)
+        path = args[0]
+        options = args[1] ? args[1] : {}
+        raw = args[2] ? args[2] : false
+        request(method_name.to_sym, path, options, raw)
+      else
+        super
+      end
     end
 
-    # Perform an HTTP DELETE request
-    def delete(path, options={}, raw=false)
-      request(:delete, path, options, raw)
+    def respond_to?(method_name, include_private = false)
+      if (REQUEST_METHODS.include? method_name.to_s)
+        true
+      else
+        super
+      end
     end
 
     private
-    
+
     def before_request
       if Desk.minute != Time.now.min
         Desk.minute = Time.now.min
         Desk.counter = 0
       end
-      
+
       Desk.counter += 1
       if Desk.use_max_requests
         if Desk.counter > Desk.max_requests
@@ -44,16 +52,21 @@ module Desk
         case method
         when :get, :delete
           request.url(formatted_path(path), options)
-        when :post, :put
+        when :patch, :post, :put
           request.path = formatted_path(path)
-          request.body = options unless options.empty?
+          request.headers['Content-Type'] = 'application/json'
+          request.body = options.to_json unless options.empty?
         end
       end
       raw ? response : response.body
     end
 
     def formatted_path(path)
-      [path, format].compact.join('.')
+      if(self.version == "v1")
+        [path, format].compact.join('.')
+      else
+        path
+      end
     end
   end
 end