fanforce-plugin-factory 0.41.0 → 1.6.0.rc1

data/.gitignore

@@ -14,6 +14,7 @@ tmp
 .idea/
 .DS_STORE
 Gemfile.lock
+!._*.registry
 
 # YARD artifacts
 .yardoc

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/.yardopts

@@ -0,0 +1,5 @@
+lib/**/*.rb
+--load ./.yardopts.rb
+--markup-provider=redcarpet
+--markup=markdown
+--readme README.md

data/.yardopts.rb

@@ -0,0 +1 @@
+require 'redcarpet/compat'

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
 gemspec
+
+group :development, :test do
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'simplecov', :require => false
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup', :require => true
+end

data/README.md

@@ -17,19 +17,16 @@ ruby '1.9.3'
 
 gem 'fanforce-plugin-factory'
 ```
-One you've created the Gemfile you'll need to run bundler install.
+One you've created the Gemfile you'll need to run bundle install.
 
 ### /config.ru
-Only seven lines are required (in addition to having a Redis server).
+Only four lines are required (you must have 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
+require 'fanforce/plugin_factory'
+Fanforce::Plugin.config { |config| config._id = 'facebook' }
+run Fanforce::Plugin
 ```
 You can replace config._id (as in the example above) with an environment variable: ENV['FANFORCE_PLUGIN_ID']
 
@@ -38,23 +35,19 @@ Your plugin can now be added to the Fanforce Marketplace. Use the follow config
 
 ```ruby
 "public_urls": {
+    "marketplace_img": "http://${PRIMARY_DOMAIN}/assets/marketplace.png",
     "icon_16": "http://${PRIMARY_DOMAIN}/assets/icon-16.png",
-    "icon_32": "http://${PRIMARY_DOMAIN}/assets/icon-32.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"
+    "dashboard": "http://${PRIMARY_DOMAIN}/dashboard.html"
 },
 "callback_urls": {
     "install": "http://${PRIMARY_DOMAIN}/install",
     "uninstall": "http://${PRIMARY_DOMAIN}/uninstall"
 },
-"widget_dependencies": [
-    {
-        "widget-name-here": "http://${PRIMARY_DOMAIN}/widget_tmpls"
-    }
-]
+"plugin_dependencies": []
 ```
 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.
 
@@ -67,44 +60,29 @@ There are lots of ways you can start building out and customizing your plugin...
 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.
+    * /dashboard.js - this is included in the dashboard.html file.
+* /css
+    * /dashboard.css - this is also included in the dashboard.html file.
 * /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.
+    * /marketplace.png - this icon must be 220px by 142px.
 
 ### /views
-HAML is the default layout engine. The .haml extension is converted to .html when served in the browser.
+HAML is setup by default. The extension is changed 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.
+*Default Views:*
+* /index.haml - default page visitors will see if they try to access domain
+* /dashboard.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
+*Default Layouts:*
+* /dashboard.haml - the wrapper layout for views/dashboard.haml
+* /promotional.haml - the wrapper layout for views/index.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).
@@ -113,19 +91,19 @@ Anything you put in here will be publicly available. The only folder you should
 * /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:
+The fanforce-plugin-factory sets up all the required routes. If you want to customize existing routes or add new ones, create a config/routes.rb file and specify routes within the Plugin:Sinatra class:
 ```
-class FanforcePlugin::Sinatra
+class Plugin::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.
+Check out [Sinatra's](http://www.sinatrarb.com/documentation) documentation for more details on routes and much more. The Plugin::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.
+Overwrite any existing routes by specifying them in your config/routes.rb. You can also pull default route logic into your new custom routes by calling route_[NAME_OF_ROUTE] method.
 ```
-class FanforcePlugin::Sinatra
+class Plugin::Sinatra
   any '/install' do
     # do whatever you want here
     route_install
@@ -134,29 +112,17 @@ end
 ```
 *Default Routes:*
 - route_index:     get ['/','/index.html']
+- route_dashboard: get '/dashboard.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 '/:organization_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
+class Plugin::Sinatra
 
   use Rack::Session::Cookie
   use OmniAuth::Builder do
@@ -169,7 +135,8 @@ 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
+
+# Loading 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
@@ -189,42 +156,40 @@ 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'
 ```
 
+# Create Plugin-Specific ENV Variables In Development
+Documentation coming soon.
+
 # 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|
+require 'bundler'; Bundler.setup
+require 'fanforce/plugin_factory'
+Fanforce::Plugin.config do |config|
   config.redis_url = 'redis://USERNAME:PASSWORD@HOST:PORT'
 end
