datasift 2.1.1 → 3.0.0.beta

data/examples/football-buffered.rb

@@ -1,51 +0,0 @@
-# This example constructs a DataSift_Definition object with CSDL that looks
-# for anything containing the word "football". It then sits in a loop,
-# getting buffered interactions once every 10 seconds until it's retrieved
-# 10.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the DataSift library
-require './' + File.dirname(__FILE__) + '/../lib/datasift'
-
-# Include the configuration - put your username and API key in this file
-require 'yaml'
-config = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', 'config.yml')))
-
-# Authenticate
-puts 'Creating user...'
-user = DataSift::User.new(config['username'], config['api_key'])
-
-# Create the definition
-csdl = 'interaction.content contains "football"'
-puts 'Creating definition...'
-puts '  ' + csdl
-definition = user.createDefinition(csdl)
-
-# Get buffered interactions until we've had 10
-puts 'Getting buffered interactions...'
-puts '--'
-num = 10
-from_id = false
-begin
-	interactions = definition.getBuffered(num, from_id)
-	interactions.each do |interaction|
-		puts 'Type: ' + interaction['interaction']['type']
-		puts 'Content: ' + interaction['interaction']['content']
-		puts '--'
-		num -= 1
-		from_id = interaction['interaction']['id']
-	end
-
-	if num > 0
-		sleep(10)
-	end
-end while num > 0
-
-puts
-puts 'Fetched 10 interactions, we\'re done.'
-puts

data/examples/football.rb

@@ -1,53 +0,0 @@
-# This example constructs a DataSift_Definition object with CSDL that looks
-# for anything containing the word "football". It then gets an HTTP
-# consumer for that definition and displays matching interactions to the
-# screen as they come in. It will display 10 interactions and then stop.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the DataSift library
-require './' + File.dirname(__FILE__) + '/../lib/datasift'
-
-# Include the configuration - put your username and API key in this file
-require 'yaml'
-config = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', 'config.yml')))
-
-# Authenticate
-puts 'Creating user...'
-user = DataSift::User.new(config['username'], config['api_key'])
-
-# Create the definition
-csdl = 'interaction.content contains "football"'
-puts 'Creating definition...'
-puts '  ' + csdl
-definition = user.createDefinition(csdl)
-
-# Create the consumer
-puts 'Getting the consumer...'
-consumer = definition.getConsumer(DataSift::StreamConsumer::TYPE_HTTP)
-
-# And start consuming
-puts 'Consuming...'
-puts '--'
-count = 10
-consumer.consume(true) do |interaction|
-	if interaction
-		puts 'Type: ' + interaction['interaction']['type']
-		puts 'Content: ' + interaction['interaction']['content']
-		puts '--'
-
-		count -= 1
-		if count == 0
-			puts 'Stopping consumer...'
-			consumer.stop()
-		end
-	end
-end
-
-puts
-puts 'Finished consuming'
-puts

data/examples/historics.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-ruby historics/$3.rb $1 $2 ${@:4}

data/examples/historics/create-from-csdl.rb

