frontapp 0.0.7 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c573ee9e41c505f7ae67d76e311ec2ec123c2867
-  data.tar.gz: 74e59d6e4ad2da9222f73f306ba72c48c25c4c39
+  metadata.gz: 39e2a2ed37f421a9e27a5d093b6b8edfabefe858
+  data.tar.gz: 11239032440cc8d9d85fc008944180325ed8c0f0
 SHA512:
-  metadata.gz: e4fc9da700dc96567f72b1560a11618223ca1a0b6e11a26dab0f16c69fbb6b65185e6d53573a6c90a1ac1ae3fa5c968a04a95c41a48c5b2dd9adddc680bc313c
-  data.tar.gz: 898cc2bec4f83d88f4d7f2476a6fef5a1921532531bc06d1a30d91c9f8cdcddd6e47c3d012991570ef62e3c069cdef541c6f335f398ddd727b2734bc96168e9e
+  metadata.gz: 4dcb5247a8e1efc3b367fe0f71852eb4c1676a7544446f640abe791d6c0b5b33c0f5ae26208d9f320ac9b95bd015b9f0ea2d08928952485f19eb1cf010b7f40e
+  data.tar.gz: 026dad6c0c6fd6ad2f5cfab7cf943f8dcf17174704f3f9b261e8ce4256eb41aeb3141c53017f53ad672bc1400233d39fb5f47031d642183a8e8cf18f02cb0ffe

data/lib/frontapp/client.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'http'
 require 'json'
+require_relative 'client/attachments.rb'
 require_relative 'client/channels.rb'
 require_relative 'client/comments.rb'
 require_relative 'client/contact_groups.rb'
@@ -14,6 +15,7 @@ require_relative 'client/tags.rb'
 require_relative 'client/teammates.rb'
 require_relative 'client/teams.rb'
 require_relative 'client/topics.rb'
+require_relative 'client/links.rb'
 require_relative 'client/exports.rb'
 require_relative 'error'
 require_relative 'version'
@@ -21,6 +23,7 @@ require_relative 'version'
 module Frontapp
   class Client
 
+    include Frontapp::Client::Attachments
     include Frontapp::Client::Channels
     include Frontapp::Client::Comments
     include Frontapp::Client::ContactGroups
@@ -34,6 +37,7 @@ module Frontapp
     include Frontapp::Client::Teammates
     include Frontapp::Client::Teams
     include Frontapp::Client::Topics
+    include Frontapp::Client::Links
     include Frontapp::Client::Exports
 
     def initialize(options={})
@@ -76,6 +80,24 @@ module Frontapp
       JSON.parse(res.to_s)
     end
 
+    def get_plain(path)
+      headers_copy = @headers.dup
+      res = @headers.accept("text/plain").get("#{base_url}#{path}")
+      if !res.status.success?
+        raise Error.from_response(res)
+      end
+      res.to_s
+    end
+
+    def get_raw(path)
+      headers_copy = @headers.dup
+      res = @headers.get("#{base_url}#{path}")
+      if !res.status.success?
+        raise Error.from_response(res)
+      end
+      res
+    end
+
     def create(path, body)
       res = @headers.post("#{base_url}#{path}", json: body)
       response = JSON.parse(res.to_s)
@@ -114,13 +136,15 @@ module Frontapp
         res << q.map do |k, v|
           case v
           when Symbol, String
-            "q[#{k}][]=#{URI.encode(v)}"
+            "q[#{k}]=#{URI.encode(v)}"
           when Array then
-            v.map { |c| "q[#{k}][]=#{URI.encode(c)}" }.join("&")
+            v.map { |c| "q[#{k}][]=#{URI.encode(c.to_s)}" }.join("&")
+          else
+            "q[#{k}]=#{URI.encode(v.to_s)}"
           end
         end
       end
-      res << params.map {|k,v| "#{k}=#{URI.encode(v)}"}
+      res << params.map {|k,v| "#{k}=#{URI.encode(v.to_s)}"}
       res.join("&")
     end
 

data/lib/frontapp/client/attachments.rb

@@ -0,0 +1,15 @@
+module Frontapp
+  class Client
+    module Attachments
+
+      # Parameters
+      # Name                Type    Description
+      # ----------------------------------------------------------
+      # attachment_link_id  string  Id of the requested attachment
+      # ----------------------------------------------------------
+      def download_attachment(attachment_link_id)
+        get_raw("download/#{attachment_link_id}")
+      end
+    end
+  end
+end

data/lib/frontapp/client/conversations.rb

@@ -70,6 +70,29 @@ module Frontapp
       def get_conversation_messages(conversation_id)
         list("conversations/#{conversation_id}/messages")
       end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id     string            The conversation Id
