dribble 0.0.1 → 0.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Robert R Evans
+Copyright (c) 2010 Robert R Evans - The name 'Dribble' 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,6 +1,24 @@
-= dribble
+= Dribble
 
-A Dribble API wrapper.
+This is the unofficial 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 symbolized hash. This implementation is focused on simplicity and speed. However, I have yet to really work on the speed aspect.
+
+== Dribble::API
+
+  Dribble::API::Player.profile('simplebits')
+  Dribble::API::Shot.popular
+
+
+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.
+
+This is meant for convenience and ease of use. 
+
+
+== Dribble::Player && Dribble::Shot
+
+  Dribble::Player.find('simplebits')
+  Dribble::Shot.popular
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/dribble.gemspec

@@ -0,0 +1,78 @@
+# 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{dribble}
+  s.version = "0.0.2"
+
+  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-02}
+  s.description = %q{API Wrapper for the awesome Dribble Site}
+  s.email = %q{robert@codewranglers.org}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dribble.gemspec",
+     "examples/barebones/player.rb",
+     "examples/barebones/shot.rb",
+     "examples/player.rb",
+     "examples/shot.rb",
+     "lib/core_ext/hash.rb",
+     "lib/core_ext/object.rb",
+     "lib/dribble.rb",
+     "lib/dribble/api/player.rb",
+     "lib/dribble/api/shot.rb",
+     "lib/dribble/exceptions.rb",
+     "lib/dribble/player.rb",
+     "lib/dribble/request.rb",
+     "lib/dribble/shot.rb",
+     "lib/dribble/shots.rb",
+     "lib/dribble/version.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.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.test_files = [
+    "spec/spec_helper.rb",
+     "examples/barebones/player.rb",
+     "examples/barebones/shot.rb",
+     "examples/player.rb",
+     "examples/shot.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<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<yajl-ruby>, ["= 0.7.7"])
+  end
+end
+

data/examples/barebones/player.rb

@@ -0,0 +1,14 @@
+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
+puts "Find Player's Profile"
+player = Dribble::API::Player.profile('simplebits')
+puts player
+
+# puts
+# puts "Find all the shots a player is following"
+# puts Dribble::API::Player.following_shots('simplebits').inspect

data/examples/barebones/shot.rb

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

data/examples/player.rb

@@ -1,13 +1,18 @@
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'dribble')
 
-puts "Find Player's Shots by name"
-puts Dribble::Player.find('simplebits').inspect
+# puts "Find Player's Shots by name"
+# player = Dribble::Player.find_shots('simplebits')
+# 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"
-puts Dribble::Player.profile('simplebits').inspect
 
 puts
-puts "Find Player's Followers"
-puts Dribble::Player.followers('simplebits').inspect
+puts "Find the shots that a specific Player is following"
+player3 = Dribble::Player.following_shots('simplebits')
+puts player3.inspect

data/examples/shot.rb

@@ -1,19 +1,47 @@
 dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 require File.join(dir, 'dribble')
 
-puts "Find a specific shot by ID"
-puts Dribble::Shot.for(1).inspect
+# puts "Find a specific shot by ID"
+# shot =  Dribble::Shot.for(1)
+# puts shot.inspect
+#  
+# puts
+# puts "Everyone's shots"
+# puts Dribble::Shot.everyones.inspect
+# 
+# 
+# puts
+# puts "Debut shots"
+# puts Dribble::Shot.debuts.inspect
 
-puts
-puts "Everyone's shots"
-puts Dribble::Shot.everyones.inspect
 
+# puts
+# puts "Popular shots"
+# popular = Dribble::Shot.popular
+# puts popular.inspect
+# puts
+# popular_page_2 = popular.next_page
+# puts popular_page_2.inspect
 
-puts
-puts "Debut shots"
-puts Dribble::Shot.everyones.inspect
+
+# puts
+# puts "Dan's Following these shots"
+# following = Dribble::Shot.following(1)
+# puts following.inspect
+# puts
+# following_page_2 = following.next_page
+# puts following_page_2.inspect
 
 
 puts
-puts "Popular shots"
-puts Dribble::Shot.everyones.inspect
+puts "Get a Player's Profile"
+player = Dribble::Player.find(1)
+puts player.inspect
+puts
+puts "Take this player and see what shots they are following"
+following_shots = player.following
+puts following_shots.inspect
+puts
+puts "Take this player and see what shots they've put up"
+my_shots = player.shots
+puts my_shots.inspect

data/lib/dribble/api/player.rb

@@ -0,0 +1,51 @@
+module Dribble
+  module API
+    class Player
+    
+
+      ##
+      # Find shots for a given player
+      #
+      # @param  [String/Integer]
+      # @return [Hash]
+      # @api    public
+      #
+      def self.find_shots(id, options={})
+        Dribble::Request.get("/players/#{id}/shots", setup_options(options))
+      end
+    
+    
+      ##
+      # Following Shots
+      #
+      # @param  [String/Integer]
+      # @return [Hash]
+      # @api    public
+      #
+      def self.following_shots(id, options={})
+        Dribble::Request.get("/players/#{id}/shots/following", setup_options(options))
+      end
+    
+    
+      ##
+      # Profile
+      #
+      # @param  [String/Integer]
+      # @return [Hash]
+      # @api    public
+      #
+      def self.profile(id)
+        Dribble::Request.get("/players/#{id}")
+      end
+
+    
+      private
+      
+        def self.setup_options(options)
+          {:per_page => 30, :page => 1}.merge(options)
+        end
+      
+
+    end
+  end
+end

data/lib/dribble/api/shot.rb

@@ -0,0 +1,84 @@
+module Dribble
+  module API
+    class Shot
+
+
+      ##
+      # By ID
+      #
+      # @param    [Integer]
+      # @return   [Hash]
+      # @api      public
+      #
+      def self.for(id)
+        Dribble::Request.get("/shots/#{id.to_i}")
+      end
+      
+      
+      ##
+      # Following
+      #
+      # @param    [String/Integer, Hash]
+      #           e.g. {:per_page => 30, :page => 1}
+      #
+      # @return   [Hash]
+      # @api      public
+      #
+      def self.following(id, options={})
+        Dribble::Request.get("/players/#{id}/shots/following", setup_options(options))
+      end
+      
+    
+      ##
+      # Everyones
+      #
+      # @param    [Hash]
+      #           e.g. {:per_page => 30, :page => 1}
+      #
+      # @return   [Array]
+      # @api      public
+      #
+      def self.everyones(options={})
+        Dribble::Request.get("/shots/everyone", setup_options(options))
+      end
+    
+    
+      ##
+      # Debuts
+      #
+      # @param    [Hash]
+      #           e.g. {:per_page => 30, :page => 1}
+      #
+      # @return   [Array]
+      # @api      public
+      #
+      def self.debuts(options={})
+        Dribble::Request.get("/shots/debuts", setup_options(options))
+      end
+    
+    
+      ##
+      # Popular
+      #
+      # @param    [Hash]
+      #           e.g. {:per_page => 30, :page => 1}
+      #
+      # @return   [Array]
+      # @api      public
+      #
+      def self.popular(options={})
+        Dribble::Request.get("/shots/popular", setup_options(options))
+      end
+
+    
+      private
+      
+      
+        def self.setup_options(options)
+          {:per_page => 30, :page => 1}.merge(options)
+        end
+    
+
+    end
+  end
+end

data/lib/dribble/exceptions.rb

@@ -0,0 +1,3 @@
+module Dribble
+  class NoMorePagesAvailable < StandardError; end
+end

data/lib/dribble/player.rb

@@ -1,5 +1,40 @@
 module Dribble
   class Player
+    attr_reader :id, :name, :url, :avatar_url, :location, :created_at, :draftees_count,
+                :following_count, :shots_count, :followers_count, :following, :shots
+    
+    
+    def initialize(attr={})
+      attr.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+    
+    
+    ##
+    # Following
+    #
+    # @param  [Hash]
+    # @return [Array]
+    # @api    public
+    #
+    def following(options={})
+      @following ||= Dribble::API::Shot.following(self.id, options)
+    end
+    
+    
+    ##
+    # Player's Shots
+    #
+    # @param  [Hash]
+    # @return [Array]
+    # @api    public
+    #
+    def shots(options={})
+      @shots ||= Dribble::API::Player.find_shots(self.id, options)
+    end
+    
+    
     class << self
       
       
@@ -7,45 +42,57 @@ module Dribble
       # Find shots for a given player
       #
       # @param  [String/Integer]
-      # @return [Hash]
+      # @return [Object]
       # @api    public
       #
-      def find(id, options={})
-        Dribble::Request.get("/players/#{id}/shots", setup_options(options))
+      def find_shots(id, options={})
+        results = Dribble::API::Player.find_shots(id, options)
+        Dribble::Shots.new(format_shots(results), results)
       end
