Skip to content

Latest commit

 

History

History
348 lines (224 loc) · 10.1 KB

README.original.markdown

File metadata and controls

348 lines (224 loc) · 10.1 KB
Raw

sfMelodyPlugin

sfMelodyPlugin brings:

  • Easy connection between other service supports OAuth like Facebook, Yahoo, Google
  • For example you can use facebook api without fbml or javascript Api. It's can be an easy way to use facebook connect

Installation

For Doctrine, install:

For Propel:

  • sfDoctrineOAuthPlugin

  • sfDoctrinePlugin

  • Install

     $ symfony plugin:install sfMelodyPlugin

  • Clear cache

     $ symfony cc

  • Enable the sfMelody module in settings.yml:

     all:
   .settings:
   ...
     enabled_modules: 
       - sfMelody
       - ...

  • Override the user in apps/my-app/lib/myUser.class.php:

     class myUser extends sfMelodyUser

Melodies

At this time sfMelody has 8 melodies :) :

  • Facebook
  • Google
  • Yahoo
  • LinkedIn
  • MySpace
  • Twitter
  • Neutral1 #A base class to support OAuth1
  • Neutral2 #A base class to support OAuth2

Configuration

Available options in app.yml :

all:
  melody:
    create_user: false            # create a new user if not logged when you connect to a service
    redirect_register: false      # you can redirect to a register form or anything else by specify
                                  # a valid route like "@user_register" 
    name:
      key:  my_service_key
      secret: my_secret_key
      callback: @mymodule_index   # or absolute url
      
      #needed for google or facebook
      api: [contacts, ...]        # only for google - easy way to set scopes
      scope: [permission_1, ...]  # for google and facebook to set permissions - for google prefere api parameter
      
      #optional
      user:                       # to create an user
        field_1:
          call: xx
          call_parameters: [x, x, x]
          path: xx.xy.zz
          prefix: xx_
          suffix: _xx
          key: false
        ...
        
      provider: provider          #like google, facebook -optional if 'name' config key is the name of the provider
      request_token_url: url      # override the url - for OAuth 1 implementation only
      request_auth_url: url
      access_token_url: url
      namespaces:                 # namespaces are used to make some api calls - see namespace Section
        ns1: http://my.name.space
        ...
      aliases:                    # Alias is an easy way to simplify api calls
        me: my/alias   
        ...     
      auth_parameters:
        param1: value
      call_parameters:
        param1: value
      access_parameters:
        param1: value
      output_format: json
      create_user: true      
      redirect_register: false
      
      #optional only for OAuth 1
      request_parameters:
        param1: value
      request_token_url: url

In an action:

$this->getUser()->connect('name');

This action redirects to the callback specified in the app.yml

In an other action when you have the autorization:

$this->getUser()->getMelody('name')->getMe();  #see section Api for more informations

Example

We try a sample with facebook, Register an application (see section Register application to have url to register apps). Then put the config in app.yml:

all:
  melody:
    create_user: true               # to create a user for all melodies 
    facebook:
      key: my_api_key
      secret: application_secret
      callback: @mymodule_facebook
      scope: [email]                #optionnal - http://developers.facebook.com/docs/authentication/permissions
                                    # needed to create an user based on his email_address
      user:
        username:                   # the name of a field of sfGuardUser
          call: me                  # api call
          path: id                  # path could be user.object.email for example to retrieve the right inforamtion
          prefix: Facebook_
        first_name:
          call: me
          path: first_name
        last_name: 
          call: me
          path: last_name
        email_adress:               
          call: me                  
          path: email               
          key: true                 # it's a key to retrieve user from other services based on this information
                                    # if no field is a key all are keys by default.        
      
    facebook_plus:                  # you can manage more than one config for a service
      provider: facebook            # to manage permissions for example            
      ...
    google:
      ...

For example we put a link:

<?php echo link_to('Connect to facebook', '@mymodule_connect') ?>

In the action.class.php :

public function executeConnect(sfWebRequest $request)
{
  $this->getUser()->connect('facebook');
}

public function executeFacebook(sfWebRequest $request)
{
  $this->me = $this->getUser()->getMelody('facebook')->getMe();
}

User

The user creation is a security point because for example if you create user based on email addresses. If a user create an account by a classic way and if the email specified is not validated he can retrieve rights on the user which have the email.

So you have to specified the user creation by put some informations in the config file (app.yml).

The informations under the user key in config allow to create a user with theses informations. The keys (key:true) allow to retrieve existing user to make links between services or to signin a user according his created account.

How it's works :

If an user is authenticated and request acces to a service. The rights are attached to him.

There is an event (melody.filter_user) to filter an user if auticanted. This event has params melody and conflict. melody is the current melody and conflict represents if the user match the key rules (app.yml). So in this filter you can change the user or do anything you want in this situation.

If the user is not authenticated, it try to retrieve the user by the token then it try to retrieve the user by the keys(config). And then create the user if needeed.

Before saving the user, if you specify redirect_register with a valid routing rule, you can redirect the workflow to your action.

In this case, you can retrieve the user created but not saved :

  • unserialize($this->getUser()->getAttribute('melody_user'))

And the melody :

  • unserialize($this->getUser()->getAttribute('melody'))

Api

When you call:

$this->getUser()->getMelody('facebook')->getMe();

In fact it's use the default namespace of facebook : https://graph.facebook.com

It calls the method sfOAuth->get($action, $aliases, $params, $method = 'GET')

getMe means get('me')

getMeFriends -> get('me/friends')

an alias is a way to have simpliest call for example :

$fb_melody->getFriends(array('friends' => 'me/friends'));

you can put your own aliases in the app.yml to have simplier calls.

Apis

To make api calls, you have to know api for each service provider :

Register Application

Namespaces

To change the namesapce in use just use:

$google_melody->ns('contacts');

You can use all these namespaces in the api config to have permissions to use them.

Aliases

Default aliases :

  • Google

    • contacts: m8/feeds/contacts
    • me: default/full

  • Yahoo !

    • uid: [userid]
    • me: user/[userid]

  • LinkedIn

    • me: people/~

  • MySpace

    • me: user.json

Contribute

If you want more providers or more default aliases. Feel free to ask or contribute on Github : http://github.com/chok/sfMelodyPlugin

TODO

  • Better management of tokens (refresh, etc...)
  • ...