+      # link_ids            array (optional)  Link IDs to add Either link_ids or link_external_urls must be specified but not both
+      # link_external_urls  array (optional)  Link external urls to add. Creates links if necessary. Either link_ids or link_external_urls must be specified but not both
+      # ----------------------------------------------
+      def add_conversation_links!(conversation_id, params = {})
+        cleaned = params.permit(:link_ids, :link_external_urls)
+        create_without_response("conversations/#{conversation_id}/links", cleaned)
+      end
+
+      # Parameters
+      # Name             Type              Description
+      # ----------------------------------------------
+      # conversation_id  string            The conversation Id
+      # link_ids        array of strings  link IDs to remove
+      # ----------------------------------------------
+      def remove_conversation_links!(conversation_id, params = {})
+        cleaned = params.permit(:link_ids)
+        delete("conversations/#{conversation_id}/links", cleaned)
+      end
     end
   end
-end
+end

data/lib/frontapp/client/links.rb

@@ -0,0 +1,64 @@
+module Frontapp
+  class Client
+    module Links
+
+      def links(params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("links", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -------------------------------
+      # link_id  string  Id of the requested link
+      # -------------------------------
+      def get_link(link_id)
+        get("links/#{link_id}")
+      end
+
+      # Allowed attributes:
+      # Name          Type               Description
+      # ------------------------------------
+      # name          string (optional)  Name of the link. If none is specified, the external_url is used as a default
+      # external_url  string             Underlying identifying link/url of the link
+      # ------------------------------------
+      def create_link!(params = {})
+        cleaned = params.permit(:name, :external_url)
+        create("links", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # link_id  string  Id of the requested link
+      # -----------------------------
+      #
+      # Allowed attributes:
+      # Name  Type    Description
+      # ------------------------------------
+      # name  string  New name of the link
+      # ------------------------------------
+      def update_link!(link_id, params = {})
+        cleaned = params.permit(:name)
+        update("links/#{link_id}", cleaned)
+      end
+
+      # Parameters
+      # Name      Type    Description
+      # -----------------------------
+      # link_id  string  Id of the requested link
+      # -----------------------------
+      #
+      # Allowed params:
+      # Name        Type               Description
+      # ------------------------------------------
+      # q           object (optional)  Search query.
+      # q.statuses  array (optional)   List of the statuses of the conversations you want to list
+      # ------------------------------------------
+      def get_link_conversations(link_id, params = {})
+        cleaned = params.permit({ q: [:statuses] })
+        list("links/#{link_id}/conversations", cleaned)
+      end
+    end
+  end
+end

data/lib/frontapp/client/messages.rb

@@ -10,7 +10,17 @@ module Frontapp
       def get_message(message_id)
         get("messages/#{message_id}")
       end
-
+      
+      # Parameters
+      # Name        Type    Description
+      # -------------------------------
+      # message_id  string  Id of the requested message
+      # -------------------------------
+      def get_message_source(message_id)
+        get_plain("messages/#{message_id}").b
+        # .b sets encoding to ASCII-8BIT, which is safer for raw emails than UTF-8
+      end
+      
       # Parameters
       # Name        Type    Description
       # -------------------------------

data/lib/frontapp/client/topics.rb

@@ -15,9 +15,10 @@ module Frontapp
       # q.statuses  array (optional)   List of the statuses of the conversations you want to list
       # ------------------------------------------
       def get_topic_conversations(topic_id, params = {})
-        cleaned = params.permit({ q: [:statuses] })
-        list("topics/#{topic_id}/conversations", cleaned)
+        warn "[DEPRECATION] `Topics` is deprecated.  Please use `Links` instead."
+
+        get_link_conversations(topic_id, params)
       end
     end
   end
-end
+end

data/lib/frontapp/error.rb

@@ -6,6 +6,7 @@ module Frontapp
         when 401 then UnauthorizedError
         when 404 then NotFoundError
         when 409 then ConflictError
+        when 429 then TooManyRequestsError
         else self
         end
       error_class.new(response)
@@ -21,4 +22,5 @@ module Frontapp
   class NotFoundError < Error; end
   class ConflictError < Error; end
   class UnauthorizedError < Error; end
+  class TooManyRequestsError < Error; end
 end

data/lib/frontapp/version.rb

@@ -1,3 +1,3 @@
 module Frontapp
-  VERSION = "0.0.7"
+  VERSION = "0.0.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frontapp
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.11
 platform: ruby
 authors:
 - Niels van der Zanden
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 files:
 - lib/frontapp.rb
 - lib/frontapp/client.rb
+- lib/frontapp/client/attachments.rb
 - lib/frontapp/client/channels.rb
 - lib/frontapp/client/comments.rb
 - lib/frontapp/client/contact_groups.rb
@@ -82,6 +83,7 @@ files:
 - lib/frontapp/client/events.rb
 - lib/frontapp/client/exports.rb
 - lib/frontapp/client/inboxes.rb
+- lib/frontapp/client/links.rb
 - lib/frontapp/client/messages.rb
 - lib/frontapp/client/rules.rb
 - lib/frontapp/client/tags.rb