-      
-      
+  
+  
       ##
-      # Followers
+      # Following Shots
       #
       # @param  [String/Integer]
-      # @return [Hash]
+      # @return [Object]
       # @api    public
       #
-      def followers(id, options={})
-        Dribble::Request.get("/players/#{id}/shots/following", setup_options(options))
+      def following_shots(id, options={})
+        results = Dribble::API::Player.following_shots(id, options)
+        Dribble::Shots.new(format_shots(results), results)
       end
-      
-      
+
+  
       ##
       # Profile
       #
       # @param  [String/Integer]
-      # @return [Hash]
+      # @return [Object]
       # @api    public
       #
       def profile(id)
-        Dribble::Request.get("/players/#{id}")
+        new(Dribble::API::Player.profile(id))
       end
+      alias_method :find, :profile
       
-      
-      
+    
       private
         
-        def setup_options(options)
-          {:per_page => 30, :page => 1}.merge(options)
+        
+        ##
+        # Format Shots
+        #
+        # @param  [Array, Symbold]
+        # @return [Object]
+        # @api    private
+        #
+        def format_shots(response, index = :shots)
+          response[index].map do |shot|
+            Dribble::Shot.new(shot)
+          end
         end
-      
     end
+    
   end
 end

data/lib/dribble/request.rb

@@ -1,14 +1,15 @@
 module Dribble
   class Request
     class << self
-      
       DRIBBLE_API = 'api.dribbble.com'
-      TIMEOUT     = 10
       
       def get(query, options={})
-        uri = options.empty? ? "#{to_url}#{query}" : "#{to_url}#{query}?#{options.to_query}"
-        url = ::URI.parse(uri)
-        ::Yajl::HttpStream.get(url, :symbolize_keys => true)
+        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
       
       

data/lib/dribble/shot.rb

@@ -1,67 +1,94 @@
 module Dribble
   class Shot
-    class << self
-      
-      
-      ##
-      # By ID
-      #
-      # @param    [Integer]
-      # @return   [Hash]
-      # @api      public
-      #
-      def for(id)
-        Dribble::Request.get("/shots/#{id.to_i}")
+    attr_reader   :id, :title, :url, :image_url, :image_teaser_url, :width, :height, :created_at, :player,
+                  :views_count, :likes_count, :comments_count, :rebounds_count
+    
+    
+    def initialize(attributes={})
+      attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
       end
-      
-      
-      ##
-      # Everyones
-      #
-      # @param    [Hash]
-      #           e.g. {:per_page => 30, :page => 1}
-      #
-      # @return   [Array]
-      # @api      public
-      #
-      def everyones(options={})
-        Dribble::Request.get("/shots/everyone", setup_options(options))
-      end
-      
-      
-      ##
-      # Debuts
-      #
-      # @param    [Hash]
-      #           e.g. {:per_page => 30, :page => 1}
-      #
-      # @return   [Array]
-      # @api      public
-      #
-      def debuts(options={})
-        Dribble::Request.get("/shots/debuts", setup_options(options))
-      end
-      
-      
-      ##
-      # Popular
-      #
-      # @param    [Hash]
-      #           e.g. {:per_page => 30, :page => 1}
-      #
-      # @return   [Array]
-      # @api      public
-      #
-      def popular(options={})
-        Dribble::Request.get("/shots/popular", setup_options(options))
-      end
-      
-      private
-        
-        def setup_options(options)
-          {:per_page => 30, :page => 1}.merge(options)
-        end
-      
+      @player = Dribble::Player.new(attributes[:player]) if attributes[:player]
+    end
+    
+    
+    ##
+    # By ID
+    #
+    # @param    [Integer]
+    # @return   [Object]
+    # @api      public
+    #
+    def self.for(id)
+      new(Dribble::API::Shot.for(id))
+    end
+    
+    
+    ##
+    # Following
+    #
+    # @param  [String/Integer]
+    # @return [Object]
+    # @api    public
+    #
+    def self.following(id, options={})
+      results = Dribble::API::Shot.following(id, options)
+      Dribble::Following.new(format_shots(results), results)
     end
+  
+  
+    ##
+    # Everyones
+    #
+    # @param    [Hash]
+    #           e.g. {:per_page => 30, :page => 1}
+    #
+    # @return   [Object]
+    # @api      public
+    #
+    def self.everyones(options={})
+      results = Dribble::API::Shot.everyones(options)
+      Dribble::Everyones.new(format_shots(results), results)
+    end
+  
+  
+    ##
+    # Debuts
+    #
+    # @param    [Hash]
+    #           e.g. {:per_page => 30, :page => 1}
+    #
+    # @return   [Object]
+    # @api      public
+    #
+    def self.debuts(options={})
+      results = Dribble::API::Shot.debuts(options)
+      Dribble::Debuts.new(format_shots(results), results)
+    end
+  
+  
+    ##
+    # Popular
+    #
+    # @param    [Hash]
+    #           e.g. {:per_page => 30, :page => 1}
+    #
+    # @return   [Object]
+    # @api      public
+    #
+    def self.popular(options={})
+      results = Dribble::API::Shot.popular(options)
+      Dribble::Popular.new(format_shots(results), results)
+    end
+    
+
+    private
+    
+      def self.format_shots(response, index = :shots)
+        response[index].map do |shot|
+          new(shot)
+        end
+      end
+
   end
 end

data/lib/dribble/shots.rb

@@ -0,0 +1,43 @@
+module Dribble
+  class Shots
+    attr_reader :shots, :page, :pages, :per_page, :total
+    
+    def initialize(shots, attributes={})
+      @shots    = shots
+      @page     = attributes[:page]
+      @pages    = attributes[:pages]
+      @per_page = attributes[:per_page]
+      @total    = attributes[:total]
+    end
+    
+    
+    def next_page
+      api_endpoint  = self.class.to_s.split('::').last.downcase.to_sym
+      options       = {:page => self.page.to_i + 1}
+      raise Dribble::NoMorePagesAvailable.new('You are already on the last page.') if options[:page] > self.pages.to_i
+      Dribble::Shot.send(api_endpoint, options)
+    end
+    
+  end
+end
+
+
+module Dribble
+  class Popular < Shots
+  end
+end
+
+module Dribble
+  class Everyones < Shots
+  end
+end
+
+module Dribble
+  class Debuts < Shots
+  end
+end
+
+module Dribble
+  class Following < Shots
+  end
+end

data/lib/dribble.rb

@@ -1,8 +1,11 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-# require 'rubygems'
+require 'uri'
+
+require 'rubygems'
+require 'yajl/gzip'
+require 'yajl/deflate'
 require 'yajl/http_stream'
-require 'yajl'
 
 base = File.expand_path(File.dirname(__FILE__))
 
@@ -12,9 +15,21 @@ Dir[File.join(File.join(base, 'core_ext'), '*.rb')].each { |file| require file }
 require File.join(base, 'dribble/version')
 
 module Dribble
-  autoload :Request,        'dribble/request'
+  autoload :Request,              'dribble/request'
+  autoload :NoMorePagesAvailable, 'dribble/exceptions'
+  
+  # Custom Objects for easy usage of the Dribble API
+  autoload :Player,               'dribble/player'
+  autoload :Shot,                 'dribble/shot'
+  autoload :Shots,                'dribble/shots'
+  autoload :Popular,              'dribble/shots'
+  autoload :Debut,                'dribble/shots'
+  autoload :Everyone,             'dribble/shots'
+  autoload :Following,            'dribble/shots'
   
-  # The API
-  autoload :Player,       'dribble/player'
-  autoload :Shot,         'dribble/shot'
+  # A slimmer API that converts JSON to a Hash. No Object creation overhead.
+  module API
+    autoload :Player,             'dribble/api/player'
+    autoload :Shot,               'dribble/api/shot'
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dribble
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Robert R Evans
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-30 00:00:00 -07:00
+date: 2010-08-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,14 +80,21 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- dribble.gemspec
+- examples/barebones/player.rb
+- examples/barebones/shot.rb
 - examples/player.rb
 - examples/shot.rb
 - lib/core_ext/hash.rb
 - lib/core_ext/object.rb
 - lib/dribble.rb
+- lib/dribble/api/player.rb
+- lib/dribble/api/shot.rb
+- lib/dribble/exceptions.rb
 - lib/dribble/player.rb
 - lib/dribble/request.rb
 - lib/dribble/shot.rb
+- lib/dribble/shots.rb
 - lib/dribble/version.rb
 - spec/rcov.opts
 - spec/spec.opts
@@ -128,5 +135,7 @@ specification_version: 3
 summary: API Wrapper for the awesome Dribble Site
 test_files: 
 - spec/spec_helper.rb
+- examples/barebones/player.rb
+- examples/barebones/shot.rb
 - examples/player.rb
 - examples/shot.rb