optionsful 0.1.8 → 0.2.3

data/spec/optionsful_documentator_spec.rb

@@ -1,117 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper'
-
-
-describe Baurets::Optionsful::Documentator do
-
-  include Rack::Test::Methods
-
-  Baurets::Optionsful::Documentator.send(:remove_const, :RAILS_ROOT) if Baurets::Optionsful::Documentator.const_defined?(:RAILS_ROOT)
-  Baurets::Optionsful::Documentator.const_set(:RAILS_ROOT, File.join(File.dirname(__FILE__), 'samples' ) )
-  base_path = ::Baurets::Optionsful::Config.new.base_path
-
-  describe "as a Rack middleware" do
-
-    it "is a Ruby object that responds to call;" do
-      assert ::Baurets::Optionsful::Documentator.new(app).respond_to? :call
-    end
-
-    before do
-      ActionController::Routing::Routes.draw do |map| 
-        map.resources :posts, :has_many => :comments
-      end
-    end
-
-    it "takes exactly one argument, (the environment) and returns an Array;" do
-      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => (base_path + "/posts")}))
-      assert response.kind_of?(Array)
-    end
-
-    it "the returned Array must have exactly three values: the status, the headers and the body;" do
-      response = ::Baurets::Optionsful::Documentator.new(app).call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => (base_path + "/posts")}))
-      assert response.size.should == 3
-      assert response[0].kind_of? Fixnum 
-      assert response[1].kind_of? Hash
-      assert response[2].kind_of? String
-    end
-
-    it "must be nice, acting somewhere on a Rack middleware stack." do
-      response = fake_docs_app.call(mock_env({"REQUEST_METHOD" => "GET", "PATH_INFO" => "/lobster"}))
-      assert response.size.should == 3
-      assert response[0].kind_of? Fixnum
-      assert response[0].should == 200
-      assert response[1].kind_of? Hash
-    end
-
-  end
-
-  describe "extracts metadata information about a resource" do
-
-    describe "MUST override Rails routing recognition successfully" do 
-
-      before(:all) do
-        ActionController::Routing::Routes.draw do |map| 
-          map.resources :posts, :has_many => :comments
-          map.resources :notes
-          map.resources :stuff
-          map.resources :trips
-          map.resources :teams
-        end
-      end
-
-      it "may let the request go through if base path doesn't match" do
-        pending
-        # req_path =  "/xyz"
-        #         response = http_get_request(req_path)
-        #         assert response[0].kind_of? Fixnum
-        #         assert response[0].should_not == 500
-      end
-
-
-      it "MAY find proper structured information and build an html response" do
-        Baurets::Optionsful::Documentator.send(:remove_const, :RAILS_ROOT) if Baurets::Optionsful::Documentator.const_defined?(:RAILS_ROOT)
-        Baurets::Optionsful::Documentator.const_set(:RAILS_ROOT, File.join(File.dirname(__FILE__), 'samples' ) )
-        req_path = base_path + "/posts"
-        response = http_get_request(req_path)
-
-        assert response[0].kind_of? Fixnum
-        assert response[0].should == 200
-      end
-
-      it "MAY NOT find proper structured information and build an html response" do
-        req_path = base_path + "/notes"
-        response = http_get_request(req_path)
-        assert response.kind_of?(Array)
-        assert response[0].kind_of? Fixnum
-      end
-      
-      it "MAY NOT find controller file and build an html response" do
-        req_path = base_path + "/stuff"
-        response = http_get_request(req_path)
-        assert response.kind_of?(Array)
-        assert response[0].kind_of? Fixnum
-      end
-      
-      it "MAY NOT understand anything" do
-        req_path = base_path + "/trips"
-        response = http_get_request(req_path)
-        assert response.kind_of?(Array)
-        assert response[0].kind_of? Fixnum
-      end
-      
-      it "MAY NOT understand anything" do
-        req_path = base_path + "/teams"
-        response = http_get_request(req_path)
-        assert response.kind_of?(Array)
-        assert response[0].kind_of? Fixnum
-      end
-
-
-      after(:all) do
-        ActionController::Routing::Routes.reload!
-      end
-
-    end
-
-  end
-
-end

data/spec/samples/app/controllers/comments_controller.rb

@@ -1,86 +0,0 @@
-# --- 
-# service: 
-#   title: Post comments controller
-#   entrypoint: /posts/:post/comments
-#   support: kayaman@baurets.net
-#   description: Comments Service allow you say shit about anything you dislike!
-class CommentsController < ApplicationController
-
-  # --- 
-  # resource: 
-  #   title: list
-  #   identifier: /posts/{:post}/comments
-  #   support: kayaman@baurets.net
-  #   description:  Create new comments over a post instance.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def index
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def show
-  end
-
-
-  def new
-  end
-
-
-  def update
-  end
-
-
-  def delete
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def create
-    @post = Post.find(params[:post_id])
-    @comment = @post.comments.create!(params[:comment])
-    respond_to do |format|
-      format.html { redirect_to @post }
-      format.js
-    end
-  end
-end

data/spec/samples/app/controllers/notes_controller.rb

@@ -1,6 +0,0 @@
-class NotesController < ApplicationController
-  
-  
-  
-  
-end

data/spec/samples/app/controllers/posts_controller.rb

@@ -1,185 +0,0 @@
-# --- 
-# service: 
-#   title: Posts front controller
-#   entrypoint: /posts
-#   support: kayaman@baurets.net
-#   description: The Posts sevices let you list, create, update, and delete Posts from our application.
-class PostsController < ApplicationController
-  before_filter :authenticate, :except => [:index, :show]
-
-  # --- 
-  # resource: 
-  #   title: Listing
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description: List posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: cache-control
-  def index
-    @posts = Post.find(:all)
-
-    respond_to do |format|
-      format.html # index.html.erb
-      format.xml  { render :xml => @posts }
-      format.json { render :json => @posts }
-      format.atom
-    end
-  end
-
-  # --- 
-  # resource: 
-  #   title: Posts front controller
-  #   identifier: /posts
-  #   support: kayaman@baurets.net
-  #   description: Retuns all posts.
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  def show
-    @post = Post.find(params[:id])
-
-    respond_to do |format|
-      format.html # show.html.erb
-      format.xml  { render :xml => @post }
-    end
-  end
-
-  # --- 
-  # resource: 
-  #   title: Posts front controller
-  #   identifier: /posts
-  #   support: kayaman@baurets.net
-  #   description: Retuns all posts.
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  def new
-    @post = Post.new
-
-    respond_to do |format|
-      format.html # new.html.erb
-      format.xml  { render :xml => @post }
-    end
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def edit
-    @post = Post.find(params[:id])
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def create
-    @post = Post.new(params[:post])
-
-    respond_to do |format|
-      if @post.save
-        flash[:notice] = 'Post was successfully created.'
-        format.html { redirect_to(@post) }
-        format.xml  { render :xml => @post, :status => :created, :location => @post }
-      else
-        format.html { render :action => "new" }
-        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
-      end
-    end
-  end
-
-  # --- 
-  # resource: 
-  #   title: Posts front controller
-  #   identifier: /posts
-  #   support: kayaman@baurets.net
-  #   description: Retuns all posts.
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  def update
-    @post = Post.find(params[:id])
-
-    respond_to do |format|
-      if @post.update_attributes(params[:post])
-        flash[:notice] = 'Post was successfully updated.'
-        format.html { redirect_to(@post) }
-        format.xml  { head :ok }
-      else
-        format.html { render :action => "edit" }
-        format.xml  { render :xml => @post.errors, :status => :unprocessable_entity }
-      end
-    end
-  end
-
-  # --- 
-  # resource: 
-  #   title: Posts front controller
-  #   identifier: /posts
-  #   support: kayaman@baurets.net
-  #   description: Retuns all posts.
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  def destroy
-    @post = Post.find(params[:id])
-    @post.destroy
-
-    respond_to do |format|
-      format.html { redirect_to(posts_url) }
-      format.xml  { head :ok }
-    end
-  end
-
-  private
-
-  def authenticate
-    authenticate_or_request_with_http_basic do |name, password|
-      name == "admin" && password == "secret"
-    end
-  end
-end

data/spec/samples/app/controllers/teams_controller.rb

@@ -1,33 +0,0 @@
-# --- 
-# service: 
-#   title: Teams controller
-#   entrypoint: /posts/:post/comments
-#   support: kayaman@baurets.net
-#   description: Comments Service allow you say shit about anything you dislike!
-class TripsController < ApplicationController
-
-  # !! something wrong ? & 
-  # & ^% !@#
-  def index
-  end
-
-  def show
-  end
-
-
-  def new
-  end
-
-
-  def update
-  end
-
-
-  def delete
-  end
-
-
-  def create
-
-  end
-end

data/spec/samples/app/controllers/trips_controller.rb

@@ -1,82 +0,0 @@
-##
-# sjdhsdjhsdhhjdhjjdhsjhsdhsdjhjshdjhsdshd
-class TripsController < ApplicationController
-
-  # --- 
-  # resource: 
-  #   title: list
-  #   identifier: /posts/{:post}/comments
-  #   support: kayaman@baurets.net
-  #   description:  Create new comments over a post instance.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def index
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def show
-  end
-
-
-  def new
-  end
-
-
-  def update
-  end
-
-
-  def delete
-  end
-
-  # --- 
-  # resource: 
-  #   title: create
-  #   identifier: /
-  #   support: kayaman@baurets.net
-  #   description:  Create new posts.
-  #   source-link: research
-  #   alternates:
-  #     - one
-  #     - two
-  # representation:
-  #   media-types: 
-  #     - application/xml
-  #     - application/json
-  #   last-modified: 2010-07-23
-  # control:
-  #   cache: no-cache
-  def create
-    @post = Post.find(params[:post_id])
-    @comment = @post.comments.create!(params[:comment])
-    respond_to do |format|
-      format.html { redirect_to @post }
-      format.js
-    end
-  end
-end