zendesk 0.1.2 → 0.1.3

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+zendesk.yml
+benchmark.rb

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.1.3
+* enhancements
+  * removed requirement active_support
+  * work with XML only using ReXML
+  * removed jeweler dependecies
+
 == 0.1.2
 * bugfix
   * fixed missed field entries

data/Gemfile

@@ -1,12 +1,8 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+gemspec
+
+gem 'rest-client'
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.0"
-  # gem "rcov", ">= 0"
+  gem "rspec"
 end

data/Rakefile

@@ -1,25 +1,2 @@
-# encoding: utf-8
-
-require 'rubygems'
 require 'bundler'
-require 'rake/rdoctask'
-
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "zendesk"
-  gem.homepage = "http://github.com/aderyabin/zendesk"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby wrapper around the Zendesk API}
-  gem.description = %Q{Ruby wrapper around the Zendesk API}
-  gem.email = "deriabin@gmail.com"
-  gem.authors = ["Andrey Deryabin"]
-end
+Bundler::GemHelper.install_tasks

data/lib/zendesk.rb

@@ -1,17 +1,17 @@
 # Zendesk
 require 'rubygems'
-require 'active_support'
 require 'rest_client'
 require 'yaml'
+require 'rexml/document'
 
 module Zendesk
-  
+
   class ConfigurationNotFound < NameError;
   end
-  
-  
-  ZENDESK_ROOT          = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ".") unless defined?(ZENDESK_ROOT)
-  DEFAULT_CONFIG_PATH   = File.join(ZENDESK_ROOT, 'config', 'zendesk.yml')
+
+
+  ZENDESK_ROOT = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ".") unless defined?(ZENDESK_ROOT)
+  DEFAULT_CONFIG_PATH = File.join(ZENDESK_ROOT, 'config', 'zendesk.yml')
 
   def self.load_configuration(config_path)
     exists = config_path && File.exists?(config_path)
@@ -22,16 +22,63 @@ module Zendesk
   def self.config
     @configuration ||= load_configuration(DEFAULT_CONFIG_PATH)
   end
-  
+
   def self.resource
     @resource ||= RestClient::Resource.new config['host'], :user => config['user'], :password => config['password'], :timeout => 20, :open_timeout => 1
   end
+
+  def self.xml_in(xml_data)
+    xml_elements_to_hash REXML::Document.new(xml_data).root
+  end
+
+  def self.xml_elements_to_hash(element)
+    value = element.text
+    value = case element.attributes['type']
+    when 'integer'
+      value.to_i
+    when 'datetime'
+      DateTime.parse(element.text)
+    else
+      element.text
+    end if value
+
+    if element.elements.count > 0
+      if element.attributes['type'] == 'array'
+        value = element.elements.map{|el| xml_elements_to_hash(el) }
+      else
+        value = {}
+        element.elements.each{|el| value.merge! xml_elements_to_hash(el) }
+      end      
+    end
+    { element.name.gsub('-', '_').to_sym => value }      
+  end
+
+  def self.xml_out(hash)
+    doc = REXML::Document.new 
+    doc.add_element hash_elements_to_xml(hash.keys[0], hash.values[0])
+    doc.to_s
+  end  
   
+  def self.hash_elements_to_xml(key, value)
+    element = REXML::Element.new(key.to_s.gsub('_', '-'))
+    if value.is_a?(Array)
+      element.attributes['type'] = 'array'
+      value.each{ |val| element.add_element hash_elements_to_xml(val.keys[0], val.values[0]) }
+    elsif value.is_a?(Hash)
+      value.each_pair{ |key, v| element.add_element hash_elements_to_xml(key, v) }
+    else
+      element.text = value
+    end
+    element
+  end
+
+
+
   autoload :Resource, File.dirname(__FILE__) + '/zendesk/resource.rb'
   autoload :Comment, File.dirname(__FILE__) + '/zendesk/comment.rb'
   autoload :Ticket, File.dirname(__FILE__) + '/zendesk/ticket.rb'
   autoload :User, File.dirname(__FILE__) + '/zendesk/user.rb'
-  
+
   autoload :Constants, File.dirname(__FILE__) + '/zendesk/lib/constants.rb'
   autoload :RestObject, File.dirname(__FILE__) + '/zendesk/lib/rest_object.rb'
   autoload :Properties, File.dirname(__FILE__) + '/zendesk/lib/properties.rb'

data/lib/zendesk/comment.rb

@@ -13,12 +13,12 @@ class Zendesk::Comment < Zendesk::Resource
   end
 
   def to_xml    
-    { :value => value, :is_public => is_public }.to_xml(:skip_instruct => true, :root=>:comment)
+    Zendesk.xml_out({:comment => { :value => value, :is_public => is_public }})
   end
 
   def save
     begin
-      response = resource["tickets/#{ticket_id}.xml"].put self.to_xml, :content_type => 'application/xml'
+      response = Zendesk.resource["tickets/#{ticket_id}.xml"].put self.to_xml, :content_type => 'application/xml'
       return (200..300).include?(response.headers[:status].to_i)
     rescue Exception => e
       puts e.message

