muddyit_fu 0.2.8 → 0.2.9

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
 nbproject
+test/config.yml

data/README.rdoc

@@ -21,26 +21,26 @@ use the API.
   access_token: "YOUR_ACCESS_TOKEN"
   access_token_secret: "YOUR_ACCESS_TOKEN_SECRET"
 
-== Retrieving all sites
+== Retrieving all collections
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  muddyit.sites.find(:all).each do |site|
-    puts "#{site.label} : #{site.token}"
+  muddyit.collections.find(:all).each do |collection|
+    puts "#{collection.label} : #{collection.token}"
   end
 
-== Retrieving a single site
+== Retrieving a single collection
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  puts muddyit.sites.find('a0ret4').label
+  puts muddyit.collections.find('a0ret4').label
 
 == Categorisation request
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  site = muddyit.sites.first
-  site.pages.create({:uri => 'http://news.bbc.co.uk/1/hi/uk_politics/8011321.stm'}, {:minium_confidence => 0.2})
+  collection = muddyit.collections.first
+  collection.pages.create({:uri => 'http://news.bbc.co.uk/1/hi/uk_politics/8011321.stm'}, {:minium_confidence => 0.2})
 
 == View categorised pages
 
@@ -49,8 +49,8 @@ use the API.
                          :consumer_secret => 'bbb',
                          :access_token => 'ccc',
                          :access_token_secret => 'ddd')
-  site = muddyit.sites.first
-  site.pages.find(:all) do |page|
+  collection = muddyit.collections.first
+  collection.pages.find(:all) do |page|
     puts page.title
     page.entities.each do |entity|
       puts entity.uri
@@ -61,8 +61,8 @@ use the API.
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  site = muddyit.sites.find(:all).first
-  site.pages.find_by_entity('http://dbpedia.org/resource/Gordon_Brown') do |page|
+  collection = muddyit.collections.find(:all).first
+  collection.pages.find_by_entity('http://dbpedia.org/resource/Gordon_Brown') do |page|
     puts page.identifier
   end
 
@@ -70,9 +70,9 @@ use the API.
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  site = muddyit.sites.find(:all).first
+  collection = muddyit.collcetions.find(:all).first
   puts "Related entity\tOccurance
-  site.entities.find_related('http://dbpedia.org/resource/Gordon_Brown').each do |entry|
+  collection.entities.find_related('http://dbpedia.org/resource/Gordon_Brown').each do |entry|
     puts "#{entry[:enity].uri}\t#{entry[:count]}"
   end
 
@@ -80,8 +80,8 @@ use the API.
 
   require 'muddyit_fu'
   muddyit = Muddyit.new('muddyit.yml')
-  site = muddyit.sites.find(:all).first
-  page = site.pages.find(:all, :uri => 'http://news.bbc.co.uk/1/hi/uk_politics/7878418.stm').first
+  collection = muddyit.collections.find(:all).first
+  page = collection.pages.find(:all, :uri => 'http://news.bbc.co.uk/1/hi/uk_politics/7878418.stm').first
   puts "Our page : #{page.title}\n\n"
   page.related_content.each do |results|
     puts "#{results[:page].title} #{results[:count]}"

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.2.9

data/examples/newsindexer.rb

@@ -6,7 +6,7 @@ require 'open-uri'
 
 # Connect to Muddy
 muddyit =  Muddyit.new('./config.yml')
-site = muddyit.sites.find(:all).first
+collection= muddyit.collections.find(:all).first
 # Parse RSS
 rss_content = ''
 open('http://newsrss.bbc.co.uk/rss/newsonline_uk_edition/uk_politics/rss.xml') do |f|
@@ -15,7 +15,7 @@ end
 rss = RSS::Parser.parse(rss_content, false)
 # Loop through, analyse and display entities
 rss.items.each do |item|
