zendesk2 0.4.4 → 0.4.5

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

@@ -12,21 +12,14 @@ class Zendesk2::Client
 
   class Mock
     def get_organization(params={})
-      id   = params["id"]
-      if body = self.data[:organizations][id]
+      id = params["id"]
 
-        response(
-          :path  => "/organizations/#{id}.json",
-          :body  => {
-            "organization" => body
-          },
-        )
-      else 
-        response(
-          :path   => "/organizations/#{id}.json",
-          :status => 404
-        )
-      end
+      response(
+        :path  => "/organizations/#{id}.json",
+        :body  => {
+          "organization" => find!(:organizations, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -14,7 +14,7 @@ class Zendesk2::Client
     def get_organization_memberships(params={})
       organization_id = params["organization_id"]
 
-      page(params, :memberships, "/organizations/#{organization_id}/memberships.json", "organization_memberships", filter: lambda { |c| c.select { |m| m["organization_id"] == organization_id } })
+      resources(:memberships, "/organizations/#{organization_id}/memberships.json", "organization_memberships", filter: lambda { |c| c.select { |m| m["organization_id"] == organization_id } })
     end
   end # Mock
 end

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

@@ -15,20 +15,12 @@ class Zendesk2::Client
       id   = params["id"]
       path = "/tickets/#{id}.json"
 
-      if body = self.data[:tickets][id]
-        response(
-          :path => path,
-          :body => {
-            "ticket" => body
-          },
-        )
-      else 
-        response(
-          :path   => path,
-          :status => 404,
-          :body => {"error" => "RecordNotFound", "description" => "Not found"},
-        )
-      end
+      response(
+        :path => path,
+        :body => {
+          "ticket" => self.find!(:tickets, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -13,25 +13,14 @@ class Zendesk2::Client
 
   class Mock
     def get_ticket_audit(params={})
-      id        = params["id"]
-      ticket_id = params["ticket_id"]
+      id = params["id"]
 
-      path = "/ticket_audits/#{id}.json"
-
-      if body = self.data[:ticket_audits][id]
-        response(
-          :path => path,
-          :body => {
-            "ticket_audit" => body
-          },
-        )
-      else 
-        response(
-          :path   => path,
-          :status => 404,
-          :body => {"error" => "RecordNotFound", "description" => "Not found"},
-        )
-      end
+      response(
+        :path => "/ticket_audits/#{id}.json",
+        :body => {
+          "ticket_audit" => find!(:ticket_audits, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -13,22 +13,13 @@ class Zendesk2::Client
   class Mock
     def get_ticket_field(params={})
       id   = params["id"]
-      path = "/ticket_fields/#{id}.json"
 
-      if body = self.data[:ticket_fields][id]
-        response(
-          :path => path,
-          :body => {
-            "ticket_field" => body
-          },
-        )
-      else
-        response(
-          :path   => path,
-          :status => 404,
-          :body => {"error" => "RecordNotFound", "description" => "Not found"},
-        )
-      end
+      response(
+        :path => "/ticket_fields/#{id}.json",
+        :body => {
+          "ticket_field" => find!(:ticket_fields, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -12,7 +12,7 @@ class Zendesk2::Client
   end
   class Mock
     def get_ticket_fields(params={})
-      page(params, :ticket_fields, "/ticket_fields.json", "ticket_fields")
+      collection(:ticket_fields, "/ticket_fields.json", "ticket_fields")
     end
   end
 end

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

@@ -20,24 +20,13 @@ class Zendesk2::Client
   class Mock
     def get_ticket_metric(params={})
       id        = params["id"]
-      ticket_id = params["ticket_id"]
-
-      path = "/tickets_metrics/#{id}.json"
 
-      if body = self.data[:ticket_metrics][id]
-        response(
-          :path => path,
-          :body => {
-            "ticket_metric" => body
-          },
-        )
-      else
-        response(
-          :path   => path,
-          :status => 404,
-          :body   => {"error" => "RecordNotFound", "description" => "Not found"},
-        )
-      end
+      response(
+        :path => "/tickets_metrics/#{id}.json",
+        :body => {
+          "ticket_metric" => find!(:ticket_metrics, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -16,15 +16,12 @@ class Zendesk2::Client
     def get_topic_comment(params={})
       id       = params["id"]
       topic_id = params["topic_id"]
-      path     = "/topics/#{topic_id}/comments/#{id}.json"
-
-      body = self.data[:topic_comments][id]
 
-      unless (topic_comment = self.data[:topic_comments][id]) && topic_comment["topic_id"] == topic_id
-        response(status: 404)
+      unless (topic_comment = self.find!(:topic_comments, id)) && topic_comment["topic_id"] == topic_id
+        error!(:not_found)
       else
         response(
-          :path  => "/topic_comments/#{id}.json",
+          :path  => "/topics/#{topic_id}/comments/#{id}.json",
           :body  => {
             "topic_comment" => topic_comment,
           },

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

@@ -13,7 +13,7 @@ class Zendesk2::Client
   class Mock
     def get_topic_comments(params={})
       topic_id = params["topic_id"]
-      topic    = self.data[:topics][topic_id] # TODO: 404 if !topic
+      self.find!(:topics, topic_id)
       filter   = lambda { |comments| comments.select { |c| c["topic_id"] == topic_id } }
 
       page(params, :topic_comments, "/topics/#{topic_id}/comments.json", "topic_comments", filter: filter).tap do

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

@@ -13,22 +13,18 @@ class Zendesk2::Client
   class Mock
     def get_user(params={})
       id   = params["id"]
-      if body = self.data[:users][id]
 
-        identities = self.data[:identities].values.select{|i| i["user_id"] == id}
-        identity = identities.find{|i| i["type"] == "email" && i["primary"]} || identities.find{|i| i["type"] == "email"}
+      identities = self.data[:identities].values.select{|i| i["user_id"] == id}
+      identity = identities.find { |i| i["type"] == "email" && i["primary"] } || identities.find { |i| i["type"] == "email" }
 
-        # @todo what happens if no identity?
+      # @todo what happens if no identity?
 
-        response(
-          :path  => "/users/#{id}.json",
-          :body  => {
-            "user" => body.merge("email" => identity["value"]),
-          },
-        )
-      else
-        response(status: 404)
-      end
+      response(
+        :path  => "/users/#{id}.json",
+        :body  => {
+          "user" => find!(:users, id).merge("email" => identity["value"]),
+        },
+      )
     end
   end # Mock
 end

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

@@ -0,0 +1,25 @@
+class Zendesk2::Client
+  class Real
+    def get_user_field(params={})
+      id = params["id"]
+
+      request(
+        :method => :get,
+        :path => "/user_fields/#{id}.json"
+      )
+    end
+  end # Real
+
+  class Mock
+    def get_user_field(params={})
+      id   = params["id"]
+
+      response(
+        :path => "/user_fields/#{id}.json",
+        :body => {
+          "user_field" => find!(:user_fields, id)
+        },
+      )
+    end
+  end # Mock
+end

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

@@ -0,0 +1,18 @@
+class Zendesk2::Client
+  class Real
+    def get_user_fields(params={})
+      page_params = Zendesk2.paging_parameters(params)
+
+      request(
+        :params  => page_params,
+        :method  => :get,
+        :path    => "/user_fields.json",
+      )
+    end
+  end
+  class Mock
+    def get_user_fields(params={})
+      collection(:user_fields, "/user_fields.json", "user_fields")
+    end
+  end
+end

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

@@ -13,22 +13,13 @@ class Zendesk2::Client
     def get_user_identity(params={})
       id      = params["id"]
       user_id = params["user_id"]
-      path    = "/users/#{user_id}/identities/#{id}.json"
 
-      if body = self.data[:identities][id]
-        response(
-          :path => path,
-          :body => {
-            "identity" => body
-          },
-        )
-      else 
-        response(
-          :path   => path,
-          :status => 404,
-          :body => {"error" => "RecordNotFound", "description" => "Not found"},
-        )
-      end
+      response(
+        :path =>  "/users/#{user_id}/identities/#{id}.json",
+        :body => {
+          "identity" => find!(:identities, id)
+        },
+      )
     end
   end # Mock
 end

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

@@ -16,7 +16,7 @@ class Zendesk2::Client
     def get_user_memberships(params={})
       user_id = params["user_id"]
 
-      page(params, :memberships, "/users/#{user_id}/organization_memberships.json", "organization_memberships", filter: lambda{|c| c.select { |a| a["user_id"] == user_id }})
+      resources(:memberships, "/users/#{user_id}/organization_memberships.json", "organization_memberships", filter: lambda{|c| c.select { |a| a["user_id"] == user_id }})
     end
   end # Mock
 end

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

@@ -19,7 +19,7 @@ class Zendesk2::Client
 
       path = "/users/#{user_id}/organization_memberships/#{id}/make_default.json"
 
-      if (membership = self.data[:memberships][id]) && membership["user_id"] == user_id
+      if (membership = self.find!(:memberships, id)) && membership["user_id"] == user_id
         # only one user can be default
         other_user_memberships = self.data[:memberships].values.select { |m| m["user_id"] == user_id }
         other_user_memberships.each { |i| i["default"] = false }
@@ -29,11 +29,7 @@ class Zendesk2::Client
           :method => :put,
           :path   => path
         )
-      else
-        response(
-          :path   => path,
-          :status => 404
-        )
+      else error!(:not_found)
       end
     end
   end

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

@@ -17,7 +17,7 @@ class Zendesk2::Client
       user_id = params.delete("user_id")
       path    = "/users/#{user_id}/identities/#{id}/make_primary.json"
 
-      user_identity = self.data[:identities][id]
+      user_identity = self.find!(:identities, id)
 
       if user_identity && user_identity["user_id"] == user_id
         # only one user can be primary
@@ -29,11 +29,8 @@ class Zendesk2::Client
           :method => :put,
           :path   => path
         )
-      else 
-        response(
-          :path   => path,
-          :status => 404
-        )
+      else
+        error!(:not_found)
       end
     end
   end

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

@@ -15,21 +15,15 @@ class Zendesk2::Client
   end
   class Mock
     def update_group(params={})
-      id   = params.delete("id")
-      path = "/groups/#{id}.json"
-
-      if group = self.data[:groups][id]
-        group.merge!(params)
-        response(
-          :method => :put,
-          :path   => "/groups/#{id}.json",
-          :body   => {
-            "group" => group
-          },
-        )
-      else response(status: 404)
-      end
+      id = params.delete("id")
 
+      response(
+        :method => :put,
+        :path   => "/groups/#{id}.json",
+        :body   => {
+          "group" => find!(:groups, id).merge!(params)
+        },
+      )
     end
   end
 end

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

@@ -20,8 +20,8 @@ class Zendesk2::Client
       topic_id = params.delete("topic_id")
       path     = "/topics/#{topic_id}/comments/#{id}.json"
 
-      unless (topic_comment = self.data[:topic_comments][id]) && topic_comment["topic_id"] == topic_id
-        response(status: 404)
+      unless (topic_comment = self.find!(:topic_comments, id)) && topic_comment["topic_id"] == topic_id
+        error!(:not_found)
       else
         body = topic_comment.merge!(params)
         response(

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

@@ -0,0 +1,28 @@
+class Zendesk2::Client
+  class Real
+    def update_user_field(params={})
+      id = params.delete("id")
+
+      request(
+        :method => :put,
+        :path   => "/user_fields/#{id}.json",
+        :body   => {
+          "user_field" => params
+        },
+      )
+    end
+  end
+  class Mock
+    def update_user_field(params={})
+      user_field_id = params.delete("id")
+
+      response(
+        :method => :put,
+        :path   => "/user_fields/#{user_field_id}.json",
+        :body   => {
+          "user_field" => find!(:user_fields, user_field_id).merge!(params),
+        },
+      )
+    end
+  end
+end

data/lib/zendesk2/client.rb

@@ -18,8 +18,9 @@ class Zendesk2::Client < Cistern::Service
   collection :ticket_comments
   collection :topic_comments
   collection :topics
-  collection :users
+  collection :user_fields
   collection :user_identities
+  collection :users
   model :category
   model :forum
   model :group
@@ -38,9 +39,9 @@ class Zendesk2::Client < Cistern::Service
   model :topic
   model :topic_comment
   model :user
+  model :user_field
   model :user_identity
 
-  request :get_assignable_groups
   request :create_category
   request :create_forum
   request :create_group
@@ -51,6 +52,7 @@ class Zendesk2::Client < Cistern::Service
   request :create_topic
   request :create_topic_comment
   request :create_user
+  request :create_user_field
   request :create_user_identity
   request :destroy_category
   request :destroy_forum
@@ -62,7 +64,9 @@ class Zendesk2::Client < Cistern::Service
   request :destroy_topic
   request :destroy_topic_comment
   request :destroy_user
+  request :destroy_user_field
   request :destroy_user_identity
+  request :get_assignable_groups
   request :get_audits
   request :get_categories
   request :get_category
@@ -73,10 +77,9 @@ class Zendesk2::Client < Cistern::Service
   request :get_group
   request :get_groups
   request :get_membership
-  request :get_user_memberships
-  request :get_organization_memberships
   request :get_organization
   request :get_organization_by_external_id
+  request :get_organization_memberships
   request :get_organization_tickets
   request :get_organization_users
   request :get_organizations
@@ -95,8 +98,11 @@ class Zendesk2::Client < Cistern::Service
   request :get_topic_comments
   request :get_topics
   request :get_user
+  request :get_user_field
+  request :get_user_fields
   request :get_user_identities
   request :get_user_identity
+  request :get_user_memberships
   request :get_users
   request :mark_membership_default
   request :mark_user_identity_primary
@@ -112,24 +118,34 @@ class Zendesk2::Client < Cistern::Service
   request :update_topic
   request :update_topic_comment
   request :update_user
+  request :update_user_field
   request :update_user_identity
 
   recognizes :url, :subdomain, :host, :port, :path, :scheme, :logger, :adapter, :username, :password, :token, :jwt_token
 
+  module Shared
+    def require_parameters(params, *requirements)
+      if (missing = requirements - params.keys).any?
+        raise ArgumentError, "missing parameters: #{missing.join(", ")}"
+      end
+    end
+  end
+
   class Real
+    include Shared
 
     attr_accessor :username, :url, :token, :logger, :jwt_token
 
     def initialize(options={})
       url = options[:url] || Zendesk2.defaults[:url] || begin
-        host      = options[:host]
-        subdomain = options[:subdomain] || Zendesk2.defaults[:subdomain]
+      host      = options[:host]
+      subdomain = options[:subdomain] || Zendesk2.defaults[:subdomain]
 
-        host ||= "#{subdomain}.zendesk.com"
-        scheme = options[:scheme] || "https"
-        port   = options[:port] || (scheme == "https" ? 443 : 80)
+      host ||= "#{subdomain}.zendesk.com"
+      scheme = options[:scheme] || "https"
+      port   = options[:port] || (scheme == "https" ? 443 : 80)
 
-        "#{scheme}://#{host}:#{port}"
+      "#{scheme}://#{host}:#{port}"
       end
 
       @url  = URI.parse(url).to_s
@@ -181,6 +197,7 @@ class Zendesk2::Client < Cistern::Service
   end
 
   class Mock
+    include Shared
 
     attr_reader :username, :url, :token, :jwt_token
 
@@ -199,6 +216,7 @@ class Zendesk2::Client < Cistern::Service
         :tickets         => {},
         :topic_comments  => {},
         :topics          => {},
+        :user_fields     => {},
         :users           => {},
       }
     end
@@ -218,12 +236,12 @@ class Zendesk2::Client < Cistern::Service
 
     def initialize(options={})
       url = options[:url] || begin
-        host   = options[:host]
-        host ||= "#{options[:subdomain] || "mock"}.zendesk.com"
-        scheme = options[:scheme] || "https"
-        port   = options[:port] || (scheme == "https" ? 443 : 80)
+      host   = options[:host]
+      host ||= "#{options[:subdomain] || "mock"}.zendesk.com"
+      scheme = options[:scheme] || "https"
+      port   = options[:port] || (scheme == "https" ? 443 : 80)
 
-        "#{scheme}://#{host}:#{port}"
+      "#{scheme}://#{host}:#{port}"
       end
 
       @url  = url
@@ -249,6 +267,21 @@ class Zendesk2::Client < Cistern::Service
       File.join(@url, "/api/v2", path.to_s)
     end
 
+    def resources(collection, path, collection_root, options={})
+      filter    = options[:filter]
+      resources = self.data[collection].values
+      resources = filter.call(resources) if filter
+      count     = resources.size
+
+      response(
+        :body => {
+          collection_root => resources,
+          "count"         => count,
+        },
+        :path => path
+      )
+    end
+
     def page(params, collection, path, collection_root, options={})
       page_params = Zendesk2.paging_parameters(params)
       page_size   = (page_params["per_page"] || 50).to_i
@@ -288,6 +321,37 @@ class Zendesk2::Client < Cistern::Service
       pluralized
     end
 
+    def self.error_map
+      @@error_map ||= {
+        :invalid => [422, {
+          "error"       => "RecordInvalid",
+          "description" => "Record validation errors",
+        }],
+        :not_found => [404, {
+          "error"       => "RecordNotFound",
+          "description" => "Not found",
+        }],
+      }
+    end
+
+    def find!(collection, identity, options={})
+      if resource = self.data[collection][identity]
+        resource
+      else
+        error!(options[:error] || :not_found)
+      end
+    end
+
+    def error!(type, options={})
+      status, body = self.class.error_map[type]
+      body.merge!("details" => options[:details]) if options[:details]
+
+      response(
+        :status => status,
+        :body   => body,
+      )
+    end
+
     def response(options={})
       method = options[:method] || :get
       status = options[:status] || 200