diggr 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2008-08-26
+
+* 1 major enhancement
+
+  * Diggr allows querying of the Digg API
+

data/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/diggr.rb
+lib/diggr/api.rb
+lib/diggr/api_error.rb
+lib/diggr/constants.rb
+lib/diggr/json_parser.rb
+lib/diggr/request.rb
+lib/diggr/response_classes/comment.rb
+lib/diggr/response_classes/container.rb
+lib/diggr/response_classes/digg.rb
+lib/diggr/response_classes/error.rb
+lib/diggr/response_classes/medium.rb
+lib/diggr/response_classes/photo.rb
+lib/diggr/response_classes/story.rb
+lib/diggr/response_classes/topic.rb
+lib/diggr/response_classes/user.rb
+test/test_api.rb
+test/test_comment.rb
+test/test_container.rb
+test/test_digg.rb
+test/test_error.rb
+test/test_json_parser.rb
+test/test_medium.rb
+test/test_photo.rb
+test/test_request.rb
+test/test_story.rb
+test/test_topic.rb
+test/test_user.rb

data/README.txt

@@ -0,0 +1,113 @@
+= diggr
+
+* http://diggr.rubyforge.org
+
+== DESCRIPTION:
+
+Diggr is a ruby wrapper for the Digg API.
+
+Diggr strives to remain consistent with the Digg API endpoints listed here: 
+http://apidoc.digg.com/CompleteList. Endpoints are created in Diggr with method calls. 
+Each node in an endpoint becomes a method call and each node which is an argument becomes 
+an argument to the previous method. As an example, the following endpoint
+
+/user/{user name}
+
+in which the user name is "johndoe" would be created with this Diggr call:
+
+diggr.user("johndoe")
+
+To send the request to the Digg API and retrieve the results of the call, Diggr requests are
+terminated in one of two ways.
+
+1. Using the fetch method. By ending your request with the fetch method, your result will be
+   returned to you. If the request is singular, you will receive a single object as a
+   response. If the request is plural, you will receive a collection of objects stored in an
+   array.
+
+2. Using any Enumerable method. This works only on plural requests. In this case, it is
+   unnecessary to use the fetch method.
+
+See the synopsis for examples of each of these types of calls.
+
+Options such as count or offset can be set using the options method and providing a hash of 
+arguments. See synopsis for more information.
+
+Note: In an effort to remain consistent with the Digg API, some method names do not follow
+the ruby idiom of underscores. Although somewhat ugly, this allows a user read the Digg API
+and understand the exact methods to call in Diggr to achieve their desired results.
+
+== FEATURES/PROBLEMS:
+
+* Diggr wraps the Digg API and returns both single elements and collections based on the request
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'diggr'
+  
+  diggr = Diggr::API.new
+  
+  # retrieve a single user by user name and print the number of profile views
+  user = diggr.user("johndoe").fetch
+  puts user.profileviews
+
+  # iterator over the most recent 10 stories (default return size) and print their titles
+  diggr.stories.each do |story|
+    puts story.title
+  end
+
+  # print the title of the 3 most recent hot stories
+  diggr.stories.hot.options(:count => 3).each do |story|
+    puts story.title
+  end
+
+  # build an array of stories whos title contains "foo"
+  diggr.stories.inject([]) do |array,story|
+    array << story if story.title =~ /foo/
+    array
+  end
+
+  # print the title of the 2nd and 3rd most recent stories
+  diggr.stories.options(:count => 2, :offset => 2).each do |story|
+    puts story.title
+  end
+
+== REQUIREMENTS:
+
+* need 1.0.2 or greater
+* json 1.1.3 or greater
+* activesupport 2.1.0 or greater
+
+== INSTALL:
+
+* install from rubyforge (major releases)
+* sudo gem install diggr
+
+* install from github (major and minor releases)
+* sudo gem install dfg59-diggr --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require 'need'
+need { 'lib/diggr.rb' }
+
+Hoe.new('diggr', Diggr::VERSION) do |p|
+  p.developer('Drew Olson', 'drew@drewolson.org')
+  p.extra_deps << ['need', '>= 1.0.2']
+  p.extra_deps << ['json', '>= 1.1.3']
+  p.extra_deps << ['activesupport', '>= 2.1.0']
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/diggr.rb

