restfulie 0.1.0.beta1

data/lib/restfulie/server/configuration.rb

@@ -0,0 +1,24 @@
+module Restfulie
+  module Server
+    module Configuration
+      # Defines host to be passed to polymorphic_url.
+      # You need to setup this to your own domain in order to generate meaningful links.
+      mattr_accessor :host
+      @@host = 'localhost'
+      
+      # Passes a symbol to polymorphic_url in order to use a namespaced named_route.
+      # So, if config.named_route_prefix = :rest, it will search for rest_album_url,
+      # rest_album_songs_url, and so on.
+      mattr_accessor :named_route_prefix
+      @@named_route_prefix = nil
+            
+      # This defines a Rails-like way to setup options. You can do, in a initializer:
+      #   Restfulie::Server.setup do |config|
+      #     config.host = 'mydomain.com'
+      #   end
+      def self.setup
+        yield self
+      end
+    end
+  end
+end

data/lib/restfulie/server/controller.rb

@@ -0,0 +1,74 @@
+module Restfulie
+  module Server
+    # Controller which adds default CRUD + search + other operations.
+    # TODO: move these actions to controller/base.rb (maybe using InheritedResources, maybe not)
+    module Controller
+      # creates a model based on the request media-type extracted from its content-type
+      def create
+        type = model_type
+        return head 415 unless fits_content(type, request.headers['CONTENT_TYPE'])
+
+        @model = type.from_xml request.body.string
+        if @model.save
+          render_created @model
+        else
+          render :xml => @model.errors, :status => :unprocessable_entity
+        end
+      end
+    
+      # renders this resource
+      def show
+        @model = model_type.find(params[:id])
+        instance_variable_set(model_variable_name, @model)
+        render_resource(@model)
+      end
+      
+      def model_variable_name
+        ("@" + model_type.to_s.downcase).to_sym
+      end
+
+      # destroys this resource
+      def destroy
+        @model = model_type.find(params[:id])
+        @model.destroy
+        head :ok
+      end
+
+      # updates a resouce
+      def update
+        type = model_type
+
+        @loaded = type.find(params[:id])
+        return head(:status => 405) unless @loaded.can? :update
+
+        return head(415) unless fits_content(type, request.headers['CONTENT_TYPE'])
+
+        @model = Hash.from_xml(request.body.string)[model_name]
+        pre_update(@model) if self.respond_to?(:pre_update)
+        
+        if @loaded.update_attributes(@model)
+          render_resource @loaded
+        else
+          render :xml => @loaded.errors, :status => :unprocessable_entity
+        end
+      end
+
+      # returns the model for this controller
+      def model_type
+        self.class.name[/(.*)Controller/,1].singularize.constantize
+      end
+      
+      # retrieves the model name
+      def model_name
+        self.class.name[/(.*)Controller/,1].singularize.underscore
+      end
+    
+      def fits_content(type, content_type)
+        Restfulie::MediaType.supports?(content_type) &&
+                (type.respond_to?(:media_type_representations) ?
+                type.media_type_representations.include?(content_type) :
+                Restfulie::MediaType.default_representations.include?(content_type))
+      end
+    end
+  end
+end

data/lib/restfulie/server/core_ext/array.rb

@@ -0,0 +1,61 @@
+# Introspective methods to assist in the conversion of collections in other formats.
+class Array
+  def to_atom(options={}, &block)
+    raise "Not all elements respond to to_atom" unless all? { |e| e.respond_to? :to_atom }
+    options = options.dup
+    
+    if options.delete :only_self_link
+      options[:skip_associations_links] = true
+      options[:skip_attributes]         = true      
+    end
+    
+    feed = Restfulie::Common::Representation::Atom::Feed.new
+    # TODO: Define better feed attributes
+    # Array#to_s can return a very long string
+    feed.title      = "Collection of #{map {|i| i.class.name }.uniq.to_sentence}"
+    feed.updated    = updated_at
+    feed.published  = published_at
+    # TODO: this id does not comply with Rest standards yet
+    feed.id = hash
+    
+    each do |element|
+      feed.entries << element.to_atom(options)
+    end
+    
+    yield feed if block_given?
+    
+    feed
+  end
+  
+  # Return max update date for items in collection, for it uses the updated_at of items.
+  # 
+  #==Example:
+  #
+  # Find max updated at in ActiveRecord objects 
+  #
+  #   albums = Albums.find(:all)
+  #   albums.updated_at
+  # 
+  # Using a custom field to check the max date
+  #
+  #   albums = Albums.find(:all)
+  #   albums.updated_at(:created_at)
+  #
+  def updated_at(field = :updated_at)
+    max = max_by{|o| o.send(field)}
+    if max
+      max.send(field)
+    else
+      Time.now
+    end
+  end
+
+  def published_at(field = :published_at)
+    min = min_by{|o| o.send(field)}
+    if min
+      min.send(field)
+    else
+      Time.now
+    end
+  end
+end

