rambo_ruby 0.1.0

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

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+RSpec.describe "e-BookMobile API", type: :request do
+
+  describe "/authors" do
+    let(:route) { "/authors" }
+
+    describe "POST" do
+      let(:headers) do
+        {
+          "Content-Type" => "application/json"
+        }
+      end
+
+      let(:request_body) do
+        {
+          "first_name" => "asgaakh",
+          "last_name" => "sjdhhgu",
+          "year_of_birth" => 3333
+        }.to_json
+      end
+
+      let(:response_body) do
+        {
+          "author" => {
+            "id" => 1,
+            "first_name" => "asgaakh",
+            "last_name" => "sjdhhgu",
+            "year_of_birth" => 3333
+          }
+        }.to_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/spec_helper_json_added.rb.example

@@ -0,0 +1,11 @@
+require "rspec"
+require "rspec/core"
+require "rspec/matchers"
+require "rspec/expectations"
+require "raml-rb"
+require "rack/test"
+require "json"
+
+path = File.expand_path('../../lib', __FILE__)
+
+Dir.foreach(path) {|f| require f if f.match(/.*\.rb\z/) }

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

@@ -0,0 +1,10 @@
+require "rspec"
+require "rspec/core"
+require "rspec/matchers"
+require "rspec/expectations"
+require "raml-rb"
+require "json"
+
+path = File.expand_path('../../lib', __FILE__)
+
+Dir.foreach(path) {|f| require f if f.match(/.*\.rb\z/) }

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

@@ -0,0 +1,9 @@
+require "rspec"
+require "rspec/core"
+require "rspec/matchers"
+require "rspec/expectations"
+require "raml-rb"
+
+path = File.expand_path('../../lib', __FILE__)
+
+Dir.foreach(path) {|f| require f if f.match(/.*\.rb\z/) }

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

@@ -0,0 +1,10 @@
+require "rspec"
+require "rspec/core"
+require "rspec/matchers"
+require "rspec/expectations"
+require "raml-rb"
+require "json"
+
+path = File.expand_path('../../lib', __FILE__)
+
+Dir.foreach(path) {|f| require f if f.match(/.*\.rb\z/) }

data/features/support/foobar.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/lib/cli.rb

@@ -0,0 +1,65 @@
+require "colorize"
+require "document_generator"
+
+module Rambo
+  class CLI
+    def initialize(raml_file=nil, opts={}, stdout=STDOUT, stderr=STDERR)
+      @stdout  = stdout
+      @stderr  = stderr
+      @file    = raml_file
+      @options = opts
+
+      validate!
+
+      @generator = Rambo::DocumentGenerator.new(file, options)
+    end
+
+    def run!
+      print_logo
+      generator.generate_spec_dir!
+      generator.generate_rambo_helper!
+      generator.generate_matcher_dir!
+      generator.generate_examples!
+      generator.generate_matchers!
+
+      stdout.puts("Generating contract tests...")
+      sleep 0.4
+
+      begin
+        generator.generate_spec_file!
+        stdout.puts("Done!".green)
+      rescue NoMethodError => e
+        stderr.puts("Error: #{e.message}".red)
+        stderr.puts "\t#{e.backtrace.join("\n\t")}"
+      end
+    end
+
+    def validate!
+      exit_for_missing_file unless file
+      exit_for_invalid_file_format unless file.match(/\.raml$/)
+    end
+
+    private
+
+    attr_accessor :file, :stdout, :stderr, :generator, :options
+
+    def print_logo
+      stdout.puts logo.colorize(color: String.colors.sample)
+      sleep 0.4
+    end
+
+    def exit_for_missing_file
+      stdout.puts "USAGE: rambo [FILE]"
+      exit 1
+    end
+
+    def exit_for_invalid_file_format
+      stdout.puts "Unsupported file format. Please choose a RAML file."
+      exit 1
+    end
+
+    def logo
+      File.read(File.expand_path("../../assets/logo.txt", __FILE__))
+    end
+  end
+end

data/lib/document_generator.rb

