help-scout-docs 0.1

data/lib/help_scout_docs/error/options_error.rb

@@ -0,0 +1,6 @@
+module HelpScoutDocs
+  class Error
+    class OptionsError < Error
+    end
+  end
+end

data/lib/help_scout_docs/error/parser_error.rb

@@ -0,0 +1,6 @@
+module HelpScoutDocs
+  class Error
+    class ParserError < Error
+    end
+  end
+end

data/lib/help_scout_docs/error/resource_not_found_error.rb

@@ -0,0 +1,6 @@
+module HelpScoutDocs
+  class Error
+    class ResourceNotFoundError < Error
+    end
+  end
+end

data/lib/help_scout_docs/method.rb

@@ -0,0 +1,54 @@
+module HelpScoutDocs
+  class Method
+    extend Forwardable
+    attr_accessor :method, :client, :options
+
+    def initialize(client=nil, options={})
+      @options ||= options
+      @client = client || initialize_client
+    end
+
+    def_delegator :@client, :get, :get_request
+    def_delegator :@client, :post, :post_request
+    def_delegator :@client, :path
+
+    # Delegate to a HelpScoutDocs::Client
+    #
+    # @return [HelpScoutDocs::Client]
+    #
+    def initialize_client
+      @client = HelpScoutDocs::Client.new(@options) unless defined?(@client) && @client.hash == @options.hash
+      @client
+    end
+
+    # Has a client been initialized?
+    #
+    # @return [Boolean]
+    #
+    def client?
+      !!@client
+    end
+
+    private
+
+    # If we're providing the client, the endpoint may need to be reset set
+    # @param [Client]
+    # @return [Client]
+    #
+    def set_endpoint(endpoint)
+      @client.instance_variable_set("@endpoint", endpoint)
+    end
+
+    # Are all the required params here?
+    # @param [Hash]
+    # @param [Array<Symbol>]
+    # @return [Boolean]
+    #
+    def validate_options(options, attrs)
+      matched_attrs = options.keys & attrs
+      if matched_attrs.to_set != attrs.to_set
+        raise HelpScoutDocs::Error::OptionsError.new("#{(attrs - matched_attrs).join(", ")} required options are missing")
+      end
+    end
+  end
+end

data/lib/help_scout_docs/methods/article.rb

@@ -0,0 +1,45 @@
+module HelpScoutDocs
+  class Article < HelpScoutDocs::Method
+
+    # List all articles
+    def list(id, type=:category, options={})
+      public_send(:"list_by_#{type}", id, options)
+    end
+
+    # List all articles
+    #
+    def list_by_category(category_id, options={})
+      get_request("categories/#{category_id}/articles", options)
+    end
+
+    # List all articles
+    #
+    def list_by_collection(collection_id, options={})
+      get_request("collections/#{collection_id}/articles", options)
+    end
+
+    # Get an article
+    #
+    def get(id, options={})
+      get_request("articles/#{id}", options)
+    end
+
+    # Get a related articles
+    #
+    def related(id, options={})
+      get_request("articles/#{id}/related", options)
+    end
+
+    # Get a article's revisions
+    #
+    def revisions(id, options={})
+      get_request("articles/#{id}/revisions", options)
+    end
+
+    # Get a article's revision
+    #
+    def get_revision(id, options={})
+      get_request("revisions/#{id}", options)
+    end
+  end
+end

data/lib/help_scout_docs/methods/category.rb

@@ -0,0 +1,16 @@
+module HelpScoutDocs
+  class Category < HelpScoutDocs::Method
+    # List categories
+    #
+    def list(collection_id, options={})
+      get_request("collections/#{collection_id}/categories", options)
+    end
+    alias :by_collection :list
+
+    # Get a category
+    #
+    def get(id, options={})
+      get_request("categories/#{id}", options)
+    end
+  end
+end

data/lib/help_scout_docs/methods/collection.rb

@@ -0,0 +1,15 @@
+module HelpScoutDocs
+  class Collection < HelpScoutDocs::Method
+    # List collections
+    #
+    def list(options={})
+      get_request("collections", options)
+    end
+
+    # Get a collection
+    #
+    def get(id, options={})
+      get_request("collections/#{id}", options)
+    end
+  end
+end

data/lib/help_scout_docs/methods/methods.rb

@@ -0,0 +1,6 @@
+require 'help_scout_docs/method'
+require 'help_scout_docs/methods/article'
+require 'help_scout_docs/methods/category'
+require 'help_scout_docs/methods/collection'
+require 'help_scout_docs/methods/site'
+

data/lib/help_scout_docs/methods/site.rb

@@ -0,0 +1,15 @@
+module HelpScoutDocs
+  class Site < HelpScoutDocs::Method
+    # List sites
+    #
+    def list(options={})
+      get_request("sites", options)
+    end
+
+    # Get a site
+    #
+    def get(id, options={})
+      get_request("sites/#{id}", options)
+    end
+  end
+end

data/lib/help_scout_docs/response/parse_json.rb

@@ -0,0 +1,33 @@
+require 'faraday_middleware'
+require 'json/ext'
+
+module HelpScoutDocs
+  module Response
+    class ParseJson < ::FaradayMiddleware::ParseJson
+      def on_complete(env)
+        status = env[:status]
+        if status == 403 || status == 401
+          error = env[:body].fetch(:error, "Unknown Help Scout Docs API error")
+          raise Error::AuthenticationError.new(error)
+        elsif status == 404
+          raise Error::ResourceNotFoundError.new("Help Scout Docs Not found")
+        elsif status =~ /^5/
+          raise Error::ApiException.new("Help Scout Docs call unsuccessful. Try again later.")
+        end
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |environment|
+          environment[:body] = parse(environment[:body])
+          on_complete(environment)
+        end
+      end
+
+      private
+
+      def parse(body)
+        JSON.parse(body, symbolize_names: true)
+      end
+    end
+  end
+end

data/lib/help_scout_docs/result.rb

@@ -0,0 +1,31 @@
+module HelpScoutDocs
+  class Result
+    attr_reader :response
+
+    # Initialize a new Response, throw exception for fatal errors
+    # @param [Hash] result
+    #
+    def initialize(response)
+      @response = response
+    end
+
+    # Was it successful?
+    # @return [Boolean]
+    #
+    def success?
+      !error?
+    end
+
+    # Was there an error?
+    # @return [Boolean]
+    #
+    def error?
+      response.is_a?(Hash) ? response.has_key?(:status) : false
+    end
+
+    def message
+      return unless error?
+      response.fetch(:message)
+    end
+  end
+end

data/lib/help_scout_docs/version.rb

@@ -0,0 +1,3 @@
+module HelpScoutDocs
+  VERSION = "0.1"
+end

data/spec/cassettes/HelpScoutDocs_Article/_get/should_return_the_article.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/articles/54027853e4b019254d1ec268
+    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:48 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:
+      - '331'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"article":{"id":"54027853e4b019254d1ec268","number":149,"collectionId":"540221e9e4b019254d1ec25b","slug":"article","status":"notpublished","hasDraft":true,"name":"Article","text":"<p>Revision</p>","categories":["540227d7e4b003be53bdcd28"],"related":null,"publicUrl":"http://rubydocsapi.helpscoutdocs.com/article/149-article","popularity":0.0,"keywords":null,"viewCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-31T01:20:19Z","updatedAt":"2014-08-31T02:48:48Z","lastPublishedAt":null}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:48 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/HelpScoutDocs_Article/_get/when_using_an_id/should_return_the_article.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/articles/54027853e4b019254d1ec268
+    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:48 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:
+      - '331'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"article":{"id":"54027853e4b019254d1ec268","number":149,"collectionId":"540221e9e4b019254d1ec25b","slug":"article","status":"notpublished","hasDraft":true,"name":"Article","text":"<p>Revision</p>","categories":["540227d7e4b003be53bdcd28"],"related":null,"publicUrl":"http://rubydocsapi.helpscoutdocs.com/article/149-article","popularity":0.0,"keywords":null,"viewCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-31T01:20:19Z","updatedAt":"2014-08-31T02:48:48Z","lastPublishedAt":null}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:48 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/HelpScoutDocs_Article/_list_by_category/should_return_the_list_of_articles_by_category.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/categories/540227d7e4b003be53bdcd28/articles
+    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:47 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:
+      - '292'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"articles":{"page":1,"pages":1,"count":1,"items":[{"id":"54027853e4b019254d1ec268","number":149,"collectionId":"540221e9e4b019254d1ec25b","slug":"article","status":"notpublished","hasDraft":true,"name":"Article","publicUrl":"http://rubydocsapi.helpscoutdocs.com/article/149-article","popularity":0.0,"viewCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-31T01:20:19Z","updatedAt":"2014-08-31T02:48:48Z","lastPublishedAt":null}]}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:47 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/HelpScoutDocs_Article/_list_by_collection/should_return_the_list_of_articles_by_collection.yml

@@ -0,0 +1,47 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/collections/540221e9e4b019254d1ec25b/articles
+    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:47 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:
+      - '360'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"articles":{"page":1,"pages":1,"count":2,"items":[{"id":"54027853e4b019254d1ec268","number":149,"collectionId":"540221e9e4b019254d1ec25b","slug":"article","status":"notpublished","hasDraft":true,"name":"Article","publicUrl":"http://rubydocsapi.helpscoutdocs.com/article/149-article","popularity":0.0,"viewCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-31T01:20:19Z","updatedAt":"2014-08-31T02:48:48Z","lastPublishedAt":null},{"id":"54028cf8e4b003be53bdcd2e","number":150,"collectionId":"540221e9e4b019254d1ec25b","slug":"another-article","status":"notpublished","hasDraft":false,"name":"Another
+        article","publicUrl":"http://rubydocsapi.helpscoutdocs.com/article/150-another-article","popularity":0.0,"viewCount":0,"createdBy":20055,"updatedBy":20055,"createdAt":"2014-08-31T02:48:24Z","updatedAt":"2014-08-31T02:48:31Z","lastPublishedAt":"2014-08-31T02:48:31Z"}]}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:47 GMT
+recorded_with: VCR 2.9.0

data/spec/cassettes/HelpScoutDocs_Article/_related/should_return_related_articles.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<api-key>:<api-password>@docsapi.helpscout.net/v1/articles/54027853e4b019254d1ec268/related
+    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:48 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:
+      - '66'
+      "<api-password>-Frame-Options":
+      - SAMEORIGIN
+    body:
+      encoding: UTF-8
+      string: '{"articles":{"page":1,"pages":1,"count":0,"items":[]}}'
+    http_version: 
+  recorded_at: Sun, 31 Aug 2014 19:02:49 GMT
+recorded_with: VCR 2.9.0