rspec-swagger 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 69120da3aba2240072d19dbf8ba8236e0bf79892
-  data.tar.gz: 253427f8a67826e42ae7aa67283cd1ecf5ce9a0c
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGNkZjA5NThmNjU0Yzg1ZDhjNWM4ODcyZjUyMTYwZmQyZDg3MDI4Zg==
+  data.tar.gz: !binary |-
+    ODI1NDBiNGY4M2Q1ZjlhZTdmYjAzMTZlMDljZGE1MjI0MTA5MWVkMQ==
 SHA512:
-  metadata.gz: 42d3e7de7b294c4578fccf786bd7da647da9998ad744784392755010c458b73547efee9a110d00158b0eaf60e7d43972e86fc0ec65b063dcf9dd19474b262d15
-  data.tar.gz: 8ce96e472366e11b7e8044b983754c28df39fee5a0efbdd01e21982c8c048b1b0f6b74e534e069dc27bdd98ea5585d2ccade6918594e7ca961cdd99750447f06
+  metadata.gz: !binary |-
+    Njg5NDE5YjI0NmQ2N2MzNjUwMDc4MjVlYjFkNDJlYjMzOTNhZTgyNTg5NWQy
+    YjdhNjA5ZDZlYmQ3MTc0OTI0OGNjMjk2Y2Y5YTMwNWRkZjQ2N2Q0NmI3ZjIz
+    YWQ1NTE1YzQ1ODU2YzRlOWUwN2Y1NDVlNDI1NGVkOWJjYmFkYWM=
+  data.tar.gz: !binary |-
+    OTUyNmUzNGQ1MzgzOTlmMzQxOWJjN2I2MzkwM2U1YTEwMTRlZWFmMmY3MzFk
+    MWE3OWJjNGU2ZDk2MDkxMzBlZDQ2MzEzNmIyYzQ3ZTNjMGUxNTVkMmQ1YjQx
+    MjFiODRmZjUzNGIzMjllNGMwMWQzOGNiNGYyNmQ2MWEzZWE3MDE=

data/Rakefile

@@ -1,2 +1,4 @@
 require "bundler/gem_tasks"
+require 'rspec/swagger/tasks'
 
+task default: ['rspec:swagger:install']

data/lib/rspec/swagger.rb

@@ -1,7 +1,13 @@
+require 'colorize'
+
+require "rspec/swagger/formatter"
+require "rspec/swagger/routes_with_no_required_params"
+require "rspec/swagger/routes_with_sample_values"
+require "rspec/swagger/swagger_loader"
+require "rspec/swagger/test_helpers"
 require "rspec/swagger/version"
 
 module Rspec
   module Swagger
-    # Your code goes here...
   end
 end

data/lib/rspec/swagger/formatter.rb

@@ -0,0 +1,35 @@
+module Rspec
+  module Swagger
+    class Formatter
+      def initialize(table_widths: [25, 40])
+        @table_widths = table_widths.freeze
+      end
+
+      # format()
+      #
+      # Set passed to true for green output, false for red. You can color
+      # any part of the left or right text by using <...> (which are invalid
+      # URL characters anyway, so shouldn't ever appear in the output
+      def format(passed: true, left_text: "", right_text: "")
+        if passed
+          str = "<.> "
+        else
+          str = "<F> "
+        end
+
+        str += sprintf("%#{@table_widths[0]}.#{@table_widths[0]}s | ", left_text)
+        str += sprintf("%-#{@table_widths[1]}.#{@table_widths[1]}s", right_text)
+
+        if passed
+          str = str.gsub(/\<(.*?)\>/) { |match| $1.green }
+          str = str.gsub(/\<(.*?)$/)  { |match| $1.green }
+        else
+          str = str.gsub(/\<(.*?)\>/) { |match| $1.red }
+          str = str.gsub(/\<(.*?)$/)  { |match| $1.red }
+        end
+
+        puts str
+      end
+    end
+  end
+end

data/lib/rspec/swagger/routes_with_no_required_params.rb

@@ -0,0 +1,37 @@
+module Rspec
+  module Swagger
+    module RoutesWithNoRequiredParams
+      def test_200_for_routes_with_no_required_parameters
+        @loader.documented_paths.each do |api|
+          unless api =~ /\{.*\}/
+            # see if the API returns a 200 code
+            begin
+              get api
+
+              @formatter.format passed:     last_response.status == 200,
+                                left_text:  api,
+                                right_text: "was <#{last_response.status}>"
+            rescue
+              @formatter.format passed:     false,
+                                left_text:  api,
+                                right_text: "<#{$!.message}>"
+            end
+
+            # see if the 200 response is documented
+            if operation = @loader.operation(:GET, api)
+              passed = false
+
+              operation["responseMessages"].each do |msg|
+                passed = true if msg["code"] == 200
+              end
+
+              @formatter.format passed:     passed,
+                                left_text:  api,
+                                right_text: "200 #{"<not> " unless passed}<documented>"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/swagger/routes_with_sample_values.rb

@@ -0,0 +1,64 @@
+module Rspec
+  module Swagger
+    module RoutesWithSampleValues
+      def test_sample_values_for_path_params_on_get_routes
+        @loader.documented_paths.each do |api|
+          if api =~ /\{.*\}/
+            if operation = @loader.operation(:GET, api)
+              ["200", "403", "404"].each do |code|
+                api_with_values = api.clone
+
+                operation["parameters"].each do |param|
+                  if sample_value = sample_value_from_param(param, code)
+                    api_with_values = api_with_values.gsub("{#{param['name']}}", sample_value)
+                  end
+                end
+
+                unless api_with_values.include?("{")
+                  begin
+                    get api_with_values
+
+                    @formatter.format passed:     last_response.status.to_i == code.to_i,
+                                      left_text:  api_with_values,
+                                      right_text: "was <#{last_response.status}>"
+
+                    @formatter.format passed:     last_response.status.to_i == code.to_i,
+                                      left_text:  api_with_values,
+                                      right_text: "#{code} <documented>"
+                  rescue
+                    @formatter.format passed:     false,
+                                      left_text:  api_with_values,
+                                      right_text: "<#{$!.message}>"
+
+                    @formatter.format passed:     false,
+                                      left_text:  api_with_values,
+                                      right_text: "#{code} <documented>"
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def sample_value_from_param(param, code)
+        has_sample_values_hash = param["sampleValues"].respond_to?(:has_key?) &&
+          param["sampleValues"].has_key?(code.to_s)
+
+        if has_sample_values_hash
+          if param["sampleValues"][code.to_s].respond_to?(:has_key?)
+            param["sampleValues"][code.to_s][environment]
+          else
+            param["sampleValues"][code.to_s]
+          end
+        end
+      end
+
+      def environment
+        ENV["ENVIRONMENT"] || "development"
+      end
+    end
+  end
+end

data/lib/rspec/swagger/swagger_loader.rb

@@ -0,0 +1,48 @@
+module Rspec
+  module Swagger
+    class SwaggerLoader
+      def initialize
+        @root = JSON.parse(File.read("docs/swagger.json"))
+
+        @resources = @root["apis"].map do |api|
+          path = "#{api['path']}.json"
+
+          if File.exists?("docs" + path)
+            JSON.parse(File.read("docs" + path))
+          else
+            raise "file not found: docs#{path}"
+          end
+        end
+
+        @root.freeze
+        @resources.freeze
+      end
+
+      attr_reader :root, :resources
+
+      # documented_paths()
+      #
+      # Get a list of routes that are documented. Returns an array of Strings.
+      def documented_paths
+        @documented_paths ||= begin
+          @resources.inject([]) { |memo, r| memo += r["apis"].map { |api| api["path"] } }
+        end
+      end
+
+      # operation()
+      #
+      # Get an operation by HTTP verb and path.
+      #
+      # Example: @loader.operation(:GET, "/foo")
+      def operation(verb, path)
+        @resources.each do |resource|
+          resource["apis"].each do |api|
+            api["operations"].each do |op|
+              return op if op["httpMethod"] == verb.to_s && path == api["path"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/swagger/tasks.rb

@@ -0,0 +1,26 @@
+namespace :rspec do
+  namespace :swagger do
+    task default: [:install]
+
+    templates_dir = Rake.application.original_dir + "/templates"
+
+    desc "Install rspec-swagger."
+    task install: ["docs", "docs/swagger.json", "docs/example_resource.json", "spec", "spec/swagger_spec.rb"]
+
+    directory "docs"
+
+    file "docs/swagger.json" do
+      cp File.expand_path("#{templates_dir}/swagger.json", __FILE__), "docs/swagger.json"
+    end
+
+    file "docs/example_resource.json" do
+      cp File.expand_path("#{templates_dir}/example_resource.json", __FILE__), "docs/example_resource.json"
+    end
+
+    directory "spec"
+
+    file "spec/swagger_spec.rb" do
+      cp File.expand_path("#{templates_dir}/swagger_spec.rb", __FILE__), "spec/swagger_spec.rb"
+    end
+  end
+end

data/lib/rspec/swagger/test_helpers.rb

@@ -0,0 +1,22 @@
+module Rspec
+  module Swagger
+    module TestHelpers
+      include RoutesWithNoRequiredParams
+      include RoutesWithSampleValues
+
+      # test_api_correctness()
+      #
+      # Tests the correctness of the Swagger-formatted docs stored
+      # in the docs/swagger.json and docs/*.json files. You can either
+      # run this method for all of the tests, or pick and choose from
+      # the tests referenced in this method.
+      def test_api_correctness
+        @loader = SwaggerLoader.new
+        @formatter = Formatter.new
+
+        test_200_for_routes_with_no_required_parameters
+        test_sample_values_for_path_params_on_get_routes
+      end
+    end
+  end
+end

data/lib/rspec/swagger/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module Swagger
-    VERSION = "0.0.1"
+    VERSION = "0.0.4"
   end
 end

data/rspec-swagger.gemspec

@@ -3,13 +3,16 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rspec/swagger/version'
 
+REQUIREMENT_LINE = "require 'rspec/swagger/tasks'\n"
+RAKEFILE = 'Rakefile'
+
 Gem::Specification.new do |spec|
   spec.name          = "rspec-swagger"
   spec.version       = Rspec::Swagger::VERSION
   spec.authors       = ["Colin Rymer"]
   spec.email         = ["colin.rymer@gmail.com"]
-  spec.summary       = %q{Generate Swagger docs from your specs.}
-  spec.description   = %q{Generate Swagger docs from your specs.}
+  spec.summary       = %q{Test Swagger-documented APIs automatically.}
+  spec.description   = %q{Test Swagger-documented APIs automatically.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -18,6 +21,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "colorize"
+
+  Gem.post_install do
+    if File.exists? RAKEFILE
+      original_file = File.read RAKEFILE
+      unless original_file.include?( REQUIREMENT_LINE )
+        File.write RAKEFILE, "#{REQUIREMENT_LINE}#{original_file}"
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "rspec/swagger"
+require "rspec"
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+# Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

data/templates/example_resource.json

@@ -0,0 +1,26 @@
+{
+  "apiVersion": "1",
+  "swaggerVersion": "1.2",
+  "basePath": "http://local.api.apartmentguide.com",
+  "resourcePath": "/example_resource",
+  "apis": [
+  {
+    "path": "/example_resource",
+    "description": "Example Resource",
+    "operations": [
+    {
+      "parameters": [],
+      "httpMethod": "GET",
+      "notes": null,
+      "embeds": [],
+      "scopes": [],
+      "errorResponses": [],
+      "summary": "Find example_resource",
+      "nickname": "index",
+      "responseClass": "string",
+      "responseTypeInternal": "string"
+    }
+    ]
+  }
+  ]
+}

data/templates/swagger.json

@@ -0,0 +1,18 @@
+{
+  "apiVersion": "1",
+  "swaggerVersion": "1.2",
+  "apis": [
+  {
+    "path": "/example_resource",
+    "description": "Operations about example_resource"
+  }
+  ],
+  "info": {
+    "title": "Swagger Sample App",
+    "description": "This is a sample server.  You can find out more about Swagger \n    at <a href=\"http://swagger.wordnik.com\">http://swagger.wordnik.com</a> or on irc.freenode.net, #swagger.  For this sample,\n    you can use the api key \"special-key\" to test the authorization filters",
+    "termsOfServiceUrl": "http://helloreverb.com/terms/",
+    "contact": "apiteam@wordnik.com",
+    "license": "Apache 2.0",
+    "licenseUrl": "http://www.apache.org/licenses/LICENSE-2.0.html"
+  }
+}

data/templates/swagger_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Rspec::Swagger do
+  include Rspec::Swagger::TestHelpers
+
+  it "should describe the api" do
+    test_api_correctness
+  end
+end

metadata

@@ -1,58 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: rspec-swagger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Colin Rymer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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'
-description: Generate Swagger docs from your specs.
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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'
+description: Test Swagger-documented APIs automatically.
 email:
 - colin.rymer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec/swagger.rb
+- lib/rspec/swagger/formatter.rb
+- lib/rspec/swagger/routes_with_no_required_params.rb
+- lib/rspec/swagger/routes_with_sample_values.rb
+- lib/rspec/swagger/swagger_loader.rb
+- lib/rspec/swagger/tasks.rb
+- lib/rspec/swagger/test_helpers.rb
 - lib/rspec/swagger/version.rb
 - rspec-swagger.gemspec
+- spec/spec_helper.rb
+- templates/example_resource.json
+- templates/swagger.json
+- templates/swagger_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -63,12 +101,12 @@ 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: []
@@ -76,5 +114,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Generate Swagger docs from your specs.
-test_files: []
+summary: Test Swagger-documented APIs automatically.
+test_files:
+- spec/spec_helper.rb