buzzsprout 0.0.1 → 0.0.2

data/.gitignore

@@ -17,5 +17,6 @@ tmtags
 coverage
 rdoc
 pkg
+.yardoc
 
 ## PROJECT::SPECIFIC

data/.yardopts

@@ -0,0 +1,7 @@
+--readme          README.md
+--markup          markdown
+--markup-provider rdiscount
+--default-return  nil
+-p ../yardoc_templates
+-o ../../sites/wynn/public/projects/buzzsprout/api
+--no-private

data/README.md

@@ -8,19 +8,19 @@ Ruby wrapper for the (yet unreleased, undocumented) [Buzzsprout](http://buzzspro
     
 ## Usage
 
-### Getting a list of episodes
+Getting a list of episodes
 
     # get your podcast ID from your RSS feed http://www.buzzsprout.com/105.rss
     >> Buzzsprout.episodes(105)
     => [<#Buzzsprout::Episode artist="Adam Stacoviak and Wynn Netherland" created_at=Mon Jan 25 11:53:02 -0600 2010 date=Mon, 25 Jan 2010 description="Adam and Wynn talk with Chris Wanstrath aka @defunkt from GitHub about the magic of Git, the past, present and future of GitHub, building a bootstrapped startup and some other cool stuff you'll just have to hear for yourself." duration=4675 id=2274 live=true podcast_id=105 s3=true size=37400482 tags="git, github, interview, bootstrapping, business, startups" title="Episode 0.1.0 - Chris Wanstrath from GitHub" updated_at=Mon Jan 25 13:36:42 -0600 2010>]
     
 
-### Get a list of tagged episodes
+Get a list of tagged episodes
     >> tags = %w(git github)
     >> Buzzsprout.episodes(105, tags)
     => [<#Buzzsprout::Episode artist="Adam Stacoviak and Wynn Netherland" created_at=Mon Jan 25 11:53:02 -0600 2010 date=Mon, 25 Jan 2010 description="Adam and Wynn talk with Chris Wanstrath aka @defunkt from GitHub about the magic of Git, the past, present and future of GitHub, building a bootstrapped startup and some other cool stuff you'll just have to hear for yourself." duration=4675 id=2274 live=true podcast_id=105 s3=true size=37400482 tags="git, github, interview, bootstrapping, business, startups" title="Episode 0.1.0 - Chris Wanstrath from GitHub" updated_at=Mon Jan 25 13:36:42 -0600 2010>]
     
-### Get a single episode
+Get a single episode
     # podcast_id, episode_id
     >> Buzzsprout.episodes(105, 2274)
     => <#Buzzsprout::Episode artist="Adam Stacoviak and Wynn Netherland" created_at=Mon Jan 25 11:53:02 -0600 2010 date=Mon, 25 Jan 2010 description="Adam and Wynn talk with Chris Wanstrath aka @defunkt from GitHub about the magic of Git, the past, present and future of GitHub, building a bootstrapped startup and some other cool stuff you'll just have to hear for yourself." duration=4675 id=2274 live=true podcast_id=105 s3=true size=37400482 tags="git, github, interview, bootstrapping, business, startups" title="Episode 0.1.0 - Chris Wanstrath from GitHub" updated_at=Mon Jan 25 13:36:42 -0600 2010>

data/Rakefile

@@ -8,13 +8,13 @@ begin
     gem.summary = %Q{Ruby wrapper for the stealth mode Buzzsprout API}
     gem.description = %Q{Ruby wrapper for the stealth mode Buzzsprout API}
     gem.email = "wynn.netherland@gmail.com"
-    gem.homepage = "http://github.com/pengwynn/buzzsprout"
+    gem.homepage = "http://wynnnetherland.com/projects/buzzsprout"
     gem.authors = ["Wynn Netherland"]
     gem.add_dependency('activesupport', '>= 2.3.2')
-    gem.add_dependency('hashie', '>= 0.1.3')
+    gem.add_dependency('hashie', '>= 0.2.0')
     gem.add_dependency('httparty', '>= 0.5.0')
 
-    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('shoulda', '>= 2.10.1')
     gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
     gem.add_development_dependency('fakeweb', '>= 1.2.5')
     gem.add_development_dependency "yard", ">= 0"

data/VERSION

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

data/lib/buzzsprout.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'time'
-gem 'activesupport', '>= 2.3.2'
+gem 'activesupport', '~> 2.3.2'
 require 'activesupport'
 
 gem 'hashie', '>= 0.1.3'
@@ -17,10 +17,20 @@ Hash.send :include, Hashie::HashExtensions
 
 module Buzzsprout
   
+  # List all the episodes for a podcast
+  #
+  # @param [Fixnum] podcast_id The ID for the podcast
+  # @param [Array<String>] tags An array of tags to filter episodes
+  # @return [Array<Episode>] A list of episodes matching the query
   def self.episodes(podcast_id, tags=[])
     Client.episodes(podcast_id, tags)
   end
 
+  # Retrieve episode details
+  #
+  # @param [Fixnum] podcast_id The ID for the podcast
+  # @param [Fixnum] episode_id The ID for the episode
+  # @return [Episode] A list of episodes matching the query
   def self.episode(podcast_id, episode_id)
     Client.episode(podcast_id, episode_id)
   end

data/lib/buzzsprout/client.rb

@@ -5,6 +5,11 @@ module Buzzsprout
     format :json
     base_uri "http://www.buzzsprout.com"
 
+    # List all the episodes for a podcast
+    #
+    # @param [Fixnum] podcast_id The ID for the podcast
+    # @param [Array<String>] tags An array of tags to filter episodes
+    # @return [Array<Episode>] A list of episodes matching the query
     def self.episodes(podcast_id, tags=[])
       query = {}
       tags = tags.join(",") if tags.is_a?(Array)
@@ -13,6 +18,11 @@ module Buzzsprout
       response.map{|item| Buzzsprout::Episode.new(item['episode'])}
     end
 
+    # Retrieve episode details
+    #
+    # @param [Fixnum] podcast_id The ID for the podcast
+    # @param [Fixnum] episode_id The ID for the episode
+    # @return [Episode] A list of episodes matching the query
     def self.episode(podcast_id, episode_id)
       Buzzsprout::Episode.new(self.get("/#{podcast_id}/#{episode_id}.json")['episode'])
     end

data/lib/buzzsprout/episode.rb

@@ -1,7 +1,7 @@
-
 module Buzzsprout
   class Episode < Hashie::Dash
     property :s3
+    # Gets/sets the episode artist
     property :artist
     property :size
     property :title
@@ -15,30 +15,42 @@ module Buzzsprout
     property :updated_at
     property :created_at
     
+    # Has the episode been uploaded to S3?
+    # @return [true,false] Boolean indicating whether or not the episode is on S3
     def s3?
       !!self[:s3]
     end
     
+    # Has the episode been published?
+    # @return [true,false] Boolean indicating whether or not the episode has been published
     def live?
       !!self[:live]
     end
     
+    # Formatted duration
+    # @return [String] duration formatted as time
     def duration
       segments = [self[:duration]/60]
       segments << (self[:duration] % 60 ) 
       segments.map {|t| t.to_s.rjust(2, '0')}.join(':')
     end
     
+    # Set the duration
+    # @param [String] duration as time
     def duration=(value)
       new_duration = value.to_s.split(":").reverse
       s, m = new_duration
       self[:duration] = (s.to_i + (m.to_i*60))
     end
     
+    # Duration in seconds
+    # @return [Integer] duration in seconds
     def duration_in_seconds
       self[:duration]
     end
     
+    # List of tags
+    # @return [Array<String>] array of tags for this episode
     def tags
       self[:tags].split(",")
     end

data/test/helper.rb

@@ -2,13 +2,14 @@ require 'test/unit'
 require 'pathname'
 require 'rubygems'
 
-gem 'thoughtbot-shoulda', '>= 2.10.1'
+gem 'shoulda', '>= 2.10.1'
 gem 'jnunemaker-matchy', '0.4.0'
 gem 'fakeweb', '>= 1.2.5'
 
 require 'shoulda'
 require 'matchy'
 require 'fakeweb'
+require 'redgreen'
 
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: buzzsprout
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Wynn Netherland
@@ -9,79 +14,105 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-26 00:00:00 -06:00
+date: 2010-06-12 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 2
         version: 2.3.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: hashie
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.3
-    version: 
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 0
         version: 0.5.0
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: thoughtbot-shoulda
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: shoulda
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 1
         version: 2.10.1
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: jnunemaker-matchy
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
         version: 0.4.0
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: fakeweb
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
         version: 1.2.5
-    version: 
+  type: :development
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: yard
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id007
 description: Ruby wrapper for the stealth mode Buzzsprout API
 email: wynn.netherland@gmail.com
 executables: []
@@ -94,6 +125,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .yardopts
 - LICENSE
 - README.md
 - Rakefile
@@ -107,7 +139,7 @@ files:
 - test/helper.rb
 - test/test_buzzsprout.rb
 has_rdoc: true
-homepage: http://github.com/pengwynn/buzzsprout
+homepage: http://wynnnetherland.com/projects/buzzsprout
 licenses: []
 
 post_install_message: 
@@ -119,18 +151,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the stealth mode Buzzsprout API