-  page = site.pages.create({:uri => item.guid.content}, {:realtime => true, :store => false})
+  page = collection.pages.create({:uri => item.guid.content}, {:realtime => true, :store => false})
   puts "#{item.guid.content} contains:"
   page.entities.each do |entity|
     puts "\t#{entity.term}, #{entity.classification}"

data/examples/oauth.rb

@@ -32,7 +32,7 @@ begin
   puts "Secret : #{ssecret}"
   puts
 
-  puts "Account sites"
+  puts "Account collections"
   puts
   
   muddyit =  Muddyit.new(:consumer_key => token,
@@ -40,8 +40,8 @@ begin
                          :access_token => stoken,
                          :access_token_secret => ssecret)
   
-  muddyit.sites.find(:all).each do |site|
-    puts "#{site.label} has token #{site.token}"
+  muddyit.collections.find(:all).each do |collection|
+    puts "#{collection.label} has token #{collection.token}"
   end
 
 rescue OAuth::Unauthorized

data/lib/muddyit/base.rb

@@ -88,18 +88,25 @@ module Muddyit
       res = request_over_http(api_url, http_method, opts, body)
       # Strip any js wrapping methods
 
-      if res.body =~ /^.+\((.+)\)$/
-        r = JSON.parse($1)
+      case res
+      when Net::HTTPSuccess, Net::HTTPRedirection
+        case res.body
+        when " "
+          return res
+        when /^.+\((.+)\)$/
+          return JSON.parse($1)
+        else
+          return JSON.parse(res.body)
+        end
+      when Net::HTTPNotFound
+        return res
       else
-        r = JSON.parse(res.body)
+        return res.error!
       end
-      
-      return r
     end
 
-
-    # creates and/or returns the Muddyit::Sites object
-    def sites() @sites ||= Muddyit::Sites.new(self) end
+    # creates and/or returns the Muddyit::Collections object
+    def collections() @collections ||= Muddyit::Collections.new(self) end
 
     protected
 

data/lib/muddyit/collections/collection.rb

@@ -0,0 +1,20 @@
+class Muddyit::Collections::Collection < Muddyit::Generic
+
+  # get pages object for collection
+  #
+  def pages() @pages ||= Muddyit::Collections::Collection::Pages.new(@muddyit, :collection => self) end
+  def entities() @entities ||= Muddyit::Collections::Collection::Entities.new(@muddyit, :collection => self) end
+
+  def destroy
+    api_url = "/collections/#{@attributes[:token]}"
+    @muddyit.send_request(api_url, :delete, {})
+  end
+
+  protected
+  def fetch
+    api_url = "/collections/#{@attributes[:token]}"
+    response = @muddyit.send_request(api_url, :get, {})
+    response['collections'].nested_symbolize_keys!
+  end
+
+end

data/lib/muddyit/{sites → collections}/entities/entity.rb

@@ -1,4 +1,4 @@
-class Muddyit::Sites::Site::Entities::Entity < Muddyit::Generic
+class Muddyit::Collections::Collection::Entities::Entity < Muddyit::Generic
 
 #  def classification
 #    unless @attributes[:type]
@@ -8,26 +8,26 @@ class Muddyit::Sites::Site::Entities::Entity < Muddyit::Generic
 #    @attributes[:type]
 #  end
 
-  # retrieve entities related to the specified entity within the site entities collection
+  # retrieve entities related to the specified entity within the collection entities collection
   #
   # Params
   # * options (Optional)
   #
   def related(options = {})
-    api_url = "/sites/#{self.site.attributes[:token]}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}/related"
+    api_url = "/collections/#{self.collection.attributes[:token]}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}/related"
     response = @muddyit.send_request(api_url, :get, options)
 
     results = []
     response.each { |result|
       # The return format needs sorting out here .......
-      results.push Muddyit::Sites::Site::Entities::Entity.new(@muddyit, result)
+      results.push Muddyit::Collections::Collection::Entities::Entity.new(@muddyit, result)
     }
     return results
   end
 
   protected
   def fetch
-    api_url = "/sites/#{@attributes[:site].token}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}"
+    api_url = "/collections/#{@attributes[:collection].token}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}"
     response = @muddyit.send_request(api_url, :get)
     response.nested_symbolize_keys!
   end

data/lib/muddyit/{sites → collections}/entities.rb

@@ -1,7 +1,7 @@
-class Muddyit::Sites::Site::Entities < Muddyit::Generic
+class Muddyit::Collections::Collection::Entities < Muddyit::Generic
   # Placeholder
 
-  # retrieve entities related to the specified entity within the site entities collection
+  # retrieve entities related to the specified entity within the collection entities collection
   #
   # Params
   # * options (Optional)
@@ -9,12 +9,12 @@ class Muddyit::Sites::Site::Entities < Muddyit::Generic
   def find_related(uri, options = {})
 
     raise if uri.nil?
-    api_url = "/sites/#{self.site.attributes[:token]}/entities/#{Digest::MD5.hexdigest(uri)}/related"
+    api_url = "/collections/#{self.collection.attributes[:token]}/entities/#{Digest::MD5.hexdigest(uri)}/related"
     response = @muddyit.send_request(api_url, :get, options)
 
     results = []
     response.each { |result|
-      results.push :count => result.delete('count'), :entity => Muddyit::Sites::Site::Entities::Entity.new(@muddyit, result)
+      results.push :count => result.delete('count'), :entity => Muddyit::Collections::Collection::Entities::Entity.new(@muddyit, result)
     }
     return results
   end

data/lib/muddyit/{sites → collections}/pages/page/extracted_content.rb

@@ -1,11 +1,10 @@
-class Muddyit::Sites::Site::Pages::Page::ExtractedContent < Muddyit::Generic
+class Muddyit::Collections::Collection::Pages::Page::ExtractedContent < Muddyit::Generic
 
   def initialize(muddyit, attributes)
     super(muddyit, attributes)
     populate_terms
   end
 
-
   protected
 
   def populate_terms

data/lib/muddyit/{sites → collections}/pages/page.rb

@@ -1,4 +1,4 @@
-class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
+class Muddyit::Collections::Collection::Pages::Page < Muddyit::Generic
 
   # Create a set of entities from the categorisation results
   def initialize(muddyit, attributes = {})
@@ -19,9 +19,9 @@ class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
 
     body = { :page => { :uri => self.uri, :options => options } }
 
-    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{self.identifier}"
+    api_url = "/collections/#{self.collection.attributes[:token]}/pages/#{self.identifier}"
     response = @muddyit.send_request(api_url, :put, {}, body.to_json)
-    return Muddyit::Sites::Site::Pages::Page.new(@muddyit, response['page'].merge!(:site => self.site))
+    return Muddyit::Collections::Collection::Pages::Page.new(@muddyit, response['page'].merge!(:collection => self.collection))
   end
 
 
@@ -30,10 +30,10 @@ class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
   def extracted_content
     if @extracted_content_cache.nil?
       if @attributes[:extracted_content]
-        @extracted_content_cache = Muddyit::Sites::Site::Pages::Page::ExtractedContent.new(@muddyit, @attributes[:extracted_content])
+        @extracted_content_cache = Muddyit::Collections::Collection::Pages::Page::ExtractedContent.new(@muddyit, @attributes[:extracted_content])
       else
         r = self.fetch
-        @extracted_content_cache = Muddyit::Sites::Site::Pages::Page::ExtractedContent.new(@muddyit, r[:extracted_content])
+        @extracted_content_cache = Muddyit::Collections::Collection::Pages::Page::ExtractedContent.new(@muddyit, r[:extracted_content])
       end
     end
     @extracted_content_cache
@@ -43,7 +43,7 @@ class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
   # delete the page
   #
   def destroy
-    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{@attributes[:identifier]}"
+    api_url = "/colletions/#{self.collection.attributes[:token]}/pages/#{@attributes[:identifier]}"
     response = @muddyit.send_request(api_url, :delete, {})
     # Is this the correct thing to return ?
     return true
@@ -55,19 +55,19 @@ class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
   # * options (Optional)
   #
   def related_content(options = {})
-    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{@attributes[:identifier]}/related"
+    api_url = "/collections/#{self.collection.attributes[:token]}/pages/#{@attributes[:identifier]}/related"
     response = @muddyit.send_request(api_url, :get, options, nil)
     results = []
     response.each { |result|
       # The return format needs sorting out here .......
-      results.push :page => @attributes[:site].pages.find(result['identifier']), :count => result['count']
+      results.push :page => @attributes[:collection].pages.find(result['identifier']), :count => result['count']
     }
     return results
   end
 
   protected
   def fetch
-    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{@attributes[:identifier]}"
+    api_url = "/collections/#{self.collection.attributes[:token]}/pages/#{@attributes[:identifier]}"
     
     response = @muddyit.send_request(api_url, :get, {:include_content => true}, nil)
 
@@ -79,7 +79,7 @@ class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
     results = []
     if @attributes.has_key?(:entities)
       @attributes[:entities].each do |result|
-         results.push Muddyit::Sites::Site::Entities::Entity.new(@muddyit, result.merge!(:site => @attributes[:site]))
+         results.push Muddyit::Collections::Collection::Entities::Entity.new(@muddyit, result.merge!(:collection => @attributes[:collection]))
       end
       @attributes[:entities] = results
     end

data/lib/muddyit/{sites → collections}/pages.rb

@@ -1,6 +1,6 @@
-class Muddyit::Sites::Site::Pages < Muddyit::Generic
+class Muddyit::Collections::Collection::Pages < Muddyit::Generic
 
-  # find a specific page from the site
+  # find a specific page from the collection
   #
   # Params
   # * type (Required)
@@ -12,23 +12,23 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
     if type.is_a? Symbol
       case type
       when :all
-        api_url = "/sites/#{self.site.attributes[:token]}/pages"
+        api_url = "/collections/#{self.collection.attributes[:token]}/pages"
         if block_given?
           token = nil
           begin
           response = @muddyit.send_request(api_url, :get, options.merge!(:page => token))
           response['pages'].each { |page|
-            yield Muddyit::Sites::Site::Pages::Page.new(@muddyit, page.merge!(:site => self.site))
+            yield Muddyit::Collections::Collection::Pages::Page.new(@muddyit, page.merge!(:collection => self.collection))
           }
           token = response['next_page']
           # Need to figure out which of the below actually occurs
           end while !token.nil? || !token == ''
         else
-          api_url = "/sites/#{self.site.attributes[:token]}/pages"
+          api_url = "/collections/#{self.collection.attributes[:token]}/pages"
           response = @muddyit.send_request(api_url, :get, options)
 
           pages = []
-          response['pages'].each { |page| pages.push Muddyit::Sites::Site::Pages::Page.new(@muddyit, page.merge!(:site => self.site)) }
+          response['pages'].each { |page| pages.push Muddyit::Collections::Collection::Pages::Page.new(@muddyit, page.merge!(:collection => self.collection)) }
           return { :next_page => response['next_page'], :pages => pages }
         end
       else
@@ -36,9 +36,9 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
       end
 
     elsif type.is_a? String
-      api_url = "/sites/#{self.site.attributes[:token]}/pages/#{type}"
+      api_url = "/collections/#{self.collection.attributes[:token]}/pages/#{type}"
       response = @muddyit.send_request(api_url, :get, {})
-      response.has_key?('identifier') ? Muddyit::Sites::Site::Pages::Page.new(@muddyit, response.merge!(:site => self.site)) : nil
+      response.has_key?('identifier') ? Muddyit::Collections::Collection::Pages::Page.new(@muddyit, response.merge!(:collection => self.collection)) : nil
     end
   end
 
@@ -61,9 +61,9 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
 
     body = { :page => doc.merge!(:options => options) }
 
-    api_url = "/sites/#{self.site.attributes[:token]}/pages/"
+    api_url = "/collections/#{self.collection.attributes[:token]}/pages/"
     response = @muddyit.send_request(api_url, :post, {}, body.to_json)
-    return Muddyit::Sites::Site::Pages::Page.new(@muddyit, response['page'].merge!(:site => self.site))
+    return Muddyit::Collections::Collection::Pages::Page.new(@muddyit, response['page'].merge!(:collection => self.collection))
   end
 
   # find all pages with specified entity
@@ -125,7 +125,7 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
   #     must contain uri parameter which corresponds to dbpedia uri
   #
   def queryAllWithURI(uri, options, &block)
-    api_url = "/sites/#{self.site.attributes[:token]}/entities/#{Digest::MD5.hexdigest(uri)}"
+    api_url = "/collections/#{self.collection.attributes[:token]}/entities/#{Digest::MD5.hexdigest(uri)}"
     query_page(api_url, options, &block)
   end
 
@@ -138,7 +138,7 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
   #
   #
   def queryAllWithTerm(term, options, &block)
-    api_url = "/sites/#{self.site.attributes[:token]}/terms/#{term}"
+    api_url = "/collections/#{self.collection.attributes[:token]}/terms/#{term}"
     query_page(api_url, options, &block)
   end
 
@@ -155,7 +155,7 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
         options.merge!(:page => token) unless token.nil?
         response = @muddyit.send_request(api_url, :get, options.merge!(:page => token))
         response['pages'].each { |page|
-          yield Muddyit::Sites::Site::Pages::Page.new(@muddyit, page.merge!(:site => self.site))
+          yield Muddyit::Collections::Collection::Pages::Page.new(@muddyit, page.merge!(:collection => self.collection))
         }
         token = response['next_page']
         # Need to figure out which of the below actually occurs
@@ -164,7 +164,7 @@ class Muddyit::Sites::Site::Pages < Muddyit::Generic
       response = @muddyit.send_request(api_url, :get, {})
 
       pages = []
-      response['pages'].each { |page| pages.push Muddyit::Sites::Site::Pages::Page.new(@muddyit, page.merge!(:site => self.site)) }
+      response['pages'].each { |page| pages.push Muddyit::Collections::Collection::Pages::Page.new(@muddyit, page.merge!(:collection => self.collection)) }
       return { :next_page => response[:next_page], :pages => pages }
     end    
   end

data/lib/muddyit/collections.rb

@@ -0,0 +1,58 @@
+class Muddyit::Collections < Muddyit::Base
+
+  # create a new collections object
+  # not a muddyit:generic as it doesn't need the method missing loader
+  #
+  # Params :
+  #
+  # * muddyit (Required)
+  # a muddyit::base instance
+  #
+  def initialize(muddyit)
+    @muddyit = muddyit
+  end
+
+  def create(label, uri)
+
+    raise unless label
+
+    body = {:collection => {}}
+    body[:collection].merge!(:label => label) if label
+    body[:collection].merge!(:uri => uri) if uri
+
+    api_url = "/collections/"
+    response = @muddyit.send_request(api_url, :post, {}, body.to_json)
+    return Muddyit::Collections::Collection.new(@muddyit, response['collection'])
+  end
+
+  # find a specific collection
+  #
+  # Params
+  # * type (Required)
+  #   one of :all or a token
+  #
+  def find(type, options = {})
+    raise 'no type specified' unless type
+
+    if type.is_a? Symbol
+      case type
+      when :all
+        api_url = "/collections/"
+        response = @muddyit.send_request(api_url, :get, options)
+        collections = []
+        response.each { |collection| collections.push Muddyit::Collections::Collection.new(@muddyit, collection['collection']) }
+        return collections
+      else
+        raise 'invalid type specified'
+      end
+    elsif type.is_a? String
+      api_url = "/collections/#{type}"
+      response = @muddyit.send_request(api_url, :get, options)
+      return Muddyit::Collections::Collection.new(@muddyit, response['collection'])
+    else
+      raise 'invalid type specified'
+    end
+
+  end
+
+end

data/lib/muddyit/generic.rb

@@ -38,7 +38,8 @@ class Muddyit::Generic < Muddyit::Base
       @info_added = true
     end
     unless @attributes.has_key?(method.to_sym)
-      raise "No method named #{method.to_s}"
+      puts "Failed to find missing method #{method.to_s}"
+      raise
     end
     if args.nil?
       @attributes[method.to_sym]

data/lib/muddyit_fu.rb

@@ -47,8 +47,6 @@ class Hash
 end
 
 # base must load first
-%w(base oauth errors generic sites entities sites/site sites/pages sites/pages/page sites/pages/page/extracted_content sites/entities sites/entities/entity).each do |file|
+%w(base oauth errors generic collections entities collections/collection collections/pages collections/pages/page collections/pages/page/extracted_content collections/entities collections/entities/entity).each do |file|
   require File.join(File.dirname(__FILE__), 'muddyit', file)
 end
-
-

data/muddyit_fu.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{muddyit_fu}
-  s.version = "0.2.8"
+  s.version = "0.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["rattle"]
-  s.date = %q{2009-11-10}
+  s.date = %q{2010-01-09}
   s.email = %q{support[at]muddy.it}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -22,19 +22,22 @@ Gem::Specification.new do |s|
      "examples/newsindexer.rb",
      "examples/oauth.rb",
      "lib/muddyit/base.rb",
+     "lib/muddyit/collections.rb",
+     "lib/muddyit/collections/collection.rb",
+     "lib/muddyit/collections/entities.rb",
+     "lib/muddyit/collections/entities/entity.rb",
+     "lib/muddyit/collections/pages.rb",
+     "lib/muddyit/collections/pages/page.rb",
+     "lib/muddyit/collections/pages/page/extracted_content.rb",
      "lib/muddyit/entities.rb",
      "lib/muddyit/errors.rb",
      "lib/muddyit/generic.rb",
      "lib/muddyit/oauth.rb",
-     "lib/muddyit/sites.rb",
-     "lib/muddyit/sites/entities.rb",
-     "lib/muddyit/sites/entities/entity.rb",
-     "lib/muddyit/sites/pages.rb",
-     "lib/muddyit/sites/pages/page.rb",
-     "lib/muddyit/sites/pages/page/extracted_content.rb",
-     "lib/muddyit/sites/site.rb",
      "lib/muddyit_fu.rb",
