freshdesk 0.1

data/lib/freshdesk.rb

@@ -0,0 +1,133 @@
+require 'rest_client'
+require 'nokogiri'
+
+class Freshdesk
+
+  # custom errors
+  class AlreadyExistedError < StandardError; end
+  class ConnectionError < StandardError; end
+  
+  attr_accessor :base_url
+  
+  def initialize(base_url, username, password)
+    
+    @base_url = base_url
+    
+    RestClient.add_before_execution_proc do | req, params |
+      req.basic_auth username, password
+    end
+  end
+  
+  # Freshdesk API client support "GET" with id parameter optional
+  #   Returns nil if there is no response
+  def self.define_get(name, *args)
+    name = name.to_s
+    method_name = "get_" + name
+
+    define_method method_name do |*args| 
+      uri = mapping(name)
+      uri.gsub!(/.xml/, "/#{args}.xml") if args.size > 0
+
+      begin
+        response = RestClient.get uri
+      rescue Exception
+        response = nil
+      end
+    end
+  end
+  
+  # Freshdesk API client support "DELETE" with the required id parameter
+  def self.define_delete(name, *args)
+    name = name.to_s
+    method_name = "delete_" + name
+
+    define_method method_name do |args|
+      uri = mapping(name)
+      raise StandardError, "An ID is required to delete" if args.size.eql? 0
+      uri.gsub!(/.xml/, "/#{args}.xml")
+      RestClient.delete uri
+    end
+  end
+  
+  # Freshdesk API client support "POST" with the optional key, value parameter
+  #
+  #  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)
+    name = name.to_s
+    method_name = "post_" + name
+    
+    define_method method_name do |args|
+      raise StandardError, "Arguments are required to modify data" if args.size.eql? 0
+      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 
+        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
+        raise
+      end   
+      
+      response   
+    end
+  end
+  
+  [:tickets, :ticket_fields, :users, :forums, :solutions, :companies].each do |a|
+    define_get a
+    define_post a  
+    define_delete a
+  end
+  
+   
+  # Mapping of object name to url:
+  #   tickets => helpdesk/tickets.xml
+  #   ticket_fields => /ticket_fields.xml
+  #   users => /contacts.xml
+  #   forums => /categories.xml
+  #   solutions => /solution/categories.xml
+  #   companies => /customers.xml
+  def mapping(method_name)
+    path = 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 "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")
+    end
+  end
+  
+  # match with the root name of xml document that freskdesk uses
+  def doc_name(name)
+    doc = case name 
+      when "tickets" then "helpdesk_ticket"
+      when "ticket_fields" then "helpdesk-ticket-fields"
+      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

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: freshdesk
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- David Liman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby Gem for interfacing with the Freshdesk API
+email: limanoit@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/freshdesk.rb
+has_rdoc: true
+homepage: https://github.com/dvliman/freshdesk-api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for interfacing with the Freshdesk API
+test_files: []
+