bartzon-zelda 0.0.3 → 0.0.5

data/README.rdoc

@@ -1,48 +1,7 @@
 = zelda
 
-* http://github.com/#{github_username}/#{project_name}
+* http://github.com/bartzon/zelda
 
 == DESCRIPTION:
 
-FIX (describe your package)
-
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* FIX (list of requirements)
-
-== INSTALL:
-
-* FIX (sudo gem install, anything else)
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 FIXME full name
-
-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.
+If you don't know what this is, you probably don't need it :).

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.5

data/lib/zelda.rb

@@ -9,6 +9,7 @@ rescue LoadError
   require 'httparty'
 end
 
+require 'zelda/base'
 require 'zelda/request'
 require 'zelda/zender'
 require 'zelda/omroep'
@@ -16,7 +17,7 @@ require 'zelda/serie'
 require 'zelda/aflevering'
 
 module Zelda
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 
   class ZeldaError < StandardError;        end
   class ZeldaCollectionError < ZeldaError; end

data/lib/zelda/aflevering.rb

@@ -1,15 +1,4 @@
 module Zelda
-  class Aflevering
-    def initialize(vars={})
-      @attrs = vars
-    end
-    
-    def method_missing(method, *args, &block)
-      if @attrs[method]
-        return @attrs[method]
-      else
-        super(method, *args, &block)
-      end
-    end
+  class Aflevering < Zelda::Base    
   end
 end

data/lib/zelda/base.rb

@@ -0,0 +1,24 @@
+module Zelda
+  # Abstract base class to provide common functionality of Zelda importer classes.
+  # including method_missing magic to turn an @attrs hash into getters.
+  class Base
+    def initialize(attrs={})
+      @attrs = attrs
+    end
+
+    def attributes
+      @attrs
+    end    
+
+    # Try both string keys and symbol keys in that order.
+    def method_missing(method, *args, &block)
+      if @attrs[method.to_s]
+        return @attrs[method.to_s]
+      elsif @attrs[method]
+        return @attrs[method]
+      else
+        super(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/zelda/omroep.rb

@@ -1,8 +1,9 @@
 module Zelda
-  class Omroep
+  class Omroep < Zelda::Base
     class << self
-      def find(id)
-        new Request.get("omroepen/#{id}")['omroep']
+      def find(slug)
+        attrs = Request.get("omroepen/#{slug}")['omroep'] rescue nil
+        attrs ? new(attrs) : nil
       end
       
       def all
@@ -10,24 +11,10 @@ module Zelda
       end
     end
     
-    def initialize(attrs={})
-      @attrs = attrs
-    end
-    
-    def id
-      @attrs['id']
-    end
-    
-    def name
-      @attrs['name']
-    end
-    
     def series
-      objects = []
-      Zelda::Request.get("omroepen/#{id}/series")['series'].each do |attrs|
-        objects << Zelda::Serie.new(attrs)
+      Zelda::Request.get("omroepen/#{slug}/series")['omroep']['series']['serie'].map do |attrs|
+        Zelda::Serie.new(attrs)
       end
-      objects
     end
   end
 end

data/lib/zelda/request.rb

@@ -1,7 +1,15 @@
 module Zelda
   class Request
     def self.get(url)
-      HTTParty.get parse_url(url)
+      result = HTTParty.get parse_url(url)
+      
+      if result
+        %w(created_at updated_at id).each do |key|
+          result.delete(key) if result[key]
+        end
+      end
+
+      result
     end
     
     def self.parse_url(*args)

data/lib/zelda/serie.rb

@@ -1,12 +1,13 @@
 module Zelda
-  class Serie
+  class Serie < Zelda::Base
     class << self
       def search(query)
         Request.get("series/search/#{query}")['series']
       end
       
       def find(id)
-        new Request.get("series/#{id}")
+        attrs = Request.get("series/#{id}")['serie'] rescue nil
+        attrs ? new(attrs) : nil
       end
       
       def all
@@ -14,39 +15,36 @@ module Zelda
       end
     end
   
-    def initialize(attrs={})
-      @attrs = attrs
-    end
-    
-    def name
-      @attrs["serie"]["name"]
-    end
-  
-    def serieid
-      @attrs["serie"]["serieid"]
-    end
-  
-    def afleveringen
-      @afleveringen ||= get_afleveringen()
+    def afleveringen(van=nil, tot=nil)
+      get_afleveringen(:van => van, :tot => tot)
     end
 
     def upcoming_afleveringen
-      @upcoming_afleveringen ||= get_afleveringen("upcoming")
+      get_afleveringen(:collection => "upcoming")
     end
   
     def past_afleveringen
-      @past_afleveringen ||= get_afleveringen("past")
+      get_afleveringen(:collection => "past")
     end
   
     private
-      def get_afleveringen(timestamp=nil)
-        url = [ "series", serieid, "afleveringen", timestamp ].join("/")
+      def get_afleveringen(*args)
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
 
-        objects = []
-        Request.get(url)["afleveringen"].each do |vars|
-          objects << Zelda::Aflevering.new(vars)
+        Request.get(url)["afleveringen"].map do |vars|
+          Zelda::Aflevering.new(vars)
+        end
+      end
+      
+      def url
+        if collection = @options[:collection]
+          [ "series", serieid, "afleveringen", collection ].join("/")
+        elsif @options[:van] && @options[:tot]
+          van, tot = @options[:van], @options[:tot]
+          [ "series", serieid, "afleveringen" ].join("/") + "?van=#{van.to_i}&tot=#{tot.to_i}"
+        else
+          [ "series", serieid, "afleveringen" ].join("/")
         end
-        objects
       end
   end
 end

data/lib/zelda/zender.rb

@@ -1,8 +1,9 @@
 module Zelda
-  class Zender
+  class Zender < Zelda::Base
     class << self
       def find(id)
-        new Request.get("zenders/#{id}")
+        attrs = Request.get("zenders/#{id}")
+        attrs ? new(attrs) : nil
       end
       
       def all
@@ -10,10 +11,6 @@ module Zelda
       end
     end
     
-    def initialize(attrs={})
-      @attrs = attrs
-    end
-    
     def name
       @attrs["zender"]["name"]
     end

data/spec/spec_helper.rb

@@ -8,6 +8,10 @@ end
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
 require 'zelda'
 
 module Zelda

data/spec/support/shared_examples.rb

@@ -0,0 +1,9 @@
+shared_examples_for "a zelda base model" do
+  it "should respond to the attributes set in the constructor" do
+    @model.foo.should == 'bar'
+  end
+  
+  it "should not respond to attributes not set in the constructor" do
+    lambda { @model.no_not_here_nope }.should raise_error(NoMethodError)
+  end
+end

data/spec/zelda/aflevering_spec.rb

@@ -1,17 +1,13 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Zelda::Aflevering do
-  it "should accept attributes when being initialized" do
-    Zelda::Aflevering.new(:foo => "bar").should be_a(Zelda::Aflevering)
+  before do
+    @model = Zelda::Aflevering.new(:foo => "bar")
   end
   
-  it "should respond to the attributes set in the constructor" do
-    afl = Zelda::Aflevering.new(:foo => "bar")
-    afl.foo.should == 'bar'
-  end
+  it_should_behave_like 'a zelda base model'
   
-  it "should not respond to attributes not set in the constructor" do
-    afl = Zelda::Aflevering.new(:foo => "bar")
-    lambda { afl.bar }.should raise_error(NoMethodError)
-  end
+  it "should accept attributes when being initialized" do
+    Zelda::Aflevering.new(:foo => "bar").should be_a(Zelda::Aflevering)
+  end  
 end

data/spec/zelda/omroep_spec.rb

@@ -1,6 +1,12 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Zelda::Omroep do
+  before do
+    @model = Zelda::Omroep.new(:foo => "bar")
+  end
+  
+  it_should_behave_like 'a zelda base model'
+
   describe "when retrieving a list of omroepen" do
     it "should call Zelda with the correct url" do
       Zelda::Request.should_receive(:get).with("omroepen")
@@ -10,16 +16,16 @@ describe Zelda::Omroep do
   
   describe "when retrieving a specific omroep" do
     before(:each) do
-      omroep_attrs = { "omroep" => {"id" => "1", "name" => "KRO"} }
-      Zelda::Request.stub!(:get).with("omroepen/1").and_return omroep_attrs
+      omroep_attrs = { "omroep" => {"slug" => "kro", "name" => "KRO"} }
+      Zelda::Request.stub!(:get).with("omroepen/kro").and_return omroep_attrs
     end
     
     def find_omroep
-      Zelda::Omroep.find(1)
+      Zelda::Omroep.find('kro')
     end
     
     it "should call Zelda with the correct url" do
-      Zelda::Request.should_receive(:get).with("omroepen/1")
+      Zelda::Request.should_receive(:get).with("omroepen/kro")
       find_omroep
     end
     
@@ -27,8 +33,13 @@ describe Zelda::Omroep do
       find_omroep.should be_a(Zelda::Omroep)
     end
     
-    it "should return the correct id" do
-      find_omroep.id.should == "1"
+    it "should return nil if the omroep cannot be found" do
+      Zelda::Request.stub!(:get).and_return nil
+      find_omroep.should be_nil
+    end
+    
+    it "should return the correct slug" do
+      find_omroep.slug.should == "kro"
     end
     
     it "should return the correct name" do
@@ -38,9 +49,9 @@ describe Zelda::Omroep do
   
   describe "when retrieving the series for an omroep" do
     before(:each) do
-      @omroep = Zelda::Omroep.new('id' => 1)
+      @omroep = Zelda::Omroep.new('slug' => 'kro')
       
-      Zelda::Request.stub!(:get).and_return('series' => [{'foo' => 'bar'}])
+      Zelda::Request.stub!(:get).and_return('omroep' => {'series' => {'serie' => [{'foo' => 'bar'}]}})
     end
     
     def find_series
@@ -48,7 +59,7 @@ describe Zelda::Omroep do
     end
     
     it "should call Zelda with the correct url" do
-      Zelda::Request.should_receive(:get).with("omroepen/1/series")
+      Zelda::Request.should_receive(:get).with("omroepen/kro/series")
       find_series
     end
     

data/spec/zelda/request_spec.rb

@@ -2,10 +2,22 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe Zelda::Request do
   it "should call HTTParty" do
-    HTTParty.should_receive(:get).with("http://zelda.omroep.nl/12345/foo")
+    HTTParty.should_receive(:get).with("http://zelda.omroep.nl/12345/foo").and_return nil
     Zelda::Request.get('foo')
   end
 
+  it "should remove private attributes" do
+    attrs = { 'foo' => "bar", 'created_at' => "foo", 'updated_at' => "bar", 'id' => 10 }
+    HTTParty.stub!(:get).and_return(attrs)
+    
+    attrs = Zelda::Request.get('foo')
+    
+    attrs['created_at'].should be_nil
+    attrs['updated_at'].should be_nil
+    attrs['id'].should be_nil
+    attrs['foo'].should == 'bar'
+  end
+
   it "should raise an error without an API key" do
     api_key = Zelda.send(:remove_const, :API_KEY)
     lambda { Zelda::Request.get('foo') }.should raise_error("No Zelda::API_KEY specified")

data/spec/zelda/serie_spec.rb

@@ -29,10 +29,15 @@ describe Zelda::Serie do
     it "should return a new Zender" do
       find_serie.should be_a(Zelda::Serie)
     end
+
+    it "should return nil if the zender cannot be found" do
+      Zelda::Request.stub!(:get).and_return nil
+      find_serie.should be_nil
+    end
     
     it "should send the correct request when asked for afleveringen" do
       serie = find_serie
-      Zelda::Request.should_receive(:get).with("series/POW_00243538/afleveringen/").and_return("afleveringen" => ["foo"])
+      Zelda::Request.should_receive(:get).with("series/POW_00243538/afleveringen").and_return("afleveringen" => ["foo"])
       serie.afleveringen.should == [@aflevering]
     end
 

data/spec/zelda/zender_spec.rb

@@ -27,6 +27,11 @@ describe Zelda::Zender do
       find_zender.should be_a(Zelda::Zender)
     end
     
+    it "should return nil if the zender cannot be found" do
+      Zelda::Request.stub!(:get).and_return nil
+      find_zender.should be_nil
+    end
+    
     it "should return the correct name" do
       find_zender.name.should == "Nederland 1"
     end

data/zelda.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{zelda}
-  s.version = "0.0.3"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bart Zonneveld"]
-  s.date = %q{2009-08-26}
+  s.date = %q{2009-09-01}
   s.description = %q{ }
   s.email = %q{loop@superinfinite.com}
   s.extra_rdoc_files = [
@@ -20,12 +20,12 @@ Gem::Specification.new do |s|
     ".gitignore",
      "History.txt",
      "Manifest.txt",
-     "PostInstall.txt",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "lib/zelda.rb",
      "lib/zelda/aflevering.rb",
+     "lib/zelda/base.rb",
      "lib/zelda/omroep.rb",
      "lib/zelda/request.rb",
      "lib/zelda/serie.rb",
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "script/generate",
      "spec/spec.opts",
      "spec/spec_helper.rb",
+     "spec/support/shared_examples.rb",
      "spec/zelda/aflevering_spec.rb",
      "spec/zelda/omroep_spec.rb",
      "spec/zelda/request_spec.rb",
@@ -48,10 +49,11 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{zelda}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.4}
   s.summary = %q{}
   s.test_files = [
     "spec/spec_helper.rb",
+     "spec/support/shared_examples.rb",
      "spec/zelda/aflevering_spec.rb",
      "spec/zelda/omroep_spec.rb",
      "spec/zelda/request_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bartzon-zelda
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors: 
 - Bart Zonneveld
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 00:00:00 -07:00
+date: 2009-09-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,12 +35,12 @@ files:
 - .gitignore
 - History.txt
 - Manifest.txt
-- PostInstall.txt
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/zelda.rb
 - lib/zelda/aflevering.rb
+- lib/zelda/base.rb
 - lib/zelda/omroep.rb
 - lib/zelda/request.rb
 - lib/zelda/serie.rb
@@ -50,6 +50,7 @@ files:
 - script/generate
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb
 - spec/zelda/aflevering_spec.rb
 - spec/zelda/omroep_spec.rb
 - spec/zelda/request_spec.rb
@@ -87,6 +88,7 @@ specification_version: 3
 summary: ""
 test_files: 
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb
 - spec/zelda/aflevering_spec.rb
 - spec/zelda/omroep_spec.rb
 - spec/zelda/request_spec.rb

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-For more information on zelda, see http://zelda.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-