wadl_generator 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in wadl_generator.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,64 @@
+# WADL Generator
+
+## Installation
+
+    # Gemfile
+    gem 'wadl_generator'
+
+## Usage / Example
+
+#### config/routes.rb
+
+    namespace 'api' do
+      namespace 'v1' do
+        get 'description.:format' => 'base#description'
+        resources :posts, :only => [:index, :show]
+      end
+    end
+
+#### app/controllers/api/v1/base_controller.rb
+
+    class Api::V1::BaseController < ApplicationController
+      def description
+        respond_to do |format|
+          format.html do
+            render :text => %q{<iframe src="http://apigee.com/<user>/embed/console/<name>" 
+              width="100%" height="95%"></iframe>}
+          end
+    
+          format.wadl do
+            render :text => WADL::Generator.new(wadl_description, :apigee => true), 
+              :content_type => 'application/xml'
+          end
+        end
+      end
+
+      private
+
+      def wadl_description
+        {
+          :base => "#{request.url.gsub('/description.wadl', '')}",
+          :resources => {
+            'posts' => {
+              :index_formats => {
+                :json => 'application/json',
+              },
+              :show_formats => {
+                :json => 'application/json',
+                :html => 'application/html',
+                :pdf => 'application/pdf',
+              },
+              :example_id => 28,
+            },
+          }
+        }
+      end
+    end
+
+## Todos
+
+* Add tests
+
+## License
+
+MIT License - Thomas Maurer

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/wadl/generator.rb

@@ -0,0 +1,78 @@
+module WADL
+  class Generator
+    VERSION = '0.1.0'
+    
+    attr_reader :description, :options, :wadl
+
+    def initialize(description, options = {})
+      @description, @options, @wadl = description, options, ''
+    end
+
+    def to_text
+      generate
+      @wadl
+    end
+
+    def generate
+      xml = Builder::XmlMarkup.new :indent => 2, :target => @wadl
+      xml.instruct!
+
+      namespaces = {
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+        'xsi:schemaLocation' => 'http://wadl.dev.java.net/2009/02',
+        'xmlns' => 'http://wadl.dev.java.net/2009/02',
+      }
+      
+      if options[:apigee]
+        namespaces['xmlns:apigee'] = 'http://api.apigee.com/wadl/2010/07/'
+        namespaces['xsi:schemaLocation'] << ' http://apigee.com/schemas/wadl-schema.xsd http://api.apigee.com/wadl/2010/07/ http://apigee.com/schemas/apigee-wadl-extensions.xsd'
+      end
+
+      xml.application(namespaces) do
+        xml.resources(:base => description[:base]) do
+          description[:resources].each do |name, config|
+            # index
+            xml.resource(:path => "#{name.pluralize.underscore}.{format}") do
+              xml.param(:name => 'format', :type => 'xsd:string', :style => 'template',
+                  :required => true, :default => config[:index_formats].keys.first) do
+                config[:index_formats].each do |format, mime_type|
+                  xml.option(:value => format, :mediaType => mime_type)
+                end
+              end
+
+              xml.method('id' => name.pluralize.underscore, 'name' => 'GET') do
+                if options[:agigee]
+                  xml.tag!('apigee:tags') { xml.tag!('apigee:tag', name.singularize.camelcase, :primary => true) }
+                  xml.tag!('apigee:authentication', :required => false)
+                  xml.tag!('apigee:example', :url => "/#{name.pluralize.underscore}.#{config[:index_formats].keys.first}")
+                end
+              end
+            end
+
+            # show
+            xml.resource(:path => "#{name.pluralize.underscore}/{id}.{format}") do
+              xml.param(:name => 'format', :type => 'xsd:string', :style => 'template',
+                  :required => true, :default => config[:show_formats].keys.first) do
+                config[:show_formats].each do |format, mime_type|
+                  xml.option(:value => format, :mediaType => mime_type)
+                end
+              end
+              xml.param(:name => 'id', :type => 'xsd:string', :style => 'query', :required => true)
+
+              xml.method('id' => name.singularize.underscore, 'name' => 'GET') do
+                if options[:agigee]
+                  xml.tag!('apigee:tags') { xml.tag!('apigee:tag', name.singularize.camelcase, :primary => true) }
+                  xml.tag!('apigee:authentication', :required => false)
+                  xml.tag!('apigee:example', :url => "/#{name.pluralize.underscore}/#{config[:example_id]}.#{config[:show_formats].keys.first}")
+                end
+              end
+            end
+          end
+        end
+      end    
+    
+      self
+    end
+  end
+end

data/lib/wadl_generator.rb

@@ -0,0 +1 @@
+require 'wadl/generator'

data/wadl_generator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "wadl/generator"
+
+Gem::Specification.new do |s|
+  s.name        = "wadl_generator"
+  s.version     = WADL::Generator::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Thomas Maurer"]
+  s.email       = ["tma@freshbit.ch"]
+  s.homepage    = ""
+  s.summary     = %q{Simple WADL Generator targeted on REST APIs with optional Apigee Flavour}
+  s.description = %q{Simple WADL Generator targeted on REST APIs with optional Apigee Flavour}
+
+  s.rubyforge_project = "wadl_generator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: wadl_generator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Thomas Maurer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-10 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Simple WADL Generator targeted on REST APIs with optional Apigee Flavour
+email: 
+- tma@freshbit.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/wadl/generator.rb
+- lib/wadl_generator.rb
+- wadl_generator.gemspec
+has_rdoc: true
+homepage: ""
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: wadl_generator
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Simple WADL Generator targeted on REST APIs with optional Apigee Flavour
+test_files: []
+