restfulie 0.1.0.beta1

data/Gemfile

@@ -0,0 +1,28 @@
+# A sample Gemfile
+source :gemcutter
+#
+gem "rails", ">= 3.0.0"
+gem "libxml-ruby"
+
+gem "rack-conneg"
+gem "json_pure"
+gem "sqlite3-ruby"
+gem "yard"
+
+gem "respondie"
+
+if RUBY_VERSION < "1.9"
+  gem "ruby-debug"
+else
+  gem "ruby-debug19", :require => "ruby-debug"
+end
+
+group :test do  
+  gem "nokogiri"
+  gem "rspec-rails", ">= 2.0.0.beta.19"
+  gem "rcov"
+  gem "sinatra"
+	gem "state_machine"
+  gem "test-unit", "= 1.2.3"
+	gem "fakeweb"
+end  

data/Gemfile.lock

@@ -0,0 +1,128 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fakeweb (1.2.8)
+    hoe (2.6.1)
+      rake (>= 0.8.7)
+      rubyforge (>= 2.0.4)
+    i18n (0.4.1)
+    json_pure (1.4.6)
+    libxml-ruby (1.1.4)
+    linecache (0.43)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-conneg (0.1.4)
+      rack (>= 1.0)
+    rack-mount (0.6.12)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rcov (0.9.8)
+    respondie (0.9.0)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rspec-rails (2.0.0.beta.19)
+      rspec (= 2.0.0.beta.19)
+      webrat (>= 0.7.2.beta.1)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sinatra (1.0)
+      rack (>= 1.0)
+    sqlite3-ruby (1.3.1)
+    state_machine (0.9.4)
+    test-unit (1.2.3)
+      hoe (>= 1.5.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    webrat (0.7.2.beta.1)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+    yard (0.5.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  json_pure
+  libxml-ruby
+  nokogiri
+  rack-conneg
+  rails (>= 3.0.0)
+  rcov
+  respondie
+  rspec-rails (>= 2.0.0.beta.19)
+  ruby-debug
+  sinatra
+  sqlite3-ruby
+  state_machine
+  test-unit (= 1.2.3)
+  yard

data/LICENSE

@@ -0,0 +1,17 @@
+/***
+ * 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. 
+ */
+

data/README.textile

@@ -0,0 +1,138 @@
+h1. Web site
+
+Restfulie's website can be found at "http://restfulie.caelumobjects.com":http://restfulie.caelumobjects.com
+From there you can see some videos and read the "Restfulie from Scratch guide":http://restfulie.caelumobjects.com/caelumobjects-restful-rails.pdf.
+
+h1. Quit pretending
+
+CRUD through HTTP is a good step forward to using resources and becoming RESTful, another step further into it is to make use of hypermedia and semantic meaningful media types: this gem allows you to do it really fast.
+
+You can read the "article on using the web for real":http://guilhermesilveira.wordpress.com/2009/11/03/quit-pretending-use-the-web-for-real-restfulie/ which gives an introduction to hypermedia/resources/services.
+
+h2. Why would I use restfulie?
+
+#  Easy --> writing hypermedia and semantic meaningful media type aware clients
+#  Small -> it's not a bloated solution with a huge list of APIs
+#  HATEOAS --> clients you are unaware of will not bother if you change
+#  HATEOAS --> consumed resources will not affect your software whenever they change their flow
+#  Adaptability --> clients are able to adapt to your changes
+ 
+h2. Simple server example
+
+In the server side, all you need to do is notify inherited_resources which media types you are able to represent your resource:
+
+<pre>
+	class OrdersController < ApplicationController
+	  include Restfulie::Server::ActionController::Base
+
+	  respond_to :atom, :html, :xml, :commerce, :opensearch
+
+	  def index
+	    respond_with @orders = Order.all
+	  end
+
+	  def show
+	    respond_with @order = Order.find(params[:id])
+	  end
+
+	end
+</pre>
+
+That's it. Restfulie will take care of rendering a valid representation according to content negotiation. You can configure the rendering process through a custom tokamak view:
+
+<pre>
+	collection(@orders) do |collection|
+	  collection.values do |value|
+		value.id = orders_url
+	  end
+	  
+	  collection.link("create", orders_url)
+	  collection.members
+	end
+</pre>
+
+You can go through an entire application by "watching this video":http://guilhermesilveira.wordpress.com or "downloading an example application contained within the restfulie ":http://github.com/caelum/restfulie/tree/master/full-examples/rest_from_scratch/
+
+h2. Simple client example
+
+The following example is a partial REST client implementation that navigates through some relations:
+
+<pre>
+order = Restfulie.at('http://localhost:3000/orders/1').get!
+order.items.each { |item| puts items }
+receipt = order.payment.post! { :amount => 500 }
+puts receipt.id
+</pre>
+
+In order to create a full REST client, "watch this video":http://guilhermesilveira.wordpress.com.
+
+h2. Full examples
+
+You can view an entire application running Restfulie under *spec/integration/order/server* and *spec/integration/order/client* in this git repository.
+
+"You can also download a full example of a REST based agent and server":http://github.com/caelum/restfulie/tree/master/full-examples/rest_from_scratch/ using Restfulie, according to the Rest Architecture Maturity Model.
+
+h2. Documentation
+
+Appart from the simple server and client examples provided here, you can find the following links useful:
+
+* "RDocs":http://rdoc.info/projects/caelum/restfulie
+* "Official website":http://restfulie.caelumobjects.com
+* "How-tos":http://restfulie.caelumobjects.com/caelumobjects-restful-rails.pdf
+* "Buying through Rest: Rest to the enterprise (video)":http://guilhermesilveira.wordpress.com/2010/04/13/buying-through-rest-applying-rest-to-the-enterprise/
+
+h2. Installing
+
+Execute:
+
+<pre>
+gem install restfulie
+</pre>
+
+For use in Rails 2.3, make sure to require the responders_backport gem in addition to the restfulie gem, either in environment.rb or in the Gemfile.
+
+h2. Building the project
+
+If you want to build the project and run its tests, remember to install all (client and server) required gem. 
+"Bundler":http://gembundler.com/ is required to easily manage dependencies
+
+<pre>
+bundle install
+rake test:spec test:integration
+</pre>
+
+<script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-11770776-1");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+
+h2. Contributions
+
+Restfulie was created and is maintained by "Caelum":http://caelumobjects.com, and has received enormous contributions from all those developers:
+
+Project Leader
+Guilherme Silveira, "Caelum":http://www.caelum.com.br
+
+Caue Guerra, caelum
+George Guimaraes, abril and plataforma
+Fabio Akita
+Diego Carrion
+Leandro Silva
+Gavin-John Noonan
+Antonio Marques
+Luis Cipriani, abril
+Everton Ribeiro, abril
+Paulo Ahagon, abril
+Elomar França
+Thomas Stefano
+"David Paniz":"http://www.caelum.com.br"
+"Caike Souza":"http://www.caikesouza.com/blog"
+
+h2. Rails 2
+
+If you want to use Restfulie with Rails2, please use any release up to 0.9.2 and its minor releases.

data/Rakefile

@@ -0,0 +1,146 @@
+require 'rubygems'
+require 'rubygems/specification'
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require File.expand_path('lib/restfulie')
+
+GEM = "restfulie"
+GEM_VERSION = Restfulie::VERSION
+SUMMARY  = "Hypermedia aware resource based library in ruby (client side) and ruby on rails (server side)."
+AUTHOR   = "Guilherme Silveira, Caue Guerra, Luis Cipriani, Everton Ribeiro, George Guimaraes, Paulo Ahagon, Several contributors"
+EMAIL    = "guilherme.silveira@caelum.com.br"
+HOMEPAGE = "http://restfulie.caelumobjects.com"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.summary = SUMMARY
+  s.require_paths = ['lib']
+  s.files = FileList['lib/**/*.rb', '[A-Z]*', 'lib/**/*.rng'].to_a
+  s.add_dependency("nokogiri", [">= 1.4.2"])
+  s.add_dependency("actionpack", [">= 2.3.2"])
+  s.add_dependency("activesupport", [">= 2.3.2"])
+  s.add_dependency("json_pure", [">= 1.2.4"])
+
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+end
+
+module FakeServer
+  def self.wait_server(port=3000)
+    (1..15).each do 
+      begin
+        Net::HTTP.get(URI.parse("http://localhost:#{port}/"))
+        return
+      rescue
+        sleep 1
+      end
+    end
+    raise "Waited for the server but it did not finish"
+  end
+  
+  def self.start_sinatra
+    IO.popen("cd tests && ruby ./spec/requests/fake_server.rb") do |pipe|
+      wait_server 4567
+      yield
+      Process.kill 'INT', pipe.pid
+    end
+  end
+  
+  def self.run(setup, process)
+    success = IO.popen(setup) do |pipe|
+      wait_server
+      success = system "rake spec"
+      Process.kill 'INT', pipe.pid
+      success
+    end
+    if !success
+      raise "Some of the specs failed"
+    end
+  end
+  
+  def self.start_server_and_run_spec(target_dir)
+    success = Dir.chdir(File.join(File.dirname(__FILE__), target_dir)) do
+      system('rake db:drop db:create db:migrate')
+      self.run "rails server", "rake spec"
+    end
+  end
+  
+end
+
+# optionally loads a task if the required gems exist
+def optionally
+  begin
+    yield
+  rescue LoadError; end
+end
+
+namespace :test do
+  
+  task :spec do
+    FakeServer.start_sinatra do
+      FakeServer.start_server_and_run_spec "tests"
+    end
+  end
+  
+  task :integration do
+    FakeServer.start_server_and_run_spec "full-examples/rest_from_scratch/part_1"
+    FakeServer.start_server_and_run_spec "full-examples/rest_from_scratch/part_2"
+    FakeServer.start_server_and_run_spec "full-examples/rest_from_scratch/part_3"
+  end
+  
+  task :sinatra do
+    FakeServer.start_sinatra do
+      puts "Press something to quit"
+      gets
+    end
+  end
+  
+  task :all => ["spec","integration"]
+  
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # t.spec_files = FileList['spec_*.rb']
+  t.spec_opts = ['--colour', '--format progress']
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::RDocTask.new("rdoc") do |rdoc|
+   rdoc.options << '--line-numbers' << '--inline-source'
+end
+
+optionally do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/restfulie/**/*.rb', 'README.textile']
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  sh %{gem install pkg/#{GEM}-#{GEM_VERSION} -l}
+end
+
+desc "Create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Builds the project"
+task :build => ["install", "test:spec"]
+
+desc "Default build will run specs"
+task :default => :build
+

data/lib/restfulie/client/base.rb

@@ -0,0 +1,36 @@
+module Restfulie
+  module Client#:nodoc
+    module Base
+      
+      def method_missing(sym, *args, &block)
+        if @base_position.respond_to?(sym)
+          @base_position.send sym, *args, &block
+        else
+          super(sym, *args, &block)
+        end
+      end
+     
+      def self.included(base)#:nodoc
+        base.extend(self)
+      end
+  
+      def uses_restfulie(configuration = Configuration.new,&block)
+        EntryPoint.configuration_for(resource_name,configuration,&block)
+        configure
+      end
+  
+      def configure
+        configuration = EntryPoint.configuration_of(resource_name)
+        raise "Undefined configuration for #{resource_name}" unless configuration
+        @base_position = Restfulie.at(configuration.entry_point)
+        configuration.representations.each do |representation_name,representation|
+          register_representation(representation_name,representation)
+        end
+      end
+  
+      def resource_name
+        @resource_name ||= self.class.to_s.to_sym 
+      end
+    end
+  end
+end

data/lib/restfulie/client/cache/basic.rb

@@ -0,0 +1,76 @@
+# Basic cache implementation for restfulie.
+#
+# It uses the request headers and uri to store it in memory.
+# This cache might not be optimal for long running clients, which should use a memcached based one.
+# Use Restfulie::Client.cache_provider to change the provider
+module Restfulie::Client::Cache
+  class Basic
+
+    def put(key, req, response)
+      if Restfulie::Client::Cache::Restrictions.may_cache?(response)
+        Restfulie::Common::Logger.logger.debug "caching #{key} #{response}"
+        cache_add(key, req, response)
+      end
+      response
+    end
+
+    def get(key, request)
+
+      # debugger
+      response = cache_get(key, request)
+      return nil if response.nil?
+
+      if response.has_expired_cache?
+        remove(key)
+      else
+        Restfulie::Common::Logger.logger.debug "RETURNING cache #{key}"
+        cache_hit response
+      end
+
+    end
+    
+    # removes all elements from the cache
+    def clear
+      cache.clear
+    end
+
+  private
+
+    # allows response enhancement when the cache was hit with it
+    def cache_hit(response)
+      response
+    end
+
+    def cache_add(key, req, response)
+      values = (cache.read(key) || []).dup
+      values << [req, response]
+      cache.write(key, values)
+    end
+
+    def cache_get(key, req)
+      return nil unless cache.exist?(key)
+      found = cache.read(key).find do |cached|
+        old_req = cached.first
+        old_response = cached.last
+        
+        headers_match = old_response.vary_headers_for(old_req) == old_response.vary_headers_for(req)
+        if headers_match && old_response.verb == req.verb
+          old_response
+        else
+          false
+        end
+      end
+      found ? found.last : nil
+    end
+
+    def remove(key)
+      cache.delete(key)
+      nil
+    end
+
+    def cache
+      Restfulie::Client.cache_store
+    end
+
+  end
+end

data/lib/restfulie/client/cache/fake.rb

@@ -0,0 +1,15 @@
+# Fake cache that does not cache anything
+# Use Restfulie::Client.cache_provider = Restfulie::Client::Cache::Fake.new
+module Restfulie::Client::Cache
+  class Fake
+    def put(url, req, response)
+      response
+    end
+
+    def get(url, req)
+    end
+
+    def clear
+    end
+  end
+end