apivore 0.0.2

data/lib/apivore.rb

@@ -0,0 +1,48 @@
+require 'apivore/rspec_builder'
+require 'apivore/rspec_matchers'
+
+module Apivore
+  class Swagger < Hashie::Mash
+
+    def validate
+      case version
+      when '2.0'
+        schema = File.read(File.expand_path("../../data/swagger_2.0_schema.json", __FILE__))
+      else
+        raise "Unknown/unsupported Swagger version to validate against: #{version}"
+      end
+      JSON::Validator.fully_validate(schema, self)
+    end
+
+    def version
+      swagger
+    end
+
+    def base_path
+      self['basePath'] || ''
+    end
+
+    def each_response(&block)
+      paths.each do |path, path_data|
+        path_data.each do |verb, method_data|
+          raise "No responses found in swagger for path '#{path}', method #{verb}: #{method_data.inspect}" if method_data.responses.nil?
+          method_data.responses.each do |response_code, response_data|
+            schema_location = nil
+            if response_data.schema
+              schema_location = Fragment.new ['#', 'paths', path, verb, 'responses', response_code, 'schema']
+            end
+            block.call(path, verb, response_code, schema_location)
+          end
+        end
+      end
+    end
+  end
+
+  # This is a workaround for json-schema's fragment validation which does not allow paths to contain forward slashes
+  #  current json-schema attempts to split('/') on a string path to produce an array.
+  class Fragment < Array
+    def split(options = nil)
+      self
+    end
+  end
+end

data/lib/apivore/rspec_builder.rb

@@ -0,0 +1,114 @@
+require 'apivore/rspec_matchers'
+require 'action_controller'
+require 'action_dispatch'
+require 'rspec/mocks'
+require 'hashie'
+
+module Apivore
+  module RspecBuilder
+    include Apivore::RspecMatchers
+    include ActionDispatch::Integration
+    include RSpec::Mocks::ExampleMethods
+
+    @@setups ||= {}
+
+    @@master_swagger_uri = nil
+
+    # Setup tests against a combination of path, method, and response.
+    # - *keys -> A combination of path, method, and/or response. Blank '' for base setup.
+    # - &block -> Code block to execute to setup the test. A hash of path subsitution parameters can be returned if required.
+    # All matching code blocks are executed, and substitution parameters are merged in order of specificity.
+    def apivore_setup(*keys, &block)
+      @@setups[keys.join] = block
+    end
+
+    def get_apivore_setup(path, method, response)
+      keys_to_search = [
+        '', # base setup key
+        response,
+        method,
+        path,
+        method + response,
+        path + response,
+        path + method,
+        path + method + response
+      ]
+      final_result = {}
+      keys_to_search.each do |k|
+        setup = @@setups[k]
+        if setup
+          result = instance_eval &setup
+          final_result.merge!(result) if result.is_a?(Hash)
+        end
+      end
+      final_result
+    end
+
+    def apivore_build_path(path, data)
+      path.scan(/\{([^\}]*)\}/).each do |param|
+        key = param.first
+        if data && data[key]
+          path = path.gsub "{#{key}}", data[key].to_s
+        else
+          raise URI::InvalidURIError, "No substitution data found for {#{key}} to test the path #{path}.\nAdd it via an:\n  apivore_setup '<path>', '<method>', '<response>' do\n    { '#{key}' => <value> }\n  end\nblock in your specs.", caller
+        end
+      end
+      path + (data['_query_string'] ? "?#{data['_query_string']}" : '')
+    end
+
+    def apivore_check_consistency_with_swagger_at(uri, current_service = nil)
+      @@current_service = current_service
+      @@master_swagger_uri = uri
+    end
+
+    def apivore_swagger(swagger_path)
+      session = ActionDispatch::Integration::Session.new(Rails.application)
+      begin
+        session.get swagger_path
+      rescue
+        # TODO: make this fail inside rspec test execution rather than immediately raise an exception.
+        # ALSO, handle other scenarios where we can't get a response to generate tests, e.g 500s, invalid formats etc
+        raise "Unable to perform GET request for swagger json: #{swagger_path} - #{$!}."
+      end
+      Apivore::Swagger.new JSON.parse(session.response.body)
+    end
+
+    def validate(swagger_path)
+
+      describe "swagger documentation" do
+        before { get swagger_path }
+        subject { body }
+        it { should be_valid_swagger }
+        it { should have_models_for_all_get_endpoints }
+        if @@master_swagger_uri
+          req = Net::HTTP.get(@@master_swagger_uri, "/swagger.json")
+          master_swagger = JSON.parse(req)
+          it { should be_consistent_with_swagger_definitions master_swagger, @@current_service }
+        end
+      end
+
+      swagger = apivore_swagger(swagger_path)
+      swagger.each_response do |path, method, response_code, fragment|
+        describe "path #{path} method #{method} response #{response_code}" do
+          it "responds with the specified models" do
+            setup_data = get_apivore_setup(path, method, response_code)
+            full_path = apivore_build_path(swagger.base_path + path, setup_data)
+            # e.g., get(full_path)
+            begin
+              send(method, full_path, setup_data['_data'] || {}, setup_data['_headers'] || {})
+            rescue
+              raise "Unable to #{method} #{full_path} -- invalid response from server: #{$!}."
+            end
+            expect(response).to have_http_status(response_code), "expected #{response_code} array, got #{response.status}: #{response.body}"
+
+            if fragment
+              expect(response.body).to conform_to_the_documented_model_for(swagger, fragment)
+            end
+
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/apivore/rspec_matchers.rb

