swish 0.6.0 → 0.7.0

data/.gitignore

@@ -17,6 +17,7 @@ tmtags
 coverage
 rdoc
 pkg
+.rvmrc
 
 ## PROJECT::SPECIFIC
 swish*.gem

data/README.rdoc

@@ -11,6 +11,7 @@ Swish is just a Ruby gem:
 Not playing in the Ruby league? Here are the others we know of so far:
 
 * AS3: http://github.com/markstar/StarDribbbleLib
+* C#/.NET: http://github.com/superlogical/dribbble-dotnet (I would have called it "Nothing but .NET")
 * ExpressionEngine 1.6.8+: http://ninefour.co.uk/labs/dribbble
 * ExpressionEngine 2: http://olivierbon.com/projects/dreebbble
 * PHP: http://github.com/martinbean/dribbble-php
@@ -33,18 +34,11 @@ Not playing in the Ruby league? Here are the others we know of so far:
   shot.comments_count
   shot.rebounds_count
   
-  
   # Find more shots
   inspiring       = Dribbble::Shot.popular
   call_the_police = Dribbble::Shot.everyone
   yay_noobs       = Dribbble::Shot.debuts
   
-  # Paginate through shots (default is 15 per page, max 30)
-  Dribbble::Shot.popular(:page => 2, :per_page => 3)
-  Dribbble::Shot.everyone(:page => 10, :per_page => 5)
-  Dribbble::Shot.debuts(:page => 5, :per_page => 30)
-  
-  
   # Find a player
   player = Dribbble::Player.find('jeremy')
   
@@ -64,11 +58,9 @@ Not playing in the Ruby league? Here are the others we know of so far:
 
   # List a player's shots
   player.shots
-  player.shots(:page => 2, :per_page => 10)
   
-  # List shots by player's that this player follows
+  # List shots by players that this player follows
   player.shots_following
-  player.shots_following(:page => 5, :per_page => 30)
 
   # List a player's draftees
   player.draftees
@@ -79,6 +71,41 @@ Not playing in the Ruby league? Here are the others we know of so far:
   # List the players who a player is following
   player.following
 
+== Pagination
+
+The Dribbble API returns paginated lists, with a default page size of 15 items. Swish makes it easy to traverse the pages of any list.
+
+  # Get the second page of popular shots, with 30 shots per page
+  shots = Dribbble::Shot.popular(:page => 2, :per_page => 30)
+  
+  # Some useful stats for rendering pagination links
+  shots.page     # => current page number
+  shots.per_page # => number of items per page
+  shots.total    # => total number of items on all pages
+  shots.pages    # => total number of pages
+  
+  # Try it with other lists
+  Dribbble::Player.find('jeremy').shots(:per_page => 5)
+  Dribbble::Player.find('jeremy').shots_following(:page => 10)
+
+See http://dribbble.com/api#pagination for more information.
+
+== Who's using Swish?
+
+* http://liiikes.com/, "Using statistics to find the best content on Dribbble."
+* http://hooppps.com/, "A free open-source mobile dribbble browser"
+
+Email jeremy@weiskotten.com to have your project added to this list.
+
+== Thanks
+
+Thanks to Dan and Rich for creating Dribbble (and its API!), and to everyone that has contributed to Swish, including:
+
+* Jeffrey Chupp
+* Jon Distad
+* Michael Parenteau
+
+Email jeremy@weiskotten.com if you should be on this list. Apologies and thanks in advance.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/dribbble/base.rb

@@ -1,20 +1,24 @@
 module Dribbble
   class Base
     include HTTParty
-    extend HTTParty
 
     base_uri 'api.dribbble.com'
 
-    attr_accessor :created_at
-
-    def initialize(attributes={})
+    def initialize(attributes=nil)
       attributes ||= {}
-      attributes.each do |key, value|
-        setter = "#{key}="
-        self.send setter, value if self.respond_to?(setter)
+      @created_at = attributes.delete('created_at')
+      attributes.each do |(attr, val)|
+        instance_variable_set("@#{attr}", val)
+        instance_eval "def #{attr}() @#{attr} end"
       end
+    end
 
