rescik 0.2.0

data/README

@@ -0,0 +1,9 @@
+Rescik
+====
+
+Use prawn to generate REST API docummentation.
+
+Usage
+====
+
+Check examples/example.rb for basic usage

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "rescik"
+    gemspec.summary = "REST API docummentation generator"
+    gemspec.description = "Generates docummentation in pdf format using simple DSL"
+    gemspec.email = "imoryc@gmail.com"
+    gemspec.homepage = "http://github.com/ignacy/rescik"
+    gemspec.authors = ["Ignacy Moryc"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+############################

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/examples/example.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/../lib/rescik"
+
+Rescik.generate("REST_API.pdf") do
+  method("POST", "/products") do
+    description "This methods allows us to create new products using XML REST API"
+    params({"name" => ["required", "string", "This is the name"],
+             "product_type" => ["required", "string", "This is product's type"],
+             "cover_id" => ["required", "string", "this is cover id"]})
+
+    example_response(<<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<access-tokens type="array">
+<access-token>
+<single-access-token>WuBcURTUTt4GRg56nRj</single-access-token>
+<user-id type="integer">1</user-id>
+</access-token>
+</access-tokens>
+RESPONSE
+                     )
+  end
+end

data/lib/rescik.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'prawn'
+require "prawn/measurement_extensions"
+
+Prawn.debug = true
+
+class Rescik < Prawn::Document
+
+  def self.generate(outfile, &block)
+    @doc = new(:top_margin => 0.75.in,
+               :bottom_margin => 1.in,
+               :left_margin => 1.in,
+               :right_margin => 1.in,
+               :page_size => [7.0.in, 9.19.in])
+    @doc.instance_eval(&block)
+    @doc.render_file(outfile)
+  end
+
+  def method(type, path)
+    text "#{type.upcase} #{path}", :size => 11, :style => :bold
+    stroke_horizontal_rule
+    move_down 15
+    yield
+  end
+
+  def description(desc)
+    move_down 10
+    text "Description:", :style => :bold, :size => 9
+    move_down 5
+    text desc, :size => 9
+  end
+
+  def params(opts)
+    move_down 10
+    text "Parameters", :style => :bold, :size => 9
+    move_down 5
+    opts.each { |k, v|
+      text "- #{k}", :style => :bold, :size => 9
+      text "(#{v.first} prameter; type:  #{v[1]})   #{v.last || ""}", :size => 9
+      move_down(3)
+    }
+  end
+
+  def example_response(response)
+    move_down 10
+    text "Response example:", :style => :bold, :size => 9
+    move_down 5
+    text response, :size => 9
+  end
+
+end

data/rescik.gemspec

@@ -0,0 +1,46 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rescik}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ignacy Moryc"]
+  s.date = %q{2010-11-26}
+  s.description = %q{Generates docummentation in pdf format using simple DSL}
+  s.email = %q{imoryc@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+     "Rakefile",
+     "VERSION",
+     "examples/example.rb",
+     "lib/rescik.rb",
+     "pkg/rescik-0.1.0.gem",
+     "rescik.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ignacy/rescik}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{REST API docummentation generator}
+  s.test_files = [
+    "examples/example.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rescik
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Ignacy Moryc
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Generates docummentation in pdf format using simple DSL
+email: imoryc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- examples/example.rb
+- lib/rescik.rb
+- pkg/rescik-0.1.0.gem
+- rescik.gemspec
+has_rdoc: true
+homepage: http://github.com/ignacy/rescik
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: REST API docummentation generator
+test_files: 
+- examples/example.rb