blue_velvet 1.0.0 → 1.0.1

data/README.md

@@ -1,11 +1,32 @@
+[![Heineken? Fuck that shit!](https://sphotos-a.xx.fbcdn.net/hphotos-prn1/552344_137798096358473_725002513_n.jpg)](http://www.youtube.com/watch?v=snhiofL2Rh4)
+
 # 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,
+ages. You can even subclass the controller and create your own actions,
 using one or more of your Facebook page's plethora of properties.
 
+[![Build Status](https://secure.travis-ci.org/tubbo/blue_velvet.png?branch=master)](http://travis-ci.org/tubbo/blue_velvet)
+
+## In The Wild
+
+BlueVelvet can be observed "in the wild" on <http://thewonderbars.com>.
+I've also [open-sourced the
+codebase](https://github.com/tubbo/thewonderbars.com/tree/develop) to
+give an example as to how this gem could be/is being used.
+
+**NOTE:** At this time, I haven't deployed the site using blue_velvet to
+the server for <http://thewonderbars.com>. I've been very busy with work
+and setting up gigs for the band, so I haven't gotten around to getting
+all that up and running. In keeping with my philosophy of reserving the
+'master' branch for the working, released version of the code, the
+source tree using this gem is available in the 'develop' branch. Soon, I
+will merge this branch into master and BlueVelvet will deploy on
+<http://thewonderbars.com>. Until then, check out the source and if you
+don't believe me, download the app and run it yourself!
+
 ## Usage
 
 Add the gem to your Gemfile
@@ -17,12 +38,33 @@ 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 "/"..
+Facebook App details. If you don't know how to do that, look below
+in the "Configuration" section.
 
     $ rails generate facebook:config
 
+It should look something like this:
+
+```yaml
+# This is your Facebook configuration file. Put your Facebook app info in this file
+# and it will be read by the Rails application.
+
+development:
+  app_id:
+  secret_key:
+  page_id:
+
+test:
+  app_id:
+  secret_key:
+  page_id:
+
+production:
+  app_id:
+  secret_key:
+  page_id:
+```
+
 And finally, add the query to your `config/routes.rb`:
 
     get "/about" => "facebook/page#description"
@@ -34,6 +76,25 @@ Facebook page's description!
 For more information on the many properties available to you, check out
 the API documentation.
 
+## Configuration
+
+All configuration is taken care of in a file called
+`config/facebook.yml`. This is also the file used by 
+[Koala](https://github.com/arsduo/koala), the gem that is actually 
+communicating with the Facebook Graph API, so if you're used
+to working with that configuration this should be easy for you.
+
+In order to use blue_velvet, you must create a Facebook app on
+<https://developers.facebook.com>. Once you do that, obtain the
+following information from the new app page on the control panel:
+
+- App ID/API Key
+- App Secret
+- Your Facebook page ID, which can be obtained by visiting your Facebook page and observing the number at the very end of the address bar, right after the "/".
+
+Add that information into your YAML config, and you can begin using
+blue_velvet in your application.
+
 ## Background
 
 This project is the result of the work I've done on my band's website,
@@ -77,3 +138,10 @@ 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.
+
+## Extended Documentation
+
+- [Facebook API documentation](https://developers.facebook.com)
+- [Facebook Apps Control Panel](https://developers.facebook.com/apps)
+- [RDoc code documentation](http://rdoc.info/github/tubbo/blue_velvet/master/frames)
+- [RubyGems page](https://rubygems.org/gems/blue_velvet)

data/Rakefile

@@ -1,6 +1,7 @@
 #!/usr/bin/env rake
 begin
   require 'bundler/setup'
+  require 'bundler/gem_tasks'
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end

data/lib/blue_velvet/version.rb

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

data/lib/generators/facebook/config/USAGE

@@ -0,0 +1,15 @@
+Description:
+    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. Also creates a file in
+    +config/initializers+ that helps set up Koala with this
+    configuration. You may optionally use this file to pass
+    configuration to Koala directly, as it conforms to most people's
+    conventional use of the gem.
+
+Example:
+    rails generate facebook:config
+
+    This will create:
+        config/facebook.yml
+        config/initializers/koala.rb

data/lib/generators/facebook/config/config_generator.rb

@@ -0,0 +1,13 @@
+module Facebook
+  # Generate configuration for BlueVelvet and Koala.
+  class ConfigGenerator < Rails::Generators::Base
+    desc "Copies Facebook/Koala configuration to your application"
+    source_root File.expand_path('../templates', __FILE__)
+
+    # Edit this file with your Facebook app details
+    def copy_configuration
+      copy_file "facebook.yml", "config/facebook.yml"
+      copy_file "koala.rb",     "config/initializers/koala.rb"
+    end
+  end
+end

data/lib/generators/facebook/config/templates/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: 
+  secret_key: 
+  page_id: 
+
+test:
+  app_id: 
+  secret_key: 
+  page_id: 
+
+production:
+  app_id: 
+  secret_key: 
+  page_id: 
+

data/lib/generators/facebook/config/templates/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/lib/generators/facebook/views/USAGE

@@ -0,0 +1,12 @@
+Description:
+    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.
+
+Example:
+    rails generate facebook:views
+
+    This will create:
+        app/views/facebook/page/_attribute_not_found.html.haml
+        app/views/facebook/page/_page_attribute.html.haml

data/lib/generators/facebook/views/views_generator.rb

@@ -0,0 +1,11 @@
+module Facebook
+  # Generate views for the Facebook namespace.
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../../app/views', __FILE__)
+
+    def copy_views
+      directory "facebook", "app/views/facebook"
+    end
+  end
+end
+

data/test/dummy/log/test.log

@@ -933,3 +933,65 @@ Processing by Facebook::PageController#events as HTML
   Rendered /Users/necromancer/Code/blue_velvet/app/views/facebook/page/_attribute_not_found.html.erb (0.5ms)
 Completed 200 OK in 14ms (Views: 1.8ms | ActiveRecord: 0.0ms)
    (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (3.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Processing by Facebook::PageController#events as HTML
+  Rendered /Users/necromancer/Code/blue_velvet/app/views/facebook/page/_attribute_not_found.html.erb (2.9ms)
+Completed 200 OK in 65ms (Views: 43.7ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+Processing by Facebook::PageController#about as HTML
+  Rendered /Users/necromancer/Code/blue_velvet/app/views/facebook/page/_page_attribute.html.erb (1.0ms)
+Completed 200 OK in 327ms (Views: 16.6ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (0.5ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.2ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.0ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.1ms)  begin transaction
+Processing by Facebook::PageController#events as HTML
+  Rendered /Users/necromancer/Code/blue_velvet/app/views/facebook/page/_attribute_not_found.html.erb (2.5ms)
+Completed 200 OK in 33ms (Views: 14.6ms | ActiveRecord: 0.0ms)
+   (0.1ms)  rollback transaction
+   (0.0ms)  begin transaction
+Processing by Facebook::PageController#about as HTML
+  Rendered /Users/necromancer/Code/blue_velvet/app/views/facebook/page/_page_attribute.html.erb (0.9ms)
+Completed 200 OK in 151ms (Views: 2.4ms | ActiveRecord: 0.0ms)
+   (0.3ms)  rollback transaction

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blue_velvet
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -81,8 +81,12 @@ files:
 - lib/blue_velvet/engine.rb
 - lib/blue_velvet/version.rb
 - lib/blue_velvet.rb
-- lib/generators/facebook/config_generator.rb
-- lib/generators/facebook/views_generator.rb
+- lib/generators/facebook/config/config_generator.rb
+- lib/generators/facebook/config/templates/facebook.yml
+- lib/generators/facebook/config/templates/koala.rb
+- lib/generators/facebook/config/USAGE
+- lib/generators/facebook/views/USAGE
+- lib/generators/facebook/views/views_generator.rb
 - MIT-LICENSE
 - Rakefile
 - README.md

data/lib/generators/facebook/config_generator.rb

@@ -1,15 +0,0 @@
-# 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

@@ -1,14 +0,0 @@
-# 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