radian6 0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/*
+.rvmrc
+.DS_Store
+*.tmproj
+.*swp
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/License.md

@@ -0,0 +1,8 @@
+Copyright (c) 2012 Riccardo Cambiassi
+
+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.
+

data/README.md

@@ -0,0 +1,48 @@
+# Radian6
+
+Radian6 gem is a (rough) ruby interface to the Radian6 EST API (http://labs.radian6.com/api/)
+
+## INSTALLATION
+
+    gem install radian6
+
+## Usage
+
+    # connect to the API
+    api = Radian6::API.new(username, password, app_key, :sandbox =>
+true, :proxy => myproxy, :debug => true, :async => false)
+    
+    # get a XML dump of the posts within a specified range
+    posts_xml = api.fetchRangeTopicPostsXML( ((Time.now - 3600)*1000).to_s, (Time.now * 1000).to_s, [topic])
+
+    # get topics
+    topics = api.topics
+    
+
+
+## Status
+
+This is just the first draft of the wrapper. It can be improved in many, many ways.
+The API class in particular is quite messy, as it's the result of several experiments, expect it to change quite dramatically in the near future. 
+
+Feel free to help (see Contributing below)
+
+## TODO
+
+* Clean up API class (maybe structuring the various calls in different "services" as suggested by the API documentation)
+* better coverage for object output (right now only Post and Topic are supported)
+* remove the option to generate objects from xml as it's too slow and hogs the memory when dealing with big pages.
+* remove async connection option and isolate it via a Connector class interface
+
+## Contributing to the code (a.k.a. submitting a pull request)
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Commit and push your changes.
+5. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+
+## Copyright
+
+Copyright (c) 2012 Riccardo Cambiassi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/radian6/api.rb

@@ -0,0 +1,183 @@
+require 'rubygems'
+require 'nokogiri'
+require 'net/http'
+require 'em-http-request'
+require 'uri'
+require 'digest/md5'
+require 'time'
+
+module Radian6
+  class API
+    class HarvestError < StandardError; end
+    attr_reader :auth_appkey, :auth_token
+    def initialize(username, password, app_key, opts={})
+      @auth_appkey = app_key
+      opts = { :sandbox => false, :debug => false, :async => false }.merge(opts)
+      @debug = opts[:debug]
+      @async = opts[:async]
+      @proxy = opts[:proxy]
+      if opts[:sandbox]
+        @endpoint = "http://sandboxapi.radian6.com/socialcloud/v1/"
+      else
+        @endpoint = "http://api.radian6.com/socialcloud/v1/"
+      end
+
+      authenticate(username, password)
+      return self
+    end
+
+    def topics(cache=false)
+      if (cache)
+        xml = File.read('./fixtures/topics.xml')
+      else
+        log("App Key: #{@auth_appkey.inspect}")
+        log("Auth Token: #{@auth_token.inspect}")
+        xml = api_get( "topics", { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })
+      end
+      log("Received XML\n#{xml.inspect}")
+      return Radian6::Topic.from_xml(xml)
+    end
+
+    def fetchRecentTopicPosts(hours=1,topics=[62727],media=[1,2,4,5,8,9,10,11,12,13,16],start_page=0,page_size=1000,dump_file=false)
+      path = "data/topicdata/recent/#{hours}/#{topics.join(',')}/#{media.join(',')}/#{start_page}/#{page_size}"
+      xml = api_get(path, { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })     
+      return Radian6::Post.from_xml(xml)
+    end
+
+    def fetchRangeTopicPosts(range_start,range_end,topics=[62727],media=[1,2,4,5,8,9,10,11,12,13,16],start_page=0,page_size=1000,dump_file=false)
+      # BEWARE: range_start and range_end should be UNIX epochs in milliseconds, not seconds
+      xml = fetchRangeTopicPostsXML(range_start, range_end, topics, media, start_page, page_size)
+
+      if dump_file
+        log "\tDumping to file #{dump_file} at #{Time.now}"
+        f = File.new(dump_file, "w")
+        f.write(xml)
+        f.close
+
+        counter = Radian6::SAX::PostCounter.new 
+        parser = Nokogiri::XML::SAX::Parser.new(counter)
+        parser.parse(xml)
+        log "\tFinished parsing the file at #{Time.now}"
+        raise counter.error if counter.error
+        return counter
+      else
+        return Radian6::Post.from_xml(xml)
+      end
+    end
+
+    def fetchRangeTopicPostsXML(range_start, range_end, topics=[], media=[1,2,4,5,8,9,10,11,12,13,16], start_page=1, page_size=1000)
+      # BEWARE: range_start and range_end should be UNIX epochs in milliseconds, not seconds
+      path = "data/topicdata/range/#{range_start}/#{range_end}/#{topics.join(',')}/#{media.join(',')}/#{start_page}/#{page_size}?includeFullContent=1"
+      log "\tGetting page #{start_page} for range #{range_start} to #{range_end} in topic #{topics.join(', ')} at #{Time.now}"
+      xml = api_get(path, { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })
+      return xml
+    end
+
+    def fetchMediaTypes
+      path = "lookup/mediaproviders"
+      xml = api_get(path, { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })
+      return xml
+    end
+
+    def eachRangeTopicPostsXML(range_start, range_end, topics=[62727], media=[1,2,4,5,8,9,10,11,12,13,16], page_size=1000)
+      page = 1
+      fetched_article_count = 0
+      botched = 0
+      total_count = 1
+      begin
+        xml         = sanitize_xml( fetchRangeTopicPostsXML(range_start, range_end, topics, media, page, page_size) )
+        counter     = get_posts_counter_for(xml)
+        total_count = counter.total
+        fetched_article_count = (page -1) * page_size + counter.count
+
+        yield page, xml, counter
+
+        page += 1
+      end while total_count > fetched_article_count
+    end
+
+    def fetchRangeConversationCloudData(range_start, range_end, topics=[62727], media=[1,2,4,5,8,9,10,11,12,13,16], segmentation=0)
+      path = "data/tagclouddata/#{range_start}/#{range_end}/#{topics.join(',')}/#{media.join(',')}/#{segmentation}"
+      api_get(path, { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })
+    end
+
+    def fetchInfluencerData(topics=[], show_sentiment = 0, show_engagement = 0)
+      path = "data/influencerdata/#{topics.join(",")}/#{show_sentiment}/#{show_engagement}/"
+      api_get(path, { 'auth_appkey' => @auth_appkey, 'auth_token' => @auth_token })
+    end
+  
+    protected
+
+    def sanitize_xml(xml)
+      xml.gsub(/\u0000/, '')
+    end
+  
+    def authenticate(username, password) 
+      log("Username -> #{username.inspect}")
+      log("Password -> #{password.inspect}")
+      md5_pass = Digest::MD5::hexdigest(password)
+      xml = api_get("auth/authenticate", 
+                    { 'auth_user' => username, 
+                      'auth_pass' => md5_pass,
+                      'auth_appkey' => @auth_appkey})
+      log("Received XML\n#{xml.inspect}")
+      doc = Nokogiri::XML(xml)
+      @auth_token = doc.xpath('//auth/token').text
+    end
+
+    def get_posts_counter_for(xml)
+        counter = Radian6::SAX::PostCounter.new
+        parser  = Nokogiri::XML::SAX::Parser.new(counter)
+        parser.parse(xml)
+        raise counter.error if counter.error
+        counter
+    end
+
+    def log(string)
+      puts "#{self.class}: #{string}" if @debug
+    end
+  
+    def api_get(method, headers={})
+      if @async
+        get_async(method, headers)
+      else
+        get_sync(method, headers)
+      end
+    end
+
+    def get_async(method, headers={})
+      options = { 
+        :connect_timeout => 3600,
+        :inactivity_timeout => 3600,
+      }
+      options[:proxy] = { :host => @proxy.host, :port => @proxy.port.to_i } if @proxy
+
+      unless method == "auth/authenticate"
+        headers['auth_appkey'] = @auth_appkey
+        headers['auth_token']  = @auth_token
+      end
+      http = EventMachine::HttpRequest.new(@endpoint + method, options ).get :head => headers
+      http.response
+    end
+
+    def get_sync(method, args={})
+      unless method == "auth/authenticate"
+        args['auth_appkey'] = @auth_appkey
+        args['auth_token']  = @auth_token
+      end
+      
+      url = URI.parse(@endpoint + method)
+      
+      protocol = @proxy.nil? ? Net::HTTP : Net::HTTP::Proxy(@proxy.host, @proxy.port)
+
+      res = protocol.start(url.host, url.port ) do |http|
+        http.open_timeout = 3600
+        http.read_timeout = 3600
+        log "  GET #{url.request_uri}"
+        http.get(url.request_uri, args)
+      end
+      res.body # maybe handle errors too...
+    end
+    
+  end
+end

data/lib/radian6/filter_group.rb

@@ -0,0 +1,12 @@
+module Radian6
+  class FilterGroup
+    attr_accessor :name, :queries, :id
+    
+    def initialize(params)
+      params = {} unless params.is_a? Hash
+      @name = params[:name] || ''
+      @queries   = params[:queries] || ''
+      @id       = params[:id] || ''
+    end
+  end
+end

data/lib/radian6/filter_query.rb

@@ -0,0 +1,12 @@
+module Radian6
+  class FilterQuery
+    attr_accessor :query, :isExcludeQuery, :id
+    
+    def initialize(params)
+      params = {} unless params.is_a? Hash
+      @isExcludeQuery = params[:isExcludeQuery] || ''
+      @query   = params[:query] || ''
+      @id       = params[:id] || ''
+    end
+  end
+end

data/lib/radian6/post.rb

@@ -0,0 +1,40 @@
+module Radian6
+  class Post
+    attr_accessor :author, :avatar, :username, :title, :created_at, :updated_at, :id, :body, :source, :permalink
+    
+    def initialize(params)
+      params = {} unless params.is_a? Hash
+      @username = params[:username] || ""
+      @title    = params[:title]    || ""
+      @id       = params[:id]       || ""
+      @body     = params[:body]     || ""
+      @source   = params[:source].downcase || "" rescue ""
+      @permalink= params[:permalink]       || ""
+      @author   = params[:author]   || ""
+      @avatar   = params[:avatar]   || ""
+      @created_at=params[:created_at]  || ""
+      @updated_at=params[:updated_at]  || ""
+    end
+    
+    def self.from_xml(xml)
+      xml_posts = Nokogiri::XML(xml).root.xpath('//article') rescue []
+      posts = []
+      xml_posts.each_with_index do |xml_message, index|
+        post = self.new({
+          :username    => xml_message.xpath('./description/author').text,
+          :title       => xml_message.xpath('./description/headline').text,
+          :author      => xml_message.xpath('./description/author').text,
+          :avatar      => xml_message.xpath('./avatar').text,
+          :created_at  => xml_message.xpath('./publish_date').text,
+          :updated_at  => xml_message.xpath('./publish_date').text,
+          :id          => xml_message.object_id,
+          :body        => xml_message.xpath('./description/content').text,
+          :source      => xml_message.xpath('./media_provider').text,
+          :permalink   => xml_message.xpath('./article_url').text
+        })
+        posts << post
+      end
+      return posts
+    end
+  end
+end

data/lib/radian6/sax/post.rb

@@ -0,0 +1,101 @@
+require 'nokogiri'
+
+module Radian6
+  module SAX
+    class Post < Nokogiri::XML::SAX::Document
+      attr_reader :posts
+      def initialize
+        @post_elem = false
+        @current_post = {}
+        @posts = []
+        @path = []
+        @xpaths = {
+            :prefix => "radian6_RiverOfNews_export/article/", 
+            :paths  => {'description/author'    => "username",
+                        'description/headline'  => "title",
+                        'description/author'    => "author",
+                        'avatar'                => "avatar",
+                        'publish_date'          => "created_at",
+                        'description/content'   => "body",
+                        'media_provider'        => "source",
+                        'article_url'           => "permalink"
+                      }
+          }
+      end
+      
+      def start_element name, attrs = []
+        @path << name
+        if is_resource_elem?
+          @post_elem = find_resource_elem(name)
+        end
+        if name == "article"
+          attrs.each do |a|
+            @current_post[:id] = a[1] if a[0].to_s.downcase == "id"
+          end
+        end
+      end
+    
+      def end_element name
+        @path.pop
+        @post_elem = false
+        if name == "article"
+          post = Radian6::Post.new(@current_post)
+          new_post(post)
+          @current_post = {}
+        end
+        if name == "radian6_RiverOfNews_export"
+          end_of_file
+        end
+      end
+
+      def characters text
+        update_post(text)
+      end
+      
+      def cdata_block text
+        update_post(text)
+      end
+      
+      def update_post(text)
+        if @post_elem
+          @current_post[@post_elem] = text
+        end
+      end        
+      
+      def new_post(post)
+        @posts << post
+      end
+      
+      def end_of_file
+        true
+      end
+      
+      def is_resource_elem?
+        xpaths.include?(current_path)
+      end
+      
+      def find_resource_elem(name)
+        xpaths_map[current_path].to_sym
+      end
+      
+      def current_path
+        @path.join("/")
+      end
+      
+      def xpaths
+        @expanded_paths ||= @xpaths[:paths].keys.map { |x| @xpaths[:prefix] + x }
+      end
+      
+      def xpaths_map
+        return @expanded_paths_map if @expanded_paths_map
+        
+        @expanded_paths_map = {}
+        @xpaths[:paths].keys.each do |path|
+          @expanded_paths_map[@xpaths[:prefix] + path] = @xpaths[:paths][path]
+        end
+        return @expanded_paths_map
+      end
+      
+    end
+  end
+end

data/lib/radian6/sax/post_counter.rb

@@ -0,0 +1,61 @@
+require 'nokogiri'
+
+module Radian6
+  module SAX
+    class PostCounter < Nokogiri::XML::SAX::Document
+      attr_reader :count, :total, :error, :last_timestamp
+      def initialize
+        @in_count = false
+        @in_total = false
+        @in_error = false
+      end
+      def start_element name, attrs = []
+        unless done?
+          case name
+          when "article_count"
+            @in_count = true
+          when "total_article_count"
+            @in_total = true
+          when "error"
+            @in_error = true
+          when "publish_date"
+            fetch_timestamp(attrs)
+          end
+        end
+      end
+
+      def end_element name
+        unless done?
+          case name
+          when "article_count"
+            @in_count = false
+          when "total_article_count"
+            @in_total = false
+          when "error"
+            @in_error = false
+          end
+        end
+      end
+
+      def characters text
+        unless done?
+          if @in_count
+            @count = text.to_i
+          elsif @in_total
+            @total = text.to_i
+          elsif @in_error
+            @error = text
+          end
+        end
+      end
+
+      def fetch_timestamp(attrs = [])
+        @last_timestamp ||= attrs.select { |key, value| key == "epoch" }.first[1].to_i
+      end
+
+      def done?
+        (@count.nil? || @total.nil? || @last_timestamp.nil?) ? false : true
+      end
+    end
+  end
+end

data/lib/radian6/topic.rb

@@ -0,0 +1,51 @@
+module Radian6
+  class Topic
+    attr_accessor :name, :groups, :id
+    
+    def initialize(params)
+      params = {} unless params.is_a? Hash
+      @name = params[:name] || ""
+      @groups   = params[:groups] || ""
+      @id       = params[:id] || ""
+    end
+
+    def self.from_xml(xml)
+      xml_topics = Nokogiri::XML(xml).root.xpath('//topicFilters/topicFilter') rescue []
+      topics = []
+      xml_topics.each do |xml_topic|
+        topics << parse_topic(xml_topic)
+      end
+      return topics
+    end
+    private
+
+    def self.parse_topic(xml_topic)
+      groups = []
+      xml_topic.xpath('./filterGroups/filterGroup').each do |xml_group|
+        groups << parse_group(xml_group)
+      end
+      self.new({
+        :name     => xml_topic.xpath('./name').text,
+        :id       => xml_topic.xpath('./topicFilterId').text,
+        :groups   => groups
+      })
+    end
+
+    def self.parse_group(xml_group)
+      queries = []
+      xml_group.xpath('./filterQueries/filterQuery').each do |xml_query|
+        queries << FilterQuery.new({
+          :id             => xml_query.xpath('./filterQueryId').text,
+          :query          => xml_query.xpath('./query').text,
+          :isExcludeQuery => xml_query.xpath('./filterQueryTypeId').text
+        })
+      end
+
+      FilterGroup.new({
+        :name     => xml_group.xpath('./name').text,
+        :id       => xml_group.xpath('./filterGroupId').text,
+        :queries  => queries
+      })
+    end
+  end
+end

data/lib/radian6/version.rb

@@ -0,0 +1,3 @@
+module Radian6
+  VERSION = "0.1"
+end

data/lib/radian6.rb

@@ -0,0 +1,8 @@
+require 'radian6/api'
+require 'radian6/post'
+require 'radian6/sax/post_counter'
+require 'radian6/sax/post'
+require 'radian6/topic'
+require 'radian6/filter_query'
+require 'radian6/filter_group'
+

data/radian6.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/radian6/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('yard')
+  s.add_development_dependency('webmock')
+  s.add_runtime_dependency('nokogiri', '>= 1.4.4')
+  s.add_runtime_dependency('em-http-request')
+  s.authors = ["Vincent Spehner"]
+  s.description = %q{A Ruby wrapper for the Radian6 REST API}
+  s.post_install_message =<<eos
+********************************************************************************
+
+  Thank you for installing radian6
+
+  Follow @vzmind on Twitter for announcements, updates, and news.
+  https://twitter.com/vzmind
+
+********************************************************************************
+eos
+  s.email = ['bru@codewitch.org']
+  # s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'https://github.com/vzmind/radian6'
+  s.name = 'radian6'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{Ruby wrapper for the Radian6 API}
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.version = Radian6::VERSION.dup
+end

data/spec/lib/radian6/api_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+require 'radian6'
+
+describe Radian6::API do
+  include Radian6SpecHelper
+  before do
+    stub_request(:get, "http://api.radian6.com/socialcloud/v1/auth/authenticate").
+      to_return(:status => 200, :body => auth_xml)
+  end
+
+  describe "initialization" do
+    it "should authenticate user" do
+      r6 = Radian6::API.new "username", "password", "123456789"
+      WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/auth/authenticate").
+        with(:headers => {'Auth-Pass' => '5f4dcc3b5aa765d61d8327deb882cf99', 'Auth-User' => 'username'})
+      
+      r6.should_not be_nil
+      r6.auth_token.should == "abcdefghi"
+      r6.auth_appkey.should == "123456789"
+    end
+  end
+
+  context "after initialization" do
+    before do 
+      @r6 = Radian6::API.new "username", "password", "123456789";
+    end
+
+    describe "#topics" do
+      before do
+        stub_request(:get, /.*api.radian6.com.+/).
+          to_return(:status => 200, :body => topics_xml)
+      end
+
+      it "should request topics" do
+        @r6.topics
+        WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/topics").
+          with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+      end
+    
+      it "should return a collection" do
+        @r6.topics.should respond_to :each
+      end
+    end
+    
+    describe "fetchRecentTopicPosts" do
+      before do
+        @topics = [123456]
+        stub_request(:get, /.*api.radian6.com.+/).
+        to_return(:status => 200, :body => recent_xml)
+      end
+
+      it "should make the correct request" do
+         @r6.fetchRecentTopicPosts 1, @topics, [1]
+         WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/data/topicdata/recent/1/123456/1/0/1000").
+           with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+      end
+      
+      it "should return a collection" do
+        @r6.fetchRecentTopicPosts(1, @topics, [1]).should respond_to :each
+      end
+      
+      it "should return radian6 posts" do
+        Radian6::Post.should_receive(:from_xml)
+        @r6.fetchRecentTopicPosts(1, @topics, [1])
+      end
+     end
+     
+    describe "fetchRangeTopicPostsXML" do
+      before do
+        @topics = [123456]
+        stub_request(:get, /.*api.radian6.com.+/).
+           to_return(:status => 200, :body => range_xml)
+      end
+      
+      it "should make the correct request" do
+        @r6.fetchRangeTopicPostsXML "1308738914000", "1308738964000", @topics, [1]
+        WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/data/topicdata/range/1308738914000/1308738964000/123456/1/1/1000?includeFullContent=1").
+          with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+      end
+      
+      it "should not return radian6 posts" do
+        Radian6::Post.should_not_receive(:from_xml)
+        @r6.fetchRangeTopicPostsXML("1308738914000", "1308738964000", @topics, [1])
+      end
+      
+      it "should return xml" do
+        @r6.fetchRangeTopicPostsXML("1308738914000", "1308738964000", @topics, [1]).should == range_xml
+      end
+    end
+    
+    describe "eachRangeTopicPostsXML" do
+      before do
+        @topics = [123456]
+      end
+      context "when posts span multiple pages" do 
+        it "should loop over all the pages" do
+          stub_request(:get, /.*api.radian6.com.+\/[123]\/10/).
+            to_return(:status => 200, :body => pages_xml(10, 33))
+          stub_request(:get, /.*api.radian6.com.+\/4\/10/).
+            to_return(:status => 200, :body => pages_xml(3, 33))
+
+          counter = 1
+          @r6.eachRangeTopicPostsXML("1308738914000", "1308738964000", @topics, [1], 10) do |page, xml|
+            WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/data/topicdata/range/1308738914000/1308738964000/123456/1/#{counter}/10?includeFullContent=1").
+              with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+
+            page.should == counter
+            if counter == 4
+              xml.should == pages_xml(3, 33)
+            else
+              xml.should == pages_xml(10, 33)
+            end
+            counter += 1
+          end
+
+          counter.should == 5
+        end
+      end
+      context "when all posts fit in one page" do
+        it "should make just one call" do
+          stub_request(:get, /.*api.radian6.com.+\/1\/10/).
+            to_return(:status => 200, :body => pages_xml(10, 10))
+
+          counter = 1
+          @r6.eachRangeTopicPostsXML("1308738914000", "1308738964000", @topics, [1], 10) do |page, xml|
+            WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/data/topicdata/range/1308738914000/1308738964000/123456/1/#{counter}/10?includeFullContent=1").
+              with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+            counter += 1
+          end
+          counter.should == 2
+        end
+      end
+      context "when there are no posts" do
+         it "should loop just once" do
+           stub_request(:get, /.*api.radian6.com.+\/1\/20/).
+             to_return(:status => 200, :body => pages_xml(0, 0))
+
+           counter = 1
+           @r6.eachRangeTopicPostsXML("1308738914000", "1308738964000", @topics, [1], 20) do |page, xml|
+             WebMock.should have_requested(:get, "http://api.radian6.com/socialcloud/v1/data/topicdata/range/1308738914000/1308738964000/123456/1/#{counter}/20?includeFullContent=1").
+               with(:headers => {'Auth-Appkey' => '123456789', 'Auth-Token' => 'abcdefghi'})
+
+             page.should == 1
+             xml.should == pages_xml(0, 0)
+             counter += 1
+           end
+
+           counter.should == 2
+         end
+       end     
+    end  
+  end  
+end

data/spec/lib/radian6/filter_group_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Radian6::FilterGroup do
+  
+  describe "initialization" do  
+     filter_group_attributes = [:name, :queries, :id]
+     ['Radian6::FilterGroup.new({})', 'Radian6::FilterGroup.new(nil)', 'Radian6::FilterGroup.new([])'].each do |subj|
+       context "initializing with #{subj}" do
+         subject { eval subj}
+         filter_group_attributes.each do |method|
+           its(method.to_sym) { should be_empty }
+         end
+       end
+     end
+   end  
+  
+end

data/spec/lib/radian6/filter_query_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Radian6::FilterQuery do
+  describe "initialization" do  
+    filter_query_attributes = [ :query, :isExcludeQuery, :id]
+    ['Radian6::FilterQuery.new({})', 'Radian6::FilterQuery.new(nil)', 'Radian6::FilterQuery.new([])'].each do |subj|
+      context "initializing with #{subj}" do
+        subject { eval subj}
+        filter_query_attributes.each do |method|
+          its(method.to_sym) { should be_empty }
+        end
+      end
+    end
+  end  
+  
+end

data/spec/lib/radian6/post_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'radian6'
+
+describe Radian6::Post do
+  include Radian6SpecHelper
+  post_attributes = %w{author avatar username title created_at updated_at id body source permalink}
+  describe ".from_xml" do
+    context "nil parameter" do
+      it 'should return a collection' do
+        Radian6::Post.from_xml(nil).should respond_to :each
+      end
+    end
+    
+    context "bad parameter" do
+      it 'should return a collection' do
+        Radian6::Post.from_xml(27).should respond_to :each
+      end
+    end
+    
+    context "bad xml" do
+      it 'should return a collection' do
+        Radian6::Post.from_xml('wibble').should respond_to :each
+      end
+    end   
+    
+    context "empty string" do
+      it 'should return a collection' do
+        Radian6::Post.from_xml('').should respond_to :each
+      end
+    end  
+    
+    context "proccesing recent_xml" do
+      it "should produce Radian6::Posts" do
+        Radian6::Post.from_xml(recent_xml).each do |post| 
+          post.is_a?(Radian6::Post).should be true       
+        end
+      end
+    end
+  end
+  
+  describe "initialization" do  
+    ['Radian6::Post.new({})', 'Radian6::Post.new(nil)', 'Radian6::Post.new([])'].each do |subj|
+      context "initializing with #{subj}" do
+        subject { eval subj}
+        post_attributes.each do |method|
+          its(method.to_sym) { should be_empty }
+        end
+      end
+    end
+  end  
+end

data/spec/lib/radian6/topic_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Radian6::Topic do
+  include Radian6SpecHelper
+  
+  topic_attributes = [:name, :groups, :id]
+  describe ".from_xml" do
+    context "nil parameter" do
+      it 'should return a collection' do
+        Radian6::Topic.from_xml(nil).should respond_to :each
+      end
+    end
+    
+    context "bad parameter" do
+      it 'should return a collection' do
+        Radian6::Topic.from_xml(27).should respond_to :each
+      end
+    end
+    
+    context "bad xml" do
+      it 'should return a collection' do
+        Radian6::Topic.from_xml('wibble').should respond_to :each
+      end
+    end   
+    
+    context "empty string" do
+      it 'should return a collection' do
+        Radian6::Topic.from_xml('').should respond_to :each
+      end
+    end     
+    
+    context "proccesing topics_xml" do
+      it "should produce Radian6::Topics" do
+        Radian6::Topic.from_xml(topics_xml).each do |topic| 
+          topic.is_a?(Radian6::Topic).should be true       
+        end
+      end
+      it "should create FilterGroups for each topic" do 
+        Radian6::Topic.from_xml(topics_xml).each do |topic| 
+          topic.groups.each{|group| group.is_a?(Radian6::FilterGroup).should be true}       
+        end
+      end
+      it "should create FilterQueries for each FilterGroup" do 
+        Radian6::Topic.from_xml(topics_xml).each do |topic| 
+          topic.groups.each do |group| 
+            group.queries.each{|query| query.is_a?(Radian6::FilterQuery).should be true}
+          end         
+        end
+      end
+    end 
+  end
+  
+  describe "initialization" do  
+    ['Radian6::Topic.new({})', 'Radian6::Topic.new(nil)', 'Radian6::Topic.new([])'].each do |subj|
+      context "initializing with #{subj}" do
+        subject { eval subj}
+        topic_attributes.each do |method|
+          its(method) { should be_empty }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require 'rspec'
+require 'webmock/rspec'
+
+# require 'rspec/mocks/standalone'
+
+require 'support/radian6_spec_helper.rb'
+# Dir[File.firname.join("spec/support/**/*.rb")].each {|f| require f}
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'radian6'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    WebMock.disable_net_connect!(:allow_localhost => true)
+  end
+end

data/spec/support/radian6_spec_helper.rb

@@ -0,0 +1,76 @@
+module Radian6SpecHelper
+  def auth_xml
+    "<auth><token>abcdefghi</token></auth>"
+  end
+
+  def topics_xml
+    '<topicFilters>
+      <topicFilter>
+        <name><![CDATA[FILTER TEST]]></name>
+        <topicFilterId>111111</topicFilterId>
+        <filterGroups>
+          <filterGroup>
+            <filterGroupId>222222</filterGroupId>
+            <name><![CDATA[Group 2 test]]></name>
+            <filterQueries>
+              <filterQuery>
+                <query><![CDATA["apple" AND "banana"]]></query>
+                <filterQueryId>333333</filterQueryId>
+                <filterQueryTypeId>0</filterQueryTypeId>
+              </filterQuery>
+              <filterQuery>
+                <query><![CDATA["coconut" AND "date"]]></query>
+                <filterQueryId>444444</filterQueryId>
+                <filterQueryTypeId>0</filterQueryTypeId>
+              </filterQuery>
+            </filterQueries>
+          </filterGroup>
+          <filterGroup>
+            <filterGroupId>555555</filterGroupId>
+            <name><![CDATA[Group 5 test]]></name>
+            <filterQueries>
+              <filterQuery>
+                <query><![CDATA["elderberry" AND "fig"]]></query>
+                <filterQueryId>666666</filterQueryId>
+                <filterQueryTypeId>0</filterQueryTypeId>
+              </filterQuery>
+            </filterQueries>
+          </filterGroup>
+      </filterGroups>
+      </topicFilter>
+    </topicFilters>'
+  end
+  
+  def recent_xml
+    '<radian6_RiverOfNews_export>
+      <article ID="111111">
+        <description charset="UTF-8">
+          <headline><![CDATA[TEST HEADLINE 1]]></headline>
+          <author fbid="-1"><![CDATA[author]]></author>
+          <content><![CDATA[article content]]></content>
+        </description>
+        <article_url><![CDATA[http://example.com/111111]]></article_url>
+        <media_provider id="10">TWITTER</media_provider>
+        <publish_date epoch="1308738914000">Jun 22, 2011 11:35 AM</publish_date>
+      </article>
+      <article ID="222222">
+        <description charset="UTF-8">
+          <headline><![CDATA[TEST HEADLINE 2]]></headline>
+          <author fbid="-1"><![CDATA[author]]></author>
+          <content><![CDATA[article content]]></content>
+        </description>
+        <article_url><![CDATA[http://example.com/222222]]></article_url>
+        <media_provider id="10">TWITTER</media_provider>
+        <publish_date epoch="1308738914000">Jun 22, 2011 11:35 AM</publish_date>
+      </article>
+    </radian6_RiverOfNews_export>'
+  end
+  alias :range_xml :recent_xml
+
+  def pages_xml(article_count=10, total_article_count=100)
+    "<radian6_RiverOfNews_export>
+      <article_count>#{article_count}</article_count>
+      <total_article_count>#{total_article_count}</total_article_count>
+    </radian6_RiverOfNews_export>"
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: radian6
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Vincent Spehner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70256223536480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70256223536480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70256223535720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70256223535720
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70256223535140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256223535140
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70256223534440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256223534440
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70256223529600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256223529600
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &70256223528960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256223528960
+description: A Ruby wrapper for the Radian6 REST API
+email:
+- bru@codewitch.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- License.md
+- README.md
+- Rakefile
+- lib/radian6.rb
+- lib/radian6/api.rb
+- lib/radian6/filter_group.rb
+- lib/radian6/filter_query.rb
+- lib/radian6/post.rb
+- lib/radian6/sax/post.rb
+- lib/radian6/sax/post_counter.rb
+- lib/radian6/topic.rb
+- lib/radian6/version.rb
+- radian6.gemspec
+- spec/lib/radian6/api_spec.rb
+- spec/lib/radian6/filter_group_spec.rb
+- spec/lib/radian6/filter_query_spec.rb
+- spec/lib/radian6/post_spec.rb
+- spec/lib/radian6/topic_spec.rb
+- spec/spec_helper.rb
+- spec/support/radian6_spec_helper.rb
+homepage: https://github.com/vzmind/radian6
+licenses: []
+post_install_message: ! "********************************************************************************\n\n
+  \ Thank you for installing radian6\n\n  Follow @vzmind on Twitter for announcements,
+  updates, and news.\n  https://twitter.com/vzmind\n\n********************************************************************************\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: radian6
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the Radian6 API
+test_files:
+- spec/lib/radian6/api_spec.rb
+- spec/lib/radian6/filter_group_spec.rb
+- spec/lib/radian6/filter_query_spec.rb
+- spec/lib/radian6/post_spec.rb
+- spec/lib/radian6/topic_spec.rb
+- spec/spec_helper.rb
+- spec/support/radian6_spec_helper.rb