@@ -0,0 +1,6 @@
+require 'need'
+need { File.join('diggr','api') }
+
+module Diggr
+  VERSION = '0.1.0'
+end

data/lib/diggr/api.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'need'
+need { 'constants' }
+need { 'request' }
+
+module Diggr
+  class API
+    Diggr::Constants::VALID_ROOT_METHODS.each do |method|
+      define_method(method) do |*args|
+        request = Diggr::Request.new 
+        request.send(method,*args)
+      end
+    end
+  end
+end

data/lib/diggr/api_error.rb

@@ -0,0 +1 @@
+class APIError < StandardError; end

data/lib/diggr/constants.rb

@@ -0,0 +1,36 @@
+module Diggr
+  module Constants
+    VALID_ROOT_METHODS = [
+      :containers,
+      :container,
+      :errors,
+      :error,
+      :galleryphotos,
+      :galleryphoto,
+      :media,
+      :medium,
+      :stories,
+      :story,
+      :topic,
+      :topics,
+      :users,
+      :user
+    ]
+    RESPONSE_CLASSES = [
+      "containers",
+      "errors",
+      "diggs",
+      "comments",
+      "photos",
+      "media",
+      "stories",
+      "topics",
+      "users"
+    ]
+    HOST = "services.digg.com"
+    PORT = 80
+    USER_AGENT = 'diggr'
+    APP_KEY = 'http://diggr.rubyforge.org'
+    RESPONSE_TYPE = 'application/json'
+  end
+end

data/lib/diggr/json_parser.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'active_support/inflector'
+require 'json'
+require 'need'
+need { 'api_error' }
+need { 'constants' }
+
+module Diggr
+  class JSONParser
+    def parse(data)
+      build_objects_from_parsed_json(JSON.parse(data))
+    end
+
+    private
+
+    def build_objects_from_parsed_json(parsed_data)
+      if parsed_data.has_key?('code') && parsed_data['code'] == 404
+        raise APIError, "specified path returned a 404 error"
+      end
+
+      collection_type, collection_data = cleanse_json(parsed_data)
+
+      if collection_type.nil?
+        nil
+      else
+        build_result(collection_type, collection_data)
+      end
+    end
+
+    def build_result(collection_type, collection_data)
+      klass = find_class(collection_type)
+
+      object_collection = collection_data.inject([]) do |collection,object_data|
+        collection << klass.new_from_parsed_json(object_data) 
+      end
+
+      object_collection.size == 1 ? object_collection.first : object_collection
+    end
+
+    def cleanse_json(parsed_data)
+      parsed_data.select { |key,val| Diggr::Constants::RESPONSE_CLASSES.include?(key) }[0]
+    end
+
+    def find_class(collection_type)
+      file_name = Inflector.singularize(collection_type)
+      need { File.join('response_classes',file_name) }
+      Inflector.constantize('Diggr::'+ Inflector.camelize(file_name))
+    end 
+  end
+end
+

data/lib/diggr/request.rb

@@ -0,0 +1,67 @@
+require 'enumerator'
+require 'cgi'
+require 'net/http'
+require 'rubygems'
+require 'need'
+need { 'constants' }
+need { 'json_parser' }
+
+module Diggr
+  class Request
+    include Enumerable
+
+    def initialize
+      @end_point = ''
+      @options = nil
+    end
+
+    def options(params)
+      @options = params.inject("") do |options,(key,val)|
+        options + "&#{key}=#{cleanse(val)}"
+      end
+      self
+    end
+
+    def method_missing(name,*args,&block)
+      @end_point += "/#{name}"
+      unless args.empty?
+        @end_point += "/#{args.join(',')}"
+      end 
+      self
+    end
+
+    def each(&block)
+      fetch.each(&block)
+    end
+
+    def fetch
+      response = make_request
+      Diggr::JSONParser.new.parse(response)
+    end
+
+    private
+
+    def make_request
+      Net::HTTP.start(Diggr::Constants::HOST,Diggr::Constants::PORT) do |http|
+        http.get(
+          path,
+          'User-Agent' => Diggr::Constants::USER_AGENT,
+          'Accept' => Diggr::Constants::RESPONSE_TYPE
+        ).body
+      end
+    end
+
+    def cleanse(val)
+      if val.kind_of? String
+        val = CGI.escape(val)
+      end
+      val
+    end
+
+    def path
+      path = @end_point + "?appkey=#{cleanse(Diggr::Constants::APP_KEY)}"
+      path += @options if @options
+      path
+    end
+  end
+end

data/lib/diggr/response_classes/comment.rb

@@ -0,0 +1,15 @@
+module Diggr
+  class Comment
+    attr_accessor :date, :id, :story, :up, :down, :replies, :replyto, :user, :content, :level, :root
+
+    def self.new_from_parsed_json(data)
+      comment = Comment.new
+
+      data.each do |key,val|
+        comment.send("#{key}=",val)
+      end
+
+      comment
+    end  
+  end
+end

data/lib/diggr/response_classes/container.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'need'
+need { 'topic' }
+
+module Diggr
+  class Container
+    attr_accessor :name, :short_name, :topics
+
+    def initialize
+      self.topics = []
+    end
+
+    def self.new_from_parsed_json(data)
+      container = Container.new
+      container.name = data['name']
+      container.short_name = data['short_name']
+      
+      if data.has_key? 'topics'
+        data['topics'].each do |topic_data|
+          container.topics << Topic.new_from_parsed_json(topic_data)
+        end
+      end
+
+      container
+    end  
+  end
+end

data/lib/diggr/response_classes/digg.rb

@@ -0,0 +1,15 @@
+module Diggr
+  class Digg
+    attr_accessor :date, :story, :id, :user, :status
+
+    def self.new_from_parsed_json(data)
+      digg = Digg.new
+
+      data.each do |key,val|
+        digg.send("#{key}=",val)
+      end
+
+      digg
+    end  
+  end
+end

data/lib/diggr/response_classes/error.rb

@@ -0,0 +1,15 @@
+module Diggr
+  class Error
+    attr_accessor :code, :message
+
+    def self.new_from_parsed_json(data)
+      error = Error.new
+
+      data.each do |key,val|
+        error.send("#{key}=",val)
+      end
+
+      error
+    end
+  end
+end

data/lib/diggr/response_classes/medium.rb

@@ -0,0 +1,15 @@
+module Diggr
+  class Medium
+    attr_accessor :name, :short_name
+
+    def self.new_from_parsed_json(data)
+      medium = Medium.new
+
+      data.each do |key,val|
+        medium.send("#{key}=",val)
+      end
+
+      medium
+    end
+  end
+end

data/lib/diggr/response_classes/photo.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'need'
+need { 'user' }
+
+module Diggr
+  class Photo
+    attr_accessor :id, :submit_date, :comments, :title, :user, :src, :href, :originalheight, :originalwidth,
+      :height, :width, :contentType
+
+    def self.new_from_parsed_json(data)
+      photo = Photo.new
+
+      data.each do |key,val|
+        unless key == 'user'
+          photo.send("#{key}=",val)
+        end
+      end
+
+      if data.has_key? 'user'
+        photo.user = Diggr::User.new_from_parsed_json(data['user']) 
+      end
+
+      photo
+    end  
+  end
+end