+load 'fanforce/plugin.rake'
 ```
 
+
 # Using Fanforce::Worker
 
-FanforcePlugin includes the fanforce-workers gem by default and includes a convenience helper method. FanforcePlugin.enqueue
+Fanforce::Plugin includes the fanforce-workers gem by default and includes a convenience helper method. Fanforce::Plugin.enqueue
 will prefix the name of your worker with the name of your plugin to ensure there are no conflicts across multiple plugins
-or apps. This is the naming convention used by Fanforce Factory when creating and uploading Iron.io workers.
+or plugins. This is the naming convention used by Fanforce Factory when creating and uploading Iron.io workers.
 
 As an example, if you have a testing.worker file, you would use the following command:
 
 ```
-FanforcePlugin.enqueue 'testing', {params_to_send: 'whatever'}
+Fanforce::Plugin.enqueue 'testing', {params_to_send: 'whatever'}
 ```
 
 

data/Rakefile

@@ -3,14 +3,71 @@ require 'rake/testtask'
 require 'fileutils'
 include FileUtils
 
-# Default Rake task is compile
-#task :default => :compile
+task :pre_build do
+  Rake::Task['test'].execute
+  puts '---------------------------------------------------------------------'
+  puts 'TESTS PASSED!'
+  puts '---------------------------------------------------------------------'
+  puts 'UPDATING SCAFFOLDING DIGESTS...'
+  Rake::Task['scaffolding:register'].execute
+  puts 'READY TO BUILD!'
+  puts '---------------------------------------------------------------------'
+end
+
+namespace :scaffolding do
+  require 'digest'
+
+  class Fanforce::CLI
+    DIR = ''
+    TYPE = ''
+  end
+
+  require 'fanforce/plugin_factory/cli'
+  require 'fanforce/plugin_factory/cli/lib/scaffolding_file'
+
+  task :register do
+    scaffolding_dir = File.expand_path('../lib/fanforce/plugin_factory/scaffolding', __FILE__)
+
+    Dir.glob("#{scaffolding_dir}/**/*", File::FNM_DOTMATCH).each do |scaffold_filepath|
+      next if scaffold_filepath =~ /\.registry/ or File.directory?(scaffold_filepath)
+
+      file_parts = scaffold_filepath.split('/')
+      registry_filepath = "#{file_parts[0...-1].join('/')}/._#{file_parts[-1]}.registry"
+
+      file = Fanforce::PluginFactory::CLI::ScaffoldingFile.new(scaffold_filepath)
+      if [:file,:image,:partial].include?(file.scaffold_type)
+        next if file.digest_exists_in_registry?(file.scaffold_digest)
+        File.open(registry_filepath, 'a') {|f|
+          f.puts "fanforce-plugin-factory-#{Fanforce::PluginFactory::VERSION}:#{file.scaffold_digest}"
+        }
+      elsif [:items].include?(file.scaffold_type)
+        scaffold_contents = File.open(file.scaffold_filepath).read
+        raise "item changes are not registered for #{file.scaffold_filepath}" if !file.list_matches_latest_registry?(scaffold_contents)
+        next
+      elsif [:json].include?(file.scaffold_type)
+        scaffold_contents = File.open(file.scaffold_filepath).read
+        raise "json changes are not registered for #{file.scaffold_filepath}" if !file.json_matches_latest_registry?(scaffold_contents)
+        next
+      elsif [:skipped].include?(file.scaffold_type)
+        next
+      else
+        raise "unknown scaffold type: #{file.scaffold_type}"
+      end
+
+      puts "- REGISTERED #{scaffold_filepath.gsub(scaffolding_dir, '')} (#{file.scaffold_type})"
+    end
+  end
+
+end
+
+task :build => :pre_build
+task :default => :build
 
 ########################################################################
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
+  t.libs.push 'lib'
+  t.libs.push 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end

data/fanforce-plugin-factory.gemspec

@@ -10,34 +10,34 @@ Gem::Specification.new do |gem|
   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.homepage    = 'http://github.com/fanforce/gem-fanforce-plugin-factory'
 
   gem.files         = `git ls-files`.split($/)
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'rake',            '~> 0.8.7'
-  gem.add_runtime_dependency 'redis',           '~> 3.0.5'
-  gem.add_runtime_dependency 'sinatra',         '~> 1.4.3'
-  gem.add_runtime_dependency 'sinatra-contrib', '~> 1.4.1'
+  gem.add_runtime_dependency 'rake',            '~> 10.3.2'
+  gem.add_runtime_dependency 'redis',           '~> 3.1.0'
+  gem.add_runtime_dependency 'sinatra',         '~> 1.4.5'
+  gem.add_runtime_dependency 'sinatra-contrib', '~> 1.4.2'
   gem.add_runtime_dependency 'rack-contrib',    '~> 1.1.0'
-  gem.add_runtime_dependency 'haml',            '~> 4.0.3'
-  gem.add_runtime_dependency 'coffee-script',   '~> 2.2.0'
-  gem.add_runtime_dependency 'activesupport',    '3.2.13'
+  gem.add_runtime_dependency 'haml',            '~> 4.0.5'
+  gem.add_runtime_dependency 'coffee-script',   '~> 2.3.0'
 
-  gem.add_runtime_dependency 'sass',            '~> 3.2.12'
-  gem.add_runtime_dependency 'compass',         '~> 0.12.2'
-  gem.add_runtime_dependency 'sprockets',       '~> 2.10.0'
-  gem.add_runtime_dependency 'sprockets-sass',  '~> 1.0.2'
+  gem.add_runtime_dependency 'sass',            '~> 3.4.5'
+  gem.add_runtime_dependency 'compass',         '~> 1.0.1'
+  gem.add_runtime_dependency 'sprockets',       '~> 2.12.2'
+  gem.add_runtime_dependency 'sprockets-sass',  '~> 1.2.0'
   gem.add_runtime_dependency 'yui-compressor',  '~> 0.12.0'
-  gem.add_runtime_dependency 'uglifier',        '~> 2.2.1'
-  gem.add_runtime_dependency 'therubyracer',    '~> 0.12.0'
+  gem.add_runtime_dependency 'uglifier',        '~> 2.5.3'
+  gem.add_runtime_dependency 'therubyracer',    '~> 0.12.1'
 
-  gem.add_runtime_dependency 'bugsnag',         '~> 1.5.2'
-  gem.add_runtime_dependency 'rack-jsonr',      '~> 0.2.6'
+  gem.add_runtime_dependency 'bugsnag',         '~> 2.5.0'
+  gem.add_runtime_dependency 'rack-jsonr',      '~> 0.2.7'
 
-  gem.add_runtime_dependency 'fanforce',            '~> 0.18'
-  gem.add_runtime_dependency 'fanforce-api',        '~> 0.20'
-  gem.add_runtime_dependency 'fanforce-exceptions', '~> 0.5'
-  gem.add_runtime_dependency 'fanforce-worker',     '~> 0.20'
+  gem.add_runtime_dependency 'rest_client',     '= 1.7.3'
+
+  gem.add_runtime_dependency 'fanforce-base',          '~> 1.6.0'
+  gem.add_runtime_dependency 'fanforce-api',           '~> 1.6.0'
+  gem.add_runtime_dependency 'fanforce-plugin-worker', '~> 1.6.0'
 end

data/lib/fanforce/plugin_factory.rb

@@ -1,68 +1,26 @@
-ENV['RACK_ENV'] ||= 'development'
-####################################################################################
-require 'rack/jsonr'
-require 'fanforce/api'
-require 'fanforce/worker'
-require 'active_support/all'
-require 'sinatra/base'
-require 'fileutils'
-require 'redis'
 require_relative 'plugin_factory/version'
+require_relative 'plugin_factory/load'
 
-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.enqueue(queue_name, payload)
-    Fanforce::Worker.enqueue "#{config._id}-#{queue_name}", payload
-  end
+########################################################################################################################
 
-  def self.config(&block)
-    config = @@config ||= FanforcePlugin::CoreConfig.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
+class Fanforce::PluginFactory
 
-  def self.root
-    config.root_dir
-  end
+  def self.generate(plugin_base_dir)
+    require_relative 'plugin_factory/plugin'
+    require_relative 'plugin_factory/load_sprockets' if ENV['RACK_ENV'] == 'development'
 
-  def self.dir_name
-    config.dir_name
-  end
-
-  def self._id
-    config._id
+    Fanforce::Plugin.load(plugin_base_dir)
   end
+end
 
-  def self.type
-    config.type
-  end
+########################################################################################################################
 
-  def self.load_config
-    config.load
-  end
+# The following is run if file is required from config.ru or Rakefile
+if caller[0].split(':')[0] =~ /^(.+)\/(config\.ru|Rakefile)$/
+  plugin_base_dir = $1
+  loader_filename = $2
+  ENV['RACK_ENV'] ||= 'development'
 
-  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'
-    request = Rack::Request.new(env)
-    Rack::JSONR.intercept_method_override(env, request, request.params, :all)
-    FanforcePlugin::Sinatra.new.call(env)
-  end
-
-  require_relative 'plugin_factory/config/core_config'
+  Fanforce::PluginFactory.generate(plugin_base_dir)
+  load "#{Fanforce::Plugin.config.factory_dir}/Rakefile" if loader_filename == 'Rakefile'
 end
-