blueprint_agreement 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a1e036ac9271954e3c96329a28c2d4c86cb747
-  data.tar.gz: 910db3562b5e51afd8afda394510bcb4b42ec0b7
+  metadata.gz: 28677ec795e7e0c8645db0290a6baf0295a9ba14
+  data.tar.gz: acf526bdeb96bec01eae55362e5487f6a95155d9
 SHA512:
-  metadata.gz: 992d8e4b3b696bc0b3ddf582b0c21b8a1305aa54a99d58c45961c2f8c3881b9ba532515e2a0a0b38fb9afe4fcd1af08f145a593649c78ee3d3e4b0fac511c286
-  data.tar.gz: 828c36905e2a2e3901cdcf58770bf902162c9679fec3303c7248c3291d7945996de51172cfd3c5cc5abe93599227fa5ded28811e32f0531875e79e1e5116db13
+  metadata.gz: 83bf1f60ded145fe3862cba1770397cd308bb363c51d7eb1c7142a39efc9df05a845c40ea7b10d513d504e4cdb0385893d6785fac0e9b979de1e70ce84344964
+  data.tar.gz: cbe51475db42b814b050eab152411a4493060600c93c878ce8e3a043c7b9001ac4dd9caa81f01cd6edf0e5c01f323d442ae07a7f9411c668103415e4659c8f95

data/README.md

@@ -98,17 +98,19 @@ Body:
 {"param_1": "hi"}
 ```
 
-### Config File
+### Configuration
 
-/config/initializer/blueprint_agreement.rb
+`config/initializer/blueprint_agreement.rb`
 
-``` ruby
-  BlueprintAgreement::Config.configure do |config|
-    config.port = '8082'
-    config.server_path = '.'
-    config.exclude_attributes = ['field_name']
-    config.allow_headers = ['Authorization', 'Cookie']
-  end
+```ruby
+BlueprintAgreement.configure do |config|
+  config.port = '8082'
+  config.server_path = '.'
+  config.exclude_attributes = ['field_name']
+  config.allow_headers = ['Authorization', 'Cookie']
+end
+
+BlueprintAgreement.configuration.port = '8080'
 ```
 
 ### Allow Headers
@@ -123,12 +125,12 @@ This config option intents to exclude attributes when the match is perform. It o
 
 Examples:
 
-``` ruby
+```ruby
 # This excludes 'field_one' and the element 'sub_field_one' inside the 'field_two' array. It doesn't exclude 'field_two'.
-BlueprintAgreement::Config.exclude_attributes = ['field_one', field_two: [ 'sub_field_one' ]]
+BlueprintAgreement.configuration.exclude_attributes = ['field_one', field_two: [ 'sub_field_one' ]]
 
 # This excludes 'field_one' and 'sub_field_four'. It doesn't exclude 'field_two' or 'sub_field_one'.
-BlueprintAgreement::Config.exclude_attributes = ['field_one', field_two: { sub_field_one: [ 'sub_field_four' ] } ]
+BlueprintAgreement.configuration.exclude_attributes = ['field_one', field_two: { sub_field_one: [ 'sub_field_four' ] } ]
 ```
 
 ## Contributing

data/blueprint_agreement.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
-  spec.add_runtime_dependency "activesupport", ">= 4.2", "< 5.1"
+  spec.add_runtime_dependency "activesupport", ">=4.2"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~>11.1"

data/lib/blueprint_agreement.rb

@@ -2,7 +2,7 @@ require "minitest"
 require "minitest/spec"
 require "minitest/mock"
 require "blueprint_agreement/version"
-require 'blueprint_agreement/config'
+require 'blueprint_agreement/configuration'
 require 'blueprint_agreement/errors'
 require 'blueprint_agreement/api_services/drakov_service'
 require "blueprint_agreement/server"
@@ -39,10 +39,38 @@ require 'blueprint_agreement/minitest/expectations'
 #    +-+-+                     +--+--+                           +-+-+
 #
 module BlueprintAgreement
+  class << self
+    attr_writer :configuration
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  module Config
+    class << self
+      def configure(&block)
+        warn "[DEPRECATION] `BlueprintAgreement::Config` is deprecated.  Please use `BlueprintAgreement.configuration` instead."
+        BlueprintAgreement.configure(&block)
+      end
+
+      def method_missing(name, *args)
+        warn "[DEPRECATION] `BlueprintAgreement::Config` methods are  deprecated.  Please use `BlueprintAgreement.configuration` instead."
+        configuration = BlueprintAgreement.configuration;
+        return configuration.send(name) if name.to_s =~ /^(\w*)$/
+        return configuration.send(name, *args)  if name.to_s =~ /^(\w*)=$/
+        super
+      end
+    end
+  end
 end
 
 Minitest.after_run do
-  if BlueprintAgreement::Config.active_service?
-    Process.kill 'TERM', BlueprintAgreement::Config.active_service[:pid]
+  if BlueprintAgreement.configuration.active_service?
+    Process.kill 'TERM', BlueprintAgreement.configuration.active_service[:pid]
   end
 end

data/lib/blueprint_agreement/api_services/drakov_service.rb

@@ -2,21 +2,22 @@ module BlueprintAgreement
   class DrakovService
     attr :pid, :port, :hostname, :root_path, :allow_headers
 
-    def initialize
-      @port = Config.port
-      @allow_headers = Config.allow_headers
-      @hostname = Config.hostname
-      @root_path = Config.server_path
+    def initialize(config = BlueprintAgreement.configuration)
+      @config = config
+      @port = @config.port
+      @allow_headers = @config.allow_headers
+      @hostname = @config.hostname
+      @root_path = @config.server_path
     end
 
     def start(path)
       @pid = spawn "drakov -f #{root_path}/#{path} -p #{port} #{allow_headers}".strip, options
-      Config.active_service = { pid: @pid, path: path }
+      @config.active_service = { pid: @pid, path: path }
     end
 
     def stop
-      Process.kill 'TERM', Config.active_service[:pid]
-      Config.active_service = nil
+      Process.kill 'TERM', @config.active_service[:pid]
+      @config.active_service = nil
     end
 
     def host

data/lib/blueprint_agreement/configuration.rb

@@ -0,0 +1,31 @@
+module BlueprintAgreement
+  class Configuration
+    attr_accessor :active_service,
+      :exclude_attributes,
+      :allow_headers,
+      :port,
+      :hostname,
+      :server_path
+
+    def initialize
+      @active_service = nil
+      @exclude_attributes = nil
+      @allow_headers = nil
+      @port = "8082"
+      @hostname = "http://localhost"
+      @server_path = './docs'
+    end
+
+    def active_service?
+      !!@active_service
+    end
+
+    def allow_headers=(headers)
+      @allow_headers = headers.map { |header| "--header #{header}" }.join(" ")
+    end
+
+    def default_format
+      '*.apib'
+    end
+  end
+end

data/lib/blueprint_agreement/minitest/assertions.rb

@@ -1,11 +1,11 @@
 module Minitest
   module Assertions
     def assert_shall_agree_upon contract_name, response
-      result    = response.body
-      api_service =  BlueprintAgreement::DrakovService.new
-      server    = BlueprintAgreement::Server.new(
+      result      = response.body
+      api_service = BlueprintAgreement::DrakovService.new(BlueprintAgreement.configuration)
+      server      = BlueprintAgreement::Server.new(
         api_service: api_service,
-        config: BlueprintAgreement::Config
+        config: BlueprintAgreement.configuration
       )
 
       begin
@@ -14,8 +14,8 @@ module Minitest
         requester = BlueprintAgreement::Utils::Requester.new(request, server)
         expected  = requester.perform.body.to_s
 
-        unless BlueprintAgreement::Config.exclude_attributes.nil?
-          filters = BlueprintAgreement::Config.exclude_attributes
+        unless BlueprintAgreement.configuration.exclude_attributes.nil?
+          filters = BlueprintAgreement.configuration.exclude_attributes
           result = BlueprintAgreement::ExcludeFilter.deep_exclude(
             BlueprintAgreement::Utils.to_json(result),
             filters)

data/lib/blueprint_agreement/server.rb

@@ -17,7 +17,8 @@ module BlueprintAgreement
     end
 
     def restart(path)
-      stop && @api_service.start(path)
+      stop
+      @api_service.start(path)
     end
 
     def stop

data/lib/blueprint_agreement/utils/requester.rb

@@ -43,6 +43,9 @@ module BlueprintAgreement
         rescue Errno::ECONNREFUSED
           sleep 1
           perform
+        rescue Errno::ECONNRESET
+          sleep 1
+          perform
         end
       end
 

data/lib/blueprint_agreement/version.rb

@@ -1,3 +1,3 @@
 module BlueprintAgreement
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/test/fixtures/second_api.md

@@ -0,0 +1,83 @@
+FORMAT: 1A
+
+# The Simplest API
+This is one of the simplest APIs written in the **API Blueprint**. One plain
+resource combined with a method and that's it! We will explain what is going on
+in the next installment - 
+[Resource and Actions](02.%20Resource%20and%20Actions.md).
+
+**Note:** As we progress through the examples, do not also forget to view the
+[Raw](https://raw.github.com/apiaryio/api-blueprint/master/examples/01.%20Simplest%20API.md)
+code to see what is really going on in the API Blueprint, as opposed to just
+seeing the output of the Github Markdown parser.
+
+Also please keep in mind that every single example in this course is a **real
+API Blueprint** and as such you can **parse** it with the 
+[API Blueprint parser](https://github.com/apiaryio/drafter) or one of its
+[bindings](https://github.com/apiaryio/drafter#bindings).
+
+## API Blueprint
++ [This: Raw API Blueprint](https://raw.github.com/apiaryio/api-blueprint/master/examples/01.%20Simplest%20API.md)
++ [Next: Resource and Actions](02.%20Resource%20and%20Actions.md)
+
+# GET /message
++ Request  (application/json)
++ Response 200 (application/json)
+    
+    + Body
+
+            {
+              "name": "Hello World"
+            }
+
+# POST /message/empty
++ Request  (application/json)
++ Response 204 (application/json)
+
+    + Body
+
+            {
+              "name": "Hello World"
+            }
+
+# PATCH /message/1
++ Request (application/json)
++ Response 200 (application/json)
+
+    + Body
+
+            {
+              "name": "Hello World"
+            }
+
+# GET /cookie
++ Request (application/json)
+
+    + Headers
+
+            Cookie: cookie=have-a-cookie
+
++ Response 200 (application/json)
+
+    + Body
+
+            {
+              "cookie": "have a cookie!"
+            }
+
+# GET /extra_headers
++ Request (application/json)
+
+    + Headers
+
+            Cookie: cookie=have-a-cookie
+            Accept: application/json
+            Version: v1
+
++ Response 200 (application/json)
+
+    + Body
+
+            {
+              "cookie": "have a cookie!"
+            }

data/test/integration/simple_api_test.rb

@@ -14,7 +14,7 @@ describe "Rails" do
 
   before do
     module Rails; end
-    BlueprintAgreement::Config.server_path('./test/fixtures')
+    BlueprintAgreement.configuration.server_path = './test/fixtures'
   end
   after do
     Object.send(:remove_const, :Rails)
@@ -58,7 +58,7 @@ describe "Rack Test" do
 
   before do
     module Rack; module Test; end; end
-    BlueprintAgreement::Config.server_path('./test/fixtures')
+    BlueprintAgreement.configuration.server_path = './test/fixtures'
   end
 
   describe 'when blueprint agreement was included but never used' do
@@ -86,7 +86,7 @@ describe "Rack Test" do
     let(:endpoint){ '/message' }
 
     before do
-      BlueprintAgreement::Config.exclude_attributes = ['name']
+      BlueprintAgreement.configuration.exclude_attributes = ['name']
     end
 
     it 'returns a Not Found Route error' do
@@ -108,8 +108,35 @@ describe "Rack Test" do
     let(:endpoint){ '/message/empty' }
     let(:last_request) { RailsMocks::Request.new(fullpath: endpoint, request_method: 'POST') }
 
+    before do
+      BlueprintAgreement.configuration.exclude_attributes = ['name']
+    end
+
+    it 'returns a Not Found Route error' do
+     last_response.shall_agree_upon('hello_api.md')
+    end
+  end
+
+  describe 'with multiple apib files' do
+    let(:endpoint){ '/message/1' }
+    let(:last_request) { RailsMocks::Request.new(fullpath: endpoint, request_method: 'PATCH') }
+
+    it 'returns a Not Found Route error' do
+     last_response.shall_agree_upon('hello_api.md')
+     last_response.shall_agree_upon('second_api.md')
+    end
+  end
+
+  describe 'support old configuration method' do
+    let(:body) { "" }
+    let(:endpoint){ '/message/empty' }
+    let(:last_request) { RailsMocks::Request.new(fullpath: endpoint, request_method: 'POST') }
+
     before do
       BlueprintAgreement::Config.exclude_attributes = ['name']
+      BlueprintAgreement::Config.configure do |config|
+        config.exclude_attributes = ['name']
+      end
     end
 
     it 'returns a Not Found Route error' do

data/test/unit_test/utils/{config_test.rb → configuration_test.rb}

@@ -1,7 +1,7 @@
 require "test_helper"
 
-describe BlueprintAgreement::Config do
-  let(:subject) { BlueprintAgreement::Config }
+describe BlueprintAgreement::Configuration do
+  let(:subject) { BlueprintAgreement::Configuration.new }
 
   describe 'allow headers' do
     it 'allows setting the allowed headers' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint_agreement
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Charly Palencia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -117,7 +111,7 @@ files:
 - blueprint_agreement.gemspec
 - lib/blueprint_agreement.rb
 - lib/blueprint_agreement/api_services/drakov_service.rb
-- lib/blueprint_agreement/config.rb
+- lib/blueprint_agreement/configuration.rb
 - lib/blueprint_agreement/errors.rb
 - lib/blueprint_agreement/minitest/assertions.rb
 - lib/blueprint_agreement/minitest/expectations.rb
@@ -130,13 +124,14 @@ files:
 - lib/blueprint_agreement/version.rb
 - tasks/test.rake
 - test/fixtures/hello_api.md
+- test/fixtures/second_api.md
 - test/integration/simple_api_test.rb
 - test/request_builder_test.rb
 - test/server_test.rb
 - test/support/rails_mocks/request.rb
 - test/support/rails_mocks/response.rb
 - test/test_helper.rb
-- test/unit_test/utils/config_test.rb
+- test/unit_test/utils/configuration_test.rb
 - test/unit_test/utils/exclude_filter_test.rb
 - test/unit_test/utils/requester_test.rb
 homepage: https://github.com/charly-palencia/blueprint-agreement
@@ -165,12 +160,13 @@ specification_version: 4
 summary: A Minitest API Documentation Matcher , based on ApiBluePrint schema.
 test_files:
 - test/fixtures/hello_api.md
+- test/fixtures/second_api.md
 - test/integration/simple_api_test.rb
 - test/request_builder_test.rb
 - test/server_test.rb
 - test/support/rails_mocks/request.rb
 - test/support/rails_mocks/response.rb
 - test/test_helper.rb
-- test/unit_test/utils/config_test.rb
+- test/unit_test/utils/configuration_test.rb
 - test/unit_test/utils/exclude_filter_test.rb
 - test/unit_test/utils/requester_test.rb

data/lib/blueprint_agreement/config.rb

@@ -1,69 +0,0 @@
-module BlueprintAgreement
-  module Config
-    extend self
-    @@active_service = nil
-    @@exclude_attributes = nil
-    @@allow_headers = nil
-    @@port = "8082"
-    @@hostname = "http://localhost"
-
-    def configure; yield self end
-
-    def port=(port)
-      @@port = port
-    end
-
-    def server_path=(server_path)
-      @server_path = server_path
-    end
-
-    def exclude_attributes=(exclude_attributes)
-      @@exclude_attributes = exclude_attributes
-    end
-
-    def active_service?
-      !!@@active_service
-    end
-
-    def active_service=(active_service)
-      @@active_service = active_service
-    end
-
-    def active_service
-      @@active_service
-    end
-
-    def server_path(path = './docs')
-      @server_path ||= path
-    end
-
-    def allow_headers=(headers)
-      @@allow_headers = headers.map { |header| "--header #{header}" }.join(" ")
-    end
-
-    def allow_headers
-      @@allow_headers
-    end
-
-    def default_format
-      '*.apib'
-    end
-
-    def port
-      @@port
-    end
-
-    def hostname
-      @@hostname
-    end
-
-    def hostname=(host)
-      @@hostname = host
-    end
-
-    def exclude_attributes
-      @@exclude_attributes
-    end
-  end
-end
-