freshdesk-api-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd73cd89e68bb221ab2913c0ca2d11997e9276a2
+  data.tar.gz: 5eb140df6498a686d1ee7ae249af0ad96691809e
+SHA512:
+  metadata.gz: 9a5e3c2d991d7d63145e67016674e8fb35019c20aa8c1468c7495a7c87bdf36d039da6b6f9f20c68fc1431ed1ed83221e754d8a5a61f013ee0541436ba9c6870
+  data.tar.gz: b1c558358bd8ffb809eb5756cf4ce86325e5156092f21c468ae9c8f4ad08c238217db762047f50ab5900e925805537e1d2165059a19da279ac84f5a7a216ad53

data/lib/freshdesk-api-client.rb

@@ -0,0 +1,11 @@
+require 'base64'
+require 'json'
+require 'uri'
+
+require_relative 'freshdesk/api/client/helper'
+require_relative 'freshdesk/api/client/request'
+require_relative 'freshdesk/api/client/discussion'
+require_relative 'freshdesk/api/client/ticket'
+require_relative 'freshdesk/api/client/user'
+require_relative 'freshdesk/api/client/solution'
+

data/lib/freshdesk/api/client/discussion.rb

@@ -0,0 +1,81 @@
+module Freshdesk
+	module Api
+		module Client
+
+			class Discussion
+
+				CATEGORIES = "discussions/categories".freeze
+				FORUMS = "discussions/forums".freeze
+				TOPICS = "discussions/topics".freeze
+				POSTS = "discussions/posts".freeze
+
+				#Initialize with your freshdesk account url and api key.
+				def initialize base_url, api_key
+					@connection = Freshdesk::Api::Client::Request.new base_url, api_key
+				end
+
+				#Get category by passing its id.
+				def get_category id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES, id )
+				end
+
+				#Get Forum by passing its id.
+				def get_forum id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get FORUMS, id )
+				end
+
+				#Get topic by passing its id.
+				def get_topic id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get TOPICS, id )
+				end
+
+				#Create a category by passing payload. Please refer https://freshdesk.com/api#forum
+				def create_category payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post CATEGORIES, payload )
+				end
+
+				#Create a forum by passing payload. Please refer https://freshdesk.com/api#forum
+				def create_forum payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post FORUMS, payload )
+				end
+
+				#Create a topic by passing payload. Please refer https://freshdesk.com/api#forum
+				def create_topic payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post TOPICS, payload )
+				end
+
+				#Create a post by passing payload. Please refer https://freshdesk.com/api#forum
+				def create_post topic_id, payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post POSTS, payload, topic_id, nil, "create_post" )
+				end
+
+				#Lists all categories 
+				def list_categories
+					Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES )
+				end
+
+				#Delete category by passing its id.
+				def delete_category id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete CATEGORIES, id ).code
+					end
+				end
+
+				#Delete Forum by passing its id.
+				def delete_forum id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete FORUMS, id ).code
+					end
+				end
+
+				#Delete Post by passing its id. A Post cannot be deleted alone.
+				def delete_topic id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete TOPICS, id ).code
+					end
+				end				
+
+			end
+		end
+	end
+end

data/lib/freshdesk/api/client/helper.rb

@@ -0,0 +1,18 @@
+module Freshdesk
+	module Api
+		module Client
+			def self.convert_to_hash response
+				JSON.parse response.to_str
+			end
+
+			def self.delete_status_wrapper
+				response = yield if block_given?
+				if !response.nil? and (response >= 200 and response < 299)
+					true
+				else
+					false
+				end
+			end
+		end
+	end
+end

data/lib/freshdesk/api/client/request.rb

