restfulie 0.6.0 → 0.7.0

data/lib/restfulie.rb

@@ -1,77 +1,9 @@
-#
-#  Copyright (c) 2009 Caelum - www.caelum.com.br/opensource
-#  All rights reserved.
-# 
-#  Licensed under the Apache License, Version 2.0 (the "License"); 
-#  you may not use this file except in compliance with the License. 
-#  You may obtain a copy of the License at 
-#  
-#   http://www.apache.org/licenses/LICENSE-2.0 
-#  
-#  Unless required by applicable law or agreed to in writing, software 
-#  distributed under the License is distributed on an "AS IS" BASIS, 
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
-#  See the License for the specific language governing permissions and 
-#  limitations under the License. 
-#
-
-require 'restfulie/logger'
-
-require 'net/http'
-require 'uri'
-require 'vendor/jeokkarak/jeokkarak'
-
-require 'restfulie/media_type'
-
-require 'restfulie/client'
-
-require 'restfulie/server/base'
-require 'restfulie/server/controller'
-require 'restfulie/server/instance'
-require 'restfulie/server/marshalling'
-require 'restfulie/server/transition'
-require 'restfulie/server/restfulie_controller'
-require 'restfulie/server/atom_media_type'
-require 'restfulie/unmarshalling'
-
-# Author:: Guilherme Silveira (mailto:guilherme.silveira@caelum.com.br)
-
-# This module controls global options for the Restfulie framework.
 module Restfulie
+  ROOT_PATH = File.dirname(__FILE__)
+  $LOAD_PATH.unshift(ROOT_PATH) unless $LOAD_PATH.include?(ROOT_PATH)
   
-  # Sets this class as a restfulie class.
-  # You may pass a block defining your own transitions.
-  #
-  # The transitions added will be concatenated with any extra transitions provided by your resource through
-  # the use of state and transition definitions.
-  # For every transition its name is the only mandatory field:
-  # options = {}
-  # [:show, options] # will generate a link to your controller's show action
-  #
-  # The options can be used to override restfulie's conventions:
-  # options[:rel] = "refresh" # will create a rel named refresh
-  # options[:action] = "destroy" # will link to the destroy method
-  # options[:controller] = another controller # will use another controller's action
-  #
-  # Any extra options will be passed to the target controller url_for method in order to retrieve
-  # the transition's uri.
-  def acts_as_restfulie
-    extend Restfulie::Server::Base
-    extend Restfulie::MediaTypeControl
-    include Restfulie::Server::Instance
-    include Restfulie::Server::Marshalling
-    extend Restfulie::Unmarshalling #TODO still needs testing. e.g. server model has from_xml
-    #TODO and need to test (de)serialization with both AR and no-AR
-    
-    self.send :define_method, :following_transitions do
-      transitions = []
-      yield( self, transitions ) if block_given?
-      transitions
-    end
-  end
-
 end
 
-Object.extend Restfulie
+require 'restfulie/client'
+require 'restfulie/server'
 
-include ActiveSupport::CoreExtensions::Hash

data/lib/vendor/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/vendor/atom/pub.rb

