rambo_ruby 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e9e44dd1a7ba574cdbef91ae9da5408509f8ae9
-  data.tar.gz: fcb8fadb835b96e57e3f7aaddb4e975314728048
+  metadata.gz: 5b74a5013560eb488b270d589b8afe2c34d50710
+  data.tar.gz: f42894dd1bd0861c1c57f38e2ea50fc8b0ff88d5
 SHA512:
-  metadata.gz: 43b10db4c71a29b355004feab6648c96ebc5b810fead6b3fdfc89bbc70fceff67b6e8563b0ddab8ef8e68ace5212ff53b6bc692d07f237f69420d9ac10c0516a
-  data.tar.gz: 288b6ac7adfc13f090e0978e97c7bdc49878e681a8cdddd3502d22b345a294cd9a7df2087b2305093332c36eebd84c32606c2ad7e079c551772c91abe3ade1be
+  metadata.gz: 4410761d557036a272a84ca2b3daf8c8e812f1c24409a3ef30b83f8d1d72ccfdaf24378522c652effc819356e9080c4e49df11c2f31ee4799923c7c339c28cb6
+  data.tar.gz: de7a7aceb527990e6e71b5b7bff8c27653cfda9190263230233bf2578ff24d59d1572432b1f2792007bbda31a5485c1032986b2b59964b7e853600c9a9fa3506

data/README.md

