vigia 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MjZiMjEwOTE3OGMzMjM3NDFlMThmOTc3YTU5MjRjNTUwYjAxNGE2OQ==
+    MmE1ZDljN2M0MTU3NDI2NGE5ZTU2YjY4OTkyYWY1OTM4ZjgxMjQxOA==
   data.tar.gz: !binary |-
-    ODQ1M2U3ZTZmODNiMjJhMGIwMGZmYTM0NzZiYzRjOGQ3Zjk2M2MyZA==
+    YTM0ZWFlYzYwNDBhODhjOGExZjUyZGY1MDkyYmY3Y2E0M2RiOWM5MA==
 SHA512:
   metadata.gz: !binary |-
-    MDYyYzJjZDYxNDFjNzdkOTQyN2MwY2Y3YjI2YzI0MDZiYTc0Y2U5NzljZmE4
-    MjAwYTY1YzZmN2VkNDBlOWM0ODJkMGIzZTA4MjYwZTBjZmM1ZjI4ZjZjYjJl
-    ZDk4NmMxZWQzOWZiMmZiNTJlYzNjZWIyODFhMzUzNzNjMGNiNzM=
+    YzU4YjhiZTgyNTMzZTU3ZDU2ZmJmMzFiNDQyY2M3MWQ1NjFhN2ExZjU5NWY5
+    MWM3N2ViNmRjMzM3MDAzMGVkODE2MWFiYTY0NTAwNWM0NGRiNTVlM2E2Yzll
+    ZGY3NzdhNTI2ZTgzOWQwMzE3ODA2MzkzOTQ1YzExMzdlMmYzM2E=
   data.tar.gz: !binary |-
-    YWZmZGQ5NjJhN2ZkNTk2ZWM2YzhiOWMyMWQ0YWMyYjUwMjIxNTVkMzI2MTU0
-    M2IxZWYzYzZmYjA1NTQzMTQ2YmE3ZGM0ZmNkZDI4ZmNiYzVkOTc2ODZmNWE3
-    Njg0ZjcwZjkyYWZlZWM1NGRhYWJkMzBiMGM3OTUyMGYwNjYxNmI=
+    YmI2MTZlODQ1NjRmNGQ1YjdiYzFlOGFiOTI3OTE4Y2Y3ZDliZWU0OTZlZjEz
+    NWI1MGY0YzYyMDVkZmUwMGNkMDhiYjc4MDEwMGEwYTk4NDA0YWU2YmFiYThh
+    NDFlYTZjNzkxZmJlNmQxMzZkYzE3Y2FiZTI0M2Y1ZDExOWMyOWM=

data/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 # RedSnow needs to download its git submodules before compiling
-gem 'redsnow', '>= 0.1.3', github: 'apiaryio/redsnow', submodules: true
+gem 'redsnow', github: 'apiaryio/redsnow', submodules: true
 gem 'codeclimate-test-reporter', group: :test, require: nil
 
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 Vigia
 ========
 
-[![Build Status](https://travis-ci.org/nogates/vigia.svg?branch=master)](https://travis-ci.org/nogates/vigia)
+[![Build Status](https://travis-ci.org/lonelyplanet/vigia.svg?branch=master)](https://travis-ci.org/lonelyplanet/vigia)
 [![Code Climate](https://codeclimate.com/github/nogates/vigia/badges/gpa.svg)](https://codeclimate.com/github/nogates/vigia)
 [![Test Coverage](https://codeclimate.com/github/nogates/vigia/badges/coverage.svg)](https://codeclimate.com/github/nogates/vigia)
 
@@ -58,221 +58,3 @@ namespace :spec do
 end
 ```
 
-## Configuration
-
-Vigia tries to be flexible enough in case that you need to run custom operations during the tests.
-
-```ruby
-
-Vigia.configure do |config|
-
-  # Define your source file. For example, within a Rails app
-  config.source_file = "#{ Rails.root }/apibs/my_api.apib"
-
-  # Define the host address where the request will be performed.
-  config.host = 'http://localhost:3000'
-
-  # Include a collection of custom headers in all the requests.
-  config.headers = { authorization: 'Bearer <your hash here>' }
-
-  # Reset rspec_config and set up documentation formatter
-  config.rspec_config do |rspec_config|
-    rspec_config.reset
-    rspec_config.formatter = RSpec::Core::Formatters::DocumentationFormatter
-  end
-
-  # Attach a before_context hook to set up the database using Databasecleaner
-  config.before_context do
-    DatabaseCleaner.start
-  end
-
-  # Set a timer on the primary group and raise an exception if the
-  # described group takes more than 5 seconds to run
-  config.before_group do
-    let!(:group_started_at) { Time.now } if described_class.options[:primary]
-  end
-
-  config.after_group do
-    if described_class.options[:primary]
-      it 'has taken less than 5 seconds to run this example' do
-        expect(Time.now.to_i - group_started_at.to_i).to be < 5
-      end
-    end
-  end
-end
-
-Vigia.rspec!
-
-```
-For more information about config, see the `Vigia::Config` class.
-
-## Adapters
-
-By default, Vigia uses `Vigia::Adapters::Blueprint` adapter. This adapter takes an Api Blueprint compatible file and parses it using [RedSnow](https://github.com/apiaryio/redsnow). Then, it builds up the test structure accordingly.
-
-If needed, Vigia can be configured to use a custom adapter. To do so, you just need to specify the adapter class inside the vigia configuration block:
-
-```ruby
-Vigia.configure do |config|
-  config.adapter = MyBlogAdapter
-end
-```
-
-Then, insde your adapter class, you can use the `setup_adater` method to define the groups and contexts that the adapter will provide:
-
-```ruby
-
-# Post
-class MyBlogAdapter < Vigia::Adapter
-  setup_adapter do
-    group :resource,
-      primary: true,
-      contexts: [ :default ]
-      describes: [ :post, :pages ]
-
-    context :default,
-      http_client_options: {
-        url: -> { "/#{ resource }" },
-        method: :get
-        },
-      expectations: {
-        code: 200,
-        headers: {},
-        body: -> { adapter.body_for(resource) }
-      }
-  end
-
-  def body_for(resource)
-    case resource
-    when :post
-      # Your post index expected body
-    when :pages
-      # Your pages index expected body
-    else
-      'Unknown resource. WTH!'
-    end
-  end
-end
-```
-
-When vigia starts, it fetchs the first group defined as primary. For each group, Vigia will loop on each element of the describes option (`:post, :page` in this example), and will set a rspec memoized object named as the group (`let(:resource) { :post }`). Then, it will run the children (if any) and the contexts in this group, setting up the `http_client_options` and `expectations` memoized objects per context.
-
-See `Vigia::Adapters::Blueprint` class for more information about configuring and setting up an adapter.
-
-## Context Variables
-
-Vigia tries to be consistent with the way the RSpec are normally written. It creates the describe groups and context based on the adapter configuration and set up all the variables for the examples by using RSpec memoized objects.
-
-```ruby
-
-# With an adapter `ExampleAdapter` with this config
-#
-# group :resource,
-#   describes: [ :posts, :pages ],
-#   children:  [ :action ]
-#
-# group :action
-#   describes: [ :get, :post ],
-#   context:   [ :default ]
-#
-# context :default,
-#   http_client_options: {
-#     method:  -> { action.to_s.upcase }
-#     url:     -> { adapter.url_for(resource) }" }
-#     headers: :headers
-#   expectations:
-#     code: :code
-#     headers: {}
-#     body: -> { Body.for(resource} }
-#
-# Vigia will generate this RSpec code
-
-describe Vigia::RSpec do
-  let(:adapter) { ExampleAdapter.instance }
-  let(:client)  { Vigia.config.http_client_class.new(http_options) }
-  let(:result)  { client.run }
-
-  # the loop starts...
-  describe 'posts' do
-    let(:resource) { :posts }
-
-    describe 'action' do
-      let(:action) { :get }
-
-      context 'default' do
-        let(:http_client_options) { Vigia::HttpClient::Options.new(context_options) }
-        let(:expectations)        { Vigia::HttpClient::ExpectedRequest.new(expectations) }
-
-        # EXAMPLES RUN HERE!
-      end
-      # NEXT ACTION
-    end
-    # NEXT RESOURCE
-  end
-end
-```
-
-Also, It is important to mention that it is in this context where the adapter configuration will be executed. In the previous example, we configured the http_client option as follows:
-
-```ruby
-#   http_client_options: {
-#     method:  -> { action.to_s.upcase }
-#     url:     -> { adapter.url_for(resource) }" }
-#     headers: :headers
-```
-
-The option `method` is a lambda object. This object will be executed inside the RSpec memoized objects context. It is the same as doing:
-
-```ruby
-  # it has access to all context/group memoized objects
-  let(:method) { action.to_s.upcase }
-```
-
-You can also use the adapter like in option `url`, since it has been defined as a memoized object by Vigia::RSpec.
-
-Lastly, you can specify a symbol as the option value. In this case, the adapter will be the reciever of this method.
-
-## Vigia Examples
-
-The first way to include examples on vigia is using `register`. Option `disabled_if` can be used to prevent the example for being executed on different situations. `contexts` limits the example to the listed contexts.
-
-```ruby
-
-# On your config file, spec_helper, etc.
-Vigia::Sail::Example.register(
-  :my_custom_body_validator,
-  expectation: -> { expect { MyValidator(result.body) }.not.to raise_error } },
-  contexts:    [ :my_context ],  # default: :default
-  disable_if:  -> { ! result.headers[:content_type].include?('my_validator_mime') }
-  )
-```
-
-## Custom shared examples
-
-Vigia allows to include custom shared rspec examples in the test using some options in the config
-
-```ruby
-
-Vigia.configure do |config|
-  # Define where your examples are located
-  config.custom_examples_paths = [ '/my_project/shared_examples/apib_examples.rb' ]
-
-  # Define the custom examples you want to include in your test
-
-  # To the example in all your requests use `:all` symbol
-  config.add_custom_examples_on(:all, 'my custom examples')
-end
-```
-
-Then, create your Rspec shared example and name the examples accordingly
-
-```ruby
-# /my_project/shared_examples/apib_examples.rb
-
-shared_examples 'my custom examples' do
-  it 'is a valid json response' do
-    expect { JSON.parse(result.body) }.not_to raise_error
-  end
-end
-
-```

data/lib/vigia/adapters/blueprint.rb

@@ -92,8 +92,22 @@ module Vigia
         end
       end
 
+      def find_action(url, method)
+        resources_by_url(url).map(&:actions).flatten.select do|action|
+          action && (method.nil? || action.method.downcase == method.to_s.downcase)
+        end.first
+      end
+
       private
 
+
+      def resources_by_url(url)
+       apib_resources.select do |resource|
+          path = URI.parse(url).path
+          Vigia::Url.template_defines_url?(resource.uri_template, path)
+        end
+      end
+
       def locate_in_sourcemap(key, object)
         node_index  = apib_structure[key].index(object)
         source_node = apib_sourcemap[key][node_index]
@@ -132,6 +146,10 @@ module Vigia
         @apib_structure ||= build_structure(apib)
       end
 
+      def apib_resources
+        apib.resource_groups.map(&:resources).flatten
+      end
+
       def build_structure(start_point)
         {}.tap do |hash|
           hash[:resource_groups] = start_point.resource_groups

data/lib/vigia/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vigia
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Tapiador
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -189,25 +189,25 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - Gemfile
+- lib/vigia/adapter.rb
+- lib/vigia/adapters/blueprint.rb
+- lib/vigia/config.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/http_client/options.rb
-- lib/vigia/spec/support/utils.rb
-- lib/vigia/spec/api_spec.rb
-- lib/vigia/adapters/blueprint.rb
 - lib/vigia/parameters.rb
-- lib/vigia/sail/group.rb
-- lib/vigia/sail/group_instance.rb
-- lib/vigia/sail/examples/default.rb
+- lib/vigia/rspec.rb
 - lib/vigia/sail/context.rb
 - lib/vigia/sail/example.rb
+- lib/vigia/sail/examples/default.rb
+- lib/vigia/sail/group.rb
+- lib/vigia/sail/group_instance.rb
 - lib/vigia/sail/rspec_object.rb
-- lib/vigia/adapter.rb
-- lib/vigia/config.rb
+- lib/vigia/spec/api_spec.rb
+- lib/vigia/spec/support/utils.rb
 - lib/vigia/url.rb
-- lib/vigia/formatter.rb
-- lib/vigia/hooks.rb
-- lib/vigia/rspec.rb
 - lib/vigia/version.rb
 - lib/vigia.rb
 - README.md