data/lib/diggr/response_classes/story.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'need'
+need { 'user' }
+need { 'topic' }
+need { 'container' }
+need { 'photo' }
+
+module Diggr
+  class Story
+    attr_accessor :id, :link, :submit_date, :diggs, :comments, :title, :description,
+      :status, :media, :user, :topic, :container, :thumbnail, :href
+
+    def self.new_from_parsed_json(data)
+      story = Story.new
+
+      story.id = data['id'] if data['id']
+      story.link = data['link'] if data['link']
+      story.submit_date = data['submit_date'] if data['submit_date']
+      story.diggs = data['diggs'] if data['diggs']
+      story.comments = data['comments'] if data['comments']
+      story.title = data['title'] if data['title']
+      story.description = data['description'] if data['description']
+      story.status = data['status'] if data['status']
+      story.media = data['media'] if data['media']
+      story.user = Diggr::User.new_from_parsed_json(data['user']) if data['user']
+      story.topic = Diggr::Topic.new_from_parsed_json(data['topic']) if data['topic']
+      story.container = Diggr::Container.new_from_parsed_json(data['container']) if data['container']
+      story.thumbnail = Diggr::Photo.new_from_parsed_json(data['thumbnail']) if data['thumbnail']
+      story.href = data['href'] if data['href']
+
+      story
+    end
+  end
+end

data/lib/diggr/response_classes/topic.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'need'
+need { 'container' }
+
+module Diggr
+  class Topic
+    attr_accessor :name, :short_name, :container
+
+    def self.new_from_parsed_json(data)
+      topic = Topic.new
+      topic.name = data['name']
+      topic.short_name = data['short_name']
+
+      if data.has_key? 'container'
+        topic.container = Diggr::Container.new_from_parsed_json(data['container']) 
+      end
+
+      topic
+    end  
+  end
+end

data/lib/diggr/response_classes/user.rb

@@ -0,0 +1,15 @@
+module Diggr
+  class User
+    attr_accessor :name, :fullname, :icon, :registered, :profileviews, :links
+
+    def self.new_from_parsed_json(data)
+      user = User.new
+
+      data.each do |key,val|
+        user.send("#{key}=",val)
+      end
+
+      user
+    end
+  end
+end

data/test/test_api.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'test/unit'
+require 'need'
+need { '../lib/diggr/api' }
+need { '../lib/diggr/request' }
+need { '../lib/diggr/constants' }
+
+class TestDigg < Test::Unit::TestCase
+  def test_instantiate_class
+    assert_nothing_raised do
+      Diggr::API.new
+    end
+  end
+
+  def test_valid_root_method_returns_a_request_instance
+    digg = Diggr::API.new
+
+    Diggr::Constants::VALID_ROOT_METHODS.each do |method|
+      assert_instance_of Diggr::Request, digg.send(method)
+    end
+  end
+
+  def test_invalid_root_method_throws_error
+    digg = Diggr::API.new
+
+    assert_raises NoMethodError do
+      digg.foo
+    end
+  end
+
+  def test_valid_root_method_returns_request_with_corrent_endpoint
+    digg = Diggr::API.new
+    request = digg.media
+
+    assert_equal "/media", request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_valid_root_method_with_args_returns_request_with_corrent_endpoint
+    digg = Diggr::API.new
+    request = digg.media('123')
+
+    assert_equal "/media/123", request.send(:instance_variable_get,"@end_point")
+  end
+end

data/test/test_comment.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/comment' }
+
+class TestComment < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Comment.new
+    end
+  end
+
+  def test_new_from_parsed_json_data
+    parsed_json_data = {
+      'date' => '07292008',
+      'id' => '2',
+      'story' => '1',
+      'up' => '2',
+      'down' => '3',
+      'replies' => '5',
+      'replyto' => 'null',
+      'user' => 'johndoe',
+      'content' => 'this is a comment',
+      'level' => '0',
+      'root' => '0'
+    }
+
+    comment = Diggr::Comment.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      assert_equal val, comment.send(key)
+    end
+  end
+end

data/test/test_container.rb

@@ -0,0 +1,35 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/container' }
+
+class TestContainer < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Container.new
+    end
+  end
+
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      'name' => 'Test Container',
+      'short_name' => 'test',
+      'topics' => [
+        {
+          'name' => 'Test Topic',
+          'short_name' => 'test'
+        }
+      ]
+    }
+
+    container = Diggr::Container.new_from_parsed_json(parsed_json_data)
+    
+    parsed_json_data.each do |key,val|
+      if key == 'topics'
+        assert_instance_of Array, container.topics
+      else
+        assert_equal val, container.send(key)
+      end
+    end
+  end
+end

data/test/test_digg.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/digg' }
+
+class TestDigg < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Digg.new
+    end
+  end
+
+  def test_new_from_parsed_json_data
+    parsed_json_data = {
+      'date' => '07292008',
+      'story' => '1',
+      'id' => '2',
+      'user' => 'johndoe',
+      'status' => 'popular'
+    }
+
+    digg = Diggr::Digg.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      assert_equal val, digg.send(key)
+    end
+  end
+end

data/test/test_error.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/error' }
+
+class TestError < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Error.new
+    end
+  end
+
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      'code' => '1234',
+      'message' => 'test',
+    }
+
+    error = Diggr::Error.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      assert_equal val, error.send(key)
+    end
+  end
+end

data/test/test_json_parser.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/json_parser' }
+need { '../lib/diggr/response_classes/topic' }
+
+class TestJSONParser < Test::Unit::TestCase
+  def test_find_class
+    parser = Diggr::JSONParser.new
+
+    assert_equal Diggr::Topic, parser.send(:find_class, 'topics')
+  end
+
+  def test_cleanse_json
+    parser = Diggr::JSONParser.new
+
+    data = {
+      "stories" => { :test => "foo" },
+      "foo" => "bar",
+      "baz" => "boom"
+    }
+
+    assert_equal(["stories", { :test => "foo" }], parser.send(:cleanse_json, data))
+  end
+end

data/test/test_medium.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/medium' }
+
+class TestMedium < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Medium.new
+    end
+  end
+
+  def test_new_from_parsed_json_data
+    parsed_json_data = {
+      'name' => 'Test Name',
+      'short_name' => 'test'
+    }
+
+    digg = Diggr::Medium.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      assert_equal val, digg.send(key)
+    end
+  end
+end

data/test/test_photo.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/photo' }
+
+class TestPhoto < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Photo.new
+    end
+  end
+
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      'id' => '1',
+      'submit_date' => '12345',
+      'comments' => '5',
+      'title' => 'Test Photo',
+      'user' => {
+        'name' => 'johndoe',
+        'icon' => 'http://www.gravitar.com',
+        'registered' => '1234567',
+        'profileviews' => '13',
+      },
+      'src' => 'http://www.digg.com/some/stuff/here',
+      'href' => 'http://www.digg.com/more/stuff/here'
+    }
+
+    photo = Diggr::Photo.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      if key == 'user'
+        assert_instance_of Diggr::User, photo.user
+      else
+        assert_equal val, photo.send(key)
+      end
+    end 
+  end
+end

data/test/test_request.rb

