muddyit_fu 0.2.6

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+nbproject

data/CHANGELOG

@@ -0,0 +1,31 @@
+muddyit_fu Changelog
+
+0.2.1
+- Updated to reflect new api
+
+0.2.0
+- Added new oauth style authentication method
+
+0.1.0
+- Moved to using Jeweller for gem management, should fix previously empty gems
+
+0.0.4
+- Fixed content_data bug when attributes hadn't been requested
+- Added proper dbpedia entity support for Entity class
+
+0.0.3
+- Updated License
+- Modified related and related_content functionality for pages to match muddy server API changes
+
+0.0.2
+
+- Added License
+- Added Changelog (!)
+- Moved back to using JSON for JRuby people
+- Improved content data terms data struct
+- Cached content data struct for a page object
+- Added a 'classification' method to entity to make up for type being an existing method
+
+0.0.1
+
+- First Release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rob Lee
+
+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.rdoc

@@ -0,0 +1,111 @@
+= muddyit_fu
+
+== Installation
+
+  sudo gem install gemcutter
+  sudo gem tumble
+  sudo gem install muddyit_fu
+
+== Getting started
+
+muddy.it uses oauth to manage it's api access.  To access the muddy.it data
+programmatically you will need to register an application.  Login and visit :
+
+http://www.muddy.it/oauth_clients/
+
+You can register an application here, a callback URI isn't required.
+
+The 'consumer token' and 'consumer secret' are used to generate a token for
+accessing muddy.it.  For further details and an example of how to programatically
+generate a new access token for muddy.it see here :
+
+http://stakeventures.com/articles/2008/02/23/developing-oauth-clients-in-ruby
+
+See the 'Authorising clients using irb' section for a sample irb session.
+
+These details are then used to provide access to the service.  The credentials
+can be stored in a yml file, an example of which is provided below.
+
+== Example muddyit.yml
+
+  ---
+  consumer_key: "YOUR_CONSUMER_KEY"
+  consumer_secret: "YOUR_CONSUMER_SECRET"
+  access_token: "YOUR_ACCESS_TOKEN"
+  access_token_secret: "YOUR_ACCESS_TOKEN_SECRET"
+
+== Retrieving all sites
+
+  require 'muddyit_fu'
+  muddyit = Muddyit.new('muddyit.yml')
+  muddyit.sites.find(:all).each do |site|
+    puts "#{site.label} : #{site.token}"
+  end
+
+== Retrieving a single site
+
+  require 'muddyit_fu'
+  muddyit = Muddyit.new('muddyit.yml')
+  puts muddyit.sites.find('a0ret4').label
+
+== Categorisation request
+
+  require 'muddyit_fu'
+  muddyit = Muddyit.new('muddyit.yml')
+  site = muddyit.sites.first
+  site.pages.create({:identifier => 'http://news.bbc.co.uk/1/hi/uk_politics/8011321.stm'}, {:minium_confidence => 0.2})
+
+== View categorised pages
+
+  require 'muddyit_fu'
+  muddyit =  Muddyit.new(:consumer_key => 'aaa',
+                         :consumer_secret => 'bbb',
+                         :access_token => 'ccc',
+                         :access_token_secret => 'ddd')
+  site = muddyit.sites.first
+  site.pages.find(:all) do |page|
+    puts page.title
+    page.entities.each do |entity|
+      puts entity.uri
+    end
+  end
+
+== View all pages containing 'Gordon Brown'
+
+  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|
+    puts page.identifier
+  end
+
+== Find related entities for 'Gordon Brown'
+
+  require 'muddyit_fu'
+  muddyit = Muddyit.new('muddyit.yml')
+  site = muddyit.sites.find(:all).first
+  puts "Related entity\tOccurance
+  site.entities.find_related('http://dbpedia.org/resource/Gordon_Brown').each do |entry|
+    puts "#{entry[:enity].uri}\t#{entry[:count]}"
+  end
+
+== Find related content for : http://news.bbc.co.uk/1/hi/uk_politics/7878418.stm
+
+  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
+  puts "Our page : #{page.title}\n\n"
+  page.related_content.each do |results|
+    puts "#{results[:page].title} #{results[:count]}"
+  end
+
+== Obtaining oauth access credentials
+
+See http://gist.github.com/178993
+
+== Contact
+
+  Author: Rob Lee
+  Email: support [at] muddy.it
+  Main Repository: http://github.com/rattle/muddyit_fu/tree/master

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "muddyit_fu"
+    gem.summary = "Provides a ruby interface to muddy.it"
+    gem.email = "support[at]muddy.it"
+    gem.homepage = "http://github.com/rattle/muddyit_fu"
+    gem.authors = ["rattle"]
+    gem.add_dependency('json', '>= 0.0.0')
+    gem.add_dependency('oauth', '>= 0.3.6')
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "muddyit_fu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.6

