rambo_ruby 0.1.0

data/spec/lib/cli_spec.rb

@@ -0,0 +1,71 @@
+RSpec.describe Rambo::CLI do
+  let(:io)         { StringIO.new }
+  let(:stderr)     { StringIO.new }
+  let(:opts)       { { rails: true } }
+  let(:valid_file) { File.expand_path('../../support/foobar.raml', __FILE__) }
+
+  describe "run!" do
+    let(:cli) { Rambo::CLI.new(valid_file, opts, io, stderr) }
+
+    before(:each) do
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_rambo_helper!)
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_spec_file!)
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_matchers!)
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_matcher_dir!)
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_examples!)
+      allow_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_spec_dir!)
+    end
+
+    it "creates a spec/contract directory" do
+      expect_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_spec_dir!)
+      cli.run!
+    end
+
+    it "creates a spec/support/matchers directory" do
+      expect_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_matchers!)
+      cli.run!
+    end
+
+    it "creates a rambo_helper file" do
+      allow(File).to receive(:exist?).with('spec/rambo_helper.rb').and_return(true)
+      expect_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_rambo_helper!)
+      cli.run!
+    end
+
+    it "creates foobar_spec.rb" do
+      expect_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_spec_file!)
+      cli.run!
+    end
+
+    it "creates the spec/support/examples directory" do
+      expect_any_instance_of(Rambo::DocumentGenerator).to receive(:generate_examples!)
+      cli.run!
+    end
+
+    context "when there is an error" do
+      it "prints the error messaage" do
+        allow_any_instance_of(Rambo::DocumentGenerator)
+          .to receive(:generate_spec_file!)
+          .and_raise NoMethodError, "Undefined method generate_spec_file!"
+
+        expect{ cli.run! }.to rescue(NoMethodError)
+      end
+    end
+  end
+
+  describe "validate!" do
+    context "with no file given" do
+      it "exits" do
+        expect{ Rambo::CLI.new(nil, io) }.to raise_error(SystemExit)
+      end
+    end
+
+    context "with the wrong file format" do
+      let(:invalid_file) { File.expand_path('../support/foobar.yml', __FILE__) }
+
+      it "exits" do
+        expect{ Rambo::CLI.new(invalid_file, io) }.to raise_error(SystemExit)
+      end
+    end
+  end
+end

data/spec/lib/document_generator_spec.rb

@@ -0,0 +1,74 @@
+RSpec.describe Rambo::DocumentGenerator do
+  let(:valid_file) { File.expand_path('../../support/foobar.raml', __FILE__) }
+  let(:options) { { rails: true } }
+  let(:generator) { Rambo::DocumentGenerator.new(valid_file, options) }
+
+  before(:each) do
+    allow_any_instance_of(Rambo::DocumentGenerator).to receive(:extract_raml)
+  end
+
+  describe "#generate_spec_dir!" do
+    it "generates the spec/contract directory" do
+      expect(FileUtils).to receive(:mkdir_p).with("spec/contract/output")
+      generator.generate_spec_dir!
+    end
+  end
+
+  describe "#generate_rambo_helper!" do
+    it "generates the rambo_helper file" do
+      aggregate_failures do
+        expect_any_instance_of(Rambo::RSpec::HelperFile)
+          .to receive(:initialize)
+          .with({
+            :template_path => File.expand_path("lib/rspec/templates/rambo_helper_file_template.erb"),
+            :file_path     => "spec/rambo_helper.rb"
+          })
+        expect_any_instance_of(Rambo::RSpec::HelperFile).to receive(:generate)
+      end
+
+      generator.generate_rambo_helper!
+    end
+  end
+
+  describe "#generate_spec_file!" do
+    before(:each) do
+      allow(File).to receive(:open)
+    end
+
+    it "generates foobar_spec.rb" do
+      allow_any_instance_of(Rambo::RSpec::SpecFile).to receive(:render).and_return("foo")
+      expect(File).to receive(:write).with("spec/contract/foobar_spec.rb", "foo")
+      generator.generate_spec_file!
+    end
+  end
+
+  describe "#generate_matcher_dir!" do
+    it "creates a spec/support/matchers directory" do
+      expect(FileUtils).to receive(:mkdir_p).with("spec/support/matchers")
+      generator.generate_matcher_dir!
+    end
+  end
+
+  describe "#generate_matchers!" do
+    it "adds a matcher file" do
+      aggregate_failures do
+        expect_any_instance_of(Rambo::RSpec::HelperFile)
+          .to receive(:initialize)
+          .with(
+            template_path: File.expand_path("lib/rspec/templates/matcher_file_template.erb"),
+            file_path: "spec/support/matchers/rambo_matchers.rb"
+          )
+        expect_any_instance_of(Rambo::RSpec::HelperFile).to receive(:generate)
+      end
+
+      generator.generate_matchers!
+    end
+  end
+
+  describe "#generate_examples!" do
+    it "creates the directory" do
+      expect(FileUtils).to receive(:mkdir_p).with("spec/support/examples")
+      generator.generate_examples!
+    end
+  end
+end

