rubydesk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 284c6c625c53ed16cdd44bcb3d65766e07da8d5c
+  data.tar.gz: a9fd0abfe356b0ded3050426a1ad9d0024e08659
+SHA512:
+  metadata.gz: 3318291eb242687c9062a0d56bfb8783f8ddce14190d77e7f363a6ddba73e0d394af9368a8f5af90b36d816ec1b8733e9a10af116fe0ae8550eb33cc8c0e9964
+  data.tar.gz: 1e6f23db74ec2fd6b3f4e6ce8026a577ebf69cdfdfe139d4d479bd471b8d1053eb37f8aeae10084d5ed8a5e4928042d3ac414b76600f6fb9139d68c8605aeb2e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubydesk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Trey Caliva
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Rubydesk
+
+Ruby Gem to connect to Freshdesk API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubydesk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubydesk
+
+## Usage
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rubydesk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rubydesk/version.rb

@@ -0,0 +1,3 @@
+module Rubydesk
+  VERSION = "0.0.1"
+end

data/lib/rubydesk.rb

@@ -0,0 +1,245 @@
+require "rubydesk/version"
+require 'rest_client'
+require 'nokogiri'
+require 'uri'
+
+module Rubydesk
+
+  # custom errors
+  class AlreadyExistedError < StandardError; end
+  class ConnectionError < StandardError; end
+
+  attr_accessor :base_url, :freshdesk_api_key
+
+  def initialize(base_url, freshdesk_api_key='X', username='X', password='X')
+
+    @base_url = base_url
+    @freshdesk_api_key = freshdesk_api_key
+
+    RestClient.add_before_execution_proc do | req, params |
+
+      if @freshdesk_api_key
+        req.basic_auth freshdesk_api_key, password
+      else
+        req.basic_auth username, password
+      end
+    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.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 |params={}|
+      uri = mapping(name)
+      uri.gsub!(/\.xml/, ".#{response_format}")
+      unless params.empty?
+        uri += '?' + URI.encode_www_form(params)
+      end
+
+      begin
+        response = RestClient.get uri
+      rescue Exception
+        response = nil
+      end
+    end
+  end
+
+  # Freshdesk API client support "DELETE" with the required id parameter
+  def self.fd_define_delete(name)
+    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.fd_define_post(name)
+    name = name.to_s
+    method_name = "post_" + name
+
+    define_method method_name do |args, id=nil|
+      raise StandardError, "Arguments are required to modify data" if args.size.eql? 0
+      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
+        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
+        raise
+      end
+
+      response
+    end
+  end
+
+  # 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
+  #   users => /contacts.xml
+  #   forums => /categories.xml
+  #   solutions => /solution/categories.xml
+  #   companies => /customers.xml
+  def mapping(method_name, id = nil)
+    case method_name
+      when "tickets" then File.join(@base_url + "helpdesk/tickets.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)
+    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

data/rubydesk.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubydesk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubydesk"
+  spec.version       = Rubydesk::VERSION
+  spec.authors       = ["Trey Caliva"]
+  spec.email         = ["trey@directorschoice.travel"]
+  spec.summary       = "Ruby Gem to connect to Freshdesk API"
+  spec.description   = "Ruby Gem to connect to Freshdesk API"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rubydesk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Trey Caliva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby Gem to connect to Freshdesk API
+email:
+- trey@directorschoice.travel
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rubydesk.rb
+- lib/rubydesk/version.rb
+- rubydesk.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby Gem to connect to Freshdesk API
+test_files: []