crohr-restfully 0.0.0 → 0.1.1

data/Rakefile

@@ -8,9 +8,10 @@ begin
     gem.summary = %Q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.}
     gem.description = %Q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow HATEOAS principles and provide OPTIONS methods and/or Allow headers.}
     gem.email = "cyril.rohr@gmail.com"
-    gem.homepage = "http://github.com/cryx/restfully"
+    gem.homepage = "http://github.com/crohr/restfully"
     gem.authors = ["Cyril Rohr"]
-    gem.add_dependency "rest-client"
+    gem.add_dependency "rest-client"    
+    
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
 

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.1

data/bin/restfully

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# The command line Restfully client
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'restfully'
+require 'optparse'
+require 'logger'
+require 'pp'
+
+@options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: restfully base_url [root_uri] [options]"
+
+  opts.on("-u=", "--username=", "Sets the username") do |u|
+    @options['username'] = u
+  end
+  opts.on("-p=", "--password=", "Sets the user password") do |p|
+    @options['password'] = p
+  end
+  opts.on("-c=", "--config=", "Sets the various options based on a custom YAML configuration file") do |v|
+    @options['configuration_file'] = v
+  end
+  opts.on("-v", "--verbose", "Run verbosely") do |v|
+    @options['verbose'] = v
+  end
+  opts.on("--log=", "Outputs log messages to the given file. Defaults to stdout") do |v|
+    @options['log'] = v
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+end
+
+option_parser.parse!
+
+@base_url = ARGV.shift
+@root_uri = ARGV.shift || "/"
+
+if (config_filename = @options.delete('configuration_file')) && File.exists?(File.expand_path(config_filename))
+  config = YAML.load_file(File.expand_path(config_filename))
+  @base_url = config.delete('base_url') || @base_url
+  @root_uri = config.delete('root_uri') || @root_uri
+  @options.merge!(config)
+end
+
+unless @base_url
+  $stderr.puts option_parser.help
+  exit(-1)
+else
+  if (log_file=@options.delete('log'))
+    @logger = Logger.new(File.expand_path(log_file))
+  else
+    @logger = Logger.new(STDOUT)
+  end
+  if @options.delete('verbose')
+    @logger.level = Logger::DEBUG
+  else
+    @logger.level = Logger::WARN
+  end
+
+  def session
+    @session ||= Restfully::Session.new(@base_url, @options.merge('root' => @root_uri, 'logger' => @logger))
+  end
+  def root 
+    @root ||= Restfully::Resource.new(session.root, session).load
+  end
+  
+  root # preloads
+  
+  require 'irb'
+  require 'irb/completion'
+  
+  ARGV.clear
+  IRB.start
+  exit!
+end

data/examples/grid5000.rb

@@ -9,7 +9,7 @@ logger.level = Logger::INFO
 # Restfully.adapter = Restfully::HTTP::RestClientAdapter
 # Restfully.adapter = Patron::Session
 RestClient.log = 'stdout'
-Restfully::Session.new('https://localhost:3443/sid', 'root' => '/versions/current', 'logger' => logger) do |grid, session|
+Restfully::Session.new('https://localhost:3443/sid', 'root' => '/grid5000', 'logger' => logger) do |grid, session|
   grid_stats = {'hardware' => {}, 'system' => {}}
   grid.sites.each do |site_uid, site|
     site_stats = site.status.inject({'hardware' => {}, 'system' => {}}) {|accu, (node_uid, node_status)|
@@ -24,7 +24,4 @@ Restfully::Session.new('https://localhost:3443/sid', 'root' => '/versions/curren
   p [:total, grid_stats]
   puts "Getting status of a few nodes in rennes:"
   pp grid.sites['rennes'].status(:query => {:only => ['paradent-1', 'paradent-10', 'paramount-3']})
-  
-  # TODO: Auto discovery of allowed HTTP methods: create raises an error if not available, otherwise POSTs the given object (and auto-select the content-type)
-  # grid.sites["rennes"].jobs.create({:walltime => 120, :whatever => ''})
 end

data/lib/restfully.rb

@@ -1,41 +1,12 @@
-class BasicObject #:nodoc:
-  instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
-end unless defined?(BasicObject)
-
-# monkey patching:
-class Hash
-  def symbolize_keys
-    inject({}) do |options, (key, value)|
-      options[(key.to_sym rescue key) || key] = value
-      options
-    end
-  end
-
-  def to_params
-    params = ''
-
-    each do |k, v|
-      if v.is_a?(Array)
-        params << "#{k}=#{v.join(",")}&"
-      else
-        params << "#{k}=#{v.to_s}&"
-      end
-    end
-
-    params.chop! 
-    params
-  end
-
-end
 
 module Restfully
   class RestfullyError < StandardError; end
 end
 
-require File.dirname(__FILE__)+'/restfully/parsing'
-require File.dirname(__FILE__)+'/restfully/session'
-require File.dirname(__FILE__)+'/restfully/special_hash'
-require File.dirname(__FILE__)+'/restfully/special_array'
-require File.dirname(__FILE__)+'/restfully/link'
-require File.dirname(__FILE__)+'/restfully/resource'
-require File.dirname(__FILE__)+'/restfully/collection'
+require 'restfully/extensions'
+require 'restfully/session'
+require 'restfully/special_hash'
+require 'restfully/special_array'
+require 'restfully/link'
+require 'restfully/resource'
+require 'restfully/collection'

data/lib/restfully/collection.rb

@@ -32,6 +32,7 @@ module Restfully
         self
       else
         @raw = session.get(path, options) if raw.nil? || force_reload
+        @items.clear
         raw.each do |key, value|
           next if key == 'links'
           self_link = (value['links'] || []).map{|link| Link.new(link)}.detect{|link| link.self?}
@@ -46,6 +47,21 @@ module Restfully
       end
     end
     
+    def inspect(options = {:space => "     "})
+      output = "#<#{self.class}:0x#{self.object_id.to_s(16)}"
+      if loaded?
+        output += "\n#{options[:space]}------------ META ------------"
+        output += "\n#{options[:space]}@uri: #{uri.inspect}"
+        unless @items.empty?        
+          output += "\n#{options[:space]}------------ PROPERTIES ------------"
+          @items.each do |key, value|
+            output += "\n#{options[:space]}#{key.inspect} => #{value.class.name}"
+          end
+        end
+      end
+      output += ">"
+    end
+    
     
   end
 end

data/lib/restfully/extensions.rb

@@ -0,0 +1,41 @@
+class BasicObject #:nodoc:
+  instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
+end unless defined?(BasicObject)
+
+# monkey patching:
+class Hash
+  # Taken from ActiveSupport
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  # Taken from ActiveSupport  
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+
+
+  # This is by no means the standard way to transform ruby objects into query parameters
+  # but it is targeted at our own needs
+  def to_params
+    params = ''
+
+    each do |k, v|
+      if v.is_a?(Array)
+        params << "#{k}=#{v.join(",")}&"
+      else
+        params << "#{k}=#{v.to_s}&"
+      end
+    end
+
+    params.chop! 
+    params
+  end
+
+end

data/lib/restfully/link.rb

@@ -1,7 +1,7 @@
 module Restfully
   class Link
     
-    VALID_RELATIONSHIPS = %w{member parent collection self}
+    VALID_RELATIONSHIPS = %w{member parent collection self alternate}
     RELATIONSHIPS_REQUIRING_TITLE = %w{collection member}
     
     attr_reader :rel, :title, :href, :errors

data/lib/restfully/resource.rb

@@ -5,13 +5,13 @@ module Restfully
   # Suppose that the load method has been called on the resource before trying to access its attributes or associations
   
   class Resource < DelegateClass(Hash)
+    
     undef :type
-    attr_reader :uri, :session, :state, :raw, :uid, :associations
+    attr_reader :uri, :session, :state, :raw, :uid, :associations, :type
 
     def initialize(uri, session, options = {})
       @uri = uri
       @session = session
-      @parent = options['parent']
       @raw = options['raw']
       @state = :unloaded
       @attributes = {}
@@ -23,7 +23,7 @@ module Restfully
     
     def method_missing(method, *args)
       if association = @associations[method.to_s]
-        session.logger.debug "loading association #{method} with #{args.inspect}"
+        session.logger.debug "Loading association #{method}, args=#{args.inspect}"
         association.load(*args)
       else
         super(method, *args)
@@ -51,7 +51,8 @@ module Restfully
         raw.each do |key, value|
           case key
           when 'links'  then  next
-          when 'uid'   then  @uid = value
+          when 'uid'    then  @uid = value
+          when 'type'   then  @type = value
           else
             case value
             when Hash
@@ -72,10 +73,32 @@ module Restfully
       @associations.has_key?(method.to_s) || super(method, *args)
     end
     
+    def inspect(options = {:space => "     "})
+      output = "#<#{self.class}:0x#{self.object_id.to_s(16)}"
+      if loaded?
+        output += "\n#{options[:space]}------------ META ------------"
+        output += "\n#{options[:space]}@uri: #{uri.inspect}"
+        output += "\n#{options[:space]}@uid: #{uid.inspect}"
+        output += "\n#{options[:space]}@type: #{type.inspect}"
+        @associations.each do |title, assoc|
+          output += "\n#{options[:space]}@#{title}: #{assoc.class.name}"
+        end
+        unless @attributes.empty?
+          output += "\n#{options[:space]}------------ PROPERTIES ------------"
+          @attributes.each do |key, value|
+            output += "\n#{options[:space]}#{key.inspect} => #{value.inspect}"
+          end
+        end
+      end
+      output += ">"
+    end    
+    
     protected
     def define_link(link)
       if link.valid?
         case link.rel
+        when 'parent'
+          @associations['parent'] = Resource.new(link.href, session)
         when 'collection'
           raw_included = link.resolved? ? raw[link.title] : nil
           @associations[link.title] = Collection.new(link.href, session, 
@@ -86,7 +109,7 @@ module Restfully
           @associations[link.title] = Resource.new(link.href, session, 
             'raw' => raw_included)
         when 'self'
-          # uri is supposed to be equal to link['href'] for self relations. so we do nothing
+          @uri = link.href
         end
       else 
         session.logger.warn link.errors.join("\n")

data/lib/restfully/session.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'logger'
 require 'restclient'
+require 'restfully/parsing'
 
 module Restfully
   class Error < StandardError; end
@@ -16,10 +17,11 @@ module Restfully
     
     # TODO: use CacheableResource
     def initialize(base_url, options = {})
+      options = options.stringify_keys
       @base_url = base_url
       @root = options['root'] || '/'
       @logger = options['logger'] || NullLogger.new 
-      @user = options['user']
+      @username = options['username']
       @password = options['password']
       # TODO: generalize
       # @connection = Patron::Session.new
@@ -29,7 +31,7 @@ module Restfully
       # @connection.insecure = true
       # @connection.username = @user
       # @connection.password = @password      
-      @connection = RestClient::Resource.new(base_url || '', :user => @user, :password => @password)
+      @connection = RestClient::Resource.new(base_url || '', :user => @username, :password => @password)
       yield Resource.new(root, self).load, self if block_given?
     end
     

data/restfully.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{restfully}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cyril Rohr"]
+  s.date = %q{2009-09-15}
+  s.default_executable = %q{restfully}
+  s.description = %q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow HATEOAS principles and provide OPTIONS methods and/or Allow headers.}
+  s.email = %q{cyril.rohr@gmail.com}
+  s.executables = ["restfully"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/restfully",
+     "examples/grid5000.rb",
+     "lib/restfully.rb",
+     "lib/restfully/collection.rb",
+     "lib/restfully/extensions.rb",
+     "lib/restfully/link.rb",
+     "lib/restfully/parsing.rb",
+     "lib/restfully/resource.rb",
+     "lib/restfully/session.rb",
+     "lib/restfully/special_array.rb",
+     "lib/restfully/special_hash.rb",
+     "restfully.gemspec",
+     "spec/collection_spec.rb",
+     "spec/link_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/restfully_spec.rb",
+     "spec/session_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/crohr/restfully}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.}
+  s.test_files = [
+    "spec/collection_spec.rb",
+     "spec/link_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/restfully_spec.rb",
+     "spec/session_spec.rb",
+     "spec/spec_helper.rb",
+     "examples/grid5000.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+  end
+end

data/spec/resource_spec.rb

@@ -143,7 +143,7 @@ describe Resource do
       resource.should respond_to(:status)
       status.should_receive(:load).and_return(status)
       resource.status.should == status
-      resource.uri.should == 'uri' # self link should not override it
+      resource.uri.should == "/sites/rennes/versions/123" # self link should override the URI attribute
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crohr-restfully
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-31 00:00:00 -07:00
-default_executable: 
+date: 2009-09-15 00:00:00 -07:00
+default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
@@ -24,8 +24,8 @@ dependencies:
     version: 
 description: Experimental code for auto-generation of wrappers on top of RESTful APIs that follow HATEOAS principles and provide OPTIONS methods and/or Allow headers.
 email: cyril.rohr@gmail.com
-executables: []
-
+executables: 
+- restfully
 extensions: []
 
 extra_rdoc_files: 
@@ -38,15 +38,18 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/restfully
 - examples/grid5000.rb
 - lib/restfully.rb
 - lib/restfully/collection.rb
+- lib/restfully/extensions.rb
 - lib/restfully/link.rb
 - lib/restfully/parsing.rb
 - lib/restfully/resource.rb
 - lib/restfully/session.rb
 - lib/restfully/special_array.rb
 - lib/restfully/special_hash.rb
+- restfully.gemspec
 - spec/collection_spec.rb
 - spec/link_spec.rb
 - spec/resource_spec.rb
@@ -54,7 +57,8 @@ files:
 - spec/session_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/cryx/restfully
+homepage: http://github.com/crohr/restfully
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -75,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.