medschool 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53704fee4693a236c333219f661fa9454f34c1a8
+  data.tar.gz: 98067f01b54b65da5ae474683c0795bbfcf627a7
+SHA512:
+  metadata.gz: 05f192ff18bf6a245ef9aa71d398c82db1a2ce7f2efc92870019562c8c061e10b57dd4411e96279ee39d7ae65409bf7e786299f2957bc47b71bdf4cf8f3fba42
+  data.tar.gz: 818bfed1da98d9b4943e2eb35e298b739c7d4859c70ba8e2d8f8ff289007fddc471d5813cff267c4eb5681cdab91a97c0a6ce32c33ca11bc5e5834638344a865

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmp/
+.ds_store
+.ruby-version
+.ruby-gemset

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Emily Dobervich; TeamSnap, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,81 @@
+# Medschool
+
+Make your docs smarter! Medschool is a tool for documenting APIs that helps you keep your documentation in-sync with reality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'medschool'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install medschool
+
+## Usage
+
+Write markdown narrative in a `*.md.msd` file:
+
+```
+  ## Creating a new user
+  
+  This is how you create a new user!
+```
+
+Embed requests and responses:
+
+```
+  ## Creating a new user
+  
+  This is how you create a new user!
+  
+  @@@request: creating_a_user
+    type: json
+    method: post
+    route: '/sports'
+    data:
+      user:
+        properties:
+          username:
+            value: "Bobby"
+            type: string
+          password:
+            value: "password"
+            type: string
+  @@@
+  
+  ### Response
+  
+  @@@response: creating_a_user
+    type: json
+    status: 200
+    data:
+      user:
+        username: "Bobby"
+  @@@
+```
+
+### Using Medschool in tests
+
+```ruby
+  msd = Medschool::Example.new(file, request_or_response_name)
+  msd.request_hash # Request hash
+  msd.validate_response(response) # Validates a response object
+```
+
+### Generating HTML Docs
+
+`rake docs:generate`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/medschool

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/lib/medschool/example.rb

@@ -0,0 +1,42 @@
+module Medschool
+  class Example
+    def initialize(path, example_name)
+      self.path = File.join(Medschool.root, "#{path}.md.med")
+      self.example_name = example_name
+      load_examples
+    end
+
+    def request_hash
+      Medschool::HashGenerator.new(raw_request[:data]).process
+    end
+
+    def validate_response(response)
+      Medschool::Validator.new(raw_response, response).validate!
+    end
+
+    private
+
+    attr_accessor :path, :example_name, :raw_request, :raw_response
+
+    def load_examples
+      contents = File.read(path)
+      regex = /^@@@(?<type>request|response): #{example_name}\n(?<yaml>.*?)@@@$/m
+      matches = contents.scan(regex)
+
+      matches.each do |match|
+        load_example_from_match(match)
+      end
+    end
+
+    def load_example_from_match(match)
+      example = YAML.load(match[1]).with_indifferent_access
+
+      case match[0]
+      when "request"
+        self.raw_request = example
+      when "response"
+        self.raw_response = example
+      end
+    end
+  end
+end

data/lib/medschool/hash_generator.rb

@@ -0,0 +1,19 @@
+module Medschool
+  class HashGenerator < SchemaProcessor
+    def initialize(data)
+      self.data = data
+    end
+
+    def process
+      process_properties(data)
+    end
+
+    def check_item(item)
+      item['value']
+    end
+
+    private
+
+    attr_accessor :data
+  end
+end

data/lib/medschool/rails.rb

@@ -0,0 +1,12 @@
+module Medschool
+  module Rails
+  end
+end
+
+Medschool.root = Rails.root.join("features/markdown")
+
+RSpec.configure do |config|
+  config.include RSpec::Rails::RequestExampleGroup, :example_group => {
+    :file_path => config.escaped_path(%w[features])
+  }
+end

data/lib/medschool/railtie.rb

@@ -0,0 +1,5 @@
+class Medschool::Railtie < Rails::Railtie
+  rake_tasks do
+    load "medschool/tasks/generate.rake"
+  end
+end

data/lib/medschool/schema_processor.rb

@@ -0,0 +1,39 @@
+module Medschool
+  class SchemaProcessor
+    def process_item(item, *args)
+      if Array === item
+        process_items(item, *args)
+      elsif item['properties']
+        process_properties(item['properties'], *args)
+      elsif item['type']
+        check_item(item, *args)
+      end
+    end
+
+    def process_properties(properties, *args)
+      h = HashWithIndifferentAccess.new
+      properties ||= {}
+      properties.each do |key, value|
+        h[key] = properties_process_item(value, key, *args)
+      end
+      h
+    end
+
+    def properties_process_item(value, key, *args)
+      process_item(value, *args)
+    end
+
+    def process_items(items, *args)
+      items.collect do |item|
+        items_process_item(item, *args)
+      end
+    end
+
+    def items_process_item(item, *args)
+      process_item(item, *args)
+    end
+
+    def check_item(item, *args)
+    end
+  end
+end

data/lib/medschool/tasks/generate.rake

@@ -0,0 +1,55 @@
+require 'redcarpet'
+
+class CodeRayRenderer < Redcarpet::Render::HTML
+  def block_code(code, language)
+    CodeRay.scan(code, language).div
+  end
+end
+
+namespace :docs do
+  task :generate do
+    markdown_renderer = Redcarpet::Markdown.new(CodeRayRenderer.new, {:fenced_code_blocks => true, :disable_indented_code_blocks => true })
+
+    `rm -rf #{Rails.root.join('docs')}`
+    `mkdir -p #{Rails.root.join('docs')}`
+
+    Medschool.root = Rails.root.join('features/markdown')
+
+    Dir[Medschool.root.join("**/*.md.med")].each do |markdown|
+      preprocessed = nil
+
+      File.open(markdown) do |f|
+        preprocessed = preprocess_markdown(f.read)
+      end
+
+      File.open(Rails.root.join('docs', File.basename(markdown, ".md.med") + '.html'), "w") do |f|
+        f.write markdown_renderer.render(preprocessed)
+      end
+    end
+  end
+end
+
+def preprocess_markdown(markdown)
+  example_regex = /^@@@(?<type>request|response): (?<name>[\w\-]*?)\n(?<yaml>.*?)@@@$/m
+  results = markdown.gsub(example_regex) do |match|
+    hash = YAML.load($3).with_indifferent_access
+    data = hash[:data]
+
+    h = Medschool::HashGenerator.new(data).process
+
+    curl = $1 == "request" ? curl_from_params(hash, h) : ''
+
+    curl + (h.size > 0 ? "```json\n#{MultiJson.dump(h, :pretty => true)}\n```" : "")
+  end
+end
+
+def curl_from_params(hash, params)
+  method = hash[:method]
+  route = hash[:route]
+
+  if params.size > 0
+    "`$ curl -X #{method.upcase} -d \"#{MultiJson.dump(params).gsub("\"", "\\\"").gsub(",", ", ")}\" http://localhost:3000#{route}`\n\n"
+  else
+    "`$ curl -X #{method.upcase} http://localhost:3000#{route}`\n\n"
+  end
+end

data/lib/medschool/validator.rb

@@ -0,0 +1,105 @@
+module Medschool
+  class Validator < SchemaProcessor
+    def initialize(example, response)
+      self.example = example
+      self.response = response
+    end
+
+    def validate!
+      process_status(example[:status], response.status)
+      process_headers(example[:headers], response)
+      if response.body.empty?
+        {}
+      else
+        process_properties(example[:data], JSON.parse(response.body))
+      end
+    end
+
+    private
+
+    def process_status(example_status, status)
+      unless example_status == status
+        raise "Expected status code of #{example_status}. Got: #{status}."
+      end
+    end
+
+    def process_headers(headers, response)
+      if headers.respond_to?(:each)
+        headers.each do |header, value|
+          unless response.headers[header] == value
+            raise "Expected #{header}: '#{response.headers[header]}' to be '#{value}'"
+          end
+        end
+      end
+    end
+
+    def properties_process_item(value, key, hash)
+      process_item(value, hash[key])
+    end
+
+    def items_process_item(item, array)
+      validated = false
+
+      array.each do |array_item|
+        begin
+          process_item(item, array_item)
+          validated = true
+        rescue
+        end
+      end
+
+      pretty_item = HashGenerator.new(:item => item).process
+
+      raise "Array item:\n#{MultiJson.dump(pretty_item[:item], :pretty => true)}\nNot found in:\n#{MultiJson.dump(array, :pretty => true)}" unless validated
+    end
+
+    def check_item(item_schema, item)
+      case
+      when item_schema['pattern']
+        check_pattern(item_schema['pattern'], item)
+      when item_schema['exact'] != false
+        check_value(item_schema['value'], item)
+      when item_schema['type']
+        check_type(item_schema['type'], item)
+      end
+    end
+
+    def check_value(schema_value, value)
+      unless schema_value == value
+        raise "Expected '#{value}' to equal '#{schema_value}'"
+      end
+    end
+
+    def check_pattern(schema_pattern, value)
+      regexp = Regexp.new(schema_pattern)
+      value = value.to_s
+
+      unless value =~ regexp
+        raise "Expected '#{value}' to match /#{schema_pattern}/"
+      end
+    end
+
+    def check_type(type, value)
+      case type
+      when 'integer'
+        check_integer(value)
+      when 'timestamp'
+        check_timestamp(value)
+      end
+    end
+
+    def check_integer(value)
+      if !(Integer === value)
+        raise "Expected '#{value}' to be an integer"
+      end
+    end
+
+    def check_timestamp(value)
+      Time.parse(value)
+    rescue
+      raise "Expected '#{value}' to be a timestamp"
+    end
+
+    attr_accessor :example, :response
+  end
+end

data/lib/medschool/version.rb

@@ -0,0 +1,3 @@
+module Medschool
+  VERSION = "0.1"
+end

data/lib/medschool.rb

@@ -0,0 +1,13 @@
+$:.unshift File.dirname(__FILE__)
+
+module Medschool
+  class << self
+    attr_accessor :root
+  end
+end
+
+require "medschool/example"
+require "medschool/schema_processor"
+require "medschool/hash_generator"
+require "medschool/validator"
+require "medschool/railtie" if defined?(Rails)

data/medschool.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'medschool/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "medschool"
+  gem.version       = Medschool::VERSION
+  gem.authors       = ["Emily Dobervich"]
+  gem.email         = ["emily@narwhunderful.com"]
+  gem.description   = %q{Medschool makes your API Docs smarter}
+  gem.summary       = %q{Document your API}
+  gem.homepage      = "http://github.com/teamsnap/medschool"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("redcarpet")
+  gem.add_dependency("coderay")
+  gem.add_dependency("json-schema")
+  gem.add_dependency("multi_json")
+
+  gem.add_development_dependency("pry")
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: medschool
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Emily Dobervich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Medschool makes your API Docs smarter
+email:
+- emily@narwhunderful.com
+executables:
+- medschool
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/medschool
+- lib/medschool.rb
+- lib/medschool/example.rb
+- lib/medschool/hash_generator.rb
+- lib/medschool/rails.rb
+- lib/medschool/railtie.rb
+- lib/medschool/schema_processor.rb
+- lib/medschool/tasks/generate.rake
+- lib/medschool/validator.rb
+- lib/medschool/version.rb
+- medschool.gemspec
+homepage: http://github.com/teamsnap/medschool
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Document your API
+test_files: []
+has_rdoc: