fanforce-plugin-factory 0.7.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGI0MzkyNmQ5MDU4ZGM0MDMzNjg1ZjQzYmFkYzdmYTFiNGU4MDI3Yg==
+  data.tar.gz: !binary |-
+    YzJmMmVlYWM1OGQzYWZkM2NkMjZiN2RhNDI3MDRlZjY0ZDliODk2ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDJlYjQ3NTVmNjE1YWEyYjczNjVmOGM1OGVjYTA4MzA4N2IzNTkyMTM2NWEw
+    OGEzMzEzNGM3YzdlNDY4ZWVkYjg3NTM3N2NlYzBiM2IxYWE5NGM1YzUwMmE3
+    YTRiYzliZTZkODcyMGU1ZWRiODg1ZTBhMmM4MjI0NmIzYjhiNGQ=
+  data.tar.gz: !binary |-
+    YTZlZGJiYTc1ZjFlNjBmNGNhYTNkY2UzMGQzZTUyZDc5OTIyMmQ2NzhjYmNl
+    ZWQ3YzUyYWMxMzQwNDM3ZDY1MThjMzQ1Yzg2ZGYxODFjZTNjZjMxY2Q5Yzc4
+    ZTIzNGZhODY3YjFhYjY5OTA1MDY5MDBjNmMyYzgwOWRmNmQxYzI=

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/
+.DS_STORE
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,218 @@
+fanforce-plugin-factory
+========
+The fanforce-plugin-factory is a gem that makes it really easy to create new Fanforce Plugins using convention over configuration.
+
+# Easy Setup
+Only two files are required to setup a new project:
+1. Gemfile
+2. config.ru
+
+### /Gemfile
+Since the fanforce-plugin-factory gem is hosted on a private gem server so you'll need to specify the source for both rubygems and the private server.
+
+```ruby
+source 'https://rubygems.org'
+source 'https://gems.gemfury.com/xF8KY9sm8eS9yUQqw1jD/'
+ruby '1.9.3'
+
+gem 'fanforce-plugin-factory'
+```
+One you've created the Gemfile you'll need to run bundler install.
+
+### /config.ru
+Only seven lines are required (in addition to having a Redis server).
+
+```ruby
+require 'bundler'; Bundler.setup
+require 'fanforce/plugin'
+FanforcePlugin.config do |config|
+  config._id = 'watch-youtube'
+  config.type = :behavior  # :data_connector, :data_processor, :broadcaster, :identifier, :behavior
+end
+run FanforcePlugin
+```
+You can replace config._id (as in the example above) with an environment variable: ENV['FANFORCE_PLUGIN_ID']
+
+### Ready for the Fanforce Marketplace!
+Your plugin can now be added to the Fanforce Marketplace. Use the follow config settings when adding your new plugin into Fanforce
+
+```ruby
+"public_urls": {
+    "icon_16": "http://${PRIMARY_DOMAIN}/assets/icon-16.png",
+    "icon_32": "http://${PRIMARY_DOMAIN}/assets/icon-32.png",
+    "icon_42": "http://${PRIMARY_DOMAIN}/assets/icon-42.png"
+},
+"staffer_ui_urls": {
+    "add_initiative": "http://${PRIMARY_DOMAIN}/add_initiative.html",
+    "edit_initiative": "http://${PRIMARY_DOMAIN}/edit_initiative.html"
+},
+"callback_urls": {
+    "install": "http://${PRIMARY_DOMAIN}/install",
+    "uninstall": "http://${PRIMARY_DOMAIN}/uninstall"
+},
+"widget_dependencies": [
+    {
+        "widget-name-here": "http://${PRIMARY_DOMAIN}/widget_tmpls"
+    }
+]
+```
+Note: for development and testing we recommend using the [POW server](http://pow.cx/), but you can use rackup or any other server to run your new plugin.
+
+====================
+
+# Customizing/Building Your Plugin
+There are lots of ways you can start building out and customizing your plugin...
+
+### /assets
+Use the assets folder to store all your images, css, and javascript files. There are six asset files that are required. If any are missing, the fanforce-plugin-factory sends default versions when requested.
+
+*Default Assets:*
+* /css
+    * /add_edit_initiative.css - this is loaded from the add_edit_initiative.haml layout.
+    * /add_source.css - this is loaded from the add_source.haml layout.
+    * /engage.css - this is loaded from the engage.haml layout.
+    * /new_message.css - this is loaded from the new_message.haml layout.
+    * /source_details.css - this is loaded from the source_details.haml layout.
+* /js
+    * /add_edit_initiative.js - this is loaded from the add_edit_initiative.haml layout.
+    * /add_source.js - this is loaded from the add_source.haml layout.
+    * /add_source_popup.js - this is loaded from the add_source_popup.haml layout.
+    * /engage.js - this is loaded from the engage.haml layout.
+    * /new_message.js - this is loaded from the new_message.haml layout.
+    * /source_details.js - this is loaded from the source_details.haml layout.
+* /img
+    * /icon-16.png - this icon must be 16px by 16px.
+    * /icon-32.png - this icon must be 32px by 32px.
+    * /icon-42.png - this icon must be 42px by 42px.
+
+### /views
+HAML is the default layout engine. The .haml extension is converted to .html when served in the browser.
+
+*Default Views for Behavior Plugins:*
+* /add_initiative.haml - used in the Command Center.
+* /edit_initiative.haml - used in the Command Center.
+* /engage.haml - used in the Command Center.
+
+*Default Views for Broadcaster Plugins:*
+* /new_message.haml - used in the Command Center.
+
+### /layouts
+You can turn off layouts from be used (see Advanced Configuration)
+
+*Default Layouts for Behavior Plugins:*
+* /add_edit_initiative.haml - the wrapper layout for views/add_initiative.haml and views/edit_initiative.haml
+* /engage.haml - the wrapper layout for views/engage.haml
+
+*Default Layouts for Broadcaster Plugins:*
+* /new_message.haml - the wrapper layout for views/new_message.haml
+
+### /public
+Anything you put in here will be publicly available. The only folder you should not use is /assets, since it is used for precompiling assets (see below).
+
+*Default Files:*
+* /favicon.ico
+
+### /config/routes.rb
+The fanforce-plugin-factory sets up all the required routes. If you want to customize existing routes or add new ones, create a routes.rb file in your home directory with a FanforcePlugin:Sinatra class:
+```
+class FanforcePlugin::Sinatra
+  get '/test' do
+    "Custom route!"
+  end
+end
+```
+Check out [Sinatra's](http://www.sinatrarb.com/documentation) documentation for more details on routes and much more. The FanforcePlugin::Sinatra inherits from the Sinatra::Base, which gives you full control to customize the fanforce-plugin-factory's sinatra implementation as much as you want.
+
+Overwrite any existing routes by specifying them in your routes.rb. You can also pull default route logic into your new custom routes by calling route_[NAME_OF_ROUTE] method.
+```
+class FanforcePlugin::Sinatra
+  any '/install' do
+    # do whatever you want here
+    route_install
+  end
+end
+```
+*Default Routes:*
+- route_index:     get ['/','/index.html']
+- route_install:   post '/install'
+- route_uninstall: post '/uninstall'
+
+*Default Routes for Behavior Plugins:*
+- route_add_initiative:  get '/add_initiative.html'
+- route_edit_initiative: get '/add_initiative.html'
+- route_widget_tmpls:    get '/widget_tmpls.html'
+- route_engage:          get '/:fanforce_slug/:initiative_slug/engage.html'
+
+*Default Routes for Broadcaster Plugins:*
+- route_new_message: get '/new_message.html'
+
+*Default Routes for Data Connector Plugins:*
+- route_add_source: get '/add_source.html'
+- route_source_details: get '/source_details.html'
+
+### /config/initializer.rb
+If you need to run Sinatra middleware or other non-route code, you'll want to create a config/initializer.rb file. This file is required before config/routes.rb. As an example, if you want to use the OmniAuth Facebook Strategy, you would include the following in config/initializer.rb:
+```
+require 'omniauth'
+require 'omniauth-constantcontact2'
+
+class FanforcePlugin::Sinatra
+
+  use Rack::Session::Cookie
+  use OmniAuth::Builder do
+    provider :constantcontact, ENV['CONSTANTCONTACT_API_KEY'], ENV['CONSTANTCONTACT_API_SECRET']
+  end
+
+end
+```
+
+### /lib/*
+If you create a lib/ folder in your plugin's home directory, it will be automatically added to your plugin's ruby path. This allows you to require 'any_file' that has been put in this folder.
+
+# Using Pages/Layouts In Controllers
+Fanforce-plugin-factory adds a helper method on top of the Sinatra code base to load pages and layouts. It's called page:
+```
+get '/custom.html' do
+  page :custom, :layout => :custom
+end
+```
+*Other Examples*
+- :custom_page
+- :custom_page, :layout => :false
+
+# Rendering JSON, JSONP, and JSONR
+Fanforce-plugin-factory adds a "json" method you use in your routes to convert the object to json and set the correct application/json header:
+```
+get '/custom.html' do
+  json first_name: 'Caleb', last_name: 'Clark'
+end
+```
+If a callback param is sent in the request then your json is automatically converted to JSONR[http://github.com/calebclark/rack-jsonr] (JSON Resource).
+
+# Asset Helpers
+Fanforce-plugin-factory comes with a few asset helpers you can use in your haml pages:
+
+- stylesheet(absolute_or_relative_path) - creates style tag
+- javascript(absolute_or_relative_path) - creates script tag
+- asset_path(absolute_or_relative_path) - prints path to asset
+
+# Precompile Your Assets for Faster Delivery
+Heroku tries to run `rake assets:precompile` when pushing new code changes. Fanforce-plugin-factory has this rake task built-in. To activate, just create a new Rakefile in your plugin directory with the following:
+```
+require 'bundler'; Bundler.setup
+require 'fanforce/plugin'
+FanforcePlugin.config do |config|
+  config.type = :behavior  # :data_connector, :data_processor, :broadcaster, :identifier, :behavior
+end
+load 'fanforce/plugin.rake'
+```
+
+# Configure Redis
+By default fanforce-plugin-factory looks for ENV['REDIS_URL'] and if that isn't found, it falls back to redis://localhost:6379. You can specify a custom redis url with `config.redis_url = ` in config.ru:
+```
+FanforcePlugin.config do |config|
+  config.redis_url = 'redis://USERNAME:PASSWORD@HOST:PORT'
+end
+```
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'fileutils'
+include FileUtils
+
+# Default Rake task is compile
+#task :default => :compile
+
+########################################################################
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/fanforce-plugin-factory.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fanforce/plugin_factory/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'fanforce-plugin-factory'
+  gem.version     = Fanforce::PluginFactory::VERSION
+  gem.date        = '2012-10-19'
+  gem.summary     = %q{Everything needed to setup a new plugin on Fanforce}
+  gem.authors     = ['Caleb Clark']
+  gem.email       = ['cclark@fanforce.com']
+  gem.homepage    = 'http://github.com/mlabs/fanforce-plugin-factory'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake', '~> 0.8.7'
+  gem.add_runtime_dependency 'redis', '~> 3.0'
+  gem.add_runtime_dependency 'sinatra', '~> 1.3'
+  gem.add_runtime_dependency 'multi_json', '~> 1.3.6'
+  gem.add_runtime_dependency 'sinatra-contrib'
+  gem.add_runtime_dependency 'rack-contrib'
+  gem.add_runtime_dependency 'haml', '~> 4'
+  gem.add_runtime_dependency 'coffee-script'
+  gem.add_runtime_dependency 'activesupport', '~> 3.2'
+
+  gem.add_runtime_dependency 'sass', '~> 3.2'
+  gem.add_runtime_dependency 'compass', '~> 0.12'
+  gem.add_runtime_dependency 'sprockets', '~> 2.9'
+  gem.add_runtime_dependency 'sprockets-sass', '~> 0.9'
+  gem.add_runtime_dependency 'yui-compressor', '~> 0.9'
+  gem.add_runtime_dependency 'uglifier', '~> 1.3'
+
+  gem.add_runtime_dependency 'yui-compressor', '~> 0.9'
+  gem.add_runtime_dependency 'uglifier', '~> 1.3'
+
+  gem.add_runtime_dependency 'rack-jsonr', '~> 0.2'
+  gem.add_runtime_dependency 'fanforce-api', '~> 0.8'
+  gem.add_runtime_dependency 'fanforce-errors', '~> 0.2'
+end

data/lib/fanforce/plugin_factory.rake

@@ -0,0 +1,71 @@
+require 'fanforce'
+require 'fileutils'
+require 'json'
+require 'yaml'
+require_relative 'plugin_factory/sprockets/hacks'
+require_relative 'plugin_factory/sprockets/compiler'
+
+def load_env_from_file(file)
+  File.open(file, 'rb') do |file|
+    contents = file.read
+    lines = contents.gsub('export ', '').split(/\n\r?/).reject{|line| line.blank?}
+    lines.each do |line|
+      keyValue = line.split('=', 2)
+      next unless keyValue.count == 2
+      ENV[keyValue.first] = keyValue.last.gsub("'",'').gsub('"','')
+    end
+  end
+end
+
+if (!ENV['RACK_ENV'] or ENV['RACK_ENV'] == 'development')
+  load_env_from_file("#{FanforcePlugin.config.root_dir}/.powenv") if File.exists?("#{FanforcePlugin.config.root_dir}/.powenv")
+  load_env_from_file("#{FanforcePlugin.config.root_dir}/.pluginenv") if File.exists?("#{FanforcePlugin.config.root_dir}/.pluginenv")
+end
+
+FanforcePlugin.config.load_redis
+
+namespace :assets do
+  root_dir = FanforcePlugin.config.root_dir
+  factory_root_dir = FanforcePlugin.config.factory_root_dir
+
+  desc 'Precompile assets for production'
+  task :precompile => :clean do
+    sprockets = SprocketsCompiler.setup(root_dir)
+
+    puts 'PRECOMPILING ASSETS... '
+    SprocketsCompiler.new(sprockets: sprockets, precompile: [/(\/|^)[^_\/]+[^\/]*\.(css|js|png|gif|jpeg|jpg|otf|eot|svg|ttf|woff)/]).compile
+    puts 'DONE'
+
+    print 'GENERATING ASSET MANIFESTS... '
+    asset_list = {}
+    sprockets.each_logical_path do |logical_path|
+      if File.basename(logical_path) !~ /^[_]/ and asset = sprockets.find_asset(logical_path)
+        asset_list[logical_path] = "/assets/#{asset.digest_path}"
+      end
+    end
+    IO.write File.join(root_dir, '/public/asset_manifest.json'), JSON.generate(asset_list)
+    IO.write File.join(root_dir, '/public/asset_manifest.json'), "ASSETS=#{JSON.generate(asset_list)}"
+    IO.write File.join(root_dir, '/public/asset_manifest.json'), asset_list.to_yaml
+    puts 'DONE'
+
+    print 'ENSURING FAVICON EXISTS... '
+    if !File.exists?(root_dir+'/public/favicon.ico')
+      puts ''
+      FileUtils.cp("#{factory_root_dir}/public/favicon.ico", "#{root_dir}/public/favicon.ico")
+      puts "#{root_dir}/public/favicon.ico"
+    end
+    puts 'DONE'
+  end
+
+  desc 'Clean assets folder'
+  task :clean do
+    print 'DESTROYING PUBLIC/ASSETS... '
+    FileUtils.rm_rf File.join(root_dir, '/public/assets')
+    puts 'DONE'
+  end
+
+  task :test do
+    puts 'TEST WORKED!'
+  end
+
+end

data/lib/fanforce/plugin_factory.rb

@@ -0,0 +1,60 @@
+ENV['RACK_ENV'] ||= 'development'
+####################################################################################
+require 'fanforce'
+require 'active_support/all'
+require 'sinatra/base'
+require 'fileutils'
+require 'redis'
+
+if ENV['RACK_ENV'] == 'development'
+  require_relative 'plugin_factory/sprockets/hacks'
+  require_relative 'plugin_factory/sprockets/compiler'
+end
+
+caller[0].split(':')[0] =~ /^(.+(config\.ru|Rakefile))$/ ? ROOT_DIR = File.dirname($1) : nil
+
+module FanforcePlugin
+
+  def self.config(&block)
+    config = @@config ||= FanforcePlugin::SinatraConfig.new(ROOT_DIR)
+    if block.present?
+      block.call(config)
+      config.root_dir = File.dirname($1) if !config.root_dir and caller[0].split(':')[0] =~ /^(.+(config\.ru|Rakefile))$/
+    end
+    config
+  end
+
+  def self.root
+    config.root_dir
+  end
+
+  def self.dir_name
+    config.dir_name
+  end
+
+  def self._id
+    config._id
+  end
+
+  def self.type
+    config.type
+  end
+
+  def self.load_config
+    config.load
+  end
+
+  def self.call(env)
+    if ENV['RACK_ENV'] == 'development' and env['PATH_INFO'] =~ /^\/assets\//
+      env['PATH_INFO'] = env['PATH_INFO'].gsub(/^\/assets/, '')
+      sprockets = SprocketsCompiler.setup(FanforcePlugin.config.root_dir)
+      return sprockets.index.call(env)
+    end
+    require_relative 'plugin_factory/_init_sinatra'
+    FanforcePlugin::Sinatra.new.call(env)
+  end
+
+  require_relative 'plugin_factory/config/sinatra_config'
+  require_relative 'plugin_factory/initializers/ff_globals'
+end
+