dredd-rack 0.3.0

data/lib/dredd/rack/version.rb

@@ -0,0 +1,5 @@
+module Dredd
+  module Rack
+    VERSION = '0.3.0'
+  end
+end

data/spec/lib/dredd/rack/configuration_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe Dredd::Rack::Configuration do
+
+  context 'when extending any class' do
+
+    before(:each) do
+      Dredd::Rack.const_set(:ConfigurableClass, Class.new)
+      @klass = Dredd::Rack::ConfigurableClass
+      @klass.send :extend, Dredd::Rack::Configuration
+    end
+
+    after(:each) do
+      Dredd::Rack.send(:remove_const, :ConfigurableClass)
+    end
+
+    let(:subject) { @klass }
+
+    describe 'provides #app which' do
+
+      it_behaves_like 'a configuration option', 'app'
+
+      it "defauts to nil", private: true do
+        expect(subject.app).to be_nil
+      end
+    end
+  end
+end

data/spec/lib/dredd/rack/rake_task_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Dredd::Rack::RakeTask do
+
+  it 'is a kind of Rake::TaskLib', protected: true do
+    expect(subject).to be_kind_of ::Rake::TaskLib
+  end
+
+  it 'responds to :description', public: true do
+    expect(subject).to respond_to :description
+  end
+
+  it 'responds to :runner', public: true do
+    expect(subject).to respond_to :runner
+  end
+
+  it 'responds to :name', public: true do
+    expect(subject).to respond_to :name
+  end
+
+  describe '#runner', public: true do
+
+    it 'is a default Dredd::Rack runner' do
+      expect(subject.runner).to be_kind_of Dredd::Rack::Runner
+      expect(subject.runner.command).to match(/\Adredd doc\/\*\.apib doc\/\*\.apib\.md \z/)
+    end
+  end
+
+  describe '#description', public: true do
+
+    it 'defaults to "Run Dredd::Rack API blueprint verification"' do
+      expect(subject.description).to eq 'Run Dredd::Rack API blueprint verification'
+    end
+
+    context 'and a custom description was provided' do
+
+      it 'returns the custom description' do
+        pending "I don't know how to setup the custom description."
+        # set the custom description here
+
+        subject = Dredd::Rack::RakeTask.new # should be created after setting the description
+        expect(subject.description).to eq 'Validate an API against its blueprint'
+      end
+    end
+  end
+
+  describe '#name', public: true do
+
+    it 'defaults to :dredd' do
+      expect(subject.name).to eq :dredd
+    end
+
+    context 'when a custom name was provided' do
+
+      it 'returns the custom name' do
+        subject = Dredd::Rack::RakeTask.new(:anderson)
+        expect(subject.name).to eq :anderson
+      end
+    end
+  end
+end

data/spec/lib/dredd/rack/runner_spec.rb

@@ -0,0 +1,223 @@
+require 'spec_helper'
+
+describe Dredd::Rack::Runner do
+
+  it 'responds to :api_endpoint', public: true do
+    expect(subject).to respond_to :api_endpoint
+  end
+
+  it 'responds to :command', public: true do
+    expect(subject).to respond_to :command
+  end
+
+  it 'responds to :command_parts', private: true do
+    expect(subject).to respond_to :command_parts
+  end
+
+  it 'responds to :command_parts=', private: true do
+    expect(subject).to respond_to :command_parts=
+  end
+
+  it 'respond_to :paths_to_blueprints', public: true do
+    expect(subject).to respond_to :paths_to_blueprints
+  end
+
+  it 'responds to :run', public: true do
+    expect(subject).to respond_to :run
+  end
+
+  it 'generates a valid command by default', public: true do
+    expect(subject.send(:command_valid?)).to be_truthy
+  end
+
+  describe 'responds to all the Dredd options', public: true do
+
+    Dredd::Rack::Runner::OPTIONS.each do |option|
+      it "responds to :#{option}" do
+        expect(subject).to respond_to option
+      end
+    end
+  end
+
+  describe 'responds to the negated form of the Dredd boolean options', public: true do
+
+    Dredd::Rack::Runner::NEGATABLE_BOOLEAN_OPTIONS.each do |option|
+      it "responds to :no_#{option}" do
+        expect(subject).to respond_to "no_#{option}".to_sym
+      end
+    end
+  end
+
+  describe '#command_valid?', private: true do
+
+    context 'when the generated command has less than two arguments' do
+
+      it 'returns false' do
+        allow(subject).to receive_message_chain(:command, :has_at_least_two_arguments?).and_return(false)
+        expect(subject.send(:command_valid?)).not_to be_truthy
+      end
+    end
+  end
+
+  describe '#initialize', public: true do
+
+    context 'with an API endpoint as argument' do
+
+      it 'defines a custom API endpoint' do
+        expect(Dredd::Rack::Runner.new('https://api.example.com').command).to end_with 'https://api.example.com'
+        expect(Dredd::Rack::Runner.new('https://api.example.com').command).not_to match /http:\/\/localhost:3000/
+      end
+    end
+
+    context 'with a block as argument' do
+
+      it 'returns a configured Dredd runner' do
+
+        subject = Dredd::Rack::Runner.new 'http://localhost:4567' do |options|
+          options.paths_to_blueprints 'blueprints/*.apib', 'doc/*.apib'
+          options.level :silly
+          options.no_color!
+        end
+
+        expect(subject.command).to match /http:\/\/localhost:4567/
+        expect(subject.command).to match /blueprints\/\*\.apib doc\/\*\.apib/
+        expect(subject.command).to match /--level silly/
+        expect(subject.command).to match /--no-color/
+
+        expect(subject.command).not_to match /http:\/\/localhost:3000/
+        expect(subject.command).not_to match /doc\/\*\.apib.md/
+      end
+    end
+  end
+
+  describe '#paths_to_blueprints', public: true do
+
+    it 'is chainable' do
+      expect(subject.paths_to_blueprints('some/path/*.apib')).to eq subject
+    end
+
+    context 'with one or more paths to blueprints as arguments' do
+
+      it 'defines custom paths to blueprints' do
+        expect(subject.paths_to_blueprints('blueprints/*.md', 'blueprints/*.apib').command).to match /blueprints\/\*\.md blueprints\/\*\.apib/
+        expect(subject.paths_to_blueprints('blueprints/*.md').command).not_to match /doc/
+      end
+    end
+
+    context 'with a blank path as argument', public: true do
+
+      it 'raises ArgumentError' do
+        expect{ subject.paths_to_blueprints('') }.to raise_error ArgumentError, 'invalid path to blueprints'
+      end
+    end
+  end
+
+  describe '#run', public: true do
+
+    context 'when the command is valid' do
+
+      before(:each) do
+        allow(subject).to receive(:command_valid?).and_return(true)
+      end
+
+      it 'runs Dredd!' do
+        command = double()
+        allow(subject).to receive(:command).and_return(command)
+
+        expect(Kernel).to receive(:system).with(command)
+        subject.run
+      end
+
+      context 'when configured to test the API locally' do
+
+        before(:each) do
+          allow(subject).to receive(:api_remote?).and_return(false)
+        end
+
+        context 'with Dredd::Rack.app properly configured' do
+
+          before(:each) do
+            @app_under_test = double()
+            allow(Dredd::Rack).to receive(:app).and_return(@app_under_test)
+
+            @capybara_server = double()
+            allow(@capybara_server).to receive(:new).and_return(@capybara_server)
+            allow(@capybara_server).to receive(:host).and_return('localhost')
+            allow(@capybara_server).to receive(:port).and_return('4567')
+            allow(Kernel).to receive(:system)
+
+            stub_const("Capybara::Server", @capybara_server)
+          end
+
+          it 'creates a Capybara::Server instance and serves the API' do
+            expect(@capybara_server).to receive(:new).with(@app_under_test)
+            expect(@capybara_server).to receive(:boot)
+            subject.run
+          end
+
+          it 'gets its API endpoint from the Capybara::Server instance' do
+            allow(@capybara_server).to receive(:boot)
+            expect { subject.run }.to change { subject.api_endpoint }.to("http://#{@capybara_server.host}:#{@capybara_server.port.to_s}")
+          end
+        end
+      end
+    end
+  end
+
+  Dredd::Rack::Runner::BOOLEAN_OPTIONS.each do |option|
+    describe "##{option}", public: true do
+      it_behaves_like 'a boolean option', option, ['some argument']
+    end
+  end
+
+  Dredd::Rack::Runner::NEGATABLE_BOOLEAN_OPTIONS.each do |option|
+    describe "#no_#{option}", public: true do
+      it_behaves_like 'a boolean option', "no_#{option}".to_sym, ['some argument']
+    end
+  end
+
+  Dredd::Rack::Runner::SINGLE_ARGUMENT_OPTIONS.each do |option|
+    describe "##{option}", public: true do
+      it_behaves_like 'a single-argument option', option, ['first argument', 'second argument']
+    end
+  end
+end
+
+describe String, public: true do
+
+  it 'responds to :has_at_least_two_arguments?' do
+    expect(subject).to respond_to :has_at_least_two_arguments?
+  end
+
+
+  describe '#has_at_least_two_arguments?' do
+
+    context 'when the String can be interpreted as a command with at least two arguments' do
+      context 'returns true (reliable)' do
+
+        ['dredd doc/*.apib http://api.example.com',
+         'dredd doc/*.apib doc/*apib.md http://api.example.com',
+         'dredd doc/*.apib http://api.example.com --level verbose'].each do |subject|
+
+          it "e.g. '#{subject}'" do
+            expect(subject.has_at_least_two_arguments?).to be_truthy
+          end
+        end
+      end
+    end
+
+    context 'when the String can be interpreted as a command with less than two arguments' do
+      context 'returns false (unreliable)' do
+
+        ['dredd http://api.example.com',
+         'dredd doc/*.apib --dry-run',
+         'dredd --dry-run --level verbose'].each do |subject|
+
+          it "e.g. '#{subject}'" do
+            expect(subject.has_at_least_two_arguments?).to be_falsey
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/dredd/rack_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe Dredd::Rack do
+
+  it 'is configurable', public: true do
+    expect(subject).to be_kind_of Dredd::Rack::Configuration
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'dredd/rack'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f; puts f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # make sure the deprecated RSpec 2 syntax is not used
+  config.raise_errors_for_deprecations!
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/spec_for_configuration_option_interface.rb

