README

=======

SilverStripe Social Statistics module

Maintainer Contact

Kirk Mayo

Requirements

SilverStripe 3.2
Access to create cron jobs
https://github.com/silverstripe-australia/silverstripe-queuedjobs
https://github.com/kmayo-ss/twitter-stripe

Documentation

The module is used query social statistics for different web pages and store the information and provide this information via an API

Setup

The Twitter service makes use of another SilverStripe module which uses Oauth to use the Twitter API. You will need to consult the the Readme file (../twitter-stripe/README.md) for details on setting up the Oauth details. The module config.yml also contains a setting under SocialProofSetting which is used to lock the urls down to certain domains.

Services

The module queuries various social media services which are managed via config.yml To add another service you will need to create a class with the properties service and statistics as these are used when adding a row to the URLStatistics model. The class will also need to declare a method called processQueue which is used in a cron job, this is enforced by a interface called SocialServiceInterface which should be implemented in any future service classes.

API Endpoints

Curently the following API endpoints exist

http://socialproof.stripetheweb.com/api/countsfor?urls=http://[urltobeprocessed]
http://socialproof.stripetheweb.com/api/countsfor/service/facebook?urls=[urltobeprocessed]
http://socialproof.stripetheweb.com/api/countsfor/service/twitter?urls=[urltobeprocessed]
http://socialproof.stripetheweb.com/api/countsfor/service/linkedin?urls=[urltobeprocessed]
http://socialproof.stripetheweb.com/api/countsfor/service/linkedin?urls=[urltobeprocessed]
http://socialproof.stripetheweb.com/api/countsfor/service/google?urls=[urltobeprocessed]

Accepting third party AJAX requests

If you want to allow third party javascript requests to query the service (like AJAX) you will need to set the CORS flag in your yml config to true so that the Access-Control-Allow-Origin header gets sent back to the requesting browser as per the example below.

Querying the API from a third party can be done with jQuery or AJAX. A simple synchronous javascript example is below where you can just call the function requestInfo with the host and the request.

function requestInfo(host, request) {
    var xhr = new XMLHttpRequest();
    xhr.open("GET", host + request, false);
    xhr.send();

    return xhr.response;
}

// call with the following
// var result = requestInfo('http://192.168.0.1/', 'geoip/50.206.151.39.json');

SocialAPI:
  allow_cors: true

You can also add an IP whitelist for the domains that you want to be processed by using:

SocialAPI:
  allowed_domains:
    - blog4.marketo.com

If you want to map development domains to production domains, you can use the following:

 domain_mapping:
   localdomain.dev: blog4.marketo.com

Domains can also use wildcards for matching subdomains:

  allowed_domains:
    - *.marketo.com
  allowed_domains:
    - *domain.dev: blog4.marketo.com

Composer Installation

composer require solnet/socialproof

TODO

Testing

marketo / silverstripe-social-proof

Maintainers

Details