Ninja Pumpkin Mutants

    sails-service-social

    3.1.1 • Public • Published

    sails-service-social

    Build Status Coverage

    Downloads Downloads npm version License

    semantic-release Commitizen friendly dependencies dev dependencies

    Service for Sails framework with social features.

    List of supported social networks

    • Facebook

    Getting Started

    Install this module.

    npm install sails-service-social

    Then require it in your service and create social instance.

    // api/services/SocialService.js
    import SocialService from 'sails-service-social';
     
    export default SocialService('facebook');
     
    // api/controllers/SocialController.js
    export default {
      friends: function(req, res) {
        SocialService
          .getFriends('<FB_ACCESS_TOKEN>')
          .then(res.ok)
          .catch(res.negotiate);
      }
    };

    Configuration

    You can store access token in config (but really, why you need that?):

    config.accessToken - This access token will be used if you don't specify access token in methods arguments;

    API

    Each of social instances has following methods:

    getProfile([accessToken], [config])

    Get profile from social network. Returns Promise.

    accessToken - {String} Access token received from social network

    config - {Object} Configuration object with additional options to social API

    getFriends([accessToken], [config])

    Get friends from social network. Returns Promise.

    accessToken - {String} Access token received from social network

    config - {Object} Configuration object with additional options to social API

    getPhotos([accessToken], [config])

    Get photos from social network. Returns Promise.

    accessToken - {String} Access token received from social network

    config - {Object} Configuration object with additional options to social API

    getPosts([accessToken], [config])

    Get posts from social network. Returns Promise.

    accessToken - {String} Access token received from social network

    config - {Object} Configuration object with additional options to social API

    Examples

    FacebookSocial

    let facebook = SocialService('facebook');
     
    facebook
      .getProfile('<FB_ACCESS_TOKEN>', {fields: ['id', 'name', 'email', 'photos']})
      .then(console.log.bind(console))
      .catch(console.error.bind(console));

    License

    The MIT License (MIT)

    Copyright (c) 2015 Eugene Obrezkov

    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.

    Install

    npm i sails-service-social

    DownloadsWeekly Downloads

    35

    Version

    3.1.1

    License

    MIT

    Last publish

    Collaborators

    • ghaiklor