midna 0.3.0 → 0.5.0

data/README.rdoc

@@ -1,13 +1,38 @@
 = midna
 
-Ruby interface to the Midna API.
+Ruby interface to the Midna API. See the [Rdoc]http://rdoc.info/projects/tilsammans/midna on how to use it.
 
 This gem chats with the Midna API so you don't have to. It will give you objects in the Midna namespace, which you can query like Active Record:
 
+  # all channels
   Midna::Channel.all
-  Midna::Channel.find(code)			# alphanumeric; like NL1
-  Midna::Episode.find(id)			# aflevering ID/episode ID from the omroep player
-  Midna::Broadcast.all(code)		# code is Channel code
+  # alphanumeric; like NL1
+  Midna::Channel.find(code)
+
+  # series ID from the omroep player
+  Midna::Series.find(id)
+  # searches the Solr index by series name
+  Midna::Series.search(query)
+
+  # aflevering/episode ID from the omroep player
+  Midna::Episode.find(id)
+  # all episodes for the given Series
+  Midna::Episode.series(id)
+  # all episodes for the given Series in the given time window
+  # start and end are integers (unixtimes)
+  Midna::Episode.series_window(id, start, end)
+  # all episodes for the given Series until the given time
+  # start is an integer (unixtime) and defaults to the current time
+  Midna::Episode.series_until(id, start)
+  # all episodes for the given Series since the given time
+  # start is an integer (unixtime) and defaults to the current time
+  Midna::Episode.series_since(id, start)
+
+  # code is Channel code
+  Midna::Broadcast.channel(code)
+  # all broadcasts for the given Channel in the given time window
+  # start and end are integers (unixtimes)
+  Midna::Broadcast.channel_window(id, start, end)
 
 All of these methods will return hashes or arrays of hashes.
 

data/Rakefile

@@ -10,8 +10,8 @@ begin
     gem.email = "joost@spacebabies.nl"
     gem.homepage = "http://github.com/tilsammans/midna"
     gem.authors = ["Joost Baaij"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_dependency 'httparty'
+    gem.add_dependency "httparty", "~> 0.6.1"
+    gem.add_development_dependency "rspec", "~> 1.2"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.5.0

data/lib/midna.rb

@@ -8,6 +8,7 @@ end
 
 require 'midna/channel'
 require 'midna/episode'
+require 'midna/series'
 require 'midna/broadcast'
 
 class Midna

data/lib/midna/broadcast.rb

@@ -1,7 +1,14 @@
 class Midna
   class Broadcast
-    def self.all(code)
+    # Return broadcasts for a Channel, based on the channel +code+.
+    def self.channel(code)
       Midna.get("/channels/#{code}/broadcasts.xml").to_hash["broadcasts"]
     end
+
+    # Return broadcasts for a Channel in a given time window.
+    # +starttime+ and +endtime+ are integers (unixtimes).
+    def self.channel_window(code, starttime, endtime)
+      Midna.get("/channels/#{code}/broadcasts.xml?start=#{starttime}&end=#{endtime}").to_hash["broadcasts"]
+    end
   end
 end

data/lib/midna/episode.rb

@@ -1,7 +1,39 @@
 class Midna
   class Episode
+    # Return one Episode based on its +id+.
     def self.find(id)
       Midna.get("/episodes/#{id}.xml").to_hash["episode"]
     end
+
+    # Return episodes for a Series, based on the series +id+.
+    def self.series(id)
+      Midna.get("/series/#{id}/episodes.xml").to_hash["episodes"]
+    end
+    
+    # Return episodes for a Series in a given time window.
+    # +starttime+ and +endtime+ are integers (unixtimes).
+    def self.series_window(id, starttime, endtime)
+      Midna.get("/series/#{id}/episodes.xml?start=#{starttime}&end=#{endtime}").to_hash["episodes"]
+    end
+    
+    # Return episodes for a Series until a certain time.
+    # +starttime+ is an integer (unixtime) and defaults to the current time.
+    def self.series_until(id, starttime=nil)
+      if starttime.nil?
+        Midna.get("/series/#{id}/episodes/until.xml").to_hash["episodes"]
+      else
+        Midna.get("/series/#{id}/episodes/until.xml?start=#{starttime}").to_hash["episodes"]
+      end
+    end
+    
+    # Return episodes for a Series since a certain time.
+    # +starttime+ is an integer (unixtime) and defaults to the current time.
+    def self.series_since(id, starttime=nil)
+      if starttime.nil?
+        Midna.get("/series/#{id}/episodes/since.xml").to_hash["episodes"]
+      else
+        Midna.get("/series/#{id}/episodes/since.xml?start=#{starttime}").to_hash["episodes"]
+      end
+    end
   end
 end

data/lib/midna/series.rb

@@ -0,0 +1,11 @@
+class Midna
+  class Series
+    def self.find(id)
+      Midna.get("/series/#{id}.xml").to_hash["series"]
+    end
+    
+    def self.search(query)
+      Midna.get("/series/search.xml?query=#{query}").to_hash["nebo_series"]
+    end
+  end
+end

data/midna.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{midna}
-  s.version = "0.3.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joost Baaij"]
-  s.date = %q{2010-08-06}
+  s.date = %q{2010-09-22}
   s.description = %q{This gem chats with the Midna API so you don’t have to. It will give you objects in the Midna namespace, which you can query like Active Record. All of these methods will return hashes or arrays of hashes.}
   s.email = %q{joost@spacebabies.nl}
   s.extra_rdoc_files = [
@@ -27,10 +27,12 @@ Gem::Specification.new do |s|
      "lib/midna/broadcast.rb",
      "lib/midna/channel.rb",
      "lib/midna/episode.rb",
+     "lib/midna/series.rb",
      "midna.gemspec",
      "spec/midna/broadcast_spec.rb",
      "spec/midna/channel_spec.rb",
      "spec/midna/episode_spec.rb",
+     "spec/midna/series_spec.rb",
      "spec/midna_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -45,6 +47,7 @@ Gem::Specification.new do |s|
     "spec/midna/broadcast_spec.rb",
      "spec/midna/channel_spec.rb",
      "spec/midna/episode_spec.rb",
+     "spec/midna/series_spec.rb",
      "spec/midna_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/midna.rb"
@@ -55,15 +58,15 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.6.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 1.2"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<httparty>, ["~> 0.6.1"])
+      s.add_dependency(%q<rspec>, ["~> 1.2"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<httparty>, ["~> 0.6.1"])
+    s.add_dependency(%q<rspec>, ["~> 1.2"])
   end
 end
 

data/spec/midna/broadcast_spec.rb

@@ -1,14 +1,25 @@
 require 'spec_helper'
 
 describe Midna::Broadcast do
-  its(:class) { should respond_to(:all) }
+  its(:class) { should respond_to(:channel) }
+  its(:class) { should respond_to(:channel_window) }
   
-  describe 'all' do
+  describe 'channel' do
     it "should get /channels/NL1/broadcasts.xml" do
       hash = stub
-      Midna.should_receive(:get).with("/channels/NL1/broadcasts.xml").and_return(all = stub)
-      all.stub!(:to_hash).and_return({"broadcasts" => hash})
-      Midna::Broadcast.all('NL1').should equal(hash)
+      Midna.should_receive(:get).with("/channels/NL1/broadcasts.xml").and_return(channel = stub)
+      channel.stub!(:to_hash).and_return({"broadcasts" => hash})
+      Midna::Broadcast.channel('NL1').should equal(hash)
     end
   end
+  
+  describe 'channel_window' do
+    it "should get /channels/NL1/broadcasts.xml?start=123&end=456" do
+      hash = stub
+      Midna.should_receive(:get).with("/channels/NL1/broadcasts.xml?start=123&end=456").and_return(channels = stub)
+      channels.stub!(:to_hash).and_return({"broadcasts" => hash})
+      Midna::Broadcast.channel_window('NL1', 123, 456).should equal(hash)
+    end
+  end
+
 end

data/spec/midna/episode_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Midna::Episode do
   its(:class) { should respond_to(:find) }
+  its(:class) { should respond_to(:series) }
+  its(:class) { should respond_to(:series_window) }
   
   describe 'find' do
     it "should get /episodes/ID.xml" do
@@ -12,4 +14,62 @@ describe Midna::Episode do
     end
   end
     
+  describe 'series' do
+    it "should get /series/ID/episodes.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/series/400/episodes.xml").and_return(episodes = stub)
+      episodes.stub!(:to_hash).and_return({"episodes" => hash})
+      Midna::Episode.series('400').should equal(hash)
+    end
+  end
+    
+  describe 'series_window' do
+    it "should get /series/ID/episodes?start=123&end=456.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/series/400/episodes.xml?start=123&end=456").and_return(episodes = stub)
+      episodes.stub!(:to_hash).and_return({"episodes" => hash})
+      Midna::Episode.series_window('400', 123, 456).should equal(hash)
+    end
+  end
+    
+  describe 'series_until' do
+    describe 'without time' do
+      it "should get /series/ID/episodes/until.xml" do
+        hash = stub
+        Midna.should_receive(:get).with("/series/400/episodes/until.xml").and_return(episodes = stub)
+        episodes.stub!(:to_hash).and_return({"episodes" => hash})
+        Midna::Episode.series_until('400').should equal(hash)
+      end
+    end
+
+    describe 'with time' do
+      it "should get /series/ID/episodes/until.xml" do
+        hash = stub
+        Midna.should_receive(:get).with("/series/400/episodes/until.xml?start=123").and_return(episodes = stub)
+        episodes.stub!(:to_hash).and_return({"episodes" => hash})
+        Midna::Episode.series_until('400', 123).should equal(hash)
+      end
+    end
+  end
+    
+  describe 'series_since' do
+    describe 'without time' do
+      it "should get /series/ID/episodes/since.xml" do
+        hash = stub
+        Midna.should_receive(:get).with("/series/400/episodes/since.xml").and_return(episodes = stub)
+        episodes.stub!(:to_hash).and_return({"episodes" => hash})
+        Midna::Episode.series_since('400').should equal(hash)
+      end
+    end
+
+    describe 'with time' do
+      it "should get /series/ID/episodes/since.xml" do
+        hash = stub
+        Midna.should_receive(:get).with("/series/400/episodes/since.xml?start=123").and_return(episodes = stub)
+        episodes.stub!(:to_hash).and_return({"episodes" => hash})
+        Midna::Episode.series_since('400', 123).should equal(hash)
+      end
+    end
+  end
+    
 end

