buttless 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,28 @@
+source :gemcutter #"http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'rest-client'
+gem 'json'
+gem 'pdfkit'
+gem 'activesupport'
+gem 'minitest'
+gem 'googlecharts'
+gem 'array_stats'
+gem 'redcarpet'
+gem 'webmock'
+gem 'rake'
+gem 'tilt'
+gem 'minitest-reporters'
+gem 'sinatra'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0" 
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    addressable (2.2.7)
+    ansi (1.4.2)
+    array_stats (0.6.0)
+    crack (0.3.1)
+    git (1.2.5)
+    googlecharts (1.6.8)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    mime-types (1.18)
+    minitest (2.11.4)
+    minitest-reporters (0.5.1)
+      ansi
+      minitest (~> 2.0)
+      ruby-progressbar
+    multi_json (1.1.0)
+    pdfkit (0.5.2)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    ruby-progressbar (0.0.10)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+    webmock (1.8.4)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  array_stats
+  bundler (~> 1.0.0)
+  googlecharts
+  jeweler (~> 1.8.3)
+  json
+  minitest
+  minitest-reporters
+  pdfkit
+  rake
+  rdoc (~> 3.12)
+  redcarpet
+  rest-client
+  shoulda
+  simplecov
+  sinatra
+  tilt
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Engine Room Apps
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README_old.rdoc

@@ -0,0 +1,19 @@
+= buttless
+
+Description goes here.
+
+== Contributing to buttless
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Tobin Harris. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "buttless"
+  gem.homepage = "http://github.com/tobinharris/buttless"
+  gem.license = "MIT"
+  gem.summary = %Q{Design, document and develop against an API without having a backend.}
+  gem.description = %Q{Buttless gives you a way to quickly flesh out an API in detail. It generates sexy documentation. And, you can quickly run the API and simulate various scenarios without neededing a backend.}
+  gem.email = "tobin@tobinharris.com"
+  gem.authors = ["Tobin Harris"]  
+  gem.files.include 'lib/template/*'
+  gem.files.include 'lib/template/api-doc/*'
+  gem.files.include 'lib/template/api-doc/images/*'
+  gem.files.include 'lib/template/code_samples/*'
+  gem.files.include 'lib/template/json_examples/*'
+  gem.files.include 'lib/template/server/*'
+  gem.files.include 'lib/template/test/*'
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'simplecov/simplecovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "buttless #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/buttless

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+unless ARGV.empty?
+  file = File.expand_path(File.dirname(__FILE__)) + '/..'  
+  
+  if ARGV[0] == "--update"
+    exec "cp -r #{file}/lib/template/server/* server/"
+    exec "cp #{file}/lib/template/Rakefile ."
+    exec "cp #{file}/lib/template/Gemfile ."
+  else    
+    cmd = "cp -r #{file}/lib/template #{ARGV[0]}"
+    puts cmd
+  end
+else
+  puts "\n\nButtless\nLets you design, document and develop against an API without having a backend.\n\nUsage\n\n\tbuttless my_api_project      # Generates an empty buttless folder"
+end

data/buttless.gemspec

@@ -0,0 +1,127 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "buttless"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobin Harris"]
+  s.date = "2012-04-01"
+  s.description = "Buttless gives you a way to quickly flesh out an API in detail. It generates sexy documentation. And, you can quickly run the API and simulate various scenarios without neededing a backend."
+  s.email = "tobin@tobinharris.com"
+  s.executables = ["buttless"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README_old.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README_old.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/buttless",
+    "buttless.gemspec",
+    "lib/buttless.rb",
+    "lib/template/.DS_Store",
+    "lib/template/Gemfile",
+    "lib/template/Gemfile.lock",
+    "lib/template/Rakefile",
+    "lib/template/api-doc/.DS_Store",
+    "lib/template/api-doc/images/logo.png",
+    "lib/template/api-doc/index.html",
+    "lib/template/api-doc/index.md.erb",
+    "lib/template/api-doc/report.css",
+    "lib/template/api-doc/screen.css",
+    "lib/template/api-doc/template.html.erb",
+    "lib/template/code_samples/prthw.md.erb",
+    "lib/template/config.yaml",
+    "lib/template/database.yaml",
+    "lib/template/install",
+    "lib/template/json_examples/funky_stuff.json",
+    "lib/template/json_examples/funky_stuff_info.json",
+    "lib/template/json_examples/funky_thing.json",
+    "lib/template/json_examples/post_ok.json",
+    "lib/template/readme.textile",
+    "lib/template/server/config.ru",
+    "lib/template/test/test_helper.rb",
+    "lib/template/test/test_stuff.rb",
+    "readme.textile",
+    "test/helper.rb",
+    "test/test_buttless.rb"
+  ]
+  s.homepage = "http://github.com/tobinharris/buttless"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Design, document and develop against an API without having a backend."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<pdfkit>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<minitest>, [">= 0"])
+      s.add_runtime_dependency(%q<googlecharts>, [">= 0"])
+      s.add_runtime_dependency(%q<array_stats>, [">= 0"])
+      s.add_runtime_dependency(%q<redcarpet>, [">= 0"])
+      s.add_runtime_dependency(%q<webmock>, [">= 0"])
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<tilt>, [">= 0"])
+      s.add_runtime_dependency(%q<minitest-reporters>, [">= 0"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<pdfkit>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<googlecharts>, [">= 0"])
+      s.add_dependency(%q<array_stats>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<tilt>, [">= 0"])
+      s.add_dependency(%q<minitest-reporters>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<pdfkit>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<googlecharts>, [">= 0"])
+    s.add_dependency(%q<array_stats>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<tilt>, [">= 0"])
+    s.add_dependency(%q<minitest-reporters>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/template/Gemfile

@@ -0,0 +1,14 @@
+source :gemcutter
+gem 'rest-client'
+gem 'json'
+gem 'pdfkit'
+gem 'activesupport'
+gem 'minitest'
+gem 'googlecharts'
+gem 'array_stats'
+gem 'redcarpet'
+gem 'webmock'
+gem 'rake'
+gem 'tilt'
+gem 'minitest-reporters'
+gem 'sinatra'

data/lib/template/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    addressable (2.2.7)
+    ansi (1.4.2)
+    array_stats (0.6.0)
+    crack (0.3.1)
+    googlecharts (1.6.8)
+    json (1.6.3)
+    mime-types (1.17.2)
+    minitest (2.11.2)
+    minitest-reporters (0.5.1)
+      ansi
+      minitest (~> 2.0)
+      ruby-progressbar
+    multi_json (1.0.4)
+    pdfkit (0.5.2)
+    rack (1.3.5)
+    rack-protection (1.1.4)
+      rack
+    rake (0.9.2.2)
+    redcarpet (2.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    ruby-progressbar (0.0.10)
+    sinatra (1.3.1)
+      rack (>= 1.3.4, ~> 1.3)
+      rack-protection (>= 1.1.2, ~> 1.1)
+      tilt (>= 1.3.3, ~> 1.3)
+    tilt (1.3.3)
+    webmock (1.8.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  array_stats
+  googlecharts
+  json
+  minitest
+  minitest-reporters
+  pdfkit
+  rake
+  redcarpet
+  rest-client
+  sinatra
+  tilt
+  webmock

data/lib/template/Rakefile

@@ -0,0 +1,96 @@
+require 'rubygems'
+require "bundler/setup"
+require 'rake/testtask'
+require 'pdfkit'
+require 'redcarpet'
+require 'erb'
+require 'tilt'
+
+class Helper
+  def example_path(method, ip=nil)
+    path = method["path"]
+    params = []
+    method["parameters"].each do |p|      
+      next if p["optional"] or p["type"]=="POST" 
+      if path.include?(":#{p['name']}") 
+        path.gsub!(":#{p['name']}", p["example"].to_s)
+        next
+      end
+      params << "#{p["name"]}=#{p["example"]}"            
+    end unless method["parameters"].nil?
+    
+    api_call = "#{path}?#{params.join('&')}"
+    #puts "**** WARNING **** \n Method length is #{api_call.length}, which is greater than 19 so won't work on some embedded devices: #{api_call}" if "#{path}?#{params.join('&')}".length > 19
+    "#{ip}#{api_call}"
+  end
+  
+  def example_curl(method, ip="http://192.168.1.3", no=2)
+    path = example_path(method, ip)
+    i = 0
+    params = []    
+    method["parameters"].select{|p|p["type"]=="POST"}.each do |p|
+      break unless i < no or p["optional"] == false
+      i=i+1 
+      params << "#{p["name"]}=#{p["example"]}"
+    end if method["parameters"]
+    data = nil
+    unless params.empty?
+      data = "--data \"#{params.join('&')}\"  \\\n"
+    end
+    "curl -v #{data.nil? ? '' : "\\\n #{data}"} #{path}".chomp('?')
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Generate HTML and PDF"
+task :gen => [:html, :pdf]
+
+desc "Generate HTML docs"
+task :html => :prepare do  
+  File.open('index.html','w').write(@html)    
+end
+
+desc "Generate PDF docs"
+task :pdf => :prepare do  
+  `/Applications/wkhtmltopdf.app/Contents/MacOS/wkhtmltopdf --page-size A4 --margin-left 20mm --margin-right 20mm --margin-top 20mm --margin-bottom 20mm index.html #{@config["full_title"]}.pdf`
+  #`wkhtmltopdf --page-size A4 --margin-left 20mm --margin-right 20mm --margin-top 20mm --margin-bottom 20mm index.html #{@config["full_title"]}.pdf`
+  
+  # PDFKit.configure do |config|
+  #     config.root_url = @root_url
+  # end
+  # 
+  # kit = PDFKit.new(@html, :page_size => 'A4') #:print_media_type => true, 
+  # kit.stylesheets << 'report.css'
+  # file = kit.to_file("#{@config["full_title"]}.pdf")
+end
+
+desc "Prepare for generation"
+task :prepare do
+  @home_dir = File.dirname(__FILE__)
+  Dir.chdir('api-doc')
+  @root_url = "file://localhost#{Dir.pwd}/"
+  
+  @config = YAML::load( File.open( "#{@home_dir}/config.yaml" ) )  
+  @db = YAML::load( File.open( "#{@home_dir}/database.yaml" ) )
+    
+  doc = Tilt.new("index.md.erb").render(self, :db=>@db, :helper=>Helper.new, :config=>@config)
+  md = Redcarpet::Markdown.new(Redcarpet::Render::HTML.new(render_options={}), extensions={:tables=>true})
+  #toc = Redcarpet::Markdown.new(Redcarpet::Render::HTML_TOC.new())
+  @content = md.render(doc)
+  
+  @html = ERB.new(File.open('template.html.erb','r').read()).result(binding())
+  @html = @html.gsub(/root_url/,@root_url)    
+  
+end
+
+def example(name)
+   return "TODO" if name.nil?
+   name = name.to_s   
+   File.open("#{@home_dir}/json_examples/#{name}.json".downcase,'r').read()
+end