service_contract 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 375af4c11c52d3fd5594769255fd23677ecc784f
-  data.tar.gz: 73d98f54671f7a9fec7bd4878f2d38d6d6c33857
+  metadata.gz: cda29b086c0922a685bcf1c3ada63c6e5786dd21
+  data.tar.gz: d2471890764bdb42b78ab77107c748e8af0f1599
 SHA512:
-  metadata.gz: 2b148df034846a5d796a85ea75a36e05f8400be7df0c2881199cca51a8c1ccc41c95c0511966993388da16ba64f84487b72083ff8e6129d05594aa115af5f240
-  data.tar.gz: c82ee8d3f16eefcfd1c84187571a67e9f3724844432af64501c0906f6553dd81e755f9b159bc9097d0abf6e4a6b96d64e5b4d48795eb8bab3d1513f70858b367
+  metadata.gz: b55b44ca63fe651c4de836ed6b37c5bee7df090374e307bfcf86322a46df76c9e525161cbdab9f7be24417d9bb6676185932ba5b66d72d47b4ba7645cb3e79c4
+  data.tar.gz: 990b883ac9c8da2d8a230cd0c2ce53860b526392fc808ef54e221b7e6f86ddca14bfe44ccb3e2f269fb6b93f69dc7a032eda85929821463afdb1698d942da7b6

data/.travis.yml

@@ -1,3 +1,9 @@
 env:
   global:
-    - CODECLIMATE_REPO_TOKEN=2ca11363f82515a172ab992c3e4bacf032fc088c57a9907bcb2bcb9eaa71e344 
+    - CODECLIMATE_REPO_TOKEN=2ca11363f82515a172ab992c3e4bacf032fc088c57a9907bcb2bcb9eaa71e344
+
+rvm:
+  - 2.1.0
+  - 2.2.0
+
+before_install: gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.4.0
+
+* add enum types
+* refactor some internals for types

data/lib/service_contract/abstract_parameter.rb

@@ -8,10 +8,6 @@ module ServiceContract
       raise :not_implemented
     end
 
-    def subtype
-      nil
-    end
-
     def default
       nil
     end
@@ -20,4 +16,4 @@ module ServiceContract
       nil
     end
   end
-end
+end

data/lib/service_contract/abstract_type.rb

@@ -12,16 +12,20 @@ module ServiceContract
       []
     end
 
-    def array?
-      false
+    def valid_value?(value)
+      if valid_values.empty?
+        true
+      else
+        valid_values.include?(value)
+      end
     end
 
-    def complex?
-      false
+    def valid_values
+      []
     end
 
     def valid_ruby_types
       [Object]
     end
   end
-end
+end

data/lib/service_contract/assertions.rb

@@ -6,36 +6,37 @@ module ServiceContract
     end
 
     def assert_data_matches_type(data, type, allow_nil = true)
-      if type.array?
-        assert data.is_a?(Array), "expected #{type.name} to be an Array; instead got: #{data.inspect} (#{data.class.name})"
+      # Skip out if object is nil and allowed to be nil
+      return true if data.nil? && allow_nil
+
+      # basic type checking
+      assert type.valid_ruby_types.any?{|type| data.is_a?(type) }, "expected #{type.name} to be one of #{type.valid_ruby_types}"
+      assert type.valid_value?(data), "#{data} is not an allowed value of type: #{type.name}"
+
+      # check subtype
+      if type.subtype
         data.each do |datum|
           assert_data_matches_type(datum, type.subtype, allow_nil)
         end
-      elsif type.complex?
-        # Skip out of the complex object is nil and allowed to be nil
-        return true if data.nil? && allow_nil
-        # type should have fields
-        type.fields.each do |field|
-
-          #Does data contain attributes that the contract doesn't specify?
-          data_extra_attrs = (data.keys.map(&:to_sym) - type.fields.map{|n| n.name.to_sym})
-          assert_equal 0, data_extra_attrs.size, "#{type.name} contains attributes not described in contract: #{data_extra_attrs.join(',')}"
-
-          # ensure the field is present
-          value = data.fetch(field.name) do
-            data.fetch(field.name.to_sym) do
-              assert false, "expected #{type.name} to have attribute: #{field.name}"
-            end
-          end
+      end
 
-          # check the data type
-          assert_data_matches_type(value, field.type, allow_nil)
+      # check subfields
+      type.fields.each do |field|
+        #Does data contain attributes that the contract doesn't specify?
+        data_extra_attrs = (data.keys.map(&:to_sym) - type.fields.map{|n| n.name.to_sym})
+        assert_equal 0, data_extra_attrs.size, "#{type.name} contains attributes not described in contract: #{data_extra_attrs.join(',')}"
+
+        # ensure the field is present
+        value = data.fetch(field.name) do
+          data.fetch(field.name.to_sym) do
+            assert false, "expected #{type.name} to have attribute: #{field.name}"
+          end
         end
-      else
-        # type is a scalar
-        assert (allow_nil && data.nil?) || type.valid_ruby_types.any?{|klass| data.is_a?(klass)}, "expected scalar type #{type.inspect} or nil; instead got: #{data.inspect} (#{data.class.name})"
+
+        # check the data type
+        assert_data_matches_type(value, field.type, allow_nil)
       end
     end
 
   end
-end
+end

data/lib/service_contract/avro/endpoint.rb

@@ -62,8 +62,8 @@ module ServiceContract
         return false if parameters.empty?
 
         first_param_type = parameters.first.type
-        first_param_type.complex? && first_param_type.name == protocol.main_type
+        first_param_type.is_a?(RecordType) && first_param_type.name == protocol.main_type
       end
     end
   end
-end
+end

data/lib/service_contract/avro/parameter.rb

@@ -9,12 +9,6 @@ module ServiceContract
         Type.build(definition.type)
       end
 
-      def subtype
-        definition.array? ?
-          definition.type.items :
-          nil
-      end
-
       def default
         definition.default
       end
@@ -24,4 +18,4 @@ module ServiceContract
       end
     end
   end
-end
+end

data/lib/service_contract/avro/protocol.rb

@@ -13,7 +13,7 @@ module ServiceContract
 
       def types
         avro.types.map do |type|
-          Type.new(type)
+          Type.build(type)
         end
       end
 
@@ -41,4 +41,4 @@ module ServiceContract
       end
     end
   end
-end
+end

data/lib/service_contract/avro/type.rb

@@ -1,12 +1,8 @@
 module ServiceContract
   module Avro
-    class Type < AbstractType
+    class RecordType < AbstractType
       def name
-        array? ? 
-          "Array(#{subtype.name})" :
-          complex? ?
-            definition.name :
-            definition.type.to_s
+        definition.name
       end
 
       def fields
@@ -15,66 +11,140 @@ module ServiceContract
         end
       end
 
-      def to_s
-        return name unless union?
- 
-        union_types.map(&:name).join(", ")
+      def valid_ruby_types
+        [Hash]
+      end
+    end
+
+    class ArrayType < AbstractType
+      def name
+        "Array(#{subtype.name})"
       end
 
       def subtype
-        return nil unless definition.respond_to?(:items)
         Type.build(definition.items)
       end
 
-      def array?
-        type_string == "array"
+      def valid_ruby_types
+        [Array]
       end
+    end
 
-      def self.build(definition)
-        Type.new(definition)
+    class UnionType < AbstractType
+      def name
+        "Union(#{union_types.map(&:name).join(", ")})"
       end
 
-      def complex?
-        type_string == "record"
+      def valid_ruby_types
+        union_types.map(&:valid_ruby_types).flatten
       end
 
-      def union?
-        type_string == "union"
+      protected
+
+      def union_types
+        definition.schemas.map{|schema| Type.build(schema)}
+      end
+    end
+
+    class EnumType < AbstractType
+      def name
+        "Enum(#{definition.name})"
       end
 
       def valid_ruby_types
-        case type_string
-        when "array"
-          [Array]
-        when "int"
-          [Fixnum]
-        when "string"
-          [String]
-        when "float"
-          [Float]
-        when "boolean"
-          [TrueClass, FalseClass]
-        when "null"
-          [NilClass]
-        when "union"
-          union_types.map(&:valid_ruby_types).flatten
-        else # a complex type
-          [Hash]
-        end
+        [String]
       end
 
-      protected
+      def valid_values
+        definition.symbols.map{|str| str.to_s.downcase}
+      end
+    end
 
-      def union_types
-        definition.schemas.map{|schema| Type.build(schema)}
+    class StringType < AbstractType
+      def name
+        "string"
+      end
+
+      def valid_ruby_types
+        [String]
+      end
+    end
+
+    class IntegerType < AbstractType
+      def name
+        "int"
+      end
+
+      def valid_ruby_types
+        [Fixnum]
       end
+    end
 
-      def type_string
-        type = definition.type
-        type = type.type_sym.to_s if type.respond_to?(:type_sym)
-        type
+    class FloatType < AbstractType
+      def name
+        "float"
       end
 
+      def valid_ruby_types
+        [Float]
+      end
+    end
+
+    class BooleanType < AbstractType
+      def name
+        "boolean"
+      end
+
+      def valid_ruby_types
+        [TrueClass, FalseClass]
+      end
+    end
+
+    class NullType < AbstractType
+      def name
+        "null"
+      end
+      alias :to_s :name
+
+      def valid_ruby_types
+        [NilClass]
+      end
+    end
+
+    class Type
+      class << self
+        def build(definition)
+          type = type_string(definition)
+          case type
+          when "array"
+            ArrayType.new(definition)
+          when "record"
+            RecordType.new(definition)
+          when "union"
+            UnionType.new(definition)
+          when "enum"
+            EnumType.new(definition)
+          when "string"
+            StringType.new
+          when "int"
+            IntegerType.new
+          when "float"
+            FloatType.new
+          when "boolean"
+            BooleanType.new
+          when "null"
+            NullType.new
+          else
+            raise "unknown type: #{type}"
+          end
+        end
+
+        def type_string(definition)
+          type_string = definition.type
+          type_string = type_string.type_sym.to_s if type_string.respond_to?(:type_sym)
+          type_string
+        end
+      end
     end
   end
-end
+end

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

@@ -25,12 +25,12 @@ a href=to(version.version)
               ul
                 - endpoint.parameters.each do |parameter|
                   li
-                    => parameter.type
+                    => parameter.type.name
                     = parameter.name
 
               h4 Response
               p 
-                = endpoint.response_type
+                = endpoint.response_type.name
 
   .col-md-4
     h2 Types
@@ -44,13 +44,16 @@ a href=to(version.version)
                 = type.name
           .panel-collapse.collapse.in id="collapse#{type.name}"
             .panel-body
+              - type.valid_values.each do |value|
+                p = value
               - type.fields.each do |field|
                 p
-                  a.pull-right data-toggle="collapse" href="#collapseDescription#{type.name}#{field.name}"
+                  - if field.doc
+                    a.pull-right data-toggle="collapse" href="#collapseDescription#{type.name}#{field.name}"
                     i.glyphicon.glyphicon-info-sign
-                  => field.type
+                  => field.type.name
                   | -
                   =< field.name
                 - if field.doc
                   p.collapse id="collapseDescription#{type.name}#{field.name}"
-                    em = field.doc
+                    em = field.doc

data/lib/service_contract/mock.rb

@@ -33,11 +33,11 @@ module ServiceContract
       end
 
       def mock_value(field)
-        if field.array?
+        if field.subtype
           Array.new(3) do
             mock_value(field.subtype)
           end
-        elsif field.complex?
+        elsif !field.fields.empty?
           # recursively mock values
           mock_fields(field)
         else
@@ -51,8 +51,8 @@ module ServiceContract
           when "boolean", :boolean
             [true, false].sample
           end