@@ -0,0 +1,98 @@
+require 'rest_client'
+
+module Freshdesk
+	module Api
+		module Client			
+			class Request
+
+				def initialize base_url, api_key
+					@base_url = base_url
+					@auth = create_auth_header api_key 
+				end
+
+				def get endpoint, id=nil, filters=nil, secondary_id=nil, method=nil
+					url = create_url endpoint, id, filters, secondary_id, method
+					handle_exceptions do
+						RestClient::Request.execute( url: url, method: :get, headers: @auth )
+					end
+				end
+
+				def post endpoint, payload, primary_id=nil, secondary_id=nil, method=nil
+					url = create_url endpoint, primary_id, nil, secondary_id, method
+					handle_exceptions do
+						RestClient::Request.execute( 
+							payload: payload.to_json,
+	              			headers: @auth.merge({content_type: "application/json"}),
+	              			method: :post,
+	              			url: url
+						)
+					end
+				end
+
+				def put endpoint, id, payload
+					url = create_url endpoint, id
+					handle_exceptions do
+						RestClient::Request.execute( 
+							payload: payload.to_json,
+	              			headers: @auth.merge({content_type: "application/json"}),
+	              			method: :put,
+	              			url: url
+						)
+					end
+				end
+
+				def delete endpoint, primary_id, secondary_id=nil, method=nil
+					url = create_url endpoint, primary_id, nil, secondary_id, method
+					p url
+					handle_exceptions do
+						RestClient::Request.execute( url: url, method: :delete, headers: @auth )
+					end
+				end
+
+				private
+
+				def handle_exceptions
+					begin
+						yield if block_given?
+					rescue RestClient::NotFound
+						raise Freshdesk::Api::InvalidEndpointError, "Endpoint is Invalid"
+					rescue RestClient::InternalServerError
+						raise Freshdesk::Api::ServerError, "Server Error"
+					rescue RestClient::UnprocessableEntity
+	              		raise Freshdesk::Api::AlreadyExistsError, "Entity already exists"
+	            	rescue RestClient::Found
+	              		raise Freshdesk::Api::ConnectionError, "Connection to the server failed. Please check username/password"
+	            	rescue Exception
+	              		raise
+	            	end
+				end
+
+				def create_url(endpoint, id=nil, filters=nil, secondary_id=nil, method=nil)
+		        	base = @base_url.end_with?("/") ? @base_url : "#{@base_url}/"
+		        	endpoint = endpoint.end_with?("/") ? endpoint : "#{endpoint}/"
+
+		        	url = "#{base}#{endpoint}#{id}"
+		        	url = "#{base}helpdesk/#{endpoint}#{id}" if(endpoint.include? "tickets" or endpoint.include? "conversations")
+		        	url = "#{base}discussions/topics/#{id}/posts" if(endpoint.include? "discussions/posts" and !id.nil? and method.eql? "create_post")
+		        	url = "#{base}solution/categories/#{id}/folders" if(method.eql? "create_folder")
+		        	url = "#{base}solution/categories/#{id}/folders/#{secondary_id}/articles" if(method.eql? "create_article")
+		        	url = "#{base}solution/categories/#{id}" if(method.eql? "list_folders" or method.eql? "delete_category")
+		        	url = "#{base}solution/categories/#{id}/folders/#{secondary_id}" if(method.eql? "list_articles" or method.eql? "delete_folder")
+
+
+		        	if url.end_with?("/")
+		            	url = url.slice(0, url.length - 1)
+		            end
+		            return "#{url}.json?#{filters}" unless filters.nil?
+		            "#{url}.json"
+		        end
+
+		        def create_auth_header api_key
+		        	token = Base64.encode64("#{api_key}:X")
+		        	{Authorization: "Basic #{token}"}
+		        end
+		        
+			end
+		end
+	end
+end

data/lib/freshdesk/api/client/solution.rb

@@ -0,0 +1,80 @@
+module Freshdesk
+	module Api
+		module Client
+
+			class Solution
+
+				CATEGORIES = "solution/categories".freeze
+				FOLDERS = "solution/folders".freeze
+				ARTICLES = "solution/articles".freeze
+
+				#Initialize with your freshdesk account url and api key.
+				def initialize base_url, api_key
+					@connection = Freshdesk::Api::Client::Request.new base_url, api_key
+				end
+
+				#Create category by passing its id. Please refer https://freshdesk.com/api#solution-category
+				def create_category payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post CATEGORIES, payload )
+				end
+
+
+				#Create folder by passing its id. Please refer https://freshdesk.com/api#solution-category
+				def create_folder category_id, payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post FOLDERS, payload, category_id, nil, "create_folder" )
+				end
+
+				#Create article by passing its id. Please refer https://freshdesk.com/api#solution-category
+				def create_article category_id, topic_id, payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post ARTICLES, payload, category_id, topic_id, "create_article" )
+				end
+
+				#Get category by its id.
+				def get_category id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES, id )
+				end
+
+				#Get folder by its id.
+				def get_folder id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get FOLDERS, id )
+				end
+
+				#Get article by its id.
+				def get_article id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get ARTICLES, id )
+				end
+
+				#List all articles by passing the category id and folder id together.
+				def list_articles category_id, folder_id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get ARTICLES, category_id, nil, folder_id, "list_articles" )
+				end
+
+				#List all folders by it category id.
+				def list_folders category_id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get FOLDERS, category_id, nil, nil,  "list_folders" )
+				end
+
+				#List all categories.
+				def list_categories 
+					Freshdesk::Api::Client.convert_to_hash( @connection.get CATEGORIES )
+				end
+
+				#Delete category by its id.
+				def delete_category id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete CATEGORIES, id, "delete_category" ).code
+					end
+				end
+
+				#Delete folder by category id and folder id.
+				def delete_folder category_id, id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete FOLDERS, category_id, id, "delete_folder" ).code
+					end
+				end
+
+			end 
+
+		end
+	end
+end

data/lib/freshdesk/api/client/ticket.rb

@@ -0,0 +1,63 @@
+module Freshdesk
+	module Api
+		module Client
+			class Ticket
+				TICKETS = "tickets".freeze
+				NOTES = "conversations/note".freeze
+
+				#Initialize with your freshdesk account url and api key.
+				def initialize base_url, api_key
+					@connection = Freshdesk::Api::Client::Request.new base_url, api_key
+				end
+
+				#Create ticket with payload. Please refer https://freshdesk.com/api#ticket
+				def create_ticket payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post TICKETS, payload )
+				end
+
+				#Update a ticket by passing its id and payload. Please refer https://freshdesk.com/api#ticket
+				def update_ticket id, payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.put TICKETS, id, payload )
+				end
+
+				#Delete a ticket by its id.
+				def delete_ticket id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete TICKETS, id ).code
+					end
+				end
+
+				#Get a ticket by its id.
+				def get_ticket id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get TICKETS, id )
+				end
+
+				#List all tickets.
+				def list_tickets
+					Freshdesk::Api::Client.convert_to_hash( @connection.get TICKETS )
+				end
+
+				#Check is ticket id is available by passing the id.
+				def is_ticket_id_available? id
+					begin
+						return false if id.to_i.zero?
+						get_ticket id.to_i
+						return false
+					rescue Freshdesk::Api::InvalidEndpointError
+						true
+					end
+				end
+
+				#Add note by passing the ticket id and payload. Please refer Please refer https://freshdesk.com/api#ticket
+				def add_note ticket_id, payload
+					begin
+						Freshdesk::Api::Client.convert_to_hash( @connection.post "tickets/#{ticket_id}/#{NOTES}", payload )
+					rescue Freshdesk::Api::InvalidEndpointError
+						false
+					end
+				end
+
+			end 
+		end
+	end
+end

data/lib/freshdesk/api/client/user.rb

@@ -0,0 +1,87 @@
+module Freshdesk
+	module Api
+		module Client
+			class User
+				USERS = "contacts".freeze 
+				AGENTS = "agents".freeze
+
+				#Initialize with your freshdesk account url and api key.
+				def initialize base_url, api_key
+					@connection = Freshdesk::Api::Client::Request.new base_url, api_key
+				end
+
+				#Create an user with payload. Please refer https://freshdesk.com/api#user
+				def create_user payload
+					Freshdesk::Api::Client.convert_to_hash( @connection.post USERS, payload )
+				end
+
+				#Update an user by passing its id and payload. Please refer https://freshdesk.com/api#user
+				def update_user id, payload
+					(@connection.put USERS, id, payload).code
+				end
+
+				#Get user by passing an email.
+				def get_user_by_email email
+					Freshdesk::Api::Client.convert_to_hash( @connection.get USERS, nil, "query="+URI.encode("email is #{email}") )
+				end
+
+				#Get user by passing a valid user id.
+				def get_user_by_id id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get USERS, id )
+				end
+
+				#Get agent by passing a valid agent id.
+				def get_agent_by_id id
+					Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS, id)
+				end
+
+				#Get agent by passing an email.
+				def get_agent_by_email email
+					Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS, nil, "query="+URI.encode("email is #{email}") )
+				end
+
+				#Get a user or an agent by simply passing the email.
+				def get_agent_or_user_by_email email
+					user = get_user_by_email email
+					unless user.nil? or user.empty?
+						{ type: :user, response: user[0] }
+					else
+						agent = get_agent_by_email email
+						unless agent.nil? or agent.empty?
+							{ type: :agent, response: agent[0] }
+						else
+							[]
+						end
+					end
+				end
+
+				#Delete user by its id.
+				def delete_user id
+					Freshdesk::Api::Client.delete_status_wrapper do
+						( @connection.delete USERS, id ).code
+					end
+				end
+
+				#Delete agent by its id.
+				def delete_agent id
+					begin
+						( @connection.delete AGENTS, id ).code
+					rescue Freshdesk::Api::ServerError
+						200
+					end
+				end
+
+				#List all users.
+				def list_users
+					Freshdesk::Api::Client.convert_to_hash( @connection.get USERS )
+				end
+
+				#List all agents.
+				def list_agents
+					Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS )
+				end
+
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: freshdesk-api-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dineshprabu S
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+description: This client can be used for accessing Tickets, Users, Discussions and
+  Forums on Freshdesk.
+email: dineshsprabu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/freshdesk-api-client.rb
+- lib/freshdesk/api/client/discussion.rb
+- lib/freshdesk/api/client/helper.rb
+- lib/freshdesk/api/client/request.rb
+- lib/freshdesk/api/client/solution.rb
+- lib/freshdesk/api/client/ticket.rb
+- lib/freshdesk/api/client/user.rb
+homepage: https://github.com/dineshsprabu/freshdesk-api-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/freshdesk/api/client
+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: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Freshdesk API client for v1.
+test_files: []