data/lib/zendesk/lib/properties.rb

@@ -1,13 +1,27 @@
 module Zendesk::Properties
   module ClassMethods
     
-    mattr_accessor :_attributes, :_protected_attributes, :_properties, :_datetimes
-    
     @@_attributes = []
     @@_protected_attributes = []
     @@_properties = []
     @@_datetimes = []
     
+    def _attributes
+      @@_attributes
+    end
+    
+    def _protected_attributes
+      @@_protected_attributes
+    end
+    
+    def _properties
+      @@_properties
+    end
+    
+    def _datetimes
+      @@_datetimes
+    end
+    
     def attributes(*vars)
       @@_attributes.concat vars
       attr_accessor *vars
@@ -46,7 +60,7 @@ module Zendesk::Properties
 
         class_eval <<-END
         def #{method_name}=(value)
-          @#{method_name}_id = #{method_name.upcase}.index(value)
+          @#{method_name}_id = #{method_name.upcase}.key(value)
         end
         END
       end

data/lib/zendesk/lib/rest_object.rb

@@ -1,10 +1,5 @@
 module Zendesk::RestObject
   module ClassMethods
-    def create(attrs = {})
-      instance = new(attrs)
-      instance.save
-    end
-
     def find(id)
       begin
         new().load(id)
@@ -16,16 +11,16 @@ module Zendesk::RestObject
   end
 
   module InstanceMethods
-    def path
-      self.class.to_s.demodulize.downcase.pluralize
+    def model_name
+      self.class.to_s.gsub(/^.*::/, '').downcase
     end
     
     def save
       begin
         response = if self.id
-          Zendesk.resource["#{path}/#{id}.xml"].put self.to_xml, :content_type => 'application/xml'
+          Zendesk.resource["#{model_name}s/#{id}.xml"].put self.to_xml, :content_type => 'application/xml'
         else  
-          Zendesk.resource["#{path}.xml"].post self.to_xml, :content_type => 'application/xml'
+          Zendesk.resource["#{model_name}s.xml"].post self.to_xml, :content_type => 'application/xml'
         end
         if (200..300).include?(response.headers[:status].to_i)
           load(id || response.headers[:location].scan(/\d+/).first.to_i)
@@ -51,7 +46,7 @@ module Zendesk::RestObject
     
     def load(id)
       begin
-        data = load_data(Zendesk.resource["#{path}/#{id}.xml"].get)[path.singularize]
+        data = load_data(Zendesk.resource["#{model_name}s/#{id}.xml"].get)[model_name.to_sym]
         load_attributes(data)
         load_protected_attributes(data)
         load_field_entries(data) if respond_to?(:load_field_entries)

data/lib/zendesk/resource.rb

@@ -10,6 +10,12 @@ class Zendesk::Resource
   end
   
   def load_data(xml_stream)
-    Hash.from_xml(xml_stream)
+    Zendesk.xml_in(xml_stream)
+  end
+  
+  def self.create(attrs = {})
+    instance = new(attrs)
+    instance.save
+    instance
   end
 end

data/lib/zendesk/ticket.rb

@@ -8,8 +8,8 @@ class Zendesk::Ticket < Zendesk::Resource
   properties :status, :ticket_type, :priority, :via
 
 
-  alias_attribute :id, :nice_id
-  alias_attribute :set_tags, :current_tags
+  alias :id :nice_id
+  alias :set_tags :current_tags
     
   def initialize(attrs = {})
     @comments = []
@@ -18,19 +18,21 @@ class Zendesk::Ticket < Zendesk::Resource
     super
   end
   
-  # Filling field methods from imported data.
+  # Filling custom field methods from imported data.
   # If field is not pointed in config it will be missed
   def load_field_entries(data)
-    data['ticket_field_entries'].each do |field_entry|
-      method_name = @field_ids.index(field_entry['ticket_field_id'])
-      send("#{method_name}=", field_entry['value']) if method_name
+    if data[:ticket_field_entries]
+      data[:ticket_field_entries].each do |field_entry|
+        method_name = @field_ids.key(field_entry[:ticket_field_id])
+        send("#{method_name}=", field_entry[:value]) if method_name
+      end
     end
   end
   
   def load_comments(data)
     @comments = []
-    data['comments'].each do |comment|
-      @comments << Zendesk::Comment.new(comment)
+    data[:comments].each do |comment|
+      @comments << Zendesk::Comment.new(comment[:comment])
     end
   end
   
@@ -53,20 +55,21 @@ class Zendesk::Ticket < Zendesk::Resource
   def to_xml
     result = {}
     (attributes -  @field_ids.keys).each do |obj|
-      if instance_variable_get(:"@#{obj.to_s}").present?
-        result[obj.to_s.downcase] = instance_variable_get(:"@#{obj.to_s}") 
+      if val = instance_variable_get(:"@#{obj.to_s}")
+        result[obj.to_s.downcase] = val
       end
     end
     
