partigi-partigirb 0.2.3 → 0.2.4

data/README.rdoc

@@ -1,8 +1,73 @@
 = partigirb
 
-Wrapper for the Partigi API.
+Ruby wrapper for the Partigi API, adapted from Grackle by Hayes Davis (http://github.com/hayesdavis/grackle/tree/master).
 
-Adapted from Hayes Davis grackle gem (http://github.com/hayesdavis/grackle/tree/master)
+== Usage
+
+=== Creating a client
+
+==== Without Authentication
+
+  client = Partigirb::Client.new
+
+==== With Authentication
+
+  client = Partigirb::Client.new(:auth => {:login => 'SOMEUSERLOGIN', :api_secret => 'SECRETGENERATEDFORTHEUSER'})
+  
+==== With specific API version
+  
+  client = Partigirb::Client.new(:api_version => 2)
+  
+=== Request methods
+
+A request to Partigi servers is done by translating Partigi URL paths into a set of chained method calls, just changing slashes by dots. Each call is used to build the request URL until a format call is found which causes the request to be sent. In order to specify the HTTP method use:
+
+- <tt>?</tt> for HTTP GET
+- <tt>!</tt> for HTTP POST (in this case you will need to use a client with authentication)
+
+A request is not performed until either you add the above signs to your last method call or you use a format method call.
+
+=== Formats
+
+The response format is specified by a method call with the format name (atom, json or xml). Notice that the only format fully implemented on Partigi API at the moment is atom, which is the default used by the wrapper.
+
+=== Example requests
+
+The simplest way of executing a GET request is to use the <tt>?</tt> notation, using the default format.
+
+  client.users.show? :id => 'johnwayne'     # http://www.partigi.com/api/v1/users/show.atom?id=johnwayne
+  
+Also you can force the format:
+  
+  client.users.show.json? :id => 'johnwayne # http://www.partigi.com/api/v1/users/show.json?id=johnwayne
+
+For POST requests just change <tt>?</tt> by <tt>!</tt>:
+  
+  client.reviews.update! :id => 123, :status => 1 # POST to http://www.partigi.com/api/v1/reviews/update.atom
+  
+
+=== Parameter handling
+
+- All parameters are URL encoded as necessary.
+- If you use a File object as a parameter it will be POSTed to Twitter in a multipart request.
+- If you use a Time object as a parameter, .httpdate will be called on it and that value will be used
+
+=== Return values
+
+The returned values are always OpenStruct objects (wrapped in Partigirb::PartigiStruct) containing the response values as attributes. 
+
+If the response contains several entries the client returns an Array of OpenStruct objects.
+
+When using Atom format Partigi returns some XML elements using namespaces. In those cases the elements are mapped to attributes by convention, for example: namespaceName:attribute becomes <tt>namespaceName</tt>_<tt>attribute</tt>
+
+=== Error handling
+
+In case Partigi returns an error response, this is turned into a PartigiError object having the error string returned in the XML response as message attribute.
+
+== Requirements
+
+- json
+- mime-types
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.2.4

data/examples/last_reviews_summary.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/../lib/partigirb'
+
+if ARGV.empty?
+  puts "\nUsage: ruby #{__FILE__} user_id_or_login\n\n"
+  exit
+end
+
+user_id = ARGV.first
+
+def show_reviews(client, reviews, title)
+  puts
+  puts title 
+  puts "-" * title.size
+  puts
+  
+  reviews.each do |review|
+      film = client.items.show? :id => review.ptItem_id, :type => 'film'
+      puts "- #{film.title}"
+      puts "  Comment: #{review.content}"
+      puts
+  end
+  puts
+end
+
+client = Partigirb::Client.new
+
+reviews = client.reviews.index? :user_id => user_id, :per_page => 5, :status => 0, :order => 'desc'
+show_reviews(client, reviews, "Latest 5 films you want to watch")
+
+reviews = client.reviews.index? :user_id => user_id, :per_page => 5, :status => 1, :order => 'desc'
+show_reviews(client, reviews, "Latest 5 films you have seen")
+
+reviews = client.reviews.index? :user_id => user_id, :per_page => 5, :status => 2, :order => 'desc'
+show_reviews(client, reviews, "Latest 5 films you own")

data/examples/who_ignores_me.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../lib/partigirb'
+
+if ARGV.empty?
+  puts "\nUsage: #{__FILE__} user_id_or_login\n\n"
+  exit
+end
+
+user_id = ARGV.first
+
+client = Partigirb::Client.new
+
+traitors = []
+
+page = 1
+friends = []
+
+# Get logins of people user is following
+begin
+  friends = client.friendships.index? :user_id => user_id, :type => 'follows', :page => page
+  
+  friends.each do |friend|
+    relationship = client.friendships.show? :source_id => user_id, :target_id => friend.ptUser_id
+    traitors << friend.ptUser_login if relationship.ptRelationship_source.ptRelationship_followed_by == 'false'
+  end
+  
+  page += 1
+end while !friends.empty?
+
+if traitors.empty?
+  "Everything is fine. Everyone you follow is following you."
+else
+  puts "Those are the ones that don't want to know about you:"
+  puts
+  traitors.each {|t| puts "  - #{t}"}
+end

data/lib/partigirb/handlers/xml_handler.rb

@@ -32,6 +32,8 @@ module Partigirb
             end
           end
           
+          links = node.elements.delete_all('link')
+          
           node.elements.each do |e|
             property = ""
             
@@ -43,6 +45,11 @@ module Partigirb
             property << e.name
             ts.send("#{property}=", load_recursive(e))
           end
+          
+          unless links.empty?
+            ts.send("links=", links.map{|l| build_struct(l)})
+          end
+          
           ts
         end
         

data/lib/partigirb.rb

@@ -5,6 +5,8 @@ end
 
 $:.unshift File.dirname(__FILE__)
 
+require 'rubygems'
+
 require 'open-uri'
 require 'net/http'
 require 'base64'

data/partigirb.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{partigirb}
-  s.version = "0.2.3"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Alvaro Bautista", "Fernando Blat"]
-  s.date = %q{2009-07-27}
+  s.date = %q{2009-07-30}
   s.email = ["alvarobp@gmail.com", "ferblape@gmail.com"]
   s.extra_rdoc_files = [
     "LICENSE",
@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "examples/last_reviews_summary.rb",
+     "examples/who_ignores_me.rb",
      "lib/partigirb.rb",
      "lib/partigirb/client.rb",
      "lib/partigirb/core_ext.rb",
@@ -54,7 +56,9 @@ Gem::Specification.new do |s|
      "test/mocks/transport_mock.rb",
      "test/test_helper.rb",
      "test/transport_test.rb",
-     "test/xml_handler_test.rb"
+     "test/xml_handler_test.rb",
+     "examples/last_reviews_summary.rb",
+     "examples/who_ignores_me.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/xml_handler_test.rb

@@ -69,7 +69,7 @@ class XMLHandlerTest < Test::Unit::TestCase
       xml.user do
         xml.id 123
         xml.name 'Bob'
-        xml.link({:rel => 'alternate', :href => 'http://www.pointing-to-something.com', :type => 'text/html'})
+        xml.field({:attribute1 => 'value1', :attribute2 => 'value2', :attribute3 => 'value3'})
       end
     end
     
@@ -78,9 +78,27 @@ class XMLHandlerTest < Test::Unit::TestCase
     assert_equal 123, res.id
     assert_equal 'Bob', res.name
     
-    assert res.link.is_a?(Partigirb::PartigiStruct)
-    assert_equal 'alternate', res.link.rel
-    assert_equal 'text/html', res.link._type
-    assert_equal 'http://www.pointing-to-something.com', res.link.href
+    assert res.field.is_a?(Partigirb::PartigiStruct)
+    assert_equal 'value1', res.field.attribute1
+    assert_equal 'value2', res.field.attribute2
+    assert_equal 'value3', res.field.attribute3
+  end
+  
+  should "extract links to an array" do
+    xmls = build_xml_string do |xml|
+      xml.instruct!
+      xml.user do
+        xml.id 123
+        xml.link({:rel => 'alternate', :href => 'http://www.pointing-to-something.com', :type => 'text/html'})
+        xml.link({:rel => 'self', :href => 'http://www.pointing-to-self-something.com', :type => 'application/xml'})
+      end
+    end
+    
+    res = @handler.decode_response(xmls)
+    assert res.is_a?(Partigirb::PartigiStruct)
+    assert_not_nil res.links
+    assert res.links.is_a?(Array)
+    assert_equal 'alternate', res.links.first.rel
+    assert_equal 'self', res.links[1].rel
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: partigi-partigirb
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors: 
 - Alvaro Bautista
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-27 00:00:00 -07:00
+date: 2009-07-30 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,8 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- examples/last_reviews_summary.rb
+- examples/who_ignores_me.rb
 - lib/partigirb.rb
 - lib/partigirb/client.rb
 - lib/partigirb/core_ext.rb
@@ -88,3 +90,5 @@ test_files:
 - test/test_helper.rb
 - test/transport_test.rb
 - test/xml_handler_test.rb
+- examples/last_reviews_summary.rb
+- examples/who_ignores_me.rb