freshdesk 0.1 → 0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDdjY2NmNWVjYmI4NTIxOWU4YmViNWU4OWE5ZmU2MjEwZDQxODllMw==
+  data.tar.gz: !binary |-
+    NjkzODhmMjk2ZjU2ZWFlNmEyMTE3YTI3NzRmZTYxMTFlMmU0ZTFlMw==
+SHA512:
+  metadata.gz: !binary |-
+    OTkzNTU2NmRhNjM1ODZkY2YwYzExZTFhZjYwMjk4MjA2MTU3ZmU4Mzk5Yjc1
+    YzZmNTczNmFhZDQ2ZTBmZWE0MzM1MTc2YTdiMTUwMmNiNDkyZDAwZDExZDEx
+    ODY1OWQ4YWNjNTQ5ODk1ODgzZTExZjg0NzVjZjZjOTYxNGJhMTc=
+  data.tar.gz: !binary |-
+    NWI3ZjYyMGZkMjNkOWFkYTY0NmQ3YjY4ZmEzMjc4N2I3MWEwZGMzMjA1NmY5
+    NmFiYTA0MTYwOGU0ZDQ2ZTZiNTAzYzIyNWUxOTJhYTljY2ZjMGVjYTIwZDM5
+    NDA0YzIyYjI0NjRkZDkzYzQ3MTJiNTc1YTgwMWMxYjg5ODY2NDk=

data/lib/freshdesk.rb

@@ -1,32 +1,81 @@
 require 'rest_client'
 require 'nokogiri'
+require 'uri'
 
 class Freshdesk
 
   # custom errors
   class AlreadyExistedError < StandardError; end
   class ConnectionError < StandardError; end
-  
+
   attr_accessor :base_url
-  
-  def initialize(base_url, username, password)
-    
+
+  def initialize(base_url, username, password='X')
+
     @base_url = base_url
-    
+
     RestClient.add_before_execution_proc do | req, params |
       req.basic_auth username, password
     end
   end
-  
+
+  def response_format
+    @response_format ||= "xml"
+  end
+
+  # Specify the response format to use--JSON or XML. Currently JSON is only
+  # supported for GETs, so other verbs will still use XML.
+  def response_format=(format)
+    unless format.downcase =~ /json|xml/
+      raise StandardError "Unsupported format: '#{format}'. Please specify 'xml' or 'json'."
+    end
+    @response_format = format.downcase
+  end
+
   # Freshdesk API client support "GET" with id parameter optional
   #   Returns nil if there is no response
