zendesk2 0.0.5 → 0.0.6

data/lib/zendesk2.rb

@@ -10,6 +10,7 @@ require 'time'
 
 module Zendesk2
   require 'zendesk2/errors'
+  require 'zendesk2/error'
   autoload :Client, "zendesk2/client"
   autoload :PagedCollection, "zendesk2/paged_collection"
 

data/lib/zendesk2/client.rb

@@ -1,7 +1,7 @@
 class Zendesk2::Client < Cistern::Service
 
-  model_path "zendesk2/models"
-  request_path "zendesk2/requests"
+  model_path "zendesk2/client/models"
+  request_path "zendesk2/client/requests"
 
   model :organization
   collection :organizations
@@ -23,8 +23,11 @@ class Zendesk2::Client < Cistern::Service
   request :get_ticket
   request :get_user
   request :get_organizations
+  request :get_requested_tickets
+  request :get_ccd_tickets
   request :get_tickets
   request :get_users
+  request :search
   request :update_organization
   request :update_ticket
   request :update_user
@@ -55,15 +58,15 @@ class Zendesk2::Client < Cistern::Service
       logger             = options[:logger]
       adapter            = options[:adapter] || :net_http
       connection_options = options[:connection_options] || {ssl: {verify: false}}
-      username           = options[:username] || Zendesk2.defaults[:username]
+      @username          = options[:username] || Zendesk2.defaults[:username]
       password           = options[:password] || Zendesk2.defaults[:password]
       @token             = options[:token]
 
-      raise "Missing required options: [:username, :password]" unless username && password
+      raise "Missing required options: [:username, :password]" unless @username && password
 
       @connection = Faraday.new({url: @url}.merge(connection_options)) do |builder|
         # response
-        builder.use Faraday::Request::BasicAuthentication, username, password
+        builder.use Faraday::Request::BasicAuthentication, @username, password
         builder.use Faraday::Response::RaiseError
         builder.use Faraday::Response::Logger, logger if logger
         builder.response :json
@@ -89,14 +92,15 @@ class Zendesk2::Client < Cistern::Service
         req.params.merge!(params)
         req.body= body
       end
+    rescue Faraday::Error::ClientError => e
+      raise Zendesk2::Error.new(e)
     end
-
   end
 
   class Mock
     include Zendesk2::Errors
 
-    attr_reader :username, :url
+    attr_reader :username, :url, :token
 
     def self.data
       @data ||= {
@@ -135,6 +139,7 @@ class Zendesk2::Client < Cistern::Service
       @url  = url
       @path = URI.parse(url).path
       @username, @password = options[:username], options[:password]
+      @token = options[:token]
 
       @current_user_id = self.class.new_id
 
@@ -178,8 +183,8 @@ class Zendesk2::Client < Cistern::Service
       }
 
       response(
-        body: body,
-        path: path
+        :body => body,
+        :path => path
       )
     end
 
@@ -191,15 +196,18 @@ class Zendesk2::Client < Cistern::Service
 
       url = options[:url] || url_for(path)
 
-      Faraday::Response.new(
-        :method          => method,
-        :status          => status,
-        :url             => url,
-        :body            => body,
-        :request_headers => {
-          "Content-Type"   => "application/json; charset=utf-8"
+      env = {
+        :method           => method,
+        :status           => status,
+        :url              => url,
+        :body             => body,
+        :response_headers => {
+          "Content-Type"  => "application/json; charset=utf-8"
         },
-      )
+      }
+      Faraday::Response::RaiseError.new.on_complete(env) || Faraday::Response.new(env)
+    rescue Faraday::Error::ClientError => e
+      raise Zendesk2::Error.new(e)
     end
   end
 end

data/lib/zendesk2/{models → client/models}/organization.rb

@@ -1,49 +1,49 @@
 class Zendesk2::Client::Organization < Cistern::Model
   include Zendesk2::Errors
   identity :id,               type: :integer
-  attribute :shared_comments, type: :boolean
-  attribute :notes,           type: :array
-  attribute :tags
+  attribute :created_at,      type: :time
+  attribute :details,         type: :string
   attribute :domain_names,    type: :array
-  attribute :group_id,        type: :integer
   attribute :external_id,     type: :integer
-  attribute :name
-  attribute :created_at,      type: :time
-  attribute :details
+  attribute :group_id,        type: :integer
+  attribute :shared_comments, type: :boolean
   attribute :shared_tickets,  type: :boolean
+  attribute :tags,            type: :array
+  attribute :name,            type: :string
+  attribute :notes,           type: :array
   attribute :updated_at,      type: :time
 
-  def destroy
+  def destroy!
     requires :identity
 
-    response = connection.destroy_organization("id" => self.identity)
+    connection.destroy_organization("id" => self.identity)
+  end
+
+  def destroy
+    destroy!
+  rescue Zendesk2::Error
+    false
   end
 
   def destroyed?
-    self.reload
-  rescue not_found
-    true
+    !self.reload
   end
 
   def save
-    if new_record?
-      requires :name
-      data = connection.create_organization(attributes).body["organization"]
-      merge_attributes(data)
-    else
-      requires :identity
-      params = {
-        "id"   => self.identity,
-        "name" => self.name,
-      }
-      data = connection.update_organization(params).body["organization"]
-      merge_attributes(data)
-    end
+    data = if new_record?
+             requires :name
+             connection.create_organization(params).body["organization"]
+           else
+             requires :identity
+             connection.update_organization(params).body["organization"]
+           end
+    merge_attributes(data)
   end
 
   def users
     requires :identity
     data = connection.get_organization_users("id" => self.identity).body["users"]
+
     connection.users.load(data)
   end
 
@@ -53,4 +53,10 @@ class Zendesk2::Client::Organization < Cistern::Model
 
     connection.tickets.load(data)
   end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "id", "details", "domain_names", "external_id", "group_id", "shared_comments", "shared_tickets", "tags", "name", "notes")
