rspec_api_blueprint_matchers 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3beafbdb89aaed312b890081521e50c6973475eb
+  data.tar.gz: 512c3f1a07442117d84aadd3cd6e25ba03f12e81
+SHA512:
+  metadata.gz: dd113aa0f4dcdf19a1760bd9ed0d5f48db11f993ae56c53b6e8e06e3427df2900ed9f03003eeb23979f4c2870a11ffc621bbd8e5ad59fc395ddd9f4ca8629c90
+  data.tar.gz: 8c496cef8d847dd9e7e3155ea53da91735556c6d99ff2a8d74d4327297894e042531236c03d0cc9b806cd2fe3b48869d73232117621953125b9b5342e7ef481f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Dockerfile

@@ -0,0 +1,24 @@
+FROM ruby:2.4.1-slim
+LABEL maintainer "team@shiftcommerce.com"
+
+# Install essentials and cURL
+RUN apt-get update -qq && apt-get install -y --no-install-recommends build-essential curl git libpq-dev python
+
+# Install drafter for API Blueprint Parsing
+RUN mkdir /tmp_build
+RUN cd /tmp_build
+RUN bash -c "git clone --recursive git://github.com/apiaryio/drafter.git; cd drafter; ./configure; make test; make drafter; make install"
+RUN rm -rf /tmp_build
+
+
+# Configure the main working directory
+ENV app /app
+RUN mkdir $app
+WORKDIR $app
+
+# Set the where to install gems
+ENV GEM_HOME /rubygems
+ENV BUNDLE_PATH /rubygems
+
+# Link the whole application up
+ADD . $app

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shift Commerce Ltd
+
+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,77 @@
+# RspecApib
+
+This gem allows your rspec test suite to validate requests and responses against
+your api blueprint documentation.
+
+It also allows for validating that all documented http transactions are
+covered in your test suite.  (Care should be taken with parallel specs if using this)
+
+
+## Installation
+
+This gem uses the standard api blueprint parser called "drafter" which must be
+installed before using this gem.
+
+To install it, please refer to https://github.com/apiaryio/drafter#build
+
+Once drafter is installed, please do the following :-
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_apib', group: :test
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_apib
+
+## Usage
+
+For the rest of the documentation, we will refer to "request" and "response".  These
+can be a faraday request / response environment, or a rack request / response environment
+or a generic request / response from a rails integration test suite.
+
+### Validating a http transaction
+
+A transaction is a struct containing "request" and "response" where request and
+response are typical requests and responses from rack / faraday etc..
+At present, we are using this gem for faraday though.
+
+```ruby
+expect(transaction).to match_api_docs_for(path: "/blogs", request_method: :post, content_type: "application/json")
+```
+
+#### How This Works
+
+How this works is the request is repeatedly matched against all transactions
+(request / response pairs) in the api blueprint document.  This is done in
+2 phases - first a 'short list', then a detailed match on this short list.
+This is to prevent expensive schema matching when even the basics don't match.
+The short list is then further filtered by what the developer asked for in the
+'match_api_docs_for' matcher.
+
+The matcher also allows the symbol :any to mean "Don't care what it is" but use
+with caution.
+
+The same is then done for the response and any transactions that match both
+are considered a good match.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shiftcommerce/rspec_api_blueprint_matchers
+
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_apib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/codeship-services.yml

@@ -0,0 +1,7 @@
+app:
+  build:
+    image: flomotlik/discourse
+    dockerfile_path: Dockerfile
+  cached: true
+  volumes:
+    - ./:/code

data/codeship-steps.yml

@@ -0,0 +1,4 @@
+- type: serial
+  steps:
+  - service: app
+    command: bash -c "bundle install && bundle exec rspec"

data/lib/rspec_api_blueprint_matchers.rb

@@ -0,0 +1 @@
+require "rspec_apib"

data/lib/rspec_apib.rb

@@ -0,0 +1,41 @@
+require "rspec_apib/version"
+require "rspec_apib/parser"
+require "rspec_apib/extractors"
+require "rspec_apib/transaction_validator"
+require "rspec_apib/rspec"
+require "rspec_apib/config"
+require "rspec_apib/request"
+require "rspec_apib/response"
+module RSpecApib
+  ROOT_THREAD_VARS = :"rspec_apib"
+  # The global configuration object
+  # If a block is passed into this method, it is yielded with
+  # the config object and all actions are performed from within the
+  # block as a batch - any action(s) that then need performing after
+  # a reconfigure are done once only.
+  def self.config
+    return config_instance unless block_given?
+    config_instance.batch_configure do |config|
+      yield(config)
+    end
+  end
+
+  def self.normalize_request(request)
+    Request.new request
+  end
+
+  def self.normalize_response(response)
+    Response.new response
+  end
+
+  # Global storage per thread for the gems to use where required.
+  # @return [Hash] A hash which the caller is free to modify at will
+  def self.root_thread_vars
+    Thread.current[ROOT_THREAD_VARS] ||= {}
+  end
+
+  def self.config_instance
+    root_thread_vars[:config_instance] ||= RSpecApib::Config.new
+  end
+
+end

data/lib/rspec_apib/config.rb

@@ -0,0 +1,17 @@
+module RSpecApib
+  class Config
+    attr_accessor :default_blueprint_file
+    def batch_configure
+      yield self
+    end
+
+    # The default Parser
+    # If a single blueprint file is used throughout specs then by not specifying
+    # your own parser in your examples, this default will be used which has pre
+    # parsed the default blueprint file
+    # @return [::RSpecApib::Parser] The parser
+    def default_parser
+      @default_parser ||= Parser.new.tap { |p| p.parse_file(default_blueprint_file) }
+    end
+  end
+end

data/lib/rspec_apib/elements.rb

@@ -0,0 +1,20 @@
+require "rspec_apib/elements/base"
+require "rspec_apib/elements/parse_result"
+require "rspec_apib/elements/category"
+require "rspec_apib/elements/copy"
+require "rspec_apib/elements/resource"
+require "rspec_apib/elements/transition"
+require "rspec_apib/elements/http_transaction"
+require "rspec_apib/elements/http_request"
+require "rspec_apib/elements/http_response"
+require "rspec_apib/elements/http_headers"
+require "rspec_apib/elements/asset"
+require "rspec_apib/elements/data_structure"
+require "rspec_apib/elements/object"
+require "rspec_apib/elements/member"
+require "rspec_apib/elements/annotation"
+require "rspec_apib/elements/templated_href"
+require "rspec_apib/elements/href_variables"
+require "rspec_apib/elements/source_map"
+require "rspec_apib/elements/string"
+require "rspec_apib/elements/array"

data/lib/rspec_apib/elements/annotation.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class Annotation < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/array.rb

@@ -0,0 +1,9 @@
+module RSpecApib
+  module Element
+    class Array < ::Array
+      def self.from_hash(hash, index:, parent:)
+        new(hash["content"])
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/asset.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class Asset < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/base.rb

@@ -0,0 +1,97 @@
+module RSpecApib
+  module Element
+    class Base < Struct.new(:element, :meta, :attributes, :content, :parent)
+
+      def inspect(*args)
+        "##{self.class} (element: #{element}, meta: #{meta}, attributes: #{attributes.inspect}, content: #{content.inspect}, parent: ##{parent.class})"
+      end
+
+      def self.parse_root(root)
+        index = {}
+        result = parse(root, index: index, parent: nil)
+        [result, index]
+      end
+
+      def self.parse(node_or_nodes, index:, parent:, klass: nil)
+        return node_or_nodes.map { |node| parse(node, index: index, parent: parent) } if node_or_nodes.is_a?(::Array)
+        return transformed_basic_hash(node_or_nodes, index: index, parent: parent) if is_basic_hash?(node_or_nodes)
+        return node_or_nodes unless !klass.nil? || is_base_element?(node_or_nodes)
+        hash = node_or_nodes
+        klass_name = klass
+        klass_name ||= hash["element"].slice(0,1).capitalize + hash["element"].slice(1..-1).gsub(" ", "")
+        return node_or_nodes unless RSpecApib::Element.const_defined?(klass_name)
+        klass = RSpecApib::Element.const_get(klass_name)
+        index[klass] ||= []
+        element = klass.from_hash(hash, index: index, parent: parent)
+        index[klass] << element
+        element
+      end
+
+      def self.from_hash(hash, index:, parent:)
+        attrs = parse_attributes(hash["attributes"], index: index, parent: parent)
+        child = new(hash["element"], hash["meta"], attrs, nil, parent)
+        child.content = parse(hash["content"], index: index, parent: child)
+        inherit_attrs_from_ancestors(child)
+        child
+      end
+
+      def self.inherit_attrs_from_ancestors(child)
+        child.attributes ||= {}
+        attrs = child.attributes
+        attrs_to_inherit.each do |attr|
+          attr_as_str = attr.to_s
+          unless attrs.key?(attr_as_str)
+            val = ancestor_attr(child, attr_as_str)
+            attrs[attr_as_str] = val unless val.nil?
+          end
+        end
+      end
+
+      def self.ancestor_attr(node, attr)
+        return nil if node.nil?
+        return node.attributes[attr] if node.attributes && node.attributes.key?(attr)
+        ancestor_attr(node.parent, attr)
+      end
+
+      def self.attrs_to_inherit
+        []
+      end
+
+      def self.attr_readers
+        {}
+      end
+
+      def self.is_base_element?(node)
+        node.is_a?(::Hash) && node.keys.include?("element")
+      end
+
+      private
+
+      def self.attributes_schema
+        {}
+      end
+
+      def self.parse_attributes(node, index:, parent:)
+        return node if node.nil?
+        node = node.dup
+        node.keys.each do |key|
+          klass = attributes_schema[key.to_sym]
+          node[key] = parse(node[key], index: index, parent: parent, klass: klass)
+        end
+        node
+      end
+
+      def self.is_basic_hash?(node)
+        node.is_a?(::Hash) && !is_base_element?(node)
+      end
+
+      def self.transformed_basic_hash(node, index:, parent:)
+        node = node.dup
+        node.keys.each do |key|
+          node[key] = parse(node[key], index: index, parent: parent)
+        end
+        node
+      end
+    end
+  end
+end

data/lib/rspec_apib/elements/category.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class Category < Base
+
+    end
+  end
+end

data/lib/rspec_apib/elements/copy.rb

@@ -0,0 +1,7 @@
+module RSpecApib
+  module Element
+    class Copy < Base
+
+    end
+  end
+end