service_contract 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a89e3a05c63f0cd654e67c928d715402fa1c944
-  data.tar.gz: 6080110653f611f5cfbe03ec81612f52b60f60a9
+  metadata.gz: 8533a9479365f0e1fe622726619e7d269df19251
+  data.tar.gz: 152c90e5d6a2ce67720ba9de55998225801d2feb
 SHA512:
-  metadata.gz: 548643b68055c8241f3c8d7746b1c08255d935c5f33584961b58e81598635449d4858aabf2fffed729da10a437e726aa34323a0098d4c957e60db1d4896bfb0c
-  data.tar.gz: f03f58fa109ceb830b2dd3eb8f79db36058471d07c48b27cce7b8db954348518a6fa2c9e93f3763efd682ad477bc5c11af4fb2154eb6e8041b8b118e382ce02a
+  metadata.gz: b13fb54905469260e43b5bc26c2840ca2ddfc32e35a3a240b884070aec49ba27ecafb6ba5b8ae667a8cee83593b6b0a4ebfb4d6fe50eda0f5472afc3f76f382c
+  data.tar.gz: 9aa632cd295c6a161544150cb0a5d83568fdf3d6dbf0bd1e09ca77bba52d763c33e3928fed2a2f63d53652497f44f736d327247ede0aec0ec05b7ffb1f5b4335

data/Gemfile

@@ -3,4 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in service_contract.gemspec
 gemspec
 
-gem 'codeclimate-test-reporter', group: 'test', require: nil
+group :test do
+  gem 'codeclimate-test-reporter', require: nil
+  gem 'random-word'
+end

data/lib/service_contract/assertions.rb

@@ -7,7 +7,7 @@ module ServiceContract
 
     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"
+        assert data.is_a?(Array), "expected #{type.name} to be an Array; instead got: #{data.inspect} (#{data.class.name})"
         data.each do |datum|
           assert_data_matches_type(datum, type.subtype, allow_nil)
         end
@@ -28,7 +28,7 @@ module ServiceContract
         end
       else
         # type is a scalar
-        assert (allow_nil && data.nil?) || type.valid_ruby_types.any?{|klass| data.is_a?(klass)}, "foo"
+        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})"
       end
     end
 

data/lib/service_contract/avro/endpoint.rb

@@ -54,9 +54,8 @@ module ServiceContract
 
       # seems kinda hacky
       def member?
-        first_field_type = request.fields.first.type
-        first_field_type.complex? &&
-          first_field_type.name == protocol.main_type
+        first_param_type = parameters.first.type
+        first_param_type.complex? && first_param_type.name == protocol.main_type
       end
     end
   end

data/lib/service_contract/mock.rb

@@ -0,0 +1,58 @@
+require 'random-word'
+
+module ServiceContract
+  class Mock
+    class << self
+      # generates fake data that adheres to the types defined in the service contract
+      def generate!(version)
+        mock_fields(type(version))
+      end
+
+      private
+
+      def type(version)
+        raise "not_implemented"
+      end
+
+      # can set up custom generators by field name
+      #   should be a hash of <field_name> => <lambda>
+      def customizations
+        {}
+      end
+
+      def mock_fields(type)
+        {}.tap do |res|
+          type.fields.each do |parameter|
+            if customizations.key?(parameter.name)
+              res[parameter.name] = customizations[parameter.name].call
+            else
+              res[parameter.name] = mock_value(parameter.type)
+            end
+          end
+        end
+      end
+
+      def mock_value(field)
+        if field.array?
+          Array.new(3) do
+            mock_value(field.subtype)
+          end
+        elsif field.complex?
+          # recursively mock values
+          mock_fields(field)
+        else
+          case field.name
+          when "int", :int
+            Random.new.rand(10000000)
+          when "string", :string
+            RandomWord.nouns.next
+          when "float", :float
+            Random.new.rand(10000.0)
+          when "boolean", :boolean
+            [true, false].sample
+          end
+        end        
+      end
+    end
+  end
+end

data/lib/service_contract/version.rb

@@ -1,3 +1,3 @@
 module ServiceContract
-  VERSION = "0.0.8"
+  VERSION = "0.0.10"
 end

data/lib/service_contract.rb

@@ -9,6 +9,7 @@ module ServiceContract
 
   # test hooks
   autoload :Assertions, 'service_contract/assertions'
+  autoload :Mock, 'service_contract/mock'
 
   # providers
   autoload :Avro, 'service_contract/avro'

data/service_contract.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "random-word"
 end

data/test/mock_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class LocationMock < ServiceContract::Mock
+  VALID_TYPES = %w(country state city county neighborhood postal_code)
+
+  def self.type(version)
+    SampleService.find(version).protocol("location").type("Location")
+  end
+
+  def self.customizations
+    {
+      "type" => -> { VALID_TYPES.sample }
+    }
+  end
+end
+
+class MockTest < Minitest::Test
+  include ServiceContract::Assertions
+
+  def test_mocking
+    data = Array.new(2) { LocationMock.generate!(1) }
+
+    service = SampleService.find(1)
+    protocol = service.protocol("location")
+    endpoint = protocol.endpoint("index")
+
+    assert_endpoint_response(data, endpoint)
+
+    # test customizations
+    data.each do |datum|
+      assert LocationMock::VALID_TYPES.include?(datum["type"]), "should be able to override a type generator with class level customizations"
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_contract
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
+- !ruby/object:Gem::Dependency
+  name: random-word
+  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
@@ -99,11 +113,13 @@ files:
 - lib/service_contract/avro/views/layout.slim
 - lib/service_contract/avro/views/protocol.slim
 - lib/service_contract/avro/views/version.slim
+- lib/service_contract/mock.rb
 - lib/service_contract/tasks.rb
 - lib/service_contract/version.rb
 - service_contract.gemspec
 - src/avro-tools-1.7.7.jar
 - test/assertions_test.rb
+- test/mock_test.rb
 - test/sample/1/compiled/location.avpr
 - test/sample/1/compiled/sales_region.avpr
 - test/sample/1/source/location.avdl
@@ -136,6 +152,7 @@ specification_version: 4
 summary: Abstract the definition of a service's interface contract
 test_files:
 - test/assertions_test.rb
+- test/mock_test.rb
 - test/sample/1/compiled/location.avpr
 - test/sample/1/compiled/sales_region.avpr
 - test/sample/1/source/location.avdl