@@ -1,71 +0,0 @@
-# This script creates a new Historics query from a file containing CSDL.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Function to display usage instructions with an optional error message.
-def usage(message = '', end_of_story = true)
-	puts message + '\n' unless message.length() == 0
-	puts
-	puts 'Usage: create-from-csdl <username> <api_key> \\'
-	puts '            <csdl_filename> <start> <end> <sources> <sample> <name>'
-	puts
-	puts 'Where: csdl_filename = the stream hash the query should run'
-	puts '       start         = the start date for the query (YYYYMMDDHHMMSS)'
-	puts '       end           = the end date for the query (YYYYMMDDHHMMSS)'
-	puts '       sources       = comma separated list of data sources (e.g. twitter)'
-	puts '       sample        = the sample rate'
-	puts '       name          = a friendly name for the query'
-	puts
-	puts 'Example'
-	puts '       create-from-csdl csdl.txt 20120101000000 20120101235959 \\'
-	puts '                      twitter 100 HistoricsQuery123'
-	puts
-	exit 1 unless not end_of_story
-end
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Check that we have enough arguments
-usage() unless env.args.size() == 6
-
-# Read the arguments
-csdl_filename = env.args[0]
-start_date    = env.args[1]
-end_date      = env.args[2]
-sources       = env.args[3].split(',')
-sample        = env.args[4]
-name          = env.args[5]
-
-# Parse the dates
-start_date = DateTime.strptime(start_date, '%Y%m%d%H%M%S')
-end_date   = DateTime.strptime(end_date,   '%Y%m%d%H%M%S')
-
-# Read the CSDL
-csdl = File.open(csdl_filename, 'r').read
-
-begin
-	# Create the definition
-	definition = env.user.createDefinition(csdl)
-
-	# Create the Historics query
-	historic = definition.createHistoric(start_date, end_date, sources, sample, name)
-
-	# Prepare the query
-	historic.prepare()
-
-	# Display the details
-	env.displayHistoricDetails(historic)
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
- rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/create-from-hash.rb

@@ -1,65 +0,0 @@
-# This script creates a new Historics query from a stream hash.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Function to display usage instructions with an optional error message.
-def usage(message = '', end_of_story = true)
-	puts message + '\n' unless message.length() == 0
-	puts
-	puts 'Usage: create-from-hash \\'
-	puts '            <username> <api_key> <hash> <start> <end> <sources> <sample> <name>'
-	puts
-	puts 'Where: hash    = the stream hash the query should run'
-	puts '       start   = the start date for the query (YYYYMMDDHHMMSS)'
-	puts '       end     = the end date for the query (YYYYMMDDHHMMSS)'
-	puts '       sources = comma separated list of data sources (e.g. twitter)'
-	puts '       sample  = the sample rate'
-	puts '       name    = a friendly name for the query'
-	puts
-	puts 'Example'
-	puts '       create-from-hash <hash> 20120101000000 20120101235959 \\'
-	puts '                      twitter 100 HistoricsQuery123'
-	puts
-	exit 1 unless not end_of_story
-end
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Check that we have enough arguments
-usage() unless env.args.size() == 6
-
-# Read the arguments
-stream_hash = env.args[0]
-start_date  = env.args[1]
-end_date    = env.args[2]
-sources     = env.args[3].split(',')
-sample      = env.args[4]
-name        = env.args[5]
-
-# Parse the dates
-start_date = DateTime.strptime(start_date, '%Y%m%d%H%M%S')
-end_date   = DateTime.strptime(end_date,   '%Y%m%d%H%M%S')
-
-begin
-	# Create the Historics query
-	historic = env.user.createHistoric(stream_hash, start_date, end_date, sources, sample, name)
-
-	# Prepare the query
-	historic.prepare()
-
-	# Display the details
-	env.displayHistoricDetails(historic)
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
- rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/delete.rb

@@ -1,30 +0,0 @@
-# This script deletes Historics queries from your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Make sure we have something to do
-abort('Please specify one or more playback IDs') unless env.args.size() > 0
-
-begin
-	for playback_id in env.args
-		historic = env.user.getHistoric(playback_id)
-		print 'Deleting ' + playback_id + ', "' + historic.name + '"...'
-		historic.delete()
-		puts 'done'
-	end
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/env.rb

