muddyit_fu 0.2.6 → 0.2.8

data/README.rdoc

@@ -8,23 +8,10 @@
 
 == 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 :
+muddy.it uses oauth to manage it's api access. 
 
-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.
+See http://blog.muddy.it/2009/11/getting-started-with-muddy for details on how to
+use the API.
 
 == Example muddyit.yml
 
@@ -53,7 +40,7 @@ can be stored in a yml file, an example of which is provided below.
   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})
+  site.pages.create({:uri => 'http://news.bbc.co.uk/1/hi/uk_politics/8011321.stm'}, {:minium_confidence => 0.2})
 
 == View categorised pages
 
@@ -100,10 +87,6 @@ can be stored in a yml file, an example of which is provided below.
     puts "#{results[:page].title} #{results[:count]}"
   end
 
-== Obtaining oauth access credentials
-
-See http://gist.github.com/178993
-
 == Contact
 
   Author: Rob Lee

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.8

data/examples/newsindexer.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'muddyit_fu'
+require 'rss'
+require 'open-uri'
+
+# Connect to Muddy
+muddyit =  Muddyit.new('./config.yml')
+site = muddyit.sites.find(:all).first
+# Parse RSS
+rss_content = ''
+open('http://newsrss.bbc.co.uk/rss/newsonline_uk_edition/uk_politics/rss.xml') do |f|
+  rss_content = f.read
+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})
+  puts "#{item.guid.content} contains:"
+  page.entities.each do |entity|
+    puts "\t#{entity.term}, #{entity.classification}"
+  end
+end
+

data/examples/oauth.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby
+
+# Script to ease muddy oauth application verification
+# from http://github.com/jnunemaker/twitter/blob/master/examples/oauth.rb
+
+require 'rubygems'
+require 'muddyit_fu'
+require 'launchy'
+
+puts "> enter consumer key"
+token = gets.chomp
+puts "> enter consumer secret"
+secret = gets.chomp
+
+oauth   = Muddyit::OAuth.new(token, secret)
+rtoken  = oauth.request_token.token
+rsecret = oauth.request_token.secret
+
+puts "> redirecting you to muddy to authorize"
+puts "> opening #{oauth.request_token.authorize_url}"
+Launchy.open(oauth.request_token.authorize_url)
+
+puts "> authorize in the browser and then press enter"
+waiting = gets.chomp
+
+begin
+  stoken,ssecret = oauth.authorize_from_request(rtoken, rsecret)
+
+  puts "Access Details"
+  puts
+  puts "Token : #{stoken}"
+  puts "Secret : #{ssecret}"
+  puts
+
+  puts "Account sites"
+  puts
+  
+  muddyit =  Muddyit.new(:consumer_key => token,
+                         :consumer_secret => secret,
+                         :access_token => stoken,
+                         :access_token_secret => ssecret)
+  
+  muddyit.sites.find(:all).each do |site|
+    puts "#{site.label} has token #{site.token}"
+  end
+
+rescue OAuth::Unauthorized
+  puts "> FAIL!"
+end

data/lib/muddyit/base.rb

@@ -67,8 +67,8 @@ module Muddyit
         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)
+      @consumer = ::OAuth::Consumer.new(@consumer_key, @consumer_secret, {:site=>@rest_endpoint})
+      @accesstoken = ::OAuth::AccessToken.new(@consumer, @access_token, @access_token_secret)
 
     end
 

data/lib/muddyit/oauth.rb

@@ -0,0 +1,49 @@
+# Borrowed from http://github.com/jnunemaker/twitter
+module Muddyit
+  class OAuth
+    extend Forwardable
+    def_delegators :access_token, :get, :post, :put, :delete
+
+    attr_reader :ctoken, :csecret, :consumer_options
+
+   
+    def initialize(ctoken, csecret, options={})
+      @ctoken, @csecret, @consumer_options = ctoken, csecret, {}
+    end
+
+    def consumer
+      @consumer ||= ::OAuth::Consumer.new(@ctoken, @csecret, {:site => 'http://muddy.it'}.merge(consumer_options))
+    end
+
+    def set_callback_url(url)
+      clear_request_token
+      request_token(:oauth_callback => url)
+    end
+
+    # Note: If using oauth with a web app, be sure to provide :oauth_callback.
+    # Options:
+    #   :oauth_callback => String, url that twitter should redirect to
+    def request_token(options={})
+      @request_token ||= consumer.get_request_token(options)
+    end
+
+    def authorize_from_request(rtoken, rsecret)
+      request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
+      access_token = request_token.get_access_token()
+      @atoken, @asecret = access_token.token, access_token.secret
+    end
+
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @atoken, @asecret)
+    end
+
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+
+    private
+      def clear_request_token
+        @request_token = nil
+      end
+  end
+end

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

@@ -1,12 +1,12 @@
 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
+#  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
   #
@@ -27,7 +27,7 @@ class Muddyit::Sites::Site::Entities::Entity < Muddyit::Generic
 
   protected
   def fetch
-    api_url = "/sites/#{@attributes[:site][:token]}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}"
+    api_url = "/sites/#{@attributes[:site].token}/entities/#{Digest::MD5.hexdigest(@attributes[:uri])}"
     response = @muddyit.send_request(api_url, :get)
     response.nested_symbolize_keys!
   end

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

@@ -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)
+         results.push Muddyit::Sites::Site::Entities::Entity.new(@muddyit, result.merge!(:site => @attributes[:site]))
       end
       @attributes[:entities] = results
     end

data/lib/muddyit_fu.rb

@@ -6,6 +6,7 @@ require 'json'
 #gem 'monkeyhelper-oauth', :lib => 'lib/oauth'
 require 'oauth/consumer'
 require 'digest/md5'
+require 'forwardable'
 
 require 'pp'
 
@@ -46,7 +47,7 @@ class Hash
 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|
+%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|
   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.6"
+  s.version = "0.2.8"
 
   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.date = %q{2009-11-10}
   s.email = %q{support[at]muddy.it}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -19,10 +19,13 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/newsindexer.rb",
+     "examples/oauth.rb",
      "lib/muddyit/base.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",
@@ -38,6 +41,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Provides a ruby interface to muddy.it}
+  s.test_files = [
+    "examples/newsindexer.rb",
+     "examples/oauth.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: muddyit_fu
 version: !ruby/object:Gem::Version 
-  version: 0.2.6
+  version: 0.2.8
 platform: ruby
 authors: 
 - rattle
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-04 00:00:00 +00:00
+date: 2009-11-10 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,10 +48,13 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/newsindexer.rb
+- examples/oauth.rb
 - lib/muddyit/base.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
@@ -89,5 +92,6 @@ rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Provides a ruby interface to muddy.it
-test_files: []
-
+test_files: 
+- examples/newsindexer.rb
+- examples/oauth.rb