Midna 0.8.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Joost Baaij
+
+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/README.rdoc

@@ -0,0 +1,91 @@
+= midna
+
+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:
+
+  # Information about a Broadcaster, such as AVRO
+  Midna::Broadcaster.find('avro')
+  # All series for the given Broadcaster
+  Midna::Broadcaster.series('avro')
+
+  # all channels
+  Midna::Channel.all
+  # 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.
+
+Also, Midna is Zelda's goth sister.
+
+== Installation in Rails
+
+Install this plugin as a gem.
+
+  For Rails 2, in config/environment.rb
+
+    config.gem 'midna'
+
+  For Rails 3, in Gemfile
+
+    gem 'midna'
+
+Then run <tt>rake gems:install</tt>.
+
+== Usage in plain Ruby
+
+First install the gem on your machine like usual:
+
+  $ gem install midna
+
+Use <tt>sudo</tt> if your setup requires it. After this you can require it in your code and work with Midna from there.
+
+  require 'rubygems'
+  require 'midna'
+
+  puts Midna::Channel.all
+  # => [{"name"=>"Nederland 1", "code"=>"NL1"}, {"name"=>"Nederland 2", "code"=>"NL2"}, {"name"=>"Nederland 3 & Z@pp", "code"=>"NL3"}] 
+
+
+== Configuration
+
+If you are using rails, create a file called <tt>config/initializers/midna.rb</tt> with the following configuration. If you are using the gem, execute these lines before you first call any Midna objects.
+
+The gem connects to <tt>midna.omroep.nl</tt> by default. You can override this by setting the +base_uri+:
+
+  Midna.base_uri = 'http://some.other.host'
+
+== Prerequisites
+
+The HTTparty[http://github.com/jnunemaker/httparty] gem.
+
+  gem install httparty
+
+== Copyright
+
+Copyright (c) 2010 Joost Baaij. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.7.0

data/lib/midna.rb

@@ -0,0 +1,24 @@
+begin
+  require 'httparty'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'httparty', '>= 0.4.4'
+  require 'httparty'
+end
+
+require 'midna/channel'
+require 'midna/episode'
+require 'midna/series'
+require 'midna/broadcast'
+require 'midna/broadcaster'
+
+class Midna
+  include HTTParty
+  base_uri 'http://midna.omroep.nl'
+  format :xml
+  
+  # allow override of the base uri
+  def self.base_uri=(uri)
+    base_uri(uri)
+  end
+end

data/lib/midna/broadcast.rb

@@ -0,0 +1,14 @@
+class Midna
+  class Broadcast
+    # 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/broadcaster.rb

@@ -0,0 +1,13 @@
+class Midna
+  class Broadcaster
+    # Return one Broadcaster based on its +slug+.
+    def self.find(slug)
+      Midna.get("/broadcasters/#{slug}.xml").to_hash['broadcaster']
+    end
+
+    # Return series for a Broadcaster, based on its +slug+.
+    def self.series(slug)
+      Midna.get("/broadcasters/#{slug}/series.xml").to_hash['series']
+    end
+  end
+end

data/lib/midna/channel.rb

@@ -0,0 +1,11 @@
+class Midna
+  class Channel
+    def self.all
+      Midna.get("/channels.xml").to_hash["channels"]
+    end
+    
+    def self.find(code)
+      Midna.get("/channels/#{code}.xml").to_hash["channel"]
+    end
+  end
+end

data/lib/midna/episode.rb

@@ -0,0 +1,44 @@
+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
+    
+    # Returns the last aired Episode for a Series.
+    def self.series_last(id)
+      Midna.get("/series/#{id}/episodes/last.xml").to_hash["episode"]
+    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/lib/midna/version.rb

@@ -0,0 +1,3 @@
+class Midna
+  VERSION = "0.8.0"
+end

data/midna.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "midna/version"
+
+Gem::Specification.new do |s|
+  s.name          = "Midna"
+  s.version       = Midna::VERSION
+  s.authors       = ["Joost Baaij"]
+  s.email         = ["joost@spacebabies.nl"]
+  s.homepage      = "https://github.com/tilsammans/midna"
+  s.summary       = "Ruby interface to the Midna API"
+  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_dependency 'httparty'
+end

data/spec/midna/broadcast_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Midna::Broadcast do
+  its(:class) { should respond_to(:channel) }
+  its(:class) { should respond_to(:channel_window) }
+  
+  describe 'channel' do
+    it "should get /channels/NL1/broadcasts.xml" do
+      hash = stub
+      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/broadcaster_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Midna::Broadcaster do
+  its(:class) { should respond_to(:find) }
+  its(:class) { should respond_to(:series) }
+
+  describe 'find' do
+    it "should get /broadcasters/slug.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/broadcasters/avro.xml").and_return(broadcaster = stub)
+      broadcaster.stub!(:to_hash).and_return({"broadcaster" => hash})
+      Midna::Broadcaster.find('avro').should equal(hash)
+    end
+  end
+
+  describe 'series' do
+    it "should get /broadcasters/slug/series.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/broadcasters/avro/series.xml").and_return(series = stub)
+      series.stub!(:to_hash).and_return({"series" => hash})
+      Midna::Broadcaster.series('avro').should equal(hash)
+    end
+  end
+end

