monkeyhelper-muddyit_fu 0.0.4 → 0.1.0

data/.gitignore

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

data/CHANGELOG

@@ -0,0 +1,25 @@
+muddyit_fu Changelog
+
+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/Rakefile

@@ -0,0 +1,56 @@
+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 = "robl[at]monkeyhelper.com"
+    gem.homepage = "http://github.com/monkeyhelper/muddyit_fu"
+    gem.authors = ["robl"]
+    # 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.1.0

data/lib/muddyit/base.rb

@@ -0,0 +1,184 @@
+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 :access_key_id, :secret_access_key
+
+    @@http_open_timeout = 60
+    @@http_read_timeout = 60
+
+    REST_ENDPOINT = 'http://www.muddy.it/api'
+
+    # 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:
+    #
+    # * :access_key_id (Required)
+    #     the access key id
+    # * :secret_access_key (Required)
+    #     the secret access key
+    # * :rest_endpoint (Optional)
+    #     the muddy.it rest service endpoint
+    # or:
+    # * config_file (Required)
+    #     yaml file to load configuration from
+    #
+    # Config Example (yaml file)
+    # ---
+    # access_key_id: YOUR_ACCESS_KEY_ID
+    # secret_access_key: YOUR_SECRET_ACCESS_KEY
+    #
+    def initialize(config_hash_or_file)
+      if config_hash_or_file.is_a? Hash
+        config_hash_or_file.nested_symbolize_keys!
+        @access_key_id = config_hash_or_file[:access_key_id]
+        @secret_access_key = config_hash_or_file[:secret_access_key]
+        @rest_endpoint = config_hash_or_file.has_key?(:rest_endpoint) ? config_hash_or_file[:rest_endpoint] : REST_ENDPOINT
+        raise 'config_hash must contain access_key_id and secret_access_key' unless @access_key_id and @secret_access_key
+      else
+        config = YAML.load_file(config_hash_or_file)
+        config.nested_symbolize_keys!
+        @access_key_id = config[:access_key_id]
+        @secret_access_key = config[:secret_access_key]
+        @rest_endpoint = config.has_key?(:rest_endpoint) ? config[:rest_endpoint] : REST_ENDPOINT
+        raise 'config file must contain access_key_id and secret_access_key' unless @access_key_id and @secret_access_key
+      end
+    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, options= {})
+
+      raise 'no api_url supplied' unless api_url
+
+      res = request_over_http(api_url, http_method, options)
+      # Strip any js wrapping methods
+      #puts res.body
+      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, options)
+
+      req = nil
+      http_opts = { "Accept" => "application/json", "User-Agent" => "muddyit_fu" }
+      url = URI.parse(api_url)
+
+      case http_method
+        when :get
+          u = url.query.nil? ? url.path : url.path+"?"+url.query
+          req = Net::HTTP::Get.new(u, http_opts)
+        when :post
+          req = Net::HTTP::Post.new(url.path, http_opts)
+        when :put
+          req = Net::HTTP::Put.new(url.path, http_opts)
+        when :delete
+          req = Net::HTTP::Delete.new(url.path, http_opts)
+      else
+        raise 'invalid http method specified'
+      end
+
+      options = calculate_signature(http_method, url.path, options)
+      req.set_form_data(options) unless options.keys.empty?
+      #req.basic_auth @username, @password
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.open_timeout = @@http_open_timeout
+      http.read_timeout = @@http_read_timeout
+      http.start do |http|
+        res = http.request(req)
+        case res
+        when Net::HTTPSuccess
+          return res
+        else
+          raise Muddyit::Errors.error_for(res.code, 'HTTP Error')
+        end
+      end
+    
+    end
+
+    # aws request signature methods, taken from http://rightscale.rubyforge.org/right_aws_gem_doc
+
+    def calculate_signature(http_verb, url, options)
+      endpoint = URI.parse(@rest_endpoint)
+      options.nested_stringify_keys!
+      options.delete('Signature')
+      options['AccessKeyId'] = @access_key_id
+      options['Signature'] = sign_request_v2(@secret_access_key, options, http_verb.to_s, endpoint.host, url)
+
+      return options
+    end
+
+    def signed_service_params(aws_secret_access_key, service_hash, http_verb, host, uri)
+      sign_request_v2(aws_secret_access_key, service_hash, http_verb, host, uri)
+    end
+
+    def sign_request_v2(aws_secret_access_key, service_hash, http_verb, host, uri)
+      fix_service_params(service_hash, '2')
+      # select a signing method (make an old openssl working with sha1)
+      # make 'HmacSHA256' to be a default one
+      service_hash['SignatureMethod'] = 'HmacSHA256' unless ['HmacSHA256', 'HmacSHA1'].include?(service_hash['SignatureMethod'])
+      service_hash['SignatureMethod'] = 'HmacSHA1'   unless @@digest256
+      # select a digest
+      digest = (service_hash['SignatureMethod'] == 'HmacSHA256' ? @@digest256 : @@digest1)
+      # form string to sign
+      canonical_string = service_hash.keys.sort.map do |key|
+        "#{amz_escape(key)}=#{amz_escape(service_hash[key])}"
+      end.join('&')
+      string_to_sign = "#{http_verb.to_s.upcase}\n#{host.downcase}\n#{uri}\n#{canonical_string}"
+
+      # sign the string
+      amz_escape(Base64.encode64(OpenSSL::HMAC.digest(digest, aws_secret_access_key, string_to_sign)).strip)
+    end
+
+    # Set a timestamp and a signature version
+    def fix_service_params(service_hash, signature)
+      service_hash["Timestamp"] ||= Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S.000Z") unless service_hash["Expires"]
+      service_hash["SignatureVersion"] = signature
+      service_hash
+    end
+
+    # Escape a string accordingly Amazon rulles
+    # http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/index.html?REST_RESTAuth.html
+    def amz_escape(param)
+      param.to_s.gsub(/([^a-zA-Z0-9._~-]+)/n) do
+        '%' + $1.unpack('H2' * $1.size).join('%').upcase
+      end
+    end
+
+
+  end
+end

data/lib/muddyit/content_data.rb

@@ -0,0 +1,21 @@
+class Muddyit::Sites::Site::Page::ContentData < 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/entity.rb

@@ -0,0 +1,18 @@
+class Muddyit::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
+
+  protected
+  def fetch
+    api_url = "#{@muddyit.rest_endpoint}/entities/#{URI.escape(CGI.escape(@attributes[:uri]),'.')}"
+    response = @muddyit.send_request(api_url, :get)
+    response.nested_symbolize_keys!
+  end
+  
+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/page.rb

@@ -0,0 +1,95 @@
+class Muddyit::Sites::Site::Page < Muddyit::Generic
+
+  # Create a set of entities from the categorisation results
+  def initialize(muddyit, attributes = {})
+    super(muddyit, attributes)
+    create_entities
+    @content_data_cache = nil
+  end
+
+  # submit a page or text for re-categorisation
+  #
+  # Params
+  # * options (Required)
+  #
+  def refresh(options)
+
+    # Ensure we get content_data as well
+    options[:include_content] = true unless options.has_key?(:include_content)
+
+    # Set the URI if not set
+    options[:uri] = options[:identifier] if options.has_key?(:identifier) && !options.has_key?(:uri) && !options.has_key?(:text)
+
+    # Ensure we have encoded the identifier and URI
+    if options.has_key?(:uri)
+      options[:uri] = URI.escape(CGI.escape(options[:uri]),'.')
+    elsif options.has_key?(:identifier)
+      options[:identifier] = URI.escape(CGI.escape(options[:identifier]),'.')
+    end
+
+    api_url = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/#{URI.escape(CGI.escape(@attributes[:identifier]),'.')}/refresh"
+    response = @muddyit.send_request(api_url, :post, options)
+    return Muddyit::Sites::Site::Page.new(@muddyit, response.merge!(:site => self.site))
+  end
+
+
+  # get content_data for page
+  #
+  def content_data
+    if @content_data_cache.nil?
+      if @attributes[:content_data]
+        @content_data_cache = Muddyit::Sites::Site::Page::ContentData.new(@muddyit, @attributes[:content_data])
+      else
+        r = self.fetch
+        @content_data_cache = Muddyit::Sites::Site::Page::ContentData.new(@muddyit, r[:content_data])
+      end
+    end
+    @content_data_cache
+  end
+
+  
+  # delete the page
+  #
+  def destroy
+    api_url = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/#{URI.escape(CGI.escape(@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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/#{URI.escape(CGI.escape(@attributes[:identifier]),'.')}/related/content"
+    response = @muddyit.send_request(api_url, :get, options)
+    
+    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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/#{URI.escape(CGI.escape(@attributes[:identifier]),'.')}"
+    response = @muddyit.send_request(api_url, :get, {:include_content => true })
+    response.nested_symbolize_keys!
+  end
+
+  # Convert results to entities
+  def create_entities
+    results = []
+    if @attributes.has_key?(:results)
+      @attributes[:results].each do |result|
+         results.push Muddyit::Entity.new(@muddyit, result)
+      end
+      @attributes[:results] = results
+    end
+  end
+
+end

data/lib/muddyit/pages.rb

@@ -0,0 +1,193 @@
+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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages"
+        if block_given?
+          token = nil
+          begin
+          response = @muddyit.send_request(api_url, :get, options.merge!(:page => token))
+          response['resultsets'].each { |page|
+            yield Muddyit::Sites::Site::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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages"
+          response = @muddyit.send_request(api_url, :get, options)
+
+          pages = []
+          response['resultsets'].each { |page| pages.push Muddyit::Sites::Site::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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/#{URI.escape(CGI.escape(type),'.')}"
+      response = @muddyit.send_request(api_url, :get, {})
+      response.has_key?('results') ? Muddyit::Sites::Site::Page.new(@muddyit, response.merge!(:site => self.site)) : nil
+    end
+  end
+
+  # retrieve entities related to the specified entity within the site pages collection
+  #
+  # Params
+  # * options (Optional)
+  #
+  def related_entities(uri, options = {})
+    raise "no uri supplied" if uri.nil?
+    api_url = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/related/entities/#{URI.escape(CGI.escape(uri),'.')}"
+    response = @muddyit.send_request(api_url, :get, options)
+
+    results = []
+    response.each { |result|
+      # The return format needs sorting out here .......
+      results.push Muddyit::Entity.new(@muddyit, result)
+    }
+    return results
+  end
+
+  # submit a page or text for categorisation
+  #
+  # Params
+  # * options (Required)
+  #
+  def categorise(options)
+
+    # Ensure we get content_data as well
+    options[:include_content] = true
+
+    # Set the URI if not set
+    options[:uri] = options[:identifier] if options.has_key?(:identifier) && !options.has_key?(:uri) && !options.has_key?(:text)
+
+    # Ensure we have encoded the identifier and URI
+    if options.has_key?(:uri)
+      raise if options[:uri].nil?
+      options[:uri] = URI.escape(CGI.escape(options[:uri]),'.')
+    elsif options.has_key?(:identifier)
+      raise if options[:identifier].nil?
+      options[:identifier] = URI.escape(CGI.escape(options[:identifier]),'.')
+    end
+
+    api_url = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/categorise"
+    response = @muddyit.send_request(api_url, :post, options)
+    return Muddyit::Sites::Site::Page.new(@muddyit, response.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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/withentities/#{URI.escape(CGI.escape(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 = "#{@muddyit.rest_endpoint}/sites/#{self.site.attributes[:token]}/pages/withterms/#{URI.escape(CGI.escape(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)
+        response['resultsets'].each { |page|
+          yield Muddyit::Sites::Site::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['resultsets'].each { |page| pages.push Muddyit::Sites::Site::Page.new(@muddyit, page.merge!(:site => self.site)) }
+      return { :next_page => response[:next_page], :pages => pages }
+    end    
+  end
+
+end

data/lib/muddyit/site.rb

@@ -0,0 +1,14 @@
+class Muddyit::Sites::Site < Muddyit::Generic
+
+  # get pages object for site
+  #
+  def pages() @pages ||= Muddyit::Sites::Site::Pages.new(@muddyit, :site => self) end
+  
+  protected
+  def fetch
+    api_url = "#{@muddyit.rest_endpoint}/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 = "#{@muddyit.rest_endpoint}/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 = "#{@muddyit.rest_endpoint}/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,52 @@
+require 'rubygems'
+require 'net/http'
+require 'cgi'
+require 'json'
+#require 'json/ext'
+require 'openssl'
+require 'base64' 
+
+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 entity site pages page content_data).each do |file|
+  require File.join(File.dirname(__FILE__), 'muddyit', file)
+end
+
+

data/muddyit_fu.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{muddyit_fu}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["robl"]
+  s.date = %q{2009-06-03}
+  s.email = %q{robl[at]monkeyhelper.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/muddyit/base.rb",
+     "lib/muddyit/content_data.rb",
+     "lib/muddyit/entity.rb",
+     "lib/muddyit/errors.rb",
+     "lib/muddyit/generic.rb",
+     "lib/muddyit/page.rb",
+     "lib/muddyit/pages.rb",
+     "lib/muddyit/site.rb",
+     "lib/muddyit/sites.rb",
+     "lib/muddyit_fu.rb",
+     "muddyit_fu.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/monkeyhelper/muddyit_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  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 = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,43 +1,50 @@
 --- !ruby/object:Gem::Specification 
 name: monkeyhelper-muddyit_fu
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
-- Rob Lee
+- robl
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-05-14 00:00:00 -07:00
+date: 2009-06-03 00:00:00 -07: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: 
-description: Provides a ruby interface to muddy.it via the REST api
-email: robl at monkeyhelper.com
+dependencies: []
+
+description: 
+email: robl[at]monkeyhelper.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-files: []
-
-has_rdoc: false
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/muddyit/base.rb
+- lib/muddyit/content_data.rb
+- lib/muddyit/entity.rb
+- lib/muddyit/errors.rb
+- lib/muddyit/generic.rb
+- lib/muddyit/page.rb
+- lib/muddyit/pages.rb
+- lib/muddyit/site.rb
+- lib/muddyit/sites.rb
+- lib/muddyit_fu.rb
+- muddyit_fu.gemspec
+has_rdoc: true
 homepage: http://github.com/monkeyhelper/muddyit_fu
 post_install_message: 
 rdoc_options: 
-- --main
-- README
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,6 +65,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Provides a ruby interface to muddy.it via the REST api
+summary: Provides a ruby interface to muddy.it
 test_files: []