difficult_customer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77af9fc734db424633e7e3243daebf2e91004b04
+  data.tar.gz: a44f8fc495805a3b4e3c4f86caecd3d718a3cfca
+SHA512:
+  metadata.gz: 6ea3b9bdd47d42e8d7f7028bcbb3902dc3a79d72d5ddde6cf2f1e7224c0b2233d5d895f21e05c6fd31023c48297ef712643b91869f1be4c09ee2e719ade16734
+  data.tar.gz: 310b9dd5028a9ea9e26842a7ef21a7e3b51f654224eeea9923eb77497983b185018124c219696bdeb52407703c7fe068dd23352b961d36740ecc1bc3d8e11b29

data/README.md

@@ -0,0 +1,32 @@
+# Difficult Customer plugin
+Difficult Customer is a plugin that helps you to motivate your customers to settle payments.
+
+## Usage
+To use the plugin just place this helper in your layout file: `difficult_customer`.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'difficult-customer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install difficult-customer
+```
+
+By default, this gem will use config file from example/difficult_customer.yml which contains sample configuration.
+To use your own, use:
+```bash
+$ rails generate difficult_customer:install
+```
+and adjust difficult_customer.yml file from your application's config/ directory.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'Difficult::Customer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/helpers/difficult_customer_helper.rb

@@ -0,0 +1,26 @@
+# Rails helper
+module DifficultCustomerHelper
+  def difficult_customer
+    session[:requests] = session[:requests].to_i + 1
+    msg = DifficultCustomer::MessageDisplay.new(
+      session,
+      request,
+      user_signed_in?
+    ).message_to_render
+    return if msg.nil?
+
+    render "difficult_customer/#{msg.params['appearance']}", message: msg
+  end
+
+  def random_dom_ids(count, complexity: 10)
+    Array.new(count) { random_string(complexity) }
+  end
+
+  private
+
+  def random_string(complexity)
+    Array.new(complexity) { ('a'..'z').to_a.sample }.join
+  end
+end
+
+ActionView::Base.send :include, DifficultCustomerHelper

data/app/views/difficult_customer/_alert.html.erb

@@ -0,0 +1,96 @@
+<% random_ids = random_dom_ids(9) %>
+
+<style>
+  .<%= random_ids[2] %> {
+    align-items: center;
+    align-content: center;
+    justify-content: center;
+    position: fixed;
+    transform: translate(0,0);
+    width: auto;
+    left: 0;
+    right: 0;
+    height: auto;
+    top: 0;
+    bottom: 0;
+    z-index: 991;
+    padding: 20px;
+    display: flex
+  }
+
+  .<%= random_ids[3] %> {
+    display: block;
+    position: absolute;
+    width: auto;
+    left: 0;
+    right: 0;
+    height: auto;
+    top: 0;
+    bottom: 0;
+    z-index: 995;
+    opacity: 0.3;
+    background: #222222;
+  }
+
+  .<%= random_ids[4] %> {
+    margin-top: -3%;
+    width: 30%;
+    min-height: 150px;
+    height: auto;
+    max-height: 100%;
+    overflow-x: hidden;
+    overflow-y: auto;
+    position: relative;
+    z-index: 999;
+    background: <%= message.params['colour'] %>;
+    border: 2px solid #222222;
+    padding: 16px
+  }
+
+  .<%= random_ids[5] %> {
+    position: relative
+  }
+
+  .<%= random_ids[6] %> {
+    margin: 1px;
+    padding: 0;
+    line-height: 2
+  }
+
+  .<%= random_ids[7] %> {
+    position: absolute;
+    top: 0;
+    right: 0;
+    line-height: 0;
+    font-size: 3em;
+    cursor: pointer
+  }
+
+  .<%= random_ids[8] %> {
+    position: relative;
+    font-size: 2em;
+    padding-top: 20px
+  }
+
+</style>
+
+<div id="<%= random_ids[0] %>" class="<%= random_ids[2] %>">
+  <div class="<%= random_ids[3] %>"></div>
+  <div class="<%= random_ids[4] %>">
+    <div class="<%= random_ids[5] %>">
+      <span class="<%= random_ids[6] %>"></span>
+      <span id="<%= random_ids[1] %>" class="<%= random_ids[7] %>">
+        &times;
+      </span>
+    </div>
+    <span class="<%= random_ids[8] %>">
+      <%= message.params['text'] %>
+    </span>
+  </div>
+</div>
+
+<script>
+  document.getElementById("<%= random_ids[1] %>").onclick = function() {
+    document.getElementById("<%= random_ids[0] %>").style.display = 'none'
+  }
+</script>

data/app/views/difficult_customer/_banner.html.erb

@@ -0,0 +1,46 @@
+<% random_ids = random_dom_ids(5) %>
+
+<style>
+  .<%= random_ids[2] %> {
+    z-index: 991;
+    position: absolute;
+    background: <%= message.params['colour'] %>;
+    left: 0;
+    right: 0;
+    top: 0;
+    margin: 0;
+    padding: 10px;
+    color: black
+  }
+
+  .<%= random_ids[3] %> {
+    position: relative;
+    float: left;
+    padding: 3px
+  }
+
+  .<%= random_ids[4] %> {
+    position: relative;
+    float: right;
+    cursor: pointer;
+    color: white;
+    line-height: 0;
+    padding: 7px;
+    font-size: 3em
+  }
+</style>
+
+<div id="<%= random_ids[0] %>" class="<%= random_ids[2] %>">
+  <span class="<%= random_ids[3] %>">
+    <%= message.params['text'] %>
+  </span>
+  <span id="<%= random_ids[1] %>" class="<%= random_ids[4] %>">
+    &times;
+  </span>
+</div>
+
+<script>
+  document.getElementById("<%= random_ids[1] %>").onclick = function() {
+    document.getElementById("<%= random_ids[0] %>").style.display = 'none'
+  }
+</script>

data/app/views/difficult_customer/_page.html.erb

@@ -0,0 +1,46 @@
+<% random_ids = random_dom_ids(5) %>
+
+<style>
+  .<%= random_ids[2] %> {
+    position: fixed;
+    z-index: 999;
+    padding-top: 100px;
+    left: 0;
+    top: 0;
+    width: 100%;
+    height: 100%;
+    overflow: auto;
+    background-color: <%= message.params['colour'] %>
+  }
+
+  .<%= random_ids[3] %> {
+    font-size: 4em;
+    color: white;
+    margin: auto;
+    padding: 20px;
+    width: 80%
+  }
+
+  .<%= random_ids[4] %> {
+    position: relative;
+    float: right;
+    cursor: pointer;
+    padding: 3px;
+    color: white
+  }
+</style>
+
+<div id="<%= random_ids[0] %>" class="<%= random_ids[2] %>">
+  <div class="<%= random_ids[3] %>">
+    <%= message.params['text'] %>
+    <span id="<%= random_ids[1] %>" class="<%= random_ids[4] %>">
+      &times;
+    </span>
+  </div>
+</div>
+
+<script>
+  document.getElementById("<%= random_ids[1] %>").onclick = function() {
+    document.getElementById("<%= random_ids[0] %>").style.display = 'none'
+  }
+</script>

data/lib/difficult_customer.rb

@@ -0,0 +1,10 @@
+require 'difficult_customer/version'
+require 'difficult_customer/config'
+require 'difficult_customer/engine'
+require 'difficult_customer/helpers'
+require 'difficult_customer/defaults'
+require 'difficult_customer/message'
+require 'difficult_customer/message_display'
+
+# Main module of this gem.
+module DifficultCustomer; end

data/lib/difficult_customer/config.rb

@@ -0,0 +1,28 @@
+# Gem's configuration
+module DifficultCustomer
+  # Configuration class
+  class Config
+
+    def config
+      YAML.load_file(config_file).freeze
+    end
+
+    private
+
+    def config_path
+      File.join(Dir.pwd, 'config/difficult_customer.yml')
+    end
+
+    def config_file
+      return config_path if File.exist?(config_path)
+
+      File.join(
+        File.dirname(__FILE__),
+        '..',
+        '..',
+        'example',
+        'difficult_customer.yml'
+      )
+    end
+  end
+end

data/lib/difficult_customer/defaults.rb

@@ -0,0 +1,38 @@
+# Gem namespace
+module DifficultCustomer
+  # This class provices defaults for each message priority.
+  class Defaults
+
+    def low
+      {
+        'priority' => 'low',
+        'appearance' => 'banner',
+        'position' => 'bottom',
+        'colour' => 'yellow',
+        'text' => 'This gem is not configured properly.',
+        'frequency' => 'after-sign-in'
+      }
+    end
+
+    def medium
+      {
+        'priority' => 'medium',
+        'appearance' => 'alert',
+        'colour' => 'orange',
+        'text' => 'This gem is not configured properly.',
+        'frequency' => 'every-10-requests'
+      }
+    end
+
+    def high
+      {
+        'priority' => 'high',
+        'appearance' => 'page',
+        'colour' => 'red',
+        'text' => 'This gem is not configured properly.',
+        'frequency' => 'every-2-requests'
+      }
+    end
+
+  end
+end

data/lib/difficult_customer/engine.rb

@@ -0,0 +1,9 @@
+# .
+module DifficultCustomer
+  # A Rails Engine used make the gem running.
+  class Engine < ::Rails::Engine
+
+    isolate_namespace DifficultCustomer
+
+  end
+end

data/lib/difficult_customer/helper.rb

@@ -0,0 +1 @@
+lib/difficult_customer/../app/helpers/difficult_customer_helper.rb

data/lib/difficult_customer/helpers.rb

@@ -0,0 +1,6 @@
+# Isolating in gem's namespace.
+module DifficultCustomer
+  Dir.glob(
+    File.join(File.dirname(__FILE__), '..', '..', 'app', 'helpers', '*')
+  ).each { |f| require f }
+end

data/lib/difficult_customer/message.rb

@@ -0,0 +1,19 @@
+# Isolating Message in the gem's namespace.
+module DifficultCustomer
+  # Message model
+  class Message
+
+    attr_reader :params
+
+    def initialize(params)
+      @params = merge_params(params)
+    end
+
+    private
+
+    def merge_params(params)
+      DifficultCustomer::Defaults.new.send(params['priority']).merge(params)
+    end
+
+  end
+end

data/lib/difficult_customer/message_display.rb

@@ -0,0 +1,73 @@
+# Isolating MessageDisplay in the gem's namespace.
+module DifficultCustomer
+  # Message renderer
+  class MessageDisplay
+
+    def initialize(session, request, user_signed_in)
+      @session = session
+      @request = request
+      @user_signed_in = user_signed_in
+    end
+
+    def message_to_render
+      return if priorities_sorted.first.nil?
+
+      priorities_sorted.first
+    end
+
+    private
+
+    def priorities_sorted
+      out = []
+      %w[high medium low].each do |priority|
+        config['messages'].each do |message|
+          message = cast_message(message)
+          next unless message.params['priority'] == priority
+
+          out.push(message) if message_qualifies(message)
+        end
+      end
+      out
+    end
+
+    def message_qualifies(message)
+      return false unless date_in_range(message)
+
+      every_request_qualifies(message) || after_sign_in_qualifies(message) ||
+        every_n_requests_qualifies(message)
+    end
+
+    def date_in_range(message)
+      start_date = message.params['start_date'] || '1970-01-01'
+      end_date = message.params['end_date'] || '2100-01-01'
+      (Date.parse(start_date)..Date.parse(end_date)).cover?(Time.zone.now)
+    end
+
+    def every_request_qualifies(message)
+      message.params['frequency'] == 'every-request'
+    end
+
+    def every_n_requests_qualifies(message)
+      frequency = message.params['frequency']
+      return false if (frequency =~ /every-(\d+)-requests/).nil?
+
+      (@session[:requests] % frequency.split('-')[1].to_i).zero?
+    end
+
+    def after_sign_in_qualifies(message)
+      return false unless message.params['frequency'] == 'after-sign-in'
+      return false if @request.referer.nil?
+
+      @request.referer.ends_with?('sign_in') && @user_signed_in
+    end
+
+    def cast_message(message_params)
+      Message.new(message_params['message'])
+    end
+
+    def config
+      DifficultCustomer::Config.new.config
+    end
+
+  end
+end

data/lib/difficult_customer/version.rb

@@ -0,0 +1,3 @@
+module DifficultCustomer
+  VERSION = '0.1.1'.freeze
+end

data/lib/generators/difficult_customer/install_generator.rb

@@ -0,0 +1,14 @@
+module DifficultCustomer
+  module Generators
+    # This generator copies example config into config/.
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../../../example', __dir__)
+
+      def copy_config
+        template 'difficult_customer.yml', 'config/difficult_customer.yml'
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: difficult_customer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alek Niemczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.66'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.66'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'TO DO: Description of Difficult::Customer.'
+email:
+- alek@rubylogic.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/helpers/difficult_customer_helper.rb
+- app/views/difficult_customer/_alert.html.erb
+- app/views/difficult_customer/_banner.html.erb
+- app/views/difficult_customer/_page.html.erb
+- lib/difficult_customer.rb
+- lib/difficult_customer/config.rb
+- lib/difficult_customer/defaults.rb
+- lib/difficult_customer/engine.rb
+- lib/difficult_customer/helper.rb
+- lib/difficult_customer/helpers.rb
+- lib/difficult_customer/message.rb
+- lib/difficult_customer/message_display.rb
+- lib/difficult_customer/version.rb
+- lib/generators/difficult_customer/install_generator.rb
+homepage: http://rubylogic.eu
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: 'TO DO: Summary of Difficult::Customer.'
+test_files: []