data/spec/midna/series_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Midna::Series do
+  its(:class) { should respond_to(:find) }
+  its(:class) { should respond_to(:search) }
+  
+  describe 'find' do
+    it "should get /series/ID.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/series/1200.xml").and_return(series = stub)
+      series.stub!(:to_hash).and_return({"series" => hash})
+      Midna::Series.find(1200).should equal(hash)
+    end
+  end
+  
+  describe 'search' do
+    it "should get /series/search.xml?query=QUERY" do
+      hash = stub
+      Midna.should_receive(:get).with("/series/search.xml?query=sesam").and_return(series = stub)
+      series.stub!(:to_hash).and_return({"nebo_series" => hash})
+      Midna::Series.search('sesam').should equal(hash)
+    end
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: midna
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 5
   - 0
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Joost Baaij
@@ -15,38 +15,39 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-09-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 13
+        hash: 5
         segments: 
+        - 0
+        - 6
         - 1
-        - 2
-        - 9
-        version: 1.2.9
-  type: :development
+        version: 0.6.1
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 11
         segments: 
-        - 0
-        version: "0"
-  type: :runtime
+        - 1
+        - 2
+        version: "1.2"
+  type: :development
   version_requirements: *id002
 description: "This gem chats with the Midna API so you don\xE2\x80\x99t have to. It will give you objects in the Midna namespace, which you can query like Active Record. All of these methods will return hashes or arrays of hashes."
 email: joost@spacebabies.nl
@@ -68,10 +69,12 @@ files:
 - lib/midna/broadcast.rb
 - lib/midna/channel.rb
 - lib/midna/episode.rb
+- lib/midna/series.rb
 - midna.gemspec
 - spec/midna/broadcast_spec.rb
 - spec/midna/channel_spec.rb
 - spec/midna/episode_spec.rb
+- spec/midna/series_spec.rb
 - spec/midna_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -114,6 +117,7 @@ test_files:
 - spec/midna/broadcast_spec.rb
 - spec/midna/channel_spec.rb
 - spec/midna/episode_spec.rb
+- spec/midna/series_spec.rb
 - spec/midna_spec.rb
 - spec/spec_helper.rb
 - spec/support/midna.rb