brine-dsl 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a3988772e5439b101fa2d3d9ab87034c04bb8a9
+  data.tar.gz: c1491585ad2734877fb636a0f0880b02960e9172
+SHA512:
+  metadata.gz: 72aa061fc15c4f629f74fc2ce37aa8c2818570591647dd33e8a7b0dde906f3daf735a2b22845210bb90636a3c04c2961e89b19b2cb463f198b8bd806779f8755
+  data.tar.gz: 8888baf7504c251f3011660bdb96eebb66f2f3abe3ae206b6418cc7d0f9d8048bcf1a2fd2ccdf84a22c9c016b2be6c01500419deffca8ab4341976f271f1a421

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/
+tmp
+.gradle
+*~

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+- 2.3
+- 2.4
+deploy:
+  provider: rubygems
+  gem: brine-dsl
+  api_key:
+    secure: QrX84AYqIs2Mz/5SaziW528tWzhx6pBZg93rwGWk8FyCjTZd2yILm+1O2BE/52JQclk/9lbJqzjJYsEirCC+5CmvddojiQCpX/ABeIbBq/DhNjomKf0L+tVglcZMbC/n3Xl6Xaa2kWv00mXxn71Ndj+uqCBq7oPXEZ6Z9Bf2x+Fz4+Mb0yN7tylCsQJ7WUR+EuMccXJ/eRIeVLlBqDtu7Ki534kKwOKWarkGvmvJMaXDRUSVm4dYkLDE+byoZTqu2LhcRcchCQauatDjMIv+NEhoVF9nvJPaFfSBnV64i+RwVIDemNgtSAGfZxmw6Jlf8ZWnlNDCvkXqN4dypqrlIiIZpeJpAZg0zj48sV6PNNNqr5xPgepTbNw8ShUHIQr9E8m9ePnyf1kg6FtkbnP0HYuabNw3XMIa7ZTzeCfKH6hwHFpBfNntZO9Ph6mhBsx3VkBq1RzjM3JKGOQqILsq3EZJdwRL5r+WWp8J6FtHWMfsHxQ5Fj4bAZPBYHKyamLEl14l/grnl+PussGT09DYkDInnmihprHw/5Pl/lOJk7OtmrNB2OrRlDt9spsua4P+sZdiQwqnG/p2UXQSeShQoYbm4pgqrbfKUF3Bye3uYhujXfCu2/vEN9ddv2UBKCCZA/iqZohmZbGZadeayBLLVvB/CTFzEI5z9ya0f8TDTzo=
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org' do
+  gemspec
+end

data/Gemfile.lock

@@ -0,0 +1,123 @@
+PATH
+  remote: .
+  specs:
+    brine-dsl (0.5.0)
+      cucumber (~> 2.4)
+      faraday
+      faraday_middleware
+      jsonpath
+      mustache
+      oauth2
+      rspec
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.14.2)
+      childprocess (~> 0.5.6)
+      contracts (~> 0.9)
+      cucumber (>= 1.3.19)
+      ffi (~> 1.9.10)
+      rspec-expectations (>= 2.99)
+      thor (~> 0.19)
+    asciidoctor (1.5.6.1)
+    builder (3.2.3)
+    childprocess (0.5.9)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    contracts (0.16.0)
+    cucumber (2.99.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 1.5.0)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 4.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (1.5.0)
+      gherkin (~> 4.0)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.9.18)
+    formatador (0.2.5)
+    gherkin (4.1.3)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-cucumber (2.1.2)
+      cucumber (~> 2.0)
+      guard-compat (~> 1.0)
+      nenv (~> 0.1)
+    jsonpath (0.8.10)
+      multi_json
+    jwt (1.5.6)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.12)
+    method_source (0.9.0)
+    multi_json (1.12.2)
+    multi_test (0.1.2)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    mustache (1.0.5)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.3)
+    rake (12.3.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba!
+  asciidoctor!
+  brine-dsl!
+  guard!
+  guard-cucumber!
+  rake!
+
+BUNDLED WITH
+   1.16.0

data/Guardfile

@@ -0,0 +1,12 @@
+guard 'cucumber',
+      all_after_pass: true,
+      all_on_start: true,
+      cmd_additional_args: '--profile guard',
+      keep_failed: true do
+
+  clearing = true
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^lib/.+$}) { "features" }
+  watch(%r{^features/step_definitions/.+$}) { "features" }
+  watch(%r{^features/support/.+$}) { "features" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Brightcove
+
+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,137 @@
+Brine
+===
+
+> Cucumber DSL for testing REST APIs
+
+Motivation
+---
+REpresentational State Transfer APIs expose their functionality
+through combinations of fairly coarse primitives that generally
+revolve around the use of transferring data in a standard exchange
+format (such as JSON) using HTTP methods and other aspects of the very
+simple HTTP protocol. Tests for such an API can therefore be defined
+using a domain specific language (DSL) built around those higher level
+ideas rather than requiring a general purpose language (the equivalent
+of scripted `curl` commands with some glue code and assertions).
+This project provides such a DSL by using select libraries
+integrated into Cucumber, where Cucumber provides a test-oriented
+framework for DSL creation.
+
+Sample Usage
+---
+The general usage pattern revolves around construction of a request
+and performing assertions against the received response.
+
+```gherkin
+When the request body is assigned:
+  """
+  {"first_name": "John",
+   "last_name": "Smith"}
+  """
+And a POST is sent to `/users`
+Then the value of the response status is equal to `200`
+And the value of the response body is including:
+  """
+  {"first_name": "John",
+   "last_name": "Smith"}
+  """
+```
+
+Disclaimer
+---
+Right now this project is new and features are being implemented as
+needed rather than speculatively. Some of the info here may be more
+optimistic than realistic until things are smoothed out or hopes abandoned.
+
+Features
+---
+
+### Variable Binding/Expansion
+
+In cases where dynamic data is in the response or is desired for the
+request, then values can be bound to identifiers which can then be
+expanded using [Mustache](mustache.github.io) templates in your
+feature files.
+
+### Type Transforms
+
+Different types of data can be expressed directly in the feature files
+or expanded into variables by using the appropriate syntax for that
+type.
+
+[Read More](https://github.com/brightcove/brine/wiki/Argument-Transforms)
+
+#### Type Coercion
+
+Related to transforms, a facility to coerce types is also provided. This allows
+more intelligent comparison of inputs which have been transformed to a 
+richer data type with those that have not been transformed (normally strings).
+As an example comparing a date/time value with a string will attempt to parse
+the string to a date/time so that the values can be compared using the proper semantics. 
+
+### Resource Cleanup
+
+Tests are likely to create resources which should then be cleaned up,
+restoring the pre-test state of the system: steps to facilitate this
+are provided.
+
+### Authentication
+
+Presently OAuth2 is supported to issue authenticated requests during a
+test (likely using a feature `Background`).
+
+### Division of Selection and Assertion
+
+To allow for a wider range of tests without an exploding code base
+(and keeping the assertions easier to write), Brine internall splits the
+selection of the value(s) to test from the assertion(s) that will be performed against it.
+
+[Read Mode](https://github.com/brightcove/brine/wiki/Selection-and-Assertion)
+
+### Request Construction and Response Assertion Step Definitions
+
+The previous features combined with the library of provide steps should
+cover all of the functionality needed to exercise and validate all of
+the functionality exposed by your REST API.
+
+
+Installation
+---
+
+Presently the gem for this project isn't being published anywhere:
+primarily because tracking down a local gem repository seems scary. If
+this project is open sourced then this will probably change but in the
+meantime the project can be used off of GitHub by adding this to your
+`Gemfile` and performing the usual `bundle install` dance:
+
+```ruby
+git 'git@github.com:brightcove/brine.git', :branch => 'master' do
+  gem 'brine'
+end
+```
+
+Specific branches and refs can be targetted as
+documented [here](http://bundler.io/git.html). This should likely be
+done in any cases where you're not actively tracking Brine and don't want
+your tests to suddenly break because of changes to it.
+
+Brine can then be "mixed in" to your project (which adds assorted
+modules to the `World` and loads all the step definitions and other
+Cucumber magic) by adding the following to your `support/env.rb` or
+other ruby file:
+
+```ruby
+require 'brine'
+
+World(brine_mix)
+```
+
+Select pieces can also be loaded (to be documented). With the above,
+feature files should be able to be written and executed without
+requiring any additional ruby code.
+
+Questions? Comments?
+---
+Check out the [wiki](https://github.com/brightcove/brine/wiki) for more information
+and search for related [issues](https://github.com/brightcove/brine/issues)
+or open one for anything not documented or implemented elsewhere.

data/Rakefile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new
+
+task default: %w[check]
+
+task :check do
+  ENV['ROOT_URL'] = 'http://www.example.com'
+  if (ENV['WATCH'])
+    Kernel.system("bundle exec guard -c")
+  else
+    Rake::Task['cucumber'].invoke
+  end
+end
+
+Cucumber::Rake::Task.new(:tutorial) do |t|
+  ENV['ROOT_URL'] = 'https://api.myjson.com/'
+  t.cucumber_opts = ['tutorial',
+    '-r tutorial/support/env.rb']
+end
+
+task :help do
+  puts """
+Tasks
+---
+check - run tests
+
+Environment Variables
+---
+WATCH - (guard) automatically rerun tests on file changes
+"""
+end

data/brine-dsl.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name         = 'brine-dsl'
+  s.version      = '0.5.0'
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ["Matt Whipple"]
+  s.email        = ["mwhipple@brightcove.com"]
+  s.license      = 'MIT'
+  s.homepage     = "http://github.com/brightcove/brine"
+  s.summary      = "Cucumber@REST in Brine"
+  s.description  = "Cucumber@REST in Brine"
+
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_runtime_dependency   'cucumber', '~> 2.4'
+  s.add_runtime_dependency   'mustache'
+  s.add_runtime_dependency   'oauth2'
+  s.add_runtime_dependency   'rspec'
+  s.add_runtime_dependency   'jsonpath'
+  s.add_runtime_dependency   'faraday'
+  s.add_runtime_dependency   'faraday_middleware'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'aruba'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-cucumber'
+  s.add_development_dependency 'asciidoctor'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+end

data/config/cucumber.yml

@@ -0,0 +1,2 @@
+debug: --format pretty --strict --backtrace
+guard: --format pretty --strict --backtrace

data/docs/build.gradle

@@ -0,0 +1,19 @@
+plugins {
+    id "org.asciidoctor.gradle.asciidoctor" version "1.5.1"
+}
+
+dependencies {
+    asciidoctor 'com.github.domgold.doctools.asciidoctor:asciidoctor-gherkin-extension:1.0.1'
+}
+
+asciidoctor {
+    separateOutputDirs = false
+    sourceDir 'src'
+    outputDir projectDir
+    attributes 'toc' : 'right',
+               'source-highlighter' : 'highlightjs',
+               'icons' : 'font',
+               'page-layout': 'docs',
+               'page-description': '{description}',
+               'page-keywords': '{keywords}'
+}