zendesk2 0.4.4 → 0.4.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -0
  3. data/lib/zendesk2/client/models/categories.rb +1 -1
  4. data/lib/zendesk2/client/models/forums.rb +1 -1
  5. data/lib/zendesk2/client/models/groups.rb +1 -1
  6. data/lib/zendesk2/client/models/membership.rb +1 -1
  7. data/lib/zendesk2/client/models/organization.rb +2 -0
  8. data/lib/zendesk2/client/models/organizations.rb +1 -1
  9. data/lib/zendesk2/client/models/ticket_audits.rb +1 -1
  10. data/lib/zendesk2/client/models/ticket_comments.rb +1 -1
  11. data/lib/zendesk2/client/models/ticket_metrics.rb +1 -1
  12. data/lib/zendesk2/client/models/tickets.rb +1 -1
  13. data/lib/zendesk2/client/models/topic_comments.rb +1 -1
  14. data/lib/zendesk2/client/models/topics.rb +1 -1
  15. data/lib/zendesk2/client/models/user_field.rb +59 -0
  16. data/lib/zendesk2/client/models/user_fields.rb +11 -0
  17. data/lib/zendesk2/client/models/user_identity.rb +1 -1
  18. data/lib/zendesk2/client/models/users.rb +1 -1
  19. data/lib/zendesk2/client/requests/create_membership.rb +10 -0
  20. data/lib/zendesk2/client/requests/create_user.rb +2 -12
  21. data/lib/zendesk2/client/requests/create_user_field.rb +44 -0
  22. data/lib/zendesk2/client/requests/destroy_user.rb +1 -0
  23. data/lib/zendesk2/client/requests/destroy_user_field.rb +27 -0
  24. data/lib/zendesk2/client/requests/get_category.rb +7 -14
  25. data/lib/zendesk2/client/requests/get_group.rb +6 -14
  26. data/lib/zendesk2/client/requests/get_membership.rb +6 -14
  27. data/lib/zendesk2/client/requests/get_organization.rb +7 -14
  28. data/lib/zendesk2/client/requests/get_organization_memberships.rb +1 -1
  29. data/lib/zendesk2/client/requests/get_ticket.rb +6 -14
  30. data/lib/zendesk2/client/requests/get_ticket_audit.rb +7 -18
  31. data/lib/zendesk2/client/requests/get_ticket_field.rb +6 -15
  32. data/lib/zendesk2/client/requests/get_ticket_fields.rb +1 -1
  33. data/lib/zendesk2/client/requests/get_ticket_metric.rb +6 -17
  34. data/lib/zendesk2/client/requests/get_topic_comment.rb +3 -6
  35. data/lib/zendesk2/client/requests/get_topic_comments.rb +1 -1
  36. data/lib/zendesk2/client/requests/get_user.rb +9 -13
  37. data/lib/zendesk2/client/requests/get_user_field.rb +25 -0
  38. data/lib/zendesk2/client/requests/get_user_fields.rb +18 -0
  39. data/lib/zendesk2/client/requests/get_user_identity.rb +6 -15
  40. data/lib/zendesk2/client/requests/get_user_memberships.rb +1 -1
  41. data/lib/zendesk2/client/requests/mark_membership_default.rb +2 -6
  42. data/lib/zendesk2/client/requests/mark_user_identity_primary.rb +3 -6
  43. data/lib/zendesk2/client/requests/update_group.rb +8 -14
  44. data/lib/zendesk2/client/requests/update_topic_comment.rb +2 -2
  45. data/lib/zendesk2/client/requests/update_user_field.rb +28 -0
  46. data/lib/zendesk2/client.rb +79 -15
  47. data/lib/zendesk2/collection.rb +1 -18
  48. data/lib/zendesk2/paged_collection.rb +100 -0
  49. data/lib/zendesk2/version.rb +1 -1
  50. data/lib/zendesk2.rb +9 -7
  51. data/spec/categories_spec.rb +6 -4
  52. data/spec/forums_spec.rb +7 -4
  53. data/spec/groups_spec.rb +6 -3
  54. data/spec/memberships_spec.rb +31 -5
  55. data/spec/organizations_spec.rb +6 -3
  56. data/spec/shared/zendesk_resource.rb +66 -48
  57. data/spec/ticket_fields_spec.rb +6 -3
  58. data/spec/tickets_spec.rb +6 -3
  59. data/spec/topic_comments_spec.rb +6 -5
  60. data/spec/topics_spec.rb +7 -5
  61. data/spec/user_fields_spec.rb +12 -0
  62. data/spec/user_identities_spec.rb +7 -7
  63. data/spec/users_spec.rb +7 -4
  64. metadata +12 -6
  65. data/spec/config_spec.rb +0 -17
  66. data/spec/shared/resource.rb +0 -66