@@ -0,0 +1,49 @@
+require "fileutils"
+require "raml-rb"
+
+require "rspec/spec_file"
+require "rspec/helper_file"
+
+module Rambo
+  class DocumentGenerator
+    attr_accessor :file, :raml, :options
+
+    def initialize(file, options={})
+      @file    = file
+      @raml    = Raml::Parser.parse_file(file)
+      @options = options
+    end
+
+    def generate_spec_dir!
+      FileUtils.mkdir_p("spec/contract/output")
+    end
+
+    def generate_examples!
+      FileUtils.mkdir_p("spec/support/examples")
+    end
+
+    def generate_spec_file!
+      spec_file_name = file.match(/[^\/]*\.raml$/).to_s.gsub(/\.raml$/, "_spec.rb")
+      contents       = Rambo::RSpec::SpecFile.new(raml, options).render
+      File.write("spec/contract/#{spec_file_name}", contents)
+    end
+
+    def generate_rambo_helper!
+      Rambo::RSpec::HelperFile.new(
+        template_path: File.expand_path("../rspec/templates/rambo_helper_file_template.erb", __FILE__),
+        file_path: "spec/rambo_helper.rb"
+      ).generate
+    end
+
+    def generate_matcher_dir!
+      FileUtils.mkdir_p("spec/support/matchers")
+    end
+
+    def generate_matchers!
+      Rambo::RSpec::HelperFile.new(
+        template_path: File.expand_path("../rspec/templates/matcher_file_template.erb", __FILE__),
+        file_path: "spec/support/matchers/rambo_matchers.rb"
+      ).generate
+    end
+  end
+end

data/lib/raml_models/api.rb

@@ -0,0 +1,19 @@
+module Rambo
+  module RamlModels
+    class Api
+      attr_reader :schema
+
+      def initialize(parsed_raml)
+        @schema = parsed_raml
+      end
+
+      def resources
+        @resources ||= schema.resources.map {|resource| Rambo::RamlModels::Resource.new(resource) }
+      end
+
+      def title
+        @title ||= schema.title
+      end
+    end
+  end
+end

data/lib/raml_models/body.rb

@@ -0,0 +1,33 @@
+require "json_test_data"
+
+module Rambo
+  module RamlModels
+    class Body
+
+      attr_reader :body, :type
+
+      def initialize(raml)
+        @body = raml
+      end
+
+      def content_type
+        body.content_type
+      end
+
+      def example
+        @example ||= body.example || generate_from_schema || {}.to_json
+      end
+
+      def schema
+        @schema ||= body.schema
+      end
+
+      private
+
+      def generate_from_schema
+        return nil unless body.schema
+        JSON.pretty_generate(JsonTestData.generate!(body.schema, ruby: true))
+      end
+    end
+  end
+end

data/lib/raml_models/headers.rb

@@ -0,0 +1,21 @@
+module Rambo
+  module RamlModels
+    class Headers
+      attr_accessor :headers
+
+      def initialize(headers)
+        @headers = headers
+      end
+
+      def pretty
+        beginning, ending = "{\n", "}"
+
+        contents = headers.map {|key, value|
+          "\t\"#{key}\" => \"#{value}\"\n"
+        }
+
+        "#{beginning}#{contents.join}#{ending}"
+      end
+    end
+  end
+end

data/lib/raml_models/method.rb

@@ -0,0 +1,37 @@
+module Rambo
+  module RamlModels
+    class Method
+      attr_reader :schema
+
+      def initialize(raml_method)
+        @schema = raml_method
+      end
+
+      def method
+        schema.method
+      end
+
+      def request_body
+        Rambo::RamlModels::Body.new(schema.bodies.first) if has_request_body?
+      end
+
+      def description
+        @description ||= schema.description
+      end
+
+      def headers
+        @headers ||= Rambo::RamlModels::Headers.new(schema.headers) if schema.headers
+      end
+
+      def responses
+        @responses ||= schema.responses.map {|resp| Rambo::RamlModels::Response.new(resp) }
+      end
+
+      private
+
+      def has_request_body?
+        !!schema.bodies.first
+      end
+    end
+  end
+end

data/lib/raml_models/resource.rb

@@ -0,0 +1,22 @@
+module Rambo
+  module RamlModels
+    class Resource
+
+      attr_reader :schema
+
+      def initialize(raml_resource)
+        @schema = raml_resource
+      end
+
+      def uri_partial
+        schema.uri_partial
+      end
+
+      alias_method :to_s, :uri_partial
+
+      def http_methods
+        @http_methods ||= schema.methods.map {|method| Rambo::RamlModels::Method.new(method) }
+      end
+    end
+  end
+end

data/lib/raml_models/response.rb

@@ -0,0 +1,19 @@
+module Rambo
+  module RamlModels
+    class Response
+      attr_reader :schema
+
+      def initialize(raml)
+        @schema = raml
+      end
+
+      def status_code
+        schema.code
+      end
+
+      def bodies
+        @bodies ||= schema.bodies.map {|body| Rambo::RamlModels::Body.new(body) }
+      end
+    end
+  end
+end

data/lib/raml_models.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/raml_models/**/*.rb"].each {|file| require file }

data/lib/rspec/example_group.rb

@@ -0,0 +1,53 @@
+module Rambo
+  module RSpec
+    class ExampleGroup
+
+      TEMPLATE_PATH = File.expand_path("../templates/example_group_template.erb", __FILE__)
+
+      attr_reader :resource
+
+      def initialize(resource, options={})
+        @resource = resource
+        @options  = options
+      end
+
+      def template
+        @template ||= File.read(TEMPLATE_PATH)
+      end
+
+      def create_fixture_files
+        resource.http_methods.each do |method|
+          if method.request_body
+            path = File.expand_path("spec/support/examples/#{@resource.to_s.gsub(/\//, "")}_#{method.method}_request_body.json")
+            File.write(path, method.request_body.example)
+          end
+
+          method.responses.each do |resp|
+            resp.bodies.each do |body|
+              path     = body.schema ? response_schema_fixture_path(method) : response_body_fixture_path(method)
+              contents = body.schema ? body.schema : body.example
+              File.write(path, contents)
+            end
+          end
+        end
+      end
+
+      def render
+        create_fixture_files
+        b = binding
+        ERB.new(template, 0, "-", "@result").result(resource.instance_eval { b })
+        @result
+      end
+
+      private
+
+      def response_schema_fixture_path(method)
+        File.expand_path("spec/support/examples/#{@resource.to_s.gsub(/\//, "")}_#{method.method}_response_schema.json")
+      end
+
+      def response_body_fixture_path(method)
+        File.expand_path("spec/support/examples/#{@resource.to_s.gsub(/\//, "")}_#{method.method}_response_body.json")
+      end
+    end
+  end
+end

data/lib/rspec/examples.rb

@@ -0,0 +1,32 @@
+require "rspec/example_group"
+
+module Rambo
+  module RSpec
+    class Examples
+      attr_reader :raml, :resources, :examples, :options
+
+      def initialize(raml, options={})
+        @raml    = raml
+        @options = options
+      end
+
+      def compose
+        return '' unless examples
+
+        examples.join("\n\n")
+      end
+
+      def resources
+        @resources ||= raml.resources
+      end
+
+      def example_groups
+        @example_groups ||= resources.map {|r| ExampleGroup.new(r, options) }
+      end
+
+      def generate!
+        @examples = example_groups.map(&:render)
+      end
+    end
+  end
+end

data/lib/rspec/helper_file.rb

@@ -0,0 +1,30 @@
+module Rambo
+  module RSpec
+    class HelperFile
+      def initialize(template_path:, file_path:)
+        @template_path = template_path
+        @file_path     = file_path
+      end
+
+      def generate
+        write_to_file(template) unless file_already_exists?
+      end
+
+      private
+
+      attr_reader :template_path, :file_path
+
+      def file_already_exists?
+        File.exist?(file_path)
+      end
+
+      def write_to_file(template)
+        File.write(file_path, template)
+      end
+
+      def template
+        @template ||= File.read(template_path)
+      end
+    end
+  end
+end

data/lib/rspec/spec_file.rb

@@ -0,0 +1,31 @@
+require 'erb'
+require 'raml'
+
+require "rspec/examples"
+require "raml_models"
+
+module Rambo
+  module RSpec
+    class SpecFile
+      attr_reader :raml, :examples, :options
+
+      TEMPLATE_PATH = File.expand_path('../templates/spec_file_template.erb', __FILE__)
+
+      def initialize(raml, options={})
+        @raml     = Rambo::RamlModels::Api.new(raml)
+        @options  = options
+        @examples = Examples.new(@raml, @options)
+      end
+
+      def template
+        @template ||= File.read(TEMPLATE_PATH)
+      end
+
+      def render
+        b = binding
+        ERB.new(template, 0, "-", "@result").result(raml.instance_eval { b })
+        @result
+      end
+    end
+  end
+end

data/lib/rspec/templates/example_group_template.erb

@@ -0,0 +1,39 @@
+  describe "<%= @resource.to_s %>" do
+    let(:route) { "<%= @resource.to_s %>" }
+    <%- @resource.http_methods.each do |method| %>
+    describe "<%= method.method.upcase %>" do
+      <% if method.headers %>let(:headers) do <% headers = method.headers.pretty.split("\n")[1..-2] %>
+        {
+        <%= headers.join(",\n        ") %>
+        }
+      end<% end %><% if method.request_body %>
+
+      let(:request_body) do
+        File.read("<%= "spec/support/examples/#{@resource.to_s.gsub("/", "")}_#{method.method}_request_body.json" %>")
+      end<% end %><% if has_schema = method.responses.first.bodies.first.schema %>
+
+      let(:response_schema) do
+        File.read("<%= "spec/support/examples/#{@resource.to_s.gsub("/", "")}_#{method.method}_response_schema.json" %>")
+      end<% else %>
+      let(:response_body) do<% body = method.responses.first.bodies.first.example.split("\n") %>
+        File.read("<%= "spec/support/examples/#{@resource.to_s.gsub("/", "")}_#{method.method}_response_body.json" %>")
+      end<% end %>
+
+      let(:output_file) do
+        "<%= "spec/contract/output/#{@resource.to_s.gsub("/", "")}_#{method.method}_response.json" %>"
+      end
+      <% resp_method = @options[:rails] ? "response" : "last_response" %>
+      it "<%= method.description && method.description.downcase || "#{method.method}s the resource" %>" do
+        <%= method.method %> route<% if method.request_body %>, request_body<% end %><% if method.headers %>, headers<% end %>
+
+        File.open(output_file, "w+") {|file| file.puts JSON.pretty_generate(JSON.parse(<%= resp_method %>.body)) }
+
+        expect(<%= resp_method %>.body).to <%= has_schema ? "match_schema response_schema" : "eql response_body" %>
+      end
+
+      it "returns status <%= method.responses.first.status_code %>" do
+        <%= method.method %> route<% if method.request_body %>, request_body<% end %><% if method.headers %>, headers<% end %>
+        expect(<%= resp_method %>.status).to eql <%= method.responses.first.status_code %>
+      end
+    end<%- end %>
+  end

data/lib/rspec/templates/matcher_file_template.erb

@@ -0,0 +1,8 @@
+require "rspec/expectations"
+require "json-schema"
+
+RSpec::Matchers.define :match_schema do |expected|
+  match do |actual|
+    JSON::Validator.validate(expected, actual)
+  end
+end

data/lib/rspec/templates/rambo_helper_file_template.erb

@@ -0,0 +1,3 @@
+require "spec_helper"
+
+require_relative "./support/matchers/rambo_matchers"

data/lib/rspec/templates/spec_file_template.erb

@@ -0,0 +1,15 @@
+require "rambo_helper"
+
+RSpec.describe "<%= @raml.title %>", type: :request do
+
+  # Delete output files from previous test run prior to running tests again
+  before(:all) do
+    Dir.foreach("spec/contract/output") do |file|
+      next unless file.match(/\.json$/)
+
+      File.delete(File.join("spec/contract/output", file))
+    end
+  end
+<%- if @examples.generate! && @examples.compose.size > 0 %>
+<%= @examples.compose.chomp %><%- end %>
+end

data/lib/rspec.rb

@@ -0,0 +1 @@
+Dir["#{File.dirname(__FILE__)}/rspec/**/*.rb"].each {|file| require file }

data/lib/version.rb

@@ -0,0 +1,9 @@
+module Rambo
+  MAJOR = '0'
+  MINOR = '1'
+  PATCH = '0'
+
+  def self.version
+    [Rambo::MAJOR, Rambo::MINOR, Rambo::PATCH].join('.')
+  end
+end

data/rambo_ruby.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "rambo_ruby"
+  s.version     = Rambo.version
+  s.authors     = ["Dana Scheider"]
+  s.description = "RAML in, RSpec out"
+  s.summary     = "rambo_ruby-#{s.version}"
+  s.email       = "dana.scheider@gmail.com"
+  s.license     = "MIT"
+  s.platform    = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 2.1.0"
+
+  s.add_dependency "rspec", "~> 3.4"
+  s.add_dependency "raml-rb", "~> 0.0.6"
+  s.add_dependency "rack-test", "~> 0.6"
+  s.add_dependency "colorize", "~> 0.7"
+  s.add_dependency "json_test_data", "~> 1.0"
+  s.add_dependency "json-schema", "~> 2.6"
+
+  s.add_development_dependency "cucumber", "~> 2.1"
+  s.add_development_dependency "json", "~> 1.7"
+  s.add_development_dependency "rake", "~> 11.0"
+  s.add_development_dependency "coveralls", "~> 0.7"
+  s.add_development_dependency "aruba", "~> 0.13"
+
+  s.executables        = "rambo"
+  s.default_executable = "rambo"
+
+  s.rubygems_version   = ">= 1.6.1"
+  s.files              = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ }
+  s.test_files         = `git ls-files -- {spec,features}/*`.split("\n")
+  s.rdoc_options       = ["--charset=UTF-8"]
+  s.require_path       = "lib"
+end