vigia 0.1.4 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWJmOWE0NTllY2M5OWM1ODVlYzQwOTVhMmZjM2ExMTRmZDQ0NjA0ZA==
+    NDYwMThkZDk2ZDI3NDFhYzc5ZWUyNzQ4NzA0NmRjMjgyNmFjZGM4Nw==
   data.tar.gz: !binary |-
-    ZTg5ZDljZmVmODNiNDIxN2ZhNjIyN2NjODYwNDdjMmY1MmE3ZjRmOQ==
+    MDk2NWU5YTkyMTg0NzE2YzFiNmRlMDY2Yzg3NmNkMDU1NmFiNmJkOQ==
 SHA512:
   metadata.gz: !binary |-
-    NzA4ODNkYTIzODZmYTc0ODZmNDZjYWU3YTdmYmRkMzJiMjZhNzhmZWU0N2Q3
-    YjRmNGQyMGU1MmJjNTVjMWZhYzQyNDk5N2I1ZjU4N2E0MzBlYjM4ZWQ5Y2E2
-    Mjc0ZTFmOWMwNTRmYTUyYTUxNDRiNzA0NWEwMWE3Zjc0MTYyNjY=
+    ZjA0N2FmOTg2ODRiN2Y1Y2FiMzEwYzcyNDBkNGMwNzQ2ZWNhZmMwZjc4OWZl
+    MDNiYzU3MDE0MTQxMzNkNWFjNWY3NzhiYWQyNWVhZDhiMzllZDMzMDY3MWQ1
+    MzM0ZjJjNTgxYWU4ZWU5ODZlZTExYzFlZDdjZDFlZWYzYzQxODY=
   data.tar.gz: !binary |-
-    YWU1MDFjZjE3NWM0OTQ4MzFkNmZjODk1ZTQyN2E5MGYzODMwMzgxNjk3YmQz
-    ZGVmNjQwZmI1Mzg5NGQ3ZDYyNGIwZTcxODc4ZTA1ZjRkN2NiNzI5NDY2YzBh
-    MDcyZTNhN2RjNmFhZjM0NTU1NjQyOTM1ZTE3Y2U4MjIwMjZiMmI=
+    OWMyMDQyZTViMWNkZTMzZmM5OGRlM2E1OTk2MmUwYTI5ZGY0MjEwMzM1NTZj
+    NTQ1YjgxMTVmMTBiODk2YTM1YWUxNDIzNDRlNDNmMTljM2QwYWNlOWMwOTE2
+    NTc1YTVhZDcwMDMzNzM2NTI4MGY3YWI2OWYyYjIyZjgzODcxZjA=

data/Gemfile

@@ -4,4 +4,7 @@ source 'https://rubygems.org'
 gem 'redsnow', github: 'apiaryio/redsnow', submodules: true
 gem 'codeclimate-test-reporter', group: :test, require: nil
 
+# Pull raml from github
+gem 'raml_ruby', github: 'coub/raml_ruby'
+
 gemspec

data/README.md

@@ -9,7 +9,7 @@ Vigia
 
 <img src="http://singularities.org/vigia.png" width="96" height="96" class="right" alt="Vigia logo" />
 
-Vigia is a gem to perform integration tests using RSpec and a compatible adapter (See [Adapters](https://github.com/lonelyplanet/vigia/wiki/Adapters)). The adapter creates the structure of the test (groups and context) and sets up all the variables (See [Context variables](https://github.com/lonelyplanet/vigia/wiki/Context-variables)) used to perform the http request.
+Vigia is a gem to perform integration tests on an API server using RSpec and a compatible adapter (See [Adapters](https://github.com/lonelyplanet/vigia/wiki/Adapters)). The adapter creates the structure of the test (groups and context) and sets up all the variables (See [Context variables](https://github.com/lonelyplanet/vigia/wiki/Context-variables)) used to perform the http request.
 
 These results and expectations objects can be used to run examples that will compare the expected value with the server response value. Vigia allows to use a variety of different ways to execute these comparisons (See [Vigia Examples](https://github.com/lonelyplanet/vigia/wiki/Expectations---Examples) and [Custom Shared Examples](https://github.com/lonelyplanet/vigia/wiki/Shared-examples))
 

data/lib/vigia.rb

@@ -1,12 +1,14 @@
 # encoding: utf-8
 
 require 'redsnow'
+require 'raml'
 require 'rspec'
 require 'rest_client'
 require 'addressable/template'
 
 require_relative 'vigia/adapter'
 require_relative 'vigia/adapters/blueprint'
+require_relative 'vigia/adapters/raml'
 require_relative 'vigia/config'
 require_relative 'vigia/hooks'
 require_relative 'vigia/formatter'
@@ -17,6 +19,7 @@ require_relative 'vigia/parameters'
 require_relative 'vigia/rspec'
 require_relative 'vigia/sail/rspec_object'
 require_relative 'vigia/sail/example'
+require_relative 'vigia/sail/examples/default'
 require_relative 'vigia/sail/context'
 require_relative 'vigia/sail/group'
 require_relative 'vigia/sail/group_instance'
@@ -25,21 +28,39 @@ require_relative 'vigia/version'
 
 module Vigia
   class << self
-    def config
-      @config
-    end
+
+    attr_reader :config
+
     def configure
-      @config = Vigia::Config.new
-      yield @config
-      @config.apply
+      reset!
+      @config = Vigia::Config.new.tap do |_config|
+        yield _config
+        load_default_examples if _config.load_default_examples
+      end
     end
+
     def spec_folder
       File.join(__dir__, 'vigia', 'spec')
     end
+
     def rspec!
+      ensure_config
       Vigia::Rspec.new.run!
     end
+
+    def reset!
+      [ Vigia::Sail::Context, Vigia::Sail::Example, Vigia::Sail::Group ].map(&:clean!)
+      @config = nil
+    end
+
+    private
+
+    def load_default_examples
+      Vigia::Sail::Examples::Default.load!
+    end
+
+    def ensure_config
+      (config && config.validate!) || raise('Invalid config')
+    end
   end
 end
-
-require_relative 'vigia/sail/examples/default'

data/lib/vigia/adapters/raml.rb

@@ -0,0 +1,111 @@
+module Vigia
+  module Adapters
+    class Raml < Vigia::Adapter
+
+      attr_reader :raml
+
+      setup_adapter do
+
+        after_initialize do
+          @raml = ::Raml::parse_file(source_file)
+        end
+
+        group :resource,
+          primary:     true,
+          children:    [ :method ],
+          describes:   -> { adapter.raml.resources.values },
+          description: -> { "Resource: #{ resource.name }" },
+          recursion:   -> { resources.values }
+
+        group :method,
+          children:    [ :response ],
+          describes:   -> { resource.methods.values },
+          description: -> { "Method: #{ method.name }" }
+
+        group :response,
+          children:    [ :body ],
+          describes:   -> { method.responses.values },
+          description: -> { "Response: #{ response.name }" }
+
+        group :body,
+          contexts:    [ :default ],
+          describes:   -> { response.bodies.values },
+          description: -> { "Content type: #{ body.name }" }
+
+        context :default,
+          http_client_options: {
+            method:        -> { method.name },
+            uri_template:  -> { adapter.resource_uri_template(method) },
+            parameters:    -> { adapter.parameters_for(method) },
+            headers:       -> { adapter.request_headers(body) },
+            payload:       -> { adapter.payload_for(method, body) if adapter.with_payload?(method.name) }
+          },
+          expectations: {
+             code:    -> { response.name.to_i },
+             headers: -> { adapter.expected_headers(body) },
+             body:    -> { body.schema.value }
+          }
+      end
+
+      def resource_uri_template(method)
+        uri_template  = method.parent.resource_path
+        uri_template += query_parameters(method)
+      end
+
+      def parameters_for(method)
+        format_parameters(method.query_parameters) + format_parameters(method.parent.uri_parameters)
+      end
+
+      def request_headers(body)
+        method = body.parent.parent
+        compile_headers(method.headers).tap do |headers|
+          return unless with_payload?(method.name)
+          return if     request_body_for(method, body).name == '*/*'
+          headers.merge!(content_type: request_body_for(method, body).name)
+        end
+      end
+
+      def expected_headers(body)
+        compile_headers(body.parent.headers).tap do |headers|
+          # Dont add content_type header if response is 204 (nil response)
+          headers.merge!(content_type: body.media_type) unless body.parent.name == 204 or headers.key?(:content_type)
+        end
+      end
+
+      def payload_for(method, body)
+        return unless with_payload?(method.name)
+        request_body_for(method, body).schema.value
+      end
+
+      def with_payload?(method_name)
+        [ :post, :put, :patch ].include?(method_name.to_s.downcase.to_sym)
+      end
+
+      private
+
+      def format_parameters(raml_hash)
+        raml_hash.values.each_with_object([]) do |parameter, array|
+          array << { name: parameter.name, value: parameter.example, required: !parameter.optional }
+        end
+      end
+
+      def compile_headers(headers)
+        headers.each_with_object({}) do |(key, header), hash|
+          raise "Required header #{ key } does not have an example value" if header.example.nil? && !header.optional
+          hash.merge!(key.to_s.gsub('-', '_').downcase.to_sym => header.example)
+        end
+      end
+
+      def request_body_for(method, response_body)
+        body = response_body.name == '*/*' ? method.bodies.values.first : method.bodies[response_body.name]
+        body ||raise("An example body cannot be found for method #{ method.name } #{ method.parent.resource_path }")
+      end
+
+      def query_parameters(method)
+        method.apply_traits if method.traits.any? # Does this belong here RAML?
+        return '' if method.query_parameters.empty?
+        "{?#{ method.query_parameters.keys.join(',') }}"
+      end
+    end
+  end
+end

data/lib/vigia/config.rb

@@ -1,12 +1,13 @@
 module Vigia
   class Config
     attr_accessor :source_file, :host, :custom_examples_paths, :custom_examples, :headers, :http_client_class
-    attr_accessor :adapter, :hooks, :rspec_config_block, :stderr, :stdout, :internal_hosts
+    attr_accessor :adapter, :hooks, :rspec_config_block, :stderr, :stdout, :internal_hosts, :load_default_examples
 
     def initialize
       @host                  = nil
       @source_file           = nil
       @rspec_config_block    = nil
+      @load_default_examples = true
       @internal_hosts        = []
       @headers               = {}
       @custom_examples_paths = []
@@ -18,13 +19,10 @@ module Vigia
       @http_client_class     = Vigia::HttpClient::RestClient
     end
 
-    def apply
-      validate!
-    end
-
     def validate!
-      raise("You need to provide an source") unless source_file
       raise("You have to provide a host value in config or in the Apib") unless host
+
+      true
     end
 
     def add_custom_examples_on(filter, name)

data/lib/vigia/parameters.rb

@@ -27,7 +27,7 @@ module Vigia
     end
 
     def missing_parameters
-      required_parameters.select{ |k| k[:value].nil? || k[:value].empty? }.map{ |k| k[:name] }
+      required_parameters.select{ |k| k[:value].nil? || k[:value].to_s.empty? }.map{ |k| k[:name] }
     end
   end
 end

data/lib/vigia/rspec.rb

@@ -1,10 +1,6 @@
 module Vigia
   class Rspec
     class << self
-      def adapter
-        @@adapter
-      end
-
       def include_shared_folders
         require_custom_examples
         require "#{ __dir__ }/spec/support/utils"
@@ -35,6 +31,7 @@ module Vigia
 
     def set_global_memoizers(rspec)
       instance = adapter
+      self.class.define_singleton_method(:adapter) { instance }
       rspec.let(:client)  { Vigia.config.http_client_class.new(http_client_options) }
       rspec.let(:result)  { client.run }
       rspec.let(:result!) { client.run! }
@@ -42,7 +39,7 @@ module Vigia
     end
 
     def adapter
-      @@adapter ||= Vigia.config.adapter.instance
+      @adapter ||= Vigia.config.adapter.instance
     end
 
     private

data/lib/vigia/sail/examples/default.rb

@@ -1,17 +1,29 @@
- Vigia::Sail::Example.register(
-   :code_match,
-   description: 'has the expected HTTP code',
-   expectation: -> {
-     if expectations.code.is_a?(Range)
-       expect(expectations.code.member?(result.code)).to be true
-     else
-       expect(result.code).to be(expectations.code)
-     end
-   }
- )
+module Vigia
+  module Sail
+    module Examples
+      module Default
+        module_function
 
- Vigia::Sail::Example.register(
-   :include_headers,
-   description: 'includes the expected headers',
-   expectation: -> { expect(result.headers).to include(expectations.headers) }
- )
+        def load!
+          Vigia::Sail::Example.register(
+            :code_match,
+            description: 'has the expected HTTP code',
+            expectation: -> {
+              if expectations.code.is_a?(Range)
+                expect(expectations.code.member?(result.code)).to be true
+              else
+                expect(result.code).to be(expectations.code)
+              end
+            }
+          )
+
+          Vigia::Sail::Example.register(
+            :include_headers,
+            description: 'includes the expected headers',
+            expectation: -> { expect(result.headers).to include(expectations.headers) }
+          )
+        end
+      end
+    end
+  end
+end

data/lib/vigia/sail/group.rb

@@ -15,6 +15,8 @@ module Vigia
           rspec.describe group_instance do
             let(group_instance.group.name) { group_instance.described_object }
 
+            group_instance.group.include_recursion(group_instance.described_object, self)
+
             group_instance.run(self)
           end
         end
@@ -32,6 +34,16 @@ module Vigia
         contextual_object(option_name: :describes) || []
       end
 
+      def include_recursion(object, rspec_context)
+        describes = contextual_object(option_name: :recursion, context: object) || []
+        return if describes.empty?
+        
+        self.clone.tap do |recursive_group|
+          recursive_group.options[:describes] = describes
+          recursive_group.instance_variable_set('@rspec', rspec_context)
+        end.run
+      end
+
       def create_group_instance(object, index)
         instance_name = "#{ name }#{ index }"
         Vigia::Sail::GroupInstance.new(instance_name, options, rspec).tap do |instance|

data/lib/vigia/sail/group_instance.rb

@@ -15,7 +15,7 @@ module Vigia
           end
         end
       end
-
+      
       def to_s
         description.respond_to?(:call) ? instance_exec(&description) : description
       end

data/lib/vigia/sail/rspec_object.rb

@@ -16,6 +16,14 @@ module Vigia
           instance      = new(name, options, rspec)
           instance.run
         end
+
+        def clean!
+          @collection = {}
+        end
+
+        def inherited(subclass)
+          subclass.instance_variable_set('@collection', {})
+        end
       end
 
       include Vigia::Hooks

data/lib/vigia/url.rb

@@ -17,10 +17,8 @@ module Vigia
 
     attr_reader :uri_template
 
-    # ApiBluprint uses RFC6570 in all its resource's uri_templates
-    # https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md#1-uri-templates
-    def initialize(apib_uri_template)
-      @uri_template = Addressable::Template.new(apib_uri_template)
+    def initialize(template)
+      @uri_template = Addressable::Template.new(template)
     end
 
     def expand(parameters)

data/lib/vigia/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Vigia
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vigia
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - David Tapiador
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: raml_ruby
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,22 +205,23 @@ files:
 - Gemfile
 - lib/vigia/adapter.rb
 - lib/vigia/adapters/blueprint.rb
-- lib/vigia/config.rb
+- lib/vigia/adapters/raml.rb
 - lib/vigia/formatter.rb
 - lib/vigia/hooks.rb
 - lib/vigia/http_client/options.rb
 - lib/vigia/http_client/requests.rb
 - lib/vigia/http_client/rest_client.rb
-- lib/vigia/parameters.rb
-- lib/vigia/rspec.rb
-- lib/vigia/sail/context.rb
 - lib/vigia/sail/example.rb
 - lib/vigia/sail/examples/default.rb
+- lib/vigia/sail/context.rb
 - lib/vigia/sail/group.rb
 - lib/vigia/sail/group_instance.rb
 - lib/vigia/sail/rspec_object.rb
-- lib/vigia/spec/api_spec.rb
 - lib/vigia/spec/support/utils.rb
+- lib/vigia/spec/api_spec.rb
+- lib/vigia/rspec.rb
+- lib/vigia/config.rb
+- lib/vigia/parameters.rb
 - lib/vigia/url.rb
 - lib/vigia/version.rb
 - lib/vigia.rb