@@ -5,11 +5,12 @@ describe "topic_comments" do
5
5
  let!(:user) { client.users.create!(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
6
6
  let!(:forum) { client.forums.create!(name: Zendesk2.uuid) }
7
7
  let!(:topic) { client.topics.create!(title: Zendesk2.uuid, body: Zendesk2.uuid, forum: forum) }
8
- it_should_behave_like "a resource", :topic_comments,
9
- lambda { {body: Zendesk2.uuid, topic_id: topic.identity, user_id: user.identity} },
10
- lambda { {body: Zendesk2.uuid} },
8
+
9
+ include_examples "zendesk resource",
11
10
  {
12
- :fetch_params => lambda {|tc| {"topic_id" => tc.topic_id, "id" => tc.identity}},
13
- :collection => lambda { client.topic_comments(topic_id: topic.identity) },
11
+ :create_params => lambda { {body: Zendesk2.uuid, topic_id: topic.identity, user_id: user.identity} },
12
+ :update_params => lambda { {body: Zendesk2.uuid} },
13
+ :fetch_params => lambda { |tc| {"topic_id" => tc.topic_id, "id" => tc.identity} },
14
+ :collection => lambda { client.topic_comments(topic_id: topic.identity) },
14
15
  }
15
16
  end
data/spec/topics_spec.rb CHANGED
@@ -2,9 +2,11 @@ require 'spec_helper'
2
2
 
3
3
  describe "topics" do
4
4
  let(:client) { create_client }
5
- let(:forum) { client.forums.create(name: Zendesk2.uuid) }
6
- it_should_behave_like "a resource",
7
- :topics,
8
- lambda { {title: Zendesk2.uuid, body: Zendesk2.uuid, forum_id: forum.id} },
9
- lambda { {title: Zendesk2.uuid, body: Zendesk2.uuid} }
5
+ let(:forum) { client.forums.create(name: Zendesk2.uuid) }
6
+
7
+ include_examples "zendesk resource", {
8
+ :collection => lambda { client.topics },
9
+ :create_params => lambda { { title: Zendesk2.uuid, body: Zendesk2.uuid, forum_id: forum.id } },
10
+ :update_params => lambda { { title: Zendesk2.uuid, body: Zendesk2.uuid } },
11
+ }
10
12
  end
@@ -0,0 +1,12 @@
1
+ require 'spec_helper'
2
+
3
+ describe "user_fields" do
4
+ let(:client) { create_client }
5
+
6
+ include_examples "zendesk resource", {
7
+ :collection => lambda { client.user_fields },
8
+ :create_params => lambda { { title: Zendesk2.uuid, type: "text", key: "custom_#{SecureRandom.hex(3)}"} },
9
+ :update_params => lambda { { title: Zendesk2.uuid } },
10
+ :paged => false,
11
+ }
12
+ end
@@ -3,12 +3,12 @@ require 'spec_helper'
3
3
  describe "user_identities" do
4
4
  let(:client) { create_client }
5
5
  let(:user) { client.users.create(email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true) }
6
- it_should_behave_like "a resource",
7
- :identities,
8
- lambda { {value: "ey+#{Zendesk2.uuid}@example.org", type: "email", user_id: user.id} },
9
- lambda { {verified: true} },
10
- {
11
- :fetch_params => lambda {|uc| {"user_id" => uc.user_id, "id" => uc.id}},
12
- :collection => lambda { client.user_identities(user_id: user.id) },
6
+
7
+ include_examples "zendesk resource", {
8
+ :create_params => lambda { { value: "ey+#{Zendesk2.uuid}@example.org", type: "email", user_id: user.id } },
9
+ :update_params => lambda { { verified: true } },
10
+ :fetch_params => lambda { |uc| { "user_id" => uc.user_id, "id" => uc.id } },
11
+ :collection => lambda { client.user_identities(user_id: user.id) },
12
+ :paged => false,
13
13
  }
14
14
  end
data/spec/users_spec.rb CHANGED
@@ -2,9 +2,12 @@ require 'spec_helper'
2
2
 
3
3
  describe "users" do
4
4
  let(:client) { create_client }
5
- it_should_behave_like "a resource", :users,
6
- lambda { {email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true} },
7
- lambda { {name: Zendesk2.uuid} }
5
+
6
+ include_examples "zendesk resource", {
7
+ :collection => lambda { client.users },
8
+ :create_params => lambda { { email: "zendesk2+#{Zendesk2.uuid}@example.org", name: Zendesk2.uuid, verified: true } },
9
+ :update_params => lambda { { name: Zendesk2.uuid } },
10
+ }
8
11
 
9
12
  it "should get current user" do
10
13
  current_user = client.users.current
@@ -38,7 +41,7 @@ describe "users" do
38
41
  end
39
42
 
40
43
  it "cannot destroy a user with a ticket" do
41
- ticket = client.tickets.create(requester: user, subject: Zendesk2.uuid, description: Zendesk2.uuid)
44
+ client.tickets.create(requester: user, subject: Zendesk2.uuid, description: Zendesk2.uuid)
42
45
 
43
46
  user.destroy.should be_false
44
47
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: zendesk2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.4
4
+ version: 0.4.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Josh Lane
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-03-05 00:00:00.000000000 Z
11
+ date: 2014-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: addressable
@@ -130,6 +130,8 @@ files:
130
130
  - lib/zendesk2/client/models/topic_comments.rb
131
131
  - lib/zendesk2/client/models/topics.rb
132
132
  - lib/zendesk2/client/models/user.rb
133
+ - lib/zendesk2/client/models/user_field.rb
134
+ - lib/zendesk2/client/models/user_fields.rb
133
135
  - lib/zendesk2/client/models/user_identities.rb
134
136
  - lib/zendesk2/client/models/user_identity.rb
135
137
  - lib/zendesk2/client/models/users.rb
@@ -143,6 +145,7 @@ files:
143
145
  - lib/zendesk2/client/requests/create_topic.rb
144
146
  - lib/zendesk2/client/requests/create_topic_comment.rb
145
147
  - lib/zendesk2/client/requests/create_user.rb
148
+ - lib/zendesk2/client/requests/create_user_field.rb
146
149
  - lib/zendesk2/client/requests/create_user_identity.rb
147
150
  - lib/zendesk2/client/requests/destroy_category.rb
148
151
  - lib/zendesk2/client/requests/destroy_forum.rb
@@ -154,6 +157,7 @@ files:
154
157
  - lib/zendesk2/client/requests/destroy_topic.rb
155
158
  - lib/zendesk2/client/requests/destroy_topic_comment.rb
156
159
  - lib/zendesk2/client/requests/destroy_user.rb
160
+ - lib/zendesk2/client/requests/destroy_user_field.rb
157
161
  - lib/zendesk2/client/requests/destroy_user_identity.rb
158
162
  - lib/zendesk2/client/requests/get_assignable_groups.rb
159
163
  - lib/zendesk2/client/requests/get_audits.rb
@@ -187,6 +191,8 @@ files:
187
191
  - lib/zendesk2/client/requests/get_topic_comments.rb
188
192
  - lib/zendesk2/client/requests/get_topics.rb
189
193
  - lib/zendesk2/client/requests/get_user.rb
194
+ - lib/zendesk2/client/requests/get_user_field.rb
195
+ - lib/zendesk2/client/requests/get_user_fields.rb
190
196
  - lib/zendesk2/client/requests/get_user_identities.rb
191
197
  - lib/zendesk2/client/requests/get_user_identity.rb
192
198
  - lib/zendesk2/client/requests/get_user_memberships.rb
@@ -205,20 +211,20 @@ files:
205
211
  - lib/zendesk2/client/requests/update_topic.rb
206
212
  - lib/zendesk2/client/requests/update_topic_comment.rb
207
213
  - lib/zendesk2/client/requests/update_user.rb
214
+ - lib/zendesk2/client/requests/update_user_field.rb
208
215
  - lib/zendesk2/client/requests/update_user_identity.rb
209
216
  - lib/zendesk2/collection.rb
210
217
  - lib/zendesk2/error.rb
211
218
  - lib/zendesk2/logger.rb
212
219
  - lib/zendesk2/model.rb
220
+ - lib/zendesk2/paged_collection.rb
213
221
  - lib/zendesk2/searchable.rb
214
222
  - lib/zendesk2/version.rb
215
223
  - spec/categories_spec.rb
216
- - spec/config_spec.rb
217
224
  - spec/forums_spec.rb
218
225
  - spec/groups_spec.rb
219
226
  - spec/memberships_spec.rb
220
227
  - spec/organizations_spec.rb
221
- - spec/shared/resource.rb
222
228
  - spec/shared/zendesk_resource.rb
223
229
  - spec/spec_helper.rb
224
230
  - spec/support/client_helper.rb
@@ -226,6 +232,7 @@ files:
226
232
  - spec/tickets_spec.rb
227
233
  - spec/topic_comments_spec.rb
228
234
  - spec/topics_spec.rb
235
+ - spec/user_fields_spec.rb
229
236
  - spec/user_identities_spec.rb
230
237
  - spec/users_spec.rb
231
238
  - zendesk2.gemspec
@@ -255,12 +262,10 @@ specification_version: 4
255
262
  summary: Zendesk V2 API client
256
263
  test_files:
257
264
  - spec/categories_spec.rb
258
- - spec/config_spec.rb
259
265
  - spec/forums_spec.rb
260
266
  - spec/groups_spec.rb
261
267
  - spec/memberships_spec.rb
262
268
  - spec/organizations_spec.rb
263
- - spec/shared/resource.rb
264
269
  - spec/shared/zendesk_resource.rb
265
270
  - spec/spec_helper.rb
266
271
  - spec/support/client_helper.rb
@@ -268,5 +273,6 @@ test_files:
268
273
  - spec/tickets_spec.rb
269
274
  - spec/topic_comments_spec.rb
270
275
  - spec/topics_spec.rb
276
+ - spec/user_fields_spec.rb
271
277
  - spec/user_identities_spec.rb
272
278
  - spec/users_spec.rb
data/spec/config_spec.rb DELETED
@@ -1,17 +0,0 @@
1
- require 'spec_helper'
2
-
3
- describe "client" do
4
-
5
- it "can be configured" do
6
- client = Zendesk2::Client.new(:url => "https://myzen.zendesk.com",
7
- :username => "person@place.com",
8
- :password => "wickedsecure",
9
- :token => "12345678901234567890",
10
- :jwt_token => "234823472398472938423234")
11
- client.url.should eq "https://myzen.zendesk.com"
12
- client.username.should eq "person@place.com"
13
- client.token.should eq "12345678901234567890"
14
- client.jwt_token.should eq "234823472398472938423234"
15
- end
16
-
17
- end
@@ -1,66 +0,0 @@
1
- shared_examples "a resource" do |_collection, _params, _update_params, _options={}|
2
- let(:options) { _options || {} }
3
- let(:collection) { options[:collection] ? instance_exec(&options[:collection]) : client.send(_collection) }
4
- let(:params) { instance_exec(&_params) || {} }
5
- let(:update_params) { instance_exec(&_update_params) }
6
- let(:fetch_params) { options[:fetch_params] || lambda {|r| r.identity} }
7
-
8
- it "by creating a record" do
9
- record = collection.create!(params)
10
- record.identity.should_not be_nil
11
- end
12
-
13
- it "by fetching a specific record" do
14
- record = collection.create!(params)
15
- collection.get!(fetch_params.call(record)).should == record
16
- end
17
-
18
- if _options.fetch(:paged, true)
19
- context "that is paged" do
20
- before(:each) do
21
- 3.times.each { collection.create!(instance_exec(&_params)) }
22
- end
23
-
24
- it "by retrieving the first page" do
25
- collection.all("per_page" => "1").size.should == 1
26
- end
27
-
28
- it "by retrieving the next page" do
29
- first_page = collection.all("per_page" => 1)
30
- second_page = collection.all("per_page" => 1).next_page
31
- second_page.should_not == first_page
32
- end
33
-
34
- it "by retrieving the previous page" do
35
- first_page = collection.all("per_page" => "1")
36
- previous_to_second_page = collection.all("per_page" => 1).next_page.previous_page
37
- previous_to_second_page.should == first_page
38
- end
39
- end
40
- end
41
-
42
- if _options.fetch(:update, true)
43
- it "by updating a record" do
44
- record = collection.create!(params)
45
- record.merge_attributes(update_params)
46
- record.save
47
- update_params.each {|k,v| record.send(k).should == v}
48
- end
49
- end
50
-
51
- it "by destroying a record" do
52
- pending if _collection == :forums
53
- record = collection.create!(params)
54
- record.identity.should_not be_nil
55
- record.destroy
56
- record.should be_destroyed
57
- end
58
-
59
- # Search index takes 2-3 minutes according to the docs
60
- it "should search" do
61
- pending unless Zendesk2::Client.mocking?
62
- pending unless collection.is_a?(Zendesk2::Searchable)
63
- record = collection.create!(params)
64
- collection.search(params).should include(record)
65
- end
66
- end