@@ -0,0 +1,28 @@
+RSpec.shared_examples 'a configuration option' do |option_name|
+
+  before(:each) do
+    @get_option = option_name.to_sym        # e.g. :sign_in_token
+    @set_option = option_name.+('=').to_sym # e.g. :sign_in_token=
+  end
+
+  it 'is accessible', private: true do
+    expect(subject).to respond_to @get_option
+    expect(subject).to respond_to @set_option
+  end
+
+  context 'once set' do
+
+    before(:each) do
+      @_original_value = subject.send @get_option
+      subject.send @set_option, 'custom header'
+    end
+
+    after(:each) do
+      subject.send @set_option, @_original_value
+    end
+
+    it 'can be retrieved', private: true do
+      expect(subject.send @get_option).to eq 'custom header'
+    end
+  end
+end

data/spec/support/specs_for_boolean_options.rb

@@ -0,0 +1,18 @@
+RSpec.shared_examples 'a boolean option' do |option|
+
+  it_behaves_like 'an option', option
+
+  let(:option_flag) { option.to_s.gsub('_', '-').gsub('!', '').prepend('--') }
+
+  it 'appends its flag to the command' do
+    expect{ subject.send(option) }.to change{
+      subject.command
+    }.to(include "#{option_flag}")
+  end
+
+  it 'ignores any option argument' do
+    expect{ subject.send(option, 'first argument', 'second argument') }.to change{
+      subject.command
+    }.to(end_with "#{option_flag}")
+  end
+end

data/spec/support/specs_for_options.rb

@@ -0,0 +1,6 @@
+RSpec.shared_examples 'an option' do |option|
+
+  it 'is chainable' do
+    expect(subject.send(option)).to eq subject
+  end
+end

data/spec/support/specs_for_single_argument_options.rb

@@ -0,0 +1,12 @@
+RSpec.shared_examples 'a single-argument option' do |option, args|
+
+  it_behaves_like 'an option', option
+
+  it 'appends its flag and argument to the command' do
+    option_flag = option.to_s.gsub('_', '-').prepend('--')
+
+    expect{ subject.send(option, args.slice(0), args.slice(1)) }.to change{
+      subject.command
+    }.to(end_with "#{option_flag} #{args.slice(0)}")
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: dredd-rack
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Gonzalo Bulnes Guilpain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- gon.bulnes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/dredd/rack.rb
+- lib/dredd/rack/configuration.rb
+- lib/dredd/rack/rake_task.rb
+- lib/dredd/rack/runner.rb
+- lib/dredd/rack/version.rb
+- spec/lib/dredd/rack/configuration_spec.rb
+- spec/lib/dredd/rack/rake_task_spec.rb
+- spec/lib/dredd/rack/runner_spec.rb
+- spec/lib/dredd/rack_spec.rb
+- spec/spec_helper.rb
+- spec/support/spec_for_configuration_option_interface.rb
+- spec/support/specs_for_boolean_options.rb
+- spec/support/specs_for_options.rb
+- spec/support/specs_for_single_argument_options.rb
+homepage: https://github.com/gonzalo-bulnes/dredd-rack
+licenses:
+- GPLv3
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Convenient API blueprint testing with Apiary Dredd for Rack applications.
+test_files:
+- spec/lib/dredd/rack/rake_task_spec.rb
+- spec/lib/dredd/rack/configuration_spec.rb
+- spec/lib/dredd/rack/runner_spec.rb
+- spec/lib/dredd/rack_spec.rb
+- spec/spec_helper.rb
+- spec/support/specs_for_single_argument_options.rb
+- spec/support/specs_for_boolean_options.rb
+- spec/support/specs_for_options.rb
+- spec/support/spec_for_configuration_option_interface.rb
+has_rdoc: