helply 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96a605c791f58b4a509dc4e4de70ac4c87c06e52010234670d33854c7b84251d
+  data.tar.gz: f9da25d4f39f3a9ec00899f661b2de1396efef69981ad09994992156e18e641a
+SHA512:
+  metadata.gz: 73964d3b6baaf738bc235b7cc73d754d3c835be770cf270bdfcd972e133843834c3ca8bc2395d01d377157bed36cbdbe580c9e21307a76b5d43862640e547f44
+  data.tar.gz: c7d1a2eb34116da2ab3336780a67bcc6a38cbdcb5dd81fc03f4c33a607bea7aa98c84893c5617d136c4c4b41b1de3bfc01567a1d186839abd843cc3c4473cd42

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Kirill Shevchenko
+
+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,31 @@
+# Helply
+Intercom-like helpdesk for Rails
+
+## Installation
+Add this line to your application's `Gemfile` and then execute `bundle install`:
+
+```ruby
+gem 'helply'
+```
+
+Then copy helply migrations:
+
+```sh
+rails helply:install:migrations
+rails db:migrate
+```
+
+## Usage
+Mount Engine:
+
+`config/routes.rb`
+```ruby
+Rails.application.routes.draw do
+  mount Helply::Engine => '/helpdesk'
+end
+```
+
+Look up on `/helpdesk` route.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Helply'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('./spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/helply_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/helply .css

data/app/assets/stylesheets/helply/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/helply/application_controller.rb

@@ -0,0 +1,5 @@
+module Helply
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/helply/articles_controller.rb

@@ -0,0 +1,9 @@
+require_dependency 'helply/application_controller'
+
+module Helply
+  class ArticlesController < ApplicationController
+    def show
+      @article = Helply::Article.find_by(id: params[:id])
+    end
+  end
+end

data/app/controllers/helply/collections_controller.rb

@@ -0,0 +1,13 @@
+require_dependency 'helply/application_controller'
+
+module Helply
+  class CollectionsController < ApplicationController
+    def index
+      @collections = Helply::Collection.index_list
+    end
+
+    def show
+      @collection = Helply::Collection.with_articles(params[:id])
+    end
+  end
+end

data/app/helpers/helply/application_helper.rb

@@ -0,0 +1,4 @@
+module Helply
+  module ApplicationHelper
+  end
+end

data/app/jobs/helply/application_job.rb

@@ -0,0 +1,4 @@
+module Helply
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/helply/application_mailer.rb

@@ -0,0 +1,6 @@
+module Helply
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/helply/application_record.rb

@@ -0,0 +1,5 @@
+module Helply
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/helply/article.rb

@@ -0,0 +1,7 @@
+module Helply
+  class Article < ApplicationRecord
+    belongs_to :collection
+
+    validates :title, :subtitle, :content, presence: true
+  end
+end

data/app/models/helply/collection.rb

@@ -0,0 +1,10 @@
+module Helply
+  class Collection < ApplicationRecord
+    has_many :articles
+
+    scope :index_list, -> { select(:id, :title, :description) }
+    scope :with_articles, ->(id) { where(id: id).includes(:articles).last }
+
+    validates :title, :description, presence: true
+  end
+end

data/app/views/helply/articles/show.html.erb

@@ -0,0 +1,7 @@
+Article:
+
+<div>
+  <%= @article.title %>
+  <%= @article.subtitle %>
+  <%= @article.content%>
+</div>

data/app/views/helply/collections/index.html.erb

@@ -0,0 +1,11 @@
+<h1>Helply</h1>
+<h2>Collections:<h2>
+
+<% @collections.each do |collection| %>
+  <div>
+    <p>
+      <%= link_to collection.title, collection_path(collection) %>
+      <%= collection.description %>
+    <p>
+  <div>
+<% end %>

data/app/views/helply/collections/show.html.erb

@@ -0,0 +1,15 @@
+<h1>
+  <%= @collection.title %>
+</h1>
+<h3>
+  <%= @collection.description %>
+</h3>
+
+Articles:
+
+<% @collection.articles.each do |article| %>
+  <div>
+    <%= link_to article.title, article_path(article) %>
+    <%= article.subtitle %>
+  </div>
+<% end %>

data/app/views/layouts/helply/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Helply</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag "application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Helply::Engine.routes.draw do
+  root 'collections#index'
+
+  resources :collections, only: %w[show]
+  resources :articles, only: %w[show]
+end

data/db/migrate/20200305125915_create_helply_collections.rb

@@ -0,0 +1,10 @@
+class CreateHelplyCollections < ActiveRecord::Migration[6.0]
+  def change
+    create_table :helply_collections do |t|
+      t.string :title, null: false
+      t.string :description, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200305125925_create_helply_articles.rb

@@ -0,0 +1,15 @@
+class CreateHelplyArticles < ActiveRecord::Migration[6.0]
+  def change
+    create_table :helply_articles do |t|
+      t.string :title, null: false
+      t.string :subtitle, null: false
+      t.text :content, null: false
+
+      t.references :collection
+
+      t.timestamps
+    end
+
+    add_foreign_key :helply_articles, :helply_collections, column: :collection_id
+  end
+end

data/lib/helply.rb

@@ -0,0 +1,5 @@
+require 'helply/engine'
+
+module Helply
+  # Your code goes here...
+end

data/lib/helply/engine.rb

@@ -0,0 +1,18 @@
+begin
+  require 'factory_bot_rails'
+rescue LoadError
+end
+
+module Helply
+  class Engine < ::Rails::Engine
+    isolate_namespace Helply
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    if defined?(FactoryBotRails)
+      config.factory_bot.definition_file_paths += [File.expand_path('../factories', __FILE__)]
+    end
+  end
+end

data/lib/helply/version.rb

@@ -0,0 +1,3 @@
+module Helply
+  VERSION = '0.1.0'
+end

data/lib/tasks/helply_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :helply do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: helply
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kirill Shevchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.beta3
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-selenium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Intercom-like Helpdesk for Rails apps
+email:
+- hello@kirillshevch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/helply_manifest.js
+- app/assets/stylesheets/helply/application.css
+- app/controllers/helply/application_controller.rb
+- app/controllers/helply/articles_controller.rb
+- app/controllers/helply/collections_controller.rb
+- app/helpers/helply/application_helper.rb
+- app/jobs/helply/application_job.rb
+- app/mailers/helply/application_mailer.rb
+- app/models/helply/application_record.rb
+- app/models/helply/article.rb
+- app/models/helply/collection.rb
+- app/views/helply/articles/show.html.erb
+- app/views/helply/collections/index.html.erb
+- app/views/helply/collections/show.html.erb
+- app/views/layouts/helply/application.html.erb
+- config/routes.rb
+- db/migrate/20200305125915_create_helply_collections.rb
+- db/migrate/20200305125925_create_helply_articles.rb
+- lib/helply.rb
+- lib/helply/engine.rb
+- lib/helply/version.rb
+- lib/tasks/helply_tasks.rake
+homepage: https://github.com/kirillshevch/helply
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Intercom-like Helpdesk for Rails apps
+test_files: []