-  def self.define_get(name, *args)
+  def self.fd_define_get(name)
+    name = name.to_s
+    method_name = "get_" + name
+
+    define_method method_name do |*args|
+      uri = mapping(name)
+      uri.gsub!(/\.xml/, "\.#{response_format}")
+
+      # If we've been passed a string paramter, it means we're fetching
+      # something like domain_URL/helpdesk/tickets/[ticket_id].xml
+      #
+      # If we're supplied with a hash parameter, it means we're fetching
+      # something like domain_URL/helpdesk/tickets.xml?filter_name=all_tickets&page=[value]
+      if args.size > 0
+        url_args = args.first
+        if url_args.class == Hash
+          uri += '?' + URI.encode_www_form(url_args)
+        else
+          uri.gsub!(/\.#{response_format}/, "/#{url_args}\.#{response_format}")
+        end
+      end
+
+      begin
+        response = RestClient.get uri
+      rescue Exception
+        response = nil
+      end
+    end
+  end
+
+  # Certain GET calls require query strings instead of a more
+  # RESTful URI. This method and fd_define_get are mutually exclusive.
+  def self.fd_define_parameterized_get(name)
     name = name.to_s
     method_name = "get_" + name
 
-    define_method method_name do |*args| 
+    define_method method_name do |params={}|
       uri = mapping(name)
-      uri.gsub!(/.xml/, "/#{args}.xml") if args.size > 0
+      uri.gsub!(/\.xml/, ".#{response_format}")
+      unless params.empty?
+        uri += '?' + URI.encode_www_form(params)
+      end
 
       begin
         response = RestClient.get uri
@@ -35,9 +84,9 @@ class Freshdesk
       end
     end
   end
-  
+
   # Freshdesk API client support "DELETE" with the required id parameter
-  def self.define_delete(name, *args)
+  def self.fd_define_delete(name)
     name = name.to_s
     method_name = "delete_" + name
 
@@ -48,55 +97,111 @@ class Freshdesk
       RestClient.delete uri
     end
   end
-  
+
   # Freshdesk API client support "POST" with the optional key, value parameter
   #
-  #  Will throw: 
+  #  Will throw:
   #    AlreadyExistedError if there is exact copy of data in the server
   #    ConnectionError     if there is connection problem with the server
-  def self.define_post(name, *args)
+  def self.fd_define_post(name)
     name = name.to_s
     method_name = "post_" + name
-    
-    define_method method_name do |args|
+
+    define_method method_name do |args, id=nil|
       raise StandardError, "Arguments are required to modify data" if args.size.eql? 0
-      uri = mapping(name)
-      
+      uri = mapping(name, id)
+
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.send(doc_name(name)) {
+          if args.has_key? :attachment
+            attachment_name = args[:attachment][:name] or raise StandardError, "Attachment name required"
+            attachment_cdata = args[:attachment][:cdata] or raise StandardError, "Attachment CDATA required"
+            xml.send("attachments", type: "array") {
+              xml.send("attachment") {
+                xml.send("resource", "type" => "file", "name" => attachment_name, "content-type" => "application/octet-stream") {
+                  xml.cdata attachment_cdata
+                }
+              }
+            }
+          args.except! :attachment
+          end
           args.each do |key, value|
             xml.send(key, value)
           end
         }
       end
 
-      begin 
+      begin
         response = RestClient.post uri, builder.to_xml, :content_type => "text/xml"
-        
+
       rescue RestClient::UnprocessableEntity
         raise AlreadyExistedError, "Entry already existed"
-      
+
       rescue RestClient::InternalServerError
         raise ConnectionError, "Connection to the server failed. Please check hostname"
-      
+
       rescue RestClient::Found
         raise ConnectionError, "Connection to the server failed. Please check username/password"
-      
-      rescue Exception => e3
+
+      rescue Exception
         raise
-      end   
-      
-      response   
+      end
+
+      response
     end
   end
-  
-  [:tickets, :ticket_fields, :users, :forums, :solutions, :companies].each do |a|
-    define_get a
-    define_post a  
-    define_delete a
+
+  # Freshdesk API client support "PUT" with key, value parameter
+  #
+  #  Will throw:
+  #    ConnectionError     if there is connection problem with the server
+  def self.fd_define_put(name)
+    name = name.to_s
+    method_name = "put_" + name
+
+    define_method method_name do |args|
+      raise StandardError, "Arguments are required to modify data" if args.size.eql? 0
+      raise StandardError, "id is required to modify data" if args[:id].nil?
+      uri = mapping(name)
+
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.send(doc_name(name)) {
+          args.each do |key, value|
+            xml.send(key, value)
+          end
+        }
+      end
+
+      begin
+        uri.gsub!(/.xml/, "/#{args[:id]}.xml")
+        response = RestClient.put uri, builder.to_xml, :content_type => "text/xml"
+
+      rescue RestClient::InternalServerError
+        raise ConnectionError, "Connection to the server failed. Please check hostname"
+
+      rescue RestClient::Found
+        raise ConnectionError, "Connection to the server failed. Please check username/password"
+
+      rescue Exception
+        raise
+      end
+
+      response
+    end
+  end
+
+  [:tickets, :ticket_fields, :ticket_notes, :users, :forums, :solutions, :companies, :time_sheets].each do |a|
+    fd_define_get a
+    fd_define_post a
+    fd_define_delete a
+    fd_define_put a
+  end
+
+  [:user_ticket].each do |resource|
+    fd_define_parameterized_get resource
   end
-  
-   
+
+
   # Mapping of object name to url:
   #   tickets => helpdesk/tickets.xml
   #   ticket_fields => /ticket_fields.xml
@@ -104,30 +209,29 @@ class Freshdesk
   #   forums => /categories.xml
   #   solutions => /solution/categories.xml
   #   companies => /customers.xml
-  def mapping(method_name)
-    path = case method_name
+  def mapping(method_name, id = nil)
+    case method_name
       when "tickets" then File.join(@base_url + "helpdesk/tickets.xml")
-      when "ticket_fields" then File.join( @base_url, "ticket_fields.xml")
+      when "user_ticket" then File.join(@base_url + "helpdesk/tickets/user_ticket.xml")
+      when "ticket_fields" then File.join(@base_url, "ticket_fields.xml")
+      when "ticket_notes" then File.join(@base_url, "helpdesk/tickets/#{id}/notes.xml")
       when "users" then File.join(@base_url, "contacts.xml")
       when "forums" then File.join(@base_url + "categories.xml")
       when "solutions" then File.join(@base_url + "solution/categories.xml")
       when "companies" then File.join(@base_url + "customers.xml")
+      when "time_sheets" then File.join(@base_url + "helpdesk/time_sheets.xml")
     end
   end
-  
+
   # match with the root name of xml document that freskdesk uses
   def doc_name(name)
-    doc = case name 
+    case name
       when "tickets" then "helpdesk_ticket"
       when "ticket_fields" then "helpdesk-ticket-fields"
+      when "ticket_notes" then "helpdesk_note"
       when "users" then "user"
       when "companies" then "customer"
       else raise StandardError, "No root object for this call"
     end
   end
 end
-
-#freshdesk = Freshdesk.new('http://onescreen.freshdesk.com', 'limanoit@gmail.com', '134658')
-#response  = freshdesk.post_users(:name => 'test', :email => 'test@143124test.com', :customer => "onescreen")
-#response = freshdesk.post_users(:name=>'NirmitPatel', :email=>'f.last@onescreen.com', :customer=>'1000500nemo')
-#puts response

metadata

@@ -1,74 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: freshdesk
-version: !ruby/object:Gem::Version 
-  version: "0.1"
+version: !ruby/object:Gem::Version
+  version: '0.2'
 platform: ruby
-authors: 
+authors:
 - David Liman
+- Tim Macdonald
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-22 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby Gem for interfacing with the Freshdesk API
-email: limanoit@gmail.com
+email: tsmacdonald@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/freshdesk.rb
-has_rdoc: true
 homepage: https://github.com/dvliman/freshdesk-api
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.1.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby Gem for interfacing with the Freshdesk API
 test_files: []
-