@@ -4,7 +4,7 @@
 
 Rambo is a gem that generates API contract tests from API docs in [RAML](http://raml.org/). 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.
 
-#### The current version of Rambo is 0.2.3. It is highly unstable and has a limited feature set. Use at your own risk and please file issue reports if they come up!
+#### The current version of Rambo is 0.3.1. 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:
@@ -14,7 +14,7 @@ gem install rambo_ruby
 You can also add it to your project's Gemfile:
 ```ruby
 group :development, :test do
-  gem 'rambo_ruby', '~> 0.2.3'
+  gem 'rambo_ruby', '~> 0.3.1'
 end
 ```
 There are three options for generating tests from Rambo: The command line tool, the rake task, and the Ruby API. In all cases, Rambo will look for a `.rambo.yml` file in the root directory of your project for configuration options. Options may also be passed in through the command line as arguments or the Ruby API as a hash. There is currently no option to pass arguments to the Rake task, but Rambo comes pre-loaded with sensible defaults, and the `.rambo.yml` file is always an option.
@@ -39,6 +39,12 @@ Replace `foobar.raml` with the path of the actual RAML file from which you want
 #### Options
 By default, Rambo assumes you are testing a Rails app and generates tests using the Rails Rack::Test syntax. If you are testing a non-Rails Rack app, you can use the `--no-rails` switch to use the non-Rails syntax. Rambo does not currently support non-Rack-based frameworks.
 
+If your app uses an API token header, you can also pass in the token to be used as an option using the `-T` or `--token` flag:
+```
+$ rambo foobar.raml -T sometoken
+```
+Rambo will automatically use this value for any header whose name matches "token" or "key" (not case-sensitive).
+
 ### The Rake Task
 After adding `rambo_ruby` to your Gemfile or gemspec, you will need to add the following to your Rakefile:
 ```ruby
@@ -67,13 +73,16 @@ A sample `.rambo.yml` file could look like this:
 ```yaml
 raml: docs/contracts/foobar.raml
 rails: false
+token: foobarbaz
 ```
-The two possible keys are:
+The three possible keys are:
   - `raml` - specifies the RAML file to use to generate the tests. The default, relative
     to the root of your project directory, is `doc/raml/foobar.raml`, where `foobar.raml` is the first RAML file found in the `doc/raml` directory.
   - `rails` - specifies whether your app is a Rails app. The default value is `true`.
+  - `token` - the API key or token to be included in the security headers. This value will be
+    used for any header whose name matches either "token" or "key" (not case-sensitive).
 
-If a `.rambo.yml` file is present and additional options are passed in, the option values that are passed in will override those in the `.rambo.yml` file.
+If a `.rambo.yml` file is present and additional options are passed in through the command line or Ruby API, the option values that are passed in will override those in the `.rambo.yml` file.
 
 ## Default Behavior
 In order to provide the best user experience to a majority of users, Rambo comes with some sensible defaults that are easily overridden in an optional `.rambo.yml` file, or by using command line flags or a Ruby option hash (see above).
@@ -84,9 +93,9 @@ In the present version, Rambo only generates tests from a single RAML file. If y
 As noted above, Rambo currently supports only Rack-based apps. Since Rails is the most popular Ruby framework, it assumes your app is a Rails app unless specified otherwise. Since Rack::Test syntax differs when testing Rails and non-Rails apps, you will need to tell Rambo if your app is not a Rails app using the `--no-rails` switch on the command line, the `{ rails: false }` option hash for the Ruby API, or specifying `rails: false` in your `.rambo.yml` file.
 
 ## 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.
+I started Rambo in March of 2016 as part of my work at [Renew Financial](http://renewfinancial.com). For this reason, our primary focus has been on adding the features and functionality that are most important for testing RF's back-end services. Since my contract with Renew Financial has ended, I now have more latitude to do with the project what I want, but also less time to do it.
 
-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.
+Rambo, therefore, considers RAML 1.0 and Rails 4 the default, and support for other frameworks and for RAML 0.8 is currently 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.
 

data/lib/rambo/document_generator.rb

@@ -15,7 +15,7 @@ module Rambo
         generator.generate_matcher_dir!
         generator.generate_examples!
         generator.generate_spec_file!
-        generator.generate_rambo_helper!
+        generator.generate_rambo_helper!(options)
         generator.generate_matchers!
       end
     end
@@ -43,7 +43,9 @@ module Rambo
     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"
+        file_path:     "spec/rambo_helper.rb",
+        raml:          raml,
+        options:       options
       ).generate
     end
 
@@ -54,7 +56,7 @@ module Rambo
     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"
+        file_path: "spec/support/matchers/rambo_matchers.rb", raml: nil
       ).generate
     end
   end

data/lib/rambo/raml_models/headers.rb

@@ -17,14 +17,7 @@ module Rambo
       end
 
       def pretty
-        beginning = "{\n"
-        ending    = "}"
-
-        contents = headers.to_a.map {|pair|
-          "\t\"#{pair.first}\" => \"#{pair.last}\"\n"
-        }
-
-        "#{beginning}#{contents.join("")}#{ending}"
+        JSON.pretty_generate(headers).gsub("\":", "\" =>")
       end
     end
   end

data/lib/rambo/rspec/helper_file.rb

@@ -1,18 +1,33 @@
+require "erb"
+require "raml"
+require "rambo/raml_models"
+require "rambo/rspec/examples"
+
 module Rambo
   module RSpec
     class HelperFile
-      def initialize(template_path:, file_path:)
+      attr_reader :options
+
+      def initialize(template_path:, file_path:, raml: nil, options: nil)
         @template_path = template_path
         @file_path     = file_path
+        @options       = options || { rails: true }
+        @raml          = raml ? Rambo::RamlModels::Api.new(raml) : nil
       end
 
       def generate
-        write_to_file(template) unless file_already_exists?
+        write_to_file(render) unless file_already_exists?
+      end
+
+      def render
+        b = binding
+        ERB.new(template, 0, "-", "@result").result(raml.instance_eval { b })
+        @result
       end
 
       private
 
-      attr_reader :template_path, :file_path
+      attr_reader :template_path, :file_path, :raml
 
       def file_already_exists?
         File.exist?(file_path)

data/lib/rambo/rspec/templates/rambo_helper_file_template.erb

@@ -1,3 +1,15 @@
-require "spec_helper"
-
+require "<%= @options.fetch(:rails, nil) ? "rails_helper" : "spec_helper" %>"
+require "rack/test"
 require_relative "./support/matchers/rambo_matchers"
+
+<% if options.fetch(:rails, nil) %>module ApiHelper
+  include Rack::Test::Methods
+
+  def app
+    Rails.application
+  end
+end
+
+RSpec.configure do |config|
+  config.include ApiHelper, type: :request
+end<% end %>

data/lib/version.rb

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

data/spec/lib/rambo/document_generator_spec.rb

@@ -1,7 +1,8 @@
 RSpec.describe Rambo::DocumentGenerator do
   let(:valid_file) { File.join(SPEC_DIR_ROOT, "support/foobar.raml") }
-  let(:options) { { rails: true } }
-  let(:generator) { Rambo::DocumentGenerator.new(valid_file, options) }
+  let(:options)    { { rails: true } }
+  
+  subject          { described_class.new(valid_file, options) }
 
   before(:each) do
     allow_any_instance_of(Rambo::DocumentGenerator).to receive(:extract_raml)
@@ -51,23 +52,25 @@ RSpec.describe Rambo::DocumentGenerator do
   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!
+      subject.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({
+          .with(hash_including(
             :template_path => File.join(RAMBO_ROOT, "rambo/rspec/templates/rambo_helper_file_template.erb"),
-            :file_path     => "spec/rambo_helper.rb"
-          })
+            :file_path     => "spec/rambo_helper.rb",
+            :options       => { rails: true }
+          ))
         expect_any_instance_of(Rambo::RSpec::HelperFile).to receive(:generate)
       end
 
-      generator.generate_rambo_helper!
+      subject.generate_rambo_helper!
     end
   end
 
@@ -79,14 +82,14 @@ RSpec.describe Rambo::DocumentGenerator do
     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!
+      subject.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!
+      subject.generate_matcher_dir!
     end
   end
 
@@ -95,21 +98,21 @@ RSpec.describe Rambo::DocumentGenerator do
       aggregate_failures do
         expect_any_instance_of(Rambo::RSpec::HelperFile)
           .to receive(:initialize)
-          .with(
-            template_path: File.join(RAMBO_ROOT, "rambo/rspec/templates/matcher_file_template.erb"),
-            file_path: "spec/support/matchers/rambo_matchers.rb"
-          )
+          .with(hash_including(
+            :template_path => File.join(RAMBO_ROOT, "rambo/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!
+      subject.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!
+      subject.generate_examples!
     end
   end
 end

data/spec/lib/rambo/raml_models/headers_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe Rambo::RamlModels::Headers do
 
   describe "#pretty" do
     let(:pretty) do
-      "{\n\t\"Content-Type\" => \"application/json\"\n}"
+      %Q[{\n  "Content-Type" => "application/json"\n}]
     end
 
     it "makes it pretty" do
@@ -16,11 +16,10 @@ RSpec.describe Rambo::RamlModels::Headers do
       let(:headers) { { "Content-Type" => "application/json", "Accept" => "application/json" } }
 
       let(:pretty) do
-        "{\n\t\"Content-Type\" => \"application/json\",\n\t\"Accept\" => \"application/json\"\n}"
+        %Q[{\n  "Content-Type" => "application/json",\n  "Accept" => "application/json"\n}]
       end
 
       it "formats the header hash" do
-        pending "Test fails when functionality works as expected...confusing"
         expect(subject.pretty).to eql pretty
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rambo_ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Dana Scheider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -287,7 +287,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: rambo_ruby-0.3.0
+summary: rambo_ruby-0.3.1
 test_files:
 - features/create_files.feature
 - features/error_modes.feature