zendesk2 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f8f737437bc490b562bba51cd72fec6ffad957
-  data.tar.gz: 2497c5274d2462c7d601ced33979ee752d344d51
+  metadata.gz: 79d128511e7f57cbba27856d2f6802def8372e72
+  data.tar.gz: 6f8a606ef092869b312359ea713464a5cbdf930e
 SHA512:
-  metadata.gz: 963a99eddbf1d5533c549360051df1589b619e581b027887dc0abe8551bc71e518a8c70323135160c9ad57cfcdb01f61adeb26fd4ac09a6c9c20993e524f551f
-  data.tar.gz: b316d150a0ce25ba55e744f5e66dd3ebc5a1d957418d76bc2e817a214e26ecc78dc4de2352530ea1310e354f5458a0c74afad051d1ead7be59d9f672803dfece
+  metadata.gz: 30155530e6086ef765851f134129bcf22baaa95e4b8561a685df15c828e4f852f9482ffd24083158682f16b512831e661feefdd07e5c16a61b857b94335c2d19
+  data.tar.gz: a94bccf5ecce5fbc6230fc8c158c2a43c8fb96d545c93108c0207e7e7195c3f08ec7fe44f9dc949d9a9786a0b0e7111ec695e9c545d1b76004f1e05d40757d28

data/README.md

@@ -19,6 +19,18 @@ Or install it yourself as:
 
 ## Usage
 
+### Mock it!
+
+All support resources have basic mocks.  Error conditions and messaging are constantly changing. Please contribute updates or fixes to the mock if you encounter inconsistencies.
+
+```ruby
+Zendesk2::Client.mock!
+
+client = Zendesk2::Client.new(...) # Zendesk2::Client::Mock
+client.organizations.create!(name: "foo") # Zendesk2::Client::Organization
+client.organizations.create!(name: "foo") # Zendesk2::Error => Name has already been taken
+```
+
 ### Defaults
 
 Default credentials will be read in from `~/.zendesk2` file in YAML format.
@@ -57,6 +69,7 @@ Currently support resources
 * Categories
 * Forums
 * Groups
+* Memberships
 * Organization
 * Ticket Audits
 * Ticket Fields
@@ -64,6 +77,7 @@ Currently support resources
 * Topic Comments
 * Topics
 * User Identities
+* User Fields
 * Users
 
 All collection are accessed like so:

data/lib/zendesk2/client/models/categories.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Categories < Zendesk2::Collection
+class Zendesk2::Client::Categories < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Category

data/lib/zendesk2/client/models/forums.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Forums < Zendesk2::Collection
+class Zendesk2::Client::Forums < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Forum

data/lib/zendesk2/client/models/groups.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Groups < Zendesk2::Collection
+class Zendesk2::Client::Groups < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Group

data/lib/zendesk2/client/models/membership.rb

@@ -35,7 +35,7 @@ class Zendesk2::Client::Membership < Zendesk2::Model
     merge_attributes(data)
   end
 
-  def destroy
+  def destroy!
     requires :identity
 
     connection.destroy_membership("id" => self.identity)

data/lib/zendesk2/client/models/organization.rb

@@ -40,9 +40,11 @@ class Zendesk2::Client::Organization < Zendesk2::Model
   def save!
     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)

data/lib/zendesk2/client/models/organizations.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Organizations < Zendesk2::Collection
+class Zendesk2::Client::Organizations < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Organization

data/lib/zendesk2/client/models/ticket_audits.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::TicketAudits < Zendesk2::Collection
+class Zendesk2::Client::TicketAudits < Zendesk2::PagedCollection
 
   model Zendesk2::Client::TicketAudit
 

data/lib/zendesk2/client/models/ticket_comments.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::TicketComments < Zendesk2::Collection
+class Zendesk2::Client::TicketComments < Zendesk2::PagedCollection
 
   model Zendesk2::Client::TicketComment
 

data/lib/zendesk2/client/models/ticket_metrics.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::TicketMetrics < Zendesk2::Collection
+class Zendesk2::Client::TicketMetrics < Zendesk2::PagedCollection
   model Zendesk2::Client::TicketMetric
 
   attribute :ticket_id, type: :integer

data/lib/zendesk2/client/models/tickets.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Tickets < Zendesk2::Collection
+class Zendesk2::Client::Tickets < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Ticket

data/lib/zendesk2/client/models/topic_comments.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::TopicComments < Zendesk2::Collection
+class Zendesk2::Client::TopicComments < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::TopicComment

data/lib/zendesk2/client/models/topics.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Topics < Zendesk2::Collection
+class Zendesk2::Client::Topics < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::Topic

data/lib/zendesk2/client/models/user_field.rb

@@ -0,0 +1,59 @@
+class Zendesk2::Client::UserField < Zendesk2::Model
+  extend Zendesk2::Attributes
+
+  PARAMS = %w[key type title description position active, regexp_for_validation tag custom_field_options]
+
+  # @return [Integer] Automatically assigned upon creation
+  identity :id, type: :integer
+
+  # @return [Boolean] If true, this field is available for use
+  attribute :active, type: :boolean
+  # @return [Time] The time the ticket field was created
+  attribute :created_at, type: :time
+  # @return [Array] Required and presented for a custom field of type "tagger"
+  attribute :custom_field_options, type: :array
+  # @return [String] User-defined description of this field's purpose
+  attribute :description, type: :string
+  # @return [String] create A unique key that identifies this custom field. This is used for updating the field and referencing in placeholders.
+  attribute :key, type: :string
+  # @return [Integer] Ordering of the field relative to other fields
+  attribute :position, type: :integer
+  # @return [String] Regular expression field only. The validation pattern for a field value to be deemed valid.
+  attribute :regexp_for_validation, type: :string
+  # @return [String] Optional for custom field of type "checkbox"; not presented otherwise.
+  attribute :tag, type: :string
+  # @return [String] The title of the custom field
+  attribute :title, type: :string
+  # @return [String] Supported types: "text", "textarea", "checkbox", "date", "integer", "decimal", "regexp", "tagger" (custom dropdown)
+  attribute :type, type: :string
+  # @return [Time] The time of the last update of the ticket field
+  attribute :updated_at, type: :time
+  # @return [String] The URL for this resource
+  attribute :url, type: :string
+
+  def save!
+    data = if new_record?
+             requires :type, :title, :key
+
+             connection.create_user_field(params).body["user_field"]
+           else
+             requires :identity
+
+             connection.update_user_field(params.merge("id" => self.identity)).body["user_field"]
+           end
+
+    merge_attributes(data)
+  end
+
+  def destroy!
+    requires :identity
+
+    connection.destroy_user_field("id" => self.identity)
+  end
+
+  private
+
+  def params
+    Cistern::Hash.slice(Zendesk2.stringify_keys(attributes), *PARAMS)
+  end
+end

data/lib/zendesk2/client/models/user_fields.rb

@@ -0,0 +1,11 @@
+class Zendesk2::Client::UserFields < Zendesk2::Collection
+  include Zendesk2::Searchable
+
+  model Zendesk2::Client::UserField
+
+  self.collection_method = :get_user_fields
+  self.collection_root   = "user_fields"
+  self.model_method      = :get_user_field
+  self.model_root        = "user_field"
+  self.search_type       = "user_field"
+end

data/lib/zendesk2/client/models/user_identity.rb

@@ -37,7 +37,7 @@ class Zendesk2::Client::UserIdentity < Zendesk2::Model
     merge_attributes(data)
   end
 
-  def destroy
+  def destroy!
     requires :identity
 
     connection.destroy_user_identity("user_id" => self.user_id, "id" => self.identity)

data/lib/zendesk2/client/models/users.rb

@@ -1,4 +1,4 @@
-class Zendesk2::Client::Users < Zendesk2::Collection
+class Zendesk2::Client::Users < Zendesk2::PagedCollection
   include Zendesk2::Searchable
 
   model Zendesk2::Client::User

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

@@ -1,6 +1,8 @@
 class Zendesk2::Client
   class Real
     def create_membership(params={})
+      require_parameters(params, "user_id", "organization_id")
+
       user_id = params["user_id"]
 
       request(
@@ -13,9 +15,17 @@ class Zendesk2::Client
 
   class Mock
     def create_membership(params={})
+      require_parameters(params, "user_id", "organization_id")
+
       user_id         = params["user_id"]
       organization_id = params["organization_id"]
 
+      find!(:users, user_id)
+      find!(:organizations, organization_id, error: :invalid, details: { "organization" => [ { "description" => "Organization cannot be blank" } ] })
+      if self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["organization_id"] == organization_id }
+        error!(:invalid, description: { "user_id" => [ { "description" => "User has already been taken" } ] })
+      end
+
       resource_id = self.class.new_id
 
       default_membership = false # !self.data[:memberships].values.find { |m| m["user_id"] == user_id && m["default"] }

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

@@ -23,20 +23,10 @@ class Zendesk2::Client
       }.merge(params)
 
       if (email = record["email"]) && self.data[:identities].find{|k,i| i["type"] == "email" && i["value"] == email}
-        response(
-          :method => :put,
-          :path   => path,
-          :status => 422,
-          :body   => {
-            "error"       => "RecordInvalid",
-            "description" => "Record validation errors",
-            "details" => {
+        error!(:invalid, :details => {
               "email" => [ {
                 "description" => "Email #{email} is already being used by another user"
-              } ]
-            }
-          }
-        )
+              }]})
       else
         user_identity_id = self.class.new_id # ugh
 

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

@@ -0,0 +1,44 @@
+class Zendesk2::Client
+  class Real
+    def create_user_field(params={})
+      request(
+        :body   => {"user_field" => params},
+        :method => :post,
+        :path   => "/user_fields.json",
+      )
+    end
+  end # Real
+
+  class Mock
+    def create_user_field(params={})
+      identity = self.class.new_id
+
+      record = {
+        "active"                => true,
+        "collapsed_for_agents"  => false,
+        "created_at"            => Time.now.iso8601,
+        "description"           => params["title"],
+        "editable_in_portal"    => false,
+        "id"                    => identity,
+        "position"              => 9999,
+        "regexp_for_validation" => "",
+        "removable"             => true,
+        "required"              => false,
+        "required_in_portal"    => false,
+        "tag"                   => "",
+        "title_in_portal"       => params["title"],
+        "updated_at"            => Time.now.iso8601,
+        "url"                   => url_for("/user_fields/#{identity}.json"),
+        "visible_in_portal"     => false,
+      }.merge(params)
+
+      self.data[:user_fields][identity] = record
+
+      response(
+        :method => :post,
+        :body   => {"user_field" => record},
+        :path   => "/user_fields.json"
+      )
+    end
+  end # Mock
+end # Zendesk2::Client

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

@@ -16,6 +16,7 @@ class Zendesk2::Client
       path = "/users/#{id}.json"
 
       tickets = self.data[:tickets].values.select{|t| t["requester_id"] == id}.size
+      find!(:users, id)
       if tickets < 1
         body = self.data[:users].delete(id)
         response(

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

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

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

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

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

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

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

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