zendesk_api 0.2.2 → 0.2.4

data/Gemfile.lock

@@ -13,7 +13,7 @@ GIT
 PATH
   remote: .
   specs:
-    zendesk_api (0.2.2)
+    zendesk_api (0.2.4)
       faraday (>= 0.8.0)
       faraday_middleware (>= 0.8.7)
       hashie
@@ -25,19 +25,20 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
       builder (~> 3.0.0)
-    activesupport (3.2.8)
+    activesupport (3.2.11)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.3.2)
     backports (2.6.5)
-    bond (0.4.2)
-    bootstrap-sass (2.1.1.0)
+    bond (0.4.3)
+    bootstrap-sass (2.2.2.0)
+      sass (~> 3.2)
     builder (3.0.4)
-    bump (0.3.5)
-    chunky_png (1.2.6)
+    bump (0.3.9)
+    chunky_png (1.2.7)
     coderay (1.0.8)
     coderay_bash (1.0.4)
       coderay (>= 1.0)
@@ -45,7 +46,7 @@ GEM
       chunky_png (~> 1.2)
       fssm (>= 0.2.7)
       sass (~> 3.1)
-    crack (0.3.1)
+    crack (0.3.2)
     database_cleaner (0.9.1)
     diff-lcs (1.1.3)
     eventmachine (1.0.0)
@@ -57,35 +58,35 @@ GEM
     haml (3.1.7)
     i18n (0.6.1)
     inflection (1.0.0)
-    json (1.7.5)
+    json (1.7.6)
     mime-types (1.19)
-    mongoid (3.0.11)
+    mongoid (3.0.16)
       activemodel (~> 3.1)
       moped (~> 1.1)
       origin (~> 1.0)
       tzinfo (~> 0.3.22)
-    moped (1.2.8)
-    multi_json (1.3.7)
-    origin (1.0.10)
-    rack (1.4.1)
-    rack-protection (1.2.0)
+    moped (1.3.2)
+    multi_json (1.5.0)
+    origin (1.0.11)
+    rack (1.4.3)
+    rack-protection (1.3.2)
       rack
-    rack-ssl-enforcer (0.2.4)
+    rack-ssl-enforcer (0.2.5)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (0.9.2.2)
+    rake (10.0.3)
     redcarpet (2.2.2)
     ripl (0.7.0)
       bond (~> 0.4.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sass (3.2.2)
+    rspec-mocks (2.12.1)
+    sass (3.2.5)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
@@ -103,7 +104,7 @@ GEM
       tilt (~> 1.3)
     tilt (1.3.3)
     tzinfo (0.3.35)
-    vcr (2.3.0)
+    vcr (2.4.0)
     webmock (1.9.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)

data/lib/zendesk_api/rescue.rb

@@ -17,6 +17,19 @@ module ZendeskAPI
         end
       end
 
+      def attach_error(e)
+        return unless e.response
+
+        if error = e.response[:body]
+          if error.is_a?(Hash)
+            error = Hashie::Mash.new(error)
+            self.error_message = (error.error || error.description) if respond_to?("error_message=")
+          end
+
+          self.error = error if respond_to?("error=")
+        end
+      end
+
       def rescue_client_error(*args)
         opts = args.last.is_a?(Hash) ? args.pop : {}
 
@@ -28,6 +41,7 @@ module ZendeskAPI
                 send("orig_#{method}", *args)
               rescue Faraday::Error::ClientError => e
                 log_error(e, method)
+                attach_error(e)
                 opts[:with].respond_to?(:call) ? opts[:with].call : opts[:with]
               end
             end
@@ -37,6 +51,7 @@ module ZendeskAPI
             yield
           rescue Faraday::Error::ClientError => e
             log_error(e)
+            attach_error(e)
             opts[:with].respond_to?(:call) ? opts[:with].call : opts[:with]
           end
         end

data/lib/zendesk_api/resource.rb

@@ -125,6 +125,7 @@ module ZendeskAPI
 
   # Indexable resource
   class DataResource < Data
+    attr_accessor :error, :error_message
     extend Verbs
   end
 

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

@@ -70,4 +70,73 @@ Status: 201 Created
     ]
   }
 }
+```
+
+### Deleting Uploads
+`DELETE /api/v2/uploads/{token}.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+ curl -u username:password -X DELETE https://helpdesk.zendesk.com/api/v2/uploads/{token}.json
+```
+
+#### Example Response
+
+```http
+200 OK
+```
+
+### Getting Attachments
+`GET /api/v2/attachments/{id}.json`
+
+#### Allowed For
+
+ * Admins
+
+#### Using curl
+
+```bash
+ curl -u username:password https://helpdesk.zendesk.com/api/v2/attachments/{id}.json
+```
+
+#### Example Response
+
+```http
+{
+  "attachment": {
+    "id":           498483,
+    "name":         "crash.log",
+    "content_url":  "https://company.zendesk.com/attachments/crash.log",
+    "content_type": "text/plain",
+    "size":         2532,
+    "thumbnails":   [],
+    "url":          "https://company.zendesk.com/api/v2/attachments/498483.json",
+  }
+}
+```
+
+### Deleting Attachments
+`DELETE /api/v2/attachments/{id}.json`
+
+Currently, only attachments on forum posts are allowed to be deleted.
+
+#### Allowed For
+
+ * Admins
+
+#### Using curl
+
+```bash
+ curl -u username:password -X DELETE https://helpdesk.zendesk.com/api/v2/attachments/{id}.json
+```
+
+#### Example Response
+
+```http
+200 OK
 ```

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

@@ -0,0 +1,211 @@
+## Changes Roadmap
+
+As part of our [change policy](introduction.html#change-policy), we provide this roadmap of API changes to help developers plan for required changes to their integrations with Zendesk. Please also subscribe to our [API updates forum](https://support.zendesk.com/forums/20635666-api-changes) for announcements and changes to this roadmap.
+
+### December 6, 2012
+
+The following changes will go into effect on December 6, 2012:
+
+#### Proper handling of requester and submitter for Ticket creation
+
+##### Affected endpoints
+
+``POST /api/v2/tickets.json``
+
+##### What's changing
+
+Our API is commonly used to create ticket submission forms on company websites. However, companies want to be able to set internally-facing fields on the ticket (such as tags), which requires agent authentication, while making the ticket appear as created by the customer. Today, any ticket created via the API inaccurately shows "via (Agent Name)" on the ticket UI.
+
+This will change to only allow two valid states for a ticket's first comment author:
+
+* Created by the requester, where the first comment author is the requester.
+* Created by the requester via an agent, where the first comment author is an agent.
+
+##### Example
+
+The below will create a ticket where the requester is the first comment author:
+
+```
+{
+  "ticket": {
+    "comment": {
+      "value": "This is the ticket description"
+    },
+    "requester": {
+      "name": "Customer",
+      "email": "customer@domain.com"
+    }
+  }
+}
+```
+
+The below will create a ticket where the agent designated as the submitter is the first comment author, and the ticket is shown as created by the requester, via the agent.
+
+```
+{
+  "ticket": {
+    "comment": {
+      "value": "This is the ticket description"
+    },
+    "requester": {
+      "name": "Customer",
+      "email": "customer@domain.com"
+    },
+    "submitter_id": 7
+  }
+}
+```
+
+
+### February 7, 2013
+
+The following changes will go into effect on February 7, 2013:
+
+#### Removal of ``fields`` key in favor of ``custom_fields`` for Tickets, Requests and Macros
+
+##### Affected endpoints
+
+* ``GET /api/v2/tickets/{id}.json``
+* ``GET /api/v2/requests/{id}.json``
+* ``GET /api/v2/macros/{id}/apply.json``
+
+##### Deprecation
+
+On November 8, 2012, in the above endpoints, ``custom_fields`` were added and ``fields`` were deprecated.
+
+##### What's changing
+
+To improve naming consistencies in our API, we are renaming ``fields`` to ``custom_fields`` in the above endpoints.
+
+##### Example
+
+```
+{
+  "ticket": {
+    "id": 123,
+    "fields": [
+      {
+        "id": 456,
+        "value": "value_1"
+      },
+      {
+        "id":457,
+        "value": "value_2"
+      }
+    ]
+  }
+}
+```
+
+will be changed to
+
+```
+{
+  "ticket": {
+    "id": 123,
+    "custom_fields": [
+      {
+        "id": 456,
+        "value": "value_1"
+      },
+      {
+        "id":457,
+        "value": "value_2"
+      }
+    ]
+  }
+}
+```
+
+#### Removal of ``fields``, ``custom_fields``, ``group_by``, ``group_order``, ``sort_order``, ``sort_by`` in favor of ``columns``, ``group`` and ``sort`` for Views
+
+##### Affected endpoints
+
+* ``GET /api/v2/views/{id}.json``
+
+##### Deprecation
+
+On November 13, 2012, in the above endpoint, ``columns``, ``group`` and ``sort`` were added and ``fields``, ``custom_fields``, ``group_by``, ``group_order``, ``sort_order``, ``sort_by`` were deprecated.
+
+##### What's changing
+
+To improve usability of this API, with respect to rendering view columns, we now expose a ``columns`` attribute in Views which expresses the order, header title and ID of each column in the View which corresponds to data presented in each row of the View.
+
+Furthermore, we have consolidated the grouping and sorting definitions of each View into the ``group`` and ``sort`` attributes.
+
+##### Example
+
+```
+{
+  "view": {
+    "id": 2568,
+    "title": My working tickets",
+    ...
+    "execution": {
+      "group_by": "status",
+      "group_order": "asc",
+      "sort_by": "updated",
+      "sort_order": "desc",
+      "fields": [
+        {
+          "id": "nice_id",
+          "title": "ID"
+        },
+        {
+          "id": "type",
+          "title": "Type"
+        }
+        ...
+      ],
+      "custom_fields": [
+        {
+          "id": 336767,
+          "title": "About"
+    	}
+      ]
+    }
+    ...
+  }
+}
+```
+
+will be changed to
+
+```
+{
+  "view": {
+    "id": 2568,
+    "title": My working tickets",
+    ...
+    "execution": {
+      "group": {
+        "id": "status",
+        "title": "Status",
+        "order": "asc"
+      },
+      "sort": {
+        "id": "updated",
+        "title": "Updated",
+        "order": "desc"
+      },
+      "columns": [
+        {
+          "id": "id",
+          "title": "ID"
+        },
+        {
+          "id": "type",
+          "title": "Type"
+        },
+        {
+          "id": 336767,
+          "title": "About",
+          "type": "tagger"
+        }
+        ...
+      ],
+    }
+    ...
+  }
+}
+```

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

@@ -119,6 +119,42 @@ curl https://{subdomain}.zendesk.com/api/v2/satisfaction_ratings/{id}.json \
 ```http
 Status: 200 OK
 
+{
+  "satisfaction_rating": {
+    "id":              35436,
+    "url":             "https://company.zendesk.com/api/v2/satisfaction_ratings/35436.json",
+    "assignee_id":     135,
+    "group_id":        44,
+    "requester_id":    7881,
+    "ticket_id":       208,
+    "score":           "good",
+    "updated_at":      "2011-07-20T22:55:29Z",
+    "created_at":      "2011-07-20T22:55:29Z",
+    "comment":         { ... }
+  }
+}
+```
+
+### Create a Satisfaction Rating
+`POST /api/v2/tickets/{ticket_id}/satisfaction_rating.json`
+
+#### Allowed For:
+
+ * Requester of the ticket
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/tickets/{ticket_id}/satisfaction_rating.json \
+  -X POST -d '{"satisfaction_rating": {"score": "good", "comment": "Awesome support."}}' \
+  -v -u {email_address}:{password} -H "Content-Type: application/json"
+```
+
+#### Example Response
+
+```http
+Status: 200 OK
+
 {
   "satisfaction_rating": {
     "id":              35436,

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

@@ -316,6 +316,12 @@ Voice Comments have the following keys:
 | public          | boolean | yes       | If true, the ticket requester can see this comment
 | formatted_from  | string  | yes       | A formatted version of the phone number which dialed the call
 | formatted_to    | string  | yes       | A formatted version of the phone number which answered the call
+| body            | string  | yes       | The actual comment made by the author
+| html_body       | string  | yes       | The actual comment made by the author formatted to HTML
+| public          | boolean | yes       | If this is a public comment or an internal agents only note
+| trusted         | boolean | yes       | If this comment is trusted or marked as being potentially fraudulent
+| author_id       | integer | yes       | The id of the author of this comment
+| attachments     | array   | yes       | The attachments on this comment as [Attachment](attachments.md) objects
 
 #### Example
 ```js