-        end        
+        end
       end
     end
   end
-end
+end

data/lib/service_contract/version.rb

@@ -1,3 +1,3 @@
 module ServiceContract
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/test/assertions_test.rb

@@ -78,4 +78,33 @@ class AssertionsTest < Minitest::Test
 
   end
 
-end
+  def test_enum_values
+    service = SampleService.find(2)
+    assert service, "expect to find a service by version"
+
+    protocol = service.protocol("social_login")
+    endpoint = protocol.endpoint("index")
+
+    data = [
+      {token: "sometoken", provider: "facebook"},
+      {token: "anothertoken", provider: "linkedin"}
+    ]
+
+    assert_endpoint_response(data, endpoint)
+
+    # test can be nil
+    bad_data = [
+      {token: "sometoken", provider: "bad provider"}
+    ]
+    failure_data = nil
+    begin
+      assert_endpoint_response(bad_data, endpoint)
+    rescue Minitest::Assertion => failure
+      failure_data = failure
+    end
+
+    assert !failure_data.nil?
+    assert failure_data.to_s.include?("is not an allowed value"), failure_data
+  end
+
+end

data/test/sample/2/compiled/social_login.avpr

@@ -0,0 +1,28 @@
+{
+  "protocol" : "SocialLogin",
+  "namespace" : "Gnomon",
+  "types" : [ {
+    "type" : "enum",
+    "name" : "SocialNetwork",
+    "symbols" : [ "FACEBOOK", "GOOGLE", "TWITTER", "LINKEDIN" ]
+  }, {
+    "type" : "record",
+    "name" : "Authorization",
+    "fields" : [ {
+      "name" : "token",
+      "type" : "string"
+    }, {
+      "name" : "provider",
+      "type" : "SocialNetwork"
+    } ]
+  } ],
+  "messages" : {
+    "index" : {
+      "request" : [ ],
+      "response" : {
+        "type" : "array",
+        "items" : "Authorization"
+      }
+    }
+  }
+}

data/test/sample/2/source/social_login.avdl

@@ -0,0 +1,16 @@
+@namespace("Gnomon")
+
+protocol SocialLogin {
+
+  enum SocialNetwork {
+    FACEBOOK, GOOGLE, TWITTER, LINKEDIN
+  }
+
+  record Authorization {
+    string token;
+
+    SocialNetwork provider;
+  }
+
+  array<Authorization> index();
+}

data/test/service_test.rb

@@ -68,9 +68,22 @@ class ServiceTest < Minitest::Test
 
     field_type = field.type
 
-    assert_equal('union', field_type.name)
-    assert_equal('null, int, Array(int)', field_type.to_s)
+    assert_equal('Union(null, int, Array(int))', field_type.name)
     assert_equal([NilClass, Fixnum, Array], field_type.valid_ruby_types)
   end
 
-end
+  def test_enum_types
+    service = SampleService.find(2)
+    protocol = service.protocol('social_login')
+    type = protocol.type('Authorization')
+
+    field = type.fields.detect{|field| field.name == 'provider'}
+    assert(field, 'expected to find a provider field')
+
+    field_type = field.type
+
+    assert_equal('Enum(SocialNetwork)', field_type.name)
+    assert_equal([String], field_type.valid_ruby_types)
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_contract
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-08 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -89,13 +89,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - 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
@@ -127,7 +127,9 @@ files:
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
 - test/sample/2/compiled/search_param.avpr
+- test/sample/2/compiled/social_login.avpr
 - test/sample/2/source/search_param.avdl
+- test/sample/2/source/social_login.avdl
 - test/service_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -164,6 +166,9 @@ test_files:
 - test/sample/1/source/location.avdl
 - test/sample/1/source/sales_region.avdl
 - test/sample/2/compiled/search_param.avpr
+- test/sample/2/compiled/social_login.avpr
 - test/sample/2/source/search_param.avdl
+- test/sample/2/source/social_login.avdl
 - test/service_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/lib/service_contract/abstract_field.rb

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