zentool 0.8.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'graphviz'
+gem 'httparty'
+gem 'nokogiri'
+gem 'pry'
+gem 'rspec'
+gem 'rubocop'
+gem 'ruby-graphviz'
+gem 'ruby-progressbar'
+gem 'rubysl-optparse'
+gem 'simplecov'
+# gem 'webmock'
+
+# Specify your gem's dependencies in zentool.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    zentool (0.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    json (2.0.2)
+    method_source (0.8.2)
+    mini_portile2 (2.1.0)
+    multi_xml (0.6.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.46.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-graphviz (1.2.2)
+    ruby-progressbar (1.8.1)
+    rubysl-optparse (2.0.1)
+      rubysl-shellwords (~> 2.0)
+    rubysl-shellwords (2.0.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    unicode-display_width (1.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  httparty
+  nokogiri
+  pry
+  rake (~> 10.0)
+  rspec
+  rubocop
+  ruby-graphviz
+  ruby-progressbar
+  rubysl-optparse
+  simplecov
+  zentool!
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Ennova
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tom Stephen
+
+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,44 @@
+# Zentool
+
+Zentool interfaces with your Zendesk articles to:
+- generate a graph of the relationships between articles
+- download all articles
+- generate of list of 'problem' articles
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zentool'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zentool
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/zentool. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+Contact Tom Stephen at tom.stephen@me.com

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'zentool'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/zentool

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/zentool.rb'

data/lib/zentool.rb

@@ -0,0 +1,80 @@
+require 'nokogiri'
+require 'active_support/all'
+require 'httparty'
+require 'ruby-progressbar'
+require 'pry'
+require 'io/console'
+require 'uri'
+require 'ruby-graphviz'
+require 'optparse'
+
+# require 'zentool/version'
+require_relative 'zentool/zendesk_article.rb'
+require_relative 'zentool/article_helper.rb'
+require_relative 'zentool/graph.rb'
+require_relative 'zentool/zendesk_ticket.rb'
+
+puts
+puts 'Welcome to Zentool! Please enter the following details if not entered already:'
+
+options = {}
+
+OptionParser.new do |parser|
+  parser.banner = 'Usage: zentool [options]'
+
+  parser.on('-h', '--help', 'Show this help message') do ||
+    puts parser
+  end
+
+  parser.on('-u', '--username USERNAME', 'The username for the Zendesk.') do |v|
+    options[:username] = v
+  end
+
+  parser.on('-p', '--password PASSWORD', 'The password for the Zendesk.') do |v|
+    options[:password] = v
+  end
+
+  parser.on('-d', '--domain DOMAIN', 'The domain for zendesk. e.g. https://[YOUR_DOMAIN].zendesk.com/api/v2/help_center/en-us/') do |v|
+    options[:domain] = v
+  end
+
+  parser.on('-o', '--option OPTION', 'Article, tickets or both.') do |v|
+    options[:option] = v.downcase[0]
+  end
+end.parse!
+
+
+if options[:domain] == NilClass || !options.key?(:domain)
+  print 'Zendesk domain: '
+  options[:domain] = gets.chomp
+end
+if options[:username] == NilClass || !options.key?(:username)
+  print 'Zendesk username: '
+  options[:username] = gets.chomp
+end
+if options[:password] == NilClass || !options.key?(:password)
+  print 'Zendesk password: '
+  options[:password] = STDIN.noecho(&:gets).chomp
+  puts
+end
+if options[:option] == NilClass || !options.key?(:option)
+  print 'Option (article, ticket or both [a/t/b]): '
+  options[:option] = gets.chomp.downcase[0]
+end
+puts
+case options[:option]
+when 'a'
+  puts
+  a = ArticleHelper.new(options[:username], options[:password], options[:domain])
+  a.run
+when 't'
+  t = ZendeskTicket.new(options[:username], options[:password], options[:domain])
+  t.run
+when 'b'
+  a = ArticleHelper.new(options[:username], options[:password], options[:domain])
+  a.run
+  t = ZendeskTicket.new(options[:username], options[:password], options[:domain])
+  t.run
+else
+  puts 'Not a valid option.'
+end

data/lib/zentool/article_helper.rb

@@ -0,0 +1,102 @@
+# Article Helper class, called from zentool.rb to do all the work with articles
+
+class ArticleHelper
+  def initialize(username, password, domain)
+    @username, @password, @domain = username, password, domain
+  end
+
+  def run
+    fetch_content
+    generate_summary
+    generate_local_directory
+    generate_problem_articles
+    create_graph
+  end
+
+  private
+
+  def fetch_content
+    puts ' Envision Zendesk Articles'
+    puts '---------------------------'
+
+    puts '-> Retrieving Categories'
+    @zendesk = ZendeskArticle.new(@username, @password, @domain)
+    @categories = Hash[@zendesk.categories.collect { |s| [s['id'], s] }]
+
+    puts "\n-> Retrieving Sections"
+    @zendesk = ZendeskArticle.new(@username, @password, @domain)
+    @sections = Hash[@zendesk.sections.collect { |s| [s['id'], s] }]
+
+    puts "\n-> Retrieving Articles\n"
+    @zendesk = ZendeskArticle.new(@username, @password, @domain)
+    @articles = @zendesk.articles
+    puts
+  end
+
+  def generate_summary
+    puts '-> Generating article summary file: all_articles.csv'
+    CSV.open('all_articles.csv', 'wb') do |csv|
+      csv << @zendesk.export_columns
+      @articles.each do |hash|
+        row = []
+        @zendesk.export_columns.each do |column|
+          case column
+          when 'category'
+            row << @categories[@sections[hash['section_id']]['category_id']]['name']
+          when 'section'
+            row << @sections[hash['section_id']]['name']
+          when 'word_count'
+            row << Nokogiri::HTML.parse(hash['body']).text.squish.split(' ').size
+          else
+            row << hash[column]
+          end
+        end
+        csv << row
+      end
+    end
+  end
+
+  def generate_local_directory
+    @directory = "./articles-#{DateTime.now}"
+
+    search_message = 'not yet available'
+    @found_articles = []
+
+    puts "-> Generating individual article files in #{@directory}"
+    Dir.mkdir(@directory)
+    @articles.each do |article|
+      filename = "#{article['name']}.html".tr(' ', '-').tr('/', ':')
+      filepath = "#{@directory}/#{filename}"
+      if article['body']
+        File.open(filepath, 'w') { |f| f.write(article['body']) }
+        @found_articles << filename if article['body'].include? search_message
+      end
+    end
+  end
+
+  def generate_problem_articles
+    puts "-> Generating summary of problem articles in #{@directory}"
+    File.open('problem_articles.csv', 'w') do |file|
+      file.puts 'article_filename'
+      @found_articles.each do |article_filename|
+        file.puts(article_filename)
+        puts '   - ' + article_filename
+      end
+    end
+  end
+
+  def basic_auth
+    {
+      basic_auth: {
+        username: @username,
+        password: @password
+      }
+    }
+  end
+
+  def create_graph
+    graph = Graph.new(@articles, @sections, @categories, basic_auth)
+    graph.generate
+  end
+
+end