data/spec/lib/raml_models/api_spec.rb

@@ -0,0 +1,23 @@
+RSpec.describe Rambo::RamlModels::Api do
+  let(:raml_file) { File.expand_path("../../../support/multiple_resources.raml", __FILE__) }
+  let(:raml)      { Raml::Parser.parse_file(raml_file) }
+
+  subject { described_class.new(raml) }
+
+  describe "#resources" do
+    it "has the right number of resources" do
+      expect(subject.resources.count).to eql 2
+    end
+
+    it "returns an array of Resource objects" do
+      all_are_resources = subject.resources.all? {|resource| resource.is_a?(Rambo::RamlModels::Resource) }
+      expect(all_are_resources).to be true
+    end
+  end
+
+  describe "#title" do
+    it "returns the API title from the RAML doc" do
+      expect(subject.title).to eql raml.title
+    end
+  end
+end

data/spec/lib/raml_models/body_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe Rambo::RamlModels::Body do
+  let(:raml) { Raml::Parser.parse_file(raml_file) }
+  let(:body) { raml.resources.first.methods.first.responses.first.bodies.first }
+
+  subject { described_class.new(body) }
+
+  describe "#content_type" do
+    let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+
+    it "returns the content type" do
+      expect(subject.content_type).to eql body.content_type
+    end
+  end
+
+  describe "#example" do
+    context "when an example is given" do
+      let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+
+      it "returns an example" do
+        expect(subject.example).to eql body.example
+      end
+    end
+
+    context "when a schema is given" do
+      let(:raml_file) { File.expand_path("../../../../features/support/examples/raml/basic_raml_with_schema.raml", __FILE__) }
+
+      it "returns generated JSON data" do
+        expect(JSON.parse(subject.example)).to have_key "data"
+      end
+    end
+  end
+end

data/spec/lib/raml_models/headers_spec.rb

@@ -0,0 +1,17 @@
+RSpec.describe Rambo::RamlModels::Headers do
+  let(:raml) { Raml::Parser.parse_file(raml_file) }
+  let(:raml_file) { File.expand_path("../../../support/post_with_request_headers.raml", __FILE__) }
+  let(:headers) { raml.resources.first.methods.first.headers }
+
+  subject { described_class.new(headers) }
+
+  describe "#pretty" do
+    let(:pretty) do
+      "{\n\t\"Content-Type\" => \"application/json\"\n}"
+    end
+
+    it "makes it pretty" do
+      expect(subject.pretty).to eql pretty
+    end
+  end
+end

data/spec/lib/raml_models/method_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe Rambo::RamlModels::Method do
+  let(:raml_file) { File.expand_path("../../../support/foo.raml", __FILE__) }
+  let(:raml) { Raml::Parser.parse_file(raml_file) }
+  let(:method) { raml.resources.first.methods.first }
+
+  subject { described_class.new(method) }
+
+  describe "#to_s" do
+    it "returns the method name" do
+      expect(subject.method).to eql method.method
+    end
+  end
+
+  describe "#description" do
+    it "returns the description" do
+      expect(subject.description).to eql method.description
+    end
+  end
+
+  describe "#request_body" do
+    it "returns a request body" do
+      expect(subject.request_body).to be_a Rambo::RamlModels::Body
+    end
+  end
+
+  describe "#responses" do
+    it "returns an array of Response objects" do
+      all_are_responses = subject.responses.all? {|resp| resp.is_a?(Rambo::RamlModels::Response) }
+      expect(all_are_responses).to be true
+    end
+  end
+end

data/spec/lib/raml_models/resource_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe Rambo::RamlModels::Resource do
+  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml) { Raml::Parser.parse_file(raml_file) }
+  let(:resource) { raml.resources.first }
+
+  subject { described_class.new(resource) }
+
+  describe "#to_s" do
+    it "returns the URI partial" do
+      expect(subject.to_s).to eql resource.uri_partial
+    end
+  end
+
+  describe "#uri_partial" do
+    it "returns the URI partial" do
+      expect(subject.uri_partial).to eql resource.uri_partial
+    end
+  end
+
+  describe "#http_methods" do
+    it "returns the correct methods" do
+      expect(subject.http_methods.count).to eql 1
+    end
+
+    it "returns an array of Method objects" do
+      all_are_methods = subject.http_methods.all? {|method| method.is_a?(Rambo::RamlModels::Method) }
+      expect(all_are_methods).to be true
+    end
+  end
+end

data/spec/lib/raml_models/response_spec.rb

@@ -0,0 +1,20 @@
+RSpec.describe Rambo::RamlModels::Response do
+  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml) { Raml::Parser.parse_file(raml_file) }
+  let(:response) { raml.resources.first.methods.first.responses.first }
+
+  subject { described_class.new(response) }
+
+  describe "#status_code" do
+    it "returns the response status code" do
+      expect(subject.status_code).to eql response.code
+    end
+  end
+
+  describe "bodies" do
+    it "creates an array of Body objects" do
+      all_are_bodies = subject.bodies.all? {|body| body.is_a?(Rambo::RamlModels::Body) }
+      expect(all_are_bodies).to be true
+    end
+  end
+end

data/spec/lib/rspec/example_group_spec.rb

@@ -0,0 +1,87 @@
+RSpec.describe Rambo::RSpec::ExampleGroup do
+  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raml)      { Raml::Parser.parse_file(raml_file) }
+  let(:resource)  { Rambo::RamlModels::Resource.new(raml.resources.first) }
+  let(:options)   { { rails: true } }
+  subject         { Rambo::RSpec::ExampleGroup.new(resource, options) }
+
+  before(:each) do
+    FileUtils.mkdir_p(File.expand_path("spec/support/examples"))
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(File.expand_path("spec/support/examples"))
+  end
+
+  describe "#render" do
+    it "interpolates the correct values" do
+      aggregate_failures do
+        expect(subject.render).to include("let(:output_file) do")
+        expect(subject.render).to include("describe \"#{raml.resources.first.methods.first.method.upcase}\" do")
+        expect(subject.render).to include('describe "GET" do')
+      end
+    end
+
+    it "does not include a request body" do
+      expect(subject.render).not_to include("let(:request_body) do")
+    end
+
+    it "does not include headers" do
+      expect(subject.render).not_to include("let(:headers) do")
+    end
+
+    context "when the route has a response schema" do
+      let(:raml_file) { File.expand_path("../../../support/basic_raml_with_post_route.raml", __FILE__) }
+
+      it "creates a response schema object" do
+        aggregate_failures do
+          expect(subject.render).to include("let(:response_schema) do")
+          expect(subject.render).to include("expect(response.body).to match_schema response_schema")
+        end
+      end
+    end
+
+    context "when there is a response example but not a response schema" do
+      it "creates a response_body object" do
+        aggregate_failures do
+          expect(subject.render).to include("let(:response_body) do")
+          expect(subject.render).to include("expect(response.body).to eql response_body")
+        end
+      end
+    end
+
+    context "when the route has a request body" do
+      let(:raml_file) { File.expand_path("../../../support/basic_raml_with_post_route.raml", __FILE__) }
+
+      it "adds a request body" do
+        expect(subject.render).to include("let(:request_body) do")
+      end
+
+      it "does not include headers" do
+        expect(subject.render).not_to include("let(:headers) do")
+      end
+    end
+
+    context "when the route has request headers" do
+      let(:raml_file) { File.expand_path("../../../support/post_with_request_headers.raml", __FILE__) }
+
+      it "adds headers" do
+        expect(subject.render).to include("let(:headers) do")
+      end
+    end
+
+    context "Rails app" do
+      it "uses response" do
+        expect(subject.render).to include("expect(response.body)")
+      end
+    end
+
+    context "non-Rails app" do
+      let(:options) { { rails: false } }
+
+      it "uses last_response" do
+        expect(subject.render).to include("expect(last_response.body)")
+      end
+    end
+  end
+end

data/spec/lib/rspec/examples_spec.rb

@@ -0,0 +1,38 @@
+RSpec.describe Rambo::RSpec::Examples do
+  let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+  let(:raw_raml)  { Raml::Parser.parse_file(raml_file) }
+  let(:options)   { { rails: true } }
+  let(:raml)      { Rambo::RamlModels::Api.new(raw_raml) }
+
+  subject { Rambo::RSpec::Examples.new(raml, options) }
+
+  before(:each) do
+    FileUtils.mkdir_p(File.expand_path("spec/support/examples"))
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(File.expand_path("spec/support/examples"))
+  end
+
+  describe "#generate!" do
+    it "calls render on each group" do
+      expect_any_instance_of(Rambo::RSpec::ExampleGroup).to receive(:render)
+      subject.generate!
+    end
+
+    it "returns an array of strings" do
+      aggregate_failures do
+        expect(subject.generate!).to be_a(Array)
+        expect(subject.generate!.first).to be_a(String)
+      end
+    end
+  end
+
+  describe "#compose" do
+    before(:each) { subject.generate! }
+
+    it "returns a string" do
+      expect(subject.compose).to be_a(String)
+    end
+  end
+end

data/spec/lib/rspec/helper_file_spec.rb

@@ -0,0 +1,18 @@
+RSpec.describe Rambo::RSpec::HelperFile do
+  let(:template_path) {
+    File.expand_path("lib/rspec/templates/matcher_file_template.erb")
+  }
+
+  let(:file_path) {
+    File.expand_path("spec/support/matchers/rambo_matchers.rb")
+  }
+
+  subject { described_class.new(template_path: template_path, file_path: file_path) }
+
+  describe "generate" do
+    it "writes the file" do
+      expect(File).to receive(:write).with(file_path, File.read(template_path))
+      subject.generate
+    end
+  end
+end

data/spec/lib/rspec/spec_file_spec.rb

@@ -0,0 +1,58 @@
+RSpec.describe Rambo::RSpec::SpecFile do
+  let(:raw_raml)  { Raml::Parser.parse_file(raml_file) }
+  let(:options)   { { rails: true } }
+  let(:raml)      { Rambo::RamlModels::Api.new(raw_raml) }
+  let(:spec_file) { Rambo::RSpec::SpecFile.new(raw_raml, options) }
+
+  before(:each) do
+    FileUtils.mkdir_p(File.expand_path("spec/support/examples"))
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(File.expand_path("spec/support/examples"))
+  end
+
+  context "file with examples" do
+    let(:raml_file) { File.expand_path("../../../support/foobar.raml", __FILE__) }
+
+    describe "#initialize" do
+      it "assigns @raml" do
+        expect(spec_file.raml).not_to be_nil
+      end
+
+      it "uses the correct schema" do
+        expect(spec_file.raml.schema).to eq raw_raml
+      end
+    end
+
+    describe "#template" do
+      it "is a string" do
+        expect(spec_file.template.is_a?(String)).to be true
+      end
+    end
+
+    describe "#render" do
+      it "interpolates the correct values" do
+        expect(spec_file.render).to include("e-BookMobile API")
+      end
+    end
+  end
+
+  context "file with schema" do
+    let(:raml_file) do
+      File.expand_path("../../../../features/support/examples/raml/basic_raml_with_schema.raml", __FILE__)
+    end
+
+    describe "#initialize" do
+      it "assigns @raml" do
+        expect(spec_file.raml).not_to be_nil
+      end
+    end
+
+    describe "#template" do
+      it "is a string" do
+        expect(spec_file.template.is_a?(String)).to be true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require "coveralls"
+
+Coveralls.wear! if ENV["COVERAGE"] == "true"
+
+require "rspec"
+require "rspec/core"
+require "rspec/matchers"
+require "rspec/expectations"
+require "raml-rb"
+require "json_test_data"
+require "fileutils"
+
+lib = File.expand_path("../../lib", __FILE__)
+SPEC_DIR_ROOT = File.expand_path("../", __FILE__)
+
+Dir.foreach("#{lib}")   {|f| require f if f.match(/.*\.rb\z/) }
+
+RSpec.configure do |c|
+  c.disable_monkey_patching!
+  c.order = :random
+
+  c.after(:each) do
+    File.delete("spec/rambo_helper.rb") rescue nil
+    FileUtils.rm_rf("spec/support/matchers") rescue nil
+  end
+end

data/spec/support/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/spec/support/foo.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/spec/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/spec/support/foobar.yml

@@ -0,0 +1,3 @@
+title: e-BookMobile API
+baseUri: http://api.e-bookmobile.com/{version}
+version: v1