+  end
 end

data/lib/zendesk2/{models → client/models}/organizations.rb

@@ -12,8 +12,8 @@ class Zendesk2::Client::Organizations < Cistern::Collection
     new(connection.get_current_organization.body["organization"])
   end
 
-  def search(term)
-    body = connection.search_organization("query" => term).body
+  def search(parameters)
+    body = connection.search(parameters.merge("type" => "organization")).body
     if data = body.delete("results")
       load(data)
     end

data/lib/zendesk2/{models → client/models}/ticket.rb

@@ -42,18 +42,16 @@ class Zendesk2::Client::Ticket < Cistern::Model
     connection.destroy_ticket("id" => self.identity)
   end
 
-  def destroyed?
-    self.reload
-  rescue not_found
-    true
+  def collaborators
+    self.collaborator_ids.map{|cid| self.connection.users.get(cid)}
   end
 
-  def params
-    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "external_id", "via", "requester_id", "submitter_id", "assignee_id", "organization_id", "subject", "description", "fields", "recipient", "status")
+  def collaborators=(collaborators)
+    self.collaborator_ids= collaborators.map(&:identity)
   end
 
-  def submitter
-    self.connection.users.get(submitter_id)
+  def destroyed?
+    !self.reload
   end
 
   def requester=(requester)
@@ -63,4 +61,15 @@ class Zendesk2::Client::Ticket < Cistern::Model
   def requester
     self.connection.users.get(self.requester_id)
   end
+
+  def submitter
+    self.connection.users.get(submitter_id)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), "external_id", "via", "requester_id", "submitter_id", "assignee_id", "organization_id", "subject", "description", "fields", "recipient", "status", "collaborator_ids")
+  end
+
 end

data/lib/zendesk2/{models → client/models}/user.rb

@@ -1,4 +1,5 @@
 class Zendesk2::Client::User < Cistern::Model
+  include Zendesk2::Errors
   identity :id,                     type: :id
   attribute :url
   attribute :external_id
@@ -16,7 +17,7 @@ class Zendesk2::Client::User < Cistern::Model
   attribute :email
   attribute :phone
   attribute :signature
-  attribute :details
+  attribute :details,               type: :string
   attribute :notes
   attribute :organization_id,       type: :integer
   attribute :role
@@ -41,7 +42,7 @@ class Zendesk2::Client::User < Cistern::Model
     end
   end
 
-  def destroy
+  def destroy!
     requires :identity
     raise "don't nuke yourself" if self.email == connection.username
 
@@ -49,23 +50,21 @@ class Zendesk2::Client::User < Cistern::Model
     merge_attributes(data)
   end
 
-  def destroyed?
-    !self.active
-  end
-
-  def organization=(organization)
-    self.organization_id= organization.id
+  def destroy
+    destroy!
+  rescue Zendesk2::Error => e
+    false
   end
 
-  def organization
-    self.connection.organizations.get(self.organization_id)
+  def destroyed?
+    !reload || !self.active
   end
 
   def login_url(timestamp, options={})
     requires :name, :email
 
     return_to = options[:return_to]
-    token     = self.token || options[:token]
+    token     = self.connection.token || options[:token]
 
     uri      = Addressable::URI.parse(self.connection.url)
     uri.path = "/access/remote"
@@ -87,6 +86,30 @@ class Zendesk2::Client::User < Cistern::Model
     uri.to_s
   end
 
+  def requested_tickets
+    requires :identity
+
+    data = connection.get_requested_tickets("id" => self.identity).body["tickets"]
+
+    connection.tickets.load(data)
+  end
+
+  def ccd_tickets
+    requires :identity
+
+    data = connection.get_ccd_tickets("id" => self.identity).body["tickets"]
+
+    connection.tickets.load(data)
+  end
+
+  def organization=(organization)
+    self.organization_id= organization.id
+  end
+
+  def organization
+    self.connection.organizations.get(self.organization_id)
+  end
+
   private
 
   def params

data/lib/zendesk2/{requests → client/requests}/create_ticket.rb

@@ -14,10 +14,11 @@ class Zendesk2::Client
       identity = self.class.new_id
 
       record = {
-        "id"         => identity,
-        "url"        => url_for("/tickets/#{identity}.json"),
-        "created_at" => Time.now.iso8601,
-        "updated_at" => Time.now.iso8601,
+        "id"               => identity,
+        "url"              => url_for("/tickets/#{identity}.json"),
+        "created_at"       => Time.now.iso8601,
+        "updated_at"       => Time.now.iso8601,
+        "collaborator_ids" => [],
       }.merge(params)
 
       record["requester_id"] ||= @current_user_id
@@ -34,4 +35,4 @@ class Zendesk2::Client
       )
     end
   end # Mock
-end
+end # Zendesk2::Client

data/lib/zendesk2/{requests → client/requests}/create_user.rb

@@ -14,10 +14,11 @@ class Zendesk2::Client
       identity = self.class.new_id
 
       record = {
-        "id"              => identity,
-        "url"             => url_for("/users/#{identity}.json"),
-        "created_at"      => Time.now.iso8601,
-        "updated_at"      => Time.now.iso8601
+        "id"         => identity,
+        "url"        => url_for("/users/#{identity}.json"),
+        "created_at" => Time.now.iso8601,
+        "updated_at" => Time.now.iso8601,
+        "active"     => true,
       }.merge(params)
 
       self.data[:users][identity]= record

data/lib/zendesk2/client/requests/destroy_user.rb

@@ -0,0 +1,47 @@
+class Zendesk2::Client
+  class Real
+    def destroy_user(params={})
+      id = params["id"]
+
+      request(
+        :method => :delete,
+        :path   => "/users/#{id}.json"
+      )
+    end
+  end
+
+  class Mock
+    def destroy_user(params={})
+      id   = params["id"]
+      path = "/users/#{id}.json"
+
+      tickets = self.data[:tickets].values.select{|t| t["requester_id"] == id}.size
+      if tickets < 1
+        body = self.data[:users].delete(id)
+        response(
+          :method => :delete,
+          :path   => path,
+          :body   => {
+            "user" => body,
+          },
+        )
+      else
+        response(
+          :method => :delete,
+          :path   => path,
+          :status => 422,
+          :body   => {
+            "error"       => "RecordInvalid",
+            "description" => "Record validation errors",
+            "details"     => {
+              "base" => [{
+                "type"        => "User is requester on #{tickets} ticket(s) that are not closed.",
+                "description" => "Base User is requester on #{tickets} ticket(s) that are not closed."
+              }]
+            }
+          }
+        )
+      end
+    end
+  end
+end

data/lib/zendesk2/client/requests/get_ccd_tickets.rb

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def get_ccd_tickets(params={})
+      id          = params["id"]
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/users/#{id}/tickets/ccd.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_ccd_tickets(params={})
+      id = params["id"]
+
+      page(params, :tickets, "/ccds/#{id}/tickets.json", "tickets", filter: lambda{|c| c.select{|u| u["collaborator_ids"].include?(id)}})
+    end
+  end # Mock
+end

data/lib/zendesk2/{requests → client/requests}/get_organization.rb

@@ -22,11 +22,10 @@ class Zendesk2::Client
           },
         )
       else 
