brine-dsl 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7db0f76807447d42f0c27abd45d3d84186e9f97c
-  data.tar.gz: c3b1401a78f633130aa43fe1aaaf5aba984432c0
+  metadata.gz: 90f218b8154747a97c408360872b4dd8ba4a3be9
+  data.tar.gz: cd5eefa092fd1177ee60feb2960c234f29c079b1
 SHA512:
-  metadata.gz: 2b7491ea425579bf0ef8d3130923cb24605da121c2c8620a247446c3a16a143fe8611fd850d09f19f91dc67efc1d097d7a918c8638ead49bbe269a130ba41487
-  data.tar.gz: b36c2ababc702d919e1aa34415d2523c8e365b058c94746ce1ec729d8099bf2f9e2691d3970738786ea705462127f1be1e58dd94a5d1b75fb1525eeac176a4f4
+  metadata.gz: 182d3f8d311d2fa0b3c9dda73e6538de268492d1b0610b1f4cd826402e949f8d55d85e52216cedd3e1673e6ecc599aefb4b16e2a017070b000b59178ea4c5d82
+  data.tar.gz: 1645d45e940081720a945904248cb647e5296a032e01b04ded450e8b6612cb0c8060d4f68ec2966ca8c661ef2c5078cb24a8c69b4f6384993b431ecc1b88d025

data/.ruby-gemset

@@ -0,0 +1 @@
+brine

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brine-dsl (0.8.0)
+    brine-dsl (0.9.0)
       cucumber (~> 2.4)
       faraday (~> 0.12)
       faraday_middleware (~> 0.12)
@@ -13,19 +13,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    aruba (0.14.5)
-      childprocess (>= 0.6.3, < 0.10.0)
-      contracts (~> 0.9)
-      cucumber (>= 1.3.19)
-      ffi (~> 1.9.10)
-      rspec-expectations (>= 2.99)
-      thor (~> 0.19)
-    asciidoctor (1.5.6.2)
     builder (3.2.3)
-    childprocess (0.9.0)
-      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)
@@ -38,88 +26,49 @@ GEM
       gherkin (~> 4.0)
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
-    faraday (0.12.2)
+    faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.12.2)
+    faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.23)
-    formatador (0.2.5)
     gherkin (4.1.3)
-    guard (2.14.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.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.9.0)
+    jsonpath (0.9.9)
       multi_json
       to_regexp (~> 0.2.1)
-    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.13)
-    method_source (0.9.0)
+    jwt (2.2.1)
     multi_json (1.13.1)
     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)
+    multipart-post (2.1.1)
+    mustache (1.1.0)
+    oauth2 (1.4.1)
+      faraday (>= 0.8, < 0.16.0)
+      jwt (>= 1.0, < 3.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.5)
-    rake (12.3.1)
-    rb-fsevent (0.10.3)
-    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.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rack (2.0.7)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    thor (0.20.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     to_regexp (0.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0.14)!
-  asciidoctor (~> 1.5)!
   brine-dsl!
-  guard (~> 2.14)!
-  guard-cucumber (~> 2.1)!
   rake (~> 12.3)!
 
 BUNDLED WITH
-   1.16.1
+   2.0.1

data/Rakefile

@@ -2,35 +2,11 @@
 require 'bundler'
 require 'cucumber/rake/task'
 
-Cucumber::Rake::Task.new
-Bundler::GemHelper.install_tasks
-
-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
+ Cucumber::Rake::Task.new(:check) do |t|
+  # Cucumber needs some help to deal with the features and support being split.
+  t.libs = "#{__dir__}"
 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
+Bundler::GemHelper.install_tasks
 
-Environment Variables
----
-WATCH - (guard) automatically rerun tests on file changes
-FEATURE - path to specific cucumber feature to run
-"""
-end
+task default: %w[check]

data/brine-dsl.gemspec

@@ -1,7 +1,9 @@
 # -*- encoding: utf-8 -*-
+raise 'VERSION must be specified in environment' unless ENV['VERSION']
 Gem::Specification.new do |s|
   s.name         = 'brine-dsl'
-  s.version      = '0.8.1'
+  s.version      = '0.9.0'
+#  s.version      = ENV['VERSION']
   s.platform     = Gem::Platform::RUBY
   s.authors      = ["Matt Whipple"]
   s.email        = ["mwhipple@brightcove.com"]
@@ -21,10 +23,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency     'faraday_middleware', '~> 0.12'
 
   s.add_development_dependency 'rake',               '~> 12.3'
-  s.add_development_dependency 'aruba',              '~> 0.14'
-  s.add_development_dependency 'guard',              '~> 2.14'
-  s.add_development_dependency 'guard-cucumber',     '~> 2.1'
-  s.add_development_dependency 'asciidoctor',        '~> 1.5'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/feature_setup.rb

@@ -0,0 +1,17 @@
+##
+# @file feature_setup.rb
+# Support needed to run Brine features.
+#
+# The Brine `features` directory is runtime-agnostic, so any
+# provided runtime needs to configure itself to be able to
+# execute the provided specs (docs to come).
+# This file does that work for the ruby runtime.
+#
+# It is left at the top level to keep it slightly more isolated
+# from the rest of the code and as a minor convenience for
+# referencing the file from the top-level build.
+##
+
+require 'brine'
+require 'brine/test_steps'
+World(brine_mix)

data/lib/brine/requester.rb

@@ -1,10 +1,35 @@
-# requester.rb - Provide request construction and response storage
+##
+# @file requester.rb
+# Request construction and response storage
+##
 
 require 'oauth2'
 require 'faraday_middleware'
+require 'brine/util'
+
+##
+# The root url to which Brine will send requests.
+#
+# This will normally be the value of ENV['BRINE_ROOT_URL'],
+# and that value should be directly usable after older
+# ENV['ROOT_URL'] is end-of-lifed (at which point this can be removed.
+#
+# @return [String] The root URL to use or nil if none is provided.
+##
+def brine_root_url
+  if ENV['BRINE_ROOT_URL']
+    ENV['BRINE_ROOT_URL']
+  elsif ENV['ROOT_URL']
+    deprecation_message('1.0', 'ROOT_URL is deprecated, replace with BRINE_ROOT_URL') if ENV['ROOT_URL']
+    ENV['ROOT_URL']
+  end
+end
 
+##
 # Parameter object used to configure OAuth2 middleware
+#
 # Also used to provide basic DSL for configuration
+##
 class OAuth2Params
   attr_accessor :token, :token_type
 
@@ -85,7 +110,7 @@ module Requesting
   # return Faraday client object so that it could be used directly
   # or passed to another object
   def client
-    @client ||= client_for_host((ENV['ROOT_URL'] || 'http://localhost:8080'),
+    @client ||= client_for_host(brine_root_url || 'http://localhost:8080',
                                 logging: ENV['BRINE_LOG_HTTP'])
   end
 

data/lib/brine/step_definitions/request_construction.rb

@@ -12,6 +12,11 @@ When(/^the request header `([^`]*)` is assigned `([^`]*)`$/) do |header, value|
   add_header(header, value)
 end
 
+When(/^the request credentials are set for basic auth user `([^`]*)` and password `([^`]*)`$/) do |user, password|
+  base64_combined = Base64.strict_encode64("#{user}:#{password}")
+  add_header('Authorization', "Basic #{base64_combined}")
+end
+
 When(/^an? (GET|POST|PATCH|PUT|DELETE|HEAD|OPTIONS) is sent to `([^`]*)`$/) do |method, url|
   send_request(parse_method(method), URI.escape(url))
   bind('response', response)

data/lib/brine/test_steps.rb

@@ -6,11 +6,12 @@ require 'rspec'
 HTTP_METHOD='GET|POST|PATCH|PUT|DELETE|HEAD|OPTIONS'
 
 class StubResponse
-  attr_accessor :body, :status
+  attr_accessor :body, :status, :headers
 
   def initialize
     @body = ''
     @status = 200
+    @headers = {}
   end
 end
 
@@ -81,7 +82,7 @@ end
 
 Before do
   $stubs = Faraday::Adapter::Test::Stubs.new
-  @client = Faraday.new(url: ENV['ROOT_URL'] ||
+  @client = Faraday.new(url: brine_root_url ||
                         'http://localhost:8080') do |conn|
     conn.response :logger, nil
     conn.adapter :test, $stubs
@@ -115,6 +116,11 @@ When(/^the response body is assigned:$/) do |input|
     @response.body = input
 end
 
+When(/^the response headers is assigned `([^`]*)`$/) do |input|
+    @response ||= StubResponse.new
+    @response.headers = input
+end
+
 When(/^the response body is assigned `([^`]*)`/) do |input|
     @response ||= StubResponse.new
     @response.body = input

data/lib/brine/type_checks.rb

@@ -15,6 +15,7 @@ class TypeChecks
       Number: be_a_kind_of(Numeric),
       Integer: be_a_kind_of(Integer),
       Array: be_a_kind_of(Array),
+      DateTime: be_a_kind_of(Time),
       Boolean: satisfy{|it| it == true || it == false }
     }
   end
@@ -32,4 +33,4 @@ module TypeChecking
   def type_check_for(type)
     type_checks.for_type(type)
   end
-end
+end

data/lib/brine/util.rb

@@ -28,8 +28,18 @@ module BrineUtil
 end
 
 def replaced_with(type, new_step, version, multiline=nil)
-  warn """
-DEPRECATION: This step will be removed in version #{version}. Replace with:
-#{type} #{new_step}\n#{multiline}""" unless ENV['BRINE_QUIET_DEPRECATIONS']
+  deprecation_message(version, "Replace with: #{type} #{new_step}\n#{multiline}")
   step new_step, multiline
 end
+
+##
+# Output a deprecation message with contents `msg`
+#
+# Nothing will be output if BRINE_QUIET_DEPRECATIONS is set.
+#
+# @param version [String] Version at which this feature will be removed.
+# @param message [String] The message to log.
+##
+def deprecation_message(version, message)
+  warn "DEPRECATION - Removal planned for #{version}: #{message}" unless ENV['BRINE_QUIET_DEPRECATIONS']
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brine-dsl
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Matt Whipple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-08 00:00:00.000000000 Z
+date: 2019-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -122,62 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-- !ruby/object:Gem::Dependency
-  name: guard-cucumber
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: asciidoctor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 description: Cucumber@REST in Brine
 email:
 - mwhipple@brightcove.com
@@ -185,62 +129,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
-- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- Guardfile
-- LICENSE
-- README.adoc
 - Rakefile
 - brine-dsl.gemspec
-- config/cucumber.yml
-- docs/build.gradle
-- docs/cookbook.html
-- docs/gradle/wrapper/gradle-wrapper.jar
-- docs/gradle/wrapper/gradle-wrapper.properties
-- docs/gradlew
-- docs/gradlew.bat
-- docs/guide.html
-- docs/index.html
-- docs/specs.html
-- docs/src/cookbook.adoc
-- docs/src/guide.adoc
-- docs/src/index.adoc
-- docs/src/spec.erb
-- docs/src/specs.adoc
-- features/argument_transforms/boolean.feature
-- features/argument_transforms/datetime.feature
-- features/argument_transforms/integer.feature
-- features/argument_transforms/list.feature
-- features/argument_transforms/object.feature
-- features/argument_transforms/quoted.feature
-- features/argument_transforms/regex.feature
-- features/argument_transforms/template.feature
-- features/argument_transforms/whitespace.feature
-- features/assertions/is_a_valid.feature
-- features/assertions/is_empty.feature
-- features/assertions/is_equal_to.feature
-- features/assertions/is_including.feature
-- features/assertions/is_matching.feature
-- features/assertions/is_of_length.feature
-- features/assignment/parameter.feature
-- features/assignment/random.feature
-- features/assignment/response_attribute.feature
-- features/assignment/timestamp.feature
-- features/deprecations/replaced_with.feature
-- features/request_construction/basic.feature
-- features/request_construction/body.feature
-- features/request_construction/clearing.feature
-- features/request_construction/headers.feature
-- features/request_construction/params.feature
-- features/resource_cleanup/cleanup.feature
-- features/selectors/all.feature
-- features/selectors/any.feature
-- features/step_definitions/test_steps.rb
-- features/support/env.rb
+- feature_setup.rb
 - lib/brine.rb
 - lib/brine/cleaner_upper.rb
 - lib/brine/coercer.rb
@@ -258,10 +153,6 @@ files:
 - lib/brine/transforms.rb
 - lib/brine/type_checks.rb
 - lib/brine/util.rb
-- tutorial/missing.feature
-- tutorial/post_matching.feature
-- tutorial/post_status.feature
-- tutorial/support/env.rb
 homepage: http://github.com/brightcove/brine
 licenses:
 - MIT
@@ -282,38 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Cucumber@REST in Brine
-test_files:
-- features/argument_transforms/boolean.feature
-- features/argument_transforms/datetime.feature
-- features/argument_transforms/integer.feature
-- features/argument_transforms/list.feature
-- features/argument_transforms/object.feature
-- features/argument_transforms/quoted.feature
-- features/argument_transforms/regex.feature
-- features/argument_transforms/template.feature
-- features/argument_transforms/whitespace.feature
-- features/assertions/is_a_valid.feature
-- features/assertions/is_empty.feature
-- features/assertions/is_equal_to.feature
-- features/assertions/is_including.feature
-- features/assertions/is_matching.feature
-- features/assertions/is_of_length.feature
-- features/assignment/parameter.feature
-- features/assignment/random.feature
-- features/assignment/response_attribute.feature
-- features/assignment/timestamp.feature
-- features/deprecations/replaced_with.feature
-- features/request_construction/basic.feature
-- features/request_construction/body.feature
-- features/request_construction/clearing.feature
-- features/request_construction/headers.feature
-- features/request_construction/params.feature
-- features/resource_cleanup/cleanup.feature
-- features/selectors/all.feature
-- features/selectors/any.feature
-- features/step_definitions/test_steps.rb
-- features/support/env.rb
+test_files: []