buttless 0.0.1

data/lib/template/readme.textile

@@ -0,0 +1,122 @@
+h1. My Buttless API
+
+Congratulations, you've just started using Buttless to design, document and develop against your API.
+
+Buttless lets you design an API, generate docs, and develop against it in minutes. No need to have a real back-end in place. 
+
+See the "Buttless home page":https://github.com/tobinharris/buttless for more info.
+
+
+h2. About 
+
+Buttless is pretty simple. It's structured like this:
+
+* You define your API end points, parameters and descriptions in the @database.yml@ file
+* You add example responses in the @/json_examples@ folder
+* You add tests for the API, if you want to, in the @/test@ folder.
+
+Creating and modifying your API's design takes seconds or minutes once you get the hang of it. 
+
+After that, you can:
+
+* Run a web server which will serve up your designed API with example data to develop against
+* Generate pretty PDF's documenting your API to give to developers to build the real deal against
+* Generate pretty HTML documenting for your API
+* Run tests the real API, to make sure it's being developed according to your design
+
+h2. Getting Started
+
+h3. Install Gems
+
+Install necessary gems.
+
+<pre>
+bundle install
+</pre>
+
+h3. Add an API definition to the database.yml file
+
+<pre>
+---
+  - resource: Funky Thing
+    methods:
+      - path: /api/funky/thing
+        resolves_to: /api/funky/thing/info.json
+        method: GET
+        precis: |
+          Returns information about the thing. 
+        description: |
+        parameters:            
+        example_response: funky_thing
+</pre>
+
+h3. Add an example JSON response file
+
+<pre>
+# /json_examples/funky_thing.json
+
+{"id": 2, "name": "Funky Thing"}
+</pre>
+
+h3. Generate the HTML or PDF docs
+
+Your API is defined, now generate the HTML docs using:
+
+<pre>
+rake html
+open api-doc/index.html
+</pre>
+
+Here's a sample:
+
+!http://puu.sh/nobh!
+
+Note it includes the curl statement, API index, descriptions and parameters.
+
+Or, you can generate a similar PDF using
+
+<pre>
+rake pdf
+open api-doc/funky-thing.pdf
+</pre>
+
+
+
+h3. Run a fake API in a web server
+
+<pre>
+  cd server
+  thin start
+</pre>
+
+You're API is now available as a web server. So, without a line of code, you can now do:
+
+<pre>
+curl http://localhost:3000/api/funky/stuff
+</pre>
+
+Which outputs
+
+<pre>
+  [
+    {"id": 1, "name": "Funky 1"},
+    {"id": 2, "name": "Funky 2"}
+  ]
+</pre>
+
+That response was the example JSON file referenced in your documentation. 
+
+This is handy if your an iPhone developer, cause you can define your own API, develop against it, and then once you're ready, ask a server-side developer to build the real API!
+
+h5. Define some tests for the API 
+
+It's easier to write API's if you have test cases setup to cover what is needed by the client. Simply add these to the ./test/ folder and then:
+
+<pre>
+rake test
+</pre>
+
+
+
+
+

data/lib/template/server/config.ru

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+
+@home_dir = File.dirname(__FILE__) + '/../'
+
+
+
+# Create new Sinatra controller
+controller = Sinatra.new do
+  enable :logging  
+  set :root, '../api-doc/'
+  configure do
+    set :views, ''
+  end
+  
+end
+
+# Loop through our API database
+# setting up the sinatra app dynamically
+map('/') do 
+  run Sinatra.new(controller){              
+  @db = YAML::load( File.open( "../database.yaml" ) )  
+  @db.each do |resource|    
+    resource["methods"].each do |method|
+      #next if method["path"] =~ /comfort_/
+      puts "Configuring #{method["path"]}"
+      
+      # map the path of the API method    
+      
+      
+        # if it's a POST method
+        if method["method"] == "POST"                     
+          post(method["path"]){ 
+            content_type :json
+            File.open("../json_examples/#{method["example_response"]}.json".downcase,'r').read 
+          }
+        else
+          get(method["path"]){ 
+            content_type :json
+            File.open("../json_examples/#{method['example_response']}.json".downcase,'r').read 
+            }
+        end      
+    end
+  end
+  }
+end
+
+

data/lib/template/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'minitest/pride'
+require 'minitest/reporters'
+require 'rest-client'
+require 'json'
+
+
+module MiniTest
+  module Reporters
+    class SpecReporter
+      private
+      def print_test_with_time(test)
+        total_time = Time.now - runner.test_start_time
+        print(" %s (%.2fs)" % [test.gsub(/test_|[0-9]{4,4}|_/,' ').strip, total_time])
+      end
+    end
+  end
+end
+
+
+MiniTest::Unit.runner = MiniTest::SuiteRunner.new
+MiniTest::Unit.runner.reporters << MiniTest::Reporters::SpecReporter.new 
+
+def prepare
+  @examples_dir = File.dirname(__FILE__) + "/../json_examples/"
+  @localhost = "http://192.168.1.3/api"
+end
+
+def json(data)
+  JSON.parse(data)
+end
+

data/lib/template/test/test_stuff.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+describe "When accessing THe Funky" do
+  describe "using resource Funky" do
+
+    it "should allow reading of thing" do
+      skip
+    end
+
+    it "should allow reading of stuff" do
+      skip
+    end
+    
+  end
+end

data/readme.textile

@@ -0,0 +1,50 @@
+h1. Buttless
+
+h2. Design, document and develop against API's in minutes without a back-end. 
+
+I wrote Buttless because "Engine Room Apps":http://engineroomapps.com often have to develop an iPhone app or web site without having the backend API or in place yet. This is pretty common when you're back-end developers are not in the office, or if you're waiting for your client's team to get on to it!
+
+With Buttless, you can do the following pretty quickly:
+
+# Define an API (resources, methods, parameters) using a simple YAML file
+# Define example JSON results that the API would send back
+# Generate pretty HTML and PDF documents for that defined API, which include usage instructions with CURL
+# Run a web server which creates a pretend backend for your API, so if you're an iPhone developer you have something to code against instantly
+
+h2. Getting Started
+
+Install the gem
+
+<pre>
+  gem install buttless
+</pre>
+
+Then go to your usual code folder and type
+
+<pre>
+  buttless my-first-api
+</pre>
+
+Congrats, you've just started defining your API, and will be soon able to generate docs and develop against it. 
+
+Now to "learn how to work with your API":https://github.com/tobinharris/buttless/blob/master/lib/template/readme.textile.
+
+
+h2. 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.
+
+h2. Copyright
+
+Copyright (c) 2012 Tobin Harris. See LICENSE.txt for
+further details.
+
+
+
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'buttless'
+
+class Test::Unit::TestCase
+end

data/test/test_buttless.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestButtless < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,287 @@
+--- !ruby/object:Gem::Specification
+name: buttless
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tobin Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70116055586520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055586520
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70116055585380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055585380
+- !ruby/object:Gem::Dependency
+  name: pdfkit
+  requirement: &70116055584240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055584240
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70116055583200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055583200
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70116055581980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055581980
+- !ruby/object:Gem::Dependency
+  name: googlecharts
+  requirement: &70116055580500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055580500
+- !ruby/object:Gem::Dependency
+  name: array_stats
+  requirement: &70116055573340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055573340
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70116055572220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055572220
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70116055570620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055570620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70116055569540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055569540
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &70116055567060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055567060
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: &70116055559540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055559540
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70116055558580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70116055558580
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70116055557600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116055557600
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70116055556580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70116055556580
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70116055555460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70116055555460
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70116055554460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70116055554460
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70116055553020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116055553020
+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.
+email: tobin@tobinharris.com
+executables:
+- buttless
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README_old.rdoc
+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
+homepage: http://github.com/tobinharris/buttless
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4276506953416819614
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Design, document and develop against an API without having a backend.
+test_files: []