dribble 0.1.0 → 0.1.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Robert R Evans - The name 'Dribble' is owned by its respective owners. 
+Copyright (c) 2010 Robert R Evans - The name 'Dribbble' is owned by its respective owners. 
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,26 +1,103 @@
 = Dribble
 
-This is the unofficial dribble api. For more examples look in the examples/ directory. There are examples for the both styles (object notation and hash implementation.)
+This is the unofficial dribbble api. For more examples look in the examples/ directory. There are examples for the both styles (object notation and hash implementation.)
 
 == Dribble::API
 
-There is a very thin wrapper for the Dribble API that is labeled as Dribble::API. This uses the bare minimum to get the desired data from Dribble and returns a hash. This implementation is focused on simplicity and speed. However, I have yet to really work on the speed aspect.
+There is a very thin wrapper for the Dribble API that is called Dribble::API. This uses the bare minimum to get the desired data from Dribbble and returns a hash. This implementation is focused on simplicity and speed. However, I have yet to really work on the speed aspect.
 
-  Dribble::API::Player.profile('simplebits')
-  Dribble::API::Shot.popular
 
+=== Dribble::API::Player
 
-== Dribble::Player && Dribble::Shot
+  Dribble::API::Player.find_shots('simplebits') # => Finds all the shots by simplebits
 
-Dribble::Player and Dribble::Shot is another layer on-top of the API to add that object look and feel. This is more for convenience and ease of use.
+  Dribble::API::Player.profile('simplebits') # => Gets simplebits' profile
 
-This is meant for convenience and ease of use.
+  Dribble::API::Player.following_shots('simplebits') # => Gets the shots that simplebits is following
+
+  Dribble::API::Player.followers('simplebits') # => gets simplebits' followers
+
+  Dribble::API::Player.draftees('simplebits') # => gets simplebits' draftees
+
+Each of the above (except the profile request) accepts a second parameter, a hash of options. This hash can consist of the following:
+
+  {:per_page => 30, :page => 1}
+
+You can control the pagination yourself by doing the following:
+
+  Dribble::API::Player.followers('simplebits', {:per_page => 25, :page => 3})
+
+30 is the max amount you can request per page. It is also the default set within this API implementation. Page 1 is the default page.
+
+=== Dribble::API::Shot
+  
+
+  Dribble::API::Shot.for(1) # => gets the shots for the user with the id of 1
+
+  Dribble::API::Shot.everyones # => Gets everyones shots
+
+  Dribble::API::Shot.debuts # => gets the debut shots
+
+  Dribble::API::Shot.popular # => gets the popular shots
+
+Each of the above (except the profile request) accepts a second parameter, a hash of options. This hash can consist of the following:
+
+  {:per_page => 30, :page => 1}
+
+You can control the pagination yourself by doing the following:
+
+  Dribble::API::Shot.popular({:per_page => 25, :page => 3})
+
+30 is the max amount you can request per page. It is also the default set within this API implementation. Page 1 is the default page.
+
+=== Options Defaults
+
+* Per page : 30
+* Page : 1
+
+== A convenience layer
+
+This is another layer of the API wrapper that sits on top of the Dribble::API to give an easier working interface.
+
+=== Dribble::Player
+
+  @player = Dribble::Player.profile('simplebits')
+  @player.id                     # => 1
+  @player.name                   # => Dan Cederholm
+  @player.url                    # => http://dribbble.com/players/simplebits
+  @player.avatar_url             # => http://dribbble.com/system/users/1/avatars/thumb/dancederholm-peek.jpg?1261060245
+  @player.location               # => Salem, MA
+  @player.created_at             # => 2009/07/07 21:51:22 -0400
+  @player.draftees_count         # => 103
+  @player.following_count        # => 378
+  @player.shots_count            # => 148
+  @player.followers_count        # => 2129
+  @player.following              # => [] This makes a request to dribbble to get the shots that this user is following
+  @player.shots                  # => [] This makes a request to dribbble to get the shots that this user has put up
+  @player.drafted_by_palyer_id   # => nil
   
-  Dribble::Shot.popular
   
-  player = Dribble::Player.profile('simplebits')
-  player.following  # => the shots that this player is following
-  player.shots      # => the players shots
+More documentation coming soon.
+
+=== Dribble::Shot
+
+  @shot = Dribble::Shot.for(1)
+  @shot.id                  # => 1
+  @shot.title               # => Working on the new shop
+  @shot.url                 # => http://dribbble.com/shots/1-Working-on-the-new-shop
+  @shot.image_url           # => http://dribbble.com/system/users/1/screenshots/1/Picture-2.png
+  @shot.image_teaser_url    # => http://dribbble.com/system/users/1/screenshots/1/Picture-2_teaser.png
+  @shot.width               # => 400
+  @shot.height              # => 300
+  @shot.created_at          # => 2009/07/08 06:08:35 -0400
+  @shot.player              # => Dribble::Player Object (e.g. @shot.player.name, @shot.player.url, @shot.player.location)
+  @shot.views_count         # => 838
+  @shot.likes_count         # => 8
+  @shot.comments_count      # => 3
+  @shot.rebounds_count      # => 0
+  
+
+More documentation coming soon.
 
 == Note on Patches/Pull Requests
  
@@ -34,6 +111,6 @@ This is meant for convenience and ease of use.
 
 == Copyright
 
-The name "Dribble" belongs to http://www.dribble.com
+The name "Dribbble" belongs to http://www.dribbble.com
 
 Copyright (c) 2010 Robert R Evans. See LICENSE for details.

data/Rakefile

@@ -5,15 +5,16 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "dribble"
-    gem.summary = %Q{API Wrapper for the awesome Dribble Site}
-    gem.description = %Q{API Wrapper for the awesome Dribble Site}
+    gem.summary = %Q{API Wrapper for the awesome Dribbble Site}
+    gem.description = %Q{API Wrapper for the awesome Dribbble Site}
     gem.email = "robert@codewranglers.org"
     gem.homepage = "http://github.com/revans/dribble"
     gem.authors = ["Robert R Evans"]
-    gem.add_development_dependency "rspec", "= 1.3.0"
-    gem.add_development_dependency "yard",  "= 0.5.8"
     
-    gem.add_dependency 'yajl-ruby', '= 0.7.7'
+    gem.add_development_dependency "rspec",   '= 1.3.0'
+    gem.add_development_dependency "yard",    '= 0.5.8'
+    
+    gem.add_dependency 'em-http-request',     '= 0.2.10'
     
   end
   Jeweler::GemcutterTasks.new
@@ -21,6 +22,7 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
@@ -30,6 +32,7 @@ end
 Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov_opts  = ['--exclude', '^spec,/gems/,/Library/']
   spec.rcov = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/dribble.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dribble}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert R Evans"]
-  s.date = %q{2010-08-09}
-  s.description = %q{API Wrapper for the awesome Dribble Site}
+  s.date = %q{2010-08-13}
+  s.description = %q{API Wrapper for the awesome Dribbble Site}
   s.email = %q{robert@codewranglers.org}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -40,23 +40,37 @@ Gem::Specification.new do |s|
      "lib/dribble/shot.rb",
      "lib/dribble/shots.rb",
      "lib/dribble/version.rb",
-     "spec/dribble/core_ext/hash_spec.rb",
-     "spec/dribble/core_ext/object_spec.rb",
-     "spec/rcov.opts",
+     "spec/core_ext/hash_spec.rb",
+     "spec/core_ext/object_spec.rb",
+     "spec/dribble/api/player_spec.rb",
+     "spec/dribble/api/shot_spec.rb",
+     "spec/dribble/version_spec.rb",
+     "spec/fake_data/player/player_draftees.json",
+     "spec/fake_data/player/player_find_shots.json",
+     "spec/fake_data/player/player_followers.json",
+     "spec/fake_data/player/player_following_shots.json",
+     "spec/fake_data/player/player_profile.json",
+     "spec/fake_data/shot/shot_debuts.json",
+     "spec/fake_data/shot/shot_everyones.json",
+     "spec/fake_data/shot/shot_for.json",
+     "spec/fake_data/shot/shot_popular.json",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "spec/support/fakeweb_yajl.rb"
+     "spec/support/fake_eventmachine_requests.rb"
   ]
   s.homepage = %q{http://github.com/revans/dribble}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{API Wrapper for the awesome Dribble Site}
+  s.summary = %q{API Wrapper for the awesome Dribbble Site}
   s.test_files = [
-    "spec/dribble/core_ext/hash_spec.rb",
-     "spec/dribble/core_ext/object_spec.rb",
+    "spec/core_ext/hash_spec.rb",
+     "spec/core_ext/object_spec.rb",
+     "spec/dribble/api/player_spec.rb",
+     "spec/dribble/api/shot_spec.rb",
+     "spec/dribble/version_spec.rb",
      "spec/spec_helper.rb",
-     "spec/support/fakeweb_yajl.rb",
+     "spec/support/fake_eventmachine_requests.rb",
      "examples/barebones/player.rb",
      "examples/barebones/shot.rb",
      "examples/player.rb",
@@ -70,16 +84,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_development_dependency(%q<yard>, ["= 0.5.8"])
-      s.add_runtime_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+      s.add_runtime_dependency(%q<em-http-request>, ["= 0.2.10"])
     else
       s.add_dependency(%q<rspec>, ["= 1.3.0"])
       s.add_dependency(%q<yard>, ["= 0.5.8"])
-      s.add_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+      s.add_dependency(%q<em-http-request>, ["= 0.2.10"])
     end
   else
     s.add_dependency(%q<rspec>, ["= 1.3.0"])
     s.add_dependency(%q<yard>, ["= 0.5.8"])
-    s.add_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+    s.add_dependency(%q<em-http-request>, ["= 0.2.10"])
   end
 end
 

data/examples/barebones/player.rb

@@ -2,25 +2,25 @@ dir = File.expand_path(File.join(File.dirname(__FILE__), '../..', 'lib'))
 require File.join(dir, 'dribble')
 
 # puts "Find Player's Shots by name"
-# puts Dribble::API::Player.find('simplebits').inspect
+# puts Dribble::API::Player.find_shots('simplebits').inspect
 
-# puts
-# puts "Find Player's Profile"
-# player = Dribble::API::Player.profile('simplebits')
-# puts player
+puts
+puts "Find Player's Profile"
+player = Dribble::API::Player.profile('simplebits')
+puts player.inspect
 
-# puts
-# puts "Find all the shots a player is following"
-# puts Dribble::API::Player.following_shots('simplebits').inspect
+puts
+puts "Find all the shots a player is following"
+puts Dribble::API::Player.following_shots('simplebits')
 
 
 puts
 puts "Find Player's Followers"
 player = Dribble::API::Player.followers('simplebits')
-puts player.inspect
+puts player
 
 
 puts
 puts "Find Player's Draftees"
 player = Dribble::API::Player.draftees('simplebits')
-puts player.inspect
+puts player

data/examples/barebones/shot.rb

@@ -3,19 +3,19 @@ require File.join(dir, 'dribble')
 
 # puts "Find a specific shot by ID"
 # shot =  Dribble::API::Shot.for(1)
-# puts shot.inspect
- 
+# puts shot
+#  
 # puts
 # puts "Everyone's shots"
-# puts Dribble::API::Shot.everyones.inspect
-
-
+# puts Dribble::API::Shot.everyones
+# 
+# 
 # puts
 # puts "Debut shots"
-# puts Dribble::API::Shot.debuts.inspect
-
-
-puts
-puts "Popular shots"
-popular = Dribble::API::Shot.popular
-puts popular.inspect
+# puts Dribble::API::Shot.debuts
+# 
+# 
+# puts
+# puts "Popular shots"
+# popular = Dribble::API::Shot.popular
+# puts popular

data/examples/player.rb

@@ -6,10 +6,10 @@ require File.join(dir, 'dribble')
 # puts player.inspect
 # 
 # 
-# puts
-# puts "Find Player's Profile"
-# player2 = Dribble::Player.profile('simplebits') # OR Dribble::Player.find('simplebits')
-# puts player.inspect
+puts
+puts "Find Player's Profile"
+player2 = Dribble::Player.profile('simplebits') # OR Dribble::Player.find('simplebits')
+puts player2.inspect
 
 
 # puts
@@ -17,17 +17,17 @@ require File.join(dir, 'dribble')
 # player3 = Dribble::Player.following_shots('simplebits')
 # puts player3.inspect
 
-
-puts
-puts "Find a players followers"
-player4 = Dribble::Player.followers('simplebits')
-puts player4.inspect
-
-
-puts
-puts "Find a players draftees"
-player5 = Dribble::Player.draftees('simplebits')
-puts player5.inspect
+# 
+# puts
+# puts "Find a players followers"
+# player4 = Dribble::Player.followers('simplebits')
+# puts player4.inspect
+# 
+# 
+# puts
+# puts "Find a players draftees"
+# player5 = Dribble::Player.draftees('simplebits')
+# puts player5.inspect
 
 
 

data/lib/dribble/request.rb

@@ -3,14 +3,31 @@ module Dribble
     class << self
       DRIBBLE_API = 'api.dribbble.com'
       
+      
+      ##
+      # Get
+      #
+      # @param  [String, Hash]
+      # @return [Array/Hash]
+      # @api    private
+      #
       def get(query, options={})
-        meth    = options.delete(:api_endpoint)
-        uri     = options.empty? ? "#{to_url}#{query}" : "#{to_url}#{query}?#{options.to_query}"
-        url     = ::URI.parse(uri)
-        results = ::Yajl::HttpStream.get(url, :symbolize_keys => true)
-        results[:api_endpoint] = meth if meth
-        results
-      end
+        meth = options.delete(:api_endpoint)
+        ::EventMachine.run do
+          http = ::EventMachine::HttpRequest.new("#{to_url}#{query}").get(:query => options, :timeout => 10)
+          http.callback do
+            @response = {
+              :status => http.response_header.status,
+              :header => http.response_header,
+              :body   => http.response,
+              :data   => ::Yajl::Parser.new(:symbolize_keys => true).parse(http.response)
+            }
+            ::EventMachine.stop
+          end
+        end
+        @response[:data][:api_endpoint] = meth if meth
+        @response[:data]
+      end    
       
       
       private

data/lib/dribble.rb

@@ -3,9 +3,8 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 require 'uri'
 
 require 'rubygems'
-require 'yajl/gzip'
-require 'yajl/deflate'
-require 'yajl/http_stream'
+require 'em-http-request'
+require 'yajl'
 
 base = File.expand_path(File.dirname(__FILE__))
 

data/spec/core_ext/hash_spec.rb

@@ -0,0 +1,94 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Hash do
+  
+  describe "To Query" do
+    before(:all) do
+      @query_hash = {:name => 'hilton', :postal => '92009'}
+    end
+    
+    it "should create a standard query string" do
+      @query_hash.to_query.should == 'name=hilton&postal=92009'
+    end
+    
+    it "should create an encoded query string with a namespace" do
+      @query_hash.to_query('property').should == 'property%5Bname%5D=hilton&property%5Bpostal%5D=92009'
+    end
+  end
+  
+  describe "Symbolizing Keys" do
+    before(:all) do
+      @stringified_keys = {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+      @recursive        = {'name' => 'Hilton', 'address' => {'street' => '1200 Ave.', 'postal' => '92011', 'directions' => {'from' => 'here', 'to' => 'there', 'dive_in' => {'name' => 'something'}}}}
+    end
+    
+    it "should create a new hash, keeping the old" do
+      a = @stringified_keys.symbolize_keys
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+    end
+    
+    it "should overwrite the existing hash making the keys symbols" do
+      a = @stringified_keys.symbolize_keys!
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+    end
+    
+    it "should overwrite and recursively make all keys symbols" do
+      a = @recursive.recursive_symbolize_keys!
+      a.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+      @recursive.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+    end
+  end
+  
+  describe "Symbolizing Keys" do
+    before(:all) do
+      @stringified_keys = {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+      @recursive        = {'name' => 'Hilton', 'address' => {'street' => '1200 Ave.', 'postal' => '92011', 'directions' => {'from' => 'here', 'to' => 'there', 'dive_in' => {'name' => 'something'}}}}
+    end
+    
+    it "should create a new hash, keeping the old" do
+      a = @stringified_keys.symbolize_keys
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+    end
+    
+    it "should overwrite the existing hash making the keys symbols" do
+      a = @stringified_keys.symbolize_keys!
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+    end
+    
+    it "should overwrite and recursively make all keys symbols" do
+      a = @recursive.recursive_symbolize_keys!
+      a.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+      @recursive.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+    end
+  end
+  
+  describe "Symbolizing Keys" do
+    before(:all) do
+      @stringified_keys = {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+      @recursive        = {'name' => 'Hilton', 'address' => {'street' => '1200 Ave.', 'postal' => '92011', 'directions' => {'from' => 'here', 'to' => 'there', 'dive_in' => {'name' => 'something'}}}}
+    end
+    
+    it "should create a new hash, keeping the old" do
+      a = @stringified_keys.symbolize_keys
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {'name' => 'Hilton', 'address' => '1200 Ave.', 'postal' => '92011'}
+    end
+    
+    it "should overwrite the existing hash making the keys symbols" do
+      a = @stringified_keys.symbolize_keys!
+      a.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+      @stringified_keys.should == {:name => 'Hilton', :address => '1200 Ave.', :postal => '92011'}
+    end
+    
+    it "should overwrite and recursively make all keys symbols" do
+      a = @recursive.recursive_symbolize_keys!
+      a.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+      @recursive.should == {:name => 'Hilton', :address => {:street => '1200 Ave.', :postal => '92011', :directions => {:from => 'here', :to => 'there', :dive_in => {:name => 'something'}}}}
+    end
+  end
+  
+end

data/spec/core_ext/object_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Object do
+  before(:all) do
+    @string = ''
+    @fixnum = 1
+    @float  = 1.1
+    @hash   = {}
+    @array  = []
+  end
+  
+  it "should return true when testing if an empty string is blank" do
+    @string.blank?.should be_true
+  end
+  
+  it "should return false when testing a fixnum for blank" do
+    @fixnum.blank?.should be_false
+  end
+  
+  it "should return false when testing a float for blank" do
+    @float.blank?.should be_false
+  end
+  
+  it "should return true when testing if a hash is blank" do
+    @hash.blank?.should be_true
+  end
+  
+  it "should return true when testing if an array is blank" do
+    @array.blank?.should be_true
+  end
+  
+  it "should return true when testing if nil is blank" do
+    nil.blank?.should be_true
+  end
+  
+  it "should return false when testing if true is blank" do
+    true.blank?.should be_false
+  end
+  
+  it "should return false when testing if false is blank" do
+    false.blank?.should be_false
+  end
+  
+end