umts-microservices-engine 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e81145f5bfbbeecd56413cd9b89f910bf9066cd2
-  data.tar.gz: c8e25da32da1614d9b10fbd2775796b3a867c603
+  metadata.gz: 2c498cd845409f6ef09e95e9df99569b269928fb
+  data.tar.gz: b37e6e9fd532670afe1a109a9e1ffa393a5575f1
 SHA512:
-  metadata.gz: fd700a4d1f09eadc51c3a153d83cc760e2218a133b8118b6a752b29bab84220c803e6d735d853e4aefbc368bd3b77f876f6de89991c082cc93d6ce63dbece231
-  data.tar.gz: 0496cb4a66efcd3cfbb7faf54baace1760dd9c6bab767a5aa427eea4a44dc80be8ed02d566e1556b5cad8801a42535b73861a2866a66f84169cd6716bf00db44
+  metadata.gz: 72ca82abc02906755a30b917bfcb7e2d7ba05b6e6616468ebae4af214c225fea9e14e583e9b15f32925b8f1059e3ab9a67a3c551e209faece9a1ff5538ab1fd8
+  data.tar.gz: c914a8d387381250d298cfce6a31478373cf5e15f110c0b3a978bb1190899a781d817e502c4be7056a1d409614d73c0174a6c7cc91ec1bc16a6637583a33c60d

data/app/controllers/microservices_engine/v1/data_controller.rb

@@ -31,7 +31,8 @@ module MicroservicesEngine
         data = params['content']
         data_objects = data.map { |d| d['object'] }
 
-        verify_token(params['token'])
+        # Disabled until router implements token authorization
+        # verify_token(params['token'])
         verify_build(params['build'])
 
         existing = Connection.all

data/lib/generators/install/templates/microservices_engine.rb

@@ -13,7 +13,7 @@ if [config_data['name'], config_data['uri'], config_data['security_token']].any?
 end
 
 # Make sure the URI ends with a / character
-router_uri = config['router_uri']
+router_uri = config_data['router_uri']
 
 uri = config_data['uri']
 uri += '/' if uri[-1] != '/'

data/lib/microservices_engine.rb

@@ -30,12 +30,12 @@ module MicroservicesEngine
       # ------------------------------------------------------ #
       invalid_changes = [
         cmajor > major,
-        cminor > minor && cmajor <= major,
-        crev > rev && cminor <= minor && cmajor <= major
+        cminor > minor && !(major > cmajor),
+        crev > rev && !(minor > cminor || major > cmajor)
       ]
 
       if invalid_changes.any?
-        raise 'Received version is older than existing. Now: #{build}. Given: #{b}'
+        raise "Received version is older than existing. Now: #{build}. Given: #{b}"
       end
 
       @build = b

data/lib/microservices_engine/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MicroservicesEngine
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/controllers/data_controller_spec.rb

@@ -1,15 +1,6 @@
 # frozen_string_literal: true
 require 'rails_helper'
-
-# PLANNED FOR MOVE TO OTHER FILE
-def change_build(v, b)
-  b['build'] = v
-end
-
-def relative_build(ma, mi, r)
-  [ma, mi, r].map { |ver| 1 + ver }.join('.')
-end
-# PLANNED FOR MOVE TO OTHER FILE
+require 'mse_spec_helper'
 
 describe MicroservicesEngine::V1::DataController, type: :controller do
   routes { MicroservicesEngine::Engine.routes }
@@ -19,22 +10,7 @@ describe MicroservicesEngine::V1::DataController, type: :controller do
 
   before(:each) do
     MicroservicesEngine.build = '1.1.1'
-    @data = {
-      'build': '1.1.2',
-      'token': 'TEST_ENV_VALID_TOKEN',
-      'content': [
-        {
-          'name': 'Endpoint 1',
-          'object': 'FieldTrip',
-          'url': 'http://example.com/microservices_engine/v1/data'
-        },
-        {
-          'name': 'Endpoint 2',
-          'object': 'Survey',
-          'url': 'http://potatoes.com/microservices_engine/v1/data'
-        }
-      ]
-    }
+    @data = build_basic_data
     @changed_data = @data.deep_dup # A version of data that is changed for tests
   end
 
@@ -52,23 +28,21 @@ describe MicroservicesEngine::V1::DataController, type: :controller do
         expect { process :register, method: :post, params: @data }.not_to raise_error
       end
 
