guidepost 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f5e8180cd498e7176833394eebb66091c6f24c9f6b8c59c2cdc1aa6aed34464
+  data.tar.gz: dea372997e357359bf582c5818e0bbd11c7b32cfbd99daa46d1d3cd22c32b738
+SHA512:
+  metadata.gz: c318c6a46816f326acab6b07352a11b48797cdba5b6f0fbef9020b64bb73495fee2006d5cd84b40d5f6b51c8309e55aae9075e7718d67b820e3cccc526560b16
+  data.tar.gz: 9e325c772b8a5c6ed65615967392fa9734b5497d5f8b20a2821065d708456b1d38bb6d86e6610ff27c3446bb510ba93a459d9d42463168ac29a25fc0542c6a29

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Kiren Srinivasan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# 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.
+
+## Table of Contents
+
+* [Prerequisites/Requirements](#prerequisites-requirements)
+* [Current Knowledge Base Providers](#current-knowledge-base-providers)
+* [Current Storage Services](#current-storage-services)
+* [Installation](#installation)
+* [Environment Variables](#environment-variables)
+* [Current Use Cases](#current-use-cases)
+* [Contact](#contact)
+* [Roadmap](#roadmap)
+* [License](#license)
+
+### Prerequisites/Requirements
+
+* Rails 4.2+
+* Ruby 2.5+
+
+### Current 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
+
+* 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:
+
+```ruby
+gem 'guidepost'
+```
+
+And then execute:
+
+    $ bundle
+
+### Environment Variables
+
+Make sure to have certain environmental variables set, preferrably in your `.bash_profile` or in your `.bashrc`! The prefix of each environment variable needs to be the uppercased version of the name of your project that you will use to initialize your `Guidepost::Provider` (i.e. Zendesk in this case, since this is the only provider currently supported):
+
+#### Zendesk
+
+```ruby
+# The email associated with your Zendesk subdomain
+ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_ZENDESK_EMAIL"]
+
+# The password token associated with your Zendesk subdomain
+ENV["#{YOUR_PROJECT_NAME}_GUIDEPOST_PASSWORD_TOKEN"]
+```
+
+#### S3
+
+```ruby
+# The access key associated with your AWS account
+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 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
+
+#### Back up your knowledge base to S3
+
+```ruby
+subdomain = "example"
+project_name = "example"
+
+zendesk = Guidepost::Provider::Zendesk.new(subdomain: subdomain, project_name: project_name)
+zendesk.backup_all_articles
+```
+
+## 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).
+
+## Roadmap
+
+* Tests
+* More robust documentation
+* More relevant use cases
+
+## License
+
+Guidepost is released under the [MIT License](LICENSE).

data/lib/guidepost.rb

@@ -0,0 +1,16 @@
+require 'aws-sdk'
+require 'cgi'
+require 'json'
+require 'net/http'
+
+module Guidepost
+
+    module Provider
+        autoload :Zendesk,  'guidepost/provider/zendesk'
+    end
+
+    module Storage
+        autoload :S3,       'guidepost/storage/s3'
+    end
+    
+end

data/lib/guidepost/provider/zendesk.rb

@@ -0,0 +1,67 @@
+module Guidepost
+    module Provider
+        class Zendesk
+            attr_accessor :subdomain
+            attr_accessor :project_name
+
+            def initialize(options={})
+                @subdomain = options[:subdomain]
+                @project_name = options[:project_name]
+
+                raise "Guidepost::Provider::Zendesk initializer is missing either a subdomain or project_name" if @subdomain.nil? || @project_name.nil?
+
+                @project_name.upcase!
+                @storage = options[:storage] || Guidepost::Storage::S3.new(project_name: @project_name)
+
+                @email = "#{ENV["#{@project_name}_GUIDEPOST_ZENDESK_EMAIL"]}/token"
+                @password = ENV["#{@project_name}_GUIDEPOST_ZENDESK_PASSWORD_TOKEN"]
+            end
+
+            def backup_all_articles
+                # Get all articles (with pagination)
+                articles = self.retrieve_all_articles
+        
+                # 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)
+        
+                articles.count
+            end
+        
+            def retrieve_all_articles
+                articles = []
+                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?
+                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?
+                
+                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['articles'], j_body['next_page']
+            end
+
+            def base_api_url
+                "https://#{self.subdomain}.zendesk.com/api/v2"
+            end
+        end
+    end 
+end

data/lib/guidepost/storage/s3.rb

@@ -0,0 +1,45 @@
+module Guidepost
+    module Storage
+        class S3
+            attr_accessor :project_name
+            
+            def initialize(options={})
+                @project_name = options[:project_name]
+
+                raise "Guidepost::Storage::S3 initializer is missing a project_name" if @project_name.nil?
+
+                @project_name.upcase!
+
+                @s3_client = Aws::S3::Resource.new(
+                    credentials: Aws::Credentials.new(ENV["#{@project_name}_GUIDEPOST_AWS_ACCESS_KEY_ID"], ENV["#{@project_name}_GUIDEPOST_AWS_SECRET_ACCESS_KEY"]),
+                    region: ENV["#{@project_name}_GUIDEPOST_AWS_REGION"] || "us-east-1"
+                )
+            end
+
+            def upload_file(options={})
+                path = options.fetch(:path, nil)
+                string_content = options.fetch(:string_content, "")
+                acl = options.fetch(:acl, "private")
+                metadata = options.fetch(:metadata, nil)
+
+                bucket_name = ENV["#{self.project_name}_GUIDEPOST_S3_BUCKET_NAME"]
+                storage_class = ENV["#{self.project_name}_GUIDEPOST_S3_STORAGE_CLASS"] || "STANDARD_IA"
+
+                return false if path.nil?
+                begin
+                    obj = @s3_client.bucket(bucket_name).object(path)
+                    result = obj.put({
+                        body: string_content,
+                        acl: acl,
+                        storage_class: storage_class,
+                        metadata: metadata,
+                    }) 
+                rescue Seahorse::Client::NetworkingError => e
+                    raise e if !Rails.env.test?
+                    return true
+                end
+                return !result.nil?
+            end
+        end
+    end 
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: guidepost
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kiren Srinivasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Harness your knowledge base in your Ruby applications
+email: kiren.srinivasan@holbertonschool.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/guidepost.rb
+- lib/guidepost/provider/zendesk.rb
+- lib/guidepost/storage/s3.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Harness your knowledge base in your Ruby applications
+test_files: []