Creates Ioki::Support module (#83)

lib/ioki.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'ioki/support'
 require 'ioki/configuration'
 require 'ioki/model'
 require 'ioki/error'

lib/ioki/model/base.rb

@@ -5,6 +5,8 @@
 module Ioki
   module Model
     class Base
+      extend Ioki::Support::ModuleMixins
+
       class << self
         def class_instance_attribute_definitions
           @class_instance_attribute_definitions ||= {}
@@ -58,12 +60,6 @@ def attribute_definitions
             collect(&:class_instance_attribute_definitions).
             reduce(&:merge)
         end
-
-        def descendants
-          ObjectSpace.each_object(singleton_class).reject do |k|
-            k.singleton_class? || k == self
-          end
-        end
       end
 
       attr_accessor :_raw_attributes, :_attributes, :_etag
@@ -147,7 +143,7 @@ def serialize(usecase = :read)
 
           next if definition.key?(:omit_if_blank_on) &&
                   Array(definition[:omit_if_blank_on]).include?(usecase) &&
-                  empty?(value)
+                  Ioki::Support.blank?(value)
 
           data[attribute] = if definition[:type] == :object && value.is_a?(Ioki::Model::Base)
                               value.serialize(usecase)
@@ -174,16 +170,9 @@ def reset_attributes!
       end
 
       def constantize_in_module(class_name)
-        return nil if empty?(class_name)
-
-        module_names = self.class.name.split('::')
-        module_names.slice!(-1, 1)
-        module_names << class_name
-        Object.const_get(module_names.join('::'))
-      end
+        return nil if Ioki::Support.blank?(class_name)
 
-      def empty?(value)
-        value.respond_to?(:empty?) ? !!value.empty? : !value
+        self.class.module_parent.const_get class_name
       end
     end
   end

lib/ioki/model/driver/base.rb

@@ -3,13 +3,6 @@
 module Ioki
   module Model
     module Driver
-      def self.valid_models
-        constants.
-          select { |constant| const_get(constant).is_a?(Class) }.
-          reject { |constant| const_get(constant).unvalidated? }.
-          map { |model| const_get(model) } - [Base]
-      end
-
       class Base < Ioki::Model::Base
         def self.specification_scope
           'driver_api'

lib/ioki/model/operator/base.rb

@@ -3,13 +3,6 @@
 module Ioki
   module Model
     module Operator
-      def self.valid_models
-        constants.
-          select { |constant| const_get(constant).is_a?(Class) }.
-          reject { |constant| const_get(constant).unvalidated? }.
-          map { |model| const_get(model) } - [Base]
-      end
-
       class Base < Ioki::Model::Base
         attribute :id,         on: :read, type: :string
         attribute :type,       on: :read, type: :string

lib/ioki/model/passenger/base.rb

@@ -3,13 +3,6 @@
 module Ioki
   module Model
     module Passenger
-      def self.valid_models
-        constants.
-          select { |constant| const_get(constant).is_a?(Class) }.
-          reject { |constant| const_get(constant).unvalidated? }.
-          map { |model| const_get(model) } - [Base]
-      end
-
       class Base < Ioki::Model::Base
         def self.specification_scope
           'passenger_api'

lib/ioki/model/platform/base.rb

@@ -3,13 +3,6 @@
 module Ioki
   module Model
     module Platform
-      def self.valid_models
-        constants.
-          select { |constant| const_get(constant).is_a?(Class) }.
-          reject { |constant| const_get(constant).unvalidated? }.
-          map { |model| const_get(model) } - [Base]
-      end
-
       class Base < Ioki::Model::Base
         def self.specification_scope
           'platform_api--v20210101'

lib/ioki/support.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Ioki
+  # These are methods which are adapted from ActiveSupport
+  module Support
+    # activesupport/lib/active_support/core_ext/string/inflections.rb
+    # But it doesn't support uppercase_first_letter argument and inflections
+    def camelize(term)
+      string = term.to_s.sub(/^[a-z\d]*/) { |match| match.capitalize! || match }
+      string.gsub!(%r{(?:_|(/))([a-z\d]*)}i) do
+        word = Regexp.last_match(2)
+        substituted = word.capitalize! || word
+        Regexp.last_match(1) ? "::#{substituted}" : substituted
+      end
+      string
+    end
+
+    # activesupport/lib/active_support/core_ext/object/blank.rb
+    def blank?(value)
+      value.respond_to?(:empty?) ? !!value.empty? : !value
+    end
+
+    module_function :camelize, :blank?
+
+    module ModuleMixins
+      # activesupport/lib/active_support/core_ext/module/introspection.rb
+      def module_parent_name
+        if defined?(@parent_name)
+          @parent_name
+        else
+          parent_name = name =~ /::[^:]+\z/ ? -Regexp.last_match.pre_match : nil
+          @parent_name = parent_name unless frozen?
+          parent_name
+        end
+      end
+
+      # activesupport/lib/active_support/core_ext/module/introspection.rb
+      def module_parent
+        module_parent_name ? Object.const_get(module_parent_name) : Object
+      end
+
+      # activesupport/lib/active_support/core_ext/class/subclasses.rb
+      def descendants
+        ObjectSpace.each_object(singleton_class).reject do |k|
+          k.singleton_class? || k == self
+        end
+      end
+    end
+  end
+end

lib/ioki/webhooks/event.rb

@@ -15,25 +15,13 @@ def model_class
       end
 
       def model_class_name
-        camelize data['type']
+        Ioki::Support.camelize data['type']
       end
 
       def action
         event_type&.split('.')&.last
       end
 
-      private
-
-      def camelize(term)
-        string = term.to_s.sub(/^[a-z\d]*/) { |match| match.capitalize! || match }
-        string.gsub!(%r{(?:_|(/))([a-z\d]*)}i) do
-          word = Regexp.last_match(2)
-          substituted = word.capitalize! || word
-          Regexp.last_match(1) ? "::#{substituted}" : substituted
-        end
-        string
-      end
-
     end
   end
 end

lib/ioki/webhooks/signature_validator.rb

@@ -24,9 +24,9 @@ def initialize(body:, signature:)
       end
 
       def call
-        raise Ioki::Error::WebhookSignatureMissing if blank? @signature
-        raise Ioki::Error::WebhookBodyMissing if blank? @body
-        raise Ioki::Error::WebhookSignatureKeyMissing if blank? ENV['WEBHOOK_SIGNATURE_KEY']
+        raise Ioki::Error::WebhookSignatureMissing if Ioki::Support.blank? @signature
+        raise Ioki::Error::WebhookBodyMissing if Ioki::Support.blank? @body
+        raise Ioki::Error::WebhookSignatureKeyMissing if Ioki::Support.blank? ENV['WEBHOOK_SIGNATURE_KEY']
         raise Ioki::Error::WebhookSignatureInvalid unless OpenSSL.secure_compare @signature, calculated_signature
       end
 
@@ -39,10 +39,6 @@ def calculated_signature
           @body                          # Second: The data to verify
         )
       end
-
-      def blank?(val)
-        val.nil? || val == ''
-      end
     end
   end
 end

spec/ioki/model/base_spec.rb

@@ -145,7 +145,7 @@
         model = example_class.new({})
         expect(model.foo).to be_nil
         model.foo = { bar: 42 }
-        expect(model.foo).to be_kind_of(described_class)
+        expect(model.foo).to be_kind_of(example_referenced_class)
         expect(model.foo.bar).to eq(42)
       end
     end
@@ -181,9 +181,9 @@
         expect(model.foo).to be_nil
         model.foo = [{ bar: '42' }, { bar: '43' }]
         expect(model.foo).to be_kind_of(Array)
-        expect(model.foo.first).to be_kind_of(described_class)
+        expect(model.foo.first).to be_kind_of(example_referenced_class)
         expect(model.foo.first.bar).to eq(42)
-        expect(model.foo.last).to be_kind_of(described_class)
+        expect(model.foo.last).to be_kind_of(example_referenced_class)
         expect(model.foo.last.bar).to eq(43)
       end
     end
@@ -639,4 +639,10 @@
       end
     end
   end
+
+  describe '#constantize_in_module' do
+    it 'returns a module of the given name in the same parent module' do
+      expect(Ioki::Model::Platform::Pause.new.send(:constantize_in_module, 'Place')).to eq Ioki::Model::Platform::Place
+    end
+  end
 end

spec/ioki/model/openapi_spec.rb

@@ -5,7 +5,7 @@
 RSpec.describe 'OpenApi schema definitions' do
   if API_SPECIFICATIONS[:platform_api]
     describe 'the platform_api definition' do
-      Ioki::Model::Platform.valid_models.each do |model|
+      Ioki::Model::Platform::Base.descendants.reject(&:unvalidated?).each do |model|
         it "ensures #{model} matches the published API specifications" do
           expect(model).to match_open_api_definition('platform_api', model)
         end
@@ -15,7 +15,7 @@
 
   if API_SPECIFICATIONS[:passenger_api]
     describe 'the passenger_api definition' do
-      Ioki::Model::Passenger.valid_models.each do |model|
+      Ioki::Model::Passenger::Base.descendants.reject(&:unvalidated?).each do |model|
         it "ensures #{model} matches the published API specifications" do
           expect(model).to match_open_api_definition('passenger_api', model)
         end
@@ -25,7 +25,7 @@
 
   if API_SPECIFICATIONS[:driver_api]
     describe 'the driver_api definition' do
-      Ioki::Model::Driver.valid_models.each do |model|
+      Ioki::Model::Driver::Base.descendants.reject(&:unvalidated?).each do |model|
         it "ensures #{model} matches the published API specifications" do
           expect(model).to match_open_api_definition('driver_api', model)
         end

spec/ioki/support_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Ioki::Support do
+  describe 'camelize' do
+    it 'works for lowercase strings' do
+      expect(described_class.camelize('task')).to eq('Task')
+    end
+
+    it 'works for underscored strings' do
+      expect(described_class.camelize('task_list')).to eq('TaskList')
+    end
+
+    it 'works for multiple underscored strings' do
+      expect(described_class.camelize('driver_vehicle_connection')).to eq('DriverVehicleConnection')
+    end
+
+    it 'works for empty strings' do
+      expect(described_class.camelize('')).to eq('')
+    end
+
+    it 'works for nil' do
+      expect(described_class.camelize(nil)).to eq('')
+    end
+  end
+end

spec/ioki/webhooks/event_spec.rb

@@ -39,10 +39,6 @@
     expect(event.action).to eq 'created'
   end
 
-  it 'can camelize strings' do
-    expect(event.send(:camelize, 'task_list')).to eq('TaskList')
-  end
-
   it 'has the correct id' do
     expect(event.id).to eq params['id']
   end