swish 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+swish*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeremy Weiskotten
+
+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/README.rdoc

@@ -0,0 +1,65 @@
+= Swish! A Ruby wrapper for the Dribbble API
+
+Learn about the Dribbble API at http://dribbble.com/api.
+
+== Installation
+
+Swish is just a Ruby gem:
+
+  gem install swish
+
+== Examples
+
+  require 'swish'
+  
+  # Find a shot
+  shot = Dribbble::Shot.find(21603)
+  
+  # See some data about the shot
+  shot.title
+  shot.image_url
+  shot.url
+  shot.player.name
+  
+  # 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')
+  
+  # See some data about the player
+  player.name
+  player.avatar_url
+  player.url
+  player.location
+
+  # List a player's shots
+  player.shots
+  player.shots(:page => 2, :per_page => 10)
+  
+  # List shots by player's that this player follows
+  player.shots_following
+  player.shots_following(:page => 5, :per_page => 30)
+
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeremy Weiskotten. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "swish"
+    gem.summary = %Q{A Ruby wrapper for the Dribbble API}
+    gem.description = %Q{A Ruby wrapper for the Dribbble API}
+    gem.email = "jeremy@weiskotten.com"
+    gem.homepage = "http://github.com/jeremyw/swish"
+    gem.authors = ["Jeremy Weiskotten"]
+    gem.add_development_dependency "crack", ">= 0.1.8"
+    gem.add_development_dependency "httparty", ">= 0.6.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: 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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "swish #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/dribbble/base.rb

@@ -0,0 +1,42 @@
+module Dribbble
+  class Base
+    include HTTParty
+    extend HTTParty
+
+    base_uri 'api.dribbble.com'
+
+    def initialize(attributes={})
+      attributes ||= {}
+      attributes.each do |key, value|
+        instance_variable_set "@#{key}", value
+      end
+
+      after_initialize(attributes)
+    end
+
+    def ==(other)
+      other.equal?(self) || (other.instance_of?(self.class) && other.id == id)
+    end
+
+    # Delegates to ==
+    def eql?(other)
+      self == other
+    end
+
+    protected
+
+    def after_initialize(attributes)
+      # no-op, can be overridden
+    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
+  end
+end

data/lib/dribbble/player.rb

@@ -0,0 +1,20 @@
+module Dribbble
+  class Player < Base
+    attr_accessor :id, :name, :url, :avatar_url, :location
+
+    def self.find(id)
+      new(get("/players/#{id}"))
+    end
+
+    # Fetches this player's shots.
+    # Options: :page, :per_page
+    def shots(options={})
+      Shot.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))
+    end
+  end
+end

data/lib/dribbble/shot.rb

@@ -0,0 +1,28 @@
+module Dribbble
+  class Shot < Base
+    attr_accessor :id, :title, :url, :image_url, :image_teaser_url, :width, :height, :player
+
+    def after_initialize(attributes)
+      @player = Dribbble::Player.new(attributes['player'])
+    end
+
+    def self.find(id)
+      new(get("/shots/#{id}"))
+    end
+
+    # Options: :page, :per_page
+    def self.debuts(options={})
+      paginated_list(get("/shots/debuts", :query => options))
+    end
+
+    # Options: :page, :per_page
+    def self.everyone(options={})
+      paginated_list(get("/shots/everyone", :query => options))
+    end
+
+    # Options: :page, :per_page
+    def self.popular(options={})
+      paginated_list(get("/shots/popular", :query => options))
+    end
+  end
+end

data/lib/swish.rb

@@ -0,0 +1,4 @@
+require 'httparty'
+require 'dribbble/base'
+require 'dribbble/shot'
+require 'dribbble/player'

