muck-oauth 0.1.2 → 0.1.3

data/README.rdoc

@@ -13,10 +13,7 @@ Add the following to environment.rb
   config.gem "muck-oauth"
 
 Add the following to your user model:
-  has_many :client_applications
-  has_many :tokens, :class_name => "OauthToken", :order => "authorized_at desc", :include => [:client_application]
-
-  has_one  :twitter_token, :class_name => "TwitterToken", :dependent => :destroy
+  acts_as_muck_oauth_user
   
 == Usage
 Add configuration for services to:
@@ -26,5 +23,37 @@ Link to each service like this:
   <a href="/oauth_consumers/twitter">Twitter</a>
   <a href="/oauth_consumers/google">Google</a>
   
+Each service provides methods that enable communication with the service's api via popular gems.
+For example, the twitter service uses the twitter gem and so you can call methods against 
+a user's twitter account like this:
+
+  user.twitter.client.verify_credentials[:screen_name]
+
+Please see each gem's documentation for more information:
+Twitter Docs: http://rdoc.info/projects/jnunemaker/twitter
+Twitter Examples: http://github.com/jnunemaker/twitter-app/
+i.e.
+  user.twitter.client
+
+Linked In Docs: http://github.com/pengwynn/linkedin
+i.e.
+  user.linked_in.client
+
+Google Docs: http://github.com/pelle/portablecontacts
+i.e.
+  user.google.portable_contacts
+
+Fire Eagle Docs: http://fireeagle.rubyforge.org/
+i.e.
+  user.fire_eagle.client
+
+Friend Feed Docs:
+None yet
+
+Yahoo Docs:
+None yet
+
+Flickr
+None yet
 
 Copyright (c) 2009 Tatemae.com. See LICENSE for details.

data/Rakefile

@@ -21,6 +21,7 @@ begin
     gem.add_dependency "portablecontacts"
     gem.add_dependency "agree2"
     gem.add_dependency "fireeagle"
+    gem.add_dependency "linkedin"
     gem.add_dependency "muck-engine"
     gem.add_dependency "muck-users"
     gem.add_development_dependency "shoulda"

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/app/controllers/oauth_consumers_controller.rb

@@ -13,7 +13,8 @@ class OauthConsumersController < ApplicationController
     # params[:id] holds the service name so you could use this to redirect to various parts
     # of your application depending on what service you're connecting to.
     def go_back
-      redirect_to root_url
+      #params[:id]
+      redirect_back_or_default('/')
     end
   
     def choose_layout

data/app/helpers/muck_oauth_helper.rb

@@ -34,4 +34,12 @@ module MuckOauthHelper
     @oauth_services ||= OAUTH_CREDENTIALS.keys-oauth_consumer_tokens(user).collect{ |c| c.class.service_name }
   end
   
+  def oauth_service_name(service_name)
+    name = service_name.to_s.humanize
+    name = 'Fire Eagle' if name == 'Fireeagle'
+    name = 'LinkedIn' if name == 'Linkedin' 
+    name = 'FriendFeed' if name == 'Friendfeed' 
+    name
+  end
+  
 end

data/app/models/friendfeed_token.rb

@@ -0,0 +1,21 @@
+class FriendfeedToken < ConsumerToken 
+  FRIENDFEED_SETTINGS = { 
+    :site => "https://friendfeed.com", 
+    :request_token_path => "/account/oauth/request_token", 
+    :authorize_path => "/account/oauth/authorize", 
+    :access_token_path => "/accounts/account/oauth/access_token", 
+  } 
+  
+  def self.consumer 
+    @consumer ||= create_consumer 
+  end
+  
+  def self.create_consumer(options={}) 
+    OAuth::Consumer.new credentials[:key], credentials[:secret], FRIENDFEED_SETTINGS.merge(options)
+  end 
+  
+  def self.get_request_token(callback_url) 
+    consumer.get_request_token({ :oauth_callback => callback_url })
+  end
+  
+end

data/app/models/linkedin_token.rb

@@ -0,0 +1,31 @@
+require 'linkedin'
+
+class LinkedinToken < ConsumerToken
+  LINKEDIN_SETTINGS={
+    :site => "https://api.linkedin.com", 
+    :request_token_path => "/uas/oauth/requestToken",
+    :access_token_path  => "/uas/oauth/accessToken",
+    :authorize_path     => "/uas/oauth/authorize"
+  }
+  
+  def self.consumer
+    @consumer ||= create_consumer
+  end 
+  
+  def self.create_consumer(options={})
+    OAuth::Consumer.new(credentials[:key], credentials[:secret], LINKEDIN_SETTINGS.merge(options))
+  end
+    
+  def self.get_request_token(callback_url)
+    consumer.get_request_token({ :oauth_callback => callback_url })
+  end
+  
+  def client
+    unless @client
+      @client = LinkedIn::Client.new(LinkedInToken.consumer.key, LinkedInToken.consumer.secret)
+      @client.authorize_from_access(token, secret)
+    end 
+    @client
+  end
+  
+end

data/app/models/yahoo_token.rb

@@ -0,0 +1,110 @@
+# This was taken from an older version of the oauth-plugin gem.
+class YahooToken < ConsumerToken
+  YAHOO_SETTINGS={
+    :site => "https://www.yahoo.com", 
+    :request_token_url => "https://api.login.yahoo.com/oauth/v2/get_request_token",
+    :authorize_url => "https://api.login.yahoo.com/oauth/v2/request_auth",
+    :access_token_url => "https://api.login.yahoo.com/oauth/v2/get_token"
+  }
+  
+  def self.consumer
+    @consumer ||= create_consumer
+  end
+  
+  def self.create_consumer(options={})
+    OAuth::Consumer.new credentials[:key], credentials[:secret],YAHOO_SETTINGS.merge(options)
+  end
+  
+  def self.social_apis_consumer
+    @social_api_consumer ||= create_consumer :site => "http://social.yahooapis.com/v1"
+  end
+  
+  def self.get_request_token(callback_url, scope = nil)
+    YahooRequestToken.new consumer.get_request_token({:oauth_callback => callback_url}, :scope => scope || credentials[:scope])
+  end
+  
+  # We need to do some special handling to handle this strange parameter:
+  # 
+  class YahooRequestToken < OAuth::RequestToken
+    def initialize(real_token)
+      super real_token.consumer, real_token.token, real_token.secret
+      @params = real_token.params
+    end
+    
+    # handle xoauth_request_auth_url
+    def authorize_url(params = nil)
+      if @params[:xoauth_request_auth_url]
+        return @params[:xoauth_request_auth_url]
+      else
+        super params
+      end
+    end
+  end
+  
+  def social_api
+    @social_api ||= SocialAPI.new(OAuth::AccessToken.new( self.class.social_apis_consumer, token, secret))
+  end
+  
+  class SocialAPI < Oauth::Models::Consumers::SimpleClient
+    # initial implementation of this
+    # http://developer.yahoo.com/social/rest_api_guide/index.html
+    # Please fork and submit improvements here
+    def guid
+      @guid ||= get("/v1/me/guid")["guid"]["value"]
+    end
+    
+    def usercard
+      get("/v1/user/#{guid}/profile/usercard")
+    end
+    
+    def idcard
+      get("/v1/user/#{guid}/profile/idcard")
+    end
+    
+    def tinyusercard
+      get("/v1/user/#{guid}/profile/tinyusercard")
+    end
+    
+    def profile
+      get("/v1/user/#{guid}/profile")
+    end
+    
+    def contacts
+      get("/v1/user/#{guid}/contacts")
+    end
+ 
+  end
+end
+ 
+ 
+# I have reported this as a bug to Yahoo, but on certain occassions their tokens are returned with spaces that confuse CGI.parse.
+# The only change below is that it strips the response.body. Once Yahoo fixes this I will remove this whole section.
+module OAuth
+  class Consumer
+    
+    def token_request(http_method, path, token = nil, request_options = {}, *arguments)
+      response = request(http_method, path, token, request_options, *arguments)
+ 
+      case response.code.to_i
+ 
+      when (200..299)
+        # symbolize keys
+        # TODO this could be considered unexpected behavior; symbols or not?
+        # TODO this also drops subsequent values from multi-valued keys
+        
+        CGI.parse(response.body.strip).inject({}) do |h,(k,v)|
+          h[k.to_sym] = v.first
+          h[k]        = v.first
+          h
+        end
+      when (300..399)
+        # this is a redirect
+        response.error!
+      when (400..499)
+        raise OAuth::Unauthorized, response
+      else
+        response.error!
+      end
+    end
+  end
+end

