help-scout-docs 0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (51) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/Gemfile +3 -0
  4. data/Gemfile.lock +56 -0
  5. data/README.rdoc +62 -0
  6. data/help_scout_docs.gemspec +33 -0
  7. data/lib/help_scout_docs.rb +14 -0
  8. data/lib/help_scout_docs/client.rb +95 -0
  9. data/lib/help_scout_docs/configurable.rb +78 -0
  10. data/lib/help_scout_docs/default.rb +55 -0
  11. data/lib/help_scout_docs/error.rb +5 -0
  12. data/lib/help_scout_docs/error/authentication_error.rb +6 -0
  13. data/lib/help_scout_docs/error/configuration_error.rb +6 -0
  14. data/lib/help_scout_docs/error/errors.rb +6 -0
  15. data/lib/help_scout_docs/error/options_error.rb +6 -0
  16. data/lib/help_scout_docs/error/parser_error.rb +6 -0
  17. data/lib/help_scout_docs/error/resource_not_found_error.rb +6 -0
  18. data/lib/help_scout_docs/method.rb +54 -0
  19. data/lib/help_scout_docs/methods/article.rb +45 -0
  20. data/lib/help_scout_docs/methods/category.rb +16 -0
  21. data/lib/help_scout_docs/methods/collection.rb +15 -0
  22. data/lib/help_scout_docs/methods/methods.rb +6 -0
  23. data/lib/help_scout_docs/methods/site.rb +15 -0
  24. data/lib/help_scout_docs/response/parse_json.rb +33 -0
  25. data/lib/help_scout_docs/result.rb +31 -0
  26. data/lib/help_scout_docs/version.rb +3 -0
  27. data/spec/cassettes/HelpScoutDocs_Article/_get/should_return_the_article.yml +46 -0
  28. data/spec/cassettes/HelpScoutDocs_Article/_get/when_using_an_id/should_return_the_article.yml +46 -0
  29. data/spec/cassettes/HelpScoutDocs_Article/_list_by_category/should_return_the_list_of_articles_by_category.yml +46 -0
  30. data/spec/cassettes/HelpScoutDocs_Article/_list_by_collection/should_return_the_list_of_articles_by_collection.yml +47 -0
  31. data/spec/cassettes/HelpScoutDocs_Article/_related/should_return_related_articles.yml +46 -0
  32. data/spec/cassettes/HelpScoutDocs_Article/_revisions/should_return_article_revisions.yml +46 -0
  33. data/spec/cassettes/HelpScoutDocs_Category/_get/should_return_the_category.yml +46 -0
  34. data/spec/cassettes/HelpScoutDocs_Category/_list/should_return_the_list_of_categories.yml +46 -0
  35. data/spec/cassettes/HelpScoutDocs_Client/_get/for_a_missing_request/should_raise_an_exception.yml +46 -0
  36. data/spec/cassettes/HelpScoutDocs_Client/_get/should_return_back_a_result.yml +65 -0
  37. data/spec/cassettes/HelpScoutDocs_Client/_get/with_invalid_authentication_params/should_raise_an_exception.yml +38 -0
  38. data/spec/cassettes/HelpScoutDocs_Client/_get/with_valid_params/should_call_the_requested_method.yml +65 -0
  39. data/spec/cassettes/HelpScoutDocs_Collection/_get/should_return_the_collection.yml +46 -0
  40. data/spec/cassettes/HelpScoutDocs_Collection/_list/should_return_the_list_of_collections.yml +48 -0
  41. data/spec/cassettes/HelpScoutDocs_Site/_get/should_return_the_site.yml +46 -0
  42. data/spec/cassettes/HelpScoutDocs_Site/_list/should_return_the_list_of_sites.yml +65 -0
  43. data/spec/client_spec.rb +78 -0
  44. data/spec/method_spec.rb +26 -0
  45. data/spec/methods/article_spec.rb +71 -0
  46. data/spec/methods/category_spec.rb +24 -0
  47. data/spec/methods/collection_spec.rb +23 -0
  48. data/spec/methods/site_spec.rb +23 -0
  49. data/spec/result_spec.rb +21 -0
  50. data/spec/spec_helper.rb +18 -0
  51. metadata +245 -0