data/swish.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{swish}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Weiskotten"]
+  s.date = %q{2010-07-29}
+  s.description = %q{A Ruby wrapper for the Dribbble API}
+  s.email = %q{jeremy@weiskotten.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/dribbble/base.rb",
+     "lib/dribbble/player.rb",
+     "lib/dribbble/shot.rb",
+     "lib/swish.rb",
+     "swish.gemspec",
+     "test/helper.rb",
+     "test/player_test.rb",
+     "test/shot_test.rb"
+  ]
+  s.homepage = %q{http://github.com/jeremyw/swish}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby wrapper for the Dribbble API}
+  s.test_files = [
+    "test/helper.rb",
+     "test/player_test.rb",
+     "test/shot_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<crack>, [">= 0.1.8"])
+      s.add_development_dependency(%q<httparty>, [">= 0.6.1"])
+    else
+      s.add_dependency(%q<crack>, [">= 0.1.8"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    end
+  else
+    s.add_dependency(%q<crack>, [">= 0.1.8"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'swish'
+# require 'ruby-debug'
+
+class Test::Unit::TestCase
+end

data/test/player_test.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class PlayerTest < Test::Unit::TestCase
+  def test_find
+    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 'Salem, MA', player.location
+  end
+
+  def test_shots
+    player = Dribbble::Player.find(1)
+    shots = player.shots
+    assert_equal 15, shots.size, "default page size"
+    shots.each do |shot|
+      assert_kind_of Dribbble::Shot, shot
+      assert_kind_of Dribbble::Player, shot.player
+      assert_equal player, shot.player
+    end
+
+    shots = player.shots(:per_page => 2)
+    assert_equal 2, shots.size
+    shots.each do |shot|
+      assert_equal player, shot.player
+    end
+  end
+
+  def test_shots_following
+    player = Dribbble::Player.find(1)
+    shots = player.shots_following
+    assert_equal 15, shots.size, "default page size"
+    shots.each do |shot|
+      assert_kind_of Dribbble::Shot, shot
+      assert_kind_of Dribbble::Player, shot.player
+      assert_not_equal player, shot.player
+    end
+
+    shots = player.shots_following(:per_page => 2)
+    assert_equal 2, shots.size
+    shots.each do |shot|
+      assert_not_equal player, shot.player
+    end
+  end
+end

data/test/shot_test.rb

@@ -0,0 +1,60 @@
+require 'helper'
+
+class ShotTest < Test::Unit::TestCase
+  def test_initialize
+    shot = Dribbble::Shot.new(
+        'id'                => 999,
+        'title'             => 'Title',
+        'url'               => 'http://url',
+        'image_url'         => 'http://image_url',
+        'image_teaser_url'  => 'http://image_teaser_url',
+        'width'             => 3,
+        'height'            => 2)
+
+    assert_equal 999, shot.id
+    assert_equal 'Title', shot.title
+    assert_equal 'http://url', shot.url
+    assert_equal 'http://image_url', shot.image_url
+    assert_equal 'http://image_teaser_url', shot.image_teaser_url
+    assert_equal 3, shot.width
+    assert_equal 2, shot.height
+  end
+
+  def test_find
+    shot = Dribbble::Shot.find(21603)
+    assert_kind_of Dribbble::Shot, shot
+    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_equal 400, shot.width
+    assert_equal 300, shot.height
+
+    assert_kind_of Dribbble::Player, shot.player
+  end
+
+  def test_debuts
+    shots = Dribbble::Shot.debuts
+    assert_kind_of Array, shots
+    assert_kind_of Dribbble::Shot, shots.first
+
+    shots_page2 = Dribbble::Shot.debuts(:page => 2)
+    assert_not_equal shots_page2[0], shots[0]
+
+    s = Dribbble::Shot.debuts(:per_page => 3)
+    assert_equal 3, s.size
+  end
+
+  def test_everyone
+    shots = Dribbble::Shot.everyone(:per_page => 2)
+    assert_equal 2, shots.size
+    assert_kind_of Dribbble::Shot, shots.first
+  end
+
+  def test_popular
+    shots = Dribbble::Shot.popular(:per_page => 2)
+    assert_equal 2, shots.size
+    assert_kind_of Dribbble::Shot, shots.first
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: swish
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Weiskotten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 1
+        - 8
+        version: 0.1.8
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :development
+  version_requirements: *id002
+description: A Ruby wrapper for the Dribbble API
+email: jeremy@weiskotten.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/dribbble/base.rb
+- lib/dribbble/player.rb
+- lib/dribbble/shot.rb
+- lib/swish.rb
+- swish.gemspec
+- test/helper.rb
+- test/player_test.rb
+- test/shot_test.rb
+has_rdoc: true
+homepage: http://github.com/jeremyw/swish
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Dribbble API
+test_files: 
+- test/helper.rb
+- test/player_test.rb
+- test/shot_test.rb