guidepost 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62c2acd52325cb79660d168c94639ece0246665293d8d5a4008b2798e64b9f73
-  data.tar.gz: 71e6410cfad4f1c49f2308d7b8a5354637b1da7cef6e2050731dc8958502fa2d
+  metadata.gz: 07224025b0722a20214c83ebac582ad2598712479e6b0bf70d42865a1e565128
+  data.tar.gz: fa6d4711fcd19040e8bf34c2c61387eea7439e96990ff546443cc0bb4e414d55
 SHA512:
-  metadata.gz: d8032ff476ee49c7898db53d35b3e66b25734a855a53c6fefd29ae0a74662b795a5cc38a0edefddc4e78fd754270fdb29223b94e291c645579d8d44e4ba450ec
-  data.tar.gz: 28a241a4912b8d3f830323a63678c521b4547069df32e370cdd9631ac8d2db176d7446ce2e5436baf4c2ac3e5103d71d74af45cf21d0e680812fe5d17d7c15fc
+  metadata.gz: f404c59049be377e6c220ac4e9cd14333573f10334b0613fd7d7ee65952fdd9514433576a9a21a2fd8b6d46b0d8dbfda4f61e3149b0c0448a2c4806132b4eb79
+  data.tar.gz: c69162e260001336487daf9c15f17f5f2bea96c65c2d97233c8783edda667e96816f65a262924e4d67d1cbb30780a8c09e9e897bdfdee2f7e0b946175530090d

data/README.md

@@ -1,17 +1,24 @@
 # Guidepost
 
+[![Gem Version](https://badge.fury.io/rb/guidepost.svg)](https://badge.fury.io/rb/guidepost)
+
 ## Purpose
 
-Your knowledge base is a hugely important component of your company! The purpose of this project is to help you gain more control over it.
+Your knowledge base is an incredibly important component of your company, providing value to your customers, employees, and other stakeholders! The purpose of this project is to help you gain more control over it.
+
+## Current Use Cases
+
+* [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)
 
 ## Table of Contents
 
 * [Prerequisites/Requirements](#prerequisites-requirements)
-* [Current Knowledge Base Providers](#current-knowledge-base-providers)
-* [Current Storage Services](#current-storage-services)
+* [Knowledge Base Providers](#knowledge-base-providers)
+* [Storage Services](#storage-services)
 * [Installation](#installation)
 * [Environment Variables](#environment-variables)
-* [Current Use Cases](#current-use-cases)
+* [Usage](#usage)
 * [Contact](#contact)
 * [Roadmap](#roadmap)
 * [License](#license)
@@ -21,18 +28,14 @@ Your knowledge base is a hugely important component of your company! The purpose
 * Rails 4.2+
 * Ruby 2.5+
 
-### Current Knowledge Base Providers
+### Knowledge Base Providers
 
 * Zendesk
 
-If you're looking to use this gem, but work with providers like Freshdesk, Zoho, and Confluence, feel free to reach out!
-
-### Current Storage Services
+### Storage Services
 
 * Amazon Simple Storage Service (Amazon S3)
 
-If you're looking to use this gem, but work with other storage services like Google Cloud Storage, feel free to reach out!
-
 ### Installation
 
 Add this line to your application's Gemfile:
@@ -68,27 +71,52 @@ ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_AWS_ACCESS_KEY_ID"]
 # The secret key associated with your AWS account
 ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_AWS_SECRET_ACCESS_KEY"]
 
+# The AWS region associated with this project
+ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_AWS_REGION"]
+
 # The name of the S3 bucket you want to upload your backups to
 ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_S3_BUCKET_NAME"]
 ```
 
-### Current Use Cases
-
-* Back up your knowledge base to S3
+### Usage
 
 #### Back up your knowledge base to S3
 
+##### Implement the backup functionality in your code
+
 ```ruby
-subdomain = "example"
-project_name = "example"
+# 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"
 
 zendesk = Guidepost::Provider::Zendesk.new(subdomain: subdomain, project_name: project_name)
-zendesk.backup_all_articles
+zendesk.backup_all_articles(sideload: true)
 ```
 
+##### Run a script outside of your codebase
+
+    $ rake zendesk_guide:backup_articles[spotify,employee-portal]
+
+#### Import your knowledge base into your application
+
+
+##### Generate all of the necessary model and migration files
+
+    $ rails g guidepost:models
+
+##### Perform all of the schema migrations
+
+    $ rails g guidepost:migrate
+
+##### Run a script outside of your codebase
+
+    $ rake zendesk_guide:import_guides_into_database[spotify,employee-portal]
+
 ## Contact
 
-If you find and want to address any security issues with the project, email [Kiren Srinivasan](mailto:srinitude@gmail.com.com)! For anything else, feel free to file a Github issue or tweet me [@srinitude](https://twitter.com/srinitude).
+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).
 
 ## Roadmap
 
@@ -98,4 +126,4 @@ If you find and want to address any security issues with the project, email [Kir
 
 ## License
 
-Guidepost is released under the [MIT License](LICENSE).
+Guidepost is released under the [MIT License](LICENSE).

data/lib/generators/guidepost/migrate_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators/base"
+
+module Guidepost
+    module Generators
+        
+        class MigrateGenerator < Rails::Generators::Base
+            desc "This generator performs the schema and data migrations associated with your current Zendesk guides"
+
+            def self.default_generator_root
+                File.dirname(__FILE__)
+            end
+
+            def schema_migration
+                `rake db:migrate`             
+            end
+        end
+
+    end
+end

data/lib/generators/guidepost/models_generator.rb

@@ -0,0 +1,35 @@
+require "rails/generators/base"
+
+module Guidepost
+    module Generators
+        
+        class ModelsGenerator < Rails::Generators::Base
+            desc "This generator creates the migrations, models, and tests associated with your current Zendesk guides"
+
+            def self.default_generator_root
+                File.dirname(__FILE__)
+            end
+
+            def migrations
+                timestamp = Time.now.strftime('%Y%m%d%H%M%S')
+                template "migrations.rb", "db/migrate/#{timestamp}_create_zendesk_guide_models.rb"
+                template "zendesk_guide.rake", "lib/tasks/zendesk_guide.rake"                
+            end
+
+            def models
+                model_templates = [
+                    "zendesk_guide_category.rb", 
+                    "zendesk_guide_section.rb", 
+                    "zendesk_guide_article.rb",
+                    "zendesk_guide_article_attachment.rb",
+                    "zendesk_guide_permission_group.rb",
+                    "zendesk_guide_user_segment.rb"
+                ]
+                model_templates.each do |t|
+                    template t, "app/models/#{t}"
+                end
+            end
+        end
+
+    end
+end

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

@@ -0,0 +1,95 @@
+class CreateZendeskGuideModels < ActiveRecord::Migration
+    def change
+        create_table :zendesk_guide_categories do |t|
+            t.integer :category_id, limit: 8
+            t.string :name, null: false, default: "General"
+            t.string :description
+            t.string :locale, null: false, default: "en-us"
+            t.string :source_locale
+            t.string :url
+            t.string :html_url
+            t.boolean :outdated
+            t.integer :position
+            t.timestamp :category_created_at
+            t.timestamp :category_updated_at
+        end
+
+        create_table :zendesk_guide_sections do |t|
+            t.integer :zendesk_guide_category_id
+            t.integer :category_id, limit: 8
+            t.integer :section_id, limit: 8
+            t.string :name, null: false, default: "General"
+            t.string :description
+            t.string :locale, null: false, default: "en-us"
+            t.string :source_locale
+            t.string :url
+            t.string :html_url
+            t.boolean :outdated
+            t.integer :position
+            t.timestamp :section_created_at
+            t.timestamp :section_updated_at
+        end
+
+        create_table :zendesk_guide_user_segments do |t|
+            t.integer :user_segment_id, limit: 8
+            t.string :name
+            t.string :user_type
+            t.integer :group_ids, array: true, default: [], limit: 8
+            t.integer :organization_ids, array: true, default: [], limit: 8
+            t.string :tags, array: true, default: []
+            t.timestamp :user_segment_created_at
+            t.timestamp :user_segment_updated_at
+        end
+
+        create_table :zendesk_guide_permission_groups do |t|
+            t.integer :permission_group_id, limit: 8
+            t.string :name
+            t.integer :edit, array: true, default: [], limit: 8
+            t.integer :publish, array: true, default: [], limit: 8
+            t.timestamp :permission_group_created_at
+            t.timestamp :permission_group_updated_at
+            t.boolean :built_in
+        end
+
+        create_table :zendesk_guide_articles do |t|
+            t.integer :zendesk_guide_section_id
+            t.integer :section_id, limit: 8
+            t.integer :article_id, limit: 8
+            t.string :url
+            t.string :html_url
+            t.string :title, null: false, default: "FAQ"
+            t.string :body
+            t.string :locale, null: false, default: "en-us"
+            t.string :source_locale
+            t.integer :author_id, limit: 8
+            t.boolean :comments_disabled, default: false
+            t.string :outdated_locales, array: true
+            t.string :label_names, array: true, default: []
+            t.boolean :draft, default: false
+            t.boolean :promoted, default: false
+            t.integer :position, default: 0
+            t.integer :vote_sum
+            t.integer :vote_count
+            t.integer :user_segment_id, limit: 8
+            t.integer :zendesk_guide_user_segment_id
+            t.integer :permission_group_id, limit: 8
+            t.integer :zendesk_guide_permission_group_id
+            t.timestamp :article_created_at
+            t.timestamp :article_edited_at
+            t.timestamp :article_updated_at
+        end
+
+        create_table :zendesk_guide_article_attachments do |t|
+            t.integer :zendesk_guide_article_id
+            t.integer :article_id, limit: 8
+            t.integer :article_attachment_id, limit: 8
+            t.string :url
+            t.string :file_name
+            t.string :content_url
+            t.integer :size, limit: 8
+            t.boolean :inline, default: false
+            t.timestamp :article_attachment_created_at
+            t.timestamp :article_attachment_updated_at
+        end
+    end
+end

data/lib/generators/guidepost/templates/zendesk_guide.rake

@@ -0,0 +1,70 @@
+namespace :zendesk_guide do
+
+    desc "Backup articles from knowledge base provider (i.e. Zendesk currently) [customize this task if you want to add more functionality]"
+    task :backup_articles, [:subdomain, :project_name] => :environment do |t, args|
+        begin
+            subdomain = args[:subdomain]
+            project_name = args[:project_name]
+
+            if subdomain.nil? || project_name.nil?
+                raise "Subdomain and/or project_name arguments are missing" if Rails.env.development?
+            end
+            
+            zendesk = Guidepost::Provider::Zendesk.new(subdomain: subdomain, project_name: project_name)
+            zendesk.backup_all_articles(sideload: true)
+        rescue => e
+            raise e if Rails.env.development?
+        end
+    end
+
+    desc "Import guides and respective models into database [customize this task if you want to add more functionality]"
+    task :import_guides_into_database, [:subdomain, :project_name] => :environment do |t, args|
+        begin
+            subdomain = args[:subdomain]
+            project_name = args[:project_name]
+
+            if subdomain.nil? || project_name.nil?
+                raise "Subdomain and/or project_name arguments are missing" if Rails.env.development?
+            end
+
+            zendesk = Guidepost::Provider::Zendesk.new(subdomain: subdomain, project_name: project_name)
+            articles_sections_and_categories = zendesk.retrieve_all_articles(sideload: true)
+
+            categories = articles_sections_and_categories[:categories]
+            category_objects = []
+            ZendeskGuideCategory.find_or_create_categories(categories: categories, category_objects: category_objects)
+
+            sections = articles_sections_and_categories[:sections]
+            section_objects = []
+            ZendeskGuideSection.find_or_create_sections(
+                sections: sections, 
+                section_objects: section_objects, 
+                category_objects: category_objects
+            )
+
+            user_segments = zendesk.retrieve_all_user_segments
+            user_segment_objects = []
+            ZendeskGuideUserSegment.find_or_create_user_segments(user_segments: user_segments, user_segment_objects: user_segment_objects)
+
+            permission_groups = zendesk.retrieve_all_permission_groups
+            permission_group_objects = []
+            ZendeskGuidePermissionGroup.find_or_create_permission_groups(permission_groups: permission_groups, permission_group_objects: permission_group_objects)
+
+            articles = articles_sections_and_categories[:articles]
+            article_objects = []
+            ZendeskGuideArticle.find_or_create_articles(
+                articles: articles,
+                article_objects: article_objects,
+                section_objects: section_objects,
+                user_segment_objects: user_segment_objects,
+                permission_group_objects: permission_group_objects
+            )                
+
+            article_attachments = zendesk.retrieve_all_article_attachments(articles: articles)
+            ZendeskGuideArticleAttachment.find_or_create_article_attachments(article_attachments: article_attachments, article_objects: article_objects)                
+        rescue => e
+            raise e if Rails.env.development?
+        end
+    end
+
+end

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

@@ -0,0 +1,95 @@
+class ZendeskGuideArticle < ActiveRecord::Base
+    belongs_to :zendesk_guide_section
+    belongs_to :zendesk_guide_user_segment
+    belongs_to :zendesk_guide_permission_group
+
+    has_many :zendesk_guide_article_attachments
+
+    validates :title, presence: true
+    validates :locale, presence: true
+
+    def self.find_or_create_articles(options={})
+        articles = options[:articles]
+        article_objects = options[:article_objects]
+        section_objects = options[:section_objects]
+        user_segment_objects = options[:user_segment_objects]
+        permission_group_objects = options[:permission_group_objects]
+        allowed_attributes = [
+            :section_id,
+            :article_id,
+            :url,
+            :html_url,
+            :title,
+            :body,
+            :locale,
+            :source_locale,
+            :author_id,
+            :comments_disabled, 
+            :outdated_locales,
+            :label_names,
+            :draft, 
+            :promoted, 
+            :position,
+            :vote_sum,
+            :vote_count,
+            :user_segment_id,
+            :permission_group_id,
+            :article_created_at,
+            :article_edited_at,
+            :article_updated_at
+        ]
+
+        articles.each do |a|
+            article_hash = a.clone
+
+            article_hash[:article_id] = article_hash["id"]
+            article_hash.delete("id")
+
+            article_hash[:article_created_at] = article_hash["created_at"]
+            article_hash.delete("created_at")
+
+            article_hash[:article_updated_at] = article_hash["updated_at"]
+            article_hash.delete("updated_at")
+
+            article_hash.symbolize_keys!
+
+            article_hash.each_key do |k|
+                article_hash.delete(k) if !allowed_attributes.include?(k)
+            end
+
+            article = ZendeskGuideArticle.where(article_id: article_hash[:article_id]).first
+            article.update(article_hash) if !article.nil?
+            article = ZendeskGuideArticle.create(article_hash) if article.nil?
+            
+            changed = false
+
+            section_objects.each do |so|
+                is_correct_section = (article.section_id == so.section_id)
+                if is_correct_section
+                    article.zendesk_guide_section = so
+                    changed = true
+                end
+            end
+
+            user_segment_objects.each do |us|
+                is_correct_user_segment = (article.user_segment_id == us.user_segment_id)
+                if is_correct_user_segment
+                    article.zendesk_guide_user_segment = us
+                    changed = true
+                end
+            end
+
+            permission_group_objects.each do |pg|
+                is_correct_permission_group = (article.permission_group_id == pg.permission_group_id)
+                if is_correct_permission_group
+                    article.zendesk_guide_permission_group = pg
+                    changed = true
+                end
+            end
+
+            article.save if changed
+
+            article_objects << article
+        end
+    end
+end

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

@@ -0,0 +1,47 @@
+class ZendeskGuideArticleAttachment < ActiveRecord::Base
+    belongs_to :zendesk_guide_article
+
+    def self.find_or_create_article_attachments(options={})
+        article_attachments = options[:article_attachments]
+        article_objects = options[:article_objects]
+        allowed_attributes = [
+            :article_id,
+            :article_attachment_id,
+            :url,
+            :file_name,
+            :content_url,
+            :size,
+            :inline,
+            :article_attachment_created_at,
+            :article_attachment_updated_at
+        ]
+
+        article_attachments.each do |aa|
+            article_attachment_hash = aa.clone
+
+            article_attachment_hash[:article_attachment_id] = article_attachment_hash["id"]
+            article_attachment_hash.delete("id")
+
+            article_attachment_hash[:article_attachment_created_at] = article_attachment_hash["created_at"]
+            article_attachment_hash.delete("created_at")
+
+            article_attachment_hash[:article_attachment_updated_at] = article_attachment_hash["updated_at"]
+            article_attachment_hash.delete("updated_at")
+
+            article_attachment_hash.symbolize_keys!
+
+            article_attachment = ZendeskGuideArticleAttachment.where(article_attachment_id: article_attachment_hash[:article_attachment_id]).first
+            article_attachment.update(article_attachment_hash) if !article_attachment.nil?
+            article_attachment = ZendeskGuideArticleAttachment.create(article_attachment_hash) if article_attachment.nil?
+            
+            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.save
+                    break
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,51 @@
+class ZendeskGuideCategory < ActiveRecord::Base
+    has_many :zendesk_guide_sections
+
+    validates :name, presence: true
+    validates :locale, presence: true
+    
+    def self.find_or_create_categories(options={})
+        categories = options[:categories]
+        category_objects = options[:category_objects]
+
+        allowed_attributes = [
+            :category_id,
+            :name,
+            :description,
+            :locale,
+            :source_locale,
+            :url,
+            :html_url,
+            :outdated,
+            :position,
+            :category_created_at,
+            :category_updated_at
+        ]
+
+        categories.each do |c|
+            category_hash = c.clone
+
+            category_hash[:category_id] = category_hash["id"]
+            category_hash.delete("id")
+
+            category_hash[:category_created_at] = category_hash["created_at"]
+            category_hash.delete("created_at")
+
+            category_hash[:category_updated_at] = category_hash["updated_at"]
+            category_hash.delete("updated_at")
+
+            category_hash.symbolize_keys!
+
+            category_hash.each_key do |k|
+                category_hash.delete(k) if !allowed_attributes.include?(k)
+            end
+            
+            category = ZendeskGuideCategory.where(category_id: category_hash[:category_id]).first
+            category.update(category_hash) if !category.nil?
+            category = ZendeskGuideCategory.create(category_hash) if category.nil?
+            
+            category_objects << category
+        end
+    end
+
+end

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

@@ -0,0 +1,42 @@
+class ZendeskGuidePermissionGroup < ActiveRecord::Base
+    has_many :zendesk_guide_articles
+
+    def self.find_or_create_permission_groups(options={})
+        permission_groups = options[:permission_groups]
+        permission_group_objects = options[:permission_group_objects]
+        allowed_attributes = [
+            :permission_group_id,
+            :name,
+            :edit, 
+            :publish,
+            :permission_group_created_at,
+            :permission_group_updated_at,
+            :built_in
+        ]
+
+        permission_groups.each do |p|
+            permission_group_hash = p.clone
+
+            permission_group_hash[:permission_group_id] = permission_group_hash["id"]
+            permission_group_hash.delete("id")
+
+            permission_group_hash[:permission_group_created_at] = permission_group_hash["created_at"]
+            permission_group_hash.delete("created_at")
+
+            permission_group_hash[:permission_group_updated_at] = permission_group_hash["updated_at"]
+            permission_group_hash.delete("updated_at")
+
+            permission_group_hash.symbolize_keys!
+
+            permission_group_hash.each_key do |k|
+                permission_group_hash.delete(k) if !allowed_attributes.include?(k)
+            end
+
+            permission_group = ZendeskGuidePermissionGroup.where(permission_group_id: permission_group_hash[:permission_group_id]).first
+            permission_group.update(permission_group_hash) if !permission_group.nil?
+            permission_group = ZendeskGuidePermissionGroup.create(permission_group_hash) if permission_group.nil?
+
+            permission_group_objects << permission_group
+        end
+    end
+end

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

@@ -0,0 +1,62 @@
+class ZendeskGuideSection < ActiveRecord::Base
+    belongs_to :zendesk_guide_category
+    has_many :zendesk_guide_articles
+
+    validates :name, presence: true
+    validates :locale, presence: true
+
+    def self.find_or_create_sections(options={})
+        sections = options[:sections]
+        section_objects = options[:section_objects]
+        category_objects = options[:category_objects]
+
+        allowed_attributes = [
+            :category_id,
+            :section_id,
+            :name,
+            :description,
+            :locale,
+            :source_locale,
+            :url,
+            :html_url,
+            :outdated,
+            :position,
+            :section_created_at,
+            :section_updated_at
+        ]
+
+        sections.each do |s|
+            section_hash = s.clone
+
+            section_hash[:section_id] = section_hash["id"]
+            section_hash.delete("id")
+
+            section_hash[:section_created_at] = section_hash["created_at"]
+            section_hash.delete("created_at")
+
+            section_hash[:section_updated_at] = section_hash["updated_at"]
+            section_hash.delete("updated_at")
+
+            section_hash.symbolize_keys!
+
+            section_hash.each_key do |k|
+                section_hash.delete(k) if !allowed_attributes.include?(k)
+            end
+
+            section = ZendeskGuideSection.where(section_id: section_hash[:section_id]).first
+            section.update(section_hash) if !section.nil?
+            section = ZendeskGuideSection.create(section_hash) if section.nil?
+            
+            category_objects.each do |co|
+                is_correct_category = (section.category_id == co.category_id)
+                if is_correct_category
+                    section.zendesk_guide_category = co
+                    section.save
+                    break
+                end
+            end
+
+            section_objects << section
+        end
+    end
+end

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

@@ -0,0 +1,43 @@
+class ZendeskGuideUserSegment < ActiveRecord::Base
+    has_many :zendesk_guide_articles
+
+    def self.find_or_create_user_segments(options={})
+        user_segments = options[:user_segments]
+        user_segment_objects = options[:user_segment_objects]
+        allowed_attributes = [
+            :user_segment_id,
+            :name,
+            :user_type,
+            :group_ids,
+            :organization_ids,
+            :tags,
+            :user_segment_created_at,
+            :user_segment_updated_at
+        ]
+
+        user_segments.each do |s|
+            user_segment_hash = s.clone
+
+            user_segment_hash[:user_segment_id] = user_segment_hash["id"]
+            user_segment_hash.delete("id")
+
+            user_segment_hash[:user_segment_created_at] = user_segment_hash["created_at"]
+            user_segment_hash.delete("created_at")
+
+            user_segment_hash[:user_segment_updated_at] = user_segment_hash["updated_at"]
+            user_segment_hash.delete("updated_at")
+
+            user_segment_hash.symbolize_keys!
+
+            user_segment_hash.each_key do |k|
+                user_segment_hash.delete(k) if !allowed_attributes.include?(k)
+            end
+
+            user_segment = ZendeskGuideUserSegment.where(user_segment_id: user_segment_hash[:user_segment_id]).first
+            user_segment.update(user_segment_hash) if !user_segment.nil?
+            user_segment = ZendeskGuideUserSegment.create(user_segment_hash) if user_segment.nil?
+
+            user_segment_objects << user_segment
+        end
+    end
+end

data/lib/guidepost/provider/zendesk.rb

@@ -1,8 +1,8 @@
 module Guidepost
     module Provider
         class Zendesk
-            attr_accessor :subdomain
-            attr_accessor :project_name
+            attr_reader :subdomain
+            attr_reader :project_name
 
             def initialize(options={})
                 @subdomain = options[:subdomain]
@@ -17,31 +17,112 @@ module Guidepost
                 @password = ENV["#{@project_name}_GUIDEPOST_ZENDESK_PASSWORD_TOKEN"]
             end
 
-            def backup_all_articles
+            def backup_all_articles(options={})
                 # Get all articles (with pagination)
-                articles = self.retrieve_all_articles
+                sideload = options[:sideload] || false
+                articles = self.retrieve_all_articles(sideload: sideload)
         
                 # Upload to S3
                 timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-                @storage.upload_file(path: "zendesk/article_backups/#{timestamp}.json", string_content: articles.to_json)
+
+                filename = "#{timestamp}"
+                filename += "_with_sideload" if sideload
+                @storage.upload_file(path: "zendesk/article_backups/#{filename}.json", string_content: articles.to_json)
         
                 articles.count
             end
         
-            def retrieve_all_articles
-                articles = []
+            def retrieve_all_articles(options={})
+                sideload = options[:sideload] || false
                 page_next = nil
-                while true
-                    page_articles, page_next = self.retrieve_articles(page_next)
-                    break if page_articles.nil? || page_articles.empty?
-                    articles += page_articles
-                    break if page_next.nil?
+                articles = []
+                article_attachments = nil
+
+                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 = self.retrieve_all_article_attachments(articles: articles)
+
+                    return {
+                        articles: articles,
+                        article_count: articles.count,
+                        article_attachments: article_attachments,
+                        article_attachment_count: article_attachments.count
+                    }
+                else
+                    sections = []
+                    categories = []
+
+                    section_urls = Hash.new
+                    category_urls = Hash.new
+
+                    while true
+                        page, page_next = self.retrieve_articles(url: page_next, sideload: true)
+
+                        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?
+
+                        break if no_more_articles && no_more_sections && no_more_categories
+
+                        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
+                            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
+                            end
+                            categories << c if category_urls[url] == 1
+                        end
+
+                        break if page_next.nil?
+                    end
+
+                    article_attachments = self.retrieve_all_article_attachments(articles: articles)
+
+                    return { 
+                        categories: categories, 
+                        category_count: categories.count, 
+                        sections: sections, 
+                        section_count: sections.count, 
+                        articles: articles,
+                        article_count: articles.count,
+                        article_attachments: article_attachments,
+                        article_attachment_count: article_attachments.count
+                    }
                 end
-                articles
             end
         
-            def retrieve_articles(url)
-                url = "#{self.base_api_url}/help_center/articles.json?include=translations&per_page=25&page=1" if url.nil?
+            def retrieve_articles(options={})
+                url = options[:url]
+                sideload = options[:sideload] || false
+
+                if !sideload
+                    url = "#{self.base_api_url}/help_center/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?
+                end
                 
                 uri = URI.parse(url)
         
@@ -56,7 +137,118 @@ module Guidepost
                 body = response.body.force_encoding("UTF-8")
         
                 j_body = JSON.parse(body)
-                return j_body['articles'], j_body['next_page']
+
+                if !sideload
+                    return j_body['articles'], j_body['next_page']
+                else
+                    return j_body, j_body['next_page']
+                end
+            end
+
+            def retrieve_all_user_segments(options={})
+                user_segments = []
+                next_page = nil
+
+                while true
+                    segments, next_page = self.retrieve_user_segments(url: next_page)
+                    break if segments.nil? || segments.empty?
+                    user_segments += segments
+                    break if next_page.nil?
+                end
+
+                user_segments
+            end
+
+            def retrieve_user_segments(options={})
+                url = options[:url]
+                url = "#{self.base_api_url}/help_center/user_segments.json?per_page=25&page=1" 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["user_segments"], j_body['next_page']
+            end
+
+            def retrieve_all_permission_groups(options={})
+                permission_groups = []
+                next_page = nil
+
+                while true
+                    groups, next_page = self.retrieve_permission_groups(url: next_page)
+                    break if groups.nil? || groups.empty?
+                    permission_groups += groups
+                    break if next_page.nil?
+                end
+
+                permission_groups
+            end
+
+            def retrieve_permission_groups(options={})
+                url = options[:url]
+                url = "#{self.base_api_url}/guide/permission_groups.json?per_page=25&page=1" 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["permission_groups"], j_body['next_page']
+            end
+
+            def retrieve_all_article_attachments(options={})
+                article_attachments = []
+                next_page = nil
+
+                articles = options[:articles]
+                articles.each do |article|
+                    while true
+                        attachments, next_page = self.retrieve_article_attachments(for_article: article)
+                        break if attachments.nil? || attachments.empty?
+                        article_attachments += attachments
+                        break if next_page.nil?
+                    end
+                end
+
+                article_attachments
+            end
+
+            def retrieve_article_attachments(options={})
+                article = options[:for_article]
+
+                url = "#{self.base_api_url}/help_center/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)
+                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["article_attachments"], j_body["next_page"]
             end
 
             def base_api_url

data/lib/guidepost/storage/s3.rb

@@ -1,7 +1,7 @@
 module Guidepost
     module Storage
         class S3
-            attr_accessor :project_name
+            attr_reader :project_name
             
             def initialize(options={})
                 @project_name = options[:project_name]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guidepost
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kiren Srinivasan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2019-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -24,18 +24,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: Harness your knowledge base in your Ruby applications
-email: kiren.srinivasan@holbertonschool.com
+description: Harness your knowledge base in your Rails applications
+email: srinitude@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/generators/guidepost/migrate_generator.rb
+- lib/generators/guidepost/models_generator.rb
+- lib/generators/guidepost/templates/migrations.rb
+- lib/generators/guidepost/templates/zendesk_guide.rake
+- lib/generators/guidepost/templates/zendesk_guide_article.rb
+- lib/generators/guidepost/templates/zendesk_guide_article_attachment.rb
+- lib/generators/guidepost/templates/zendesk_guide_category.rb
+- lib/generators/guidepost/templates/zendesk_guide_permission_group.rb
+- lib/generators/guidepost/templates/zendesk_guide_section.rb
+- lib/generators/guidepost/templates/zendesk_guide_user_segment.rb
 - lib/guidepost.rb
 - lib/guidepost/provider/zendesk.rb
 - lib/guidepost/storage/s3.rb
-homepage: 
+homepage: https://github.com/srinitude/guidepost
 licenses:
 - MIT
 metadata: {}
@@ -58,5 +68,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Harness your knowledge base in your Ruby applications
+summary: Harness your knowledge base in your Rails applications
 test_files: []