guidepost 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f49ae1e903b58b082d906af364a401237248bab317489daf80b8a431d33ea6b
-  data.tar.gz: 9da9ee9ed5892c403f0908e34891af82e9a9666419290354e30b9642a36502eb
+  metadata.gz: 4f751016d58b199dc4f795e66092ef5b541a4a26e58d2620e1828013796a4e8b
+  data.tar.gz: d0362d142673a44382cede84737194c4ee0c68d6f89054794fee6a6ce83c4af5
 SHA512:
-  metadata.gz: 40fa25c5cab3b25c0df32da32ed7fd6bdd1bab0b790a8c0f78d20bfaccd2830a47f11e54942d96347e06574f2cb538c94ce7cbdda84e8c768374c089547aa3d6
-  data.tar.gz: 7f090b43f12e5927137dad0e147754ab53e2d444173cb839affcb8fffb2abc78aa45b6db2722a136a63eb147e4979f66f56153a2e8e7874a1693574651ac36f6
+  metadata.gz: dddd913919db07e788a0dc969df5eefa0cf2e36c91c9c163b1dece16285c9b3a81c126382852cd59db94adeb67ac0d8f700a42b21e518995fd2cda5c56172f66
+  data.tar.gz: 276fc86844018b06092130749d0fb7936e348b79573c7b56414130a3473b974c4e6324153042ddf730e57b75be485b8c5e724ef769c6f8b6014e0ee22bde567e

data/README.md

@@ -60,7 +60,7 @@ Make sure to have certain environmental variables set, preferrably in your `.bas
 ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_ZENDESK_EMAIL"]
 
 # The password token associated with your Zendesk subdomain
-ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_PASSWORD_TOKEN"]
+ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_ZENDESK_PASSWORD_TOKEN"]
 ```
 
 #### S3

data/lib/generators/guidepost/templates/zendesk_guide_article_attachment.rb

@@ -37,7 +37,7 @@ class ZendeskGuideArticleAttachment < ActiveRecord::Base
             article_objects.each do |a|
                 is_correct_article = (article_attachment.article_id == a.article_id)
                 if is_correct_article
-                    article_attachment.zendesk_guide_article = co
+                    article_attachment.zendesk_guide_article = a
                     article_attachment.save
                     break
                 end

data/lib/guidepost.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-s3'
 require 'cgi'
 require 'json'
 require 'net/http'
@@ -13,4 +13,4 @@ module Guidepost
         autoload :S3,       'guidepost/storage/s3'
     end
     
-end
+end

data/lib/guidepost/provider/zendesk.rb

@@ -1,6 +1,8 @@
 module Guidepost
     module Provider
         class Zendesk
+            require 'uri'
+
             attr_reader :subdomain
             attr_reader :project_name
 
@@ -21,7 +23,8 @@ module Guidepost
                 query = options.fetch(:query, "")
                 return [] if query.empty?
 
-                url = "#{self.base_api_url}/help_center/articles/search.json?query=#{query}&per_page=10"
+                url = "#{self.base_api_url}/help_center/articles/search.json?query=#{URI::encode(query)}&per_page=10"
+                url += "&locale=#{options[:locale]}" if !options[:locale].nil? && !options[:locale].empty?
                 uri = URI.parse(url)
         
                 http = Net::HTTP.new(uri.host, uri.port)
@@ -52,33 +55,45 @@ module Guidepost
             def backup_all_articles(options={})
                 # Get all articles (with pagination)
                 sideload = options[:sideload] || false
-                articles = self.retrieve_all_articles(sideload: sideload)
+                all_locales = options[:all_locales] || true
+                articles = self.retrieve_all_articles(sideload: sideload, all_locales: all_locales)
         
                 # Upload to S3
                 timestamp = Time.now.strftime('%Y%m%d%H%M%S')
 
                 filename = "#{timestamp}"
                 filename += "_with_sideload" if sideload
-                @storage.upload_file(path: "zendesk/article_backups/#{filename}.json", string_content: articles.to_json)
+                @storage.upload_file(path: "zendesk/#{@subdomain}/article_backups/#{filename}.json", string_content: articles.to_json)
         
                 articles.count
             end
         
             def retrieve_all_articles(options={})
                 sideload = options[:sideload] || false
+                all_locales = options[:all_locales] || true
+
                 page_next = nil
                 articles = []
                 article_attachments = nil
 
+                locales = (self.retrieve_all_locales || []).map{|locale_json| locale_json['locale'] } if all_locales
+                locales = [''] if locales.nil? || locales.empty?
+
                 if !sideload
-                    while true
-                        page_articles, page_next = self.retrieve_articles(url: page_next)
-                        break if page_articles.nil? || page_articles.empty?
-                        articles += page_articles
-                        break if page_next.nil?
-                    end
+                    article_attachments = []
+                    locales.each do |locale|
+                        page_next = nil
+                        locale_articles = []
+                        while true
+                            page_articles, page_next = self.retrieve_articles(url: page_next, locale: locale)
+                            break if page_articles.nil? || page_articles.empty?
+                            locale_articles += page_articles
+                            break if page_next.nil?
+                        end
+                        articles += locale_articles
 
-                    article_attachments = self.retrieve_all_article_attachments(articles: articles)
+                        article_attachments += self.retrieve_all_article_attachments(articles: locale_articles, locale: locale)
+                    end
 
                     return {
                         articles: articles,
@@ -89,50 +104,57 @@ module Guidepost
                 else
                     sections = []
                     categories = []
+                    article_attachments = []
 
                     section_urls = Hash.new
                     category_urls = Hash.new
 
-                    while true
-                        page, page_next = self.retrieve_articles(url: page_next, sideload: true)
+                    locales.each do |locale|
+                        page_next = nil
+                        locales_articles = []
+
+                        while true
+                            page, page_next = self.retrieve_articles(url: page_next, sideload: true, locale: locale)
 
-                        articles_from_page = page["articles"]
-                        sections_from_page = page["sections"]
-                        categories_from_page = page["categories"]
+                            articles_from_page = page["articles"]
+                            sections_from_page = page["sections"]
+                            categories_from_page = page["categories"]
 
-                        no_more_articles = articles_from_page.nil? || articles_from_page.empty?
-                        no_more_sections = sections_from_page.nil? || sections_from_page.empty?
-                        no_more_categories = categories_from_page.nil? || categories_from_page.empty?
+                            no_more_articles = articles_from_page.nil? || articles_from_page.empty?
+                            no_more_sections = sections_from_page.nil? || sections_from_page.empty?
+                            no_more_categories = categories_from_page.nil? || categories_from_page.empty?
 
-                        break if no_more_articles && no_more_sections && no_more_categories
+                            break if no_more_articles && no_more_sections && no_more_categories
 
-                        articles += articles_from_page
+                            locales_articles += articles_from_page
 
-                        sections_from_page.each do |s|
-                            url = s["url"]
-                            if !section_urls.has_key?(url)
-                                section_urls[url] = 1
-                            else
-                                section_urls[url] += 1
+                            sections_from_page.each do |s|
+                                url = s["url"]
+                                if !section_urls.has_key?(url)
+                                    section_urls[url] = 1
+                                else
+                                    section_urls[url] += 1
+                                end
+                                sections << s if section_urls[url] == 1
                             end
-                            sections << s if section_urls[url] == 1
-                        end
 
-                        categories_from_page.each do |c|
-                            url = c["url"]
-                            if !category_urls.has_key?(url)
-                                category_urls[url] = 1
-                            else
-                                category_urls[url] += 1
+                            categories_from_page.each do |c|
+                                url = c["url"]
+                                if !category_urls.has_key?(url)
+                                    category_urls[url] = 1
+                                else
+                                    category_urls[url] += 1
+                                end
+                                categories << c if category_urls[url] == 1
                             end
-                            categories << c if category_urls[url] == 1
-                        end
 
-                        break if page_next.nil?
+                            break if page_next.nil?
+                        end
+                        articles += locales_articles
+                        
+                        article_attachments += self.retrieve_all_article_attachments(articles: locales_articles, locale: locale)
                     end
 
-                    article_attachments = self.retrieve_all_article_attachments(articles: articles)
-
                     return { 
                         categories: categories, 
                         category_count: categories.count, 
@@ -148,12 +170,13 @@ module Guidepost
         
             def retrieve_articles(options={})
                 url = options[:url]
+                locale = (options[:locale] || "").downcase
                 sideload = options[:sideload] || false
 
                 if !sideload
-                    url = "#{self.base_api_url}/help_center/articles.json?per_page=25&page=1" if url.nil?
+                    url = "#{self.base_api_url}/help_center/#{locale}/articles.json?per_page=25&page=1" if url.nil?
                 else
-                    url = "#{self.base_api_url}/help_center/articles.json?include=sections,categories&per_page=25&page=1" if url.nil?
+                    url = "#{self.base_api_url}/help_center/#{locale}/articles.json?include=sections,categories&per_page=25&page=1" if url.nil?
                 end
                 
                 uri = URI.parse(url)
@@ -252,7 +275,7 @@ module Guidepost
                 articles = options[:articles]
                 articles.each do |article|
                     while true
-                        attachments, next_page = self.retrieve_article_attachments(for_article: article)
+                        attachments, next_page = self.retrieve_article_attachments(for_article: article, url: next_page, locale: options[:locale])
                         break if attachments.nil? || attachments.empty?
                         article_attachments += attachments
                         break if next_page.nil?
@@ -263,9 +286,11 @@ module Guidepost
             end
 
             def retrieve_article_attachments(options={})
+                url = options[:url]
                 article = options[:for_article]
+                locale = (options[:locale] || "").downcase
 
-                url = "#{self.base_api_url}/help_center/articles/#{article["id"]}/attachments.json?per_page=25&page=1" if url.nil?
+                url = "#{self.base_api_url}/help_center/#{locale}/articles/#{article["id"]}/attachments.json?per_page=25&page=1" if url.nil?
                 uri = URI.parse(url)
         
                 http = Net::HTTP.new(uri.host, uri.port)
@@ -283,9 +308,81 @@ module Guidepost
                 return j_body["article_attachments"], j_body["next_page"]
             end
 
+            def retrieve_all_locales(options={})
+                locales = []
+                next_page = nil
+
+                while true
+                    tmp_locales, next_page = self.retrieve_locales(url: next_page)
+                    break if tmp_locales.nil? || tmp_locales.empty?
+                    locales += tmp_locales
+                    break if next_page.nil?
+                end
+
+                locales
+            end
+
+            def retrieve_locales(options={})
+                url = options[:url]
+
+                url = "#{self.base_api_url}/locales.json" if url.nil?
+                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)
+
+                return j_body["locales"], j_body["next_page"]
+            end
+
+            def retrieve_all_translations(options={})
+                translations = []
+                next_page = nil
+                article = options[:for_article]
+
+                while true
+                    tmp_translations, next_page = self.retrieve_translations(url: next_page, for_article: article)
+                    break if tmp_translations.nil? || tmp_translations.empty?
+                    translations += tmp_translations
+                    break if next_page.nil?
+                end
+
+                translations
+            end
+
+            def retrieve_translations(options={})
+                url = options[:url]
+                article = options[:for_article]
+
+                url = "#{self.base_api_url}/help_center/articles/#{article['id']}/translations.json" if url.nil?
+                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)
+
+                return j_body["translations"], j_body["next_page"]
+            end
+
             def base_api_url
                 "https://#{self.subdomain}.zendesk.com/api/v2"
             end
         end
     end 
-end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: guidepost
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Kiren Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-18 00:00:00.000000000 Z
+date: 2020-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1'
 description: Harness your knowledge base in your Rails applications
 email: srinitude@gmail.com
 executables: []
@@ -64,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Harness your knowledge base in your Rails applications