almodovar 0.0.1

data/README.rdoc

@@ -0,0 +1,57 @@
+=Almodovar
+
+Almodovar is a client for BeBanjo Movida API written in Ruby
+  
+==Getting started
+
+Install the gem (make sure you have http://rubygems.org in your gem source list):
+
+  $ [sudo] gem install almodovar
+  
+Now, let's play with irb:
+
+  >> require 'almodovar'
+  => true
+
+First you need an authentication token:  
+
+  >> auth = Almodovar::DigestAuth.new("realm", "user", "password")
+  => #<Almodovar::DigestAuth:0x101f846c8 @password="secret", @username="robot_five", @realm="Staging Movida", @domain=nil>
+  
+Now you have to instantiate a resource given its URL. Let's try with the root of the api:
+  
+  >> movida = Almodovar::Resource("http://movida.example.com/api", auth)
+  => <movida>
+  <link href="http://movida.example.com/api/titles" rel="titles"/>
+  <link href="http://movida.example.com/api/platforms" rel="platforms"/>
+  <link href="http://movida.example.com/api/title_groups" rel="title_groups"/>
+  </movida>
+  
+Ok. Let's see what we have under _platforms_
+  
+  >> movida.platforms
+  => [<platform>
+  <name>YouTube</name>
+  <link href="http://movida.example.com/api/platforms/5/schedule" rel="schedule"/>
+  </platform>, <platform>
+  <name>Vimeo</name>
+  <link href="http://movida.example.com/api/platforms/6/schedule" rel="schedule"/>
+  </platform>]
+  
+Now, show me the _schedule_ of the first _platform_:
+  
+  >> movida.platforms.first.schedule
+  => <schedule>
+  <link href="http://movida.example.com/api/platforms/1/schedule/schedulings" rel="schedulings"/>
+  <link href="http://movida.example.com/api/platforms/1" rel="platform"/>
+  </schedule>
+  
+Next, explore and see the {docs of the API}[http://wiki.github.com/bebanjo/almodovar/] to know about other resources.
+  
+==To-do
+
+* Ability to use parameters in linked resource calls (e.g. <tt>movida.titles(:external_id => "C51234500001")</tt>)
+* Memoize linked resource calls so that the same request isn't make several times
+* Ability to take advantage of the API _expand_ functionality (e.g. <tt>movida.titles(:expand => [:schedule, :schedulings]).schedule.schedulings</tt>)
+
+Copyright (c) 2008 BeBanjo S.L., released under the MIT license

data/lib/almodovar.rb

@@ -0,0 +1,71 @@
+require 'resourceful'
+require 'nokogiri'
+
+module Almodovar
+  
+  class DigestAuth < Resourceful::DigestAuthenticator
+  end
+  
+  class Resource
+    def initialize(auth, xml)
+      @auth = auth
+      @xml = xml
+    end
+    
+    def inspect
+      @xml.to_s
+    end
+    
+    private
+    
+    def method_missing(meth, *args, &blk)
+      attribute = @xml.at_xpath("./*[name()='#{meth}']")
+      return node_text(attribute) if attribute
+      
+      link = @xml.at_xpath("./link[@rel='#{meth}']")
+      return get_linked_resource(link) if link
+      
+      super
+    end
+    
+    def get_linked_resource(link)
+      expansion = link.at_xpath("./*")
+      expansion ? Almodovar.instantiate(expansion, @auth) : Almodovar::Resource(link['href'], @auth)
+    end
+    
+    def node_text(node)
+      case node['type']
+      when "integer": node.text.to_i
+      when "datetime": Time.parse(node.text)
+      else
+        node.text
+      end
+    end
+  end
+  
+  def self.Resource(url, auth, params = {})
+    http = Resourceful::HttpAccessor.new(:authenticator => auth)
+    response = http.resource(add_params(url, params)).get
+    instantiate Nokogiri.parse(response.body).root, auth
+  end
+  
+  def self.instantiate(node, auth)
+    if node['type'] == 'array'
+      node.xpath("./*").map { |subnode| Resource.new(auth, subnode) }
+    else
+      Resource.new(auth, node)
+    end
+  end
+  
+  def self.add_params(url, options)
+    options[:expand] = options[:expand].join(",") if options[:expand].is_a?(Array)
+    params = options.map { |k, v| "#{k}=#{v}" }.join("&")
+    params = "?#{params}" unless params.empty?
+    url + params
+  end
+  
+  def self.ResourceCollection(*args)
+    ResourceCollection.new(*args)
+  end
+  
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: almodovar
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- BeBanjo S.L.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resourceful
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: steak
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: 
+email: ballsbreaking@bebanjo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/almodovar.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://wiki.github.com/bebanjo/almodovar/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: BeBanjo Movida API client
+test_files: []
+