rambo_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 181b7e230121fc0dd07a1577c7dd39697ab18409
+  data.tar.gz: 399cbdee63d18ff87611250c0f0b9e8d9ecdf4d9
+SHA512:
+  metadata.gz: 61746a4c0f25f15a25cfe25588045506040fb2dcff720ae38d7f322802227b196dec5fed092eae158877d99e8e62f794acba20fe8e05f11fa9df43a35a2b8635
+  data.tar.gz: e254055accaecd97a45e116fbd9e9522484e8b6aeae75244da60fa076afc9594d1f65dbd23911a6eed82d1142e30d0cf876f19fe82d0909f66dbe57157d9c906

data/.rspec

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

data/.simplecov

@@ -0,0 +1,7 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+   add_filter 'raml-rb'
+end

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.0
+  - 2.3.1
+script:
+  - bundle exec rspec
+env:
+  - COVERAGE=true
+script:
+  - bundle exec rspec
+branches:
+  only:
+    - master
+sudo: false
+notifications:
+  - email: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'pry'

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+## Summary
+
+<!-- This sections are meant as guidance for you. If some doesn't fit, skip them. In general: Please provide as much information as you can to help us solving your problem -->
+
+<!--- Provide a general summary of the issue in the Title above -->
+
+## Expected Behavior
+
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
+
+## Current Behavior
+
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
+
+<!--- If you have got some output place it in the code block below. Otherwise remove it. -->
+~~~
+~~~
+
+## Possible Solution
+
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
+
+## Steps to Reproduce (for bugs)
+
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
+
+## Context
+
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
+
+## Your Environment
+
+<!--- Include as many relevant details about the environment you experienced the bug in -->
+* Version used:
+* Operating System and version:
+* Link to your project:

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dana Scheider
+
+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,50 @@
+# Rambo
+[![Build Status](https://travis-ci.org/danascheider/rambo.svg?branch=master)](https://travis-ci.org/danascheider/rambo) [![Code Climate](https://codeclimate.com/github/danascheider/rambo/badges/gpa.svg)](https://codeclimate.com/github/danascheider/rambo) [![Dependency Status](https://gemnasium.com/badges/github.com/danascheider/rambo.svg)](https://gemnasium.com/github.com/danascheider/rambo)
+ [![Coverage Status](https://coveralls.io/repos/github/danascheider/rambo/badge.svg?branch=dev)](https://coveralls.io/github/danascheider/rambo?branch=master)
+
+Rambo is a gem that generates API contract tests from API docs in [RAML](http://raml.org/).
+
+#### The current version of Rambo is 0.1.0. It is highly unstable and has a limited feature set. Use at your own risk and please file issue reports if they come up!
+
+## Usage
+You can install Rambo using:
+```ruby
+gem install rambo_ruby
+```
+You can also add it to your project's Gemfile: <
+```ruby
+group :development, :test do
+  gem 'rambo_ruby', '~> 0.0.1'
+end
+```
+To run Rambo, from the root directory of your project, run:
+```
+$ rambo foobar.raml
+```
+Rambo will create `spec/contract` directory and a `spec/rambo_helper.rb` file if they don't exist, and will create a `spec/contract/foobar_spec.rb` file. The latter will overwrite any existing spec file by the same name. This is intentional behavior and will not change in future versions.
+
+To run the RSpec examples Rambo generates, you will need to have `require`s in your `spec_helper.rb` or `rambo_helper.rb` file:
+
+- `require "rack/test"`
+- `require "json"`
+- `require "json-schema"`
+
+Rambo is being developed to test APIs complying with standard REST practices. Mileage may vary with other architectures, but I'm happy to consider pull requests.
+
+## About the Project
+I started Rambo in March of 2016 as part of my work at [Renew Financial](http://renewfinancial.com). RF has since put a second full-time engineer on the project. For this reason, our primary focus is on adding the features and functionality that are most important for testing RF's back-end services. One of these services, Repaymnt Estimatr, forms the basis for the Rambo MVP.
+
+Although the Repaymnt Estimatr repo is private, the key technical considerations here are that it is built with Rails 4 and documented using RAML 1.0. Rambo, therefore, considers these the default, and support for other frameworks and for RAML 0.8 is incidental and lower priority. We would be delighted to merge pull requests adding such support, as long as they don't adversely affect the features we need most.
+
+Although development of Rambo is largely supported by Renew Financial, we have every intention of keeping the tool open source and to continue expanding and updating its functionality.
+
+## Contributing
+Rambo is a new project and any contributions are much appreciated. All pull requests should include comprehensive test coverage and, where appropriate, documentation. If you're not sure where to get started, contact me [through Github](https://github.com/danascheider) and I'll be glad to chat.
+
+Additional information for contributors is available in the wiki. Beginning or first-time contributors are welcome and encouraged!
+
+## More Information
+  * [RAML homepage](https://raml.org)
+  * [Roy Fielding's dissertation](https://www.ics.uci.edu/~fielding/pubs/dissertation/fielding_dissertation.pdf) describing Representational State Transfer (REST) architecture
+  * [RESTful Web Services](http://www.crummy.com/writing/RESTful-Web-Services/RESTful_Web_Services.pdf), by Leonard Richardson & Sam Ruby
+  * [Toby Clemson](http://martinfowler.com/articles/microservice-testing/) on testing microservices

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = '--format pretty'
+end
+
+task :default => [:spec, :cucumber]

data/assets/logo.txt

@@ -0,0 +1,5 @@
+    ____   ___     __  ___ ____   ____
+   / __ \ /   |   /  |/  // __ ) / __ \
+  / /_/ // /| |  / /|_/ // __  |/ / / /
+ / _, _// ___ | / /  / // /_/ // /_/ /
+/_/ |_|/_/  |_|/_/  /_//_____/ \____/

data/bin/rambo

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "fileutils"
+require "cli"
+require "optparse"
+
+filename = ARGV[0] ? File.expand_path(ARGV[0], FileUtils.pwd) : nil
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: rambo [FILE] [OPTIONS]"
+
+  options[:rails] = true
+  opts.on("--no-rails", "Generate tests for a non-Rails API") do |v|
+    options[:rails] = false
+  end
+end.parse!
+
+Rambo::CLI.new(filename, options, STDOUT).run!

data/features/create_files.feature

@@ -0,0 +1,16 @@
+Feature: Create specs from RAML
+
+  The example files can be found in features/support/examples
+
+  Scenario: Generate specs from a simple RAML file
+    Given a file named "foo.raml" like "empty_raml.raml"
+    When I run `rambo foo.raml`
+    Then the directory "spec/contract" should exist
+    And the file "spec/contract/foo_spec.rb" should exist
+    And the file "spec/rambo_helper.rb" should exist
+    And the file "spec/rambo_helper.rb" should contain:
+      """
+      require "spec_helper"
+      """
+    And the file "spec/contract/foo_spec.rb" should be like "empty_spec.rb.example"
+    And the exit status should be 0

data/features/error_modes.feature

@@ -0,0 +1,13 @@
+Feature: Error handling
+
+  Scenario: No filename is given
+    When I run `rambo`
+    Then it should fail with "USAGE: rambo [FILE]"
+
+  Scenario: File given is not a RAML file
+    Given a file "foobar.yml" with:
+      """
+      foo: bar
+      """
+    When I run `rambo foobar.yml`
+    Then it should fail with "Unsupported file format. Please choose a RAML file."

data/features/generate_post_specs.feature

@@ -0,0 +1,10 @@
+Feature: Generate POST specs
+  Scenario: Simple POST route
+    Given a file named "foo.raml" like "basic_raml_with_post_route.raml"
+    When I run `rambo foo.raml`
+    Then the file "spec/contract/foo_spec.rb" should be like "simple_spec_file_with_post_route.rb.example"
+
+  Scenario: POST route with headers
+    Given a file named "foo.raml" like "post_with_request_headers.raml"
+    When I run `rambo foo.raml`
+    Then the file "spec/contract/foo_spec.rb" should be like "spec_file_with_request_headers.rb.example"

data/features/generate_simple_api_specs.feature

@@ -0,0 +1,13 @@
+Feature: Generate simple API specs
+
+  Scenario: Route with example
+    Given a file named "foo.raml" like "basic_raml_with_example.raml"
+    When I run `rambo foo.raml`
+    Then the file "spec/contract/foo_spec.rb" should be like "simple_spec_file_with_example.rb.example"
+    And the file "spec/support/examples/authors_response_body.json" should be like "basic_raml_with_example_response.json"
+
+  Scenario: Route with schema
+    Given a file named "foo.raml" like "basic_raml_with_schema.raml"
+    When I run `rambo foo.raml`
+    Then the file "spec/contract/foo_spec.rb" should be like "simple_spec_file_with_schema.rb.example"
+    And the file "spec/support/examples/authors_response_schema.json" should be like "basic_raml_with_schema_response.json"

data/features/modify_spec_helper.feature

@@ -0,0 +1,4 @@
+Feature: Modify spec helper
+
+  Background:
+    Given a file named "foo.raml" like "basic_raml_with_example.raml"

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,25 @@
+Given(/^a file named "([^"]*)" like "([^"]*)"$/) do |file, example|
+  text = read_example(example)
+  step %(a file named "#{file}" with:), text
+end
+
+Given(/^a spec_helper\.rb file that requires rack\/test but not JSON$/) do
+  step 'a file named "spec/rambo_helper.rb" like "spec_helper_only_rack_test.rb.example"'
+end
+
+Given(/^a spec_helper\.rb file that requires JSON but not rack\/test$/) do
+  step 'a file named "spec/rambo_helper.rb" like "spec_helper_only_json.rb.example"'
+end
+
+Given(/a spec_helper.rb file that requires both JSON and rack\/test$/) do
+  step 'a file named "spec/rambo_helper.rb" like "good_spec_helper.rb.example"'
+end
+
+Then(/^the file "([^"]*)" should be like "([^"]*)"$/) do |file, example|
+  text = read_example(example)
+  step %(a file "#{file}" should contain:), text
+end
+
+Then(/^the file "([^"]*)" should require "([^"]*)"$/) do |file, mod|
+  steps %Q{the file "#{file}" should match /require "#{mod}"/}
+end

data/features/support/cucumber_helper.rb

@@ -0,0 +1,13 @@
+module CucumberHelper
+  def read_example(example)
+    possible_paths = [
+      File.expand_path("../examples/raml/#{example}", __FILE__),
+      File.expand_path("../examples/rspec/#{example}", __FILE__),
+      File.expand_path("../examples/rspec/#{example}", __FILE__)
+    ]
+
+    possible_paths.each do |path|
+      return File.read(path) rescue next
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+require 'coveralls'
+
+Coveralls.wear! if ENV["COVERAGE"] == "true"
+
+require 'aruba/cucumber'
+require_relative './cucumber_helper'
+
+World(CucumberHelper)

data/features/support/examples/json/basic_raml_with_example_response.json

@@ -0,0 +1,16 @@
+{
+  "data": [
+    {
+      "id": 1,
+      "first_name": "Hermann",
+      "last_name": "Hesse"
+    },
+    {
+      "id": 2,
+      "first_name": "Charles",
+      "last_name": "Dickens"
+    }
+  ],
+  "success": true,
+  "status": 200
+}

data/features/support/examples/json/basic_raml_with_post_route_response.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "schema for a list of authors",
+  "type": "object",
+  "properties": {
+    "author": {
+      "type": "object",
+      "properties": {
+        "id": { "type": "integer" },
+        "first_name": { "type": "string" },
+        "last_name": { "type": "string" }
+      }
+    }
+  }
+}

data/features/support/examples/json/basic_raml_with_schema_response.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "schema for a list of authors",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "number"
+    }
+  }
+}

data/features/support/examples/raml/basic_raml_with_example.raml

@@ -0,0 +1,30 @@
+#%RAML 0.8
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1
+
+/authors:
+  get:
+    description: Retrieve a list of authors
+    responses:
+      200:
+        body:
+          application/json:
+            example: |
+              {
+                "data": [
+                  {
+                    "id": 1,
+                    "first_name": "Hermann",
+                    "last_name": "Hesse"
+                  },
+                  {
+                    "id": 2,
+                    "first_name": "Charles",
+                    "last_name": "Dickens"
+                  }
+                ],
+                "success": true,
+                "status": 200
+              }

data/features/support/examples/raml/basic_raml_with_post_route.raml

@@ -0,0 +1,43 @@
+#%RAML 0.8
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1
+
+/authors:
+  post:
+    description: Retrieve a list of authors
+    body:
+      application/json:
+        schema: |
+          {
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "description": "schema to create an author",
+            "type": "object",
+            "required": [ "first_name", "last_name" ],
+            "properties": {
+              "first_name": { "type": "string" },
+              "last_name": { "type": "string" },
+              "year_of_birth": { "type": "integer" }
+            }
+          }
+    responses:
+      200:
+        body:
+          application/json:
+            schema: |
+              {
+                "$schema": "http://json-schema.org/draft-04/schema#",
+                "description": "schema for a list of authors",
+                "type": "object",
+                "properties": {
+                  "author": {
+                    "type": "object",
+                    "properties": {
+                      "id": { "type": "integer" },
+                      "first_name": { "type": "string" },
+                      "last_name": { "type": "string" }
+                    }
+                  }
+                }
+              }

data/features/support/examples/raml/basic_raml_with_schema.raml

@@ -0,0 +1,24 @@
+#%RAML 0.8
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1
+
+/authors:
+  get:
+    description: Retrieve a list of authors
+    responses:
+      200:
+        body:
+          application/json:
+            schema: |
+              {
+                "$schema": "http://json-schema.org/draft-04/schema#",
+                "description": "schema for a list of authors",
+                "type": "object",
+                "properties": {
+                  "data": {
+                    "type": "number"
+                  }
+                }
+              }

data/features/support/examples/raml/empty_raml.raml

@@ -0,0 +1,5 @@
+#%RAML 0.8
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1

data/features/support/examples/raml/multiple_routes.raml

@@ -0,0 +1,15 @@
+#% RAML 0.8
+---
+title: e-Bookmobile API
+baseUri: http://api.ebookmobile.com/{version}
+version: v1
+
+/authors:
+  get:
+    description: Retrieve a list of authors
+    responses:
+      201:
+  post:
+    description: Add an author to the database
+    responses:
+      204:

data/features/support/examples/raml/post_with_request_headers.raml

@@ -0,0 +1,45 @@
+#%RAML 1.0
+---
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1
+
+/authors:
+  post:
+    description: Retrieve a list of authors
+    headers:
+      Content-Type: application/json
+    body:
+      application/json:
+        schema: |
+          {
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "description": "schema to create an author",
+            "type": "object",
+            "required": [ "first_name", "last_name" ],
+            "properties": {
+              "first_name": { "type": "string" },
+              "last_name": { "type": "string" },
+              "year_of_birth": { "type": "integer" }
+            }
+          }
+    responses:
+      200:
+        body:
+          application/json:
+            schema: |
+              {
+                "$schema": "http://json-schema.org/draft-04/schema#",
+                "description": "schema for a list of authors",
+                "type": "object",
+                "properties": {
+                  "author": {
+                    "type": "object",
+                    "properties": {
+                      "id": { "type": "integer" },
+                      "first_name": { "type": "string" },
+                      "last_name": { "type": "string" }
+                    }
+                  }
+                }
+              }

data/features/support/examples/rspec/empty_spec.rb.example

@@ -0,0 +1,5 @@
+require "rambo_helper"
+
+RSpec.describe "e-BookMobile API", type: :request do
+
+end

data/features/support/examples/rspec/simple_spec_file_with_example.rb.example

@@ -0,0 +1,31 @@
+require "rambo_helper"
+
+RSpec.describe "e-BookMobile API", type: :request do
+
+  describe "/authors" do
+    let(:route) { "/authors" }
+
+    describe "GET" do
+      let(:response_body) do
+        File.read("spec/support/examples/authors_get_response_body.json")
+      end
+
+      let(:output_file) do
+        "spec/contract/output/authors_get_response.json"
+      end
+
+      it "retrieve a list of authors" do
+        get route
+
+        File.open(output_file, "w+") {|file| file.puts JSON.pretty_generate(JSON.parse(response.body)) }
+
+        expect(response.body).to eql response_body
+      end
+
+      it "returns status 200" do
+        get route
+        expect(response.status).to eql 200
+      end
+    end
+  end
+end

data/features/support/examples/rspec/simple_spec_file_with_post_route.rb.example

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+RSpec.describe "e-BookMobile API", type: :request do
+
+  describe "/authors" do
+    let(:route) { "/authors" }
+
+    describe "POST" do
+      let(:request_body) do
+        File.read("spec/support/examples/authors_post_request_body.json")
+      end
+
+      let(:response_schema) do
+        File.read("spec/support/examples/authors_post_response_schema.json")
+      end
+
+      let(:output_file) do
+        "spec/contract/output/authors_post_response.json"
+      end
+
+      it "retrieve a list of authors" do
+        get route
+
+        File.open(output_file, "w+") {|file| file.puts(JSON.pretty_generate(JSON.parse(response.body))) }
+
+        expect(response.body).to eql response_body
+      end
+
+      it "returns status 200" do
+        get route
+        expect(response.status).to eql 200
+      end
+    end
+  end
+end

data/features/support/examples/rspec/simple_spec_file_with_schema.rb.example

@@ -0,0 +1,31 @@
+require "rambo_helper"
+
+RSpec.describe "e-BookMobile API", type: :request do
+
+  describe "/authors" do
+    let(:route) { "/authors" }
+
+    describe "GET" do
+      let(:response_schema) do
+        File.read("spec/support/examples/authors_response_schema.json")
+      end
+
+      let(:output_file) do
+        "spec/contract/output/authors_get_response.json"
+      end
+
+      it "retrieve a list of authors" do
+        get route
+
+        File.open(output_file, "w+") {|file| file.puts JSON.pretty_generate(JSON.parse(response.body)) }
+
+        expect(response.body).to match_schema response_schema
+      end
+
+      it "returns status 200" do
+        get route
+        expect(response.status).to eql 200
+      end
+    end
+  end
+end