data/lib/restfulie/server/core_ext.rb

@@ -0,0 +1 @@
+require 'restfulie/server/core_ext/array'

data/lib/restfulie/server.rb

@@ -0,0 +1,25 @@
+require 'respondie'
+require 'restfulie/common'
+
+module Restfulie
+  module Server
+    autoload :Configuration, 'restfulie/server/configuration'
+    autoload :ActionController, 'restfulie/server/action_controller'
+    autoload :ActionView, 'restfulie/server/action_view'
+    autoload :Controller, 'restfulie/server/controller'
+  end
+end
+
+require 'restfulie/server/core_ext'
+Restfulie::Server::ActionView::TemplateHandlers.activate!
+
+class ActionController::Base
+  def self.restfulie
+    include Restfulie::Server::ActionController::Base
+  end
+  
+  def self.use_trait(&block)
+    Respondie::Builder.new("Restfulie::Server::ActionController::Trait::$trait$", self).instance_eval(&block)
+  end
+
+end

data/lib/restfulie/version.rb

@@ -0,0 +1,14 @@
+module Restfulie
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.') + ".beta1"
+
+    # Restfulie's version
+    def self.to_s
+      STRING
+    end
+  end
+end

data/lib/restfulie.rb

@@ -0,0 +1,34 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
+
+require 'restfulie/version'
+require 'restfulie/common'
+require 'restfulie/client'
+require 'restfulie/server'
+
+# Shortcut to RestfulieDsl
+module Restfulie
+
+  # creates a new entry point for executing requests
+  def self.at(uri)
+    Restfulie.use.at(uri)
+  end
+
+  def self.using(&block)
+    RestfulieUsing.new.instance_eval(&block)
+  end
+  
+  def self.use(&block)
+    if block_given?
+      Restfulie::Client::Dsl.new.instance_eval(&block)
+    else
+      Restfulie::Client::Dsl.new
+    end
+  end
+  
+end
+
+class RestfulieUsing
+  def method_missing(sym, *args)
+    @current = "Restfulie::Client::HTTP::#{sym.to_s.classify}".constantize.new(@current || Restfulie::Client::HTTP::RequestAdapter.new, *args)
+  end
+end

metadata

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification 
+name: restfulie
+version: !ruby/object:Gem::Version 
+  hash: 299253573
+  prerelease: true
+  segments: 
+  - 0
+  - 1
+  - 0
+  - beta1
+  version: 0.1.0.beta1
+platform: ruby
+authors: 
+- Guilherme Silveira, Caue Guerra, Luis Cipriani, Everton Ribeiro, George Guimaraes, Paulo Ahagon, Several contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 3
+        - 2
+        version: 2.3.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id004
+description: 
+email: guilherme.silveira@caelum.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/restfulie/client/base.rb
+- lib/restfulie/client/cache/basic.rb
+- lib/restfulie/client/cache/fake.rb
+- lib/restfulie/client/cache/http_ext.rb
+- lib/restfulie/client/cache/restrictions.rb
+- lib/restfulie/client/cache.rb
+- lib/restfulie/client/configuration.rb
+- lib/restfulie/client/dsl.rb
+- lib/restfulie/client/entry_point.rb
+- lib/restfulie/client/ext/atom_ext.rb
+- lib/restfulie/client/ext/http_ext.rb
+- lib/restfulie/client/ext/json_ext.rb
+- lib/restfulie/client/feature/base.rb
+- lib/restfulie/client/feature/base_request.rb
+- lib/restfulie/client/feature/cache.rb
+- lib/restfulie/client/feature/enhance_response.rb
+- lib/restfulie/client/feature/follow_request.rb
+- lib/restfulie/client/feature/history.rb
+- lib/restfulie/client/feature/history_request.rb
+- lib/restfulie/client/feature/open_search/pattern_matcher.rb
+- lib/restfulie/client/feature/open_search.rb
+- lib/restfulie/client/feature/serialize_body.rb
+- lib/restfulie/client/feature/setup_header.rb
+- lib/restfulie/client/feature/throw_error.rb
+- lib/restfulie/client/feature/verb.rb
+- lib/restfulie/client/feature.rb
+- lib/restfulie/client/http/cache.rb
+- lib/restfulie/client/http/error.rb
+- lib/restfulie/client/http/response_holder.rb
+- lib/restfulie/client/http.rb
+- lib/restfulie/client/master_delegator.rb
+- lib/restfulie/client/mikyung/concatenator.rb
+- lib/restfulie/client/mikyung/core.rb
+- lib/restfulie/client/mikyung/languages/german.rb
+- lib/restfulie/client/mikyung/languages/portuguese.rb
+- lib/restfulie/client/mikyung/languages.rb
+- lib/restfulie/client/mikyung/rest_process_model.rb
+- lib/restfulie/client/mikyung/steady_state_walker.rb
+- lib/restfulie/client/mikyung/then_condition.rb
+- lib/restfulie/client/mikyung/when_condition.rb
+- lib/restfulie/client/mikyung.rb
+- lib/restfulie/client.rb
+- lib/restfulie/common/converter/atom/base.rb
+- lib/restfulie/common/converter/atom/builder.rb
+- lib/restfulie/common/converter/atom/helpers.rb
+- lib/restfulie/common/converter/atom.rb
+- lib/restfulie/common/converter/json/base.rb
+- lib/restfulie/common/converter/json/builder.rb
+- lib/restfulie/common/converter/json/helpers.rb
+- lib/restfulie/common/converter/json.rb
+- lib/restfulie/common/converter/open_search/descriptor.rb
+- lib/restfulie/common/converter/open_search.rb
+- lib/restfulie/common/converter/values.rb
+- lib/restfulie/common/converter/xml/base.rb
+- lib/restfulie/common/converter/xml/builder.rb
+- lib/restfulie/common/converter/xml/helpers.rb
+- lib/restfulie/common/converter/xml/link.rb
+- lib/restfulie/common/converter/xml/links.rb
+- lib/restfulie/common/converter/xml.rb
+- lib/restfulie/common/converter.rb
+- lib/restfulie/common/core_ext/hash.rb
+- lib/restfulie/common/core_ext.rb
+- lib/restfulie/common/error.rb
+- lib/restfulie/common/links.rb
+- lib/restfulie/common/logger.rb
+- lib/restfulie/common/representation/atom/base.rb
+- lib/restfulie/common/representation/atom/category.rb
+- lib/restfulie/common/representation/atom/entry.rb
+- lib/restfulie/common/representation/atom/factory.rb
+- lib/restfulie/common/representation/atom/feed.rb
+- lib/restfulie/common/representation/atom/link.rb
+- lib/restfulie/common/representation/atom/person.rb
+- lib/restfulie/common/representation/atom/source.rb
+- lib/restfulie/common/representation/atom/tag_collection.rb
+- lib/restfulie/common/representation/atom/xml.rb
+- lib/restfulie/common/representation/atom.rb
+- lib/restfulie/common/representation/generic.rb
+- lib/restfulie/common/representation/json/base.rb
+- lib/restfulie/common/representation/json/keys_as_methods.rb
+- lib/restfulie/common/representation/json/link.rb
+- lib/restfulie/common/representation/json/link_collection.rb
+- lib/restfulie/common/representation/json.rb
+- lib/restfulie/common/representation/links.rb
+- lib/restfulie/common/representation.rb
+- lib/restfulie/common.rb
+- lib/restfulie/server/action_controller/base.rb
+- lib/restfulie/server/action_controller/params_parser.rb
+- lib/restfulie/server/action_controller/patch.rb
+- lib/restfulie/server/action_controller/restful_responder.rb
+- lib/restfulie/server/action_controller/trait/cacheable.rb
+- lib/restfulie/server/action_controller/trait/created.rb
+- lib/restfulie/server/action_controller/trait.rb
+- lib/restfulie/server/action_controller.rb
+- lib/restfulie/server/action_view/helpers.rb
+- lib/restfulie/server/action_view/template_handlers/tokamak.rb
+- lib/restfulie/server/action_view/template_handlers.rb
+- lib/restfulie/server/action_view.rb
+- lib/restfulie/server/configuration.rb
+- lib/restfulie/server/controller.rb
+- lib/restfulie/server/core_ext/array.rb
+- lib/restfulie/server/core_ext.rb
+- lib/restfulie/server.rb
+- lib/restfulie/version.rb
+- lib/restfulie.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- README.textile
+- lib/restfulie/common/representation/atom/atom.rng
+has_rdoc: true
+homepage: http://restfulie.caelumobjects.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      hash: 25
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Hypermedia aware resource based library in ruby (client side) and ruby on rails (server side).
+test_files: []
+