-      it 'denies invalid token' do
-        # 1. Change base data to be an invalid token
-        # 2. Expect the request to cause an error.
+      # This test is disabled until the router implements the appropriate logic
+      # it 'denies invalid token' do
+      # 1. Change base data to be an invalid token
+      # 2. Expect the request to cause an error.
 
-        @changed_data['token'] = 'mayonnaise_is_not_an_instrument_patrick'
-        expect { process :register, method: :post, params: @changed_data }.to raise_error(SecurityError)
-      end
+      #   @changed_data['token'] = 'mayonnaise_is_not_an_instrument_patrick'
+      #   expect { process :register, method: :post, params: @changed_data }.to raise_error(SecurityError)
+      # end
     end
 
     # The request updates the build version properly
     describe 'updating MicroservicesEngine.build' do
       context 'failing builds' do
-        failing_builds = [0, -1].repeated_permutation(3).to_a.map { |bld| relative_build(*bld) }
-        failing_builds -= ['1.1.1'] # this is a result of above but is a valid build
-
-        failing_builds.each do |failing_build|
-          it 'fails with older version #{failing_build}' do
+        failing_semantic_builds.each do |failing_build|
+          it "fails with older version #{failing_build}" do
             change_build(failing_build, @changed_data)
             expect { process :register, method: :post, params: @changed_data }.to raise_error(RuntimeError)
           end
@@ -76,10 +50,8 @@ describe MicroservicesEngine::V1::DataController, type: :controller do
       end
 
       context 'passing builds' do
-        passing_builds = [0, 1].repeated_permutation(3).to_a.map { |bld| relative_build(*bld) }
-
-        passing_builds.each do |passing_build|
-          it 'passes with newer version #{passing_build}' do
+        passing_semantic_builds.each do |passing_build|
+          it "passes with newer version #{passing_build}" do
             change_build(passing_build, @changed_data)
             expect(MicroservicesEngine.build).to eq('1.1.1')
             process :register, method: :post, params: @changed_data

data/spec/microservices_engine_spec.rb

@@ -2,7 +2,96 @@
 require 'spec_helper'
 
 class MicroservicesEngineTest < ActiveSupport::TestCase
-  test 'truth' do
-    assert_kind_of Module, MicroservicesEngine
+  describe MicroservicesEngine do
+    before(:each) do
+      MicroservicesEngine.build = '1.1.1'
+      @expected = {
+        'name': '',
+        'uri': '',
+        'security_token': '',
+        'router_uri': '',
+        'accessible_models': ''
+      }
+      allow(MicroservicesEngine).to receive(:config).and_return(@expected)
+      allow(MicroservicesEngine).to receive(:reload_config).and_return(@expected)
+    end
+
+    describe 'build= and build' do
+      context 'failing builds' do
+        failing_semantic_builds.each do |failing_build|
+          it "fails with older version #{failing_build}" do
+            expect { MicroservicesEngine.build = failing_build }.to raise_error(RuntimeError)
+          end
+        end
+      end
+
+      context 'passing builds' do
+        passing_semantic_builds.each do |passing_build|
+          it "passes with newer version #{passing_build}" do
+            expect(MicroservicesEngine.build).to eq('1.1.1')
+            MicroservicesEngine.build = passing_build
+            expect(MicroservicesEngine.build).to eq(passing_build)
+          end
+        end
+      end
+    end
+
+    # Because they are alias methods, both are tested at once
+    describe 'reload_config and config' do
+      # With this test, we can effectively only test
+      # one of the methods and actually be testing both
+      it 'does the same thing' do
+        expect(MicroservicesEngine.reload_config)
+          .to be(MicroservicesEngine.config)
+      end
+
+      it 'loads the config' do
+        expect(MicroservicesEngine.config)
+          .to eq(@expected)
+      end
+
+      it 'loads the new config' do
+        @expected['name'] = 'potatoes'
+        expect(MicroservicesEngine.config)
+          .to eq(@expected)
+      end
+    end
+
+    describe 'valid_token?' do
+      context 'on test environment' do
+        it 'accepts valid token' do
+          expect(MicroservicesEngine.valid_token?('TEST_ENV_VALID_TOKEN'))
+            .to be(true)
+        end
+
+        it 'refuses invalid token' do
+          expect(MicroservicesEngine.valid_token?('POTATOES_ARE_INVALID'))
+            .to be(false)
+        end
+      end
+
+      context 'not on test environment' do
+        before(:each) do
+          @expected['security_token'] = 'PROD_ENV_VALID_TOKEN'
+          allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new('production'))
+        end
+
+        it 'raises an error with no token config' do
+          @expected['security_token'] = ''
+          expect { MicroservicesEngine.valid_token?(':thinking:') }
+            .to raise_error(RuntimeError)
+        end
+
+        it 'accepts valid token' do
+          expect(MicroservicesEngine.valid_token?('PROD_ENV_VALID_TOKEN'))
+            .to be(true)
+        end
+
+        it 'refuses invalid token' do
+          expect(MicroservicesEngine.valid_token?('POTATOES_ARE_STILL_INVALID'))
+            .to be(false)
+        end
+      end
+    end
   end
 end

data/spec/models/connection_spec.rb

@@ -20,9 +20,9 @@ describe MicroservicesEngine::Connection do
   end
 
   describe 'self.get' do
-    # it 'implies params' do
-    #   expect(@conn).to receive(:get).with(@path, {})
-    #   resp = MicroservicesEngine::Connection.get('ExampleModel', @path)
-    # end
+    it 'implies params' do
+      expect_only_instance_of(MicroservicesEngine::Connection).to receive(:get).with(@path, {})
+      MicroservicesEngine::Connection.get('ExampleModel', @path)
+    end
   end
 end

data/spec/mse_spec_helper.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# -- Changes that directly affect RSpec -- #
+module RSpec
+  module Mocks
+    ::RSpec::Mocks::ExampleMethods.class_exec do
+      def expect_only_instance_of(klass)
+        expect(klass.count).to be(1)
+        AnyInstanceExpectationTarget.new(klass)
+      end
+    end
+  end
+end
+# ---------------------------------------- #
+
+# Changes the build key of a request
+# Params:
+# +v+:: The value to change the key to
+# +b+:: The build request to change
+def change_build(v, b)
+  b['build'] = v
+end
+
+# Takes in a series of semantic versions (major, minor, revision)
+# changes and outputs a new semantic version based off of 1.1.1
+# Params:
+# +major+:: Change in major version
+# +minor+:: Change in minor version
+# +revision+:: Change in revision version
+def relative_build(major, minor, revision)
+  # Example usage:
+  # relative_build(1, -1, 0) = 2.0.1
+  # relative_build(0, 0, 0) = 1.1.1
+  [major, minor, revision].map { |ver| 1 + ver }.join('.')
+end
+
+# Returns a basic set fo a build data for integration testing
+def build_basic_data
+  {
+    'build': '1.1.2',
+    'token': 'TEST_ENV_VALID_TOKEN',
+    'content': [
+      {
+        'name': 'Endpoint 1',
+        'object': 'FieldTrip',
+        'url': 'http://example.com/microservices_engine/v1/data'
+      },
+      {
+        'name': 'Endpoint 2',
+        'object': 'Survey',
+        'url': 'http://potatoes.com/microservices_engine/v1/data'
+      }
+    ]
+  }
+end
+
+# Gives a list of all changes to a semantic build that are invalid
+def failing_semantic_builds
+  [0, -1]
+    .repeated_permutation(3)
+    .to_a.map { |bld| relative_build(*bld) } - ['1.1.1']
+end
+
+# Gives a list of all changes to a semantic build that are valid
+def passing_semantic_builds
+  base = [0, 1]
+         .repeated_permutation(3)
+         .to_a.map { |bld| relative_build(*bld) }
+  base + ['2.0.0', '2.1.0', '2.0.1', '1.2.0']
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: umts-microservices-engine
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - UMass Transportation Services
@@ -134,6 +134,7 @@ files:
 - spec/microservices_engine/install_generator_spec.rb.old
 - spec/microservices_engine_spec.rb
 - spec/models/connection_spec.rb
+- spec/mse_spec_helper.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/umts/microservices-engine
@@ -165,5 +166,6 @@ test_files:
 - spec/microservices_engine/install_generator_spec.rb.old
 - spec/microservices_engine_spec.rb
 - spec/models/connection_spec.rb
+- spec/mse_spec_helper.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb