Add PoC for resource serializers

6 files changed, 79 insertions, 0 deletions

diff --git a/app/serializers/base_serializer.rb b/app/serializers/base_serializer.rb
new file mode 100644
index 00000000000..f9f7135551b
--- /dev/null
+++ b/app/serializers/base_serializer.rb
@@ -0,0 +1,24 @@
+class BaseSerializer
+  def initialize(request = {})
+    @request = EntityRequest.new(request)
+    @opts = { request: @request }
+  end
+
+  def set(opts)
+    @request.merge!(opts)
+    self
+  end
+
+  def represent(resource, opts = {})
+    self.class.entity_class
+      .represent(resource, @opts.reverse_merge(opts))
+  end
+
+  def self.entity(entity_class)
+    @entity_class ||= entity_class
+  end
+
+  def self.entity_class
+    @entity_class
+  end
+end
diff --git a/app/serializers/entity_request.rb b/app/serializers/entity_request.rb
new file mode 100644
index 00000000000..12ceb38b284
--- /dev/null
+++ b/app/serializers/entity_request.rb
@@ -0,0 +1,16 @@
+class EntityRequest
+  # We use EntityRequest object to collect parameters and variables
+  # from the controller. Because options that are being passed to the entity
+  # do appear in each entity object  in the chain, we need a way to pass data
+  # that is present in the controller (see  #20045).
+  #
+  def initialize(parameters)
+    merge!(parameters)
+  end
+
+  def merge!(parameters)
+    parameters.each do |key, value|
+      define_singleton_method(key) { value }
+    end
+  end
+end
diff --git a/app/serializers/environment_entity.rb b/app/serializers/environment_entity.rb
new file mode 100644
index 00000000000..9415f1dd450
--- /dev/null
+++ b/app/serializers/environment_entity.rb
@@ -0,0 +1,17 @@
+class EnvironmentEntity < Grape::Entity
+  include RequestAwareEntity
+  include Gitlab::Routing.url_helpers
+
+  expose :id
+  expose :name
+  expose :project, with: ProjectEntity
+  expose :last_deployment,
+    as: :deployment,
+    using: API::Entities::Deployment
+
+  expose :environment_path
+
+  def environment_path
+    request.path
+  end
+end
diff --git a/app/serializers/environment_serializer.rb b/app/serializers/environment_serializer.rb
new file mode 100644
index 00000000000..91955542f25
--- /dev/null
+++ b/app/serializers/environment_serializer.rb
@@ -0,0 +1,3 @@
+class EnvironmentSerializer < BaseSerializer
+  entity EnvironmentEntity
+end
diff --git a/app/serializers/project_entity.rb b/app/serializers/project_entity.rb
new file mode 100644
index 00000000000..b8e23db470b
--- /dev/null
+++ b/app/serializers/project_entity.rb
@@ -0,0 +1,8 @@
+class ProjectEntity < Grape::Entity
+  expose :id
+  expose :name
+
+  expose :test do |project|
+    'something'
+  end
+end
diff --git a/app/serializers/request_aware_entity.rb b/app/serializers/request_aware_entity.rb
new file mode 100644
index 00000000000..f6b6f64d0f8
--- /dev/null
+++ b/app/serializers/request_aware_entity.rb
@@ -0,0 +1,11 @@
+module RequestAwareEntity
+  # We use SerializableRequest class to collect parameters and variables
+  # from the controller. Because options that are being passed to the entity
+  # are appear in each entity in the chain, we need a way to access data
+  # that is present in the controller (see  #20045).
+  #
+  def request
+    options[:request] ||
+      raise(StandardError, 'Request not set!!')
+  end
+end