rspec-raml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5ae1aeda8f77496f297580603fd96c4e5154bf5
+  data.tar.gz: 8bc9b4a703c8279424066f96b495bb6bdfb31726
+SHA512:
+  metadata.gz: 68c8ee7ef5fece8bc49284a9f09b0f1d5979eb5db9321640e7ffa887c74d94a641ce4804fec3905b79db441d04e41a7e99d5ae964a28151122874517fc6cdff1
+  data.tar.gz: c7cea7d5077cab65be77bbcf28879fcab012d764e52591c4598632de90c3ae3351dba6bc33cdcc25fe9d9a343504f8af5edd035b01ed03563765b96e79a7f3ed

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.12.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-raml.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ray Zane
+
+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,95 @@
+# Rspec::Raml
+
+RSpec matchers for working with [RAML](http://raml.org).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-raml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-raml
+
+## Setup
+
+First, you'll need to include RSpec::Raml's helpers in your RSpec configuration.
+
+```ruby
+RSpec.configure do |config|
+  config.include RSpec::Raml::Matchers, type: :request
+end
+```
+
+## Usage
+
+Assume you've got a RAML specification:
+
+```yaml
+#%RAML 0.8
+---
+title: Dummy API
+baseUri: https://dummy-api.com/api/{version}
+version: v1
+
+/users:
+  /{id}:
+    displayName: Find a user
+    get:
+      responses:
+        200:
+          description: User was found.
+          body:
+            application/json:
+              example: |-
+                {
+                  "id": 1,
+                  "first_name": "John",
+                  "last_name": "Doe"
+                }
+
+```
+
+You can write a spec that compares an HTTP response with the RAML specifcation you've written.
+
+```ruby
+# spec/requests/api/v1/users_spec.rb
+
+describe 'Users API' do
+  describe 'GET /api/v1/users/:id' do
+    raml { Rails.root.join('docs/api/v1.raml') }
+
+    let(:user) {
+      User.create!(
+        id: 1,
+        first_name: 'John',
+        last_name: 'Doe'
+      )
+    }
+
+    it 'is documented' do
+      get "/api/v1/users/#{user.id}"
+      expect(response).to match_raml(:get, '/users/{id}', 200)
+    end
+  end
+end
+```
+
+The `match_raml` matcher will verify that the status code returns successfully, and that the response body matches what you've declared in your RAML specification.
+
+If you haven't written your specification yet, RSpec::Raml will output an example RAML specification.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/rspec-raml.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rspec/raml/finder.rb

@@ -0,0 +1,38 @@
+require 'raml'
+
+module RSpec
+  module Raml
+    class Finder
+      attr_reader :raml
+
+      def initialize(raml)
+        @raml = raml
+      end
+
+      # Recursively traverses the raml structure and locates all Raml::Resources
+      # with a matching url.
+      def find_resources(path, node = raml)
+        node.children.flat_map do |child|
+          if child.kind_of?(::Raml::Resource) && child.resource_path == path
+            child
+          else
+            find_resources(path, child)
+          end
+        end
+      end
+
+      # Finds the response that matches the verb, path, and status.
+      def find_response(verb, path, status)
+        resources = find_resources(path)
+
+        resource = resources.find do |node|
+          method = node.methods[verb.to_s]
+          method && method.responses[status]
+        end
+
+        http_method = resource && resource.methods[verb.to_s]
+        http_method.responses[status] if http_method
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/abstract.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'yaml'
+
+module RSpec
+  module Raml
+    module Matchers
+      class Abstract
+        attr_reader :raml, :verb, :url, :status, :response
+
+        def initialize(raml, verb, url, status)
+          @raml = raml
+          @verb = verb
+          @url = url
+          @status = status
+        end
+
+        def matches?(response)
+          @response = response
+          matches_raml?
+        end
+
+        private
+
+        def content_type
+          response.content_type.to_s
+        end
+
+        def pretty_format(body)
+          JSON.pretty_generate(JSON.parse(body))
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/be_raml_content_type.rb

@@ -0,0 +1,23 @@
+require 'rspec/raml/matchers/abstract'
+
+module RSpec
+  module Raml
+    module Matchers
+      class BeRamlContentType < Abstract
+        def failure_message
+          "expected RAML to declare a response for content type: #{content_type}"
+        end
+
+        def failure_message_when_negated
+          "expected RAML not to declare content type: #{content_type}"
+        end
+
+        private
+
+        def matches_raml?
+          raml.bodies.key? content_type
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/match_raml.rb

@@ -0,0 +1,27 @@
+require 'rspec/raml/matchers/abstract'
+
+module RSpec
+  module Raml
+    module Matchers
+      class MatchRaml < Abstract
+        delegate :failure_message, :failure_message_when_negated, to: :failure
+
+        private
+
+        def matches_raml?
+          failure.nil?
+        end
+
+        def failure
+          @failure ||= matchers.find { |m| !m.matches?(response) }
+        end
+
+        def matchers
+          (RSpec::Raml::Matchers::MATCHERS - [self.class]).map do |matcher|
+            matcher.new(raml, verb, url, status)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/match_raml_body.rb

@@ -0,0 +1,40 @@
+require 'rspec/raml/matchers/abstract'
+
+module RSpec
+  module Raml
+    module Matchers
+      class MatchRamlBody < Abstract
+        def failure_message
+          diff = differ.diff_as_string(response_body, raml_body)
+          "expected response bodies to match:#{diff}"
+        end
+
+        def failure_message_when_negated
+          "expected response bodies not to match"
+        end
+
+        private
+
+        def matches_raml?
+          response_body == raml_body
+        end
+
+        def response_body
+          @response_body ||= indent_pretty_format(response.body)
+        end
+
+        def raml_body
+          @raml_body ||= indent_pretty_format(raml.bodies.fetch(content_type).example)
+        end
+
+        def differ
+          @differ ||= RSpec::Support::Differ.new(color: true)
+        end
+
+        def indent_pretty_format(body)
+          pretty_format(body).gsub("\n", "\n  ").prepend('  ')
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/match_raml_status.rb

@@ -0,0 +1,23 @@
+require 'rspec/raml/matchers/abstract'
+
+module RSpec
+  module Raml
+    module Matchers
+      class MatchRamlStatus < Abstract
+        def failure_message
+          "expected the response to have a #{raml.name} status code, but got #{response.status}"
+        end
+
+        def failure_message_when_negated
+          "expected the response not to have status: #{raml.name}"
+        end
+
+        private
+
+        def matches_raml?
+          response.status == raml.name
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers/null_matcher.rb

@@ -0,0 +1,43 @@
+require 'rspec/raml/matchers/abstract'
+
+module RSpec
+  module Raml
+    module Matchers
+      class NullMatcher < Abstract
+        def initialize(verb, url, status)
+          super(nil, verb, url, status)
+        end
+
+        def failure_message
+          "RAML not found. Here's something to get you started:\n\n#{template}"
+        end
+
+        private
+
+        def matches_raml?
+          false
+        end
+
+        def template
+          {
+            url => {
+              displayName: 'PENDING NAME',
+              verb => {
+                responses: {
+                  status => {
+                    description: 'PENDING DESCRIPTION',
+                    body: {
+                      response.content_type => {
+                        example: pretty_format(response.body)
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }.deep_stringify_keys.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/matchers.rb

@@ -0,0 +1,57 @@
+require 'raml'
+require 'rspec/raml/finder'
+require 'rspec/raml/matchers/null_matcher'
+require 'rspec/raml/matchers/match_raml'
+require 'rspec/raml/matchers/match_raml_body'
+require 'rspec/raml/matchers/match_raml_status'
+require 'rspec/raml/matchers/be_raml_content_type'
+
+module RSpec
+  module Raml
+    module Matchers
+      MATCHERS = [
+        MatchRaml,
+        MatchRamlStatus,
+        BeRamlContentType,
+        MatchRamlBody
+      ]
+
+      def self.included(base)
+        base.extend ClassMethods
+        base.let(:_raml_finder) do
+          raise ArgumentError, <<-EOMSG.strip_heredoc
+            You need to specify a RAML specification file. Example:
+
+              raml { Rails.root.join('docs/api/v1.raml') }
+          EOMSG
+        end
+      end
+
+      module ClassMethods
+        def raml(&block)
+          let(:_raml_file, &block)
+          let(:_raml_finder) do
+            RSpec::Raml::Finder.new(::Raml.parse_file(_raml_file))
+          end
+        end
+      end
+
+      # Generate matcher methods:
+      #
+      # + def match_raml(verb, url, status)
+      # + def match_raml_status(verb, url, status)
+      # + def match_raml_body(verb, url, status)
+      # + def be_raml_content_type(verb, url, status)
+      #
+      MATCHERS.each do |matcher|
+        define_method matcher.name.split('::').last.underscore do |verb, url, status|
+          if raml = _raml_finder.find_response(verb, url, status)
+            matcher.new(raml, verb, url, status)
+          else
+            NullMatcher.new(verb, url, status)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/raml/version.rb

@@ -0,0 +1,5 @@
+module Rspec
+  module Raml
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/raml.rb

@@ -0,0 +1,7 @@
+require 'rspec/raml/version'
+require 'rspec/raml/matchers'
+
+module Rspec
+  module Raml
+  end
+end

data/lib/rspec-raml.rb

@@ -0,0 +1 @@
+require 'rspec/raml'

data/rspec-raml.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/raml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-raml'
+  spec.version       = Rspec::Raml::VERSION
+  spec.authors       = ['Ray Zane']
+  spec.email         = ['raymondzane@gmail.com']
+
+  spec.summary       = %q{RSpec matchers for working with RAML.}
+  spec.description   = %q{RSpec matchers for working with RAML.}
+  spec.homepage      = 'https://github.com/rzane/rspec-raml'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'raml_ruby'
+  spec.add_dependency 'rspec'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: rspec-raml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: raml_ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: RSpec matchers for working with RAML.
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-raml.rb
+- lib/rspec/raml.rb
+- lib/rspec/raml/finder.rb
+- lib/rspec/raml/matchers.rb
+- lib/rspec/raml/matchers/abstract.rb
+- lib/rspec/raml/matchers/be_raml_content_type.rb
+- lib/rspec/raml/matchers/match_raml.rb
+- lib/rspec/raml/matchers/match_raml_body.rb
+- lib/rspec/raml/matchers/match_raml_status.rb
+- lib/rspec/raml/matchers/null_matcher.rb
+- lib/rspec/raml/version.rb
+- rspec-raml.gemspec
+homepage: https://github.com/rzane/rspec-raml
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RSpec matchers for working with RAML.
+test_files: []