restfully 0.5.10 → 0.6.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.6.0
+* Fixed collection traversal.
+* Query parameters that are Arrays are no longer joined.
+* Added 'next' as valid link relationship.
+
 0.5.10
 * Direct lookup to the resource if it cannot be found in the collection (for APIs that do not return all the items in a collection) (priteau)
 * Automatically load next pages of a collection when iterating through it

data/VERSION

@@ -1 +1 @@
-0.5.10
+0.6.0

data/lib/restfully.rb

@@ -1,10 +1,10 @@
 require 'backports'
 require 'yaml'
+require 'restfully/extensions'
 require 'restfully/error'
 require 'restfully/parsing'
 require 'restfully/http'
 require 'restfully/http/adapters/rest_client_adapter'
-require 'restfully/extensions'
 require 'restfully/session'
 require 'restfully/special_hash'
 require 'restfully/special_array'
@@ -12,9 +12,8 @@ require 'restfully/link'
 require 'restfully/resource'
 require 'restfully/collection'
 
-
 module Restfully
-  VERSION = "0.5.10"
+  VERSION = "0.6.0"
   class << self
     attr_accessor :adapter
   end

data/lib/restfully/collection.rb

@@ -28,9 +28,12 @@ module Restfully
     def each(*args, &block)
       @items.each_index{ |i|
         block.call(@items[i])
-        if i == @items.length-1 && @items.length < self["total"]
+        if i == @items.length-1 && @items.length+self["offset"] < self["total"]
           # load next page
-          next_page = Collection.new(uri, session).load(:query => {:offset => self["offset"]+@items.length}) rescue nil
+          query_options = executed_requests['GET']['options'][:query] || {}
+          query_options[:offset] = self["offset"]+@items.length
+          query_options[:limit] ||= 200
+          next_page = Collection.new(uri, session).load(:query => query_options) rescue nil
           if next_page && next_page['offset'] != self["offset"]
             @items.push(*next_page.to_a)
           end

data/lib/restfully/extensions.rb

@@ -2,23 +2,33 @@ class BasicObject #:nodoc:
   instance_methods.each { |m| undef_method m unless m =~ /^__|instance_eval/ }
 end unless defined?(BasicObject)
 
-# monkey patching:
-class Hash
-  # This is by no means the standard way to transform ruby objects into query parameters
-  # but it is targeted at our own needs
+class Object
+  # Taken from ActiveSupport
+  def to_query(key)
+    require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+    "#{CGI.escape(key.to_s)}=#{CGI.escape(to_params.to_s)}"
+  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
+    to_s
+  end
+end
 
-    params.chop! 
-    params
+class Hash
+  # Converts a hash into a string suitable for use as a URL query string. 
+  # An optional <tt>namespace</tt> can be passed to enclose the param names.
+  # Taken from ActiveSupport
+  def to_params(namespace = nil)
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end * '&'
   end
+end
 
+class Array
+  # Taken from ActiveSupport
+  def to_query(key)
+    prefix = "#{key}[]"
+    collect { |value| value.to_query(prefix) }.join '&'
+  end
 end

data/lib/restfully/http/request.rb

@@ -1,10 +1,12 @@
 require 'uri'
 module Restfully
   module HTTP
+    
     class Request
       include Headers, Restfully::Parsing
       attr_reader :headers, :uri
       attr_accessor :retries
+      
       def initialize(url, options = {})
         options = options.symbolize_keys
         @uri = url.kind_of?(URI) ? url : URI.parse(url)
@@ -16,7 +18,6 @@ module Restfully
         @retries = 0
       end
       
-      
       def body
         if @body.kind_of?(String)
           @unserialized_body ||= unserialize(@body, :content_type => @headers['Content-Type'])

data/lib/restfully/link.rb

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

data/restfully.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{restfully}
-  s.version = "0.5.10"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Cyril Rohr"]
-  s.date = %q{2010-04-20}
+  s.date = %q{2011-01-18}
   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}
@@ -67,7 +67,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/crohr/restfully}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   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",

data/spec/collection_spec.rb

@@ -48,8 +48,8 @@ describe Collection do
       body2["offset"] = 16
       body2["items"][1]["uid"] = "18th item"
       collection = Collection.new(@uri, session = mock('session')).load(:body => body)
-      session.should_receive(:get).with(@uri, :query => {:offset => 8}).ordered.and_return(response = mock("response", :body => body1, :status => 200, :headers => {}))
-      session.should_receive(:get).with(@uri, :query => {:offset => 16}).ordered.and_return(response = mock("response", :body => body2, :status => 200, :headers => {}))
+      session.should_receive(:get).with(@uri, :query => {:offset => 8, :limit => 200}).ordered.and_return(response = mock("response", :body => body1, :status => 200, :headers => {}))
+      session.should_receive(:get).with(@uri, :query => {:offset => 16, :limit => 200}).ordered.and_return(response = mock("response", :body => body2, :status => 200, :headers => {}))
       collection.find{|item| item["uid"] == "18th item"}.should_not be_nil
     end
     it "should always return nil if the searched item is not in the collection" do

data/spec/http/request_spec.rb

@@ -9,8 +9,8 @@ describe Restfully::HTTP::Request do
       :body => {"key" => "value"}.to_json
     )
     request.uri.should be_a URI
-    request.uri.to_s.should == 'https://api.grid5000.fr/sid/grid5000?q1=v1&q2=v2&custom_param1=3,4,5,6&custom_param2=value_custom_param2'
-    request.uri.query.should == "q1=v1&q2=v2&custom_param1=3,4,5,6&custom_param2=value_custom_param2"
+    request.uri.to_s.should == 'https://api.grid5000.fr/sid/grid5000?q1=v1&q2=v2&custom_param1%5B%5D=3&custom_param1%5B%5D=4&custom_param1%5B%5D=5&custom_param1%5B%5D=6&custom_param2=value_custom_param2'
+    request.uri.query.should == "q1=v1&q2=v2&custom_param1%5B%5D=3&custom_param1%5B%5D=4&custom_param1%5B%5D=5&custom_param1%5B%5D=6&custom_param2=value_custom_param2"
     request.headers.should == {
       "Content-Type"=>"application/json", 
       'Accept' => 'application/xml',

data/spec/spec_helper.rb

@@ -1,12 +1,14 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'webmock/rspec'
+include WebMock
+
 require 'restfully'
 require 'spec'
 require 'spec/autorun'
 require 'json'
 
-require 'webmock/rspec'
-include WebMock
 
 def fixture(filename)
   File.read(File.join(File.dirname(__FILE__), "fixtures", filename))

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: restfully
 version: !ruby/object:Gem::Version 
-  version: 0.5.10
+  prerelease: false
+  segments: 
+  - 0
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,69 +14,84 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-20 00:00:00 +02:00
+date: 2011-01-18 00:00:00 +01:00
 default_executable: restfully
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
         version: "1.4"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: backports
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: webmock
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id006
 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: 
@@ -139,18 +159,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Experimental code for auto-generation of wrappers on top of RESTful APIs that follow some specific conventions.