@@ -0,0 +1,79 @@
+require 'json-schema'
+require 'rspec/expectations'
+require 'net/http'
+
+module Apivore
+  module RspecMatchers
+    extend RSpec::Matchers::DSL
+    matcher :be_valid_swagger do |version|
+      match do |body|
+        @api_description = Swagger.new(JSON.parse(body))
+        @errors = @api_description.validate
+        @errors.empty?
+      end
+
+      failure_message do |body|
+        msg = "The document fails to validate as Swagger #{@api_description.version}:\n"
+        msg += @errors.join("\n")
+      end
+    end
+
+    matcher :have_models_for_all_get_endpoints do
+      match do |body|
+        @errors = []
+        swagger = Swagger.new(JSON.parse(body))
+        swagger.each_response do |path, method, response_code, schema|
+          if method == 'get' && !schema
+            @errors << "Unable to find a valid model for #{path} get #{response_code} response."
+          end
+        end
+        @errors.empty?
+      end
+
+      failure_message do
+        @errors.join("\n")
+      end
+    end
+
+    matcher :be_consistent_with_swagger_definitions do |master_swagger, current_service|
+
+      attr_reader :actual, :expected
+
+      def cleaned_definitions(definitions, current_service)
+        definitions.each do |key, definition_fields|
+          # We ignore definitions that are owned exclusively by the current_service
+          if [current_service] == definition_fields['x-services']
+            definitions[key] = nil
+          else
+            # 'x-services' is added by api.westfield.io when aggregating swagger docs
+            # Individual services will not have a 'x-services' property so we need to remove it to allow the comparison to pass
+            definitions[key] = definition_fields.except 'x-services'
+          end
+        end.select{ |_, value| !value.nil? }
+      end
+
+      match do |body|
+        our_swagger = JSON.parse(body)
+        master_definitions = cleaned_definitions(master_swagger["definitions"], current_service)
+        our_definitions = our_swagger["definitions"]
+        @actual = our_definitions.slice(*master_definitions.keys)
+        @expected = master_definitions.slice(*our_definitions.keys)
+        @actual == @expected
+      end
+
+      diffable
+    end
+
+    matcher :conform_to_the_documented_model_for do |swagger, fragment|
+      match do |body|
+        body = JSON.parse(body)
+        @errors = JSON::Validator.fully_validate(swagger, body, fragment: fragment)
+        @errors.empty?
+      end
+
+      failure_message do |body|
+        @errors.map { |e| e.sub("'#", "'#{path}#").gsub(/^The property|in schema.*$/,'') }.join("\n")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: apivore
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Charles Horn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rake
+  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: 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: rspec-rails
+  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: activesupport
+  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: test-unit
+  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: Automatically tests your API using its Swagger description of end-points,
+  models, and query parameters.
+email: charles.horn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- data/swagger_2.0_schema.json
+- lib/apivore.rb
+- lib/apivore/rspec_builder.rb
+- lib/apivore/rspec_matchers.rb
+homepage: http://github.com/westfieldlabs/apivore
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: Automatically tests your API using its Swagger description of end-points,
+  models, and query parameters.
+test_files: []
+has_rdoc: