desk 0.3.3 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +7 -0
  2. data/README.mkd +305 -106
  3. data/TRANSITION.mkd +133 -0
  4. data/desk.gemspec +1 -1
  5. data/lib/desk.rb +1 -1
  6. data/lib/desk/api.rb +5 -1
  7. data/lib/desk/client.rb +184 -10
  8. data/lib/desk/client/article.rb +4 -83
  9. data/lib/desk/client/brand.rb +11 -0
  10. data/lib/desk/client/case.rb +59 -42
  11. data/lib/desk/client/company.rb +11 -0
  12. data/lib/desk/client/custom_field.rb +10 -0
  13. data/lib/desk/client/customer.rb +26 -124
  14. data/lib/desk/client/facebook_user.rb +11 -0
  15. data/lib/desk/client/filter.rb +11 -0
  16. data/lib/desk/client/group.rb +3 -29
  17. data/lib/desk/client/insight.rb +17 -0
  18. data/lib/desk/client/integration_url.rb +11 -0
  19. data/lib/desk/client/job.rb +11 -0
  20. data/lib/desk/client/label.rb +11 -0
  21. data/lib/desk/client/macro.rb +3 -133
  22. data/lib/desk/client/mailbox.rb +26 -0
  23. data/lib/desk/client/rule.rb +14 -0
  24. data/lib/desk/client/site_setting.rb +11 -0
  25. data/lib/desk/client/system_message.rb +16 -0
  26. data/lib/desk/client/topic.rb +4 -81
  27. data/lib/desk/client/twitter_account.rb +11 -0
  28. data/lib/desk/client/twitter_user.rb +11 -0
  29. data/lib/desk/client/user.rb +3 -30
  30. data/lib/desk/configuration.rb +1 -1
  31. data/lib/desk/connection.rb +2 -1
  32. data/lib/desk/deash.rb +100 -0
  33. data/lib/desk/request.rb +33 -20
  34. data/lib/desk/version.rb +1 -1
  35. data/lib/faraday/request/oauth.rb +6 -3
  36. data/lib/faraday/response/deashify.rb +23 -0
  37. data/spec/desk/client/article_spec.rb +62 -117
  38. data/spec/desk/client/brand_spec.rb +18 -0
  39. data/spec/desk/client/case_spec.rb +182 -66
  40. data/spec/desk/client/companies_spec.rb +26 -0
  41. data/spec/desk/client/custom_fields_spec.rb +18 -0
  42. data/spec/desk/client/customer_spec.rb +16 -145
  43. data/spec/desk/client/facebook_users_spec.rb +17 -0
  44. data/spec/desk/client/filter_spec.rb +28 -0
  45. data/spec/desk/client/group_spec.rb +32 -49
  46. data/spec/desk/client/inbound_mailboxes_spec.rb +70 -0
  47. data/spec/desk/client/integration_url_spec.rb +28 -0
  48. data/spec/desk/client/job_spec.rb +32 -0
  49. data/spec/desk/client/label_spec.rb +31 -0
  50. data/spec/desk/client/macro_spec.rb +22 -185
  51. data/spec/desk/client/rule_spec.rb +18 -0
  52. data/spec/desk/client/site_setting_spec.rb +18 -0
  53. data/spec/desk/client/system_message_spec.rb +42 -0
  54. data/spec/desk/client/topic_spec.rb +31 -112
  55. data/spec/desk/client/twitter_account_spec.rb +32 -0
  56. data/spec/desk/client/twitter_user_spec.rb +27 -0
  57. data/spec/desk/client/user_spec.rb +19 -42
  58. data/spec/desk_spec.rb +2 -2
  59. data/spec/faraday/response_spec.rb +3 -6
  60. data/spec/fixtures/article +50 -0
  61. data/spec/fixtures/article_create +50 -0
  62. data/spec/fixtures/article_translation +29 -0
  63. data/spec/fixtures/article_translation_create +29 -0
  64. data/spec/fixtures/article_translation_update +29 -0
  65. data/spec/fixtures/article_translations +81 -0
  66. data/spec/fixtures/article_update +50 -0
  67. data/spec/fixtures/articles +123 -0
  68. data/spec/fixtures/articles_search +124 -0
  69. data/spec/fixtures/brand +11 -0
  70. data/spec/fixtures/brands +45 -0
  71. data/spec/fixtures/case +44 -0
  72. data/spec/fixtures/case_attachment +19 -0
  73. data/spec/fixtures/case_attachment_create +19 -0
  74. data/spec/fixtures/case_attachments +61 -0
  75. data/spec/fixtures/case_create +51 -0
  76. data/spec/fixtures/case_message +26 -0
  77. data/spec/fixtures/case_note +21 -0
  78. data/spec/fixtures/case_note_create +26 -0
  79. data/spec/fixtures/case_notes +65 -0
  80. data/spec/fixtures/case_replies +75 -0
  81. data/spec/fixtures/case_reply +26 -0
  82. data/spec/fixtures/case_reply_create +26 -0
  83. data/spec/fixtures/case_reply_update +26 -0
  84. data/spec/fixtures/case_update +49 -0
  85. data/spec/fixtures/cases +111 -0
  86. data/spec/fixtures/cases_search +113 -0
  87. data/spec/fixtures/companies +75 -0
  88. data/spec/fixtures/companies_search +76 -0
  89. data/spec/fixtures/company +26 -0
  90. data/spec/fixtures/company_create +26 -0
  91. data/spec/fixtures/company_search +76 -0
  92. data/spec/fixtures/company_update +27 -0
  93. data/spec/fixtures/custom_field +15 -0
  94. data/spec/fixtures/custom_fields +58 -0
  95. data/spec/fixtures/customer +60 -0
  96. data/spec/fixtures/customer_create +54 -0
  97. data/spec/fixtures/customer_update +60 -0
  98. data/spec/fixtures/customers +143 -0
  99. data/spec/fixtures/customers_search +143 -0
  100. data/spec/fixtures/facebook_user +16 -0
  101. data/spec/fixtures/facebook_users +55 -0
  102. data/spec/fixtures/filter +16 -0
  103. data/spec/fixtures/filter_cases +111 -0
  104. data/spec/fixtures/filters +55 -0
  105. data/spec/fixtures/group +9 -0
  106. data/spec/fixtures/group_filters +55 -0
  107. data/spec/fixtures/group_users +63 -0
  108. data/spec/fixtures/groups +42 -0
  109. data/spec/fixtures/inbound_mailbox +32 -0
  110. data/spec/fixtures/inbound_mailboxes +87 -0
  111. data/spec/fixtures/integration_url +15 -0
  112. data/spec/fixtures/integration_url_create +15 -0
  113. data/spec/fixtures/integration_url_update +15 -0
  114. data/spec/fixtures/integration_urls +54 -0
  115. data/spec/fixtures/job +17 -0
  116. data/spec/fixtures/job_create +17 -0
  117. data/spec/fixtures/jobs +57 -0
  118. data/spec/fixtures/label +17 -0
  119. data/spec/fixtures/label_create +17 -0
  120. data/spec/fixtures/label_update +17 -0
  121. data/spec/fixtures/labels +57 -0
  122. data/spec/fixtures/macro +20 -0
  123. data/spec/fixtures/macro_action +17 -0
  124. data/spec/fixtures/macro_action_update +17 -0
  125. data/spec/fixtures/macro_actions +57 -0
  126. data/spec/fixtures/macro_create +20 -0
  127. data/spec/fixtures/macro_update +20 -0
  128. data/spec/fixtures/macros +63 -0
  129. data/spec/fixtures/rule +13 -0
  130. data/spec/fixtures/rules +49 -0
  131. data/spec/fixtures/site_setting +10 -0
  132. data/spec/fixtures/site_settings +43 -0
  133. data/spec/fixtures/system_message +4 -0
  134. data/spec/fixtures/topic +23 -0
  135. data/spec/fixtures/topic_create +23 -0
  136. data/spec/fixtures/topic_translation +12 -0
  137. data/spec/fixtures/topic_translation_create +12 -0
  138. data/spec/fixtures/topic_translation_update +12 -0
  139. data/spec/fixtures/topic_translations +47 -0
  140. data/spec/fixtures/topic_update +23 -0
  141. data/spec/fixtures/topics +69 -0
  142. data/spec/fixtures/twitter_account +14 -0
  143. data/spec/fixtures/twitter_account_tweet +20 -0
  144. data/spec/fixtures/twitter_account_tweet_create +20 -0
  145. data/spec/fixtures/twitter_account_tweets +63 -0
  146. data/spec/fixtures/twitter_accounts +51 -0
  147. data/spec/fixtures/twitter_user +18 -0
  148. data/spec/fixtures/twitter_user_create +18 -0
  149. data/spec/fixtures/twitter_users +59 -0
  150. data/spec/fixtures/user +20 -0
  151. data/spec/fixtures/user_preference +18 -0
  152. data/spec/fixtures/user_preference_update +14 -0
  153. data/spec/fixtures/user_preferences +223 -0
  154. data/spec/fixtures/users +63 -0
  155. data/spec/helper.rb +12 -0
  156. data/spec/shared_context.rb +16 -0
  157. data/spec/shared_examples.rb +312 -0
  158. metadata +247 -181
  159. data/lib/desk/client/interaction.rb +0 -75
  160. data/spec/desk/client/interaction_spec.rb +0 -191
  161. data/spec/fixtures/article.json +0 -50
  162. data/spec/fixtures/article_create.json +0 -54
  163. data/spec/fixtures/article_destroy.json +0 -3
  164. data/spec/fixtures/article_update.json +0 -54
  165. data/spec/fixtures/articles.json +0 -58
  166. data/spec/fixtures/case.json +0 -59
  167. data/spec/fixtures/case_update.json +0 -59
  168. data/spec/fixtures/cases.json +0 -182
  169. data/spec/fixtures/customer.json +0 -58
  170. data/spec/fixtures/customer_create.json +0 -56
  171. data/spec/fixtures/customer_create_email.json +0 -15
  172. data/spec/fixtures/customer_update.json +0 -47
  173. data/spec/fixtures/customer_update_email.json +0 -15
  174. data/spec/fixtures/customers.json +0 -98
  175. data/spec/fixtures/group.json +0 -8
  176. data/spec/fixtures/groups.json +0 -23
  177. data/spec/fixtures/interaction_create.json +0 -126
  178. data/spec/fixtures/interactions.json +0 -139
  179. data/spec/fixtures/macro.json +0 -8
  180. data/spec/fixtures/macro_action.json +0 -9
  181. data/spec/fixtures/macro_action_update.json +0 -12
  182. data/spec/fixtures/macro_actions.json +0 -69
  183. data/spec/fixtures/macro_create.json +0 -13
  184. data/spec/fixtures/macro_destroy.json +0 -3
  185. data/spec/fixtures/macro_update.json +0 -13
  186. data/spec/fixtures/macros.json +0 -24
  187. data/spec/fixtures/topic.json +0 -9
  188. data/spec/fixtures/topic_create.json +0 -14
  189. data/spec/fixtures/topic_destroy.json +0 -3
  190. data/spec/fixtures/topic_update.json +0 -14
  191. data/spec/fixtures/topics.json +0 -35
  192. data/spec/fixtures/user.json +0 -15
  193. data/spec/fixtures/users.json +0 -24
@@ -0,0 +1,57 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/macros/1/actions?page=1&per_page=50",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/macros/1/actions?page=1&per_page=50",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/macros/1/actions?page=1&per_page=50",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "type": "set-case-description",
23
+ "value": "From a VIP Customer",
24
+ "enabled": true,
25
+ "created_at": "2013-11-22T22:49:20Z",
26
+ "updated_at": "2013-11-22T22:49:20Z",
27
+ "_links": {
28
+ "self": {
29
+ "href": "/api/v2/macros/1/actions/1",
30
+ "class": "macro_action"
31
+ },
32
+ "macro": {
33
+ "href": "/api/v2/macros/1",
34
+ "class": "macro"
35
+ }
36
+ }
37
+ },
38
+ {
39
+ "type": "set-case-priority",
40
+ "value": "10",
41
+ "enabled": true,
42
+ "created_at": "2013-11-22T22:49:20Z",
43
+ "updated_at": "2013-11-22T22:49:20Z",
44
+ "_links": {
45
+ "self": {
46
+ "href": "/api/v2/macros/1/actions/2",
47
+ "class": "macro_action"
48
+ },
49
+ "macro": {
50
+ "href": "/api/v2/macros/1",
51
+ "class": "macro"
52
+ }
53
+ }
54
+ }
55
+ ]
56
+ }
57
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "Macro Macro",
3
+ "description": "It's raining fire!",
4
+ "enabled": true,
5
+ "position": 1,
6
+ "folders": [
7
+ "Sample Macros",
8
+ "Favorites"
9
+ ],
10
+ "_links": {
11
+ "self": {
12
+ "href": "/api/v2/macros/1",
13
+ "class": "macro"
14
+ },
15
+ "actions": {
16
+ "href": "/api/v2/macros/1/actions",
17
+ "class": "macro_action"
18
+ }
19
+ }
20
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "name": "Macro Macro",
3
+ "description": "On repeat",
4
+ "enabled": true,
5
+ "position": 1,
6
+ "folders": [
7
+ "Sample Macros",
8
+ "Favorites"
9
+ ],
10
+ "_links": {
11
+ "self": {
12
+ "href": "/api/v2/macros/1",
13
+ "class": "macro"
14
+ },
15
+ "actions": {
16
+ "href": "/api/v2/macros/1/actions",
17
+ "class": "macro_action"
18
+ }
19
+ }
20
+ }
@@ -0,0 +1,63 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/macros?page=1&per_page=30",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/macros?page=1&per_page=30",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/macros?page=1&per_page=30",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "name": "Macro Macro",
23
+ "description": "On repeat",
24
+ "enabled": true,
25
+ "position": 1,
26
+ "folders": [
27
+ "Sample Macros",
28
+ "Favorites"
29
+ ],
30
+ "_links": {
31
+ "self": {
32
+ "href": "/api/v2/macros/1",
33
+ "class": "macro"
34
+ },
35
+ "actions": {
36
+ "href": "/api/v2/macros/1/actions",
37
+ "class": "macro_action"
38
+ }
39
+ }
40
+ },
41
+ {
42
+ "name": "Another Macro",
43
+ "description": null,
44
+ "enabled": true,
45
+ "position": 2,
46
+ "folders": [
47
+ "Sample Macros",
48
+ "Favorites"
49
+ ],
50
+ "_links": {
51
+ "self": {
52
+ "href": "/api/v2/macros/2",
53
+ "class": "macro"
54
+ },
55
+ "actions": {
56
+ "href": "/api/v2/macros/1/actions",
57
+ "class": "macro_action"
58
+ }
59
+ }
60
+ }
61
+ ]
62
+ }
63
+ }
@@ -0,0 +1,13 @@
1
+ {
2
+ "name": "Assign to Support",
3
+ "description": "Assign inbound tweets to support group",
4
+ "enabled": true,
5
+ "created_at": "2013-11-22T22:49:20Z",
6
+ "updated_at": "2013-11-22T22:49:20Z",
7
+ "_links": {
8
+ "self": {
9
+ "href": "/api/v2/rules/1",
10
+ "class": "rule"
11
+ }
12
+ }
13
+ }
@@ -0,0 +1,49 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/rules?page=1&per_page=30",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/rules?page=1&per_page=30",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/rules?page=1&per_page=30",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "name": "Assign to Support",
23
+ "description": "Assign inbound tweets to support group",
24
+ "enabled": true,
25
+ "created_at": "2013-11-22T22:49:20Z",
26
+ "updated_at": "2013-11-22T22:49:20Z",
27
+ "_links": {
28
+ "self": {
29
+ "href": "/api/v2/rules/1",
30
+ "class": "rule"
31
+ }
32
+ }
33
+ },
34
+ {
35
+ "name": "Increase Priority for Influential Twitter Users",
36
+ "description": null,
37
+ "enabled": true,
38
+ "created_at": "2013-11-22T22:49:20Z",
39
+ "updated_at": "2013-11-22T22:49:20Z",
40
+ "_links": {
41
+ "self": {
42
+ "href": "/api/v2/rules/2",
43
+ "class": "rule"
44
+ }
45
+ }
46
+ }
47
+ ]
48
+ }
49
+ }
@@ -0,0 +1,10 @@
1
+ {
2
+ "name": "company_name",
3
+ "value": "Cool Surfboard Co.",
4
+ "_links": {
5
+ "self": {
6
+ "href": "/api/v2/site_settings/1",
7
+ "class": "site_setting"
8
+ }
9
+ }
10
+ }
@@ -0,0 +1,43 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/site_settings?page=1&per_page=30",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/site_settings?page=1&per_page=30",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/site_settings?page=1&per_page=30",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "name": "company_name",
23
+ "value": "Cool Surfboard Co.",
24
+ "_links": {
25
+ "self": {
26
+ "href": "/api/v2/site_settings/1",
27
+ "class": "site_setting"
28
+ }
29
+ }
30
+ },
31
+ {
32
+ "name": "timezone",
33
+ "value": "Pacific Time (US & Canada)",
34
+ "_links": {
35
+ "self": {
36
+ "href": "/api/v2/site_settings/2",
37
+ "class": "site_setting"
38
+ }
39
+ }
40
+ }
41
+ ]
42
+ }
43
+ }
@@ -0,0 +1,4 @@
1
+ {
2
+ "message": "We're not doing maintenance today, but if we were then we would tell you about it here.",
3
+ "updated_at": "2013-11-22T22:49:20Z"
4
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "name": "Customer Support",
3
+ "description": "This is key to going from good to great",
4
+ "position": 1,
5
+ "allow_questions": true,
6
+ "in_support_center": true,
7
+ "created_at": "2013-11-12T22:59:20Z",
8
+ "updated_at": "2013-11-17T22:59:20Z",
9
+ "_links": {
10
+ "self": {
11
+ "href": "/api/v2/topics/1",
12
+ "class": "topic"
13
+ },
14
+ "articles": {
15
+ "href": "/api/v2/topics/1/articles",
16
+ "class": "article"
17
+ },
18
+ "translations": {
19
+ "href": "/api/v2/topics/1/translations",
20
+ "class": "topic_translation"
21
+ }
22
+ }
23
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "name": "Customer Support",
3
+ "description": null,
4
+ "position": 1,
5
+ "allow_questions": true,
6
+ "in_support_center": true,
7
+ "created_at": "2013-11-22T22:59:24Z",
8
+ "updated_at": "2013-11-22T22:59:24Z",
9
+ "_links": {
10
+ "self": {
11
+ "href": "/api/v2/topics/1",
12
+ "class": "topic"
13
+ },
14
+ "articles": {
15
+ "href": "/api/v2/topics/1/articles",
16
+ "class": "article"
17
+ },
18
+ "translations": {
19
+ "href": "/api/v2/topics/1/translations",
20
+ "class": "topic_translation"
21
+ }
22
+ }
23
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "name": "Customer Support",
3
+ "locale": "en_us",
4
+ "created_at": "2013-11-12T22:59:20Z",
5
+ "updated_at": "2013-11-17T22:59:20Z",
6
+ "_links": {
7
+ "self": {
8
+ "href": "/api/v2/topics/1/translations/en_us",
9
+ "class": "topic_translation"
10
+ }
11
+ }
12
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "name": "Japanese",
3
+ "locale": "ja",
4
+ "created_at": "2013-11-22T22:59:24Z",
5
+ "updated_at": "2013-11-22T22:59:24Z",
6
+ "_links": {
7
+ "self": {
8
+ "href": "/api/v2/topics/1/translations/en_us",
9
+ "class": "topic_translation"
10
+ }
11
+ }
12
+ }
@@ -0,0 +1,12 @@
1
+ {
2
+ "name": "Updated Japanese Translation",
3
+ "locale": "ja",
4
+ "created_at": "2013-11-17T22:59:24Z",
5
+ "updated_at": "2013-11-22T22:59:24Z",
6
+ "_links": {
7
+ "self": {
8
+ "href": "/api/v2/topics/1/translations/ja",
9
+ "class": "topic_translation"
10
+ }
11
+ }
12
+ }
@@ -0,0 +1,47 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/topics/1/translations?page=1&per_page=50",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/topics/1/translations?page=1&per_page=50",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/topics/1/translations?page=1&per_page=50",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "name": "Customer Support",
23
+ "locale": "en_us",
24
+ "created_at": "2013-11-12T22:59:20Z",
25
+ "updated_at": "2013-11-17T22:59:20Z",
26
+ "_links": {
27
+ "self": {
28
+ "href": "/api/v2/topics/1/translations/en_us",
29
+ "class": "topic_translation"
30
+ }
31
+ }
32
+ },
33
+ {
34
+ "name": "Japanese Translation",
35
+ "locale": "ja",
36
+ "created_at": "2013-11-22T22:58:24Z",
37
+ "updated_at": "2013-11-22T22:58:24Z",
38
+ "_links": {
39
+ "self": {
40
+ "href": "/api/v2/topics/1/translations/ja",
41
+ "class": "topic_translation"
42
+ }
43
+ }
44
+ }
45
+ ]
46
+ }
47
+ }
@@ -0,0 +1,23 @@
1
+ {
2
+ "name": "New Name",
3
+ "description": null,
4
+ "position": 1,
5
+ "allow_questions": false,
6
+ "in_support_center": true,
7
+ "created_at": "2013-11-17T22:59:24Z",
8
+ "updated_at": "2013-11-22T22:59:24Z",
9
+ "_links": {
10
+ "self": {
11
+ "href": "/api/v2/topics/1",
12
+ "class": "topic"
13
+ },
14
+ "articles": {
15
+ "href": "/api/v2/topics/1/articles",
16
+ "class": "article"
17
+ },
18
+ "translations": {
19
+ "href": "/api/v2/topics/1/translations",
20
+ "class": "topic_translation"
21
+ }
22
+ }
23
+ }