service_contract 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 986435826a76bf34d9367c13d65c992afc45261d
+  data.tar.gz: a0ddf05d5d5b1b26d993578a63b3bba561ccee56
+SHA512:
+  metadata.gz: c79dc84b3b9e8490f78b96506113f9c83b4687e7ec1f204f9e671f4be197981f3cc5a64a82f86e04bcbe594608e9f73a523cc02e8fe7a6136eca6a6a51f7239e
+  data.tar.gz: 78721a558a768fa5c70baa903ecb099717d5641aebe9f86e73ebb764767f95d613c96539276e82d40bea9753d46fbbe6416c552d86eec68c4bc580669ac640a2

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.travis.yml

@@ -0,0 +1,3 @@
+env:
+  global:
+    - CODECLIMATE_REPO_TOKEN=2ca11363f82515a172ab992c3e4bacf032fc088c57a9907bcb2bcb9eaa71e344 

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in service_contract.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: 'test', require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Ching
+
+MIT License
+
+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,81 @@
+# ServiceContract [![Build Status](https://travis-ci.org/chingor13/service_contract.png)](https://travis-ci.org/chingor13/service_contract) [![Code Climate](https://codeclimate.com/github/chingor13/service_contract.png)](https://codeclimate.com/github/chingor13/service_contract) [![Code Coverage](https://codeclimate.com/github/chingor13/service_contract/coverage.png)](https://codeclimate.com/github/chingor13/service_contract)
+
+The gem tries to abstract the definition of a service's interface contract
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'service_contract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install service_contract
+
+## Providers
+
+### Avro
+
+We can read an Avro protocol file to determine a set of service definitions.
+
+Example:
+
+```
+class Gnomon::Contract::Service < ServiceContract::Avro::Service
+  def self.data_dir
+  	return "/path/to/avro_files"
+  end
+end
+```
+
+## Usage
+
+We define a service as having many versions with each version having several `Protocol`s. A `Protocol` has many `Endpoint`s.
+
+Example:
+
+```
+# a Gnomon::Contract::Service instance (subclass of ServiceContract::AbstractService)
+version = Gnomon::Contract::Service.find(1)
+=> <#Gnomon::Contract::Service>
+
+protocol = version.protocol("location")
+=> <#ServiceContract::Avro::Protocol>
+
+protocol.endpoints
+=> [<#ServiceContract::Avro::Endpoint>,...]
+```
+
+## Documentation
+
+`service_contract` also provides a nice documentation layer packaged in the form of a [sinatra](http://www.sinatrarb.com/) rack application. 
+
+```
+module Gnomon
+  module Contract
+    class Documentation < ServiceContract::Avro::Documentation
+      helpers do
+        def service
+          Gnomon::Contract::Service
+        end
+      end
+    end
+  end
+end
+
+# in your rackup config
+run Gnomon::Contract::Documentation
+
+# or mount in rails routes
+MyApplication.routes.draw do
+  mount Gnomon::Contract::Documentation, at: "docs/"
+end
+```
+
+**Note**: You will have to add `sinatra` and `slim` (templating engine) to your gem dependencies yourself because it's not a core dependency.

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/service_contract/abstract_endpoint.rb

@@ -0,0 +1,11 @@
+module ServiceContract
+  AbstractEndpoint = Struct.new(:protocol, :definition) do
+    def parameters
+      []
+    end
+
+    def response_type
+      nil
+    end
+  end
+end

data/lib/service_contract/abstract_field.rb

@@ -0,0 +1,3 @@
+module ServiceContract
+  AbstractField = Struct.new(:type, :name)
+end

data/lib/service_contract/abstract_parameter.rb

@@ -0,0 +1,19 @@
+module ServiceContract
+  AbstractParameter = Struct.new(:definition) do
+    def name
+      raise :not_implemented
+    end
+
+    def type
+      raise :not_implemented
+    end
+
+    def default
+      nil
+    end
+
+    def doc
+      nil
+    end
+  end
+end

data/lib/service_contract/abstract_protocol.rb

@@ -0,0 +1,19 @@
+module ServiceContract
+  AbstractProtocol = Struct.new(:name, :service) do
+    def endpoints
+      []
+    end
+
+    def endpoint(name)
+      endpoints.detect{|endpoint| endpoint.name == name}
+    end
+
+    def types
+      []
+    end
+
+    def type(name)
+      types.detect{|type| type.name == name}
+    end
+  end
+end

data/lib/service_contract/abstract_service.rb

@@ -0,0 +1,28 @@
+module ServiceContract
+  class AbstractService
+    class << self
+      def all
+        []
+      end
+
+      def find(version)
+        all.detect{|definition| definition.version == version.to_s}
+      end
+    end
+
+    attr_reader :version
+    def initialize(version)
+      @version = version.to_s
+    end
+
+    # returns an array of AbstractProtocol
+    def protocols
+      []
+    end
+
+    def protocol(name)
+      protocols.detect{|protocol| protocol.name == name}
+    end
+
+  end
+end

data/lib/service_contract/abstract_type.rb

@@ -0,0 +1,15 @@
+module ServiceContract
+  AbstractType = Struct.new(:definition) do
+    def name
+      raise :not_implemented
+    end
+
+    def subtype
+      nil
+    end
+
+    def fields
+      []
+    end
+  end
+end

data/lib/service_contract/assertions.rb

@@ -0,0 +1,44 @@
+module ServiceContract
+  module Assertions
+
+    def assert_endpoint_response(data, endpoint, allow_nil = true)
+      assert_data_matches_type(data, endpoint.response_type, allow_nil)
+    end
+
+    def assert_data_matches_type(data, type, allow_nil = true)
+      if type.is_a?(ServiceContract::Avro::ArrayType)
+        assert data.is_a?(Array), "expected response to be an Array"
+        data.each do |datum|
+          assert_data_matches_type(datum, type.subtype)
+        end
+      else
+        type.fields.each do |field|
+          assert data.has_key?(field.name), "expected #{type.name} to have attribute: #{field.name}"
+          value = data.fetch(field.name)
+
+          expected_classes = classes_for_parameter(field)
+          assert (allow_nil && value.nil?) || expected_classes.any?{|klass| value.is_a?(klass)}, "expected #{type.name}.#{field.name} to be a #{expected_classes.join(", ")}"
+        end
+      end
+    end
+
+    protected
+
+    def classes_for_parameter(field)
+      classes = case field.type
+      when "int"
+        Fixnum
+      when "string"
+        String
+      when "float"
+        Float
+      when "boolean"
+        [TrueClass, FalseClass]
+      else # a complex type
+        Hash
+      end
+      Array(classes)
+    end
+
+  end
+end

data/lib/service_contract/avro/array_type.rb

@@ -0,0 +1,17 @@
+module ServiceContract
+  module Avro
+    class ArrayType < Type
+      def name
+        "Array"
+      end
+
+      def subtype
+        Type.build(definition.items)
+      end
+
+      def to_s
+        "Array(#{subtype.to_s})"
+      end
+    end
+  end
+end

data/lib/service_contract/avro/documentation.rb

@@ -0,0 +1,34 @@
+require 'sinatra/base'
+require 'slim'
+
+module ServiceContract
+  module Avro
+    class Documentation < Sinatra::Base
+      get '/:version/:protocol' do
+        version = service.find(params[:version])
+        protocol = version.protocol(params[:protocol])
+        slim :protocol, locals: { version: version, protocol: protocol }
+      end
+
+      get '/:version' do
+        version = service.find(params[:version])
+
+        if version
+          slim :version, locals: { version: version }
+        else
+          status 404
+        end
+      end
+
+      get '/' do
+        slim :homepage
+      end
+
+      helpers do
+        def service
+          raise :not_implemented
+        end
+      end
+    end
+  end
+end

data/lib/service_contract/avro/endpoint.rb

@@ -0,0 +1,63 @@
+require 'forwardable'
+
+module ServiceContract
+  module Avro
+    class Endpoint < AbstractEndpoint
+      extend Forwardable
+      def_delegators :definition, :name, :response, :request
+
+      def description
+        [request_method, path].join(" ")
+      end
+
+      def doc
+        definition.respond_to?(:doc) ? definition.doc : nil
+      end
+
+      def response_type
+        Type.build(response)
+      end
+
+      def parameters
+        request.fields.map{|field| Parameter.new(field) }
+      end
+
+      protected
+
+      def request_method
+        case name
+        when "create"
+          "POST"
+        when "update"
+          "PUT"
+        when "destroy"
+          "DELETE"
+        else
+          "GET"
+        end
+      end
+
+      def path
+        case name
+        when "index", "create"
+          protocol.path
+        when "show", "destroy", "update"
+          File.join(protocol.path, ":id")
+        else
+          if member?
+            File.join(protocol.path, ":id", name)
+          else
+            File.join(protocol.path, name)
+          end
+        end
+      end
+
+      # seems kinda hacky
+      def member?
+        first_field_type = request.fields.first.type
+        first_field_type.is_a?(::Avro::Schema::RecordSchema) &&
+          first_field_type.name == protocol.main_type
+      end
+    end
+  end
+end

data/lib/service_contract/avro/errors.rb

@@ -0,0 +1,7 @@
+module ServiceContract
+  module Avro
+    module Errors
+      class NotFound < Exception; end
+    end
+  end
+end

data/lib/service_contract/avro/parameter.rb

@@ -0,0 +1,23 @@
+module ServiceContract
+  module Avro
+    class Parameter < AbstractParameter
+      def name
+        definition.name
+      end
+
+      def type
+        definition.type.type_sym == :record ?
+          definition.type.name :
+          definition.type.type_sym.to_s
+      end
+
+      def default
+        definition.default
+      end
+
+      def doc
+        definition.respond_to?(:doc) ? definition.doc : nil
+      end
+    end
+  end
+end

data/lib/service_contract/avro/protocol.rb

@@ -0,0 +1,39 @@
+module ServiceContract
+  module Avro
+    class Protocol < AbstractProtocol
+      def file_path
+        File.join(service.data_dir, "#{name}.avpr")
+      end
+
+      def endpoints
+        avro.messages.map do |name, message|
+          Endpoint.new(self, message)
+        end
+      end
+
+      def types
+        avro.types.map do |type|
+          Type.new(type)
+        end
+      end
+
+      def path
+        File.join(service.path, resource_name)
+      end
+
+      protected
+
+      def resource_name
+        name.respond_to?(:pluralize) ? name.pluralize : "#{name}s"
+      end
+
+      def avro
+        @avro ||= begin
+          raise Errors::NotFound unless File.exists?(file_path)
+
+          ::Avro::Protocol.parse(File.read(file_path))
+        end
+      end
+    end
+  end
+end

data/lib/service_contract/avro/service.rb

@@ -0,0 +1,45 @@
+module ServiceContract
+  module Avro
+    class Service < AbstractService
+      class << self
+        def all
+          @all ||= begin
+            Dir.glob(File.join(data_dir, "*")).map do |filepath|
+              new(File.basename(filepath).to_s)
+            end
+          end
+        end
+
+        def data_dir
+          raise :not_implemented
+        end
+
+        def title
+          "Avro Service"
+        end
+
+        def description
+          ""
+        end
+
+      end
+
+      def protocols
+        @protocols ||= begin
+          Dir.glob(File.join(data_dir, "*.avpr")).map do |filepath|
+            name = File.basename(filepath, ".avpr")
+            Protocol.new(name, self)
+          end
+        end
+      end
+
+      def path
+        "/#{version}"
+      end
+
+      def data_dir
+        File.join(self.class.data_dir, version, "compiled")
+      end
+    end
+  end
+end

data/lib/service_contract/avro/type.rb

@@ -0,0 +1,31 @@
+module ServiceContract
+  module Avro
+    class Type < AbstractType
+      def name
+        definition.name
+      end
+
+      def fields
+        definition.fields.map do |field|
+          Parameter.new(field)
+        end
+      end
+
+      def to_s
+        name
+      end
+
+      def self.build(definition)
+        definition.is_a?(::Avro::Schema::ArraySchema) ? 
+          ArrayType.new(definition) :
+          Type.new(definition)
+      end
+
+      protected
+
+      def record?
+        definition.type.type_sym == :record
+      end
+    end
+  end
+end

data/lib/service_contract/avro/views/homepage.slim

@@ -0,0 +1,7 @@
+h2 Versions
+
+- service.all.each do |version|
+  p
+    a href=to("#{version.version}")
+      | Version
+      =< version.version

data/lib/service_contract/avro/views/layout.slim

@@ -0,0 +1,17 @@
+doctype html
+html
+  head
+    title 
+      => service.name
+      | Documentation
+    link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css"
+    script src="//code.jquery.com/jquery-2.1.1.min.js"
+    script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"
+    meta name="viewport" content="width=device-width, initial-scale=1"
+
+  body
+    .container
+      h1 = service.title
+      p = service.description
+
+      == yield

data/lib/service_contract/avro/views/protocol.slim

@@ -0,0 +1,56 @@
+h2
+  | Version
+  =<> version.version
+a href=to(version.version)
+  i.glyphicon.glyphicon-chevron-left>
+  | Back
+
+.row
+  .col-md-8
+    h2 Endpoints
+
+    .panel-group#endpoints
+      - protocol.endpoints.each do |endpoint|
+        .panel.panel-default
+          .panel-heading
+            h4.panel-title
+              a data-toggle="collapse" href="#collapse#{endpoint.name}"
+                = endpoint.description
+          .panel-collapse.collapse.in id="collapse#{endpoint.name}"
+            .panel-body
+              p = endpoint.doc
+
+              h4 Parameters
+
+              ul
+                - endpoint.parameters.each do |parameter|
+                  li
+                    => parameter.type
+                    = parameter.name
+
+              h4 Response
+              p 
+                = endpoint.response_type
+
+  .col-md-4
+    h2 Types
+
+    .panel-group#types
+      - protocol.types.each do |type|
+        .panel.panel-default
+          .panel-heading
+            h4.panel-title
+              a data-toggle="collapse" href="#collapse#{type.name}"
+                = type.name
+          .panel-collapse.collapse.in id="collapse#{type.name}"
+            .panel-body
+              - type.fields.each do |field|
+                p
+                  a.pull-right data-toggle="collapse" href="#collapseDescription#{type.name}#{field.name}"
+                    i.glyphicon.glyphicon-info-sign
+                  => field.type
+                  | -
+                  =< field.name
+                - if field.doc
+                  p.collapse id="collapseDescription#{type.name}#{field.name}"
+                    em = field.doc

data/lib/service_contract/avro/views/version.slim

@@ -0,0 +1,12 @@
+a href=to("")
+  i.glyphicon.glyphicon-chevron-left>
+  | Back
+h2 
+  | Version
+  =< version.version
+
+h3 Protocols
+- version.protocols.each do |protocol|
+  p
+    a href=to("#{version.version}/#{protocol.name}")
+      = protocol.name

data/lib/service_contract/avro.rb

@@ -0,0 +1,14 @@
+require 'avro'
+
+module ServiceContract
+  module Avro
+    autoload :ArrayType, 'service_contract/avro/array_type'
+    autoload :Documentation, 'service_contract/avro/documentation'
+    autoload :Endpoint, 'service_contract/avro/endpoint'
+    autoload :Errors, 'service_contract/avro/errors'
+    autoload :Parameter, 'service_contract/avro/parameter'
+    autoload :Protocol, 'service_contract/avro/protocol'
+    autoload :Service, 'service_contract/avro/service'
+    autoload :Type, 'service_contract/avro/type'
+  end
+end

data/lib/service_contract/tasks.rb

@@ -0,0 +1,14 @@
+namespace :avro do
+  desc 'build definitions'
+  task :build do
+    jar_file = File.expand_path("../../../src/avro-tools-1.7.7.jar", __FILE__)
+    spec_dir = File.expand_path(".")
+    Dir.glob(File.join(spec_dir, "/**/*.avdl")) do |file|
+      puts file
+      new_file = File.expand_path(File.join(File.dirname(file), "../compiled", File.basename(file, ".avdl")))
+      command = "java -jar #{jar_file} idl #{file} #{new_file}.avpr"
+      puts command
+      `#{command}`
+    end
+  end
+end

data/lib/service_contract/version.rb

@@ -0,0 +1,3 @@
+module ServiceContract
+  VERSION = "0.0.5"
+end

data/lib/service_contract.rb

@@ -0,0 +1,15 @@
+require "service_contract/version"
+
+module ServiceContract
+  autoload :AbstractEndpoint, 'service_contract/abstract_endpoint'
+  autoload :AbstractParameter, 'service_contract/abstract_parameter'
+  autoload :AbstractProtocol, 'service_contract/abstract_protocol'
+  autoload :AbstractService, 'service_contract/abstract_service'
+  autoload :AbstractType, 'service_contract/abstract_type'
+
+  # test hooks
+  autoload :Assertions, 'service_contract/assertions'
+
+  # providers
+  autoload :Avro, 'service_contract/avro'
+end

data/service_contract.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_contract/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "service_contract"
+  spec.version       = ServiceContract::VERSION
+  spec.authors       = ["Jeff Ching"]
+  spec.email         = ["jching@avvo.com"]
+  spec.summary       = %q{Abstract the definition of a service's interface contract}
+  spec.description   = %q{Abstract the definition of a service's interface contract. Supports Avro}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "avro", "~> 1.7"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5"
+end

data/test/sample/1/compiled/location.avpr

@@ -0,0 +1,113 @@
+{
+  "protocol" : "Location",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "record",
+    "name" : "Timestamp",
+    "fields" : [ {
+      "name" : "timestamp",
+      "type" : "int"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "Location",
+    "doc" : "This main class for this protocol",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int",
+      "doc" : "foo"
+    }, {
+      "name" : "type",
+      "type" : "string"
+    }, {
+      "name" : "county_name",
+      "type" : "string"
+    }, {
+      "name" : "state_name",
+      "type" : "string"
+    }, {
+      "name" : "country_name",
+      "type" : "string"
+    }, {
+      "name" : "city_name",
+      "type" : "string"
+    }, {
+      "name" : "neighborhood_name",
+      "type" : "string"
+    }, {
+      "name" : "postal_code_name",
+      "type" : "string"
+    }, {
+      "name" : "to_location",
+      "type" : "string"
+    }, {
+      "name" : "to_short_location",
+      "type" : "string"
+    }, {
+      "name" : "to_long_location",
+      "type" : "string"
+    }, {
+      "name" : "to_location_with_region",
+      "type" : "string"
+    }, {
+      "name" : "latitude",
+      "type" : "float"
+    }, {
+      "name" : "longitude",
+      "type" : "float"
+    }, {
+      "name" : "population",
+      "type" : "int"
+    }, {
+      "name" : "updated_at",
+      "type" : "Timestamp"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "FetchOption",
+    "fields" : [ {
+      "name" : "page",
+      "type" : "int",
+      "default" : 0
+    }, {
+      "name" : "per_page",
+      "type" : "int",
+      "default" : 30
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Returns a list of Locations",
+      "request" : [ {
+        "name" : "options",
+        "type" : "FetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Location"
+      }
+    },
+    "show" : {
+      "doc" : "Return a single Location",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Location"
+      }
+    },
+    "resolve" : {
+      "doc" : "Try to guess a location from a given string",
+      "request" : [ {
+        "name" : "q",
+        "type" : "string"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "Location"
+      }
+    }
+  }
+}

data/test/sample/1/compiled/sales_region.avpr

@@ -0,0 +1,60 @@
+{
+  "protocol" : "SalesRegion",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "record",
+    "name" : "SalesRegion",
+    "fields" : [ {
+      "name" : "id",
+      "type" : "int"
+    }, {
+      "name" : "name",
+      "type" : "string"
+    }, {
+      "name" : "state_id",
+      "type" : "int"
+    }, {
+      "name" : "split_region",
+      "type" : "boolean"
+    } ]
+  }, {
+    "type" : "record",
+    "name" : "SalesRegionFetchOption",
+    "fields" : [ {
+      "name" : "page",
+      "type" : "int",
+      "default" : 1
+    }, {
+      "name" : "per_page",
+      "type" : "int",
+      "default" : 30
+    }, {
+      "name" : "state_id",
+      "type" : "int"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "doc" : "Returns a list of SalesRegion",
+      "request" : [ {
+        "name" : "options",
+        "type" : "SalesRegionFetchOption"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "SalesRegion"
+      }
+    },
+    "show" : {
+      "doc" : "Return a single SalesRegion",
+      "request" : [ {
+        "name" : "id",
+        "type" : "int"
+      } ],
+      "response" : {
+        "type" : "array",
+        "items" : "SalesRegion"
+      }
+    }
+  }
+}

data/test/sample/1/source/location.avdl

@@ -0,0 +1,43 @@
+@namespace("Gnomon")
+
+protocol Location {
+
+  record Timestamp {
+    int timestamp;
+  }
+
+  /** This main class for this protocol */
+  record Location {
+    /** foo */
+    int id;
+    string type;
+    string county_name;
+    string state_name;
+    string country_name;
+    string city_name;
+    string neighborhood_name;
+    string postal_code_name;
+    string to_location;
+    string to_short_location;
+    string to_long_location;
+    string to_location_with_region;
+    float latitude;
+    float longitude;
+    int population;
+    Timestamp updated_at;
+  }
+
+  record FetchOption {
+    int page = 0;
+    int per_page = 30;
+  }
+
+  /** Returns a list of Locations */
+  array<Location> index(FetchOption options);
+
+  /** Return a single Location */
+  array<Location> show(int id);
+
+  /** Try to guess a location from a given string */
+  array<Location> resolve(string q);
+}

data/test/sample/1/source/sales_region.avdl

@@ -0,0 +1,24 @@
+@namespace("Gnomon")
+
+protocol SalesRegion {
+
+  record SalesRegion {
+    int id;
+    string name;
+    int state_id;
+    boolean split_region;
+  }
+
+  record SalesRegionFetchOption {
+    int page = 1;
+    int per_page = 30;
+    int state_id;
+  }
+
+  /** Returns a list of SalesRegion */
+  array<SalesRegion> index(SalesRegionFetchOption options);
+
+  /** Return a single SalesRegion */
+  array<SalesRegion> show(int id);
+
+}

data/test/service_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ServiceTest < Minitest::Test
+
+  def test_all
+    assert_equal(1, SampleService.all.length)
+  end
+
+  def test_find
+    service = SampleService.find(1)
+    assert service, "expect to find a service by version"
+    assert_equal "1", service.version
+
+    assert_equal 2, service.protocols.length
+    protocol = service.protocol("location")
+
+    assert_equal "location", protocol.name
+    assert_equal 3, protocol.endpoints.length
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+require 'minitest/autorun'
+require 'service_contract'
+
+class SampleService < ServiceContract::Avro::Service
+  def self.data_dir
+    File.expand_path("../sample", __FILE__)
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: service_contract
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Abstract the definition of a service's interface contract. Supports Avro
+email:
+- jching@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/service_contract.rb
+- lib/service_contract/abstract_endpoint.rb
+- lib/service_contract/abstract_field.rb
+- lib/service_contract/abstract_parameter.rb
+- lib/service_contract/abstract_protocol.rb
+- lib/service_contract/abstract_service.rb
+- lib/service_contract/abstract_type.rb
+- lib/service_contract/assertions.rb
+- lib/service_contract/avro.rb
+- lib/service_contract/avro/array_type.rb
+- lib/service_contract/avro/documentation.rb
+- lib/service_contract/avro/endpoint.rb
+- lib/service_contract/avro/errors.rb
+- lib/service_contract/avro/parameter.rb
+- lib/service_contract/avro/protocol.rb
+- lib/service_contract/avro/service.rb
+- lib/service_contract/avro/type.rb
+- lib/service_contract/avro/views/homepage.slim
+- lib/service_contract/avro/views/layout.slim
+- lib/service_contract/avro/views/protocol.slim
+- lib/service_contract/avro/views/version.slim
+- lib/service_contract/tasks.rb
+- lib/service_contract/version.rb
+- service_contract.gemspec
+- src/avro-tools-1.7.7.jar
+- test/sample/1/compiled/location.avpr
+- test/sample/1/compiled/sales_region.avpr
+- test/sample/1/source/location.avdl
+- test/sample/1/source/sales_region.avdl
+- test/service_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Abstract the definition of a service's interface contract
+test_files:
+- test/sample/1/compiled/location.avpr
+- test/sample/1/compiled/sales_region.avpr
+- test/sample/1/source/location.avdl
+- test/sample/1/source/sales_region.avdl
+- test/service_test.rb
+- test/test_helper.rb
+has_rdoc: