help-anywhere 0.1.1

data/app/assets/stylesheets/help_anywhere_core_only.css.scss

@@ -0,0 +1,181 @@
+#help-anywhere-widget {
+  position: fixed;
+  display: block;
+
+  width: auto;
+  padding-left: 3px;
+  padding-right: 3px;
+  height: 20px;
+  border-left: solid 2px white;
+  border-bottom: solid 2px white;
+  border-right: solid 2px white;
+
+  background: #333;
+  top: 0;
+  left: 75%;
+  border-bottom-left-radius: 50%;
+  border-bottom-right-radius: 50%;
+
+  font-family: Helvetica, Arial, sans-serif;
+  cursor: pointer;
+
+  color: white;
+  box-shadow: 1px 1px 5px black;
+  font-size: 12px;
+  text-align: center;
+
+  &:hover {
+    border-color: yellow;
+    color: yellow;
+  }
+}
+
+#help-anywhere-layout {
+  font-family: 'Helvetica', 'Arial', sans-serif;
+  position: absolute;
+  min-width: 100%;
+  min-height: 100%;
+  left: 0;
+  top: 0;
+  background-color: rgba(0,0,0,0.5);
+  z-index: 10001;
+
+  .ha-new-component {
+    color: white;
+  }
+
+  .ha-toolbox {
+    position: absolute;
+    top: 0;
+    right: 0;
+    height: 100%;
+    width: 200px;
+    background-color: #333;
+  }
+
+  .ha-edit-bottom-layout {
+    position: absolute;
+    bottom: 0;
+    left: 0;
+    background-color: #333;
+    width: 100%;
+    opacity: 0.6;
+
+    transition: opacity ease-in-out 0.3s;
+    -moz-transition: opacity ease-in-out 0.3s;
+    -o-transition: opacity ease-in-out 0.3s;
+    -webkit-transition: opacity ease-in-out 0.3s;
+    -ms-transition: opacity ease-in-out 0.3s;
+
+    &:hover {
+      opacity: 1;
+    }
+
+    .ha-page-list {
+      .ha-page-list-container {
+        width: 100%;
+        overflow-x: auto;
+      }
+
+      .ha-new-page {
+        cursor: pointer;
+
+        display: inline-block;
+        padding: 20px;
+
+        height: 20px;
+        width: 60px;
+
+        background-color: white;
+        text-align: center;
+        font-weight: bold;
+      }
+
+      .ha-page {
+        cursor: pointer;
+
+        display: inline-block;
+        padding: 20px;
+
+        height: 20px;
+        width: 60px;
+
+        background-color: white;
+        text-align: center;
+        font-weight: bold;
+
+        border-right: solid 2px #333;
+
+        &.selected {
+          box-shadow: inset 0px 0px 0px 5px red;
+        }
+
+        &:hover {
+          box-shadow: inset 0px 0px 0px 5px orange;
+        }
+
+        &:first-child {
+          border-left: none;
+        }
+      }
+    }
+  }
+}
+
+ .ha-bubble-target-selected {
+  border: solid 3px orange;
+  box-sizing: border-box;
+  display: 'block';
+  position: absolute;
+ }
+
+
+
+.ha-hover {
+  box-shadow: inset 0px 0px 1px 1px red, inset 0px 0px 2px 2px white !important;
+}
+
+#help-anywhere-selectbox {
+  position: absolute;
+  border-radius: 5px;
+  background-color: #EEE;
+  border: solid 1px #BBB;
+  box-shadow: 4px 4px 8px #999;
+
+  font-family: Helvetica, Arial, sans-serif;
+
+  ul {
+    list-style: none;
+    margin: 0;
+
+    padding: 5px 0px;
+
+    li {
+      min-width: 64px;
+      padding: 0;
+      color: #333;
+      font-size: 70%;
+      padding: 0px 5px;
+      cursor: pointer;
+
+      font-weight: bold;
+
+      border-top: solid 1px transparent;
+      border-bottom: solid 1px transparent;
+
+      &:hover {
+        color: white;
+        background-color: lighten(#36D, 10%);
+
+        border-bottom-color: lighten(#36D, 5%);
+        border-top-color: lighten(#36D, 15%);
+      }
+
+      a {
+        display: block;
+        color: white;
+        text-decoration: none;
+      }
+    }
+  }
+}

data/app/controllers/help_anywhere/base_controller.rb

@@ -0,0 +1,10 @@
+class HelpAnywhere::BaseController < ApplicationController
+  before_filter :check_authentication, :only => [:edit, :create, :new, :delete, :save]
+
+private
+  def check_authentication
+    unless HelpAnywhere.config.has_edition_role? self
+      raise "You are not authorized to edit help"
+    end
+  end
+end

data/app/controllers/help_anywhere/help_anywhere_controller.rb

@@ -0,0 +1,5 @@
+class HelpAnywhere::HelpAnywhereController < HelpAnywhere::BaseController
+  def routes
+    render :json => HelpAnywhere.config.routes
+  end
+end

data/app/controllers/help_anywhere/pages_controller.rb

@@ -0,0 +1,30 @@
+class HelpAnywhere::PagesController < HelpAnywhere::BaseController
+  def create
+    page = HelpAnywhere::Page.new
+    page.resource = HelpAnywhere::Resource.find_by_id params[:resource_id]
+
+    if page.save
+      render :json => {
+        :id => page.id,
+        :order => page.number
+      }
+    else
+      render :json => { :status => "BAD", :errors => page.errors }
+    end
+  end
+
+  def show
+    page = HelpAnywhere::Page.find_by_id params[:page_id]
+
+    if resource.nil?
+      render :json => nil
+    else
+      render :json => {
+        :id => page.id,
+        :order => page.number,
+        :items => page.items
+      }
+    end
+  end
+
+end

data/app/controllers/help_anywhere/resources_controller.rb

@@ -0,0 +1,84 @@
+class HelpAnywhere::ResourcesController < HelpAnywhere::BaseController
+  def show
+    resource = HelpAnywhere::Resource.find_by_name params[:name]
+
+    if resource.nil?
+      render :json => {
+        :pages => []
+      }
+    else
+      render :json => {
+        :pages => resource.pages.order('number ASC').map{ |x|
+          {
+            :order => x.number,
+            :items => x.items.map{ |x|
+              { :id => x.id, :class_id => x.class_id, :content => JSON.parse(x.content || '{}') }
+            }
+          }
+        }
+      }
+    end
+  end
+
+  def save
+    resource = HelpAnywhere::Resource.find_by_name params[:name]
+
+    if resource.nil?
+      render :text => "Resource not found", :status => 500
+    end
+
+    page_list = JSON.parse(params[:content])
+
+    resource.transaction do
+      resource.pages.each do |page_to_remove|
+        page_to_remove.destroy
+      end
+
+      page_list.each do |page|
+        page = page.with_indifferent_access
+        page_model = HelpAnywhere::Page.new
+        page_model.resource = resource
+        page_model.save!
+
+        page[:items].each do |item|
+          it = HelpAnywhere::Item.new
+
+          it.class_id = item[:class_id]
+          it.content = item[:content].to_json
+          it.page = page_model
+
+          it.save!
+        end
+
+        page_model.save!
+      end
+    end
+
+    render :json => {status: 'OK'}
+  end
+
+  def create
+    resource = HelpAnywhere::Resource.new
+    resource.name = params[:name]
+
+    if resource.save
+      render :json => {
+        :pages => resource.pages.map{ |x|
+          {
+            :order => x.number,
+            :items => x.items
+          }
+        }
+      }
+    else
+      render :json => { :status => "BAD", :errors => resource.errors }
+    end
+
+  end
+
+  def delete
+    resource = HelpAnywhere::Resource.find params[:name]
+    resource.destroy!
+  end
+
+end

data/app/helpers/help_anywhere_helper.rb

@@ -0,0 +1,5 @@
+module HelpAnywhereHelper
+  def can_edit_help?
+    HelpAnywhere.config.has_edition_role? self
+  end
+end

data/app/models/help_anywhere/item.rb

@@ -0,0 +1,6 @@
+class HelpAnywhere::Item < ActiveRecord::Base
+  belongs_to :page, :class_name => HelpAnywhere::Page
+  attr_accessible :class_id, :content, :height, :target, :width, :x, :y
+
+  validates_presence_of :page_id, :class_id
+end

data/app/models/help_anywhere/page.rb

@@ -0,0 +1,34 @@
+class HelpAnywhere::Page < ActiveRecord::Base
+  belongs_to      :resource, :class_name => HelpAnywhere::Resource
+  has_many        :items, :class_name => HelpAnywhere::Item
+
+  validates_presence_of :resource_id
+
+  before_save :inc_page_number
+  before_destroy :move_page_number
+  before_destroy :destroy_items
+private
+
+  def inc_page_number
+    if self.number.nil?
+      if self.resource.pages.count > 0
+        self.number = self.resource.pages.order('number ASC').select(:number).first.number + 1
+      else
+        self.number = 1
+      end
+    end
+  end
+
+  def move_page_number
+    unless self.number.nil?
+      self.resource.pages.where('number > ?', self.number).each do |page|
+        page.number = page.number - 1
+        page.save!
+      end
+    end
+  end
+
+  def destroy_items
+    self.items.each(&:destroy)
+  end
+end

data/app/models/help_anywhere/resource.rb

@@ -0,0 +1,14 @@
+class HelpAnywhere::Resource < ActiveRecord::Base
+  attr_accessible :name
+  has_many :pages, :class_name => HelpAnywhere::Page
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  before_destroy :destroy_pages
+
+private
+  def destroy_pages
+    self.pages.each(&:destroy)
+  end
+end

data/app/models/help_anywhere.rb

@@ -0,0 +1,2 @@
+module HelpAnywhere
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  namespace :help_anywhere do
+    match "resources" => "resources#show"
+    match "resources/create" => "resources#create", :via => :get
+    match "resources/save" => "resources#save"
+
+    match "pages/:page_id" => "pages#show"
+
+    match "routes" => "help_anywhere#routes", :via => :get
+  end
+end

data/db/migrate/20130825093318_create_help_anywhere_resources.rb

@@ -0,0 +1,9 @@
+class CreateHelpAnywhereResources < ActiveRecord::Migration
+  def change
+    create_table :help_anywhere_resources do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130825093414_create_help_anywhere_pages.rb

@@ -0,0 +1,11 @@
+class CreateHelpAnywherePages < ActiveRecord::Migration
+  def change
+    create_table :help_anywhere_pages do |t|
+      t.integer :number
+      t.references :resource
+
+      t.timestamps
+    end
+    add_index :help_anywhere_pages, :resource_id
+  end
+end

data/db/migrate/20130825093611_create_help_anywhere_items.rb

@@ -0,0 +1,19 @@
+class CreateHelpAnywhereItems < ActiveRecord::Migration
+  def change
+    create_table :help_anywhere_items do |t|
+      t.string :target
+      t.integer :x
+      t.integer :y
+      t.integer :width
+      t.integer :height
+      t.text :content
+      t.string :class_id
+
+      t.references :page
+
+      t.timestamps
+    end
+
+    add_index :help_anywhere_items, :page_id
+  end
+end

data/db/migrate/20130927171847_refactor_help_anywhere_items.rb

@@ -0,0 +1,11 @@
+class RefactorHelpAnywhereItems < ActiveRecord::Migration
+  def change
+    remove_column :help_anywhere_items, :target
+    remove_column :help_anywhere_items, :x
+    remove_column :help_anywhere_items, :y
+    remove_column :help_anywhere_items, :width
+    remove_column :help_anywhere_items, :height
+    remove_column :help_anywhere_items, :content
+    add_column :help_anywhere_items, :content, :text
+  end
+end

data/lib/help-anywhere/configuration.rb

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+module HelpAnywhere
+  def self.configure(configuration=HelpAnywhere::Configuration.new)
+    yield configuration if block_given?
+    @@configuration = configuration
+  end
+
+  def self.config
+    @@configuration ||= HelpAnywhere::Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :edition_role
+
+    def has_edition_role? scope
+      if edition_role.instance_of?(Proc)
+        edition_role.bind(scope).call
+      else
+        scope.send(edition_role.to_s.to_sym)
+      end
+    end
+
+    def routes
+      yield @routes if block_given?
+
+      @routes
+    end
+
+    def render_routes
+      @routes.to_javascript
+    end
+
+    def initialize
+      @routes = HelpAnywhere::Routes.new
+      @edition_role = lambda{ true } #per default, we need no authentication to edit help resources
+    end
+  end
+
+  class Routes
+    DEFAULTS_ROUTES = [['/', '_root'], ['??', '$1']]
+
+    attr_accessor :match_data, :ignore_data
+
+    def initialize
+      @match_data = []
+      @ignore_data = []
+    end
+
+    def match regexp, result
+      self.match_data << [ regexp, result ]
+    end
+
+    def ignore regexp
+      self.ignore_data << [ regexp, result ]
+    end
+
+    def to_json *args
+      arr = self.match_data + DEFAULTS_ROUTES
+
+      arr.to_json
+    end
+
+    def to_javascript
+      arr = self.match_data + DEFAULTS_ROUTES
+
+      output = "HelpAnywhere.add_routes(["
+      output += arr.map{ |x| "[/#{x[0].source}/, '#{x[1].sub('\'', '\\\'')}']" }.join(',')
+      output += "]);"
+
+      #output += "HelpAnywhere.ignore(["
+
+      output
+    end
+  end
+end

data/lib/help-anywhere/engine.rb

@@ -0,0 +1,10 @@
+require "rails"
+
+module HelpAnywhere
+  class Engine < Rails::Engine
+    engine_name :help_anywhere
+    #initializer "add assets to precompile" do |app|
+       #app.config.assets.precompile += %w( master/master.js master.css )
+    #end
+  end
+end

data/lib/help-anywhere/version.rb

@@ -0,0 +1,3 @@
+module HelpAnywhere
+  VERSION = "0.1.1"
+end

data/lib/help-anywhere.rb

@@ -0,0 +1,9 @@
+require 'help-anywhere/engine'
+require 'help-anywhere/configuration'
+
+module HelpAnywhere
+  #Table namespace
+  def self.table_name_prefix
+    'help_anywhere_'
+  end
+end

data/lib/tasks/help-anywhere_tasks.rake

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