grizzly-weibo 0.1.1 → 0.2.0

data/README.markdown

@@ -37,6 +37,12 @@ friends.first.screen_name   #=> "Fred Chang"
 friends.first.gender        #=> "m"
 ```
 
+You can convert a user object to a hash if you need to however use . syntax where you can. Makes the code look cleaner
+
+```ruby
+friends.first.to_h["screen_name"] #=> "Fred Chang"
+```
+
 ### Friends (Bilateral) 
 Returns a list of your bilateral friends on Weibo. This list has users who are a fan of you and your are a fan of.
 
@@ -45,3 +51,28 @@ friends = client.bilateral_friends(user_id)
 ```
 
 This method returns the same friend object that ```client.friends``` returns.
+
+### Cursors
+Weibo API supports paging. Both the ```friends``` and ```bilateral_friends``` are paginated. This means that when we
+call these methods we have a cursor object returned. This cursor object can be iterated over. Iterating in this way will
+only iterate over the first 50 results
+
+```ruby
+friends = client.friends(user_id)
+friends.each do |friend|
+  ...
+end
+```
+
+For something a little more robust we can iterate over pages as well. This will get all of a users friends iterating
+over them in blocks of fifties. Note that each time you access friends.next_page an new request to the weibo api will be
+generated.
+
+```ruby
+friends = client.friends(user_id)
+while friends.next_page? #Loops untill end of collection
+  friends.next_page do |friend|
+    ... # Loops 50 times
+  end
+end
+```

data/lib/grizzly.rb

@@ -1,6 +1,6 @@
 require 'grizzly/request'
 require 'grizzly/client'
+require 'grizzly/cursor'
 require 'grizzly/user'
 require 'grizzly/errors/no_access_token'
 require 'grizzly/errors/weibo_api'
-

data/lib/grizzly/client.rb

@@ -6,28 +6,11 @@ module Grizzly
     end
     
     def friends(user_id)
-      response = perfrom_request(:get, '/friendships/friends', {:access_token => @access_token, :uid => user_id})
-      users = []
-      response["users"].each do |user|
-        users << Grizzly::User.new(user)
-      end
-      users
+      Grizzly::Cursor.new(Grizzly::User, "/friendships/friends", {:access_token => @access_token, :uid => user_id})
     end
 
     def bilateral_friends(user_id)
-      response = perfrom_request(:get, '/friendships/friends/bilateral', {:access_token => @access_token, :uid => user_id})
-      users = []
-      response["users"].each do |user|
-        users << Grizzly::User.new(user)
-      end
-      users
-    end
-
-    private
-
-    def perfrom_request(method, url, options)
-      request = Grizzly::Request.new(method, url, options)
-      request.response
+      Grizzly::Cursor.new(Grizzly::User, "/friendships/friends/bilateral", {:access_token => @access_token, :uid => user_id})
     end
   end
 end

data/lib/grizzly/cursor.rb

@@ -0,0 +1,47 @@
+module Grizzly
+  class Cursor
+    include Enumerable
+    ITEMS_PER_PAGE = 50
+
+    def initialize(domain_object, url, options, items_per_page = ITEMS_PER_PAGE)
+      @domain_object, @url, @options, @items_per_page = domain_object, url, options, items_per_page
+      @current_page = 1
+      fetch_current_page
+    end
+
+    #Each will return the first page of results
+    def each(&block)
+      @items.each { |i| block.call i }  
+    end
+
+    #Next page will return the result set 
+    def next_page(&block)
+      @items.each { |i| block.call i }
+      @current_page += 1
+      fetch_current_page
+    end
+
+    def next_page?
+      (@current_page * @items_per_page) < @total_items
+    end
+
+    private 
+    
+    def page_request(url, options)
+      request = Grizzly::Request.new(:get, url, options)
+      request.response
+    end
+
+    def fetch_current_page
+      options = @options.merge({ :page => @current_page, :count => @items_per_page })
+      response = page_request(@url, options)
+      @total_items = response["total_number"]
+
+      @items = []
+      response[@domain_object::API_COLLECTION_NAME].each do |domain_object|
+        @items << @domain_object.new(domain_object) 
+      end
+    end
+
+  end
+end

data/lib/grizzly/user.rb

@@ -1,5 +1,7 @@
 module Grizzly
   class User
+    
+    API_COLLECTION_NAME = "users"
 
     def initialize(user_data)
       @data = user_data
@@ -13,5 +15,9 @@ module Grizzly
       end 
     end
 
+    def to_h
+      @data
+    end
+
   end
 end

data/lib/grizzly/version.rb

@@ -1,3 +1,3 @@
 module Grizzly
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grizzly-weibo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-26 00:00:00.000000000Z
+date: 2012-03-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -100,6 +100,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/grizzly/client.rb
+- lib/grizzly/cursor.rb
 - lib/grizzly/errors/no_access_token.rb
 - lib/grizzly/errors/weibo_api.rb
 - lib/grizzly/request.rb
@@ -122,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1587233218334402021
+      hash: 2776003271979443730
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: