zendesk-api 0.3.3 → 0.3.4

data/README.markdown

@@ -13,42 +13,54 @@ The unofficial Ruby Library for interacting with the [Zendesk REST API](http://w
 
 ## Install Instructions
 Normal install:
+
     gem install zendesk-api
 
 Bundler install:
+
     gem "zendesk-api", "latestversion"
 
 ## How to use it
 ### Basic
 Below outputs xml
+
     z = Zendesk::Main.new('subdomain', 'username', 'password')
 and outputs json
+
     z = Zendesk::Main.new('subdomain', 'username', 'password', :format => 'json')
 
 For the most part all functions is based on the following functions
 REST function_names = %{user, organization, group, ticket,attachement, tag, forum, entries, search}
 
 ### Show
+
     z.get_function_name(user_id)
 e.g.
+
     z.get_user(121)
 ### List
+
     z.get_function_names #with a s in the end, for plural
 e.g.
+
     z.get_users
 
 ### Create
 with string
+
     z.create_function_name("<user><email>email@company.com</email><name>John Doe</name></user>")
 with hash(array is not supported yet)
+
     z.create_function_name({:email => 'email@company.com', :name => 'John Doe'})
 
 ### Update
 Not supported yet
 
 ### Destroy
+
     z.destroy_function_name(id)
 e.g.
+
     z.destroy_user(234)
 
 

data/lib/zendesk-api.rb

@@ -22,4 +22,5 @@ require 'zendesk/tag'
 require 'zendesk/forum'
 require 'zendesk/entry'
 require 'zendesk/search'
+require 'zendesk/comment'
 require 'zendesk/main'

data/lib/zendesk/main.rb

@@ -17,7 +17,9 @@ module Zendesk
 
     def main_url
       url_prefix    = @options[:ssl] ? "https://" : "http://"
-      url_postfix   = ".zendesk.com/"
+      url_postfix   = '.zendesk.com/'
+      url_postfix   << "api/v#{@options[:api_version]}/" if @options[:api_version]
+
       url = url_prefix + @account + url_postfix
     end
 
@@ -50,23 +52,29 @@ module Zendesk
       end
     end
 
-    def make_request(end_url, body = {})
+    def make_request(end_url, body = {}, options = {})
+      options.reverse_merge!({:on_behalf_of => nil})
+      
       curl = Curl::Easy.new(main_url + end_url + ".#{@format}")
       curl.userpwd = "#{@username}:#{@password}"
+      
+      curl.headers={}
+      curl.headers.merge!({"X-On-Behalf-Of" => options[:on_behalf_of]}) if options[:on_behalf_of].present?
+      
       if body.empty? or body[:list]
         curl.url = curl.url + params_list(body[:list]) if body[:list]
         curl.perform
       elsif body[:post]
-        curl.headers = "Content-Type: application/xml"
+        curl.headers.merge!({"Content-Type" => "application/xml"})
         curl.http_post 
       elsif body[:create]
-        curl.headers = "Content-Type: application/xml"
+        curl.headers.merge!({"Content-Type" => "application/xml"})
         curl.http_post(string_body(body))
       elsif body[:update]
         # PUT seems badly broken, at least I can't get it to work without always
         # raising an exception about rewinding the data stream
         # curl.http_put(final_body)
-        curl.headers = { "Content-Type" => "application/xml", "X-Http-Method-Override" => "put" }    
+        curl.headers.merge!({ "Content-Type" => "application/xml", "X-Http-Method-Override" => "put" })  
         curl.http_post(string_body(body))
       elsif body[:destroy]
         curl.http_delete
@@ -119,5 +127,6 @@ module Zendesk
     include Zendesk::Forum
     include Zendesk::Entry
     include Zendesk::Search
+    include Zendesk::Comment
   end
 end

data/lib/zendesk/ticket.rb

@@ -9,12 +9,12 @@ module Zendesk
       make_request("tickets/#{id}")
     end
 
-    def create_ticket(input)
-      make_request("tickets", :create => Zendesk::Main.to_xml('ticket', input))
+    def create_ticket(input, options = {})
+      make_request("tickets", {:create => Zendesk::Main.to_xml('ticket', input)}, options)
     end
 
-    def update_ticket(input)
-      make_request("tickets", :update => Zendesk::Main.to_xml('ticket', input))
+    def update_ticket(id, input, options = {})
+      make_request("tickets/#{id}", {:update => Zendesk::Main.to_xml('ticket', input)}, options)
     end
 
     def delete_ticket(id)

data/spec/zendesk/main_spec.rb

@@ -1,47 +1,123 @@
 require "spec"
-require 'lib/zendesk-api'
-
-describe Zendesk::Main, "basic" do
-  before(:each) do
-    @account = "this_account"
-    @username = "this_username"
-    @password = "this_password"
-    @zendesk = Zendesk::Main.new(@account, @username, @password)
-  end
+require 'zendesk-api'
 
-  it "should have the correct mail_url with no ssl options" do
-    @zendesk.main_url.should == "http://#{@account}.zendesk.com/"
-  end
+describe Zendesk::Main do
+  describe "basic" do
+    before(:each) do
+      @account = "this_account"
+      @username = "this_username"
+      @password = "this_password"
+      @zendesk = Zendesk::Main.new(@account, @username, @password)
+    end
 
-  it "should have the correct mail_url with ssl options" do
-    @zendesk = Zendesk::Main.new(@account, @username, @password, :ssl => true)
-    @zendesk.main_url.should == "https://#{@account}.zendesk.com/"
-  end
-end
+    it "should have the correct mail_url with no ssl options" do
+      @zendesk.main_url.should == "http://#{@account}.zendesk.com/"
+    end
+
+    it "should have the correct mail_url with ssl options" do
+      @zendesk = Zendesk::Main.new(@account, @username, @password, :ssl => true)
+      @zendesk.main_url.should == "https://#{@account}.zendesk.com/"
+    end
 
-describe Zendesk::Main, 'make_request' do
-  before do
-    curl_object = Curl::Easy.method(:new)
-    Curl::Easy.stub!(:new).and_return do |*args|
-      curl = curl_object.call(*args)
-      curl.should_receive(:perform)
-      curl.stub!(:header_str) { "adsf\r\ndsaf"}
-      curl
+    it "should add the api version to the URL if one is specified" do
+      @zendesk = Zendesk::Main.new(@account, @username, @password, :ssl => true, :api_version => 1)
+      @zendesk.main_url.should == "https://#{@account}.zendesk.com/api/v1/"
     end
   end
 
-  it "should construct array url for search" do
-    zendesk = Zendesk::Main.new('my_company', "some_login", "some_password")
-    params = {
-            :foo => "bar",
-            :foo_list => [1, 2, 3]
-    }
+  describe 'make_request' do
+    context "searching" do
+      before do
+        curl_object = Curl::Easy.method(:new)
+        Curl::Easy.stub!(:new).and_return do |* args|
+          curl = curl_object.call(* args)
+          curl.should_receive(:perform)
+          curl
+        end
+      end
+
+      it "should construct array url for search" do
+        zendesk = Zendesk::Main.new('my_company', "some_login", "some_password")
+        params = {
+                :foo => "bar",
+                :foo_list => [1, 2, 3]
+        }
+
+        response = zendesk.make_request("search", :list => params)
+        response.url.should =~ /foo=bar/
+        response.url.should =~ /foo_list\[\]=1/
+        response.url.should =~ /foo_list\[\]=2/
+        response.url.should =~ /foo_list\[\]=3/
+
+      end
+    end
+
+    context "headers" do
+      before(:each) do
+        @zendesk = Zendesk::Main.new('my_company', "some_login", "some_password")
+        @mock_object = mock('curl_connection')
+        @mock_object.stub!(:userpwd=).and_return(true)
+        @mock_object.stub!(:headers=).and_return({})
+        @mock_object.stub!(:headers).and_return({})
+        @mock_object.stub!(:body_str).and_return("body")
+        @mock_object.stub!(:header_str).and_return("header")
+        @mock_object.stub!(:url).and_return("url")
+        @mock_object.stub!(:response_code).and_return("response_code")
+        @mock_object.should_receive(:http_post).and_return(true)
+        @curl_object = Curl::Easy.should_receive(:new).and_return(@mock_object)
+      end
+      it "should use default options if none are passed" do
+        params = {"subject" => "rspec rulez", "description" => "description", "status_id"=>1}
+        options_hash = {:on_behalf_of => "test@test.com"}
+
+        options_hash.should_receive(:reverse_merge!).once.with({:on_behalf_of => nil})
+        @mock_object.headers.should_receive(:merge!).once.with({"Content-Type" => "application/xml"}).and_return(true)
+        @mock_object.headers.should_receive(:merge!).once.with({"X-On-Behalf-Of" => "test@test.com"}).and_return(true)
 
-    response = zendesk.make_request("search", :list => params)
-    response.url.should =~ /foo=bar/
-    response.url.should =~ /foo_list\[\]=1/
-    response.url.should =~ /foo_list\[\]=2/
-    response.url.should =~ /foo_list\[\]=3/
+        @zendesk.make_request("ticket", {:create => params}, options_hash)
+      end
 
+      it "should format headers for creation" do
+        params = {"subject" => "rspec rulez", "description" => "description", "status_id"=>1}
+
+        @mock_object.headers.should_receive(:merge!).with({"Content-Type" => "application/xml"}).any_number_of_times.and_return(true)
+
+        @zendesk.make_request("ticket", :create => params)
+      end
+      it "should add X-On-Behalf-Of if passed in options" do
+        params = {"subject" => "rspec rulez", "description" => "description", "status_id"=>1}
+
+        @mock_object.headers.should_receive(:merge!).once.with({"Content-Type" => "application/xml"}).and_return(true)
+        @mock_object.headers.should_receive(:merge!).once.with({"X-On-Behalf-Of" => "test@test.com"}).and_return(true)
+
+        @zendesk.make_request("ticket", {:create => params}, {:on_behalf_of => "test@test.com"})
+      end
+      it "should not add X-On-Behalf-Of if not passed in options" do
+        params = {"subject" => "rspec rulez", "description" => "description", "status_id"=>1}
+
+        @mock_object.headers.should_receive(:merge!).once.with({"Content-Type" => "application/xml"}).and_return(true)
+        @mock_object.headers.should_not_receive(:merge!).with({"X-On-Behalf-Of" => ""}).and_return(true)
+
+        @zendesk.make_request("ticket", {:create => params}, {:on_behalf_of => ""})
+      end
+    end
+  end
+
+  describe "#self.to_xml" do
+    context "comments" do
+      it "should output correctly formatted XML" do
+        input = {"value" => "new comment", "public" => true}
+        xml = Zendesk::Main.to_xml('comment', input)
+        xml.should =~ /<comment>\s*<public type=\"boolean\">true<\/public>\s*<value>new comment<\/value>\s*<\/comment>/
+      end
+    end
+
+    context "tickets" do
+      it "should output correctly formatted XML" do
+        input = {"subject" => "rspec rulez", "description" => "description", "status_id"=>1}
+        xml = Zendesk::Main.to_xml('ticket', input)
+        xml.should =~ /<ticket>\s*<subject>rspec rulez<\/subject>\s*<status-id type=\"integer\">1<\/status-id>\s*<description>description<\/description>\s*<\/ticket>/
+      end
+    end
   end
-end
+end

data/spec/zendesk/user_spec.rb

@@ -1,5 +1,5 @@
 require "spec"
-require 'lib/zendesk-api'
+require 'zendesk-api'
 
 describe Zendesk::Main, 'user api' do
   # before do

data/zendesk-api.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{zendesk-api}
-  s.version = "0.3.3"
+  s.version = "0.3.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Peter Ericson"]
-  s.date = %q{2010-12-27}
+  s.authors = ["Peter Glerup Ericson"]
+  s.date = %q{2012-04-30}
   s.description = %q{RubyGem wrapper for REST API to http://zendesk.com}
   s.email = %q{pg.ericson@gmail.com}
   s.extra_rdoc_files = ["README.markdown", "lib/console.rb", "lib/zendesk-api.rb", "lib/zendesk.rb", "lib/zendesk/attachment.rb", "lib/zendesk/entry.rb", "lib/zendesk/forum.rb", "lib/zendesk/group.rb", "lib/zendesk/main.rb", "lib/zendesk/organization.rb", "lib/zendesk/search.rb", "lib/zendesk/tag.rb", "lib/zendesk/ticket.rb", "lib/zendesk/user.rb", "lib/zendesk/user_identity.rb"]

metadata

@@ -1,61 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: zendesk-api
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 3
-  version: 0.3.3
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+  prerelease: 
 platform: ruby
-authors: 
-- Peter Ericson
+authors:
+- Peter Glerup Ericson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-27 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: crack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 1
-        - 8
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.1.8
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        version: "2.3"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: RubyGem wrapper for REST API to http://zendesk.com
 email: pg.ericson@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
 - lib/console.rb
 - lib/zendesk-api.rb
@@ -71,7 +63,7 @@ extra_rdoc_files:
 - lib/zendesk/ticket.rb
 - lib/zendesk/user.rb
 - lib/zendesk/user_identity.rb
-files: 
+files:
 - Manifest
 - README.markdown
 - Rakefile
@@ -93,45 +85,35 @@ files:
 - spec/zendesk/main_spec.rb
 - spec/zendesk/user_spec.rb
 - zendesk-api.gemspec
-has_rdoc: true
 homepage: http://github.com/pgericson/zendesk-api
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Zendesk-api
 - --main
 - README.markdown
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 11
-      segments: 
-      - 1
-      - 2
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: zendesk-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: RubyGem wrapper for REST API to http://zendesk.com
 test_files: []
-
+has_rdoc: