datasift 0.2.0

data/lib/DataSift/user.rb

@@ -0,0 +1,104 @@
+#
+# user.rb - This file contains the User class.
+#
+# Copyright (C) 2011 MediaSift Ltd
+#
+# == Overview
+#
+# The User class represents a user of the API. Applications should start their
+# API interactions by creating an instance of this class. Once initialised it
+# provides factory methods for all of the functionality in the API.
+
+require 'rest_client'
+require 'crack'
+
+module DataSift
+	# User class.
+	#
+	# == Introduction
+	#
+	# The User class represents a user of the API. Applications should start their
+	# API interactions by creating an instance of this class. Once initialised it
+	# provides factory methods for all of the functionality in the API.
+	#
+	class User
+		USER_AGENT = 'DataSiftRuby/0.1';
+		API_BASE_URL = 'api.datasift.net/';
+		STREAM_BASE_URL = 'stream.datasift.net/';
+
+		attr_reader :username, :api_key, :rate_limit, :rate_limit_remaining, :api_client
+
+		# Constructor. A username and API key are required when constructing an
+		# instance of this class.
+		# === Parameters
+		#
+		# * +username+ - The user's username
+		# * +api_key+ - The user's API key
+		def initialize(username, api_key)
+			username.strip!
+			api_key.strip!
+
+			raise EInvalidData, 'Please supply valid credentials when creating a User object.' unless username.size > 0 and api_key.size > 0
+
+			@username = username
+			@api_key = api_key
+			@rate_limit = -1;
+			@rate_limit_remaining = -1
+		end
+
+		# Creates and returns a definition object.
+		# === Parameters
+		#
+		# * +csdl+ - Optional CSDL string with which to prime the object.
+		def createDefinition(csdl = '')
+			DataSift::Definition.new(self, csdl, false)
+		end
+
+		# Returns the user agent this library should use for all API calls.
+		def getUserAgent()
+			USER_AGENT
+		end
+
+		# Sets the ApiClient object to use to access the API
+		def setApiClient(client)
+			@api_client = client
+		end
+
+		# Make a call to a DataSift API endpoint.
+		# === Parameters
+		#
+		# * +endpoint+ - The endpoint of the API call.
+		# * +params+ - The parameters to be passed along with the request.
+		def callAPI(endpoint, params = {})
+			if !@api_client
+				@api_client = ApiClient.new()
+			end
+
+			res = @api_client.call(@username, @api_key, endpoint, params)
+
+			# Set up the return value
+			retval = res['data']
+
+			# Update the rate limits from the headers
+			@rate_limit = res['rate_limit']
+			@rate_limit_remaining = res['rate_limit_remaining']
+
+			case res['response_code']
+			when 200
+				# Do nothing
+			when 401
+				# Authentication failure
+				raise AccessDeniedError, retval.has_key?('error') ? retval['error'] : 'Authentication failed'
+			when 403
+				# Check the rate limit
+				raise RateLimitExceededError, retval['comment'] if @rate_limit_remaining == 0
+				# Rate limit is ok, raise a generic exception
+				raise APIError.new(403), retval.has_key?('error') ? retval['error'] : 'Unknown error'
+			else
+				raise APIError.new(res['http_code']), retval.has_key?('error') ? retval['error'] : 'Unknown error'
+			end
+
+			retval
+		end
+	end
+end

data/lib/datasift.rb

@@ -0,0 +1,19 @@
+#
+# datasift.rb - DataSift module base file
+#
+# Copyright (C) 2011 MediaSift Ltd
+#
+# == Overview
+#
+# This is the base file for the DataSift API library. Require this file to get
+# access to the full library functionality.
+#
+require 'rubygems'
+
+dir = File.dirname(__FILE__)
+require dir + '/DataSift/exceptions'
+require dir + '/DataSift/apiclient'
+require dir + '/DataSift/user'
+require dir + '/DataSift/definition'
+require dir + '/DataSift/stream_consumer'
+require dir + '/DataSift/stream_consumer_http'

data/test/helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'yaml'
+require File.dirname(__FILE__) + '/../lib/DataSift/mockapiclient'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'datasift'
+
+class Test::Unit::TestCase
+	def init()
+		@config = YAML::load(File.open(File.join(File.dirname(__FILE__), '..', 'config.yml')))
+		@testdata = YAML::load(File.open(File.join(File.dirname(__FILE__), 'testdata.yml')))
+	end
+
+	def initUser(mock = true)
+			@user = DataSift::User.new(@config['username'], @config['api_key'])
+			if mock
+				@user.setApiClient(DataSift::MockApiClient.new())
+				@user.api_client.clearResponse()
+			end
+	end
+end

data/test/test_definition.rb

@@ -0,0 +1,282 @@
+require 'helper'
+
+class TestDefinition < Test::Unit::TestCase
+	context "Given an empty Definition object" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition()
+		end
+
+		should "have an empty CSDL" do
+			assert_not_nil @definition
+			assert_equal '', @definition.csdl
+		end
+
+		should "correctly set and get the CSDL" do
+			@definition.csdl = @testdata['definition']
+			assert_equal @testdata['definition'], @definition.csdl
+		end
+	end
+
+	context "Given a Definition object with CSDL" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['definition'])
+		end
+
+		should "have the correct CSDL" do
+			assert_not_nil @definition
+			assert_equal @testdata['definition'], @definition.csdl
+		end
+	end
+
+	context "Given a Definition object with CSDL plus padding" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition("    " + @testdata['definition'] + "     ")
+		end
+
+		should "have the correct CSDL" do
+			assert_not_nil @definition
+			assert_equal @testdata['definition'], @definition.csdl
+		end
+	end
+
+	context "When trying to create a Definition object with an invalid user" do
+		should "raise an InvalidDataError" do
+			assert_raise(DataSift::InvalidDataError) { DataSift::Definition.new('username') }
+		end
+	end
+
+	context "When trying to create a Definition object with an invalid CSDL" do
+		setup do
+			init()
+			initUser()
+		end
+
+		should "raise an InvalidDataError" do
+			assert_raise(DataSift::InvalidDataError) { DataSift::Definition.new(@user, 1234) }
+		end
+	end
+
+	context "Given a Definition object with a valid CSDL" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['definition'])
+		end
+
+		should "compile the definition successfully" do
+			begin
+				@user.api_client.setResponse(200, {
+					'hash'       => @testdata['definition_hash'],
+					'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+					'cost'       => 10,
+				}, 200, 150)
+				@definition.compile()
+			rescue InvalidDataError
+				assert false, "InvalidDataError"
+			rescue CompileFailedError
+				assert false, "CompileFailedError"
+			rescue APIError
+				assert false, "APIError"
+			end
+		end
+
+		should "have the correct hash" do
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			assert_equal @testdata['definition_hash'], @definition.hash
+		end
+
+		should "have a positive cost" do
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			@definition.compile()
+			assert @definition.total_cost > 0
+		end
+
+		should "have a valid created_at date" do
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			@definition.compile()
+			assert @definition.created_at
+		end
+	end
+
+	context "Given a Definition object with an invalid CSDL" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['invalid_definition'])
+		end
+
+		should "fail to compile the definition" do
+			@user.api_client.setResponse(400, {
+				'error' => 'The target interactin.content does not exist',
+			}, 200, 150)
+			assert_raise(DataSift::CompileFailedError) { @definition.compile() }
+		end
+
+		should "have a hash of false" do
+			@user.api_client.setResponse(400, {
+				'error' => 'The target interactin.content does not exist',
+			}, 200, 150)
+			assert_equal false, @definition.hash
+		end
+	end
+
+	context "The cost returned from a valid Definition object" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['definition'])
+			# Compile the definition first
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			@definition.compile()
+			# Now get the cost
+			@user.api_client.setResponse(200, {
+				'costs' => {
+					'contains' => {
+						'count'   => 1,
+						'cost'    => 4,
+						'targets' => {
+							'interaction.content' => {
+								'count' => 1,
+								'cost'  => 4,
+							},
+						},
+					},
+				},
+				'total' => 4
+			}, 200, 150)
+			@cost = @definition.getCostBreakdown()
+		end
+
+		should "contain valid cost data" do
+			assert @cost.has_key?('costs')
+			assert @cost.has_key?('total')
+		end
+
+		should "have a positive total cost" do
+			assert @cost['total'] > 0
+		end
+	end
+
+	context "Buffered data returned by a valid Definition object" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['definition'])
+			# Compile the definition first
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			@definition.compile()
+			# Now get some buffered interactions
+			@user.api_client.setResponse(200, {
+				'stream' => {
+					0 => {
+						'interaction' => {
+							'source' => 'Snaptu',
+							'author' => {
+								'username' => 'nittolexia',
+								'name'     => 'nittosoetreznoe',
+								'id'       => 172192091,
+								'avatar'   => 'http://a0.twimg.com/profile_images/1429378181/gendowor_normal.jpg',
+								'link'     => 'http://twitter.com/nittolexia',
+							},
+							'type'       => 'twitter',
+							'link'       => 'http://twitter.com/nittolexia/statuses/89571192838684672',
+							'created_at' => 'Sat, 09 Jul 2011 05:46:51 +0000',
+							'content'    => 'RT @ayyuchadel: Haha RT @nittolexia: Mending gak ush maen twitter dehh..RT @sansan_arie:',
+							'id'         => '1e0a9eedc207acc0e074ea8aecb2c5ea',
+						},
+						'twitter' => {
+							'user' => {
+								'name'            => 'nittosoetreznoe',
+								'description'     => 'fuck all',
+								'location'        => 'denpasar, bali',
+								'statuses_count'  => 6830,
+								'followers_count' => 88,
+								'friends_count'   => 111,
+								'screen_name'     => 'nittolexia',
+								'lang'            => 'en',
+								'time_zone'       => 'Alaska',
+								'id'              => 172192091,
+								'geo_enabled'     => true,
+							},
+							'mentions' => {
+								0 => 'ayyuchadel',
+								1 => 'nittolexia',
+								2 => 'sansan_arie',
+							},
+							'id'         => '89571192838684672',
+							'text'       => 'RT @ayyuchadel: Haha RT @nittolexia: Mending gak ush maen twitter dehh..RT @sansan_arie:',
+							'source'     => '<a href="http://www.snaptu.com" rel="nofollow">Snaptu</a>',
+							'created_at' => 'Sat, 09 Jul 2011 05:46:51 +0000',
+						},
+						'klout' => {
+							'score'         => 45,
+							'network'       => 55,
+							'amplification' => 17,
+							'true_reach'    => 31,
+							'slope'         => 0,
+							'class'         => 'Networker',
+						},
+						'peerindex' => {
+							'score' => 30,
+						},
+						'language' => {
+							'tag' => 'da',
+						},
+					},
+				},
+			}, 200, 150)
+			@interactions = @definition.getBuffered()
+		end
+
+		should "be valid" do
+			assert @interactions
+		end
+	end
+
+	context "A StreamConsumer object returned by a valid Definition object" do
+		setup do
+			init()
+			initUser()
+			@definition = @user.createDefinition(@testdata['definition'])
+			# Compile the definition first
+			@user.api_client.setResponse(200, {
+				'hash'       => @testdata['definition_hash'],
+				'created_at' => Time.now.strftime('%Y-%m-%d %H:%M:%S'),
+				'cost'       => 10,
+			}, 200, 150)
+			@definition.compile()
+			# Now get a consumer
+			@consumer = @definition.getConsumer()
+		end
+
+		should "be valid" do
+			assert @consumer.is_a? DataSift::StreamConsumer
+		end
+	end
+end

data/test/test_live_api.rb

@@ -0,0 +1,100 @@
+require 'helper'
+
+class TestDefinitionLive < Test::Unit::TestCase
+	context "Given a Definition object with a valid CSDL" do
+		setup do
+			init()
+			initUser(false)
+			@user = DataSift::User.new(@config['username'], @config['api_key'])
+			@definition = @user.createDefinition(@testdata['definition'])
+		end
+
+		should "compile the definition successfully" do
+			begin
+				@definition.compile()
+			rescue InvalidDataError
+				assert false, "InvalidDataError"
+			rescue CompileFailedError
+				assert false, "CompileFailedError"
+			rescue APIError
+				assert false, "APIError"
+			end
+		end
+
+		should "have the correct hash" do
+			@definition.compile()
+			assert_equal @testdata['definition_hash'], @definition.hash
+		end
+
+		should "have a positive cost" do
+			@definition.compile()
+			assert @definition.total_cost > 0
+		end
+
+		should "have a valid created_at date" do
+			@definition.compile()
+			assert @definition.created_at
+		end
+	end
+
+	context "Given a Definition object with an invalid CSDL" do
+		setup do
+			init()
+			initUser(false)
+			@definition = @user.createDefinition(@testdata['invalid_definition'])
+		end
+
+		should "fail to compile the definition" do
+			assert_raise(DataSift::CompileFailedError) { @definition.compile() }
+		end
+
+		should "have a hash of false" do
+			assert_raise(DataSift::CompileFailedError) { @definition.compile() }
+			assert_equal false, @definition.hash
+		end
+	end
+
+	context "The cost returned from a valid Definition object" do
+		setup do
+			init()
+			initUser(false)
+			@definition = @user.createDefinition(@testdata['definition'])
+			@cost = @definition.getCostBreakdown()
+		end
+
+		should "contain valid cost data" do
+			assert @cost.has_key?('costs')
+			assert @cost.has_key?('total')
+		end
+
+		should "have a positive total cost" do
+			assert @cost['total'] > 0
+		end
+	end
+
+	context "Buffered data returned by a valid Definition object" do
+		setup do
+			init()
+			initUser(false)
+			@definition = @user.createDefinition(@testdata['definition'])
+			@interactions = @definition.getBuffered()
+		end
+
+		should "be valid" do
+			assert @interactions
+		end
+	end
+
+	context "A StreamConsumer object returned by a valid Definition object" do
+		setup do
+			init()
+			initUser(false)
+			@definition = @user.createDefinition(@testdata['definition'])
+			@consumer = @definition.getConsumer()
+		end
+
+		should "be valid" do
+			assert @consumer.is_a? DataSift::StreamConsumer
+		end
+	end
+end