dalziel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6944cdfc4fdc1dd2a028bfb9c6fe2583daf677a9
+  data.tar.gz: 2da11520a936a1a849d3309273f65f50ff65a992
+SHA512:
+  metadata.gz: 3ad60a04ed570187c166d925c6da42758d0b306860edce7966ff76f5146840f07b80a2e8e6bbd0de9e4b91b1b09952271546abca82c89cc2f09dc2983c428741
+  data.tar.gz: ab6de7d98900481fad52bb34684327050f3f90953ee8a149a254ebcea0869d392c9fde3a39bd5ada610639e9c38df5808929cec926bc64f24f334b9351871c12

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.3.1
+before_install: gem install bundler -v 1.14.4

data/Gemfile

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

data/README.md

@@ -0,0 +1,84 @@
+# Dalziel
+
+Convenience library for testing JSON API calls in RSpec.
+Uses [WebMock](https://github.com/bblimke/webmock) and
+[JSON Expressions](https://github.com/chancancode/json_expressions).
+
+* Easily specify JSON responses for stubbed calls with WebMock.
+* Verify that the request you've sent contains the right data.
+* Verify that you respond as a proper JSON API.
+* Easy to read failure messages
+
+## Usage
+
+Testing outgoing requests:
+
+``` ruby
+
+it "makes the right request" do
+
+  # lightweight wrapper around webmock for stubbing JSON calls
+  request = stub_json_request(
+    :put,
+    "http://some-api-call"
+    user: {
+      id: 5,
+      name: "Pascoe"
+    }
+  )
+
+  call_your_code
+
+  # make sure you sent the right data to the external service
+  expect(request).to match_json_request(
+    user: {
+      name: "Pascoe",
+      password: String,
+    }.ignore_extra_keys!
+  )
+end
+```
+
+The other side of the request, verify that you behave as a JSON API:
+
+``` ruby
+it "creates a user" do
+  post "/users", user: { name: "Pascoe" }
+
+  expect(User.count).to eq 1
+
+  expect(last_response).to match_json_response(
+    user: {
+      id: Integer,
+      name: String,
+    }.ignore_extra_keys!
+  ).status(201) # defaults to 200
+end
+```
+
+This tests your headers too.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dalziel', group: :test
+```
+
+## 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).
+
+## 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 "dalziel"
+
+# 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/dalziel.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dalziel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dalziel"
+  spec.version       = Dalziel::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+
+  spec.summary       = %q{Convenience gem for testing JSON API calls}
+  spec.description   = %q{Convenience gem for testing JSON API calls}
+  spec.homepage      = "https://github.com/iain/dalziel"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "json_expressions", "~> 0.8"
+  spec.add_dependency "webmock", "~> 2.3"
+end

data/lib/dalziel/version.rb

@@ -0,0 +1,3 @@
+module Dalziel
+  VERSION = "0.1.0"
+end

data/lib/dalziel.rb

@@ -0,0 +1,232 @@
+require "dalziel/version"
+require "json_expressions"
+require "webmock"
+
+module Dalziel
+
+  def self.format_headers(headers)
+    size = headers.keys.map(&:size).max
+    headers.map { |k,v| "%-#{size + 2}s %s" % [ "#{k}:", v ] }.join("\n")
+  end
+
+  def self.indent(string)
+    string.split("\n").map { |line| "    #{line}" }.join("\n")
+  end
+
+  module Matchers
+
+    # Stubs outgoing JSON requests with WebMock.
+    #
+    # Usage:
+    #
+    #     stub_json_request(:get, "url", user: { id: 1 })
+    def stub_json_request(verb, url, body, status = 200)
+      stub_request(verb, url).to_return(
+        headers: { content_type: "application/json" },
+        body: body.to_json,
+        status: status,
+      )
+    end
+
+
+    # Verifies outgoing request body stubbed with WebMock.
+    #
+    # Usage:
+    #
+    #     req = stub_json_request(:get, "url", user: { id: 1 })
+    #
+    #     act
+    #
+    #     expect(req).to match_json_request(
+    #       foo: {
+    #         bar: Integer
+    #       }
+    #     )
+    def match_json_request(pattern)
+      RequestMatcher.new(pattern)
+    end
+
+    # Verifies that the response is a proper JSON response.
+    # Optionally you can chain `status` to verify the status code.
+    #
+    # Usage:
+    #
+    #     get "/foo/bar"
+    #     expect(last_response).to match_json_response(
+    #       foo: {
+    #         bar: Integer
+    #       }
+    #     )
+    def match_json_response(pattern)
+      ResponseMatcher.new(pattern)
+    end
+
+    # Replacement for the json_expression default matcher, shows prettier output.
+    #
+    # Usage:
+    #
+    #     expect(json_or_hash).to match_json_expression(
+    #       user: {
+    #         id: Integer
+    #       }
+    #     )
+    def match_json_expression(pattern)
+      JSONPatternMatcher.new(pattern)
+    end
+
+    class JSONPatternMatcher
+
+      attr_reader :json_expression, :request, :body
+
+      def initialize(json_expression)
+        @json_expression = json_expression
+      end
+
+      def does_not_match?(*)
+        fail "Inverted matching is not implemented with this matcher"
+      end
+
+      def matches?(json)
+        @original = json
+        @hash = json.is_a?(String) ? JSON.parse(json) : json
+        matcher =~ @hash
+      rescue JSON::ParserError => error
+        @not_parsable_json = error
+        false
+      end
+
+      def failure_message
+        if @not_parsable_json
+          original = Dalziel.indent(@original.inspect)
+          error = "#{@not_parsable_json.class}: #{@not_parsable_json}"
+          "Couldn't parse the following:\n\n%s\n\n%s" % [ original, error ]
+        else
+          json = Dalziel.indent(JSON.pretty_generate(@hash))
+          type = @original.is_a?(String) ? "JSON" : @original.class.to_s
+          "Got the following %s:\n\n%s\n\n%s" % [ type, json, matcher.last_error ]
+        end
+      end
+
+      private
+
+      def matcher
+        @matcher ||= JsonExpressions::Matcher.new(json_expression)
+      end
+
+    end
+
+    class RequestMatcher
+
+      attr_reader :json_expression, :request, :body
+
+      def initialize(json_expression)
+        @json_expression = json_expression
+      end
+
+      def matches?(request_pattern)
+        @request = nil
+        all_stubbed_requests.each { |request_signature, _count|
+          if request_pattern.matches?(request_signature)
+            @request = request_signature
+            break
+          end
+        }
+        return false if @request.nil?
+
+        @body = JSON.parse(@request.body)
+        @accept = @request.headers["Accept"]
+
+        @is_json = @accept =~ /\bjson$/
+        @json_match = payload_matcher =~ @body
+
+        @is_json && @json_match
+      end
+
+      def does_not_match?(response)
+        fail "Inverted matching is not implemented with this matcher"
+      end
+
+      def failure_message
+        if @request == []
+          "No request matched"
+        elsif !@is_json
+          "Accept header is not JSON.\n\n%s\n\nAccept is %s" % [ show_request, @accept.inspect ]
+        else
+          "Request body did not match.\n\n%s\n\n%s" % [ show_request, payload_matcher.last_error ]
+        end
+      end
+
+      def show_request
+        headers = Dalziel.format_headers(request.headers)
+        Dalziel.indent "%s %s\n\n%s\n\n%s" % [ request.method.to_s.upcase, request.uri.to_s, headers, JSON.pretty_generate(body) ]
+      end
+
+      def payload_matcher
+        @payload_matcher ||= JsonExpressions::Matcher.new(json_expression)
+      end
+
+      def all_stubbed_requests
+        WebMock::RequestRegistry.instance.requested_signatures
+      end
+
+    end
+
+    class ResponseMatcher
+
+      attr_reader :json_expression, :response, :body
+
+      def initialize(json_expression)
+        @json_expression = json_expression
+        @status = 200
+      end
+
+      def matches?(response)
+        @response = response
+        @body = JSON.parse(response.body)
+        @content_type = response.headers["Content-Type"]
+
+        @is_json = (@content_type.to_s.split(";",2).first =~ /\bjson$/)
+        @json_match = (payload_matcher =~ @body)
+        @status_match = (@status == response.status)
+
+        @status_match && @is_json && @json_match
+      end
+
+      def does_not_match?(response)
+        fail "Inverted matching is not implemented with this matcher"
+      end
+
+      def failure_message
+        if !@is_json
+          "Content-Type is not JSON.\n\n%s\n\nContent-Type is %s" % [ show_response, @content_type.inspect ]
+        elsif !@status_match
+          "Unexpected response status.\n\n%s\n\nExpected response status to be %s, but was %s." % [ show_response, @status.inspect, response.status ]
+        else
+          "Response body did not match.\n\n%s\n\n%s" % [ show_response, payload_matcher.last_error ]
+        end
+      end
+
+      def payload_matcher
+        @payload_matcher ||= JsonExpressions::Matcher.new(json_expression)
+      end
+
+      def show_response
+        headers = Dalziel.format_headers(response.headers)
+        Dalziel.indent "HTTP/1.1 %s\n\n%s\n\n%s" % [ response.status, headers, JSON.pretty_generate(body) ]
+      end
+
+      def status(code)
+        @status = code
+        self
+      end
+
+    end
+
+  end
+end
+
+if defined?(RSpec)
+  RSpec.configure do |config|
+    config.include Dalziel::Matchers
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: dalziel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json_expressions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Convenience gem for testing JSON API calls
+email:
+- iain@iain.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dalziel.gemspec
+- lib/dalziel.rb
+- lib/dalziel/version.rb
+homepage: https://github.com/iain/dalziel
+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: Convenience gem for testing JSON API calls
+test_files: []