@@ -342,6 +348,10 @@ Voice Comments have the following keys:
   "formatted_to":          "+1 (123) 325-7890",
   "transcription_visible": true,
   "public":                true,
+  "author_id":             1,
+  "body":                  "Request #219 "request" was closed and merged into this request.",
+  "html_body":             "<p>Request <a target="_blank" href="/tickets/219">#219</a> &quot;aa&quot; was closed and merged into this request.</p>",
+  "trusted":               true,
   "attachments":           []
 }
 ```
@@ -373,12 +383,14 @@ Each property that is set on a newly created Ticket is tracked with a Create eve
 
 Create events have the following keys:
 
-| Name       | Type    | Read-only | Comment
-| ---------- | ------- | --------- | -------
-| id         | integer | yes       | Automatically assigned when creating events
-| type       | string  | yes       | Has the value `Create`
-| field_name | string  | yes       | The name of the field that was set
-| value      | string  | yes       | The value of the field that was set
+| Name       | Type            | Read-only | Comment
+| ---------- | --------------- | --------- | -------
+| id         | integer         | yes       | Automatically assigned when creating events
+| type       | string          | yes       | Has the value `Create`
+| field_name | string          | yes       | The name of the field that was set
+| value      | string / array  | yes       | The value of the field that was set
+
+`value` will always be a string, except when when the `field_name` is `tags`
 
 #### Example
 ```js
@@ -395,13 +407,15 @@ When a ticket is updated, Change events track the previous and newly updated val
 
 Change events have the following keys:
 
-| Name           | Type    | Read-only | Comment
-| -------------- | ------- | --------- | -------
-| id             | integer | yes       | Automatically assigned when creating events
-| type           | string  | yes       | Has the value `Change`
-| field_name     | string  | yes       | The name of the field that was changed
-| value          | string  | yes       | The value of the field that was changed
-| previous_value | string  | yes       | The previous value of the field that was changed
+| Name           | Type            | Read-only | Comment
+| -------------- | --------------- | --------- | -------
+| id             | integer         | yes       | Automatically assigned when creating events
+| type           | string          | yes       | Has the value `Change`
+| field_name     | string          | yes       | The name of the field that was changed
+| value          | string / array  | yes       | The value of the field that was changed
+| previous_value | string / array  | yes       | The previous value of the field that was changed
+
+`value` and `previous_value` will always be strings, except when when the `field_name` is `tags`
 
 #### Example
 ```js

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

@@ -408,4 +408,48 @@ Status: 200
     ...
   }
 }
+```
+
+### Set a User's Password
+
+`POST /api/v2/users/{user_id}/password.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/password.json \
+  -X POST -d '{"password": "newpassword"}' \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200
+```
+
+### Change a User's Password
+
+`PUT /api/v2/users/{user_id}/password.json`
+
+#### Allowed For
+
+ * Agents
+
+#### Using curl
+
+```bash
+curl https://{subdomain}.zendesk.com/api/v2/users/{user_id}/password.json \
+  -X POST -d '{"previous_password": "oldpassword", "password": "newpassword"}' \
+  -v -u {email_address}:{password}
+```
+
+#### Example Response
+
+```http
+Status: 200
 ```

data/lib/zendesk_api/version.rb

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

data/spec/core/rescue_spec.rb

@@ -12,7 +12,11 @@ describe ZendeskAPI::Rescue do
     end
 
     def puff(error)
-      raise error, "Puff"
+      if error.is_a?(Class)
+        raise error, "Puff"
+      else
+        raise error
+      end
     end
 
     def boom(error)
@@ -56,6 +60,25 @@ describe ZendeskAPI::Rescue do
     Boom.new(client).puff(Faraday::Error::ClientError)
   end
 
