blue_velvet 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Tom Scott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+# BlueVelvet
+
+BlueVelvet is a content management system that uses the Facebook
+platform as the data store. It allows you to map route actions to
+Facebook API calls and display the results with partials in your other
+pages. You can even subclass the controller and create your own actions,
+using one or more of your Facebook page's plethora of properties.
+
+## Usage
+
+Add the gem to your Gemfile
+
+    gem 'blue_velvet'
+
+Then rebundle
+
+    $ bundle install
+
+Generate the Facebook configuration YAML file and edit it with your
+Facebook App details. Obtain your Facebook page ID from the URL of your
+Facebook page, it's the number at the end, after the hyphenated name and
+a "/"..
+
+    $ rails generate facebook:config
+
+And finally, add the query to your `config/routes.rb`:
+
+    get "/about" => "facebook/page#description"
+
+If you start up your Rails server, you can now browse to
+`http://localhost:3000/about` and expect to see the content in your
+Facebook page's description!
+
+For more information on the many properties available to you, check out
+the API documentation.
+
+## Background
+
+This project is the result of the work I've done on my band's website,
+[TheWonderBars.com](http://thewonderbars.com). I didn't want to have to
+maintain two versions of press data, and since we had an active Facebook
+page that was chock full of content well before the site was designed and 
+deployed, I considered using Facebook as our main "database", rather
+than a locally-maintained SQL database of some kind. At this point in
+time, TheWonderBars.com does not require a database in order to
+function.
+
+## Contributing
+
+All contributions will be examined and considered. Anyone can feel free
+to make their voice known by contributing to the project. Click the
+"Fork" button on the top of the screen (register a GitHub account if you
+don't already have one), create a feature branch, and submit the changes
+back to me in the form of a pull request.
+
+You must write tests for your feature or bug fix and they must pass.
+
+## License
+
+Copyright 2012 Tom Scott
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,42 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BlueVelvet'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Configure the dummy app with a dummy Facebook page."
+task :configuration do
+  cp "config/facebook.yml", "test/dummy/config/facebook.yml"
+end
+
+task :default => :test

data/app/assets/javascripts/blue_velvet/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree ../facebook

data/app/assets/stylesheets/blue_velvet/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree ../facebook
+ */

data/app/assets/stylesheets/facebook/attribute.css.scss

@@ -0,0 +1,2 @@
+.facebook_attribute {
+}

data/app/controllers/facebook/page_controller.rb

@@ -0,0 +1,54 @@
+# The interim between the Facebook page data and the end user, this defines the internal API
+# used by the Rails app to call Facebook attributes as if they were controller actions.
+class Facebook::PageController < ApplicationController
+  # Much like method_missing, this method is called when ApplicationController can't find
+  # the hard-coded action. For this controller specifically, it will be called on all routing
+  # requests to +facebook/page+.
+  #
+  # This method retrieves any attribute from the Facebook page and displays it with a consistent
+  # partial template. The template used is page_attribute, which creates a +<div class="facebook_attribute"
+  # id="{whatever-facebook-attribute-you-used}>+ and renders it with the contents of the Facebook
+  # attribute. Because this method makes use of a partial, it can be called in place of any other
+  # +render+ or +redirect_to+ call, from any part of the application like so:
+  # 
+  #     class InfoController < ApplicationController
+  #       def about
+  #         render 'facebook/page#description'
+  #       end
+  #     end
+  #
+  # Or, you may route to the action:
+  #
+  #     get "/about" => "facebook/page#description"
+  #
+  # Note that using routes.rb is easier, but binds you to using CSS as the main method of
+  # customization. You may override our styles if you simply create styles for
+  # +.facebook_attribute+, and for individual pages the name of the attribute as an ID.
+  def action_missing attribute_name
+    if facebook.has_attribute? attribute_name
+      attribute_content = facebook.send(:"#{attribute_name}").gsub(/\n/, "<br>")
+      attribute = Facebook::Attribute.new \
+        name: attribute_name.parameterize,
+        title: attribute_name.titleize,
+        body: attribute_content
+      render partial: 'page_attribute', locals: { attribute: attribute }
+    else
+      render partial: 'attribute_not_found', locals: { attribute_name: "#{attribute_name}" }
+    end
+  end
+
+protected
+  # Shorthand accessor for the omnipresent Facebook client
+  def facebook
+    @facebook_client ||= Facebook::Client.new
+  end
+
+private
+  def use_layout
+    if request.xhr?
+      false
+    else
+      'application'
+    end
+  end
+end

data/app/models/facebook/attribute.rb

@@ -0,0 +1,8 @@
+# Display a Facebook page attribute for use in the Rails view layer.
+class Facebook::Attribute
+  attr_accessor :name, :title, :body
+
+  def initialize with_options={}
+    with_options.each { |key,val| self.send :"#{key}=", val }
+  end
+end

data/app/models/facebook/client.rb

@@ -0,0 +1,45 @@
+# A client for the Facebook Graph API which looks for data on a specific Facebook page or profile. It
+# reads from the YAML configuration stored in `config/facebook.yml` for the current Rails environment.
+class Facebook::Client
+  attr_reader :graph, :oauth
+  attr_accessor :page
+
+  # Connects to the open graph.
+  def initialize options={}
+    @oauth = Koala::Facebook::OAuth.new \
+        Facebook.config[:app_id], Facebook.config[:secret_key]
+    @graph = Koala::Facebook::API.new access_token
+    @page = @graph.get_object(Facebook.config[:page_id])
+  end
+
+  def has_attribute? attribute
+    @page["#{attribute}"].present?
+  end
+
+  # Gets any attribute from Facebook, as long as it's within the filter, and returns it.
+  def method_missing attribute
+    if @page.present?
+      if self.has_attribute? attribute
+        @page["#{attribute}"]
+      else
+        raise Facebook::AttributeNotFound
+      end
+    else
+      raise Facebook::PageNotFound
+    end
+  end
+
+  private
+
+  def access_token
+    @oauth.get_app_access_token
+  end
+end
+
+module Facebook
+  # Thrown when the Facebook page doesn't have the attribute requested.
+  class AttributeNotFound < StandardError; end
+
+  # Thrown when the Facebook page can't be found
+  class PageNotFound < StandardError; end
+end

data/app/views/facebook/page/_attribute_not_found.html.erb

@@ -0,0 +1,8 @@
+<div id="error">
+  <h2>Attribute Not Found</h2>
+  <p>
+    We're sorry, but the requested attribute <strong><%= attribute_name %></strong>
+    could not be found on this Facebook page. Either it has not been filled in yet, 
+    or the page author has opted not to publicize its contents.
+  </p>
+</div>

data/app/views/facebook/page/_page_attribute.html.erb

@@ -0,0 +1,7 @@
+<div class="facebook_attribute" id="<%= attribute.name %>">
+  <h2><%= attribute.title %></h2>
+
+  <p>
+    <%= attribute.body %>
+  </p>
+</div>

data/config/facebook.yml

@@ -0,0 +1,18 @@
+# This is your Facebook configuration file. Put your Facebook app info in this file
+# and it will be read by the Rails application. and BlueVelvet.
+
+development:
+  app_id: 149744351829141
+  secret_key: 0a8de678e00605bda2c583ea187d197e
+  page_id: 137797553025194
+
+test:
+  app_id: 149744351829141
+  secret_key: 0a8de678e00605bda2c583ea187d197e
+  page_id: 137797553025194
+
+production:
+  app_id: 149744351829141
+  secret_key: 0a8de678e00605bda2c583ea187d197e
+  page_id: 137797553025194
+

data/config/initializers/koala.rb

@@ -0,0 +1,29 @@
+require 'koala'
+
+module Facebook
+  def self.config
+    if Rails.env.staging?
+      ActiveSupport::HashWithIndifferentAccess.new \
+        app_id: ENV['FB_APP_ID'],
+        secret_key: ENV['FB_SECRET_KEY'],
+        page_id: ENV['FB_PAGE_ID']
+    else
+      ActiveSupport::HashWithIndifferentAccess.new \
+        YAML.load_file(Rails.root.join("config/facebook.yml"))[Rails.env]
+    end
+  end
+end
+
+Koala::Facebook::OAuth.class_eval do
+  def initialize_with_default_settings(*args)
+    case args.size
+      when 0, 1
+        raise "application id and/or secret are not specified in the config" unless Facebook.config[:app_id].present? && Facebook.config[:secret_key].present?
+        initialize_without_default_settings(Facebook.config[:app_id], Facebook.config[:secret], args.first)
+      when 2, 3
+        initialize_without_default_settings(*args)
+    end
+  end
+
+  alias_method_chain :initialize, :default_settings
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+BlueVelvet::Engine.routes.draw do
+end

data/lib/blue_velvet/engine.rb

@@ -0,0 +1,6 @@
+module BlueVelvet
+  class Engine < ::Rails::Engine
+    isolate_namespace BlueVelvet
+    #isolate_namespace Facebook
+  end
+end

data/lib/blue_velvet/version.rb

@@ -0,0 +1,3 @@
+module BlueVelvet
+  VERSION = "1.0.0"
+end

data/lib/blue_velvet.rb

@@ -0,0 +1,4 @@
+require "blue_velvet/engine"
+
+module BlueVelvet
+end

data/lib/generators/facebook/config_generator.rb

@@ -0,0 +1,15 @@
+# Creates YAML configuration in +config/facebook.yml+ which helps you
+# connect to the Facebook platform. Required inherently by Koala, which
+# forms the backend of this gem.
+class Facebook::ConfigGenerator < Rails::Generators::Base
+  # Edit this file with your Facebook app details
+  def create_yaml_file
+    copy_file "config/facebook.yml", "#{Rails.root}/config/facebook/yml"
+  end
+
+  # Don't touch this file, all it does is read from YAML and instantiate
+  # Koala.
+  def create_initializer
+    copy_file "config/initializers/koala.rb", "#{Rails.root}/config/initializers/koala.rb"
+  end
+end

data/lib/generators/facebook/views_generator.rb

@@ -0,0 +1,14 @@
+# Copies internal gem views for use in the main app. Any view files
+# encountered in the app in the same location as those in the engine
+# will override the default views, so this generator allows you to
+# customize the display of your Facebook content.
+class Facebook::ViewsGenerator < Rails::Generators::Base
+  def copy_page_views
+    views_dir = File.join(__FILE__, 'app', 'views', 'facebook')
+    Dir[views_dir].each do |view_file_path|
+      view_file = File.basename view_file_path
+      app_path = "#{Rails.root}/app/views/facebook/#{view_file}"
+      copy_file view_file_path, app_path
+    end
+  end
+end

data/test/blue_velvet_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BlueVelvetTest < ActiveSupport::TestCase
+  test "the module exists" do
+    assert_kind_of Module, BlueVelvet
+  end
+end