atduskgreg-dm-fql-adapter 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-07-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+example_app.rb
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/dm-fql-adapter.rb
+lib/dm-fql-adapter/facemask.rb
+script/console
+script/destroy
+script/generate
+spec/dm-fql-adapter_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,3 @@
+For more information on dm-fql-adapter, see http://github.com/atduskgreg/dm-fql-adapter
+
+

data/README.rdoc

@@ -0,0 +1,14 @@
+An FQL Adapter for DataMapper. Read-only.
+
+FQL is the "Facebook Query Language": an API that allows you to send SQL-ish strings along with session information and API credentials to Facebook in order to query for information about users, comments, stream activity and more. See the FQL docs here: http://wiki.developers.facebook.com/index.php/FQL
+
+For usage, see example_app.rb.
+
+As of 7/16/09, this only ran on the DataMapper Next branch (i.e. 0.10). For details on how to upgrade to that branch, see here: http://sick.snusnu.info/2009/06/03/migrating-to-datamapper-0100/
+
+At some point, I will probably factor this into a gem. You know, if people bug me.
+
+Also, this repo includes Facemask, a more straightforward approach to querying the Facebook API than some of the more complex libs out there.
+
+-- Greg Borenstein
+7/16/09 in Portland, OR

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/dm-fql-adapter'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'dm-fql-adapter' do
+  self.developer 'Greg Borenstein', 'greg.borenstein@gmail.com'
+  self.version = "0.0.1"
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.summary = "FQL Adapter for DataMapper"
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/example_app.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'sinatra'
+require 'dm-core'
+require 'dm-fql-adapter'
+
+class User
+  include DataMapper::Resource
+  
+  # NB: If you don't pick a key DM will act weird
+  property :uid, Integer, :key => true 
+  property :name, String
+  property :sex, String
+  property :pic_big, String
+end
+
+post "/" do
+  adapter = DataMapper.setup(:default, 
+    {:adapter => 'fql', 
+     :api_key => "YOUR API KEY", 
+     :secret_key => "YOUR SECRET KEY", 
+     :session_key => params[:fb_sig_session_key]
+      }
+    )
+
+  user = User.get(546502145)
+  "#{user.name} - #{user.sex} <img src=\"#{user.pic_big}\" />"
+end

data/lib/dm-fql-adapter.rb

@@ -0,0 +1,49 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'dm-core'  
+require DataMapper.root / 'lib' / 'dm-core' / 'adapters' / 'abstract_adapter'
+require DataMapper.root / 'lib' / 'dm-core' / 'adapters' / 'data_objects_adapter'
+require File.expand_path(File.dirname(__FILE__)) + '/dm-fql-adapter/facemask.rb'
+require 'json'
+
+module DataMapper
+  module Adapters
+    
+    class DataObjectsAdapter
+      module SQL
+        def quote_name(name)
+          name
+        end
+      end
+    end
+    
+    class FqlAdapter < AbstractAdapter
+
+      include DataMapper::Adapters::DataObjectsAdapter::SQL
+
+      def initialize(name, options={})
+        super
+        
+        self.resource_naming_convention = DataMapper::NamingConventions::Resource::Underscored        
+        
+        @facebook = Facemask.new :api_key     => options[:api_key],
+                                 :secret_key  => options[:secret_key],
+                                 :session_key => options[:session_key]
+      end
+      
+      def read(query)        
+        q = select_statement(query).to_s
+      
+        # hack around the mysterious '?'
+        q = q.gsub(/\?(\w*)/){"\"#{$1}\""}
+
+        results = @facebook.find_by_fql(q)
+        results = JSON.parse(results)
+        query.filter_records(results)
+      end
+      
+
+    end # class FqlAdapter
+  end
+end

data/lib/dm-fql-adapter/facemask.rb

@@ -0,0 +1,80 @@
+require 'md5'
+require 'json'
+require 'rubygems'
+require 'rest_client'
+
+class Facemask
+  class FaceFail < StandardError; end
+  
+  attr_accessor :session_key, :api_key, :secret_key
+  
+  def initialize opts={}
+    @api_key = opts[:api_key]
+    @secret_key = opts[:secret_key]
+    @session_key = opts[:session_key]
+  end
+  
+  # Execute raw FQL and return the results in JSON
+  def find_by_fql(query)
+    post('facebook.fql.query', :query => query, :format => "json")
+  end
+  
+  # Sends a templatized feed for the given bundle_id with the given data hash.
+  def publish_user_feed(bundle_id, data)
+    post("facebook.feed.publishUserAction", {:template_bundle_id=> bundle_id, 
+                                             :template_data => data.to_json} )
+  end
+
+  def publish_page_feed(data)
+    data[:title_template] ||= "{actor} Item"
+    post("facebook.feed.publishTemplatizedAction", data)
+  end
+  
+  def post(method, params)
+    params.merge! generate_params(method)
+    params.merge! :sig => signature_for(params)
+    Facemask.execute(params)
+  end
+  
+    
+
+  def self.execute(params)
+    begin
+      puts "[FBOOK REQUEST] #{params.inspect}"
+      result = RestClient.post("http://api.facebook.com/restserver.php", params)
+    rescue Errno::ECONNRESET, EOFError
+      if attempt == 0
+        attempt += 1
+        puts "Failed once, retrying..."
+        retry
+      end
+    rescue Exception => e
+      raise FaceFail.new(e)
+    end        
+  end
+  
+  def signature_for(params)
+    raw_string = params.inject([]) do |collection, pair|
+      collection << pair.join("=")
+      collection
+    end.sort.join
+    puts "ABOUT TO HEX"
+    puts raw_string
+    puts self.secret_key
+    Digest::MD5.hexdigest([raw_string, self.secret_key].join)
+  end
+  
+  def generate_params(method)
+    result = {}
+    if session_key
+      result[:session_key] = session_key    
+    end
+    
+    result[:method] = method
+    result[:api_key] = api_key
+    result[:call_id] = Time.now.to_f.to_s
+    result[:v] = "1.0"
+    
+    result
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/dm-fql-adapter.rb'}"
+puts "Loading dm-fql-adapter gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/dm-fql-adapter_spec.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'spec'
+require 'dm-core'
+require File.expand_path(File.dirname(__FILE__)) + '/../lib/dm-fql-adapter.rb'
+
+class User
+  include DataMapper::Resource
+
+  property :uid, Integer, :key => true # !important
+  property :name, String
+  property :sex, String
+  property :pic_big, String
+end
+
+describe DataMapper::Adapters::FqlAdapter do
+  before :all do
+    Facemask.stub!(:new).and_return(@f = mock('Facemask'))                                      
+
+    @adapter = DataMapper.setup(:default, :adapter   => 'fql',
+                                          :api_key  => 'api',
+                                          :secret_key      => 'secret')
+  end
+
+  it "should generate the correct FQL" do
+    @f.should_receive(:find_by_fql).with("SELECT uid, name, sex, pic_big FROM user WHERE uid = \"12345\"").and_return('[{"name":"Cyndy Glucksman","pic_big":"http:\/\/profile.ak.fbcdn.net\/v227\/1454\/108\/n500409376_1710.jpg","sex":"female","uid":500409376}]')
+    User.get(12345)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'dm-fql-adapter'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: atduskgreg-dm-fql-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Greg Borenstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: ""
+email: 
+- greg.borenstein@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- example_app.rb
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/dm-fql-adapter.rb
+- lib/dm-fql-adapter/facemask.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/dm-fql-adapter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: 
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dm-fql-adapter
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: FQL Adapter for DataMapper
+test_files: []
+