web_service_documenter 0.0.1

data/bin/web_service_documenter

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "lib", "web_service_documenter")
+
+WebServiceDocumenter.generate(ARGV[0])

data/lib/web_service_documenter.rb

@@ -0,0 +1,108 @@
+require "rubygems"
+require 'yaml'
+require 'json'
+require 'net/http'
+require 'cgi'
+
+class WebServiceDocumenter
+  class Service
+    def initialize(base_uri, options)
+      @base_uri       = base_uri
+      @endpoint       = options["endpoint"]
+      @params         = options["params"]
+      @method         = (options["method"] || "get").downcase
+      @example_params = create_example_params
+    end
+
+    def to_s
+      body = ""
+
+      url = "http://#{@base_uri}#{@endpoint}"
+      uri = URI.parse(url)
+
+      result = if @method =~ /post/
+        Net::HTTP.post_form(uri, @example_params)
+      else
+        http = Net::HTTP.new(uri.host, uri.port)
+        request = Net::HTTP::Get.new(uri.path)
+        request.set_form_data(@example_params)
+
+        request  = Net::HTTP::Get.new("#{uri.path}?#{request.body}")
+        http.request(request)
+      end
+
+      if !result.kind_of?(Net::HTTPOK)
+        raise "Couldn't perform request with url: #{url}"
+      end
+
+      json_response = JSON.parse(result.body)
+
+      body << "\n"
+      body << "==================================================\n"
+
+      body << "URL: #{@endpoint} (#{@method.upcase})\n"
+      body << "\n"
+
+      body << "Request Params: \n"
+      body << "\n"
+
+      if @params && @params.any?
+        @params.each do |key, value|
+          body << "  #{key} \n"
+
+          @params[key].each do |k,v|
+            body << "    #{k}: #{v} \n"
+          end
+        end
+      else
+        body << "  None"
+      end
+
+      body << "\n"
+      body << "Response: \n"
+      body << "\n"
+      body << JSON.pretty_generate(json_response)
+      body << "\n"
+      body << "\n"
+      body
+    end
+
+  private
+
+    def create_example_params
+      hash = {}
+
+      @params.each do |key, value|
+        hash[key] = value["example_value"]
+      end
+
+      hash
+    end
+  end
+
+  def self.generate(path_to_web_services)
+    new.generate(path_to_web_services)
+  end
+
+  def generate(path_to_web_services)
+    @yml_file     = YAML.load_file(path_to_web_services)
+    @web_services = @yml_file["web_services"]
+    @base_uri     = @yml_file["settings"]["base_uri"]
+
+    curl_services
+  end
+
+private
+
+  def curl_services
+    body = ""
+
+    @web_services.each do |web_service|
+      service = Service.new(@base_uri, web_service)
+      body << service.to_s
+      body << " \n"
+    end
+
+    print body
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: web_service_documenter
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Taylor
+- Stephen Schor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-10 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- scott@railsnewbie.com
+- beholdthepanda@gmail.com
+executables: 
+- web_service_documenter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/web_service_documenter
+- lib/web_service_documenter.rb
+has_rdoc: true
+homepage: https://github.com/eastmedia/web_services_documenter
+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: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Deploy with masculine confidence
+test_files: []
+