rack-raml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86b31081e20fdb366e4f840dc58f44614492b798
+  data.tar.gz: 9469fc9a148fb16807efb6151b2100e64c9c096d
+SHA512:
+  metadata.gz: c4b0a8f2c93fa04364c77c5b1d4ab4704836fe5a9aecc8aa0f79303905e5b9db2a83fd7ce60d745109ddc50dabe34a4c8ce4b9f5c414c8f51f66a94eabf1bf63
+  data.tar.gz: d0ea9ae37ebfa610e60c4787dd8bab21299a969bb14ef55e97007edeb41e79cc8cc1a4f17fc7f8b0beaf84755c214e56a790cf4360617cf9dc84aa952b9a0318

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-raml.gemspec
+gemspec
+
+gem 'sinatra', '>= 2.0.0.beta2'
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ray Zane
+
+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,103 @@
+# Rack::Raml
+
+[![Build Status](https://travis-ci.org/rzane/rack-raml.svg?branch=master)](https://travis-ci.org/rzane/rack-raml)
+
+A mountable mock server for your [RAML](https://raml.org) specifications based on Rack.
+
+__Note:__ This is not intended for use in production environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-raml'
+```
+
+## Usage
+
+Rack::Raml implements a Rack compatible application that responds to `#call`. Therefore, it can be used with any Rack-based web framework.
+
+#### Rails
+
+To use with Rails, simply point specific URLs at an instance of `Rack::Raml::App` like so:
+
+```ruby
+MyApplication.routes.draw do
+  # ...
+
+  Rack::Raml.routes Rails.root.join('path/to/spec.raml') do |raml_app|
+    get '/api/v1/users/:id', to: raml_app
+  end
+end
+```
+
+#### Sinatra
+
+To use with Sinatra, you have a few options. The easiest way is to define your route, and invoke `#process`.
+
+```ruby
+raml_file = File.expand_path('../path/to/spec.raml', __FILE__)
+raml_app = Rack::Raml.create(raml_file)
+
+get '/api/v1/users/:id' do
+  raml_app.process(request)
+end
+```
+
+Otherwise, you might configure `Rack::Raml` in your `config.ru`.
+
+#### Example RAML
+
+```yaml
+#%RAML 0.8
+---
+title: Dummy API
+baseUri: https://dummy-api.com/api/{version}
+version: v1
+
+/users:
+  /{id}:
+    displayName: Find a user
+    get:
+      responses:
+        200:
+          description: User was found.
+          body:
+            application/json:
+              example: |-
+                {
+                  "id": 1,
+                  "first_name": "John",
+                  "last_name": "Doe"
+                }
+```
+
+## Status Codes
+
+In RAML, you'll often specify multiple status codes that your server might respond with. By default, Rack::Raml will respond with the lowest status code that you've specified. So, for example, if you've declared a 200 and a 401 response, it will respond with the 200 response code unless otherwise instructed.
+
+You can force Rack::Raml to use a specific status code by requesting the url with the `_code` query parameter. For example:
+
+```
+$ curl http://localhost:3000/api/v1/users?_code=401
+```
+
+## Content Types
+
+The server will respond with the content type that matches the request. If the request does not specify a content type, Rack::Raml will assume you want `application/json`.
+
+You can force Rack::Raml to use a specific content type by requesting the url with the `_type` query parameter. For example:
+
+```
+$ curl http://localhost:3000/api/v1/users?_type=text/plain
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rack-raml.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/rack.rb

@@ -0,0 +1,19 @@
+require 'rack'
+require 'rack/raml'
+
+raml_file = File.expand_path('../../spec/fixtures/api.raml', __FILE__)
+raml_app = Rack::Raml.create(raml_file)
+
+app = Rack::Builder.new do
+  map '/' do
+    run proc { |env|
+      [200, {'Content-Type' => 'text/plain'}, ['This is a Rack demo']]
+    }
+  end
+
+  map '/api/v1' do
+    run raml_app
+  end
+end
+
+Rack::Server.start app: app

data/examples/rails.rb

@@ -0,0 +1,25 @@
+require 'rack/raml'
+require 'action_controller/railtie'
+
+Rails.logger = Logger.new(STDOUT)
+
+class App < Rails::Application
+  config.secret_key_base = '123456789'
+  config.raml_file = File.expand_path('../../spec/fixtures/api.raml', __FILE__)
+end
+
+class PagesController < ActionController::Base
+  def index
+    render text: 'This is the Rails demo'
+  end
+end
+
+App.routes.draw do
+  Rack::Raml.routes(App.config.raml_file) do |raml_app|
+    get '/api/v1/users/:id', to: raml_app
+  end
+
+  root to: 'pages#index'
+end
+
+Rack::Server.start app: App

data/examples/sinatra.rb

@@ -0,0 +1,13 @@
+require 'sinatra'
+require 'rack/raml'
+
+raml_file = File.expand_path('../../spec/fixtures/api.raml', __FILE__)
+raml_app = Rack::Raml.create(raml_file)
+
+get '/' do
+  'This is a Sinatra demo'
+end
+
+get '/api/v1/users/:id' do
+  raml_app.process(request)
+end

data/lib/rack/raml/app.rb

@@ -0,0 +1,43 @@
+require 'rack/response'
+require 'rack/raml/response'
+
+module Rack
+  module Raml
+    class App
+      attr_reader :raml_file
+
+      def initialize(raml_file)
+        @raml_file = raml_file
+      end
+
+      def raml
+        @raml ||= ::Raml.parse_file(raml_file)
+      end
+
+      def call(env)
+        process Rack::Request.new(env)
+      end
+
+      def process(request)
+        response_for(request).to_rack
+      end
+
+      def resources
+        @resources ||= flatten_resources(raml)
+      end
+
+      private
+
+      def response_for(request)
+        Rack::Raml::Response.new(resources, request)
+      end
+
+      def flatten_resources(node)
+        node.children.inject([]) do |acc, child|
+          acc << child if child.kind_of?(::Raml::Resource)
+          acc + flatten_resources(child)
+        end
+      end
+    end
+  end
+end

data/lib/rack/raml/response.rb

@@ -0,0 +1,87 @@
+require 'uri_template'
+
+module Rack
+  module Raml
+    class Response
+      attr_reader :resources, :request
+
+      def initialize(resources, request)
+        @resources = resources
+        @request = request
+      end
+
+      def matches?
+        !response.nil?
+      end
+
+      def to_rack
+        if matches?
+          [code, { 'Content-Type' => type }, [body]]
+        else
+          [404, { 'Content-Type' => type }, [not_found]]
+        end
+      end
+
+      private
+
+      def path
+        request.env['PATH_INFO']
+      end
+
+      def verb
+        request.request_method.downcase
+      end
+
+      def type
+        request.params['_type'] || request.content_type || 'application/json'
+      end
+
+      def code
+        if value = request.params['_code']
+          value.to_i
+        elsif possible_responses
+          possible_responses.keys.min
+        end
+      end
+
+      def body
+        response.example if matches?
+      end
+
+      def not_found
+        {
+          error: 'RAML not found',
+          code: code,
+          type: type,
+          path: path,
+          verb: verb
+        }.to_json
+      end
+
+      def response
+        @response ||= (
+          possible_responses &&
+          possible_responses[code] &&
+          possible_responses[code].bodies[type]
+        )
+      end
+
+      def possible_responses
+        @possible_responses ||= find_possible_responses
+      end
+
+      def find_possible_responses
+        resource = resources.find do |res|
+          pattern = uri_pattern(res.resource_path)
+          res.methods[verb] && pattern.match(path)
+        end
+
+        resource.methods[verb].responses if resource
+      end
+
+      def uri_pattern(template)
+        URITemplate::RFC6570.new("{/prefix*}#{template}")
+      end
+    end
+  end
+end

data/lib/rack/raml/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Raml
+    VERSION = "0.1.0"
+  end
+end

data/lib/rack/raml.rb

@@ -0,0 +1,16 @@
+require 'raml'
+require 'rack/raml/version'
+require 'rack/raml/app'
+require 'rack/raml/response'
+
+module Rack
+  module Raml
+    def self.create(file)
+      Rack::Raml::App.new(file)
+    end
+
+    def self.routes(file, &block)
+      create(file).tap(&block)
+    end
+  end
+end

data/lib/rack-raml.rb

@@ -0,0 +1 @@
+require 'rack/raml'

data/rack-raml.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/raml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-raml"
+  spec.version       = Rack::Raml::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["ray@promptworks.com"]
+
+  spec.summary       = %q{A mock RAML server for Rack-based applications.}
+  spec.description   = %q{A mock RAML server for Rack-based applications.}
+  spec.homepage      = "https://github.com/rzane/rack-raml"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack'
+  spec.add_dependency 'raml_ruby'
+  spec.add_dependency 'uri_template'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rack-raml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: raml_ruby
+  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: uri_template
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: A mock RAML server for Rack-based applications.
+email:
+- ray@promptworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/rack.rb
+- examples/rails.rb
+- examples/sinatra.rb
+- lib/rack-raml.rb
+- lib/rack/raml.rb
+- lib/rack/raml/app.rb
+- lib/rack/raml/response.rb
+- lib/rack/raml/version.rb
+- rack-raml.gemspec
+homepage: https://github.com/rzane/rack-raml
+licenses:
+- MIT
+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.6.7
+signing_key: 
+specification_version: 4
+summary: A mock RAML server for Rack-based applications.
+test_files: []