midna 0.0.0 → 0.1.0

data/README.rdoc

@@ -2,10 +2,54 @@
 
 Ruby interface to the Midna API.
 
-This gem chats with the Midna API so you don't have to bother with GETs and POSTs and such. It will give you objects in the Midna namespace, so they don't even clash with your existing ones.
+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:
+
+  Midna::Channel.all
 
 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>.
+
+== Installation as a Ruby gem
+
+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
+  # => {"channels" => [ an array of hashes ]}
+
+== 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/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/midna.rb

@@ -0,0 +1,20 @@
+begin
+  require 'httparty'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'httparty', '>= 0.4.4'
+  require 'httparty'
+end
+
+require 'midna/channel'
+
+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/channel.rb

@@ -0,0 +1,7 @@
+class Midna
+  class Channel
+    def self.all
+      Midna.get("/channels.xml").to_hash
+    end
+  end
+end

data/midna.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{midna}
-  s.version = "0.0.0"
+  s.version = "0.1.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-03}
+  s.date = %q{2010-08-04}
   s.description = %q{This gem chats with the Midna API so you don't have to bother with GETs and POSTs and such. It will give you objects in the Midna namespace, so they don't even clash with your existing ones. Also, Midna is Zelda's goth sister.}
   s.email = %q{joost@spacebabies.nl}
   s.extra_rdoc_files = [
@@ -24,10 +24,13 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "lib/midna.rb",
+     "lib/midna/channel.rb",
      "midna.gemspec",
+     "spec/midna/channel_spec.rb",
      "spec/midna_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "spec/support/midna.rb"
   ]
   s.homepage = %q{http://github.com/tilsammans/midna}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -35,8 +38,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Ruby interface to the Midna API}
   s.test_files = [
-    "spec/midna_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/midna/channel_spec.rb",
+     "spec/midna_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/midna.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/midna/channel_spec.rb

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

data/spec/midna_spec.rb

@@ -1,7 +1,12 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 describe "Midna" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+  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_helper.rb

@@ -4,6 +4,10 @@ require 'midna'
 require 'spec'
 require 'spec/autorun'
 
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
 Spec::Runner.configure do |config|
   
 end

data/spec/support/midna.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: midna
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Joost Baaij
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-03 00:00:00 +02:00
+date: 2010-08-04 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,10 +51,13 @@ files:
 - Rakefile
 - VERSION
 - lib/midna.rb
+- lib/midna/channel.rb
 - midna.gemspec
+- spec/midna/channel_spec.rb
 - spec/midna_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+- spec/support/midna.rb
 has_rdoc: true
 homepage: http://github.com/tilsammans/midna
 licenses: []
@@ -90,5 +93,7 @@ signing_key:
 specification_version: 3
 summary: Ruby interface to the Midna API
 test_files: 
+- spec/midna/channel_spec.rb
 - spec/midna_spec.rb
 - spec/spec_helper.rb
+- spec/support/midna.rb