workarea-livechat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f0b404b9ae0b9d4327e619268bd5b4f5a22d2e110d980c6298c436d39c65e98
+  data.tar.gz: 0f414d8094026b9a53ef7a73fb11225b890309e4c75f17a057dc2f17aec5824a
+SHA512:
+  metadata.gz: c124a82d8cdae3c57b7ed3c38ec6aeac780433ef33d0221ab5ba0ce72315a05c53f52cbfef3847447aaab6abb79b5fe3e5850f86a941d3726285a31bf0ccf560
+  data.tar.gz: aac1d03d7b26b45e3e49ba6ab9d02cd3d65af68b854303601296d16225b6e21fded11f686b7c141837caac76cdcb64d4b2ef9ff140f54bd024051517abe28e63

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Rocela Durazo
+
+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,29 @@
+# Workarea Livechat
+Livechat plugin for the Workarea platform.
+
+This plugin supports injecting the livechat JS snippet on every storefront page. 
+
+See https://www.livechatinc.com for more information on the live chat platform.
+
+## Usage
+First you need to create a [livechat account](https://accounts.livechat.com/signup) and get your licence number they will give you a free license for 14 days.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workarea-livechat'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Configuration
+You can configure under your [Admin dashboard configuration](http://localhost:3000/admin/configuration) search for LiveChat
+
+
+## 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,31 @@
+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    = 'Workarea3 Plugin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/views/workarea/storefront/livechat/_livechat_javascript.html.haml

@@ -0,0 +1,9 @@
+- if Workarea::Livechat.enabled?
+  :javascript
+    window.__lc = window.__lc || {};
+    window.__lc.license = "#{Workarea::Livechat.license_number}";
+    ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice))
+  %noscript
+    %a{:href => "https://www.livechatinc.com/chat-with/#{Workarea::Livechat.license_number}/", :rel => "nofollow"}> Chat with us
+    , powered by
+    %a{:href => "https://www.livechatinc.com/?welcome", :rel => "noopener nofollow", :target => "_blank"} LiveChat

data/config/initializers/appends.rb

@@ -0,0 +1,5 @@
+Workarea.append_partials(
+  'storefront.document_head',
+  'workarea/storefront/livechat/livechat_javascript'
+)
+

data/config/initializers/configuration.rb

@@ -0,0 +1,15 @@
+Workarea::Configuration.define_fields do
+  fieldset 'LiveChat', namespaced: true do
+    field 'Enabled',
+      id: :enabled,
+      type: :boolean,
+      description: 'Whether to enable LiveChat functionality throughout the site',
+      default: true
+
+    field 'License Number',
+      id: :license_number,
+      type: :string,
+      description: 'Licence number for your app',
+      allow_blank: true
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/tasks/workarea_livechat_tasks.rake

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

data/lib/workarea/livechat.rb

@@ -0,0 +1,15 @@
+require 'workarea'
+require 'workarea/livechat/engine'
+require 'workarea/livechat/version'
+
+module Workarea
+  module Livechat
+    def self.license_number
+      Workarea.config.livechat_license_number
+    end
+
+    def self.enabled?
+      Workarea.config.livechat_enabled && license_number.present?
+    end
+  end
+end

data/lib/workarea/livechat/engine.rb

@@ -0,0 +1,6 @@
+module Workarea
+  module Livechat
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/workarea/livechat/version.rb

@@ -0,0 +1,5 @@
+module Workarea
+  module Livechat
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: workarea-livechat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rocela Durazo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workarea
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.x
+description: Installs chat window onto all store front pages
+email:
+- roxdurazo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/workarea_livechat_manifest.js
+- app/views/workarea/storefront/livechat/_livechat_javascript.html.haml
+- config/initializers/appends.rb
+- config/initializers/configuration.rb
+- config/routes.rb
+- lib/tasks/workarea_livechat_tasks.rake
+- lib/workarea/livechat.rb
+- lib/workarea/livechat/engine.rb
+- lib/workarea/livechat/version.rb
+homepage: https://github.com/roseliux/workarea-livechat
+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.3
+signing_key: 
+specification_version: 4
+summary: Install live chat onto storefront
+test_files: []