zendesk_api 0.2.1 → 0.2.2

data/lib/zendesk_api/server/docs/user_identities.md

@@ -10,7 +10,7 @@ User identities have the following keys:
 | id              | integer | yes       | no        | Automatically assigned upon creation
 | url             | string  | yes       | no        | The API url of this identity
 | user_id         | integer | yes       | yes       | The id of the user
-| type            | string  | yes       | yes       | One of "email", "twitter", "facebook" or "google"
+| type            | string  | yes       | yes       | One of "email", "twitter", "facebook", "google", or "phone_number"
 | value           | string  | yes       | yes       | The identifier for this identity, e.g. an email address
 | verified        | boolean | no        | no        | Is true of the identity has gone through verification
 | primary         | boolean | no        | no        | Is true of the primary identity of the user

data/lib/zendesk_api/server/docs/users.md

@@ -40,6 +40,7 @@ Users are represented as JSON objects which have the following keys:
 | last_login_at         | date                         | yes       | no        | A time-stamp of the last time this user logged in to Zendesk
 | email                 | string                       | no        | yes       | The primary email address of this user
 | phone                 | string                       | no        | no        | The primary phone number of this user
+| identities            | Array                        | no        | no        | Array of user identities (e.g. email and Twitter) associated with this user. See [User Identities](user_identities.html)
 | signature             | string                       | no        | no        | The signature of this user. Only agents and admins can have signatures
 | details               | string                       | no        | no        | In this field you can store any details obout the user. e.g. the address
 | notes                 | string                       | no        | no        | In this field you can store any notes you have about the user