-     "muddyit_fu.gemspec"
+     "muddyit_fu.gemspec",
+     "test/config.yml.example",
+     "test/test_helper.rb",
+     "test/test_muddyit_fu.rb"
   ]
   s.homepage = %q{http://github.com/rattle/muddyit_fu}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -42,7 +45,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Provides a ruby interface to muddy.it}
   s.test_files = [
-    "examples/newsindexer.rb",
+    "test/test_muddyit_fu.rb",
+     "test/test_helper.rb",
+     "examples/newsindexer.rb",
      "examples/oauth.rb"
   ]
 

data/test/config.yml.example

@@ -0,0 +1,6 @@
+consumer_key: Ni2rDBLHWym3BZxDwEm0d
+consumer_secret: X5zHwQrtGUV8M7LnOfaQtbH8r6Ka3nkONyS3gbklqM
+access_token: KzS6wjiCdKBIyeZtIq9v7A
+access_token_secret: zCd625JS6hZ3vhRVvNu8qNKx65eRdkLpHfKsXRPFy0
+rest_endpoint: http://muddy.it
+

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+
+require 'rubygems'
+require 'shoulda'
+require 'yaml'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'muddyit_fu'
+
+class Test::Unit::TestCase
+  # Add more helper methods to be used by all tests here...
+
+  def load_config(file = 'config.yml')
+    f = File.dirname(__FILE__) + '/../test/' + file
+    unless File.exist?(f)
+      puts "Unable to find configuration file #{f}"
+      exit 1
+    end
+    open(f) {|file| YAML.load(file) }
+  end
+
+end

data/test/test_muddyit_fu.rb

@@ -0,0 +1,141 @@
+require 'test_helper'
+require 'pp'
+
+class TestMuddyitFu < Test::Unit::TestCase
+
+  @@COLLECTION_LABEL = Time.now.to_s
+  @@STORY = 'http://news.bbc.co.uk/1/hi/business/8186840.stm'
+
+  context 'A muddy account' do
+
+    setup do
+      c = load_config
+      begin
+      @muddyit = Muddyit.new(:consumer_key => c['consumer_key'],
+                             :consumer_secret => c['consumer_secret'],
+                             :access_token => c['access_token'],
+                             :access_token_secret => c['access_token_secret'],
+                             :rest_endpoint => c['rest_endpoint'])
+      rescue
+        puts "Failed to connect to muddy, are the details correct ?"
+      end
+    end
+
+    should 'be able to create a collection' do
+      collection = @muddyit.collections.create(@@COLLECTION_LABEL, 'http://www.test.com')
+      assert !collection.token.nil?
+    end
+
+    should 'be able to find a collection' do
+      # This is a bit rubbish
+      @muddyit.collections.find(:all).each do |collection|
+        if collection.label == @@COLLECTION_LABEL
+          assert true
+        end
+      end
+    end
+
+    should 'be able to destroy a collection' do
+      # This is also a bit rubbish
+      collections = @muddyit.collections.find(:all)
+      collections.each do |collection|
+        if collection.label == @@COLLECTION_LABEL
+           res = collection.destroy
+           assert_equal res.code, "200"
+        end
+      end
+    end
+
+    context "with a collection" do
+
+      setup do
+        @collection = @muddyit.collections.create(@@COLLECTION_LABEL, 'http://www.test.com')
+      end
+
+      should "categorise a page in realtime and not store it" do
+        page = @collection.pages.create({:uri => @@STORY}, :realtime => true, :store => false)
+        assert page.entities.length > 0
+        pages = @collection.pages.find(:all)
+        assert pages[:pages].length == 0
+      end
+
+      should "categorise a page in realtime and store it" do
+        page = @collection.pages.create({:uri => @@STORY}, :realtime => true, :store => true)
+        assert page.entities.length > 0
+        pages = @collection.pages.find(:all)
+        assert_equal pages[:pages].length, 1
+      end
+
+      context "with a page" do
+
+        setup do
+          @page = @collection.pages.create({:uri => @@STORY}, :realtime => true)
+        end
+
+        should "find a page" do
+          assert_equal @collection.pages.find(@page.identifier).identifier, @page.identifier
+        end
+
+        should "have page attributes" do
+          assert !@page.identifier.nil?
+          assert !@page.title.nil?
+          assert !@page.created_at.nil?
+          assert !@page.content.nil?
+          assert !@page.uri.nil?
+          #assert !@page.token.nil?
+          # More attributes here ?
+        end
+
+        should "have many entities" do
+          assert @page.entities.length > 0
+        end
+
+        should "have an entity with a term and label" do
+          entity = @page.entities.first
+          assert !entity.term.nil?
+          assert !entity.uri.nil?
+        end
+
+        should "have extracted content" do
+          assert !@page.extracted_content.content.nil?
+          assert @page.extracted_content.terms.length > 0
+          assert @page.extracted_content.start_position > 0
+          assert @page.extracted_content.end_position > 0
+        end
+
+        should "delete a page" do
+          assert @page.destroy, "200"
+        end
+
+      end
+
+      context "with two pages" do
+
+        setup do
+          @page1 = @collection.pages.create({:uri => @@STORY}, :realtime => true)
+          @page2 = @collection.pages.create({:uri => @@STORY}, :realtime => true)
+        end
+
+        should "find all pages" do
+          assert_equal @collection.pages.find(:all).length, 2
+        end
+
+        should "find related pages" do
+          assert_equal @page1.related_content.length, 1
+        end
+
+      end
+
+      teardown do
+        #token = @collection.token
+        @collection.destroy
+        #res = @muddyit.collections.find(token)
+        # This should be a 404 (!)
+        #assert_equal res.code, "404"
+      end
+
+    end
+
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: muddyit_fu
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors: 
 - rattle
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-10 00:00:00 +00:00
+date: 2010-01-09 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,19 +51,22 @@ files:
 - examples/newsindexer.rb
 - examples/oauth.rb
 - lib/muddyit/base.rb
+- lib/muddyit/collections.rb
+- lib/muddyit/collections/collection.rb
+- lib/muddyit/collections/entities.rb
+- lib/muddyit/collections/entities/entity.rb
+- lib/muddyit/collections/pages.rb
+- lib/muddyit/collections/pages/page.rb
+- lib/muddyit/collections/pages/page/extracted_content.rb
 - lib/muddyit/entities.rb
 - lib/muddyit/errors.rb
 - lib/muddyit/generic.rb
 - lib/muddyit/oauth.rb
-- lib/muddyit/sites.rb
-- lib/muddyit/sites/entities.rb
-- lib/muddyit/sites/entities/entity.rb
-- lib/muddyit/sites/pages.rb
-- lib/muddyit/sites/pages/page.rb
-- lib/muddyit/sites/pages/page/extracted_content.rb
-- lib/muddyit/sites/site.rb
 - lib/muddyit_fu.rb
 - muddyit_fu.gemspec
+- test/config.yml.example
+- test/test_helper.rb
+- test/test_muddyit_fu.rb
 has_rdoc: true
 homepage: http://github.com/rattle/muddyit_fu
 licenses: []
@@ -93,5 +96,7 @@ signing_key:
 specification_version: 3
 summary: Provides a ruby interface to muddy.it
 test_files: 
+- test/test_muddyit_fu.rb
+- test/test_helper.rb
 - examples/newsindexer.rb
 - examples/oauth.rb

data/lib/muddyit/sites/site.rb

@@ -1,15 +0,0 @@
-class Muddyit::Sites::Site < Muddyit::Generic
-
-  # get pages object for site
-  #
-  def pages() @pages ||= Muddyit::Sites::Site::Pages.new(@muddyit, :site => self) end
-  def entities() @entities ||= Muddyit::Sites::Site::Entities.new(@muddyit, :site => self) end
-  
-  protected
-  def fetch
-    api_url = "/sites/#{@attributes[:token]}"
-    response = @muddyit.send_request(api_url, :get, {})
-    response['site'].nested_symbolize_keys!
-  end
-
-end

data/lib/muddyit/sites.rb

@@ -1,45 +0,0 @@
-class Muddyit::Sites < Muddyit::Base
-
-  # create a new sites object
-  # not a muddyit:generic as it doesn't need the method missing loader
-  #
-  # Params :
-  #
-  # * muddyit (Required)
-  # a muddyit::base instance
-  #
-  def initialize(muddyit)
-    @muddyit = muddyit
-  end
-
-  # find a specific site
-  #
-  # Params
-  # * type (Required)
-  #   one of :all or a site token
-  #
-  def find(type, options = {})
-    raise 'no type specified' unless type
-
-    if type.is_a? Symbol
-      case type
-      when :all
-        api_url = "/sites/"
-        response = @muddyit.send_request(api_url, :get, options)
-        sites = []
-        response.each { |site| sites.push Muddyit::Sites::Site.new(@muddyit, site['site']) }
-        return sites
-      else
-        raise 'invalid type specified'
-      end
-    elsif type.is_a? String
-      api_url = "/sites/#{type}"
-      response = @muddyit.send_request(api_url, :get, options)
-      return Muddyit::Sites::Site.new(@muddyit, response['site'])
-    else
-      raise 'invalid type specified'
-    end
-
-  end
-
-end