fanforce-plugin-factory 0.7.0

data/lib/fanforce/plugin_factory/config/_error_handling.rb

@@ -0,0 +1,26 @@
+class FanforcePlugin::Sinatra
+  require 'fanforce/errors'
+  include Fanforce::Errors
+
+  set :raise_errors, false
+  set :show_exceptions, false
+
+  error 400..600 do
+    e = env['sinatra.error'] or (next response if e.nil?)
+
+    if Object.const_defined?('Fanforce') and Fanforce.const_defined?('Api') and e.is_a?(Fanforce::Api::Error)
+      errors = e.errors
+    else
+      errors = e.respond_to?(:public_errors) ? e.public_errors : []
+      errors << {message: 'There has been an internal server error. Our developers have been notified.'} if errors.size == 0
+    end
+
+    admin_details = Fanforce::Errors.format_admin_details(e, errors)
+
+    body = {errors: errors}
+    body.merge!(admin_details.merge(backtrace: e.backtrace)).delete(:public_response) if params[:show_error_details] == '1' or FanforcePlugin.config.show_error_details
+
+    status(e.respond_to?(:code ) ? e.code : 500) and json(body)
+  end
+end
+

data/lib/fanforce/plugin_factory/config/helpers/assets.rb

@@ -0,0 +1,23 @@
+module Sinatra::AssetHelpers
+
+  def stylesheet(s)
+    s += '.css' unless s.include?('.css')
+    s = asset_path(s) unless s =~ /^https?:\// or s =~ /^\/\/\/.+/
+    "<link rel='stylesheet' href='#{s}' />"
+  end
+
+  def javascript(s)
+    s += '.js' unless s.include?('.js')
+    s = asset_path(s) unless s =~ /^https?:\// or s =~ /^\/\/\/.+/
+    "<script type='text/javascript' src='#{s}'></script>"
+  end
+
+  def asset_path(source, options={})
+    source = ('/assets/' + source).gsub('//', '/').gsub('/assets/assets/', '/assets/')
+  end
+
+  def image_path(source)
+    asset_path(source)
+  end
+
+end

data/lib/fanforce/plugin_factory/config/helpers/fanforce.rb

@@ -0,0 +1,21 @@
+module Sinatra::FanforceHelpers
+  require 'fanforce'
+
+  def fanforce_id
+    @fanforce_id = params[:fanforce_id] || ff.params[:fanforce_id]
+  end
+
+  def ff
+    return @ff if @ff.present?
+    @ff = Fanforce.new(params)
+    #return @ff if !@ff.valid_fanforce_request? and !@ff.valid_fanforce_js_request?
+
+    @ff.auth Sinatra::FanforceHelpers.find_api_key(ff.params[:fanforce_id])
+    @ff
+  end
+
+  def self.find_api_key(fanforce_id, addon_type=:plugin, addon_id=FanforcePlugin._id)
+    $Redis.get("installed:#{addon_type}-#{addon_id}:#{fanforce_id}")
+  end
+
+end

data/lib/fanforce/plugin_factory/config/helpers/json.rb

@@ -0,0 +1,10 @@
+require 'multi_json'
+
+module Sinatra::JSONHelpers
+  def json(*args)
+    args[0] = {} if args.size == 0
+    content_type (Rack.const_defined?('JSONR') and Rack::JSONR.is_jsonp_request?(request)) ? 'application/javascript' : :json
+    MultiJson.dump args[0], :pretty => settings.respond_to?(:json_pretty) && settings.json_pretty
+  end
+  alias JSON json
+end

data/lib/fanforce/plugin_factory/config/sinatra_config.rb

@@ -0,0 +1,65 @@
+class FanforcePlugin::SinatraConfig
+  attr_accessor :layout_for_add_initiative, :layout_for_add_source, :layout_for_close_popup, :layout_for_edit_initiative, :layout_for_engage, :layout_for_index, :layout_for_new_message, :layout_for_source_details
+  attr_accessor :_id, :redis_url, :factory_root_dir, :root_dir, :dir_name, :show_error_details
+  attr_reader :type
+
+  def initialize(root_dir)
+    @layout_for_add_initiative = true
+    @layout_for_add_source = true
+    @layout_for_close_popup = true
+    @layout_for_edit_initiative = true
+    @layout_for_engage = true
+    @layout_for_index = true
+    @layout_for_new_message = true
+    @layout_for_source_details = true
+
+    @_id = ENV['FANFORCE_PLUGIN_ID']
+    @type = nil
+    @root_dir = root_dir
+    @factory_root_dir = File.expand_path '../../', __FILE__
+    @redis_url = ENV['REDIS_URL'] || 'redis://localhost:6379'
+    @show_error_details = false
+  end
+
+  def show_error_details=(bool)
+    @show_error_details = [true,1,'1'].include?(bool)
+  end
+
+  def type=(type)
+    allowed = [:data_connector, :data_processor, :broadcaster, :identifier, :behavior]
+    raise "type (#{type}) was not found in allowed list: #{allowed}" if !allowed.include?(type.to_sym)
+    @type = type.to_sym
+  end
+
+  def load
+    raise 'CRITICAL: This FanforcePlugin requires config._id to be set. See documentation.' if !@_id
+    raise 'CRITICAL: This FanforcePlugin requires config.root_dir to be set. See documentation' if !@root_dir
+
+    FanforcePlugin::Sinatra.set :root, @root_dir
+    FanforcePlugin::Sinatra.set :public_folder, [@root_dir+'/public', @factory_root_dir+'/public'].inject(''){|dir, d| File.directory?(d) ? (break d) : d }
+    FanforcePlugin::Sinatra.set :views, [@root_dir+'/views', @factory_root_dir+'/views'].inject(''){|dir, d| File.directory?(d) ? (break d) : d }
+
+    FanforcePlugin.config.load_routes
+    FanforcePlugin.config.load_redis
+  end
+
+  def load_routes
+    @dir_name = /\/([^\/]+)\/?$/.match(@root_dir)[1]
+
+    $: << File.join(@root_dir,'lib') if File.directory?("#{@root_dir}/lib")
+
+    require "#{@root_dir}/config/initializer" if File.exists?("#{@root_dir}/config/initializer.rb")
+    require "#{@root_dir}/config/routes" if File.exists?("#{@root_dir}/config/routes.rb")
+
+    require "#{@root_dir}/initializer" if File.exists?("#{@root_dir}/initializer.rb")
+    require "#{@root_dir}/routes" if File.exists?("#{@root_dir}/routes.rb")
+
+    require "#{@factory_root_dir}/routes_#{@type}" if @type and File.exists?("#{@factory_root_dir}/routes_#{@type}.rb")
+    require "#{@factory_root_dir}/routes"
+  end
+
+  def load_redis
+    $Redis = ::Redis.new(url: @redis_url)
+  end
+
+end

data/lib/fanforce/plugin_factory/initializers/ff_globals.rb

@@ -0,0 +1,72 @@
+if ENV['RACK_ENV'] == 'development'
+  $BASE_DOMAIN = 'fanforce.gg'
+  $APP_DOMAIN = 'app.' + $BASE_DOMAIN
+  $API_DOMAIN = 'api.' + $BASE_DOMAIN
+  $I_DOMAIN = 'i.' + $BASE_DOMAIN
+  $WEBSITE_DOMAIN = $BASE_DOMAIN
+
+  $SMARTURL_DOMAIN = 'fanforc.gg'
+  $FF_PLUGIN_DOMAIN = 'ffplugin.gg'
+  $FF_APP_DOMAIN = 'ffapp.gg'
+  $FF_WIDGET_DOMAIN = 'ffwidget.gg'
+
+  $DEVS_DOMAIN = 'technical%40mobilizationlabs.com:zE27fdevelopers@developers-fanforce.dotcloud.com' # or localhost:3000'
+
+  $PUSHER_APP_ID = '23240'
+  $PUSHER_KEY = '029caf227a64c8e82e99'
+  $PUSHER_SECRET = '3169163d2e27de9a2291'
+
+elsif ENV['RACK_ENV'] == 'test'
+  $BASE_DOMAIN = 'fanforce.gg'
+  $APP_DOMAIN = 'app.' + $BASE_DOMAIN
+  $API_DOMAIN = 'api.' + $BASE_DOMAIN
+  $I_DOMAIN = 'i.' + $BASE_DOMAIN
+  $WEBSITE_DOMAIN = $BASE_DOMAIN
+
+  $SMARTURL_DOMAIN = 'fanforc.gg'
+  $FF_PLUGIN_DOMAIN = 'ffplugin.gg'
+  $FF_WIDGET_DOMAIN = 'ffwidget.gg'
+  $FF_APP_DOMAIN = 'ffapp.gg'
+
+  $DEVS_DOMAIN = 'technical%40mobilizationlabs.com:zE27fdevelopers@developers-fanforce.dotcloud.com'
+
+  $PUSHER_APP_ID = '23243'
+  $PUSHER_KEY = '7bcc87b3c55301f687b9'
+  $PUSHER_SECRET = '61c760c05430e68d7e8d'
+
+elsif ENV['RACK_ENV'] == 'qa'
+  $BASE_DOMAIN = 'fanforce-qa.com'
+  $APP_DOMAIN = 'app.' + $BASE_DOMAIN
+  $API_DOMAIN = 'api.' + $BASE_DOMAIN
+  $I_DOMAIN = 'i.' + $BASE_DOMAIN
+  $WEBSITE_DOMAIN = $BASE_DOMAIN
+
+  $SMARTURL_DOMAIN = 'fanforc.us'
+  $FF_PLUGIN_DOMAIN = 'ffplugin.us'
+  $FF_APP_DOMAIN = 'ffapp.us'
+  $FF_WIDGET_DOMAIN = 'ffwidget.us'
+
+  $DEVS_DOMAIN = 'technical%40mobilizationlabs.com:zE27fdevelopers@developers-fanforce.dotcloud.com'
+
+  $PUSHER_APP_ID = '14778'
+  $PUSHER_KEY = 'b5e2e23fb9542798ef38'
+  $PUSHER_SECRET = '7bfba2003df078ca64e9'
+
+elsif ENV['RACK_ENV'] == 'production'
+  $BASE_DOMAIN = 'fanforce.com'
+  $APP_DOMAIN = 'app.' + $BASE_DOMAIN
+  $API_DOMAIN = 'api.' + $BASE_DOMAIN
+  $I_DOMAIN = 'i.' + $BASE_DOMAIN
+  $WEBSITE_DOMAIN = $BASE_DOMAIN
+
+  $SMARTURL_DOMAIN = 'fanforce.io'
+  $FF_PLUGIN_DOMAIN = 'ffplugin.io'
+  $FF_APP_DOMAIN = 'ffapp.io'
+  $FF_WIDGET_DOMAIN = 'ffwidget.io'
+
+  $DEVS_DOMAIN = 'technical%40mobilizationlabs.com:zE27fdevelopers@developers-fanforce.dotcloud.com'
+
+  $PUSHER_APP_ID = '14778'
+  $PUSHER_KEY = 'b5e2e23fb9542798ef38'
+  $PUSHER_SECRET = '7bfba2003df078ca64e9'
+end

data/lib/fanforce/plugin_factory/layouts/add_edit_initiative.haml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/add_edit_initiative.css'
+
+  %body
+    = yield
+    = javascript '///' + $I_DOMAIN + '/devforce.js'
+    = javascript '/add_edit_initiative.js'
+    = yield_content :after_core_js

data/lib/fanforce/plugin_factory/layouts/add_source.haml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/add_source.css'
+
+  %body
+    = yield
+    = javascript '///' + $I_DOMAIN + '/devforce.js'
+    = javascript '/add_source.js'
+    = yield_content :after_core_js

data/lib/fanforce/plugin_factory/layouts/engage.haml

@@ -0,0 +1,27 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/engage.css'
+  %body.layout-engage
+    .lyt-root
+      .lyt-header
+        #logo
+      = yield
+      .lyt-root-footer
+    .lyt-footer
+      %span#distributed-by
+      %a{href: "http://#{$BASE_DOMAIN}"} Powered by Fanforce.
+
+  = javascript "http://#{$I_DOMAIN}/#{params[:fanforce_slug]}-fanforce.js#{'?force_compile=1&env=development' if ENV['RACK_ENV']=='development'}"
+  = yield_content :after_fanforce_js
+  :coffeescript
+    if FF.account.website_url
+      $('#distributed-by').html('Distributed by <a href="' + FF.account.website_url + '">' + FF.account.name + '</a>.&nbsp;')
+      $('#logo').html('<a href="' + FF.account.website_url + '"><img class="logo" src="' + FF.account.logo_url + '"></a>') if FF.account.logo_url?
+    else
+      $('#distributed-by').html('Distributed by ' + FF.account.name + '.&nbsp;')
+      $('#logo').html('<img class="logo" src="' + FF.account.logo_url + '">') if FF.account.logo_url

data/lib/fanforce/plugin_factory/layouts/new_message.haml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/new_message.css'
+
+  %body
+    = yield
+    = javascript "///#{$I_DOMAIN}/devforce.js?force_compile=#{ENV['RACK_ENV']=='development' ? 1 : 0}&env=#{ENV['RACK_ENV']}"
+    = javascript '/new_message.js'
+    = yield_content :after_core_js

data/lib/fanforce/plugin_factory/layouts/promotional.haml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/promotional.css'
+
+  %body
+    = yield
+    = javascript '///' + $I_DOMAIN + '/devforce.js'
+    = javascript '/promotional.js'
+    = yield_content :after_core_js

data/lib/fanforce/plugin_factory/layouts/source_details.haml

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+%html
+  %head
+    %title Fanforce
+    %meta{'http-equiv'=>'Content-Type', content:'text/html; charset=iso-8859-1'}/
+    %meta{'http-equiv'=>'Content-Language', content: 'en-us'}/
+    = stylesheet '/source_details.css'
+
+  %body
+    = yield
+    = javascript '///' + $I_DOMAIN + '/devforce.js'
+    = javascript '/source_details.js'
+    = yield_content :after_core_js

data/lib/fanforce/plugin_factory/routes.rb

@@ -0,0 +1,35 @@
+class FanforcePlugin::Sinatra
+
+  # INDEX ########################################################################
+  def route_index(params)
+    page :index, :layout => :promotional
+  end
+  ['/', '/index.html'].each do |path|
+    get path do route_index(params) end
+  end
+
+  # INSTALL ######################################################################
+  def route_install(params)
+    raise "This is not a valid plugin install request: #{env['HTTP_HOST']}" if !ff.valid_install_request?(params)
+    api_key = $Redis.get("installed:#{ff.params[:addon_type]}-#{ff.params[:addon_id]}:#{ff.params[:fanforce_id]}")
+
+    #raise 'A different API key already exists for this addon. Please uninstall first.' if api_key.present? and ff.params[:api_key] != api_key
+    $Redis.set("installed:#{ff.params[:addon_type]}-#{ff.params[:addon_id]}:#{ff.params[:fanforce_id]}", ff.params[:api_key])
+    ff.auth(ff.params[:api_key])
+
+    json status: 'installed', success: true
+  end
+  any '/install' do route_install(params) end
+
+  # UNINSTALL ####################################################################
+  def route_uninstall(params)
+    raise 'This is not a valid plugin uninstall request.' if !ff.valid_uninstall_request?(params)
+    api_key = $Redis.get("installed:#{ff.params[:addon_type]}-#{ff.params[:addon_id]}:#{ff.params[:fanforce_id]}")
+
+    raise 'API keys must match before an addon can be uninstalled.' if api_key.present? and ff.params[:api_key] != api_key
+    $Redis.del("installed:#{ff.params[:addon_type]}-#{ff.params[:addon_id]}:#{ff.params[:fanforce_id]}")
+    json status: 'uninstalled', success: true
+  end
+  any '/uninstall' do route_uninstall(params) end
+
+end

data/lib/fanforce/plugin_factory/routes_behavior.rb

@@ -0,0 +1,28 @@
+class FanforcePlugin::Sinatra
+
+  # ADD INITIATIVE UI ############################################################
+  def route_add_initiative(params)
+    page :add_initiative, :layout => :add_edit_initiative
+  end
+  get '/add_initiative.html' do route_add_initiative(params) end
+
+  # EDIT INITIATIVE UI ###########################################################
+  def route_edit_initiative(params)
+    page :edit_initiative, :layout => :add_edit_initiative
+  end
+  get '/edit_initiative.html' do route_edit_initiative(params) end
+
+  # WIDGET TMPLS #################################################################
+  def route_widget_tmpls(params)
+    content_type 'application/javascript'
+    page :widget_tmpls
+  end
+  get '/widget_tmpls' do route_widget_tmpls(params) end
+
+  # ENGAGE #######################################################################
+  def route_engage(params)
+    page :engage, :layout => :engage
+  end
+  get '/:fanforce_slug/:initiative_slug/engage.html' do route_engage(params) end
+
+end

data/lib/fanforce/plugin_factory/routes_broadcaster.rb

@@ -0,0 +1,9 @@
+class FanforcePlugin::Sinatra
+
+  # NEW MESSAGE ##################################################################
+  def route_new_message(params)
+    page :new_message, :layout => :new_message
+  end
+  get '/new_message.html' do route_new_message(params) end
+
+end

data/lib/fanforce/plugin_factory/routes_data_connector.rb

@@ -0,0 +1,21 @@
+class FanforcePlugin::Sinatra
+
+  # ADD SOURCE ##################################################################
+  def route_add_source(params)
+    page :add_source, :layout => :add_source
+  end
+  get '/add_source.html' do route_add_source(params) end
+
+  # CLOSE POPUP #################################################################
+  def route_close_popup(params)
+    page :close_popup
+  end
+  get '/close_popup.html' do route_close_popup(params) end
+
+  # SOURCE DETAILS ##############################################################
+  def route_source_details(params)
+    page :source_details, :layout => :source_details
+  end
+  get '/source_details.html' do route_source_details(params) end
+
+end

data/lib/fanforce/plugin_factory/sprockets/compiler.rb

@@ -0,0 +1,107 @@
+require 'sprockets'
+require 'sprockets-sass'
+require 'sass'
+
+class SprocketsCompiler
+  # This is pretty much copy/paste from https://github.com/stevehodgkiss/guard-sprockets2/blob/master/lib/guard/sprockets2/compiler.rb
+  # The only method added/changed is self.sprockets()
+
+  def initialize(options = {})
+    configure(options)
+    @target = Pathname.new(@assets_path)
+  end
+
+  def clean
+    FileUtils.rm_rf @assets_path, :secure => true
+  end
+
+  def compile
+    @sprockets.send(:expire_index!)
+    success = true
+    @precompile.each do |path|
+      @sprockets.each_logical_path do |logical_path|
+        next unless path_matches?(path, logical_path)
+
+        if asset = @sprockets.find_asset(logical_path)
+          success = compile_asset(asset, false)
+          success = compile_asset(asset, true) if @digest
+          break unless success
+        end
+      end
+    end
+    success
+  end
+
+  protected
+
+  def compile_asset(asset, digest)
+    filename = digest ? @target.join(asset.digest_path) : @target.join(asset.logical_path)
+    puts filename
+
+    FileUtils.mkdir_p filename.dirname
+    asset.write_to(filename)
+    asset.write_to("#{filename}.gz") if @gz && filename.to_s =~ /\.(css|js)$/
+    true
+  rescue => e
+    puts unless ENV['GUARD_ENV'] == 'test'
+    UI.error e.message.gsub(/^Error: /, '')
+    false
+  end
+
+  def path_matches?(path, logical_path)
+    if path.is_a?(Regexp)
+      path.match(logical_path)
+    else
+      File.fnmatch(path.to_s, logical_path)
+    end
+  end
+
+  def configure(options)
+    @sprockets = options[:sprockets]
+    @assets_path = options[:assets_path]
+    @precompile = options[:precompile]
+    @digest = options[:digest]
+    @gz = options[:gz]
+    set_defaults
+  end
+
+  def set_defaults
+    if defined?(Rails)
+      @sprockets ||= Rails.application.assets
+      @assets_path ||= File.join(Rails.public_path, Rails.application.config.assets.prefix)
+      @precompile ||= Rails.application.config.assets.precompile
+    else
+      @assets_path ||= "#{Dir.pwd}/public/assets"
+      @precompile ||= [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
+    end
+    @digest = true if @digest.nil?
+    @gz = true if @gz.nil?
+  end
+
+  def self.setup(base_dir)
+    sprockets = ::Sprockets::Environment.new(base_dir)
+
+    sprockets.append_path 'assets/img'
+    sprockets.append_path 'assets/js'
+    sprockets.append_path 'assets/css'
+    sprockets.append_path 'assets/lib'
+
+    default_assets_dir = File.dirname( File.expand_path( __FILE__ ) ) + '/..'
+    sprockets.append_path default_assets_dir + '/assets/img'
+    sprockets.append_path default_assets_dir + '/assets/js'
+    sprockets.append_path default_assets_dir + '/assets/css'
+    sprockets.append_path default_assets_dir + '/assets/lib'
+
+    sprockets.append_path "#{Gem.loaded_specs['compass'].full_gem_path}/frameworks/compass/stylesheets"
+
+    if ENV['RACK_ENV'] != 'development'
+      require 'yui/compressor'
+      require 'uglifier'
+      sprockets.css_compressor = YUI::CssCompressor.new
+      sprockets.js_compressor = Uglifier.new
+    end
+
+    return sprockets
+  end
+
+end