zendesk-api 0.1.2

data/Manifest

@@ -0,0 +1,13 @@
+README.markdown
+Rakefile
+lib/console.rb
+lib/zendesk-api.rb
+lib/zendesk.rb
+lib/zendesk/attachment.rb
+lib/zendesk/group.rb
+lib/zendesk/main.rb
+lib/zendesk/organization.rb
+lib/zendesk/ticket.rb
+lib/zendesk/user.rb
+zendesk-api.gemspec
+Manifest

data/README.markdown

@@ -0,0 +1,63 @@
+Zendesk API
+------------
+
+The unofficial Ruby Library for interacting with the [Zendesk REST API](http://www.zendesk.com/api)
+
+## Documentation & Requirements
+ * ActiveResource gem
+ * Curl
+ * Curb gem
+
+## What
+* Ruby wrapper around the Zendesk REST API
+
+## 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)
+
+
+## Using The Zendesk Console
+
+The Zendesk library comes with a convenient console for testing and quick commands (or whatever else you want to use it for).
+
+From /
+
+    irb -r lib/zendesk/console
+    z = Zendesk::Main.new('accountname', 'username', 'password')
+    z.get_users

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('zendesk-api', '0.1.2') do |p|
+  p.description     = "RubyGem wrapper for REST API to http://zendesk.com"
+  p.author          = "Peter Ericson"
+  p.url             = "http://github.com/pgericson/zendesk-api"
+  p.email           = "pg.ericson@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/console.rb

@@ -0,0 +1,6 @@
+require 'lib/zendesk-api'
+puts <<-TXT
+Stuff here to explain what it does
+TXT
+
+include Zendesk

data/lib/zendesk-api.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'curb'
+require 'activeresource'
+
+module Zendesk
+  class Error < StandardError; end
+  class CouldNotAuthenticateYou < StandardError; end
+end
+
+require 'zendesk/ticket'
+require 'zendesk/user'
+require 'zendesk/organization'
+require 'zendesk/group'
+require 'zendesk/attachment'
+require 'zendesk/main'

data/lib/zendesk.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/zendesk"

data/lib/zendesk/attachment.rb

@@ -0,0 +1,5 @@
+module Zendesk
+  module Attachment
+
+  end
+end

data/lib/zendesk/group.rb

@@ -0,0 +1,24 @@
+module Zendesk
+  module Group
+
+    def get_groups
+      make_request("groups")
+    end
+
+    def get_group(id)
+      make_request("groups/#{id}")
+    end
+
+    def create_group(input)
+      make_request("groups", :create => Zendesk::Main.to_xml('group', input))
+    end
+
+    def update_group(input)
+      make_request("groups", :update => Zendesk::Main.to_xml('group', input))
+    end
+
+    def delete_group(id)
+      make_request("groups", :destroy => true)
+    end
+  end
+end

data/lib/zendesk/main.rb

@@ -0,0 +1,71 @@
+module Zendesk
+  class Main
+    attr_accessor :main_url, :format
+    attr_reader :response_raw, :response
+
+    def initialize(account, username, password, options = {})
+      @account = account
+      @username = username
+      @password = password
+      if options[:format] && ['xml','json'].any?{|f| f == options[:format]}
+        @format = options[:format]
+      else
+        @format = 'xml'
+      end
+    end
+  
+    def main_url
+      url_prefix    = "http://"
+      url_postfix   = ".zendesk.com/"
+      url = url_prefix + @account + url_postfix
+    end
+
+    def self.to_xml(function_name, input)
+      if input.is_a?(String)
+        input
+      else
+        input.to_xml({:root => function_name})
+      end 
+    end
+
+    def make_request(end_url, body = {})
+      curl = Curl::Easy.new(main_url + end_url + ".#{@format}")
+      curl.userpwd = "#{@username}:#{@password}"
+      unless body.empty?
+        if body.values.first.is_a?(Hash)
+          final_body = body.values.first.to_xml
+        elsif body.values.first.is_a?(String)
+          final_body = body.values.first
+        end
+
+        if body[:create]
+          curl.headers = "Content-Type: application/xml"
+          curl.http_post(final_body)
+        elsif body[:update]
+          curl.headers = "Content-Type: application/xml"
+          curl.http_put(final_body)
+        elsif body[:destroy]
+          curl.http_delete(final_body)
+        elsif body[:list]
+          params = "?" + body[:list].to_a.map do |p|
+            "#{p[0]}=#{p[1]}"
+          end.join("&")
+          curl.url = curl.url + params
+        end
+      else
+        curl.perform
+      end
+
+      if curl.body_str == "<error>Couldn't authenticate you</error>"
+        return "string" #raise CouldNotAuthenticateYou 
+      end
+      curl.body_str
+    end
+
+    include Zendesk::Ticket
+    include Zendesk::User
+    include Zendesk::Organization
+    include Zendesk::Group
+    include Zendesk::Attachment
+  end
+end

data/lib/zendesk/organization.rb

@@ -0,0 +1,24 @@
+module Zendesk
+  module Organization
+
+    def get_organizations
+      make_request("organizations")
+    end
+
+    def get_organization(id)
+      make_request("organizations/#{id}")
+    end
+
+    def create_organization(input)
+      make_request("organizations", :create => Zendesk::Main.to_xml('organization', input))
+    end
+
+    def update_organization(input)
+      make_request("organizations", :update => Zendesk::Main.to_xml('organization', input))
+    end
+
+    def delete_organization(id)
+      make_request("organizations", :destroy => true)
+    end
+  end
+end

data/lib/zendesk/ticket.rb

@@ -0,0 +1,24 @@
+module Zendesk
+  module Ticket
+
+    def get_tickets(rule_id)
+      make_request("tickets")
+    end
+
+    def get_ticket(id)
+      make_request("tickets/#{id}")
+    end
+
+    def create_ticket(input)
+      make_request("tickets", :create => Zendesk::Main.to_xml('ticket', input))
+    end
+
+    def update_ticket(input)
+      make_request("tickets", :update => Zendesk::Main.to_xml('ticket', input))
+    end
+
+    def delete_ticket(id)
+      make_request("tickets", :destroy => true)
+    end
+  end
+end

data/lib/zendesk/user.rb

@@ -0,0 +1,28 @@
+module Zendesk
+  module User
+
+    def get_users(params = nil)
+      if params
+        make_request("users", :list => params)
+      else
+        make_request("users")
+      end
+    end
+
+    def get_user(id)
+      make_request("users/#{id}")
+    end
+
+    def create_user(input)
+      make_request("users", :create => Zendesk::Main.to_xml('user', input))
+    end
+
+    def update_user(input)
+      make_request("users", :update => Zendesk::Main.to_xml('user', input))
+    end
+
+    def delete_user(id)
+      make_request("users", :destroy => true)
+    end
+  end
+end

data/zendesk-api.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{zendesk-api}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Ericson"]
+  s.date = %q{2010-03-11}
+  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/group.rb", "lib/zendesk/main.rb", "lib/zendesk/organization.rb", "lib/zendesk/ticket.rb", "lib/zendesk/user.rb"]
+  s.files = ["README.markdown", "Rakefile", "lib/console.rb", "lib/zendesk-api.rb", "lib/zendesk.rb", "lib/zendesk/attachment.rb", "lib/zendesk/group.rb", "lib/zendesk/main.rb", "lib/zendesk/organization.rb", "lib/zendesk/ticket.rb", "lib/zendesk/user.rb", "zendesk-api.gemspec", "Manifest"]
+  s.homepage = %q{http://github.com/pgericson/zendesk-api}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Zendesk-api", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{zendesk-api}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{RubyGem wrapper for REST API to http://zendesk.com}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: zendesk-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Peter Ericson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: RubyGem wrapper for REST API to http://zendesk.com
+email: pg.ericson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- lib/console.rb
+- lib/zendesk-api.rb
+- lib/zendesk.rb
+- lib/zendesk/attachment.rb
+- lib/zendesk/group.rb
+- lib/zendesk/main.rb
+- lib/zendesk/organization.rb
+- lib/zendesk/ticket.rb
+- lib/zendesk/user.rb
+files: 
+- README.markdown
+- Rakefile
+- lib/console.rb
+- lib/zendesk-api.rb
+- lib/zendesk.rb
+- lib/zendesk/attachment.rb
+- lib/zendesk/group.rb
+- lib/zendesk/main.rb
+- lib/zendesk/organization.rb
+- lib/zendesk/ticket.rb
+- lib/zendesk/user.rb
+- zendesk-api.gemspec
+- Manifest
+has_rdoc: true
+homepage: http://github.com/pgericson/zendesk-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Zendesk-api
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: zendesk-api
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: RubyGem wrapper for REST API to http://zendesk.com
+test_files: []
+