+  context "when class has error attributes", :silence_logger do
+    let(:response) {{ :body => { :error => { :description => "hello" } } }}
+    let(:instance) { Boom.new(client) }
+
+    before do
+      Boom.send(:attr_accessor, :error, :error_message)
+
+      exception = Exception.new("message")
+      exception.set_backtrace([])
+
+      error = Faraday::Error::ClientError.new(exception, response)
+      instance.puff(error)
+    end
+
+    it "should attach the error" do
+      instance.error.should_not be_nil
+    end
+  end
+
   context "passing a block" do
     it "rescues from client errors", :silence_logger do
       rescue_client_error do

data/spec/core/spec_helper.rb

@@ -105,7 +105,6 @@ RSpec.configure do |c|
     end
   end
 
-  c.extend VCR::RSpec::Macros
   c.extend ResourceMacros
   c.extend ZendeskAPI::Fixtures
   c.include ZendeskAPI::Fixtures
@@ -116,6 +115,7 @@ VCR.configure do |c|
   c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'cassettes')
   c.default_cassette_options = { :record => :new_episodes, :decode_compressed_response => true, :serialize_with => :json, :preserve_exact_body_bytes => true }
   c.hook_into :webmock
+  c.configure_rspec_metadata!
 end
 
 include WebMock::API

data/spec/live/collection_spec.rb

@@ -17,9 +17,7 @@ describe ZendeskAPI::Collection do
       end
     end
 
-    context "pagination with no options" do
-      use_vcr_cassette
-
+    context "pagination with no options", :vcr do
       before(:each) { subject.per_page(nil).page(nil) }
 
       it "should find the next page by calling fetch" do
@@ -39,9 +37,7 @@ describe ZendeskAPI::Collection do
       end
     end
 
-    context "pagination with options" do
-      use_vcr_cassette
-
+    context "pagination with options", :vcr do
       before(:each) { subject.per_page(1).page(2) }
 
       it "should increase page option and not call fetch" do

data/spec/live/locale_spec.rb

@@ -1,8 +1,6 @@
 require 'core/spec_helper'
 
-describe ZendeskAPI::Locale do
-  use_vcr_cassette
-
+describe ZendeskAPI::Locale, :vcr do
   specify "client#current_locale" do
     client.current_locale.should be_instance_of(described_class)
   end

data/spec/live/ticket_spec.rb

@@ -120,7 +120,7 @@ describe ZendeskAPI::Ticket do
           thread[:response][:status]
         end
 
-        threads.all? {|st| [201, 422].include?(st)}.should be_true
+        threads.all? {|st| [201, 422, 409].include?(st)}.should be_true
       end
     end
   end

data/spec/macros/resource_macros.rb

@@ -7,8 +7,7 @@ module ResourceMacros
   end
 
   def it_should_be_creatable(options={})
-    context "creation" do
-      use_vcr_cassette
+    context "creation", :vcr do
       subject { described_class }
 
       before(:all) do
@@ -37,9 +36,7 @@ module ResourceMacros
   end
 
   def it_should_be_updatable(attribute, value = "TESTDATA")
-    context "update" do
-      use_vcr_cassette
-
+    context "update", :vcr do
       before(:all) do
         VCR.use_cassette("#{described_class.to_s}_update_create") do
           @object = described_class.create(client, valid_attributes.merge(default_options))
@@ -79,9 +76,7 @@ module ResourceMacros
   end
 
   def it_should_be_deletable(options = {})
-    context "deletion" do
-      use_vcr_cassette
-
+    context "deletion", :vcr do
       before(:all) do
         if options[:object]
           @object = options.delete(:object)
@@ -117,9 +112,7 @@ module ResourceMacros
     klass = args.first.is_a?(ZendeskAPI::DataResource) ? args.shift : client
     context_name = "read_#{klass.class}_#{args.join("_")}"
 
-    context context_name do
-      use_vcr_cassette
-
+    context context_name, :vcr do
       before(:all) do
         VCR.use_cassette("#{described_class.to_s}_#{context_name}_create") do
           @object = described_class.create!(client, valid_attributes.merge(default_options))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zendesk_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-14 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -272,6 +272,7 @@ files:
 - 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/changes_roadmap.md
 - lib/zendesk_api/server/docs/custom_roles.md
 - lib/zendesk_api/server/docs/forum_subscriptions.md
 - lib/zendesk_api/server/docs/forums.md