service_contract 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c79089bb4c45ecaf89930c3812b31434739a80ef
-  data.tar.gz: 77e970ad260efe58fb4b2bd084bedce070a43305
+  metadata.gz: e726ee71c2b94a1710d218844ed0638db29e5730
+  data.tar.gz: e7dd9b8d5b897d2456c4712aa00774befd9205e7
 SHA512:
-  metadata.gz: d9394895b5246c3ec59b2523b58dce7a88389a90b0c6b00ff62cd63987c6e8c4b838b11145ad4113c5cdf94cc6c358d106516eaf27d87a5f903b3a1a3c50ed4f
-  data.tar.gz: f8f775dd3f259e8fb7a1d0ea5108c4b645905205784e6e0815d9a0a19261fefb36a0b84843b773f324746ae031fd13fd25a62fa0e6a0fc28ed4123455b4dfaee
+  metadata.gz: d09426d12f7a2734d749f57c23fc61bea471c19aed47a6d0167486a4e25a5157a2dd51007fc5f80713e78cb07140d993bf0f4a64723f5963030350e22ae8a959
+  data.tar.gz: f0f48cad6bdeb955b26528e85f58a2c91f5ac03f0f5de0c23f7ed489d53cd644a25ee8bc9b5653c15d02fa558a6a51153523d4fc3feb8cfa5450673fafc9565a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.6.0
+
+* documentation rack app can serve the raw avro contracts as json
+
 ## 0.5.1
 
 * update failed assertion message to give you better information on why the data didn't match the contract

data/lib/service_contract/avro/documentation.rb

@@ -1,4 +1,5 @@
 require 'sinatra/base'
+require 'sinatra/json'
 require 'slim'
 
 module ServiceContract
@@ -7,28 +8,68 @@ module ServiceContract
       get '/:version/:protocol' do
         version = service.find(params[:version])
         protocol = version.protocol(params[:protocol])
-        slim :protocol, locals: { version: version, protocol: protocol }
+        if request_json?
+          content_type "application/json"
+          send_file File.join(service.data_dir, version.version, "compiled", "#{protocol.name}.avpr")
+        else
+          slim :protocol, locals: { version: version, protocol: protocol }
+        end
       end
 
       get '/:version' do
         version = service.find(params[:version])
 
         if version
-          slim :version, locals: { version: version }
+          if request_json?
+            json version: {
+              version: version.version,
+              protocols: version.protocols.map { |protocol|
+                {
+                  name: protocol.name,
+                  link: "/#{version.version}/#{protocol.name}"
+                }
+              }
+            }
+          else
+            slim :version, locals: { version: version }
+          end
         else
           status 404
         end
       end
 
       get '/' do
-        slim :homepage
+        if request_json?
+          json contract: {
+            name: service.name,
+            title: service.title,
+            description: service.description,
+            release_version: release_version,
+            versions: service.all.map { |version|
+              {
+                version: version.version,
+                link: "/#{version.version}"
+              }
+            }
+          }
+        else
+          slim :homepage
+        end
       end
 
       helpers do
         def service
           raise :not_implemented
         end
+
+        def request_json?
+          request.accept.map(&:entry).include?("application/json")
+        end
+
+        def release_version
+          service.const_defined?("VERSION") ? service.const_get("VERSION") : ""
+        end
       end
     end
   end
-end
+end

data/lib/service_contract/version.rb

@@ -1,3 +1,3 @@
 module ServiceContract
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/service_contract.gemspec

@@ -23,4 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5"
   spec.add_development_dependency "faker"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "slim"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "sinatra-contrib"
+  spec.add_development_dependency "pry"
 end

data/test/documentation_json_test.rb

@@ -0,0 +1,53 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'test_helper'
+require 'rack/test'
+require 'service_contract/avro/documentation'
+
+class DocumentationJsonTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    SampleDocumentation
+  end
+
+  def setup
+    super
+    header "Accept", "application/json"
+  end
+
+  def test_homepage_json
+    get '/'
+    assert_equal "application/json", last_response.headers["Content-Type"]
+    assert_equal({"contract" => {
+      "name" => "SampleService",
+      "title" => "Avro Service",
+      "description" => "",
+      "release_version" => "0.1.2",
+      "versions" => [
+        {"version" => "1", "link" => "/1"},
+        {"version" => "2", "link" => "/2"},
+      ]
+    }}, JSON.parse(last_response.body))
+  end
+
+  def test_version_index_json
+    get '/1'
+    assert_equal "application/json", last_response.headers["Content-Type"]
+    assert_equal({"version" => {
+      "version" => "1",
+      "protocols" => [
+        {"name" => "city_state", "link" => "/1/city_state"},
+        {"name" => "location", "link" => "/1/location"},
+        {"name" => "sales_region", "link" => "/1/sales_region"},
+      ]
+    }}, JSON.parse(last_response.body))
+  end
+
+  def test_protocol_json
+    get '/1/city_state'
+    assert_equal "application/json", last_response.headers["Content-Type"]
+    assert_equal File.read(File.expand_path("../sample/1/compiled/city_state.avpr", __FILE__)),
+      last_response.body
+  end
+end

data/test/documentation_test.rb

@@ -0,0 +1,40 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'test_helper'
+require 'rack/test'
+require 'capybara'
+require 'capybara/dsl'
+require 'service_contract/avro/documentation'
+
+class DocumentationTest < Minitest::Test
+  include Capybara::DSL
+
+  class SampleDocumentation < ServiceContract::Avro::Documentation
+    def service
+      SampleService
+    end
+  end
+
+  def setup
+    super
+    Capybara.app = SampleDocumentation
+  end
+
+  def test_homepage_html
+    visit '/'
+    assert page.find("a[href='http://www.example.com/1']", text: "Version 1")
+    assert page.find("a[href='http://www.example.com/2']", text: "Version 2")
+  end
+
+  def test_version_index_html
+    visit '/1'
+    assert page.find("a[href='http://www.example.com/1/city_state']", text: "city_state")
+    assert page.find("a[href='http://www.example.com/1/location']", text: "location")
+    assert page.find("a[href='http://www.example.com/1/sales_region']", text: "sales_region")
+  end
+
+  def test_version_protocol_html
+    visit '/1/city_state'
+    assert page.has_content?("CityState params")
+  end
+end

data/test/test_helper.rb

@@ -4,7 +4,15 @@ require 'minitest/autorun'
 require 'service_contract'
 
 class SampleService < ServiceContract::Avro::Service
+  VERSION = "0.1.2"
+
   def self.data_dir
     File.expand_path("../sample", __FILE__)
   end
-end
+end
+
+class SampleDocumentation < ServiceContract::Avro::Documentation
+  def service
+    SampleService
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_contract
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -80,6 +80,90 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Abstract the definition of a service's interface contract. Supports Avro
 email:
 - jching@avvo.com
@@ -119,6 +203,8 @@ files:
 - service_contract.gemspec
 - src/avro-tools-1.7.7.jar
 - test/assertions_test.rb
+- test/documentation_json_test.rb
+- test/documentation_test.rb
 - test/mock_test.rb
 - test/sample/1/compiled/city_state.avpr
 - test/sample/1/compiled/location.avpr
@@ -160,6 +246,8 @@ specification_version: 4
 summary: Abstract the definition of a service's interface contract
 test_files:
 - test/assertions_test.rb
+- test/documentation_json_test.rb
+- test/documentation_test.rb
 - test/mock_test.rb
 - test/sample/1/compiled/city_state.avpr
 - test/sample/1/compiled/location.avpr
@@ -175,4 +263,3 @@ test_files:
 - test/sample/2/source/social_login.avdl
 - test/service_test.rb
 - test/test_helper.rb
-has_rdoc: