help_center 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c7daa878339028e7a0e6bb67b3fd203f37c1f4a59070b27d8b1ea3439a902c9
+  data.tar.gz: 5fc519dcf8bce60e626cefbbb1e9ccf65ea0375f64462772a7f89d7a347ba557
+SHA512:
+  metadata.gz: 6ba59c2c645c8687617f72e8e5eb7d5a874d31c824effdc7242d3d8ac1cd0dfeb98f0892a519354c3435ad4437dccbfdfb6645aa8316e947b20c4bb9af5c0366
+  data.tar.gz: 3d991eec4b3b26bf78f937c879cda2040ab875f8a4a5a86d492ae276ef024139d7bab184c66a7efdea87b52a4bf90794e5a3595a6769d6ea1c43d038d8b6e6cc

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [uurcankaya, pasilobus] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/CHANGELOG.md

@@ -0,0 +1 @@
+

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 excid3@gmail.com. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in simple_discussion.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ugurcan Kaya
+
+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,153 @@
+# HelpCenter
+
+HelpCenter is a Rails wiki gem with Trix editor support for organizing app documentation and tutorials. It includes support categories, support articles, simple moderation, the ability to leave comments to support articles and more.
+
+Out of the box, HelpCenter comes with styling for Boostrap v4 but you're free to customize the UI as much as you like by installing the views and tweaking the HTML.
+
+## Requirements
+
+Rails >= 6.0.0
+bootstrap >= 4.0.0
+
+## Installation
+
+Before you get started, HelpCenter requires a `User` model in your application (for now).
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'help_center'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Install the migrations and migrate:
+
+```bash
+rails help_center:install:migrations
+rails db:migrate
+```
+
+Add HelpCenter to your `User` model. The model **must** have `name` method which will be used to display the user's name on comments & discussions (if enabled). Currently only a model named `User` will work.
+
+```ruby
+class User < ActiveRecord::Base
+  include HelpCenter::SupportUser
+
+  def name
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+Next add a `moderator` or `admin` flag to the `User` model.
+
+```bash
+rails g migration AddModeratorToUsers moderator:boolean
+rails db:migrate
+```
+Only moderators or admins can add support articles.
+
+```
+if current_user.admin? || current_user.moderator?
+```
+
+Add the following line to your `config/routes.rb` file:
+
+```ruby
+mount HelpCenter::Engine => "/support"
+```
+
+Lastly, add the CSS to your `application.css` to load some default styles.
+
+```scss
+*= require help_center
+```
+
+## Usage
+
+To get all the basic functionality, the only thing you need to do is add a link to HelpCenter in your navbar.
+
+```erb
+<%= link_to "Docs", help_center_path %>
+```
+
+This will take the user to the views inside the Rails engine and that's all you have to do!
+
+### Customizing
+
+If you'd like to customize the views that HelpCenter uses, you can install the views to your Rails app:
+
+```bash
+rails g help_center:views
+```
+
+You can also install a copy of the HelpCenter controllers for advanced customization:
+
+```bash
+rails g help_center:controllers
+```
+
+Helpers are available for override as well. They are used for rendering the user avatars, text formatting, and more.
+
+```bash
+rails g help_center:helpers
+```
+
+**NOTE:** Keep in mind that the more customization you do, the tougher gem upgrades will be in the future.
+
+### User comments & Notifications
+
+You can enable user comments and questions for support articles. HelpCenter will attempt to send email and slack notifications for users who leave comments when a new reply posted.
+
+To turn these off you can do the following in `config/initializers/help_center.rb`
+
+```ruby
+HelpCenter.setup do |config|
+  config.article_dicussions = false # Default: false
+  config.send_email_notifications = false # Default: true
+  config.send_slack_notifications = false # Default: true
+end
+```
+
+Slack notifications require you to set `help_center_slack_url` in your `config/secrets.yml`. If you don't have this value set, it will not attempt Slack notifications even if they are enabled.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Roadmap / Upcoming features
+Your support is appreciated for this project. Consider backing the project via GitHub Sponsors.
+
+We plan to release following features:
+
+- Contact form
+- Ticket submission
+- Live chat
+- Help Center Layout templates
+- Built-in search
+
+## Acknowledgment
+
+HelpCenter generated from the awesome [simple_discussion](https://github.com/excid3/simple_discussion) gem by [Chris Oliver](https://github.com/excid3)
+
+HelpCenter uses [Trix editor](https://github.com/basecamp/trix) by [Basecamp](https://github.com/basecamp)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uurcank/help_center 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).
+
+## Code of Conduct
+
+Everyone interacting in the HelpCenter project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pasilobus/help_center/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/assets/stylesheets/help_center.scss

@@ -0,0 +1,119 @@
+@import "font-awesome-sprockets";
+@import "font-awesome";
+
+/* Allow pagination to be centered */
+.support-threads-nav nav {
+  display: inline-block;
+}
+
+/* Highlight the active navigation item in the sidebar */
+.support-thread-filters {
+  a {
+    color: #555;
+  }
+
+  .active {
+    color: #222;
+    font-weight: bolder;
+  }
+}
+
+/* Formatting for the support threads */
+.support-thread {
+  margin-bottom: -20px;
+
+  h4 {
+    margin-bottom: 4px;
+
+    a {
+      color: #222;
+      font-size: 16px;
+      font-weight: normal;
+      line-height: 1.1;
+    }
+  }
+}
+
+.support-thread-filters a {
+  color: #555555;
+  display: block;
+
+  &:hover {
+    color: #222222;
+    font-weight: bold;
+    text-decoration: none
+  }
+}
+
+.thread-details {
+  color: #999;
+  font-size: 12px;
+  text-transform: uppercase;
+  display: flex;
+  flex-direction: column;
+}
+
+.thread-reaction {
+  background: #eeeeee;
+  padding: 1rem;
+  text-align: center;
+  border-radius: 0.5rem;
+  margin-top: 2rem;
+}
+
+.thread-reaction-links {
+  font-size: 2rem;
+  margin: 0.25rem;
+}
+
+/* Display the support post count above the "posts" text on the index page */
+.thread-posts-count {
+  color: #222;
+  text-align: center;
+
+  span, small {
+    display: block;
+  }
+
+  .count {
+    font-size: 1.5em;
+    font-weight: 300;
+    line-height: 1em;
+  }
+
+  &:hover {
+    color: #222;
+    text-decoration: none;
+  }
+}
+
+/* Formatting for the support posts themselves */
+.support-post {
+  position: relative;
+
+  /* When the URL anchor matches a post id, highlight that item */
+  &:target {
+    background-color: rgb(248, 238, 199);
+  }
+
+  /* Fill this out if you want to highlight the OPs posts */
+  &.original-poster {
+  }
+
+  &.solved {
+    border: 2px solid #5cb85c;
+  }
+}
+
+/* Formatting for the support hr to match card border */
+.help_center hr {
+  border: 0;
+  border-top: 1px solid rgba(0, 0, 0, 0.125);
+  margin: 24px -20px;
+}
+
+.help_center .text-muted {
+  color: #999;
+  margin-top: 6px;
+  font-size: 13px;
+}

data/app/controllers/help_center/application_controller.rb

@@ -0,0 +1,37 @@
+class HelpCenter::ApplicationController < ::ApplicationController
+  layout "help_center"
+
+  def page_number
+    page = params.fetch(:page, '').gsub(/[^0-9]/, '').to_i
+    page = "1" if page.zero?
+    page
+  end
+
+  def is_moderator_or_owner?(object)
+    is_moderator? || object.user == current_user
+  end
+  helper_method :is_moderator_or_owner?
+
+  def is_moderator?
+    current_user.respond_to?(:moderator) && current_user.moderator?
+  end
+  helper_method :is_moderator?
+
+  def require_mod_or_author_for_post!
+    unless is_moderator_or_owner?(@support_post)
+      redirect_to_root
+    end
+  end
+
+  def require_mod_or_author_for_thread!
+    unless is_moderator_or_owner?(@support_thread)
+      redirect_to_root
+    end
+  end
+
+  private
+
+  def redirect_to_root
+    redirect_to help_center.root_path, alert: "You aren't allowed to do that."
+  end
+end