@@ -1,37 +0,0 @@
-# This class is used by the Historics examples to remove the noise of
-# dealing with command line arguments.
-#
-
-# Include the DataSift library
-require File.dirname(__FILE__) + '/../../lib/datasift'
-
-class Env
-	attr_reader :user, :args
-
-	def initialize(args = false)
-		if args === false
-			args = ARGV
-		end
-
-		abort('Please specify your DataSift username and API key as the first two command line arguments!') unless args.size() >= 2
-
-		username = args.shift
-		api_key = args.shift
-		@user = DataSift::User.new(username, api_key)
-
-		@args = args
-	end
-
-	def displayHistoricDetails(historic)
-		puts 'Playback ID: ' + historic.hash
-		puts 'Stream hash: ' + historic.stream_hash
-		puts 'Name:        ' + historic.name
-		puts 'Start time:  ' + historic.start_date.strftime('%Y-%m-%d %H:%M:%S')
-		puts 'End time:    ' + historic.end_date.strftime('%Y-%m-%d %H:%M:%S')
-		puts 'Sources:     ' + historic.sources.join(', ')
-		puts 'Sample:      ' + String(historic.sample)
-		puts 'Created at:  ' + (historic.created_at.nil? ? 'None' : historic.created_at.strftime('%Y-%m-%d %H:%M:%S'))
-		puts 'Status:      ' + historic.status
-		puts '--'
-	end
-end

data/examples/historics/list.rb

@@ -1,30 +0,0 @@
-# This script lists Historics queries in your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-begin
-	historics = env.user.listHistorics()
-
-	if historics['historics'].size() == 0
-		puts 'No Historics queries exist in your account.'
-	else
-		for historic in historics['historics']
-			env.displayHistoricDetails(historic)
-		end
-	end
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/start.rb

@@ -1,30 +0,0 @@
-# This script starts Historics queries in your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Make sure we have something to do
-abort('Please specify one or more playback IDs') unless env.args.size() > 0
-
-begin
-	for playback_id in env.args
-		historic = env.user.getHistoric(playback_id)
-		print 'Starting ' + playback_id + ', "' + historic.name + '"...'
-		historic.start()
-		puts 'done'
-	end
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/stop.rb

@@ -1,30 +0,0 @@
-# This script stops Historics queries in your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Make sure we have something to do
-abort('Please specify one or more playback IDs') unless env.args.size() > 0
-
-begin
-	for playback_id in env.args
-		historic = env.user.getHistoric(playback_id)
-		print 'Stopping ' + playback_id + ', "' + historic.name + '"...'
-		historic.stop()
-		puts 'done'
-	end
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/historics/view.rb

@@ -1,28 +0,0 @@
-# This script views Historics queries in your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Make sure we have something to do
-abort('Please specify one or more playback IDs') unless env.args.size() > 0
-
-begin
-	for playback_id in env.args
-		historic = env.user.getHistoric(playback_id)
-		env.displayHistoricDetails(historic)
-	end
-
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-rescue DataSift::DataSiftError => err
-	puts 'ERR: [' + err.class.name + '] ' + err.message
-end

data/examples/push.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-ruby push/$3.rb $1 $2 ${@:4}

data/examples/push/delete.rb

@@ -1,33 +0,0 @@
-# This script deletes Push subscriptions from your account.
-#
-# NB: Most of the error handling (exception catching) has been removed for
-# the sake of simplicity. Nearly everything in this library may throw
-# exceptions, and production code should catch them. See the documentation
-# for full details.
-#
-
-# Include the shared Env class
-require File.dirname(__FILE__) + '/env'
-
-# Create the env object. This reads the command line arguments, creates the
-# user object, and provides access to both along with helper functions.
-env = Env.new()
-
-# Make sure we have something to do
-abort('Please specify one or more subscription IDs') unless env.args.size() > 0
-
-for sub_id in env.args
-	begin
-		sub = env.user.getPushSubscription(sub_id)
-		print 'Deleting ' + sub_id + ', "' + sub.name + '"...'
-		sub.delete()
-	rescue DataSift::DataSiftError => err
-		puts 'ERR: [' + err.class.name + '] ' + err.message
-	else
-		puts 'done'
-	end
-end
-
-if env.user.rate_limit_remaining != -1
-	puts 'Rate limit remainining: ' + String(env.user.rate_limit_remaining)
-end