data/spec/midna/channel_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Midna::Channel do
+  its(:class) { should respond_to(:all) }
+  its(:class) { should respond_to(:find) }
+  
+  describe 'all' do
+    it "should get /channels.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/channels.xml").and_return(all = stub)
+      all.stub!(:to_hash).and_return({"channels" => hash})
+      Midna::Channel.all.should equal(hash)
+    end
+  end
+  
+  describe 'find' do
+    it "should get /channel/CODE.xml" do
+      hash = stub
+      Midna.should_receive(:get).with("/channels/NL3.xml").and_return(channel = stub)
+      channel.stub!(:to_hash).and_return({"channel" => hash})
+      Midna::Channel.find('NL3').should equal(hash)
+    end
+  end
+end

data/spec/midna/episode_spec.rb

@@ -0,0 +1,84 @@
+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
+      hash = stub
+      Midna.should_receive(:get).with("/episodes/1138.xml").and_return(episode = stub)
+      episode.stub!(:to_hash).and_return({"episode" => hash})
+      Midna::Episode.find('1138').should equal(hash)
+    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
+    
+    describe "last" do
+      it "should get /series/ID/episodes/last.xml" do
+        hash = stub
+        Midna.should_receive(:get).with("/series/400/episodes/last.xml").and_return(episode = stub)
+        episode.stub!(:to_hash).and_return({"episode" => hash})
+        Midna::Episode.series_last('400').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

data/spec/midna_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "Midna" do
+  it "defines Midna::Channel" do
+    defined?(Midna::Channel).should be_true
+  end
+  
+  it "allows base_uri override" do
+    Midna.base_uri = 'bloep'
+    Midna.base_uri.should == 'http://bloep'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'midna'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+	# some optional config here
+end

data/spec/support/midna.rb

@@ -0,0 +1 @@
+Midna::BASE_URI = 'midna.local'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: Midna
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Joost Baaij
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email:
+- joost@spacebabies.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/midna.rb
+- lib/midna/broadcast.rb
+- lib/midna/broadcaster.rb
+- lib/midna/channel.rb
+- lib/midna/episode.rb
+- lib/midna/series.rb
+- lib/midna/version.rb
+- midna.gemspec
+- spec/midna/broadcast_spec.rb
+- spec/midna/broadcaster_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
+- spec/support/midna.rb
+homepage: https://github.com/tilsammans/midna
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the Midna API
+test_files:
+- spec/midna/broadcast_spec.rb
+- spec/midna/broadcaster_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
+- spec/support/midna.rb