guidepost 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82358c2aedf2cf4ff5be38ecadf44b320a3ceb57b708f3693726b160710fcb3e
-  data.tar.gz: 4cf42bd484d7d14a18b30acac71aca261fc54f4b624626beaaf0b835046d16af
+  metadata.gz: 12d91bd8f27f00b6c1115101abff0049121815b70fd4a1223518eafdd17cb138
+  data.tar.gz: c42f368aebda8b3f19acf800010202918726e03d34c37156ff0bbc8fbe0ebc1a
 SHA512:
-  metadata.gz: 23195e608a8a0deb9764da52ef4c347dfdb4143aa2655a703230a25986260548f2d0b00956fe125ea64f6861c0ae3d70779fb36be044f1610690309b64933c39
-  data.tar.gz: faf2a13bafd4990077c3b341cf3b91cb65b5dee4f06a0828abad7590ab2eb5076629edb017251b7ee5255720c5007c95ffa388bf3322729f5238e3e6216a8ecd
+  metadata.gz: 25fcf491c96d16b379a4c2c1adf57d474c48ed607eb2bf790a5bd7f6654a1155165aee66b7192f8cf942cad1502aa04557a83ba0c8cd2734e16765b06e4a976f
+  data.tar.gz: 354413ea4349e1042f51ea1952c941670dc922971cfb9f5ba0f337dea797a6b624f17ab24e5947c8aded1c9352dc7574824549be19171c3ed8a028ed98cc7183

data/README.md

@@ -10,6 +10,7 @@ Your knowledge base is an incredibly important component of your company, provid
 
 * [Back up your knowledge base to S3](#back-up-your-knowledge-base-to-s3)
 * [Import your knowledge base into your application](#import-your-knowledge-base-into-your-application)
+* [Search your knowledge base with keywords](#search-your-knowledge-base-with-keywords)
 
 ## Table of Contents
 
@@ -114,6 +115,22 @@ zendesk.backup_all_articles(sideload: true)
 
     $ rake zendesk_guide:import_guides_into_database[spotify,employee-portal]
 
+#### Search your knowledge base with keywords
+
+```ruby
+# The subdomain of your Zendesk account
+subdomain = "spotify"
+
+# The name you want to give to your project (name your environment variables accordingly)
+project_name = "employee-portal"
+
+# The keyword(s) you're searching for in articles
+query = "analytics"
+
+zendesk = Guidepost::Provider::Zendesk.new(subdomain: subdomain, project_name: project_name)
+zendesk.search(query: query)
+```
+
 ## Contact
 
 If you find and want to address any security issues with the project, email [me](mailto:srinitude@gmail.com.com)! For anything else, like bug identifications or feature requests, feel free to file a Github issue or tweet me [@srinitude](https://twitter.com/srinitude).

data/lib/guidepost/provider/zendesk.rb

@@ -17,6 +17,38 @@ module Guidepost
                 @password = ENV["#{@project_name}_GUIDEPOST_ZENDESK_PASSWORD_TOKEN"]
             end
 
+            def search(options={})
+                query = options.fetch(:query, "")
+                return [] if query.empty?
+
+                url = "#{self.base_api_url}/help_center/articles/search.json?query=#{query}&per_page=5"
+                uri = URI.parse(url)
+        
+                http = Net::HTTP.new(uri.host, uri.port)
+                http.use_ssl = true
+                http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        
+                request = Net::HTTP::Get.new(uri.request_uri)
+                request.basic_auth(@email, @password)
+                response = http.request(request)
+        
+                body = response.body.force_encoding("UTF-8")
+
+                j_body = JSON.parse(body)
+                results = j_body.fetch("results", [])
+                
+                slimmed_down_results = results.map do |result|
+                    slimmed_down_result = Hash.new
+                    slimmed_down_result[:id] = result["id"]
+                    slimmed_down_result[:title] = result["title"]
+                    slimmed_down_result[:snippet] = result["snippet"]
+
+                    slimmed_down_result
+                end
+
+                slimmed_down_results
+            end
+
             def backup_all_articles(options={})
                 # Get all articles (with pagination)
                 sideload = options[:sideload] || false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guidepost
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Kiren Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk