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,60 @@
1
+ {
2
+ "first_name": "John",
3
+ "last_name": "Doe",
4
+ "company": "ACME, Inc",
5
+ "title": "Senior Ninja",
6
+ "external_id": null,
7
+ "background": "This guy can be a challenge to work with",
8
+ "language": "en_us",
9
+ "locked_until": null,
10
+ "created_at": "2013-11-22T22:49:20Z",
11
+ "updated_at": "2013-11-22T22:49:20Z",
12
+ "custom_fields": {
13
+ "level": "vip"
14
+ },
15
+ "emails": [
16
+ {
17
+ "type": "work",
18
+ "value": "john@acme.com"
19
+ },
20
+ {
21
+ "type": "home",
22
+ "value": "john@home.com"
23
+ }
24
+ ],
25
+ "phone_numbers": [
26
+ {
27
+ "type": "work",
28
+ "value": "123-456-7890"
29
+ }
30
+ ],
31
+ "addresses": [
32
+ {
33
+ "type": "work",
34
+ "value": "123 Main St, San Francisco, CA 94105"
35
+ }
36
+ ],
37
+ "_links": {
38
+ "self": {
39
+ "href": "/api/v2/customers/1",
40
+ "class": "customer"
41
+ },
42
+ "cases": {
43
+ "href": "/api/v2/customers/1/cases",
44
+ "class": "case"
45
+ },
46
+ "company": {
47
+ "href": "/api/v2/companies/1",
48
+ "class": "company"
49
+ },
50
+ "facebook_user": {
51
+ "href": "/api/v2/facebook_users/1",
52
+ "class": "facebook_user"
53
+ },
54
+ "twitter_user": {
55
+ "href": "/api/v2/twitter_users/1",
56
+ "class": "twitter_user"
57
+ },
58
+ "locked_by": null
59
+ }
60
+ }
@@ -0,0 +1,54 @@
1
+ {
2
+ "first_name": "John",
3
+ "last_name": "Doe",
4
+ "company": null,
5
+ "title": null,
6
+ "external_id": null,
7
+ "background": null,
8
+ "language": "en_us",
9
+ "locked_until": null,
10
+ "created_at": "2013-11-22T22:49:20Z",
11
+ "updated_at": "2013-11-22T22:49:20Z",
12
+ "custom_fields": {
13
+ "level": "vip"
14
+ },
15
+ "emails": [
16
+ {
17
+ "type": "work",
18
+ "value": "john@acme.com"
19
+ },
20
+ {
21
+ "type": "home",
22
+ "value": "john@home.com"
23
+ }
24
+ ],
25
+ "phone_numbers": [
26
+
27
+ ],
28
+ "addresses": [
29
+
30
+ ],
31
+ "_links": {
32
+ "self": {
33
+ "href": "/api/v2/customers/1",
34
+ "class": "customer"
35
+ },
36
+ "cases": {
37
+ "href": "/api/v2/customers/1/cases",
38
+ "class": "case"
39
+ },
40
+ "company": {
41
+ "href": "/api/v2/companies/1",
42
+ "class": "company"
43
+ },
44
+ "facebook_user": {
45
+ "href": "/api/v2/facebook_users/1",
46
+ "class": "facebook_user"
47
+ },
48
+ "twitter_user": {
49
+ "href": "/api/v2/twitter_users/1",
50
+ "class": "twitter_user"
51
+ },
52
+ "locked_by": null
53
+ }
54
+ }
@@ -0,0 +1,60 @@
1
+ {
2
+ "first_name": "Johnny",
3
+ "last_name": "Doe",
4
+ "company": "ACME, Inc",
5
+ "title": "Senior Ninja",
6
+ "external_id": null,
7
+ "background": "This guy can be a challenge to work with",
8
+ "language": "en_us",
9
+ "locked_until": null,
10
+ "created_at": "2013-11-22T22:49:20Z",
11
+ "updated_at": "2013-11-22T22:49:20Z",
12
+ "custom_fields": {
13
+ "level": "super"
14
+ },
15
+ "emails": [
16
+ {
17
+ "type": "work",
18
+ "value": "johnny@acme.com"
19
+ },
20
+ {
21
+ "type": "other",
22
+ "value": "johnny@other.com"
23
+ }
24
+ ],
25
+ "phone_numbers": [
26
+ {
27
+ "type": "work",
28
+ "value": "123-456-7890"
29
+ }
30
+ ],
31
+ "addresses": [
32
+ {
33
+ "type": "work",
34
+ "value": "123 Main St, San Francisco, CA 94105"
35
+ }
36
+ ],
37
+ "_links": {
38
+ "self": {
39
+ "href": "/api/v2/customers/1",
40
+ "class": "customer"
41
+ },
42
+ "cases": {
43
+ "href": "/api/v2/customers/1/cases",
44
+ "class": "case"
45
+ },
46
+ "company": {
47
+ "href": "/api/v2/companies/1",
48
+ "class": "company"
49
+ },
50
+ "facebook_user": {
51
+ "href": "/api/v2/facebook_users/1",
52
+ "class": "facebook_user"
53
+ },
54
+ "twitter_user": {
55
+ "href": "/api/v2/twitter_users/1",
56
+ "class": "twitter_user"
57
+ },
58
+ "locked_by": null
59
+ }
60
+ }
@@ -0,0 +1,143 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/customers?page=1&per_page=30",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/customers?page=1&per_page=30",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/customers?page=1&per_page=30",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "first_name": "John",
23
+ "last_name": "Doe",
24
+ "company": "ACME, Inc",
25
+ "title": "Senior Ninja",
26
+ "external_id": null,
27
+ "background": "This guy can be a challenge to work with",
28
+ "language": "en_us",
29
+ "locked_until": null,
30
+ "created_at": "2013-11-22T22:49:20Z",
31
+ "updated_at": "2013-11-22T22:49:20Z",
32
+ "custom_fields": {
33
+ "level": "vip"
34
+ },
35
+ "emails": [
36
+ {
37
+ "type": "work",
38
+ "value": "john@acme.com"
39
+ },
40
+ {
41
+ "type": "home",
42
+ "value": "john@home.com"
43
+ }
44
+ ],
45
+ "phone_numbers": [
46
+ {
47
+ "type": "work",
48
+ "value": "123-456-7890"
49
+ }
50
+ ],
51
+ "addresses": [
52
+ {
53
+ "type": "work",
54
+ "value": "123 Main St, San Francisco, CA 94105"
55
+ }
56
+ ],
57
+ "_links": {
58
+ "self": {
59
+ "href": "/api/v2/customers/1",
60
+ "class": "customer"
61
+ },
62
+ "cases": {
63
+ "href": "/api/v2/customers/1/cases",
64
+ "class": "case"
65
+ },
66
+ "company": {
67
+ "href": "/api/v2/companies/1",
68
+ "class": "company"
69
+ },
70
+ "facebook_user": {
71
+ "href": "/api/v2/facebook_users/1",
72
+ "class": "facebook_user"
73
+ },
74
+ "twitter_user": {
75
+ "href": "/api/v2/twitter_users/1",
76
+ "class": "twitter_user"
77
+ },
78
+ "locked_by": null
79
+ }
80
+ },
81
+ {
82
+ "first_name": "Bob",
83
+ "last_name": "Doe",
84
+ "company": "ACME, Inc",
85
+ "title": "Senior Ninja",
86
+ "external_id": null,
87
+ "background": "Easy to work with",
88
+ "language": "en_us",
89
+ "locked_until": null,
90
+ "created_at": "2013-11-22T22:49:20Z",
91
+ "updated_at": "2013-11-22T22:49:20Z",
92
+ "custom_fields": {
93
+ "level": "vip"
94
+ },
95
+ "emails": [
96
+ {
97
+ "type": "work",
98
+ "value": "bob@acme.com"
99
+ },
100
+ {
101
+ "type": "home",
102
+ "value": "bob@home.com"
103
+ }
104
+ ],
105
+ "phone_numbers": [
106
+ {
107
+ "type": "work",
108
+ "value": "123-456-7890"
109
+ }
110
+ ],
111
+ "addresses": [
112
+ {
113
+ "type": "work",
114
+ "value": "123 Main St, San Francisco, CA 94105"
115
+ }
116
+ ],
117
+ "_links": {
118
+ "self": {
119
+ "href": "/api/v2/customers/2",
120
+ "class": "customer"
121
+ },
122
+ "cases": {
123
+ "href": "/api/v2/customers/1/cases",
124
+ "class": "case"
125
+ },
126
+ "company": {
127
+ "href": "/api/v2/companies/1",
128
+ "class": "company"
129
+ },
130
+ "facebook_user": {
131
+ "href": "/api/v2/facebook_users/1",
132
+ "class": "facebook_user"
133
+ },
134
+ "twitter_user": {
135
+ "href": "/api/v2/twitter_users/1",
136
+ "class": "twitter_user"
137
+ },
138
+ "locked_by": null
139
+ }
140
+ }
141
+ ]
142
+ }
143
+ }
@@ -0,0 +1,143 @@
1
+ {
2
+ "total_entries": 2,
3
+ "_links": {
4
+ "self": {
5
+ "href": "/api/v2/customers?page=1&per_page=30",
6
+ "class": "page"
7
+ },
8
+ "first": {
9
+ "href": "/api/v2/customers?page=1&per_page=30",
10
+ "class": "page"
11
+ },
12
+ "last": {
13
+ "href": "/api/v2/customers?page=1&per_page=30",
14
+ "class": "page"
15
+ },
16
+ "next": null,
17
+ "previous": null
18
+ },
19
+ "_embedded": {
20
+ "entries": [
21
+ {
22
+ "first_name": "John",
23
+ "last_name": "Doe",
24
+ "company": "ACME, Inc",
25
+ "title": "Senior Ninja",
26
+ "external_id": null,
27
+ "background": "This guy can be a challenge to work with",
28
+ "language": "en_us",
29
+ "locked_until": null,
30
+ "created_at": "2013-11-22T22:49:20Z",
31
+ "updated_at": "2013-11-22T22:49:20Z",
32
+ "custom_fields": {
33
+ "level": "vip"
34
+ },
35
+ "emails": [
36
+ {
37
+ "type": "work",
38
+ "value": "john@acme.com"
39
+ },
40
+ {
41
+ "type": "home",
42
+ "value": "john@home.com"
43
+ }
44
+ ],
45
+ "phone_numbers": [
46
+ {
47
+ "type": "work",
48
+ "value": "123-456-7890"
49
+ }
50
+ ],
51
+ "addresses": [
52
+ {
53
+ "type": "work",
54
+ "value": "123 Main St, San Francisco, CA 94105"
55
+ }
56
+ ],
57
+ "_links": {
58
+ "self": {
59
+ "href": "/api/v2/customers/1",
60
+ "class": "customer"
61
+ },
62
+ "cases": {
63
+ "href": "/api/v2/customers/1/cases",
64
+ "class": "case"
65
+ },
66
+ "company": {
67
+ "href": "/api/v2/companies/1",
68
+ "class": "company"
69
+ },
70
+ "facebook_user": {
71
+ "href": "/api/v2/facebook_users/1",
72
+ "class": "facebook_user"
73
+ },
74
+ "twitter_user": {
75
+ "href": "/api/v2/twitter_users/1",
76
+ "class": "twitter_user"
77
+ },
78
+ "locked_by": null
79
+ }
80
+ },
81
+ {
82
+ "first_name": "Bob",
83
+ "last_name": "Doe",
84
+ "company": "ACME, Inc",
85
+ "title": "Senior Ninja",
86
+ "external_id": null,
87
+ "background": "Easy to work with",
88
+ "language": "en_us",
89
+ "locked_until": null,
90
+ "created_at": "2013-11-22T22:49:20Z",
91
+ "updated_at": "2013-11-22T22:49:20Z",
92
+ "custom_fields": {
93
+ "level": "vip"
94
+ },
95
+ "emails": [
96
+ {
97
+ "type": "work",
98
+ "value": "bob@acme.com"
99
+ },
100
+ {
101
+ "type": "home",
102
+ "value": "bob@home.com"
103
+ }
104
+ ],
105
+ "phone_numbers": [
106
+ {
107
+ "type": "work",
108
+ "value": "123-456-7890"
109
+ }
110
+ ],
111
+ "addresses": [
112
+ {
113
+ "type": "work",
114
+ "value": "123 Main St, San Francisco, CA 94105"
115
+ }
116
+ ],
117
+ "_links": {
118
+ "self": {
119
+ "href": "/api/v2/customers/2",
120
+ "class": "customer"
121
+ },
122
+ "cases": {
123
+ "href": "/api/v2/customers/1/cases",
124
+ "class": "case"
125
+ },
126
+ "company": {
127
+ "href": "/api/v2/companies/1",
128
+ "class": "company"
129
+ },
130
+ "facebook_user": {
131
+ "href": "/api/v2/facebook_users/1",
132
+ "class": "facebook_user"
133
+ },
134
+ "twitter_user": {
135
+ "href": "/api/v2/twitter_users/1",
136
+ "class": "twitter_user"
137
+ },
138
+ "locked_by": null
139
+ }
140
+ }
141
+ ]
142
+ }
143
+ }