help-scout-docs 0.1

data/spec/cassettes/HelpScoutDocs_Site/_get/should_return_the_site.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/sites/540221a1e4b019254d1ec25a
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/json
+      Accept-Charset:
+      - utf-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 31 Aug 2014 19:02:54 GMT
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Authorization
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Type:
+      - application/json; charset=utf-8
+      Vary:
+      - Accept-Encoding,User-Agent
+      Content-Length:
+      - '355'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"site":{"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"}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:54 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/HelpScoutDocs_Site/_list/should_return_the_list_of_sites.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/sites
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+      Accept:
+      - application/json
+      Accept-Charset:
+      - utf-8
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Sun, 31 Aug 2014 19:02:53 GMT
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Authorization
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Type:
+      - application/json; charset=utf-8
+      Vary:
+      - Accept-Encoding,User-Agent
+      Content-Length:
+      - '1563'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      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
+        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'',
+        function (){\n  var li = document.createElement(''li'');\n  var a = document.createElement(''a'');\n  var
+        link = document.createTextNode(\"Contact Support\");\n  a.appendChild(link);\n  a.href
+        = \"http://support.guestfolio.com/contact\";\n  li.appendChild(a);\n  var
+        home = document.getElementById(\"home\");\n  home.parentNode.insertBefore(li,
+        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''
+        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''
+        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''
+        type=''text/css'' media=''all'' />\n<style>\nbody {\n  margin-top: 0;\n}\ndiv.navbar-inner
+        {\n  border-bottom: 1px solid #ddd;\n}\nh1, h2, h3 {\n  font-family: ''Source
+        Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n}\n#sidebar
+        h3 {\n  color: #00a9dc;\n  font-weight: 200;\n  line-height: 1.25;\n  margin-bottom:
+        8px;\n  font-size: 1.2em;\n}\np.lu {\n  font-size: 0.6em;\n  text-align: right;\n}\nol,
+        li, ul {\n  margin-left: 20px;\n}\n.navbar .nav a {\n  font-family: ''Source
+        Sans Pro'', ''Helvetica Neue'', Helvetica, Helvetica, Arial, sans-serif;\n  text-transform:
+        uppercase;\n  font-size: 17px;\n  color: #888;\n}\n.navbar .nav a:hover {\n  color:
+        #00a9dc;\n}\n\n</style>\n\n<script src=\"//cdn.sublimevideo.net/js/q4o9lqsy.js\"
+        type=\"text/javascript\"></script>","metaDescription":"Frequently asked questions
+        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"}]}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:53 GMT
+recorded_with: VCR 2.9.0

data/spec/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'json'
+
+module HelpScoutDocs
+  describe Client do
+    let(:config) {
+      {
+        api_key:      "api-key",
+        api_password: "api-password"
+      }
+    }
+
+    describe "#initialize" do
+      context "by default" do
+        it "should initialize a logger" do
+          expect(subject.logger).not_to be_nil
+        end
+      end
+
+      it "should allow the default attributes to be set" do
+        expect(Client.new(config).instance_variable_get("@api_key")).to eq config[:api_key]
+      end
+    end
+
+    describe "#get" do
+      it "should return back a result", :vcr do
+        expect(subject.get("sites")).to be_kind_of(Result)
+      end
+
+      context "with invalid authentication params", :vcr do
+        subject(:client) { Client.new(api_key: "invalid") }
+
+        it "should raise an exception" do
+          expect { subject.get("sites") }.to raise_error Error::AuthenticationError
+        end
+      end
+
+      context "with missing path params", :vcr do
+        it "should raise an exception" do
+          expect { subject.get(nil) }.to raise_error ArgumentError
+        end
+      end
+
+      context "with valid params", :vcr do
+        it "should call the requested method" do
+          result = subject.get("sites")
+          expect(result.success?).to be true
+          expect(result.response).to be_a_kind_of(Hash)
+        end
+      end
+
+      context "for a missing request", :vcr do
+        it "should raise an exception" do
+          expect{ subject.get("sites/1") }.to raise_error HelpScoutDocs::Error::ResourceNotFoundError
+        end
+      end
+
+      context "when the response cannot be parsed" do
+        it "should throw an exception and log the error" do
+          logger = double(:logger)
+          expect(logger).to receive(:error).with(an_instance_of(String)) do |error|
+            expect(error).to eq "Unable to parse Help Scout Docs API response: JSON::ParserError"
+          end
+          expect(logger).to receive(:debug)
+
+          subject = Client.new(config.merge(logger: logger))
+
+          expect_any_instance_of(Faraday::Connection).to receive(:get) { raise JSON::ParserError }
+          expect { subject.get("sites") }.to raise_error HelpScoutDocs::Error::ParserError
+        end
+      end
+    end
+
+    describe "#post" do
+      # See .get
+    end
+  end
+end

data/spec/method_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Method do
+    describe "#initialize" do
+      context "by default" do
+        it "should initialize a new client" do
+          expect(Method.new.client).to be_kind_of(Client)
+        end
+
+        it "should pass through options to the client" do
+          method = HelpScoutDocs::Method.new(nil, api_key: "api-key")
+          expect(method.client.instance_variable_get("@api_key")).to eq "api-key"
+        end
+
+        context "when the client is already initialized" do
+          let(:client) { Client.new }
+
+          it "should intiialize using the existing client" do
+            expect(Method.new(client).client).to eq client
+          end
+        end
+      end
+    end
+  end
+end

data/spec/methods/article_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Article do
+    let(:article_id)    { "54027853e4b019254d1ec268" }
+    let(:category_id)   { "540227d7e4b003be53bdcd28" }
+    let(:collection_id) { "540221e9e4b019254d1ec25b" }
+
+    describe "#list_by_category", :vcr do
+      it "should return the list of articles by category" do
+        articles = subject.list_by_category(category_id).response
+        expect(articles).to be_kind_of(Hash)
+        expect(articles).to have_key(:articles)
+      end
+    end
+
+    describe "#list_by_collection", :vcr do
+      it "should return the list of articles by collection" do
+        articles = subject.list_by_collection(collection_id).response
+        expect(articles).to be_kind_of(Hash)
+        expect(articles).to have_key(:articles)
+      end
+    end
+
+    describe "#list" do
+      it "should call #list_by_category by default" do
+        expect(subject).to receive(:list_by_category).with(category_id, {})
+        subject.list(category_id)
+      end
+
+      context "passing :collection as type" do
+        it "should call #list_by_collection" do
+          expect(subject).to receive(:list_by_collection).with(collection_id, {})
+          subject.list(collection_id, :collection)
+        end
+      end
+    end
+
+    describe "#get", :vcr do
+      it "should return the article" do
+        article = subject.get(article_id).response
+        expect(article).to be_kind_of(Hash)
+        expect(article).to have_key(:article)
+      end
+
+      context "when using an id" do
+        it "should return the article" do
+          article = subject.get(article_id).response
+          expect(article).to be_kind_of(Hash)
+          expect(article).to have_key(:article)
+        end
+      end
+    end
+
+    describe "#related", :vcr do
+      it "should return related articles" do
+        related = subject.related(article_id).response
+        expect(related).to be_kind_of(Hash)
+        expect(related).to have_key(:articles)
+      end
+    end
+
+    describe "#revisions", :vcr do
+      it "should return article revisions" do
+        revisions = subject.related(article_id).response
+        expect(revisions).to be_kind_of(Hash)
+        expect(revisions).to have_key(:articles)
+      end
+    end
+  end
+end

data/spec/methods/category_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Category do
+    let(:category_id)   { "540227d7e4b003be53bdcd28" }
+    let(:collection_id) { "540221e9e4b019254d1ec25b" }
+
+    describe "#list", :vcr do
+      it "should return the list of categories" do
+        categories = subject.list(collection_id).response
+        expect(categories).to be_kind_of(Hash)
+        expect(categories).to have_key(:categories)
+      end
+    end
+
+    describe "#get", :vcr do
+      it "should return the category" do
+        category = subject.get(category_id).response
+        expect(category).to be_kind_of(Hash)
+        expect(category).to have_key(:category)
+      end
+    end
+  end
+end

data/spec/methods/collection_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Collection do
+    describe "#list", :vcr do
+      it "should return the list of collections" do
+        collections = subject.list.response
+        expect(collections).to be_kind_of(Hash)
+        expect(collections).to have_key(:collections)
+      end
+    end
+
+    describe "#get", :vcr do
+      let(:collection_id) { "540221e9e4b019254d1ec25b" }
+
+      it "should return the collection" do
+        collection = subject.get(collection_id).response
+        expect(collection).to be_kind_of(Hash)
+        expect(collection).to have_key(:collection)
+      end
+    end
+  end
+end

data/spec/methods/site_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Site do
+    describe "#list", :vcr do
+      it "should return the list of sites" do
+        sites = subject.list.response
+        expect(sites).to be_kind_of(Hash)
+        expect(sites).to have_key(:sites)
+      end
+    end
+
+    describe "#get", :vcr do
+      let(:site_id) { "540221a1e4b019254d1ec25a" }
+
+      it "should return the site" do
+        site = subject.get(site_id).response
+        expect(site).to be_kind_of(Hash)
+        expect(site).to have_key(:site)
+      end
+    end
+  end
+end

data/spec/result_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module HelpScoutDocs
+  describe Result do
+    describe "#success?" do
+      it "should return true for a successful response" do
+        expect(Result.new({message: "success"}).success?).to be true
+      end
+
+      it "should return false for an unsuccessful response" do
+        expect(Result.new({status: "401"}).success?).to be false
+      end
+    end
+
+    describe "#message" do
+      it "should return the error message for a failed response" do
+        expect(Result.new({status: "404", message: "Message"}).message).to eq "Message"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+ENV['HELP_SCOUT_DOCS_API_KEY'] = "api-key";
+
+require 'help_scout_docs'
+require 'webmock'
+require 'multi_json'
+require 'vcr'
+require 'pry'
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('<api-key>')      { ENV['HELP_SCOUT_DOCS_API_KEY'] }
+  c.filter_sensitive_data('<api-password>') { "X" }
+  c.configure_rspec_metadata!
+end
+
+Log4r::Logger.global.outputters = Log4r::Outputter.stdout

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: help-scout-docs
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Mark Edmondson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: This limited (read-only) Help Scout Docs API integration provides functionality
+  for extracting existing documentation content
+email:
+- mark@guestfolio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- help_scout_docs.gemspec
+- lib/help_scout_docs.rb
+- lib/help_scout_docs/client.rb
+- lib/help_scout_docs/configurable.rb
+- lib/help_scout_docs/default.rb
+- lib/help_scout_docs/error.rb
+- lib/help_scout_docs/error/authentication_error.rb
+- lib/help_scout_docs/error/configuration_error.rb
+- lib/help_scout_docs/error/errors.rb
+- lib/help_scout_docs/error/options_error.rb
+- lib/help_scout_docs/error/parser_error.rb
+- lib/help_scout_docs/error/resource_not_found_error.rb
+- lib/help_scout_docs/method.rb
+- lib/help_scout_docs/methods/article.rb
+- lib/help_scout_docs/methods/category.rb
+- lib/help_scout_docs/methods/collection.rb
+- lib/help_scout_docs/methods/methods.rb
+- lib/help_scout_docs/methods/site.rb
+- lib/help_scout_docs/response/parse_json.rb
+- lib/help_scout_docs/result.rb
+- lib/help_scout_docs/version.rb
+- spec/cassettes/HelpScoutDocs_Article/_get/should_return_the_article.yml
+- spec/cassettes/HelpScoutDocs_Article/_get/when_using_an_id/should_return_the_article.yml
+- spec/cassettes/HelpScoutDocs_Article/_list_by_category/should_return_the_list_of_articles_by_category.yml
+- spec/cassettes/HelpScoutDocs_Article/_list_by_collection/should_return_the_list_of_articles_by_collection.yml
+- spec/cassettes/HelpScoutDocs_Article/_related/should_return_related_articles.yml
+- spec/cassettes/HelpScoutDocs_Article/_revisions/should_return_article_revisions.yml
+- spec/cassettes/HelpScoutDocs_Category/_get/should_return_the_category.yml
+- spec/cassettes/HelpScoutDocs_Category/_list/should_return_the_list_of_categories.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/for_a_missing_request/should_raise_an_exception.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/should_return_back_a_result.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/with_invalid_authentication_params/should_raise_an_exception.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/with_valid_params/should_call_the_requested_method.yml
+- spec/cassettes/HelpScoutDocs_Collection/_get/should_return_the_collection.yml
+- spec/cassettes/HelpScoutDocs_Collection/_list/should_return_the_list_of_collections.yml
+- spec/cassettes/HelpScoutDocs_Site/_get/should_return_the_site.yml
+- spec/cassettes/HelpScoutDocs_Site/_list/should_return_the_list_of_sites.yml
+- spec/client_spec.rb
+- spec/method_spec.rb
+- spec/methods/article_spec.rb
+- spec/methods/category_spec.rb
+- spec/methods/collection_spec.rb
+- spec/methods/site_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Guestfolio/help-scout-docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Integration with Help Scout Docs API
+test_files:
+- spec/cassettes/HelpScoutDocs_Article/_get/should_return_the_article.yml
+- spec/cassettes/HelpScoutDocs_Article/_get/when_using_an_id/should_return_the_article.yml
+- spec/cassettes/HelpScoutDocs_Article/_list_by_category/should_return_the_list_of_articles_by_category.yml
+- spec/cassettes/HelpScoutDocs_Article/_list_by_collection/should_return_the_list_of_articles_by_collection.yml
+- spec/cassettes/HelpScoutDocs_Article/_related/should_return_related_articles.yml
+- spec/cassettes/HelpScoutDocs_Article/_revisions/should_return_article_revisions.yml
+- spec/cassettes/HelpScoutDocs_Category/_get/should_return_the_category.yml
+- spec/cassettes/HelpScoutDocs_Category/_list/should_return_the_list_of_categories.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/for_a_missing_request/should_raise_an_exception.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/should_return_back_a_result.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/with_invalid_authentication_params/should_raise_an_exception.yml
+- spec/cassettes/HelpScoutDocs_Client/_get/with_valid_params/should_call_the_requested_method.yml
+- spec/cassettes/HelpScoutDocs_Collection/_get/should_return_the_collection.yml
+- spec/cassettes/HelpScoutDocs_Collection/_list/should_return_the_list_of_collections.yml
+- spec/cassettes/HelpScoutDocs_Site/_get/should_return_the_site.yml
+- spec/cassettes/HelpScoutDocs_Site/_list/should_return_the_list_of_sites.yml
+- spec/client_spec.rb
+- spec/method_spec.rb
+- spec/methods/article_spec.rb
+- spec/methods/category_spec.rb
+- spec/methods/collection_spec.rb
+- spec/methods/site_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true