data/app/views/oauth_consumers/_oauth_available_services.html.erb

@@ -4,7 +4,7 @@
     <ul <%='class="icon-list"' if include_icons%>>
       <% services.each do |service| -%>
         <li class="<%=service.to_s.parameterize%> oauth_service service-link" <%= service_icon_background(service) if include_icons%> title="<%=translate('muck.oauth.connect_to_account_title', :service => service.to_s.humanize) %>">
-          <%= link_to service.to_s.humanize, oauth_consumer_path(service), :class => 'oauthfancybox iframe' %>
+          <%= link_to oauth_service_name(service), oauth_consumer_path(service) %>
         </li>
       <% end -%>
     </ul>

data/app/views/oauth_consumers/_oauth_current_services.html.erb

@@ -6,9 +6,9 @@
     <ul <%='class="icon-list"' if include_icons%>>
       <% consumer_tokens.each do |token| -%>
         <li class="<%=token.class.service_name.to_s.parameterize%> oauth_service service-link" <%= service_icon_background(token.class.service_name) if include_icons %>>
-          <%= link_to token.class.service_name.to_s.humanize, oauth_consumer_path(token.class.service_name), :class => 'oauthfancybox iframe' %>
+          <%= link_to oauth_service_name(token.class.service_name), oauth_consumer_path(token.class.service_name), :class => 'oauthfancybox' %>
         </li>
       <% end -%>
     </ul>
   <% end -%>
-</div>
+</div>

data/config/initializers/oauth_consumers.rb

@@ -2,46 +2,23 @@
 # each entry needs a corresponding token model.
 #
 # eg. :twitter => TwitterToken, :hour_feed => HourFeedToken etc.
-#
-# OAUTH_CREDENTIALS={
-#   get it at: http://twitter.com/apps
-#   :twitter=>{
-#     :key=>"",
-#     :secret=>""
-#   },
-#   :google=>{
-#     :key=>"",
-#     :secret=>"",
-#     :scope=>"" # see http://code.google.com/apis/gdata/faq.html#AuthScopes
-#   },
-#   :agree2=>{
-#     :key=>"",
-#     :secret=>""
-#   },
-#   :fireeagle=>{
-#     :key=>"",
-#     :secret=>""
-#   },
-#   :hour_feed=>{
-#     :key=>"",
-#     :secret=>"",
-#     :options=>{ # OAuth::Consumer options
-#       :site=>"http://hourfeed.com" # Remember to add a site for a generic OAuth site
-#     }
-#   },
-#   :nu_bux=>{
-#     :key=>"",
-#     :secret=>"",
-#     :super_class=>"OpenTransactToken",  # if a OAuth service follows a particular standard 
-#                                         # with a token implementation you can set the superclass
-#                                         # to use
-#     :options=>{ # OAuth::Consumer options
-#       :site=>"http://nubux.heroku.com" 
-#     }
-#   }
-# }
-# 
-OAUTH_CREDENTIALS={
-} unless defined? OAUTH_CREDENTIALS
 
