ratom 0.5.0 → 0.5.1

data/History.txt

@@ -1,3 +1,7 @@
+== 0.5.1 2008-08-05
+
+* Added optional AuthHMAC support
+
 == 0.5.0 2008-07-28
 
 * Fix bug where processing instructions break parsing.

data/Manifest.txt

@@ -9,6 +9,7 @@ lib/atom.rb
 lib/atom/pub.rb
 lib/atom/version.rb
 lib/atom/xml/parser.rb
+lib/atom/configuration.rb
 setup.rb
 spec/app/member_entry.atom
 spec/app/service.xml

data/README.txt

@@ -215,7 +215,8 @@ We can tell rAtom about our custom namespace and custom class using the followin
 The first method call registers an alias for the "http://custom.namespace" namespace and the second method call
 tell rAtom that when it encounters a custom:property element within a Feed it should create an instance of Custom::Property
 and pass the XML Reader to the constructor of the instance.  It is then up to the constructor to populate the objects attributes 
-from the XML.  
+from the XML. Note that the alias you create using +add_extension_namespace+ can be anything you want, it doesn't need
+to match the alias in the actual XML itself.
 
 The custom property will then be available as a method on the rAtom class.  In the above example:
 
@@ -223,6 +224,11 @@ The custom property will then be available as a method on the rAtom class.  In t
   @feed.custom_property.first.name == 'foo'
   @feed.custom_property.first.value == 'bar'
 	
+There is one caveat to this.  By using this type of extension support you are permanently modifying the rAtom classes.
+So if your application process one type of atom extension and you are happy with permanently modified rAtom classes,
+the extra extensibility might work for you.  If on the other hand you process lots of different types of extension you might
+want to stick with simpler extension mechanism using the [namespace, element] method described above.
+ 
 (Thanks to nachokb for this feature!!)
 
 === Basic Authentication
@@ -246,6 +252,10 @@ method call that requires them.  This might be a bit of a pain but it does make
 for protecting your credentials, although if you are using HTTP Basic Authentication there is a good chance your credentials aren't
 very well protected anyway.
 