data/spec/cassettes/HelpScoutDocs_Article/_revisions/should_return_article_revisions.yml ADDED
@@ -0,0 +1,46 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/articles/54027853e4b019254d1ec268/related
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:49 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '66'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"articles":{"page":1,"pages":1,"count":0,"items":[]}}'
44
+ http_version:
45
+ recorded_at: Sun, 31 Aug 2014 19:02:49 GMT
46
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Category/_get/should_return_the_category.yml ADDED
@@ -0,0 +1,46 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/categories/540227d7e4b003be53bdcd28
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:50 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '286'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"category":{"id":"540227d7e4b003be53bdcd28","number":148,"slug":"category","visibility":"public","collectionId":"540221e9e4b019254d1ec25b","order":1,"defaultSort":"popularity","name":"Category","description":null,"articleCount":1,"publishedArticleCount":0,"publicUrl":"http://rubydocsapi.helpscoutdocs.com/category/148-category","createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:36:55Z","updatedAt":"2014-08-31T01:20:20Z"}}'
44
+ http_version:
45
+ recorded_at: Sun, 31 Aug 2014 19:02:50 GMT
46
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Category/_list/should_return_the_list_of_categories.yml ADDED
@@ -0,0 +1,46 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/collections/540221e9e4b019254d1ec25b/categories
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:49 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '371'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"categories":{"page":1,"pages":1,"count":2,"items":[{"id":"540227d7e4b003be53bdcd28","number":148,"slug":"category","visibility":"public","collectionId":"540221e9e4b019254d1ec25b","order":1,"defaultSort":"popularity","name":"Category","description":null,"articleCount":1,"publishedArticleCount":0,"publicUrl":"http://rubydocsapi.helpscoutdocs.com/category/148-category","createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:36:55Z","updatedAt":"2014-08-31T01:20:20Z"},{"id":"540221e9e4b019254d1ec25c","number":147,"slug":"uncategorized","visibility":"public","collectionId":"540221e9e4b019254d1ec25b","order":10000,"defaultSort":"popularity","name":"Uncategorized","description":null,"articleCount":1,"publishedArticleCount":0,"publicUrl":"http://rubydocsapi.helpscoutdocs.com/category/147-uncategorized","createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:11:37Z","updatedAt":"2014-08-31T02:48:31Z"}]}}'
44
+ http_version:
45
+ recorded_at: Sun, 31 Aug 2014 19:02:50 GMT
46
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Client/_get/for_a_missing_request/should_raise_an_exception.yml ADDED
@@ -0,0 +1,46 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/sites/1
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 404
21
+ message: Not Found
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:46 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '61'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"code":404,"error":"Resource not found"}'
44
+ http_version:
45
+ recorded_at: Sun, 31 Aug 2014 19:02:46 GMT
46
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Client/_get/should_return_back_a_result.yml ADDED
@@ -0,0 +1,65 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/sites
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:45 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '1563'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"sites":{"page":1,"pages":1,"count":3,"items":[{"id":"5265aaffe4b0d77ef66a525d","subDomain":"guestfolio","cname":"help.guestfolio.com","hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"categories","title":"Guestfolio
44
+ Knowledge Base","description":"Search the Guestfolio documentation","logoUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5335ebb7e4b0cf4cd65802d2/Guestfolio-50.png","logoWidth":188,"logoHeight":50,"favIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/526afc70e4b09e5feddf352b/butterfly.png","touchIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/526afc9de4b09e5feddf352e/butterfly-200-1.png","homeUrl":"http://support.guestfolio.com","homeLinkText":"Documentation","pageBgColor":"#f5f5f5","headerBgColor":"#f8f8f8","navTextColor":"#888888","navActiveColor":"#30a5eb","linkColor":"#30a5eb","articleTextColor":null,"hasContactForm":false,"mailboxId":null,"contactEmail":null,"styleSheetUrl":"","headerCode":"<script>\nwindow.addEventListener(''load'',
45
+ function (){\n var li = document.createElement(''li'');\n var a = document.createElement(''a'');\n var
46
+ link = document.createTextNode(\"Contact Support\");\n a.appendChild(link);\n a.href
47
+ = \"http://support.guestfolio.com/contact\";\n li.appendChild(a);\n var
48
+ home = document.getElementById(\"home\");\n home.parentNode.insertBefore(li,
49
+ home.nextSibling);\n});\n</script>\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-regular-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:regular''
50
+ type=''text/css'' media=''all'' />\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-300-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:300''
51
+ type=''text/css'' media=''all'' />\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-700-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:700''
52
+ type=''text/css'' media=''all'' />\n<style>\nbody {\n margin-top: 0;\n}\ndiv.navbar-inner
53
+ {\n border-bottom: 1px solid #ddd;\n}\nh1, h2, h3 {\n font-family: ''Source
54
+ Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n}\n#sidebar
55
+ h3 {\n color: #00a9dc;\n font-weight: 200;\n line-height: 1.25;\n margin-bottom:
56
+ 8px;\n font-size: 1.2em;\n}\np.lu {\n font-size: 0.6em;\n text-align: right;\n}\nol,
57
+ li, ul {\n margin-left: 20px;\n}\n.navbar .nav a {\n font-family: ''Source
58
+ Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n text-transform:
59
+ uppercase;\n font-size: 17px;\n color: #888;\n}\n.navbar .nav a:hover {\n color:
60
+ #00a9dc;\n}\n\n</style>\n\n<script src=\"//cdn.sublimevideo.net/js/q4o9lqsy.js\"
61
+ type=\"text/javascript\"></script>","metaDescription":"Frequently asked questions
62
+ and support documentation for Guestfolio","createdBy":20055,"updatedBy":20055,"createdAt":"2014-03-28T21:50:34Z","updatedAt":"2014-07-17T23:33:20Z"},{"id":"540221a1e4b019254d1ec25a","subDomain":"rubydocsapi","cname":null,"hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"articles","title":"RubyDocsAPI","description":null,"logoUrl":null,"logoWidth":null,"logoHeight":null,"favIconUrl":null,"touchIconUrl":null,"homeUrl":null,"homeLinkText":null,"pageBgColor":null,"headerBgColor":null,"navTextColor":null,"navActiveColor":null,"linkColor":null,"articleTextColor":null,"hasContactForm":false,"mailboxId":0,"contactEmail":null,"styleSheetUrl":null,"headerCode":null,"metaDescription":null,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:10:25Z","updatedAt":"2014-08-30T19:10:25Z"},{"id":"5339e189e4b0cf4cd6580473","subDomain":"lasso","cname":"help.lasso.in","hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"articles","title":"Lasso","description":"","logoUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5400bb85e4b003be53bdcb6c/logo-large.png","logoWidth":75,"logoHeight":75,"favIconUrl":null,"touchIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5400bb73e4b003be53bdcb6b/logo-large.png","homeUrl":"http://www.lasso.in","homeLinkText":"Home","pageBgColor":"#ffffff","headerBgColor":"#22a0a6","navTextColor":"#ffffff","navActiveColor":"#e7e7e7","linkColor":"#e41e25","articleTextColor":"#222222","hasContactForm":true,"mailboxId":20878,"contactEmail":null,"styleSheetUrl":"","headerCode":"","metaDescription":"","createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-29T17:45:25Z","updatedAt":"2014-08-29T17:45:25Z"}]}}'
63
+ http_version:
64
+ recorded_at: Sun, 31 Aug 2014 19:02:45 GMT
65
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Client/_get/with_invalid_authentication_params/should_raise_an_exception.yml ADDED
@@ -0,0 +1,38 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://invalid:<api-password>@docsapi.helpscout.net/v1/sites
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 401
21
+ message: Unauthorized
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:45 GMT
25
+ Content-Type:
26
+ - application/json; charset=utf-8
27
+ Vary:
28
+ - Accept-Encoding,User-Agent
29
+ Content-Length:
30
+ - '78'
31
+ "<api-password>-Frame-Options":
32
+ - SAMEORIGIN
33
+ body:
34
+ encoding: UTF-8
35
+ string: '{"code":401,"error":"Authentication credentials are invalid"}'
36
+ http_version:
37
+ recorded_at: Sun, 31 Aug 2014 19:02:46 GMT
38
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Client/_get/with_valid_params/should_call_the_requested_method.yml ADDED
@@ -0,0 +1,65 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/sites
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:46 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '1563'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"sites":{"page":1,"pages":1,"count":3,"items":[{"id":"5265aaffe4b0d77ef66a525d","subDomain":"guestfolio","cname":"help.guestfolio.com","hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"categories","title":"Guestfolio
44
+ Knowledge Base","description":"Search the Guestfolio documentation","logoUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5335ebb7e4b0cf4cd65802d2/Guestfolio-50.png","logoWidth":188,"logoHeight":50,"favIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/526afc70e4b09e5feddf352b/butterfly.png","touchIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/526afc9de4b09e5feddf352e/butterfly-200-1.png","homeUrl":"http://support.guestfolio.com","homeLinkText":"Documentation","pageBgColor":"#f5f5f5","headerBgColor":"#f8f8f8","navTextColor":"#888888","navActiveColor":"#30a5eb","linkColor":"#30a5eb","articleTextColor":null,"hasContactForm":false,"mailboxId":null,"contactEmail":null,"styleSheetUrl":"","headerCode":"<script>\nwindow.addEventListener(''load'',
45
+ function (){\n var li = document.createElement(''li'');\n var a = document.createElement(''a'');\n var
46
+ link = document.createTextNode(\"Contact Support\");\n a.appendChild(link);\n a.href
47
+ = \"http://support.guestfolio.com/contact\";\n li.appendChild(a);\n var
48
+ home = document.getElementById(\"home\");\n home.parentNode.insertBefore(li,
49
+ home.nextSibling);\n});\n</script>\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-regular-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:regular''
50
+ type=''text/css'' media=''all'' />\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-300-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:300''
51
+ type=''text/css'' media=''all'' />\n<link rel=''stylesheet'' id=''options_typography_Source+Sans+Pro-700-css'' href=''https://fonts.googleapis.com/css?family=Source+Sans+Pro:700''
52
+ type=''text/css'' media=''all'' />\n<style>\nbody {\n margin-top: 0;\n}\ndiv.navbar-inner
53
+ {\n border-bottom: 1px solid #ddd;\n}\nh1, h2, h3 {\n font-family: ''Source
54
+ Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n}\n#sidebar
55
+ h3 {\n color: #00a9dc;\n font-weight: 200;\n line-height: 1.25;\n margin-bottom:
56
+ 8px;\n font-size: 1.2em;\n}\np.lu {\n font-size: 0.6em;\n text-align: right;\n}\nol,
57
+ li, ul {\n margin-left: 20px;\n}\n.navbar .nav a {\n font-family: ''Source
58
+ Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n text-transform:
59
+ uppercase;\n font-size: 17px;\n color: #888;\n}\n.navbar .nav a:hover {\n color:
60
+ #00a9dc;\n}\n\n</style>\n\n<script src=\"//cdn.sublimevideo.net/js/q4o9lqsy.js\"
61
+ type=\"text/javascript\"></script>","metaDescription":"Frequently asked questions
62
+ and support documentation for Guestfolio","createdBy":20055,"updatedBy":20055,"createdAt":"2014-03-28T21:50:34Z","updatedAt":"2014-07-17T23:33:20Z"},{"id":"540221a1e4b019254d1ec25a","subDomain":"rubydocsapi","cname":null,"hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"articles","title":"RubyDocsAPI","description":null,"logoUrl":null,"logoWidth":null,"logoHeight":null,"favIconUrl":null,"touchIconUrl":null,"homeUrl":null,"homeLinkText":null,"pageBgColor":null,"headerBgColor":null,"navTextColor":null,"navActiveColor":null,"linkColor":null,"articleTextColor":null,"hasContactForm":false,"mailboxId":0,"contactEmail":null,"styleSheetUrl":null,"headerCode":null,"metaDescription":null,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:10:25Z","updatedAt":"2014-08-30T19:10:25Z"},{"id":"5339e189e4b0cf4cd6580473","subDomain":"lasso","cname":"help.lasso.in","hasPublicSite":true,"companyName":"Guestfolio","homePageContent":"articles","title":"Lasso","description":"","logoUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5400bb85e4b003be53bdcb6c/logo-large.png","logoWidth":75,"logoHeight":75,"favIconUrl":null,"touchIconUrl":"https://s3.amazonaws.com/helpscout.net/docs/assets/5265aaffe4b0d77ef66a525c/images/5400bb73e4b003be53bdcb6b/logo-large.png","homeUrl":"http://www.lasso.in","homeLinkText":"Home","pageBgColor":"#ffffff","headerBgColor":"#22a0a6","navTextColor":"#ffffff","navActiveColor":"#e7e7e7","linkColor":"#e41e25","articleTextColor":"#222222","hasContactForm":true,"mailboxId":20878,"contactEmail":null,"styleSheetUrl":"","headerCode":"","metaDescription":"","createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-29T17:45:25Z","updatedAt":"2014-08-29T17:45:25Z"}]}}'
63
+ http_version:
64
+ recorded_at: Sun, 31 Aug 2014 19:02:46 GMT
65
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Collection/_get/should_return_the_collection.yml ADDED
@@ -0,0 +1,46 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/collections/540221e9e4b019254d1ec25b
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:53 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '252'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"collection":{"id":"540221e9e4b019254d1ec25b","siteId":"540221a1e4b019254d1ec25a","number":145,"slug":"collection","visibility":"public","order":1,"name":"Collection","description":"","publicUrl":"http://rubydocsapi.helpscoutdocs.com/collection/145-collection","articleCount":2,"publishedArticleCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:11:37Z","updatedAt":"2014-08-30T19:36:56Z"}}'
44
+ http_version:
45
+ recorded_at: Sun, 31 Aug 2014 19:02:53 GMT
46
+ recorded_with: VCR 2.9.0
data/spec/cassettes/HelpScoutDocs_Collection/_list/should_return_the_list_of_collections.yml ADDED
@@ -0,0 +1,48 @@
1
+ ---
2
+ http_interactions:
3
+ - request:
4
+ method: get
5
+ uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/collections
6
+ body:
7
+ encoding: US-ASCII
8
+ string: ''
9
+ headers:
10
+ User-Agent:
11
+ - Faraday v0.9.0
12
+ Accept:
13
+ - application/json
14
+ Accept-Charset:
15
+ - utf-8
16
+ Accept-Encoding:
17
+ - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
18
+ response:
19
+ status:
20
+ code: 200
21
+ message: OK
22
+ headers:
23
+ Date:
24
+ - Sun, 31 Aug 2014 19:02:50 GMT
25
+ Access-Control-Allow-Origin:
26
+ - "*"
27
+ Access-Control-Allow-Headers:
28
+ - Authorization
29
+ Access-Control-Allow-Methods:
30
+ - GET, POST, PUT, DELETE
31
+ Access-Control-Allow-Credentials:
32
+ - 'true'
33
+ Content-Type:
34
+ - application/json; charset=utf-8
35
+ Vary:
36
+ - Accept-Encoding,User-Agent
37
+ Content-Length:
38
+ - '536'
39
+ "<api-password>-Frame-Options":
40
+ - SAMEORIGIN
41
+ body:
42
+ encoding: UTF-8
43
+ string: '{"collections":{"page":1,"pages":1,"count":4,"items":[{"id":"5265aaffe4b0d77ef66a525e","siteId":"5265aaffe4b0d77ef66a525d","number":1,"slug":"support-articles","visibility":"public","order":1,"name":"Support
44
+ articles","description":null,"publicUrl":"http://help.guestfolio.com/collection/1-support-articles","articleCount":81,"publishedArticleCount":76,"createdBy":20055,"updatedBy":20055,"createdAt":"2013-10-21T22:30:23Z","updatedAt":"2014-02-04T01:22:10Z"},{"id":"52f03fb4e4b078f4bda9a70f","siteId":"5265aaffe4b0d77ef66a525d","number":83,"slug":"internal-articles","visibility":"private","order":1,"name":"Internal
45
+ articles","description":null,"publicUrl":"http://help.guestfolio.com/collection/83-internal-articles","articleCount":10,"publishedArticleCount":10,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-02-04T01:17:40Z","updatedAt":"2014-02-04T01:17:45Z"},{"id":"5339e556e4b0cf4cd6580478","siteId":"5339e189e4b0cf4cd6580473","number":99,"slug":"general","visibility":"public","order":1,"name":"General","description":"","publicUrl":"http://help.lasso.in/collection/99-general","articleCount":2,"publishedArticleCount":2,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-03-31T21:59:50Z","updatedAt":"2014-03-31T22:00:44Z"},{"id":"540221e9e4b019254d1ec25b","siteId":"540221a1e4b019254d1ec25a","number":145,"slug":"collection","visibility":"public","order":1,"name":"Collection","description":"","publicUrl":"http://rubydocsapi.helpscoutdocs.com/collection/145-collection","articleCount":2,"publishedArticleCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-30T19:11:37Z","updatedAt":"2014-08-30T19:36:56Z"}]}}'
46
+ http_version:
47
+ recorded_at: Sun, 31 Aug 2014 19:02:52 GMT
48
+ recorded_with: VCR 2.9.0