-    result[:ticket_field_entries] = []
+    ticket_field_entries = []
     @field_ids.each_pair do |key, value|
-      if instance_variable_get(:"@#{key.to_s}").present?
-        result[:ticket_field_entries] << {:ticket_field_id => value, :value => instance_variable_get(:"@#{key.to_s}").to_s}
+      if val = instance_variable_get(:"@#{key.to_s}")
+        ticket_field_entries << { :ticket_field_id => value, :value => val.to_s }
       end
     end
+     result[:ticket_field_entries] = ticket_field_entries unless ticket_field_entries.empty?
     
-    result[:set_tags] = current_tags
-    result.to_xml(:skip_instruct => true, :root=>:ticket)
+    result[:set_tags] = current_tags if current_tags
+    Zendesk.xml_out({:ticket => result})
   end
   
   def tags
@@ -74,14 +77,14 @@ class Zendesk::Ticket < Zendesk::Resource
   end
   
   def tags=(tags)
-    @current_tags = tags.to_a.join(' ')
+    @current_tags = tags.is_a?(Array) ? tags.to_a.join(' ') : tags
   end
   
   def load_fields
     attr_keys = Zendesk.config['ticket'] || {}
     @field_ids = {}
     field_names = attr_keys.keys
-    unless field_names.blank?
+    unless field_names.empty?
       field_names = field_names.map(&:to_sym)
       attr_keys.keys.each do |attr_name|
         @field_ids[attr_name.to_sym]  = attr_keys[attr_name]

data/lib/zendesk/user.rb

@@ -14,6 +14,6 @@ class Zendesk::User < Zendesk::Resource
   def to_xml
     result = {}
     attributes.each{|attr| result[attr] = instance_variable_get(:"@#{attr.to_s}") }
-    result.to_xml(:skip_instruct => true, :root=>:user)
+    SimpleXML.xml_out result, 'RootName' =>:user, 'AttrPrefix' => true
   end
 end

data/lib/zendesk/version.rb

@@ -1,3 +1,3 @@
 module Zendesk
-  VERSION = "0.0.1"
+  VERSION = "0.1.3"
 end

data/spec/ticket_spec.rb

@@ -26,4 +26,9 @@ require File.dirname(__FILE__) + '/../lib/zendesk'
     ticket.ticket_type_id.should  == 3
   end
   
+  it 'should convert to xml' do
+    ticket = Zendesk::Ticket.new( :description => 'ticket_description', :tags => 'one_two' )
+    ticket.to_xml.should == "<ticket><description>ticket_description</description><set-tags>one_two</set-tags></ticket>"
+  end
+  
 end

data/zendesk.gemspec

@@ -1,62 +1,21 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zendesk/version"
 
 Gem::Specification.new do |s|
   s.name = %q{zendesk}
-  s.version = "0.1.2"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.version = Zendesk::VERSION
+  s.platform    = Gem::Platform::RUBY
   s.authors = ["Andrey Deryabin"]
-  s.date = %q{2011-05-19}
+  s.date = %q{2011-05-20}
+  s.summary = %q{Ruby wrapper around the Zendesk API}
   s.description = %q{Ruby wrapper around the Zendesk API}
   s.email = %q{deriabin@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG.rdoc",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/zendesk.rb",
-    "lib/zendesk/comment.rb",
-    "lib/zendesk/lib/constants.rb",
-    "lib/zendesk/lib/properties.rb",
-    "lib/zendesk/lib/rest_object.rb",
-    "lib/zendesk/resource.rb",
-    "lib/zendesk/ticket.rb",
-    "lib/zendesk/user.rb",
-    "lib/zendesk/version.rb",
-    "spec/comment_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/ticket_spec.rb",
-    "zendesk.gemspec"
-  ]
   s.homepage = %q{http://github.com/aderyabin/zendesk}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Ruby wrapper around the Zendesk API}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
-    else
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-    end
-  else
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end
 

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: zendesk
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors: 
 - Andrey Deryabin
@@ -15,57 +10,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 +04:00
+date: 2011-05-20 00:00:00 +04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: bundler
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
-  name: jeweler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
-        version: 1.6.0
-  requirement: *id002
+dependencies: []
+
 description: Ruby wrapper around the Zendesk API
 email: deriabin@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
+- .gitignore
 - CHANGELOG.rdoc
 - Gemfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/zendesk.rb
 - lib/zendesk/comment.rb
 - lib/zendesk/lib/constants.rb
@@ -81,8 +44,8 @@ files:
 - zendesk.gemspec
 has_rdoc: true
 homepage: http://github.com/aderyabin/zendesk
-licenses: 
-- MIT
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -93,25 +56,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper around the Zendesk API
-test_files: []
-
+test_files: 
+- spec/comment_spec.rb
+- spec/spec_helper.rb
+- spec/ticket_spec.rb

data/VERSION

@@ -1 +0,0 @@
-0.1.2