@@ -201,6 +202,16 @@ Location: /api/v2/users/{new-user-id}.json
 }
 ```
 
+### Create User with Multiple Identities
+
+If you have a user with multiple identities, such as email addresses and Twitter accounts, you can also include
+these values at creation time. This is especially useful when importing users from another system.
+
+```bash
+curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/users.json \
+  -H "Content-Type: application/json" -X POST -d '{"user": {"name": "Roger Wilco", "identities": [{ "type": "email", "value": "test@user.com"}, {"type": "twitter", "value": "tester84" }]}}'
+```
+
 ### Create Many Users
 `POST /api/v2/users/create_many.json`
 

data/lib/zendesk_api/server/docs/views.md

@@ -1,7 +1,7 @@
 ## Views
 
 ### JSON Format
-Views are read-only and represented as simple flat JSON objects which have the following keys.
+Views are represented as simple flat JSON objects which have the following keys.
 
 | Name            | Type                       | Comment
 | --------------- | ---------------------------| -------------------
@@ -36,35 +36,33 @@ View Execution is a read-only object that describes how to display a collection
 
 | Name            | Type    | Comment
 | --------------- | ------- | -------
-| fields          | Array   | The ticket fields to display. System fields have a string id.
-| custom_fields   | Array   | The custom ticket fields to display. Custom fields have an id and url referencing the [Ticket Field](ticket_fields.md)
-| group_by        | String  | When present, the field by which the tickets are grouped
-| group_order     | String  | The direction the tickets are grouped. May be one of 'asc' or 'desc'
-| sort_order      | String  | The direction the tickets are sorted. May be one of 'asc' or 'desc'
-| sort_by         | String  | The ticket field used for sorting. This will either be a title or a custom field id.
+| columns         | Array   | The ticket fields to display. Custom fields have an id, title, type and url referencing the [Ticket Field](ticket_fields.md)
+| group           | Object  | When present, the structure indicating how the tickets are grouped
+| sort            | Object  | The column structure of the field used for sorting.
 
 #### Example
 ```js
 {
    "execution":{
-     "fields": [
+     "columns": [
        { "id": "status",  "title": "Status" },
-       { "id": "updated", "title": "Updated" }
-     ],
-     "custom_fields": [
+       { "id": "updated", "title": "Updated" },
        {
-         "id": 5, "title": "Account",
+         "id": 5, "title": "Account", "type": "text",
          "url": "https://example.zendesk.com/api/v2/ticket_fields/5.json"
        },
        ...
      ]
-     "group_by":null,
-     "sort_order":"desc",
-     "sort_by":"updated"
+     "group": { "id": "status", "title": "Status", "order": "desc" },
+     "sort": { "id": "updated", "title": "Updated", "order": "desc" }
    }
 }
 ```
 
+# Deprecated
+
+#
+
 ### Conditions
 The conditions under which a ticket is selected.
 
@@ -313,6 +311,63 @@ Status: 200 OK
 }
 ```
 
+### Create View
+`POST /api/v2/views.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/api/v2/views.json \
+  -H "Content-Type: application/json" -X POST -d '{"view":{"title":"Roger Wilco", "all": [{ "field": "status", "operator": "is", "value": "open" }]}}'
+```
+
+#### Example Response
+
+```http
+Status: 201 Created
+Location: /api/v2/view/{new-view-id}.json
+
+{
+  "view": {
+    "id":   9873843,
+    "title": "Roger Wilco",
+    ...
+  }
+}
+```
+
+### Update View
+`PUT /api/v2/view/{id}.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl -v -u {email_address}:{password} https://{subdomain}.zendesk.com/view/{id}.json \
+  -H "Content-Type: application/json" -X PUT -d '{"view":{"title":"Roger Wilco II"}}'
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
+{
+  "view": {
+    "id":   9873843,
+    "title": "Roger Wilco II",
+    ...
+  }
+}
+```
+
 ### Executing Views
 `GET /api/v2/views/{id}/execute.json`
 
@@ -372,6 +427,41 @@ Status: 200 OK
 }
 ```
 
+### Getting Tickets from a view
+`GET /api/v2/views/{id}/tickets.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl:
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/views/{id}/tickets.json \
+  -v -u {email_address}:{password}
+```
+
+#### Example Responses
+
+```http
+Status: 200 OK
+
+{
+  "tickets": [
+    {
+      "id":      35436,
+      "subject": "Help I need somebody!",
+      ...
+    },
+    {
+      "id":      20057623,
+      "subject": "Not just anybody!",
+      ...
+    },
+  ]
+}
+```
+
 ### Previewing Views
 `POST /api/v2/views/preview.json`
 

data/lib/zendesk_api/version.rb

@@ -1,3 +1,3 @@
 module ZendeskAPI
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/core/spec_helper.rb

@@ -107,6 +107,8 @@ RSpec.configure do |c|
 
   c.extend VCR::RSpec::Macros
   c.extend ResourceMacros
+  c.extend ZendeskAPI::Fixtures
+  c.include ZendeskAPI::Fixtures
   c.include TestHelper
 end
 

data/spec/fixtures/zendesk.rb

@@ -1,88 +1,91 @@
-def user
-  @user ||= find_or_create_user "end-user"
-end
+module ZendeskAPI
+  module Fixtures
+    def user
+      @user ||= find_or_create_user "end-user"
+    end
 
-def current_user
-  VCR.use_cassette('current_user') do
-    @current_user ||= client.users.find(:id => 'me') 
-  end
-end
+    def current_user
+      VCR.use_cassette('current_user') do
+        @current_user ||= client.users.find(:id => 'me')
+      end
+    end
 
-def agent
-  @agent ||= find_or_create_user "agent"
-end
+    def agent
+      @agent ||= find_or_create_user "agent"
+    end
 
-def find_or_create_user(role)
-  VCR.use_cassette("valid_user_#{role}") do
-    email = "zendesk-api-client-ruby-#{role}-#{client.config.username}"
+    def find_or_create_user(role)
+      VCR.use_cassette("valid_user_#{role}") do
+        email = "zendesk-api-client-ruby-#{role}-#{client.config.username}"
 
-    client.users.detect {|u| u.email == email } ||
-    client.users.create(
-      :name => "Test Valid with role #{role}",
-      :verified => true,
-      :email => email,
-      :role => role
-    )
-  end
-end
+        client.users.detect {|u| u.email == email } ||
+        client.users.create(
+          :name => "Test Valid with role #{role}",
+          :verified => true,
+          :email => email,
+          :role => role
+        )
+      end
+    end
 
-def topic
-  VCR.use_cassette('valid_topic') do
-    @topic ||= forum.topics.first
-    @topic ||= client.topics.create(
-      :title => "Test Topic",
-      :body => "This is the body of a topic.",
-      :forum_id => forum.id
-    )
-  end
-end
+    def topic
+      VCR.use_cassette('valid_topic') do
+        @topic ||= forum.topics.first
+        @topic ||= client.topics.create(
+          :title => "Test Topic",
+          :body => "This is the body of a topic.",
+          :forum_id => forum.id
+        )
+      end
+    end
 
-def forum
-  VCR.use_cassette('valid_forum') do
-    @forum ||= client.forums.detect {|f| f.topics.any? }
-    @forum ||= client.forums.create(:name => "Test Forum", :access => "everybody")
-  end
-end
+    def forum
+      VCR.use_cassette('valid_forum') do
+        @forum ||= client.forums.detect {|f| f.topics.any? }
+        @forum ||= client.forums.create(:name => "Test Forum", :access => "everybody")
+      end
+    end
 
-def category
-  VCR.use_cassette('valid_category') do
-    @category ||= client.categories.first
-    @category ||= client.categories.create(:name => "Test Category")
-  end
-end
+    def category
+      VCR.use_cassette('valid_category') do
+        @category ||= client.categories.first
+        @category ||= client.categories.create(:name => "Test Category")
+      end
+    end
 
-def ticket
-  VCR.use_cassette('valid_ticket') do
-    @ticket ||= client.tickets.first
-    @ticket ||= client.tickets.create(
-      :subject => "Test Ticket",
-      :description => "This is a test of the emergency alert system.",
-      :requester_id => user.id
-    )
-  end
-end
+    def ticket
+      VCR.use_cassette('valid_ticket') do
+        @ticket ||= client.tickets.first
+        @ticket ||= client.tickets.create(
+          :subject => "Test Ticket",
+          :description => "This is a test of the emergency alert system.",
+          :requester_id => user.id
+        )
+      end
+    end
 
-def suspended_ticket
-  VCR.use_cassette('valid_suspended_ticket') do
-    @suspended_ticket ||= client.suspended_tickets.first
-  end
-end
+    def suspended_ticket
+      VCR.use_cassette('valid_suspended_ticket') do
+        @suspended_ticket ||= client.suspended_tickets.first
+      end
+    end
 
-def group
-  VCR.use_cassette('valid_group') do
-    @ticket ||= client.groups.detect {|g| !g.default}
-    @ticket ||= client.groups.create(:name => "Test Group")
-  end
-end
+    def group
+      VCR.use_cassette('valid_group') do
+        @ticket ||= client.groups.detect {|g| !g.default}
+        @ticket ||= client.groups.create(:name => "Test Group")
+      end
+    end
 
-def organization
-  VCR.use_cassette('valid_organization') do
-    @organization ||= current_user.organization 
-  end
-end
+    def organization
+      VCR.use_cassette('valid_organization') do
+        @organization ||= current_user.organization
+      end
+    end
 
-# Global default options, overwritten if using under
-def default_options
-  {}
+    # Global default options, overwritten if using under
+    def default_options
+      {}
+    end
+  end
 end
-

data/spec/live/ticket_spec.rb

@@ -90,11 +90,38 @@ describe ZendeskAPI::Ticket do
   it "can comment while creating" do
     VCR.use_cassette("ticket_inline_comments") do
       ticket = ZendeskAPI::Ticket.new(client, valid_attributes.merge(default_options))
-      ticket.comment = ZendeskAPI::TicketComment.new(client, :value => "My comment", :public => false)
+      ticket.comment = ZendeskAPI::Ticket::Comment.new(client, :value => "My comment", :public => false)
       ticket.save!
 
       ticket.changes.should == {} # comment was set before save
       ticket.attributes[:comment].should == {"value" => "My comment", "public" => false}
     end
   end
+
+  describe "import race condition" do
+    it "should handle it" do
+      email = "test+#{rand(100000)}@test.com"
+
+      VCR.use_cassette("ticket_import_race") do
+        threads = []
+
+        3.times do
+          threads << Thread.new do
+            client.insert_callback do |response|
+              Thread.current[:response] = response
+            end
+
+            ZendeskAPI::Ticket.import(client, :requester => { :email => email, :name => "Hello" }, :subject => "Test", :description => "Test")
+          end
+        end
+
+        threads.map! do |thread|
+          thread.join(3)
+          thread[:response][:status]
+        end
+
+        threads.all? {|st| [201, 422].include?(st)}.should be_true
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -270,6 +270,7 @@ files:
 - lib/zendesk_api/server/docs/activity_stream.md
 - lib/zendesk_api/server/docs/attachments.md
 - lib/zendesk_api/server/docs/autocomplete.md
+- lib/zendesk_api/server/docs/automations.md
 - lib/zendesk_api/server/docs/categories.md
 - lib/zendesk_api/server/docs/custom_roles.md
 - lib/zendesk_api/server/docs/forum_subscriptions.md