@@ -0,0 +1,111 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require 'need'
+need { '../lib/diggr/request' }
+need { '../lib/diggr/response_classes/story' }
+need { '../lib/diggr/constants' }
+need { '../lib/diggr/json_parser' }
+
+class TestRequest < Test::Unit::TestCase
+  def test_request_instantiation
+    assert_nothing_raised do
+      Diggr::Request.new
+    end
+  end
+
+  def test_simple_end_point
+    request = Diggr::Request.new
+    request.media
+
+    assert_equal '/media', request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_simple_end_point_with_args
+    request = Diggr::Request.new
+    request.error('123')
+
+    assert_equal '/error/123', request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_complex_end_point
+    request = Diggr::Request.new
+    request.stories.popular
+
+    assert_equal '/stories/popular', request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_complex_end_point_with_args
+    request = Diggr::Request.new
+    request.stories.topic("technology").hot
+
+    assert_equal '/stories/topic/technology/hot', request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_request_with_options
+    request = Diggr::Request.new
+    request.topics.options(:count => 5, :offset => 3)
+
+    assert_equal '&count=5&offset=3', request.send(:instance_variable_get,"@options")
+  end
+
+  def test_cleanse_string_with_forward_slash
+    request = Diggr::Request.new
+
+    assert_equal '%2F', request.send(:cleanse,"/")
+  end
+
+  def test_cleanse_number
+    request = Diggr::Request.new
+
+    assert_equal 2, request.send(:cleanse,2)
+  end
+
+  def test_simple_path
+    request = Diggr::Request.new
+    request.stories
+
+    assert_equal '/stories?appkey=http%3A%2F%2Fdiggr.rubyforge.org', request.send(:path)
+  end
+
+  def test_simple_path_with_options
+    request = Diggr::Request.new
+    request.stories.options(:count => 3)
+
+    assert_equal '/stories?appkey=http%3A%2F%2Fdiggr.rubyforge.org&count=3', request.send(:path)
+  end
+
+  def test_complex_path
+    request = Diggr::Request.new
+    request.story(1).diggs
+
+    assert_equal '/story/1/diggs?appkey=http%3A%2F%2Fdiggr.rubyforge.org', request.send(:path)
+  end
+
+  def test_comma_seperated_args_product_correct_endpoint
+    request = Diggr::Request.new
+    request.stories(1,2,3,4)
+
+    assert_equal '/stories/1,2,3,4', request.send(:instance_variable_get,"@end_point")
+  end
+
+  def test_fetch
+    story = Diggr::Story.new
+    Diggr::JSONParser.any_instance.stubs(:parse).with(story).returns(story) 
+    request = Diggr::Request.new
+    request.stubs(:make_request).returns(story)
+
+    assert_equal story, request.fetch 
+  end
+
+  def test_each
+    stories = [Diggr::Story.new,Diggr::Story.new]
+    Diggr::JSONParser.any_instance.stubs(:parse).with(stories).returns(stories) 
+    request = Diggr::Request.new
+    request.stubs(:make_request).returns(stories)
+
+    request.each do |item|
+      assert_instance_of Diggr::Story, item
+    end
+  end
+end

data/test/test_story.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/story' }
+
+class TestStory < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Story.new
+    end
+  end
+
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      "id" => "4368401",
+      "link" => "http://maxsangalli.altervista.org/?p=45",
+      "submit_date" => 1196891534,
+      "diggs" => 1,
+      "comments" => 0,
+      "title" => "Jukebox con Linux",
+      "description" => "Jukebox with Linux",
+      "status" => "upcoming",
+      "media" => "news",
+      "user" => {
+          "name" => "ilsanga",
+          "icon" => "http://digg.com/img/udl.png",
+          "registered" => 1196891377,
+          "profileviews" => 0
+       },
+      "topic" => {
+        "name" => "Linux/Unix",
+        "short_name" => "linux_unix"
+      },
+      "container" => {
+        "name" => "Technology",
+        "short_name" => "technology"
+      },
+      "thumbnail" => {
+        "originalwidth" => 390,
+        "originalheight" => 387,
+        "contentType" => "image/jpeg",
+        "src" => "http://digg.com/linux_unix/Jukebox_con_Linux/t.jpg",
+        "width" => 80,
+        "height" => 80
+      },
+      "href" => "http://digg.com/linux_unix/Jukebox_con_Linux"
+    }
+
+    photo = Diggr::Story.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      unless val.kind_of? Hash
+        assert_equal val, photo.send(key)
+      end
+    end 
+  end
+end

data/test/test_topic.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/topic' }
+need { '../lib/diggr/response_classes/container' }
+
+class TestTopic < Test::Unit::TestCase
+  def test_instantiation
+    assert_nothing_raised do
+      Diggr::Topic.new
+    end
+  end
+
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      'name' => 'Test Topic',
+      'short_name' => 'test',
+      'container' => {
+        'name' => 'Test Container',
+        'short_name' => 'test'
+      }
+    }
+
+    topic = Diggr::Topic.new_from_parsed_json(parsed_json_data)
+    
+    parsed_json_data.each do |key,val|
+      if key == 'container'
+        assert_instance_of Diggr::Container, topic.container
+      else
+        assert_equal val, topic.send(key)
+      end
+    end
+  end
+end

data/test/test_user.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'rubygems'
+require 'need'
+need { '../lib/diggr/response_classes/user' }
+
+class TestUser < Test::Unit::TestCase
+  def test_instantiated
+    assert_nothing_raised do
+      Diggr::User.new
+    end
+  end
+  
+  def test_new_from_parsed_json
+    parsed_json_data = {
+      'name' => 'johndoe',
+      'icon' => 'http://www.gravitar.com',
+      'registered' => '1234567',
+      'profileviews' => '13',
+    }
+
+    user = Diggr::User.new_from_parsed_json(parsed_json_data)
+
+    parsed_json_data.each do |key,val|
+      assert_equal val, user.send(key)
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: diggr
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: need
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: "Diggr is a ruby wrapper for the Digg API.  Diggr strives to remain consistent with the Digg API endpoints listed here:  http://apidoc.digg.com/CompleteList. Endpoints are created in Diggr with method calls.  Each node in an endpoint becomes a method call and each node which is an argument becomes  an argument to the previous method. As an example, the following endpoint  /user/{user name}  in which the user name is \"johndoe\" would be created with this Diggr call:  diggr.user(\"johndoe\")  To send the request to the Digg API and retrieve the results of the call, Diggr requests are terminated in one of two ways.  1. Using the fetch method. By ending your request with the fetch method, your result will be returned to you. If the request is singular, you will receive a single object as a response. If the request is plural, you will receive a collection of objects stored in an array.  2. Using any Enumerable method. This works only on plural requests. In this case, it is unnecessary to use the fetch method.  See the synopsis for examples of each of these types of calls.  Options such as count or offset can be set using the options method and providing a hash of  arguments. See synopsis for more information.  Note: In an effort to remain consistent with the Digg API, some method names do not follow the ruby idiom of underscores. Although somewhat ugly, this allows a user read the Digg API and understand the exact methods to call in Diggr to achieve their desired results."
+email: 
+- drew@drewolson.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/diggr.rb
+- lib/diggr/api.rb
+- lib/diggr/api_error.rb
+- lib/diggr/constants.rb
+- lib/diggr/json_parser.rb
+- lib/diggr/request.rb
+- lib/diggr/response_classes/comment.rb
+- lib/diggr/response_classes/container.rb
+- lib/diggr/response_classes/digg.rb
+- lib/diggr/response_classes/error.rb
+- lib/diggr/response_classes/medium.rb
+- lib/diggr/response_classes/photo.rb
+- lib/diggr/response_classes/story.rb
+- lib/diggr/response_classes/topic.rb
+- lib/diggr/response_classes/user.rb
+- test/test_api.rb
+- test/test_comment.rb
+- test/test_container.rb
+- test/test_digg.rb
+- test/test_error.rb
+- test/test_json_parser.rb
+- test/test_medium.rb
+- test/test_photo.rb
+- test/test_request.rb
+- test/test_story.rb
+- test/test_topic.rb
+- test/test_user.rb
+has_rdoc: true
+homepage: http://diggr.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: diggr
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Diggr is a ruby wrapper for the Digg API
+test_files: 
+- test/test_api.rb
+- test/test_comment.rb
+- test/test_container.rb
+- test/test_digg.rb
+- test/test_error.rb
+- test/test_json_parser.rb
+- test/test_medium.rb
+- test/test_photo.rb
+- test/test_request.rb
+- test/test_story.rb
+- test/test_topic.rb
+- test/test_user.rb