fb_joy 0.1.2

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+gem 'hashie'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec",    ">= 2.3.0"
+  gem "bundler",  ">= 1.0.0"
+  gem "jeweler",  ">= 1.6.3"
+  # gem 'yard'
+  gem "simplecov", ">= 0.5"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    hashie (1.2.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.3.2)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  hashie
+  jeweler (>= 1.6.3)
+  rspec (>= 2.3.0)
+  simplecov (>= 0.5)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Waseem Ahmad
+
+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,78 @@
+## FB Joy
+
+FB Joy is Joey with a few fixes added.
+
+Joey(<a href="http://github.com/waseem/joey">http://github.com/waseem/joey</a>) provides object wrappers for nodes in the Facebook OpenGraph. It also provides wrappers for the data returned from facebook REST api. This gem depends upon Koala(<a href="http://github.com/arsduo/koala">http://github.com/arsduo/koala</a>).
+
+This discussion(<a href="http://groups.google.com/group/koala-users/browse_thread/thread/650be4f3377aef48">http://groups.google.com/group/koala-users/browse_thread/thread/650be4f3377aef48</a>) sums up the motivation to create Joey and what it intends to accomplish.
+
+### Wrappers
+
+Koala is a lightweight Ruby library which provides an interface to access Facebook Open Graph and REST API.
+
+Facebook servers return data in the form of Json or XML. When you use Koala to make requests to the Graph, it converts the returned Json into ready to be used Ruby hashes. e.g.
+
+    koala_client = Koala::Facebook::GraphAndRestAPI.new(access_token)
+    # http://graph.facebook.com/me
+    me = koala_client.get_object('me')
+    # => {"name"=>"Phuddu Bandar", "timezone"=>5.5, "gender"=>"male", "id"=>"100000654222309", "birthday"=>"12/01/1986", "last_name"=>"Bandar", "updated_time"=>"2010-01-10T16:35:06+0000", "hometown"=>{"name"=>nil, "id"=>nil}, "link"=>"http://www.facebook.com/profile.php?id=100000654222309", "email"=>"phuddu.bandar@gmail.com", "first_name"=>"Phuddu"}
+
+    me['name'] # => 'Phuddu Bandar'
+    me['gender'] # => 'male'
+    me['hometown']['name'] # => nil
+
+Above when tried with joey returns a Joey::User object. We can access different information associated with a user using accessor methods instead of hash keys.
+
+    koala_client = Koala::Facebook::GraphAndRestAPI.new(access_token)
+    # http://graph.facebook.com/me
+    me = koala_client.me
+    # => <#Joey::User about=nil about_me=nil activities=nil birthday="12/01/1986" birthday_date=nil books=nil email="phuddu.bandar@gmail.com" first_name="Phuddu" gender="male" id="100000654222309" interests=nil is_app_user=nil is_blocked=nil last_name="Bandar" link="http://www.facebook.com/profile.php?id=100000654222309" locale=nil meeting_for=nil meeting_sex=nil middle_name=nil movies=nil music=nil name="Phuddu Bandar" notes_count=nil pic=nil pic_big=nil pic_big_with_logo=nil pic_small=nil pic_small_with_logo=nil pic_square=nil pic_square_with_logo=nil pic_with_logo=nil political=nil profile_blurb=nil profile_update_time=nil profile_url=nil quotes=nil relationship_status=nil religion=nil sex=nil significant_other_id=nil timezone=5.5 tv=nil uid=nil updated_time="2010-01-10T16:35:06+0000" username=nil verified=nil wall_count=nil website=nil>
+
+    me.name # => 'Phuddu Bandar'
+    me.gender # => 'male'
+    me.hometown.name # => nil
+
+
+The main advantage of creating wrapper classes for different nodes in the Graph is that one can add custom methods to different objects. e.g.
+
+In Open Graph there is no method to know if a user has given some particular extended permission to your application. However in old REST api there is <a href="http://developers.facebook.com/docs/reference/rest/users.hasAppPermission">users.hasAppPermission</a> for the same.
+
+If we use plain Koala, we can implement it in following way:
+
+    !koala_client.rest_call('users.hasAppPermission', :ext_perm => 'email').zero? # => true or false
+
+In Joey, call to users.hasAppPermission is sheilded behind a Joey::User#has_app_permission?(ext_perm)
+
+    me = koala_client.me
+    me.has_app_permission?(:email) # => true or false
+
+A more complex use case arises when someone intends to add application specific methods to different nodes. e.g.
+
+An application intends to know if a user has given his proxy email while giving the email extended permission. One can include a module with custom methods.
+
+    module FacebookUser
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+      end
+
+      def has_proxy_email?
+        if self.has_app_permission?(:email)
+          return self.email =~ /@proxymail\.facebook\.com/
+        else
+          return true
+        end
+      end
+    end
+
+and somewhere when you intialize your application like 'config/initializers/joey_patch.rb' in Rails
+
+    Joey::User.send(:include, FacebookUser)
+
+Now one can do
+
+    me = koala_client.me
+    me.has_proxy_email? # => true or false

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fb_joy"
+  gem.homepage = "http://github.com/kristianmandrup/joey"
+  gem.license = "MIT"
+  gem.summary = "Ruby Wrapper API for Facebook OpenGraph"
+  gem.description = "Object wrappers for nodes in the Facebook OpenGraph"
+  gem.email = "talk.to.waseem@gmail.com"
+  gem.authors = ["Waseem Ahmad"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/fb_joy.gemspec

@@ -0,0 +1,88 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fb_joy"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Waseem Ahmad"]
+  s.date = "2012-05-07"
+  s.description = "Object wrappers for nodes in the Facebook OpenGraph"
+  s.email = "talk.to.waseem@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "fb_joy.gemspec",
+    "lib/fb_joy.rb",
+    "lib/joey/action.rb",
+    "lib/joey/affiliation.rb",
+    "lib/joey/album.rb",
+    "lib/joey/comment.rb",
+    "lib/joey/education.rb",
+    "lib/joey/education_history.rb",
+    "lib/joey/fetching_array.rb",
+    "lib/joey/hs_info.rb",
+    "lib/joey/image.rb",
+    "lib/joey/like.rb",
+    "lib/joey/location.rb",
+    "lib/joey/model.rb",
+    "lib/joey/page.rb",
+    "lib/joey/parser_helpers.rb",
+    "lib/joey/photo.rb",
+    "lib/joey/post.rb",
+    "lib/joey/privacy.rb",
+    "lib/joey/profile.rb",
+    "lib/joey/property.rb",
+    "lib/joey/relative.rb",
+    "lib/joey/rest_api.rb",
+    "lib/joey/status.rb",
+    "lib/joey/tag.rb",
+    "lib/joey/television.rb",
+    "lib/joey/user.rb",
+    "lib/joey/version.rb",
+    "lib/joey/video.rb",
+    "lib/joey/work.rb",
+    "lib/joey/work_history.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/joey"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby Wrapper API for Facebook OpenGraph"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.5"])
+    else
+      s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.3.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.3"])
+      s.add_dependency(%q<simplecov>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.3.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.3"])
+    s.add_dependency(%q<simplecov>, [">= 0.5"])
+  end
+end
+

data/lib/fb_joy.rb

@@ -0,0 +1,12 @@
+module Joey
+end
+
+require 'hashie'
+require 'koala'
+
+require 'joey/rest_api'
+require 'joey/fetching_array'
+require 'joey/profile'
+require 'joey/user'
+
+Koala::Facebook::GraphAndRestAPI.send(:include, Joey::RestAPI)

data/lib/joey/action.rb

@@ -0,0 +1,16 @@
+module Joey
+  class Action < Model
+    define_properties :name, :link
+
+    def validate
+      errors << { :message => "name should String but is #{name.inspect}" } unless name.is_a?(String)
+      errors << { :message => "link should String but is #{link.inspect}" } unless link.is_a?(String)
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/affiliation.rb

@@ -0,0 +1,15 @@
+module Joey
+  class Affiliation < Model
+    define_properties :type, :year, :name, :nid, :status
+
+    def validate
+      valid = true
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/album.rb

@@ -0,0 +1,42 @@
+module Joey
+  class Album < Model
+    
+    define_properties :id, :name, :description, :link, :count, :created_time, :updated_time, :privacy, :location, :type, :picture,
+                      :cover_photo
+    #creation_properties :name, :message
+    
+    hash_populating_accessor :from, "User", "Page"
+    hash_populating_association :comments, "Comment"
+    # hash_populating_accessor :photos, "Photo"
+    # has_association :photos, "Photo"
+    hash_populating_association :photos, "Photo"
+    
+    def validate
+      created_time.to_time rescue errors << { :message => 'created_time is not compatible' }
+      updated_time.to_time rescue errors << { :message => 'updated_time is not compatible' }
+      errors << { :message => 'id should not be nil' } if id.nil?
+      errors << { :message => "name is neither string nor nil but is #{name.inspect}" } unless name.is_a?(String) || name.nil?
+      errors << { :message => "description is neither string nor nil but is #{description.inspect}" } unless description.is_a?(String) || description.nil?
+      errors << { :message => "link is not a string but is #{link.inspect}" } unless link.is_a?(String)
+      errors << { :message => "count is neither integer nor nil but is #{count.inspect}" } unless count.is_a?(Integer) || count.nil?
+      errors << { :message => "location is neither string nor nil but is #{location.inspect}" } unless location.is_a?(String) || location.nil?
+      errors << { :message => "from is not a Joey::User or Joey::Page and is #{from.inspect}" } unless from.is_a?(Joey::User) || from.is_a?(Joey::Page)
+
+      #errors << { :message => "comments is not an array nor nil and is #{comments.inspect}" } unless comments.is_a?(Array) || comments.nil?
+      #if comments.is_a?(Array) && !(comments.collect(&:class).uniq - [Joey::Comment]).empty?
+        #errors << { :message => 'comments is not an array of Joey::Comment' }
+      #end
+
+      #errors << { :message => "photos is not an array nor nil and is #{photos.inspect}" } unless photos.is_a?(Array) || photos.nil?
+      #if photos.is_a?(Array) && !(photos.collect(&:class).uniq - [Joey::Photo]).empty?
+        #errors << { :message => 'photos is not an array of Joey::Comment' }
+      #end
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/comment.rb

@@ -0,0 +1,20 @@
+module Joey
+  class Comment < Model
+    define_properties :id, :message, :created_time, :count, :likes
+    #creation_properties :message
+    hash_populating_accessor :from, "User","Page"
+
+    def validate
+      created_time.to_time rescue errors << { :message => 'created_time is not compatible' }
+      # updated_time.to_time rescue errors << { :message => 'updated_time is not compatible' }
+      errors << { :message => 'id should not be nil' } if id.nil?
+      errors << { :message => 'from is not a Joey::User or Joey::Page' } unless from.is_a?(Joey::User) || from.is_a?(Joey::Page)
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/education.rb

@@ -0,0 +1,20 @@
+module Joey
+  class Education < Model
+    
+    define_properties :start_date, :end_date, :degree, :type
+    
+    hash_populating_accessor :school, "Page"
+    hash_populating_accessor :year, "Page"
+    hash_populating_accessor :concentration, "Page"
+
+    def validate
+      valid = true
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/education_history.rb

@@ -0,0 +1,15 @@
+module Joey
+  class EducationHistory < Model
+    define_properties :name, :degree, :year, :school_type, :concentrations
+
+    def validate
+      valid = true
+    end
+
+    def valid?
+      self.validate
+      puts self.errors.inspect unless self.errors.empty?
+      self.errors.empty?
+    end
+  end
+end

data/lib/joey/fetching_array.rb

@@ -0,0 +1,26 @@
+module Joey
+  class FetchingArray < Array
+    attr_accessor :next_url, :previous_url, :client, :classes, :count
+    
+    def fetch_next
+      return [] if next_url.blank?
+      # FIXME: following only returns a hash like {"id"=>"http://graph.facebook.com/100000637452380/feed"}
+      # try to write a method in koala which can request absolute urls
+      additions = client.get_and_map_url(next_url, classes)
+      self.next_url = additions.next_url
+      self.concat(additions)
+      additions
+    end
+    
+    def fetch_previous
+      return [] if previous_url.blank?
+      # FIXME: following only returns a hash like {"id"=>"http://graph.facebook.com/100000637452380/feed"}
+      # try to write a method in koala which can request absolute urls
+      additions = client.get_and_map_url(previous_url, classes)
+      self.previous_url = additions.previous_url
+      self.unshift(*additions)
+      additions
+    end
+
+  end
+end