-      after_initialize(attributes)
+    def get(*args, &block)
+      self.class.get *args, &block
+    end
+
+    def created_at
+      parse_time(@created_at)
     end
 
     def ==(other)
@@ -26,28 +30,18 @@ module Dribbble
       self == other
     end
 
-    def created_at=(timestamp)
-      @created_at = parse_time(timestamp)
+    def self.paginated_list(results)
+      Dribbble::PaginatedList.new(results)
     end
 
-    protected
-
-    def after_initialize(attributes)
-      # no-op, can be overridden
+    def paginated_list(results)
+      self.class.paginated_list(results)
     end
 
-    def self.paginated_list(result, list_key='shots')
-      # result['total']
-      # result['page']
-      # result['pages']
-      # result['per_page']
-      result[list_key].map do |attributes|
-        new(attributes)
-      end
-    end
+    protected
 
     def parse_time(time_string)
-      Time.parse(time_string)
+      Time.parse(time_string) if time_string
     end
   end
 end

data/lib/dribbble/comment.rb

@@ -0,0 +1,9 @@
+module Dribbble
+  class Comment < Base
+    attr_reader :player
+    def initialize(attributes={})
+      @player = Dribbble::Player.new(attributes.delete('player')) if attributes['player']
+      super
+    end
+  end
+end

data/lib/dribbble/paginated_list.rb

@@ -0,0 +1,27 @@
+module Dribbble
+  class PaginatedList < ::Array
+    attr_reader :total, :pages, :per_page, :page
+    def initialize(results)
+      @total = results['total']
+      @pages = results['pages']
+      @per_page = results['per_page']
+      @page = results['page']
+
+      result_key, result_class = 
+        if results.has_key?('shots')
+          ['shots', Dribbble::Shot]
+        elsif results.has_key?('players')
+          ['players', Dribbble::Player]
+        else
+          ['comments', Dribbble::Comment]
+        end
+
+      super((results[result_key] || []).map { |attrs| result_class.new attrs })
+    end
+
+    def inspect
+      ivar_str = instance_variables.map {|iv| "#{iv}=#{instance_variable_get(iv).inspect}"}.join(", ")
+      "#<#{self.class.inspect} #{ivar_str}, @contents=#{super}>"
+    end
+  end
+end

data/lib/dribbble/player.rb

@@ -1,9 +1,5 @@
 module Dribbble
   class Player < Base
-    attr_accessor :id, :name, :url, :avatar_url, :location, :twitter_screen_name, :drafted_by_player_id, :website_url,
-        :shots_count, :draftees_count, :followers_count, :following_count,
-        :comments_count, :comments_received_count, :likes_count, :likes_received_count, :rebounds_count, :rebounds_received_count
-
     def self.find(id)
       new(get("/players/#{id}"))
     end
@@ -11,24 +7,24 @@ module Dribbble
     # Fetches this player's shots.
     # Options: :page, :per_page
     def shots(options={})
-      Shot.paginated_list(self.class.get("/players/#{@id}/shots", :query => options))
+      paginated_list(self.class.get("/players/#{@id}/shots", :query => options))
     end
 
     # Fetches shots by players that this player follows.
     def shots_following(options={})
-      Shot.paginated_list(self.class.get("/players/#{@id}/shots/following", :query => options))
+      paginated_list(self.class.get("/players/#{@id}/shots/following", :query => options))
     end
 
     def draftees(options={})
-      Player.paginated_list(self.class.get("/players/#{@id}/draftees", :query => options), 'players')
+      paginated_list(self.class.get("/players/#{@id}/draftees", :query => options))
     end
 
     def followers(options={})
-      Player.paginated_list(self.class.get("/players/#{@id}/followers", :query => options), 'players')
+      paginated_list(self.class.get("/players/#{@id}/followers", :query => options))
     end
 
     def following(options={})
-      Player.paginated_list(self.class.get("/players/#{@id}/following", :query => options), 'players')
+      paginated_list(self.class.get("/players/#{@id}/following", :query => options))
     end
   end
 end

data/lib/dribbble/shot.rb

@@ -1,16 +1,19 @@
 module Dribbble
   class Shot < Base
-    attr_accessor :id, :title, :url, :image_url, :image_teaser_url, :width, :height, :player,
-        :views_count, :likes_count, :comments_count, :rebounds_count
-
-    def after_initialize(attributes)
-      @player = Dribbble::Player.new(attributes['player'])
+    attr_reader :player
+    def initialize(attributes={})
+      @player = Dribbble::Player.new(attributes.delete('player')) if attributes['player']
+      super
     end
 
     def self.find(id)
       new(get("/shots/#{id}"))
     end
 
+    def comments(options={})
+      paginated_list(get("/shots/#{@id}/comments", :query => options))
+    end
+
     # Options: :page, :per_page
     def self.debuts(options={})
       paginated_list(get("/shots/debuts", :query => options))
@@ -26,4 +29,4 @@ module Dribbble
       paginated_list(get("/shots/popular", :query => options))
     end
   end
-end
+end

data/lib/swish.rb

@@ -1,4 +1,6 @@
 require 'httparty'
+require 'dribbble/paginated_list'
 require 'dribbble/base'
+require 'dribbble/comment'
 require 'dribbble/shot'
-require 'dribbble/player'
+require 'dribbble/player'

data/swish.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{swish}
-  s.version = "0.6.0"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Weiskotten"]
-  s.date = %q{2010-09-18}
+  s.date = %q{2011-02-20}
   s.description = %q{A Ruby wrapper for the Dribbble API}
   s.email = %q{jeremy@weiskotten.com}
   s.extra_rdoc_files = [
@@ -24,11 +24,16 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/dribbble/base.rb",
+     "lib/dribbble/comment.rb",
+     "lib/dribbble/paginated_list.rb",
      "lib/dribbble/player.rb",
      "lib/dribbble/shot.rb",
      "lib/swish.rb",
      "swish.gemspec",
+     "test/base_test.rb",
+     "test/comment_test.rb",
      "test/helper.rb",
+     "test/paginated_list_test.rb",
      "test/player_test.rb",
      "test/shot_test.rb"
   ]
@@ -38,7 +43,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby wrapper for the Dribbble API}
   s.test_files = [
-    "test/helper.rb",
+    "test/base_test.rb",
+     "test/comment_test.rb",
+     "test/helper.rb",
+     "test/paginated_list_test.rb",
      "test/player_test.rb",
      "test/shot_test.rb"
   ]

data/test/base_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class BaseTest < Test::Unit::TestCase
+  def test_attributes_are_methods
+    base = Dribbble::Base.new('foo' => 'bar', 'baz' => 'qux')
+    assert base.respond_to?(:foo)
+    assert base.respond_to?(:baz)
+    assert_equal 'bar', base.foo
+    assert_equal 'qux', base.baz
+  end
+end

data/test/comment_test.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+class CommentTest < Test::Unit::TestCase
+
+  def test_comment_has_a_player_object
+    comment = Dribbble::Comment.new('player' => {})
+    assert comment.player.is_a?(Dribbble::Player), "#{comment.player.inspect} is not a Dribbble::Player."
+  end
+
+end

data/test/paginated_list_test.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class PaginatedListTest < Test::Unit::TestCase
+  def setup
+    @shots_results = { 
+      "total"=>750,
+      "shots"=>[{}, {}],
+      "page"=>1, 
+      "pages"=>375,
+      "per_page"=>2
+    }
+  end
+
+  def test_initialize_gathers_pagination_data
+    list = Dribbble::PaginatedList.new(@shots_results)
+
+    assert_equal 375, list.pages
+    assert_equal 750, list.total
+    assert_equal 1, list.page
+    assert_equal 2, list.per_page
+  end
+
+  def test_list_behaves_as_array
+    list = Dribbble::PaginatedList.new(@shots_results)
+    assert list.is_a? Array
+    assert list.respond_to?(:each)
+    assert list.respond_to?(:first)
+  end
+
+  def test_initialize_collects_shots_by_default
+    list = Dribbble::PaginatedList.new(@shots_results)
+    assert_equal 2, list.size
+    list.each { |shot| assert shot.is_a?(Dribbble::Shot), "#{shot.inspect} is not a Dribbble::Shot." }
+  end
+
+  def test_initialize_collecting_players
+    player_followers_results = {
+      "players"=> [{}, {}], 
+      "total"=>201,
+      "page"=>1,
+      "pages"=>101,
+      "per_page"=>2
+    } 
+
+    list = Dribbble::PaginatedList.new(player_followers_results)
+    assert_equal 2, list.size
+    list.each { |p| assert p.is_a?(Dribbble::Player), "#{p.inspect} is not a Dribbble::Player" }
+  end
+
+  def test_initialize_collecting_comments
+    comments_results = {
+      "comments"=> [{}, {}], 
+      "total"=>201,
+      "page"=>1,
+      "pages"=>101,
+      "per_page"=>2
+    } 
+
+    list = Dribbble::PaginatedList.new(comments_results)
+    assert_equal 2, list.size
+    list.each { |p| assert p.is_a?(Dribbble::Comment), "#{p.inspect} is not a Dribbble::Comment" }
+  end
+end

data/test/player_test.rb

@@ -5,7 +5,7 @@ class PlayerTest < Test::Unit::TestCase
     player = Dribbble::Player.find(1)
     assert_equal 1, player.id
     assert_equal 'Dan Cederholm', player.name
-    assert_equal 'http://dribbble.com/players/simplebits', player.url
+    assert_equal 'http://dribbble.com/simplebits', player.url
     assert_equal 'http://simplebits.com', player.website_url
     assert_equal 'Salem, MA', player.location
     assert_not_nil player.created_at

data/test/shot_test.rb

@@ -28,8 +28,8 @@ class ShotTest < Test::Unit::TestCase
     assert_equal 21603, shot.id
     assert_equal 'Moon', shot.title
     assert_equal 'http://dribbble.com/shots/21603-Moon', shot.url
-    assert_equal 'http://dribbble.com/system/users/1/screenshots/21603/shot_1274474082.png', shot.image_url
-    assert_equal 'http://dribbble.com/system/users/1/screenshots/21603/shot_1274474082_teaser.png', shot.image_teaser_url
+    assert_match /http:\/\/dribbble.com\/system\/users\/1\/screenshots\/21603\/shot_1274474082.png\?\d+/, shot.image_url
+    assert_match /http:\/\/dribbble.com\/system\/users\/1\/screenshots\/21603\/shot_1274474082_teaser.png\?\d+/, shot.image_teaser_url
     assert_equal 400, shot.width
     assert_equal 300, shot.height
 
@@ -41,6 +41,13 @@ class ShotTest < Test::Unit::TestCase
     assert_kind_of Dribbble::Player, shot.player
   end
 
+  def test_comments
+    shot = Dribbble::Shot.find(21603)
+    comments = shot.comments
+    assert comments.is_a?(Dribbble::PaginatedList), "#{comments.inspect} is not a Dribbble::PaginatedList."
+    comments.each { |c| assert c.is_a?(Dribbble::Comment), "#{c.inspect} is not a Dribbble::Comment." }
+  end
+
   def test_debuts
     shots = Dribbble::Shot.debuts
     assert_kind_of Array, shots

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: swish
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
+  - 7
   - 0
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Jeremy Weiskotten
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-18 00:00:00 -04:00
+date: 2011-02-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -67,11 +67,16 @@ files:
 - Rakefile
 - VERSION
 - lib/dribbble/base.rb
+- lib/dribbble/comment.rb
+- lib/dribbble/paginated_list.rb
 - lib/dribbble/player.rb
 - lib/dribbble/shot.rb
 - lib/swish.rb
 - swish.gemspec
+- test/base_test.rb
+- test/comment_test.rb
 - test/helper.rb
+- test/paginated_list_test.rb
 - test/player_test.rb
 - test/shot_test.rb
 has_rdoc: true
@@ -109,6 +114,9 @@ signing_key:
 specification_version: 3
 summary: A Ruby wrapper for the Dribbble API
 test_files: 
+- test/base_test.rb
+- test/comment_test.rb
 - test/helper.rb
+- test/paginated_list_test.rb
 - test/player_test.rb
 - test/shot_test.rb