Skip to content

Latest commit

 

History

History
98 lines (59 loc) · 4.37 KB

README.md

File metadata and controls

98 lines (59 loc) · 4.37 KB
Raw

A SocketStream implementation of Realtime-Demo

========================================================================

The good people at Instagram created this beautiful demo and released it a while back. In his excellent blog post, asalant described his fixes to the project and how to use it. After reading the source code I noticed that it's possible to create a version of the demo that is based on the new SocketStream platform. Given the lack of SocketStream demos, I decided this could be a minor contribution for anyone interested in the platform.

Major differences from Realtime-Demo

  1. Uses SocketStream Redis-based PubSub instead of directly using Redis PubSub,
  2. A simple Cakefile that replaces having to use cUrl for working against the Instagram API.
  3. It doesn't use express and instead uses the connect middleware capabilities provided by SocketStream v0.2
  4. It doesn't use environment variables for providing configuration to the server.
  5. It's in CoffeeScript.

Installation

Install SocketStream v0.2 and it's dependencies

For more details see the SocketStream documentation and specifically the INSTALL.MD file

Clone instastream-demo

  % git clone git@github.com:syrio/instastream-demo.git

Install the request module

  % cd instastream-demo
  % npm install request

Usage

External Hosting

The Instagram servers need to be able to contact instastream-demo in order to push pictures taken from the different locations the app (using the Cakefile or cUrl) subscribed to. This is implemented in the form of webhooks and requires instastream-demo to run on a host that is able to accept external incoming HTTP communication from those servers. You can use localtunnel to setup this up for you or, if you have an access to one, just place the app on an external host.

Signing up as an Instagram developer

In order to interwork with Instagram web services and use the Instagram API, you'll need to register at http://instagram.com/developer/ to get your developer client id and client secret identifiers. This will be used by the Cakefile (if you choose to use it) for managing location subscritions and by instastream when making requests against Instagram server.

Filling your host and your Instagram API client details

  1. Open the application configuration file - instastream-demo/config/app.coffee
  2. Add your Insatgram client_id and client_secret to instagram.api.client_id and instagram.api.client_secret
  3. If you wish to use the Cakefile, add your external host and port to http.external.host and http.external.port (this is the callback url that Instagram API servers will dispatch media to)

Starting the server

  % $YOUR_REDIS_PATH/src/redis-server
  % cd instastream-demo
  % socketstream start

Cakefile

Watch all default cities

While the socketstream server is running:

  % cd instastream-demo
  % cake all

Watch a certain default city

While the socketstream server is running:

  % cd instastream-demo
  % cake -w 'London' watch

List default cities

  % cd instastream-demo
  % cake list

Watch a certain non-default city

While the socketstream server is running:

  % cd instastream-demo
  % cake -w "Rome" -t "41.9" -o "12.5" watch

If you want to add a city with a minus long or minus lat, use a double minus (avoids problems with optparse options parsing)

  % cd instastream-demo
  % cake -w "Philadelphia" -t "39.95" -o "--75.17"  watch

Clear active subscriptions

  % cd instastream-demo
  % cake clear

cUrl

If you don't like the Cakefile you can use cUrl - see the last section of the blog post and the Instagram API documentation for information on how to do that.