rspec-webservice-outputter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 102e6bb89cb79ca071e9adfd282c1c234a8ad393
+  data.tar.gz: 5b4708ed56dd994f2b53081215ea25dbc95b371b
+SHA512:
+  metadata.gz: 1960fb4efb98d500f008372b03592fa8a0e8c0471f30bad98c05172d00893256d6b3b15e710580074e9faab091c316611778ea0fcb04d1fa57bbd016d78b175c
+  data.tar.gz: 3cf372fc49f59de8df40313a82a9ed13e8fd43ccb56f089358dc037fa6cc3b2a094529d40e26170ca5b4db56c50c0d3918cc6ad04228969797053da6e7ea13fc

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+StringLiterals:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gem "rspec", ">= 2.0"
+gem "activesupport", ">= 3.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0.11"
+  gem "rubocop"
+end

data/Gemfile.lock

@@ -0,0 +1,108 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    ast (2.3.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2
+    hashie (3.4.4)
+    highline (1.7.8)
+    i18n (0.7.0)
+    json (1.8.3)
+    juwelier (2.1.2)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.1)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    pkg-config (1.1.7)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rainbow (2.1.0)
+    rake (11.1.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.0)
+    rubocop (0.40.0)
+      parser (>= 2.3.1.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    semver (1.0.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0)
+  bundler (~> 1.0)
+  juwelier (~> 2.1.0)
+  rdoc (~> 3.12)
+  rspec (>= 2.0)
+  rubocop
+  simplecov (>= 0.11)
+
+BUNDLED WITH
+   1.10.3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Nicholas Babb
+
+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,62 @@
+# rspec-webservice-outputter
+
+Developing a JSON API in Rails? The rspec-webservice-outputter gem will print the JSON request/response data when running your rspec request specs. 
+
+There are some other tools for inspecting HTTP request/response data such as the Chrome DevTools or the Postman Chrome extension. This gem takes a different approach by providing a method to inspect the HTTP request/response from the command-line when running/debugging tests. 
+
+# Installation
+
+In your Rails Gemfile, add:
+
+```ruby
+group :test do
+  gem 'rspec-webservice-outputter'
+end
+```
+
+# Usage
+
+When running your request spec(s), set an environmental variable call WEBSERVICE:
+
+```
+WEBSERVICE=1 rspec path_to_your_spec.rb
+```
+
+The rspec example's output will look like:
+
+```
+REQUEST:
+POST /v1/some_url
+{
+  "some_field": 5,
+  "another_field": "2016-06-08"
+}
+
+RESPONSE (201):
+{
+  "id": 55,
+  "some_field": 5,
+  "another_field": "2016-06-08"
+  "created_at": "2016-06-09T01:35:41.709Z",
+  "updated_at": "2016-06-09T01:35:41.709Z"
+}
+```
+
+If your response body is empty (e.g. 204 No Content), you'll see:
+
+```
+RESPONSE (204):
+[Empty response body]
+```
+
+If your response body's JSON data can't be parsed, you'll see:
+
+```
+RESPONSE (200):
+[Non-JSON response body]
+```
+
+# Future Possibilities
+ - Explore ways of implementing as a rspec custom formatter instead of an after hook
+ - Or, toggle output via switch instead of env variable
+ - Support XML webservices

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "rspec-webservice-outputter"
+  gem.homepage = "http://github.com/ndbabb/rspec-webservice-outputter"
+  gem.license = "MIT"
+  gem.summary = "Outputs webservice request/response JSON data for rails rspec request specs"
+  #gem.description = "Outputs the webservice request/response JSON data of rspec functional specs"
+  gem.email = "ndbabb@gmail.com"
+  gem.authors = ["Nicholas Babb"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rspec-webservice-outputter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rspec_configuration.rb

@@ -0,0 +1,8 @@
+require 'rspec_webservice_outputter'
+
+RSpec.configure do |config|
+  config.after(:each) do
+    next unless ENV['WEBSERVICE'] && request
+    RspecWebServiceOutputter::Output.new(request, response).print
+  end
+end

data/lib/rspec_webservice_outputter.rb

@@ -0,0 +1,80 @@
+require 'active_support/core_ext/object/blank'
+require 'json'
+
+module RspecWebServiceOutputter
+  class Output
+    def initialize(action_dispatch_request, action_dispatch_response)
+      @action_dispatch_request = action_dispatch_request
+      @action_dispatch_response = action_dispatch_response
+    end
+
+    def print
+      puts self
+    end
+
+    def to_s
+      "\n#{request}\n\n#{response}\n\n"
+    end
+
+    private
+
+    def request
+      Request.new(@action_dispatch_request)
+    end
+
+    def response
+      Response.new(@action_dispatch_response)
+    end
+  end
+
+  class Request
+    def initialize(request)
+      @request = request
+    end
+
+    def to_s
+      "REQUEST:\n" +
+      "#{@request.method} #{@request.path}#{query_string}\n#{request_body}"
+    end
+
+    private
+
+    def query_string
+      "?#{@request.query_string}" if @request.query_string.present?
+    end
+
+    def request_body
+      if @request.body.read.present?
+        begin
+          JSON.pretty_generate(JSON.parse(@request.body.read))
+        rescue
+          "[Non-JSON request body]"
+        end
+      end
+    end
+  end
+
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def to_s
+      "RESPONSE (#{@response.code}):\n#{response_body}"
+    end
+
+    private
+
+    def response_body
+      if @response.body.present?
+        begin
+          JSON.pretty_generate(JSON.parse(@response.body))
+        rescue
+          "[Non-JSON response body]"
+        end
+      else
+        "[Empty response body]"
+      end
+    end
+  end
+end

data/spec/output_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe RspecWebServiceOutputter::Output do
+  context "to_s" do
+    it 'returns string with the request and response' do
+      request = double("request")
+      response = double("response")
+      outputter = RspecWebServiceOutputter::Output.new(request, response)
+      allow(outputter).to receive(:request).and_return("Request Output")
+      allow(outputter).to receive(:response).and_return("Response Output")
+      output = outputter.to_s.split("\n")
+      expect(output[0]).to eq("")
+      expect(output[1]).to eq("Request Output")
+      expect(output[2]).to eq("")
+      expect(output[3]).to eq("Response Output")
+    end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe RspecWebServiceOutputter::Request do
+  let(:request_with_body) do
+    body = double("body")
+    allow(body).to receive(:read).and_return('{"test": "test"}')
+    request = double("request")
+    allow(request).to receive(:method).and_return("POST")
+    allow(request).to receive(:path).and_return("/here-is-a-path")
+    allow(request).to receive(:query_string).and_return("key1=value1&key2=value2")
+    allow(request).to receive(:body).and_return(body)
+    return request
+  end
+  let(:request_empty_body) do
+    body = double("body")
+    allow(body).to receive(:read).and_return(nil)
+    request = double("request")
+    allow(request).to receive(:method).and_return("POST")
+    allow(request).to receive(:path).and_return("/here-is-a-path")
+    allow(request).to receive(:query_string).and_return("key1=value1&key2=value2")
+    allow(request).to receive(:body).and_return(body)
+    return request
+  end
+  let(:request_with_non_json) do
+    body = double("body")
+    allow(body).to receive(:read).and_return('some non-json text')
+    request = double("request")
+    allow(request).to receive(:method).and_return("POST")
+    allow(request).to receive(:path).and_return("/here-is-a-path")
+    allow(request).to receive(:query_string).and_return("key1=value1&key2=value2")
+    allow(request).to receive(:body).and_return(body)
+    return request
+  end
+  context "to_s" do
+    it 'returns string that starts with REQUEST:' do
+      output = RspecWebServiceOutputter::Request.new(request_empty_body).to_s.split("\n")
+      expect(output[0]).to eq("REQUEST:")
+    end
+    it 'returns string with request summary (method, path and query string)' do
+      output = RspecWebServiceOutputter::Request.new(request_empty_body).to_s.split("\n")
+      expect(output[1]).to eq("POST /here-is-a-path?key1=value1&key2=value2")
+    end
+    it 'returns string with request body when present' do
+      output = RspecWebServiceOutputter::Request.new(request_with_body).to_s.split("\n")
+      expect(output[2]).to eq("{")
+      expect(output[3]).to eq("  \"test\": \"test\"")
+      expect(output[4]).to eq("}")
+    end
+    it 'returns only the request summary when no request body' do
+      output = RspecWebServiceOutputter::Request.new(request_empty_body).to_s.split("\n")
+      expect(output[0]).to eq("REQUEST:")
+      expect(output[1]).to eq("POST /here-is-a-path?key1=value1&key2=value2")
+      expect(output.size).to eq(2)
+    end
+    it 'returns [Non-JSON request body] when non-empty non-JSON in body' do
+      output = RspecWebServiceOutputter::Request.new(request_with_non_json).to_s.split("\n")
+      expect(output[2]).to eq("[Non-JSON request body]")
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe RspecWebServiceOutputter::Response do
+  let(:response_with_body) do
+    response = double("response")
+    allow(response).to receive(:code).and_return("204")
+    allow(response).to receive(:body).and_return('{"test": "test"}')
+    return response
+  end
+  let(:response_empty_body) do
+    response = double("response")
+    allow(response).to receive(:code).and_return("204")
+    allow(response).to receive(:body).and_return(nil)
+    return response
+  end
+  let(:response_with_non_json) do
+    response = double("response")
+    allow(response).to receive(:code).and_return("204")
+    allow(response).to receive(:body).and_return("Some non-JSON text")
+    return response
+  end
+  context "to_s" do
+    it 'returns string that starts with RESPONSE([status_code]):' do
+      output = RspecWebServiceOutputter::Response.new(response_with_body).to_s.split("\n")
+      expect(output[0]).to eq("RESPONSE (204):")
+    end
+    it 'returns string with response body when present' do
+      output = RspecWebServiceOutputter::Response.new(response_with_body).to_s.split("\n")
+      expect(output[1]).to eq("{")
+      expect(output[2]).to eq("  \"test\": \"test\"")
+      expect(output[3]).to eq("}")
+    end
+    it 'returns [Empty response body] when no response body' do
+      output = RspecWebServiceOutputter::Response.new(response_empty_body).to_s.split("\n")
+      expect(output[1]).to eq("[Empty response body]")
+    end
+    it 'returns [Non-JSON response body] when non-empty non-JSON in body' do
+      output = RspecWebServiceOutputter::Response.new(response_with_non_json).to_s.split("\n")
+      expect(output[1]).to eq("[Non-JSON response body]")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << '../lib'
+require 'rspec_webservice_outputter'

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rspec-webservice-outputter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicholas Babb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: ndbabb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/rspec_configuration.rb
+- lib/rspec_webservice_outputter.rb
+- spec/output_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ndbabb/rspec-webservice-outputter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Outputs webservice request/response JSON data for rails rspec request specs
+test_files: []