@@ -0,0 +1,250 @@
+# Copyright (c) 2008 The Kaphan Foundation
+#
+# For licensing information see LICENSE.txt.
+#
+# Please visit http://www.peerworks.org/contact for further information.
+#
+
+require 'vendor/atom'
+require 'vendor/atom/configuration'
+require 'vendor/atom/xml/parser'
+require 'vendor/atom/version'
+require 'xml/libxml'
+require 'uri'
+require 'net/http'
+
+module Atom
+  module Pub
+    class NotSupported < StandardError; end
+    class ProtocolError < StandardError
+      attr_reader :response
+      def initialize(response)
+        @response = response
+      end
+      
+      def to_s
+        "Invalid response: #{@response}"
+      end
+    end
+    
+    class Service
+      include Atom::Xml::Parseable
+      namespace Atom::Pub::NAMESPACE
+      elements :workspaces
+      loadable! do |reader, message, severity, base, line|
+        if severity == XML::Reader::SEVERITY_ERROR
+          raise ArgumentError, "#{message} at #{line}"
+        end
+      end
+      
+      def initialize(xml = nil)
+        @workspaces = []
+
+        if xml
+          begin
+            if next_node_is?(xml, 'service', Atom::Pub::NAMESPACE)
+              xml.read
+              parse(xml)
+            else
+              raise ArgumentError, "XML document was missing atom:service"        
+            end
+          ensure
+            xml.close
+          end
+        end
+        
+        yield(self) if block_given?        
+      end
+    end
+    
+    class Categories < DelegateClass(Array)
+      include Atom::Xml::Parseable
+      elements :categories, :class => Atom::Category
+      attribute :href, :fixed
+      
+      def initialize(o)
+        super([])
+        parse(o, :once => true)
+        o.read
+        parse(o)
+      end
+
+      remove_method :categories
+      def categories; self; end
+      
+      # True true if fixed was 'yes' or 'true'
+      def fixed?
+        !self.fixed.nil? && %w(yes true).include?(self.fixed.downcase)
+      end
+    end
+    
+    class Workspace
+      include Atom::Xml::Parseable
+      element :title, :class => Content, :namespace => Atom::NAMESPACE
+      elements :collections
+      
+      def initialize(o = nil)
+        @collections = []
+        
+        case o
+        when XML::Reader
+          o.read
+          parse(o)
+        when Hash
+          o.each do |k, v|
+            self.send("#{k}=".to_sym, v)
+          end
+        end
+        
+        yield(self) if block_given?
+      end
+    end
+    
+    class Collection
+      include Atom::Xml::Parseable
+      attribute :href
+      element :title, :class => Content, :namespace => Atom::NAMESPACE
+      element :categories, :class => Categories
+      elements :accepts, :content_only => true
+      
+      def initialize(o = nil)
+        @accepts = []
+        case o
+        when XML::Reader
+          # do it once to get the attributes
+          parse(o, :once => true)
+          # now step into the element and the sub tree
+          o.read
+          parse(o)
+        when Hash
+          o.each do |k, v|
+            self.send("#{k}=", v)
+          end  
+        end
+        
+        yield(self) if block_given?
+      end
+      
+      def feed(opts = {})
+        if href
+          Atom::Feed.load_feed(URI.parse(href), opts)
+        end
+      end
+      
+      def publish(entry, opts = {})
+        uri = URI.parse(href)
+        response = nil
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          request = Net::HTTP::Post.new(uri.request_uri, 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
+        
+        case response
+        when Net::HTTPCreated
+          published = begin
+            Atom::Entry.load_entry(response.body)
+          rescue ArgumentError
+            entry
+          end
+        
+          if response['Location']
+            if published.edit_link
+              published.edit_link.href = response['Location']
+            else
+              published.links << Atom::Link.new(:rel => 'edit', :href => response['Location'])
+            end
+          end
+        
+          published
+        else
+          raise Atom::Pub::ProtocolError, response
+        end
+      end
+      
+      private
+      def headers
+        {'Accept' => 'application/atom+xml',
+         'Content-Type' => 'application/atom+xml;type=entry',
+         'User-Agent' => "rAtom #{Atom::VERSION::STRING}"
+         }
+      end
+    end
+  end
+  
+  class Entry    
+    def save!(opts = {})
+      if edit = edit_link
+        uri = URI.parse(edit.href)
+        response = nil
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          request = Net::HTTP::Put.new(uri.request_uri, 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
+        
+        case response
+        when Net::HTTPSuccess
+        else
+          raise Atom::Pub::ProtocolError, response
+        end
+      else
+        raise Atom::Pub::NotSupported, "Entry does not have an edit link"
+      end
+    end
+    
+    def destroy!(opts = {})
+      if edit = edit_link
+        uri = URI.parse(edit.href)
+        response = nil
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          request = Net::HTTP::Delete.new(uri.request_uri, {'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
+        
+        case response
+        when Net::HTTPSuccess
+        else
+          raise Atom::Pub::ProtocolError, response
+        end
+      else
+        raise Atom::Pub::NotSupported, "Entry does not have an edit link"
+      end
+    end
+    
+    private
+    def headers
+      {'Accept' => 'application/atom+xml',
+       'Content-Type' => 'application/atom+xml;type=entry',
+       'User-Agent' => "rAtom #{Atom::VERSION::STRING}"
+       }
+    end    
+  end
+end