data/lib/muddyit/base.rb

@@ -0,0 +1,129 @@
+module Muddyit
+
+  def self.new(*params)
+    Muddyit::Base.new(*params)
+  end
+
+  class Base
+    class_attr_accessor :http_open_timeout
+    class_attr_accessor :http_read_timeout
+    attr_accessor :rest_endpoint
+    attr_reader :consumer_key, :consumer_secret, :access_token, :access_token_secret
+
+    @@http_open_timeout = 120
+    @@http_read_timeout = 120
+
+    REST_ENDPOINT = 'http://www.muddy.it'
+
+    # Set the request signing method
+    @@digest1   = OpenSSL::Digest::Digest.new("sha1")
+    @@digest256 = nil
+    if OpenSSL::OPENSSL_VERSION_NUMBER > 0x00908000
+      @@digest256 = OpenSSL::Digest::Digest.new("sha256") rescue nil # Some installation may not support sha256
+    end
+    
+    # create a new muddyit object
+    #
+    # You can either pass a hash with the following attributes:
+    #
+    # * :consumer_key (Required)
+    #     the consumer key
+    # * :consumer_secret (Required)
+    #     the consumer secret
+    # * :access_token (Required)
+    #     the token
+    # * :access_token_secret (Required)
+    #     the token secret
+    # * :rest_endpoint (Optional)
+    #     the muddy.it rest service endpoint
+    # or:
+    # * config_file (Required)
+    #     yaml file to load configuration from
+    #
+    # Config Example (yaml file)
+    # ---
+    # consumer_key: AAA
+    # consumer_secret: BBB
+    # access_token: CCC
+    # access_token_secret: DDD
+    #
+    def initialize(config_hash_or_file)
+      if config_hash_or_file.is_a? Hash
+        config_hash_or_file.nested_symbolize_keys!
+        @consumer_key = config_hash_or_file[:consumer_key]
+        @consumer_secret = config_hash_or_file[:consumer_secret]
+        @access_token = config_hash_or_file[:access_token]
+        @access_token_secret = config_hash_or_file[:access_token_secret]
+        @rest_endpoint = config_hash_or_file.has_key?(:rest_endpoint) ? config_hash_or_file[:rest_endpoint] : REST_ENDPOINT
+        raise 'config_hash must contain consumer_key and consumer_secret' unless @consumer_key and @consumer_secret
+      else
+        config = YAML.load_file(config_hash_or_file)
+        config.nested_symbolize_keys!
+        @consumer_key = config[:consumer_key]
+        @consumer_secret = config[:consumer_secret]
+        @access_token = config[:access_token]
+        @access_token_secret = config[:access_token_secret]
+        @rest_endpoint = config.has_key?(:rest_endpoint) ? config[:rest_endpoint] : REST_ENDPOINT
+        raise 'config file must contain consumer_key and consumer_secret' unless @consumer_key and @consumer_secret
+      end
+
+      @consumer = OAuth::Consumer.new(@consumer_key, @consumer_secret, {:site=>@rest_endpoint})
+      @accesstoken = OAuth::AccessToken.new(@consumer, @access_token, @access_token_secret)
+
+    end
+
+    # sends a request to the muddyit REST api
+    #
+    # Params
+    # * api_url (Required)
+    #     the request url (uri.path)
+    # * http_method (Optional)
+    #     choose between GET (default), POST, PUT, DELETE http request.
+    # * options (Optional)
+    #     hash of query parameters, you do not need to include access_key_id, secret_access_key because these are added automatically
+    #
+    def send_request(api_url, http_method = :get, opts = {}, body = nil)
+
+      raise 'no api_url supplied' unless api_url
+      res = request_over_http(api_url, http_method, opts, body)
+      # Strip any js wrapping methods
+
+      if res.body =~ /^.+\((.+)\)$/
+        r = JSON.parse($1)
+      else
+        r = JSON.parse(res.body)
+      end
+      
+      return r
+    end
+
+
+    # creates and/or returns the Muddyit::Sites object
+    def sites() @sites ||= Muddyit::Sites.new(self) end
+
+    protected
+
+    # For easier testing. You can mock this method with a XML file you re expecting to receive
+    def request_over_http(api_url, http_method, opts, body)
+
+      http_opts = { "Accept" => "application/json", "Content-Type" => "application/json", "User-Agent" => "muddyit_fu" }
+      query_string = opts.to_a.map {|x| x.join("=")}.join("&")
+
+      case http_method
+        when :get
+          url = opts.empty? ? api_url : "#{api_url}?#{query_string}"
+          @accesstoken.get(url, http_opts)
+        when :post
+          @accesstoken.post(api_url, body, http_opts)
+        when :put
+          @accesstoken.put(api_url, body, http_opts)
+        when :delete
+          @accesstoken.delete(api_url, http_opts)
+      else
+        raise 'invalid http method specified'
+      end
+    
+    end
+
+  end
+end

data/lib/muddyit/entities.rb

@@ -0,0 +1,3 @@
+class Entities
+  # Placeholder
+end

data/lib/muddyit/errors.rb

@@ -0,0 +1,19 @@
+module Muddyit
+  
+    class Error < RuntimeError
+      attr_accessor :code
+    end
+
+    class Errors
+      # Method used for raising the appropriate error class for a given error code.
+      # Currently raises only Muddyit::Error
+      def self.error_for(code, message)
+        raise RuntimeError.new("Internal error. Muddyit API error not identified or unknown error.") if (code.nil? || message.nil? || message.empty?)
+        raise RuntimeError.new("Internal error. Unknown error.") if code.to_i == 0 # We assume that error code 0 is never returned
+        e = Muddyit::Error.new("#{code}: #{message}")
+        e.code = code
+        raise e
+      end
+    end
+
+end

data/lib/muddyit/generic.rb

@@ -0,0 +1,59 @@
+class Muddyit::Generic < Muddyit::Base
+
+  # superclass for data objects to inherit
+  #
+  # allows us to change the api with little code change via the magic of method
+  # missing :)
+  #
+
+  attr_accessor :attributes
+
+  # constructor
+  #
+  # Params
+  # * muddyit (Required)
+  #     a muddyit::base object
+  # * attributes (Optional)
+  #     hash of method => value entries used to simulate methods on a real object
+  #
+  def initialize(muddyit, attributes = {})
+    @muddyit = muddyit
+    @attributes = attributes.nested_symbolize_keys!
+    @info_added = false
+  end
+
+  # request data from muddy.it if we haven't done so before and we don't have 
+  # the attribute requested (acts as getter + setter)
+  #
+  # Params
+  # * method (Required)
+  #     the object method to populate, from attributes or remotely
+  # * args (Optional)
+  #     the value to set the method to
+  #
+  def method_missing(method, args = nil)
+    if @info_added == false and !@attributes.has_key?(method.to_sym)
+      #puts "Searching for missing method #{method.to_s}"
+      @attributes.merge!(self.fetch)
+      @info_added = true
+    end
+    unless @attributes.has_key?(method.to_sym)
+      raise "No method named #{method.to_s}"
+    end
+    if args.nil?
+      @attributes[method.to_sym]
+    else
+      @attributes[method.to_sym] = args
+      return true
+    end
+  end
+
+  protected
+
+  # method used to retrieve data from muddy.it service, to be overridden
+  #
+  def fetch
+    raise "not implemented"
+  end
+
+end

data/lib/muddyit/sites/entities/entity.rb

@@ -0,0 +1,35 @@
+class Muddyit::Sites::Site::Entities::Entity < Muddyit::Generic
+
+  def classification
+    unless @attributes[:type]
+      # We merge here as we don't want to overwrite a entity specific confidence score
+      @attributes.merge!(self.fetch)
+    end
+    @attributes[:type]
+  end
+
+  # retrieve entities related to the specified entity within the site entities collection
+  #
+  # Params
+  # * options (Optional)
+  #
+  def related(options = {})
+    api_url = "/sites/#{self.site.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)
+    }
+    return results
+  end
+
+  protected
+  def fetch
+    api_url = "/sites/#{@attributes[:site][:token]}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}"
+    response = @muddyit.send_request(api_url, :get)
+    response.nested_symbolize_keys!
+  end
+  
+end

data/lib/muddyit/sites/entities.rb

@@ -0,0 +1,22 @@
+class Muddyit::Sites::Site::Entities < Muddyit::Generic
+  # Placeholder
+
+  # retrieve entities related to the specified entity within the site entities collection
+  #
+  # Params
+  # * options (Optional)
+  #
+  def find_related(uri, options = {})
+
+    raise if uri.nil?
+    api_url = "/sites/#{self.site.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)
+    }
+    return results
+  end
+  
+end

data/lib/muddyit/sites/pages/page/extracted_content.rb

@@ -0,0 +1,21 @@
+class Muddyit::Sites::Site::Pages::Page::ExtractedContent < Muddyit::Generic
+
+  def initialize(muddyit, attributes)
+    super(muddyit, attributes)
+    populate_terms
+  end
+
+
+  protected
+
+  def populate_terms
+    terms = []
+    if @attributes.has_key?(:terms)    
+      @attributes[:terms].each do |term|
+         terms.push term['term']
+      end
+      @attributes[:terms] = terms
+    end
+  end
+
+end

data/lib/muddyit/sites/pages/page.rb

@@ -0,0 +1,88 @@
+class Muddyit::Sites::Site::Pages::Page < Muddyit::Generic
+
+  # Create a set of entities from the categorisation results
+  def initialize(muddyit, attributes = {})
+    super(muddyit, attributes)
+    create_entities
+    @extracted_content_cache = nil
+  end
+
+  # submit a page or text for re-categorisation
+  #
+  # Params
+  # * options (Required)
+  #
+  def update(options = {})
+
+    # Ensure we get extracted_content as well
+    options[:include_content] = true
+
+    body = { :page => { :uri => self.uri, :options => options } }
+
+    api_url = "/sites/#{self.site.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))
+  end
+
+
+  # get extracted_content for page
+  #
+  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])
+      else
+        r = self.fetch
+        @extracted_content_cache = Muddyit::Sites::Site::Pages::Page::ExtractedContent.new(@muddyit, r[:extracted_content])
+      end
+    end
+    @extracted_content_cache
+  end
+
+  
+  # delete the page
+  #
+  def destroy
+    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{@attributes[:identifier]}"
+    response = @muddyit.send_request(api_url, :delete, {})
+    # Is this the correct thing to return ?
+    return true
+  end
+
+  # retrieve related pages
+  #
+  # Params
+  # * options (Optional)
+  #
+  def related_content(options = {})
+    api_url = "/sites/#{self.site.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']
+    }
+    return results
+  end
+
+  protected
+  def fetch
+    api_url = "/sites/#{self.site.attributes[:token]}/pages/#{@attributes[:identifier]}"
+    
+    response = @muddyit.send_request(api_url, :get, {:include_content => true}, nil)
+
+    response.nested_symbolize_keys!
+  end
+
+  # Convert results to entities
+  def create_entities
+    results = []
+    if @attributes.has_key?(:entities)
+      @attributes[:entities].each do |result|
+         results.push Muddyit::Sites::Site::Entities::Entity.new(@muddyit, result)
+      end
+      @attributes[:entities] = results
+    end
+  end
+
+end

data/lib/muddyit/sites/pages.rb

@@ -0,0 +1,172 @@
+class Muddyit::Sites::Site::Pages < Muddyit::Generic
+
+  # find a specific page from the site
+  #
+  # Params
+  # * type (Required)
+  #     one of :all or a page identifier
+  #
+  def find(type, options = {})
+    raise 'no type specified' if type.nil?
+
+    if type.is_a? Symbol
+      case type
+      when :all
+        api_url = "/sites/#{self.site.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))
+          }
+          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"
+          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)) }
+          return { :next_page => response['next_page'], :pages => pages }
+        end
+      else
+        raise 'invalid type specified'
+      end
+
+    elsif type.is_a? String
+      api_url = "/sites/#{self.site.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
+    end
+  end
+
+
+
+  # submit a page or text for categorisation
+  #
+  # Params
+  # * options (Required)
+  #
+  def create(doc = {}, options = {})
+
+    # Ensure we get content_data as well
+    options[:include_content] = true
+
+    # Ensure we have encoded the identifier and URI
+    unless doc[:uri] || doc[:text]
+      raise
+    end
+
+    body = { :page => doc.merge!(:options => options) }
+
+    api_url = "/sites/#{self.site.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))
+  end
+
+  # find all pages with specified entity
+  #
+  # Params
+  # * uri (Required)
+  #   a dbpedia URI
+  # * options (Optional)
+  #
+  #
+  def find_by_entity(uri, options = {}, &block)
+    queryAllWithURI(uri, options, &block)
+  end
+
+  # find all pages with specified entities
+  #
+  # Params
+  # * uris (Required)
+  #   an array of dbpedia URIs
+  # * options (Optional)
+  #
+  #
+  def find_by_entities(uris, options = {}, &block)
+    queryAllWithURI(uris.join(','), options, &block)
+  end
+
+  # find all pages with specified term
+  #
+  # Params
+  # * term (Required)
+  #   a string e.g. 'Gordon Brown'
+  # * options (Optional)
+  #
+  #
+  def find_by_term(term, options = {}, &block)
+    queryAllWithTerm(term, options, &block)
+  end
+
+  # find all pages with specified terms
+  #
+  # Params
+  # * terms (Required)
+  #   an array of strings e.g. ['Gordon Brown', 'Tony Blair']
+  # * options (Optional)
+  #
+  #
+  def find_by_terms(terms, options = {}, &block)
+    queryAllWithTerm(terms.join(','), options, &block)
+  end
+
+  protected
+
+  # find all pages with specified entit(y|ies)
+  #
+  # multiple uris may be specified using commas
+  #
+  # Params
+  # * options (Required)
+  #     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)}"
+    query_page(api_url, options, &block)
+  end
+
+  # find all pages with specified term(s)
+  #
+  # multiple terms may be specified using commas
+  #
+  # Params
+  # * options (Required)
+  #
+  #
+  def queryAllWithTerm(term, options, &block)
+    api_url = "/sites/#{self.site.attributes[:token]}/terms/#{term}"
+    query_page(api_url, options, &block)
+  end
+
+  # utility method for term and uri query calls
+  #
+  # Params
+  # * api_url (Required)
+  #     must contain uri to make request to
+  #
+  def query_page(api_url, options)
+    if block_given?
+      token = nil
+      begin
+        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))
+        }
+        token = response['next_page']
+        # Need to figure out which of the below actually occurs
+      end while !token.nil? || !token == ''
+    else
+      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)) }
+      return { :next_page => response[:next_page], :pages => pages }
+    end    
+  end
+
+end

data/lib/muddyit/sites/site.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,45 @@
+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

data/lib/muddyit_fu.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'net/http'
+require 'cgi'
+require 'json'
+#require 'json/ext'
+#gem 'monkeyhelper-oauth', :lib => 'lib/oauth'
+require 'oauth/consumer'
+require 'digest/md5'
+
+require 'pp'
+
+class Module
+  def class_attr_accessor(attribute_name)
+    class_eval <<-CODE
+      def self.#{attribute_name}
+        @@#{attribute_name} ||= nil
+      end
+      def self.#{attribute_name}=(value)
+        @@#{attribute_name} = value
+      end
+    CODE
+  end
+end
+
+
+class Hash
+  # File merb/core_ext/hash.rb, line 166
+  def nested_symbolize_keys!
+    each do |k,v|
+      sym = k.respond_to?(:to_sym) ? k.to_sym : k
+      self[sym] = Hash === v ? v.nested_symbolize_keys! : v
+      delete(k) unless k == sym
+    end
+    self
+  end
+
+  def nested_stringify_keys!
+    each do |k,v|
+      s = k.respond_to?(:to_s) ? k.to_s : k
+      self[s] = Hash === v ? v.nested_stringify_keys! : v
+      delete(k) unless k == s
+    end
+    self
+  end
+  
+end
+
+# base must load first
+%w(base errors generic sites entities sites/site sites/pages sites/pages/page sites/pages/page/extracted_content sites/entities sites/entities/entity).each do |file|
+  require File.join(File.dirname(__FILE__), 'muddyit', file)
+end
+
+

data/muddyit_fu.gemspec

@@ -0,0 +1,57 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{muddyit_fu}
+  s.version = "0.2.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["rattle"]
+  s.date = %q{2009-11-04}
+  s.email = %q{support[at]muddy.it}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/muddyit/base.rb",
+     "lib/muddyit/entities.rb",
+     "lib/muddyit/errors.rb",
+     "lib/muddyit/generic.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"
+  ]
+  s.homepage = %q{http://github.com/rattle/muddyit_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Provides a ruby interface to muddy.it}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0.0.0"])
+      s.add_runtime_dependency(%q<oauth>, [">= 0.3.6"])
+    else
+      s.add_dependency(%q<json>, [">= 0.0.0"])
+      s.add_dependency(%q<oauth>, [">= 0.3.6"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0.0.0"])
+    s.add_dependency(%q<oauth>, [">= 0.3.6"])
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: muddyit_fu
+version: !ruby/object:Gem::Version 
+  version: 0.2.6
+platform: ruby
+authors: 
+- rattle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-04 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.6
+    version: 
+description: 
+email: support[at]muddy.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/muddyit/base.rb
+- lib/muddyit/entities.rb
+- lib/muddyit/errors.rb
+- lib/muddyit/generic.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
+has_rdoc: true
+homepage: http://github.com/rattle/muddyit_fu
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Provides a ruby interface to muddy.it
+test_files: []
+