+=== AuthHMAC authentication
+
+As of version 0.5.1 rAtom also support authentication via HMAC request signing using the AuthHMAC[http://auth-hmac.rubyforge.org] gem.  This is made available using the :hmac_access_id and :hmac_secret_key parameters which can be passed to the same methods as the HTTP Basic credentials support.
+
 == TODO
 
 * Support partial content responses from the server.

data/lib/atom.rb

@@ -412,9 +412,9 @@ module Atom # :nodoc:
     end
     
     # Reloads the feed by fetching the self uri.
-    def reload!
+    def reload!(opts = {})
       if links.self
-        Feed.load_feed(URI.parse(links.self.href))
+        Feed.load_feed(URI.parse(links.self.href), opts)
       end
     end
     
@@ -545,9 +545,9 @@ module Atom # :nodoc:
     end   
     
     # Reload the Entry by fetching the self link.
-    def reload!
+    def reload!(opts = {})
       if links.self
-        Entry.load_entry(URI.parse(links.self.href))
+        Entry.load_entry(URI.parse(links.self.href), opts)
       end
     end
   end

data/lib/atom/configuration.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2008 The Kaphan Foundation
+#
+# For licensing information see LICENSE.txt.
+#
+# Please visit http://www.peerworks.org/contact for further information.
+#
+
+module Atom
+  class Configuration
+    def self.auth_hmac_enabled?
+      unless defined?(@auth_hmac_enabled)
+        begin
+          gem 'auth-hmac'
+          require 'auth-hmac'
+          @auth_hmac_enabled = true
+        rescue
+          @auth_hmac_enabled = false
+        end
+      else
+        @auth_hmac_enabled
+      end
+    end
+  end
+end

data/lib/atom/pub.rb

@@ -6,6 +6,7 @@
 #
 
 require 'atom'
+require 'atom/configuration'
 require 'atom/xml/parser'
 require 'atom/version'
 require 'xml/libxml'
@@ -126,6 +127,12 @@ module Atom
           request = Net::HTTP::Post.new(uri.path, headers)
           if opts[:user] && opts[:pass]
             request.basic_auth(opts[:user], opts[:pass])
+          elsif opts[:hmac_access_id] && opts[:hmac_secret_key]
+            if Atom::Configuration.auth_hmac_enabled?
+              AuthHMAC.sign!(request, opts[:hmac_access_id], opts[:hmac_secret_key])
+            else
+              raise ArgumentError, "AuthHMAC credentials provides by auth-hmac gem is not installed"
+            end
           end
           response = http.request(request, entry.to_xml.to_s)
         end
@@ -171,7 +178,14 @@ module Atom
           request = Net::HTTP::Put.new(uri.path, headers)
           if opts[:user] && opts[:pass]
             request.basic_auth(opts[:user], opts[:pass])
+          elsif opts[:hmac_access_id] && opts[:hmac_secret_key]
+            if Atom::Configuration.auth_hmac_enabled?
+              AuthHMAC.sign!(request, opts[:hmac_access_id], opts[:hmac_secret_key])
+            else
+              raise ArgumentError, "AuthHMAC credentials provides by auth-hmac gem is not installed"
+            end
           end
+          
           response = http.request(request, self.to_xml)
         end
         
@@ -193,7 +207,14 @@ module Atom
           request = Net::HTTP::Delete.new(uri.path, {'Accept' => 'application/atom+xml', 'User-Agent' => "rAtom #{Atom::VERSION::STRING}"})
           if opts[:user] && opts[:pass]
             request.basic_auth(opts[:user], opts[:pass])
+          elsif opts[:hmac_access_id] && opts[:hmac_secret_key]
+            if Atom::Configuration.auth_hmac_enabled?
+              AuthHMAC.sign!(request, opts[:hmac_access_id], opts[:hmac_secret_key])
+            else
+              raise ArgumentError, "AuthHMAC credentials provides by auth-hmac gem is not installed"
+            end
           end
+          
           response = http.request(request)
         end
         

data/lib/atom/version.rb

@@ -8,7 +8,7 @@ module Atom #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 5
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/atom/xml/parser.rb

@@ -271,6 +271,13 @@ module Atom
                     request = Net::HTTP::Get.new(o.request_uri)
                     if opts[:user] && opts[:pass]
                       request.basic_auth(opts[:user], opts[:pass])
+                    elsif opts[:hmac_access_id] && opts[:hmac_secret_key]
+                      if Atom::Configuration.auth_hmac_enabled?
+                        puts "Signing with HMAC"
+                        AuthHMAC.sign!(request, opts[:hmac_access_id], opts[:hmac_secret_key])
+                      else
+                        raise ArgumentError, "AuthHMAC credentials provides by auth-hmac gem is not installed"
+                      end
                     end
                     response = http.request(request)
                   end

data/spec/atom/pub_spec.rb

@@ -248,6 +248,27 @@ describe Atom::Pub do
         created = @collection.publish(entry, :user => 'user', :pass => 'pass')
         created.should == entry
       end
+      
+      if Atom::Configuration.auth_hmac_enabled?
+        it "should send a POST with hmac authentication when an entry is published" do  
+          entry = Atom::Entry.load_entry(File.open('spec/fixtures/entry.atom'))      
+                 
+          response = mock_response(Net::HTTPCreated, entry.to_xml.to_s)
+              
+          http = mock('http')
+          http.should_receive(:request) do |request, entry_xml|
+            request['Authorization'].should match(/^AuthHMAC access_id:[a-zA-Z0-9\/+]+=*/)
+            response
+          end
+            
+          Net::HTTP.should_receive(:start).with('example.org', 80).and_yield(http)
+      
+          created = @collection.publish(entry, :hmac_access_id => 'access_id', :hmac_secret_key => 'secret')
+          created.should == entry
+        end
+      else
+        xit "should send a POST with hmac authentication when an entry is published"
+      end
     
       it "should behave well when no content is returned" do      
         entry = Atom::Entry.load_entry(File.open('spec/fixtures/entry.atom'))      
@@ -366,6 +387,23 @@ describe Atom::Pub do
       entry.save!(:user => 'user', :pass => 'pass')
     end
     
+    if Atom::Configuration.auth_hmac_enabled?
+      it "should send a PUT with hmac auth to the edit link on save!" do
+        entry = Atom::Entry.load_entry(File.open('spec/app/member_entry.atom'))
+        response = mock_response(Net::HTTPSuccess, nil)
+      
+        http = mock('http')
+        http.should_receive(:request) do |request, entry_xml|
+          request['Authorization'].should match(/^AuthHMAC access_id:[a-zA-Z0-9\/+]+=*$/)
+          response
+        end
+        
+        Net::HTTP.should_receive(:start).with('example.org', 80).and_yield(http)
+            
+        entry.save!(:hmac_access_id => 'access_id', :hmac_secret_key => 'secret')
+      end
+    end
+    
     it "should send a DELETE to the edit link on delete!" do
       entry = Atom::Entry.load_entry(File.open('spec/app/member_entry.atom'))
       response = mock_response(Net::HTTPSuccess, nil)
@@ -380,20 +418,37 @@ describe Atom::Pub do
       entry.destroy!
     end
     
-     it "should send a DELETE to the edit link on delete!" do
+    it "should send a DELETE with basic auth to the edit link on delete!" do
+      entry = Atom::Entry.load_entry(File.open('spec/app/member_entry.atom'))
+      response = mock_response(Net::HTTPSuccess, nil)
+
+      request = mock('request')
+      request.should_receive(:basic_auth).with('user', 'pass')
+      Net::HTTP::Delete.should_receive(:new).with('/member_entry.atom', an_instance_of(Hash)).and_return(request)
+
+      http = mock('http')
+      http.should_receive(:request).with(request).and_return(response)
+      Net::HTTP.should_receive(:start).with('example.org', 80).and_yield(http)
+
+      entry.destroy!(:user => 'user', :pass => 'pass')
+    end
+    
+    if Atom::Configuration.auth_hmac_enabled?
+      it "should send a DELETE with hmac auth to the edit link on delete!" do
         entry = Atom::Entry.load_entry(File.open('spec/app/member_entry.atom'))
         response = mock_response(Net::HTTPSuccess, nil)
 
-        request = mock('request')
-        request.should_receive(:basic_auth).with('user', 'pass')
-        Net::HTTP::Delete.should_receive(:new).with('/member_entry.atom', an_instance_of(Hash)).and_return(request)
-
         http = mock('http')
-        http.should_receive(:request).with(request).and_return(response)
+        http.should_receive(:request) do |request|
+          request['Authorization'].should match(/^AuthHMAC access_id:[a-zA-Z0-9\/+]+=*$/)
+          response
+        end
+        
         Net::HTTP.should_receive(:start).with('example.org', 80).and_yield(http)
 
-        entry.destroy!(:user => 'user', :pass => 'pass')
+        entry.destroy!(:hmac_access_id => 'access_id', :hmac_secret_key => 'secret')
       end
+    end
     
     it "should raise exception on save! without an edit link" do
       entry = Atom::Entry.load_entry(File.open('spec/fixtures/entry.atom'))

data/spec/atom_spec.rb

@@ -143,9 +143,6 @@ describe Atom do
 
       lambda { Atom::Feed.load_feed(uri, :user => 'user', :pass => 'pass') }.should_not raise_error
     end
-    
-    it "should pass basic-auth credentials on the request" do
-    end
   end
   
   describe 'Atom::Entry.load_entry' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ratom
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Peerworks
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-28 00:00:00 +09:30
+date: 2008-08-11 00:00:00 +09:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ files:
 - lib/atom/pub.rb
 - lib/atom/version.rb
 - lib/atom/xml/parser.rb
+- lib/atom/configuration.rb
 - setup.rb
 - spec/app/member_entry.atom
 - spec/app/service.xml