+credentials = {}
+credentials[:twitter]   = { :key => GlobalConfig.twitter_oauth_key, 
+                            :secret => GlobalConfig.twitter_oauth_secret } if GlobalConfig.twitter_oauth_key
+credentials[:google]    = { :scope => "https://mail.google.com/mail/feed/atom/", # see http://code.google.com/apis/gdata/faq.html#AuthScopes
+                            :key => GlobalConfig.google_oauth_key, 
+                            :secret => GlobalConfig.google_oauth_secret } if GlobalConfig.google_oauth_key
+credentials[:yahoo]     = { :key => GlobalConfig.yahoo_oauth_key, 
+                            :secret => GlobalConfig.yahoo_oauth_secret } if GlobalConfig.yahoo_oauth_key
+credentials[:flickr]    = { :key => GlobalConfig.flickr_oauth_key, 
+                            :secret => GlobalConfig.flickr_oauth_secret } if GlobalConfig.flickr_oauth_key
+credentials[:linkedin]  = { :key => GlobalConfig.linkedin_oauth_key, 
+                            :secret => GlobalConfig.linkedin_oauth_secret } if GlobalConfig.linkedin_oauth_key
+credentials[:fireeagle] = { :key => GlobalConfig.fireeagle_oauth_key,
+                            :secret => GlobalConfig.fireeagle_oauth_secret } if GlobalConfig.fireeagle_oauth_key
+credentials[:friendfeed] = { :key => GlobalConfig.friendfeed_oauth_key,
+                             :secret => GlobalConfig.friendfeed_oauth_secret } if GlobalConfig.friendfeed_oauth_key
+                             
+OAUTH_CREDENTIALS = credentials unless defined? OAUTH_CREDENTIALS
 load 'oauth/models/consumers/service_loader.rb'

data/lib/active_record/acts/muck_oauth_user.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module Acts #:nodoc:
+    module MuckOauthUser # :nodoc:
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+  
+      module ClassMethods
+        
+        # +acts_as_muck_oauth_user+ adds Oauth capabilities to a user.  Currently, muck-oauth supports the following services:
+        # twitter
+        # google
+        # linkedin
+        # yahoo
+        # fire_eagle
+        # flickr
+        # friend_feed
+        # After adding this method to a user you will be able to call methods against these services ie:
+        # user.linked_in.client.profile
+        def acts_as_muck_oauth_user
+          
+          has_many :client_applications
+          has_many :tokens, :class_name => "OauthToken", :order => "authorized_at desc", :include => [:client_application]
+                    
+          has_one  :twitter, :class_name => "TwitterToken", :dependent => :destroy
+          has_one  :google, :class_name => "GoogleToken", :dependent => :destroy
+          has_one  :linked_in, :class_name => "LinkedinToken", :dependent => :destroy
+          has_one  :yahoo, :class_name => "YahooToken", :dependent => :destroy
+          has_one  :fire_eagle, :class_name => "FireeagleToken", :dependent => :destroy
+          has_one  :flickr, :class_name => "FlickrToken", :dependent => :destroy
+          has_one  :friend_feed, :class_name => "FriendfeedToken", :dependent => :destroy
+          
+          include ActiveRecord::Acts::MuckOauthUser::InstanceMethods
+          extend ActiveRecord::Acts::MuckOauthUser::SingletonMethods
+        end
+      end
+
+      # class methods
+      module SingletonMethods
+      end
+      
+      module InstanceMethods
+       
+      end
+      
+    end
+  end
+end

data/lib/muck_oauth.rb

@@ -1,4 +1,6 @@
 
 ActionController::Base.send :helper, MuckOauthHelper
 
+ActiveRecord::Base.class_eval { include ActiveRecord::Acts::MuckOauthUser }
+
 I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'locales', '*.{rb,yml}') ]

data/lib/muck_oauth/tasks.rb

@@ -17,7 +17,7 @@ module MuckOauth
           task :sync do
             path = File.join(File.dirname(__FILE__), *%w[.. ..])
             system "rsync -ruv #{path}/db ."
-            system "rsync -ruv #{path}/public ."
+            #system "rsync -ruv #{path}/public ."
             if !File.exists('./config/oauth_consumers.rb')
               system "rsync -ruv #{path}/config/initializers/oauth_consumers.rb ./config/oauth_consumers.rb"
             end

data/muck-oauth.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{muck-oauth}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Ball"]
-  s.date = %q{2009-12-21}
+  s.date = %q{2009-12-22}
   s.description = %q{A simple wrapper for the oauth and oauth-plugin gems so that it is faster to include oauth in muck based applications.}
   s.email = %q{justin@tatemae.com}
   s.extra_rdoc_files = [
@@ -30,9 +30,12 @@ Gem::Specification.new do |s|
      "app/models/access_token.rb",
      "app/models/client_application.rb",
      "app/models/consumer_token.rb",
+     "app/models/friendfeed_token.rb",
+     "app/models/linkedin_token.rb",
      "app/models/oauth_nonce.rb",
      "app/models/oauth_token.rb",
      "app/models/request_token.rb",
+     "app/models/yahoo_token.rb",
      "app/views/oauth/authorize.html.erb",
      "app/views/oauth/authorize_failure.html.erb",
      "app/views/oauth/authorize_success.html.erb",
@@ -50,6 +53,7 @@ Gem::Specification.new do |s|
      "config/muck_oauth_routes.rb",
      "db/migrate/20091205001023_create_oauth_consumer_tokens.rb",
      "db/migrate/20091210172015_create_oauth_tables.rb",
+     "lib/active_record/acts/muck_oauth_user.rb",
      "lib/muck_oauth.rb",
      "lib/muck_oauth/initialize_routes.rb",
      "lib/muck_oauth/tasks.rb",
@@ -1821,6 +1825,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<portablecontacts>, [">= 0"])
       s.add_runtime_dependency(%q<agree2>, [">= 0"])
       s.add_runtime_dependency(%q<fireeagle>, [">= 0"])
+      s.add_runtime_dependency(%q<linkedin>, [">= 0"])
       s.add_runtime_dependency(%q<muck-engine>, [">= 0"])
       s.add_runtime_dependency(%q<muck-users>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
@@ -1831,6 +1836,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<portablecontacts>, [">= 0"])
       s.add_dependency(%q<agree2>, [">= 0"])
       s.add_dependency(%q<fireeagle>, [">= 0"])
+      s.add_dependency(%q<linkedin>, [">= 0"])
       s.add_dependency(%q<muck-engine>, [">= 0"])
       s.add_dependency(%q<muck-users>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -1842,6 +1848,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<portablecontacts>, [">= 0"])
     s.add_dependency(%q<agree2>, [">= 0"])
     s.add_dependency(%q<fireeagle>, [">= 0"])
+    s.add_dependency(%q<linkedin>, [">= 0"])
     s.add_dependency(%q<muck-engine>, [">= 0"])
     s.add_dependency(%q<muck-users>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: muck-oauth
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Justin Ball
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-21 00:00:00 -07:00
+date: 2009-12-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: linkedin
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: muck-engine
   type: :runtime
@@ -125,9 +135,12 @@ files:
 - app/models/access_token.rb
 - app/models/client_application.rb
 - app/models/consumer_token.rb
+- app/models/friendfeed_token.rb
+- app/models/linkedin_token.rb
 - app/models/oauth_nonce.rb
 - app/models/oauth_token.rb
 - app/models/request_token.rb
+- app/models/yahoo_token.rb
 - app/views/oauth/authorize.html.erb
 - app/views/oauth/authorize_failure.html.erb
 - app/views/oauth/authorize_success.html.erb
@@ -145,6 +158,7 @@ files:
 - config/muck_oauth_routes.rb
 - db/migrate/20091205001023_create_oauth_consumer_tokens.rb
 - db/migrate/20091210172015_create_oauth_tables.rb
+- lib/active_record/acts/muck_oauth_user.rb
 - lib/muck_oauth.rb
 - lib/muck_oauth/initialize_routes.rb
 - lib/muck_oauth/tasks.rb