-        r = response(
+        response(
           :path   => "/organizations/#{id}.json",
           :status => 404
         )
-        raise not_found!(nil, r)
       end
     end
   end # Mock

data/lib/zendesk2/client/requests/get_requested_tickets.rb

@@ -0,0 +1,22 @@
+class Zendesk2::Client
+  class Real
+    def get_requested_tickets(params={})
+      id          = params["id"]
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/users/#{id}/tickets/requested.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_requested_tickets(params={})
+      id = params["id"]
+
+      page(params, :tickets, "/requesteds/#{id}/tickets.json", "tickets", filter: lambda{|c| c.select{|u| u["requester_id"] == id}})
+    end
+  end # Mock
+end

data/lib/zendesk2/{requests → client/requests}/get_ticket.rb

@@ -13,20 +13,21 @@ class Zendesk2::Client
   class Mock
     def get_ticket(params={})
       id   = params["id"]
-      if body = self.data[:tickets][id]
+      path = "/tickets/#{id}.json"
 
+      if body = self.data[:tickets][id]
         response(
-          :path  => "/tickets/#{id}.json",
-          :body  => {
+          :path => path,
+          :body => {
             "ticket" => body
           },
         )
       else 
-        r = response(
-          :path   => "/tickets/#{id}.json",
-          :status => 404
+        response(
+          :path   => path,
+          :status => 404,
+          :body => {"error" => "RecordNotFound", "description" => "Not found"},
         )
-        raise not_found!(nil, r)
       end
     end
   end # Mock

data/lib/zendesk2/client/requests/search.rb

@@ -0,0 +1,26 @@
+class Zendesk2::Client
+  class Real
+    def search(query)
+      term = query.map{|k,v| "#{k}:#{v}"}.join(" ")
+      request(
+        :method => :get,
+        :params => {query: term},
+        :path   => "/search.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def search(query)
+      type       = query.delete("type")
+      collection = type.nil? ? self.data.values : self.data["#{type}s".to_sym]
+
+      results = collection.select{|k,v| query.all?{|term, condition| v[term.to_s] == condition}}.values
+
+      response(
+        :path => "/search.json",
+        :body => {"results" => results},
+      )
+    end
+  end # Mock
+end

data/lib/zendesk2/{requests → client/requests}/update_user.rb

@@ -10,8 +10,6 @@ class Zendesk2::Client
           "user" => params
         },
       )
-    rescue => e
-      p e.response
     end
   end
   class Mock

data/lib/zendesk2/error.rb

@@ -0,0 +1,13 @@
+class Zendesk2::Error < StandardError
+
+  attr_reader :message
+  def initialize(exception)
+    @exception = exception
+    message = if exception.response
+                 "#{exception.response[:status]} #{exception.response[:body]}"
+               else
+                 exception.message
+               end
+    super(message)
+  end
+end

data/lib/zendesk2/errors.rb

@@ -6,4 +6,12 @@ module Zendesk2::Errors
   def not_found!(*args)
     not_found.new(args)
   end
+
+  def unprocessable_entity
+    Faraday::Error::ClientError
+  end
+
+  def unprocessable_entity!(*args)
+    unprocessable_entity.new(args)
+  end
 end

data/lib/zendesk2/paged_collection.rb

@@ -3,6 +3,7 @@ module Zendesk2::PagedCollection
     klass.send(:attribute, :count)
     klass.send(:attribute, :next_page_link, {:aliases => "next_page"})
     klass.send(:attribute, :previous_page_link, {:aliases => "previous_page"})
+    klass.send(:include, Zendesk2::Errors)
     klass.send(:extend, Zendesk2::PagedCollection::Attributes)
   end
 
@@ -23,6 +24,8 @@ module Zendesk2::PagedCollection
     if data = self.connection.send(model_method, {"id" => id}).body[self.model_root]
       new(data)
     end
+  rescue Zendesk2::Error
+    nil
   end
 
   def next_page

data/lib/zendesk2/version.rb

@@ -1,3 +1,3 @@
 module Zendesk2
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/shared/resource.rb

@@ -47,4 +47,6 @@ shared_examples "a resource" do |_collection, _params, _update_params|
     record.destroy
     record.should be_destroyed
   end
+
+  it "should search"
 end

data/spec/users_spec.rb

@@ -12,4 +12,28 @@ describe "users" do
     current_user.should be_a(Zendesk2::Client::User)
     current_user.email.should == client.username
   end
+
+  describe do
+    let(:user) { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid) }
+
+    it "should get requested tickets" do
+      ticket = client.tickets.create(requester: user, subject: Zendesk2.uuid, description: Zendesk2.uuid)
+
+      user.requested_tickets.should include ticket
+    end
+
+    it "should get ccd tickets" do
+      ticket = client.tickets.create(collaborators: [user], subject: Zendesk2.uuid, description: Zendesk2.uuid)
+
+      user.ccd_tickets.should include ticket
+    end
+
+    it "cannot destroy a user with a ticket" do
+      ticket = client.tickets.create(requester: user, subject: Zendesk2.uuid, description: Zendesk2.uuid)
+
+      user.destroy.should be_false
+
+      user.should_not be_destroyed
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk2
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-08 00:00:00.000000000 Z
+date: 2012-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cistern
@@ -108,32 +108,36 @@ files:
 - Rakefile
 - lib/zendesk2.rb
 - lib/zendesk2/client.rb
+- lib/zendesk2/client/models/organization.rb
+- lib/zendesk2/client/models/organizations.rb
+- lib/zendesk2/client/models/ticket.rb
+- lib/zendesk2/client/models/tickets.rb
+- lib/zendesk2/client/models/user.rb
+- lib/zendesk2/client/models/users.rb
+- lib/zendesk2/client/requests/create_organization.rb
+- lib/zendesk2/client/requests/create_ticket.rb
+- lib/zendesk2/client/requests/create_user.rb
+- lib/zendesk2/client/requests/destroy_organization.rb
+- lib/zendesk2/client/requests/destroy_ticket.rb
+- lib/zendesk2/client/requests/destroy_user.rb
+- lib/zendesk2/client/requests/get_ccd_tickets.rb
+- lib/zendesk2/client/requests/get_current_user.rb
+- lib/zendesk2/client/requests/get_organization.rb
+- lib/zendesk2/client/requests/get_organization_tickets.rb
+- lib/zendesk2/client/requests/get_organization_users.rb
+- lib/zendesk2/client/requests/get_organizations.rb
+- lib/zendesk2/client/requests/get_requested_tickets.rb
+- lib/zendesk2/client/requests/get_ticket.rb
+- lib/zendesk2/client/requests/get_tickets.rb
+- lib/zendesk2/client/requests/get_user.rb
+- lib/zendesk2/client/requests/get_users.rb
+- lib/zendesk2/client/requests/search.rb
+- lib/zendesk2/client/requests/update_organization.rb
+- lib/zendesk2/client/requests/update_ticket.rb
+- lib/zendesk2/client/requests/update_user.rb
+- lib/zendesk2/error.rb
 - lib/zendesk2/errors.rb
-- lib/zendesk2/models/organization.rb
-- lib/zendesk2/models/organizations.rb
-- lib/zendesk2/models/ticket.rb
-- lib/zendesk2/models/tickets.rb
-- lib/zendesk2/models/user.rb
-- lib/zendesk2/models/users.rb
 - lib/zendesk2/paged_collection.rb
-- lib/zendesk2/requests/create_organization.rb
-- lib/zendesk2/requests/create_ticket.rb
-- lib/zendesk2/requests/create_user.rb
-- lib/zendesk2/requests/destroy_organization.rb
-- lib/zendesk2/requests/destroy_ticket.rb
-- lib/zendesk2/requests/destroy_user.rb
-- lib/zendesk2/requests/get_current_user.rb
-- lib/zendesk2/requests/get_organization.rb
-- lib/zendesk2/requests/get_organization_tickets.rb
-- lib/zendesk2/requests/get_organization_users.rb
-- lib/zendesk2/requests/get_organizations.rb
-- lib/zendesk2/requests/get_ticket.rb
-- lib/zendesk2/requests/get_tickets.rb
-- lib/zendesk2/requests/get_user.rb
-- lib/zendesk2/requests/get_users.rb
-- lib/zendesk2/requests/update_organization.rb
-- lib/zendesk2/requests/update_ticket.rb
-- lib/zendesk2/requests/update_user.rb
 - lib/zendesk2/version.rb
 - spec/organizations_spec.rb
 - spec/shared/resource.rb

data/lib/zendesk2/requests/destroy_user.rb

@@ -1,27 +0,0 @@
-class Zendesk2::Client
-  class Real
-    def destroy_user(params={})
-      id = params["id"]
-
-      request(
-        :method => :delete,
-        :path   => "/users/#{id}.json"
-      )
-    end
-  end
-
-  class Mock
-    def destroy_user(params={})
-      id   = params["id"]
-      body = self.data[:users].delete(id)
-
-      response(
-        :method => :delete,
-        :path   => "/users/#{id}.json",
-        :body   => {
-          "user" => body,
-        },
-      )
-    end
-  end
-end