payload-translator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02ed271a4ef7404262e5cd5379853e948470c28d515d0e4f7ef2bbe7e05bc401
+  data.tar.gz: 07ca8129f964945d42f033426fb90646560516ddfdfbdc73db0efc131f537605
+SHA512:
+  metadata.gz: fb0b462ede9e4bd3b68381a4e08ce963d4f685761e2b35d4871cbb84423511eeaebdf391f8c6055a0aa10649de0cebebeeafad51bfcdada0e2bf7b68615c0f97
+  data.tar.gz: 59b5335db5bbebeb535e31cdf6c1caec6c4e9464963e2d9a0ea72d1c4dd27221a6ae25b54cd451e6e37ad4845752a6f6ab8edbfc207321f02f5c8dd4c1905b06

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Miguel Savignano
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+## Payload translator
+
+Using a yaml configuration you can transform a payload to another payload.
+Example:
+
+```yaml
+# config.yaml
+payload:
+  id:
+    $field: _id
+    $formatter: to_integer
+  user_name:
+    $field: name
+  login_type:
+    $field: login_provider
+    $map:
+      google: GOOGLE
+      twitter: TWITTER
+      auth0: APP
+  country:
+    $fnc: get_country
+```
+
+Input:
+
+```json
+// internal_payload.json
+
+{
+  "_id": 1,
+  "name": "Jhon Doe",
+  "login_provider": "auth0"
+}
+```
+
+```ruby
+translator = PayloadTranslator::Service.new(config)
+external_payload = translator.translate(internal_payload)
+```
+
+Return:
+
+```json
+// external_payload.json
+
+{
+  "id": "1",
+  "user_name": "Jhon Doe",
+  "login_type": "APP"
+}
+```
+
+## Configure handlers
+
+Resolve the field output with a custom function.
+
+```ruby
+PayloadTranslator.configure do |config|
+  config.handlers = {
+    get_country: ->(payload) { payload['name'] },
+  }
+end
+```
+
+Or per service
+
+```ruby
+PayloadTranslator::Service(config, handlers: get_country: ->(payload) { payload['name'] })
+```
+
+## Configure formatters
+
+Apply different formatters to the output.
+
+```ruby
+PayloadTranslator.configure do |config|
+  config.formatters = {
+    uppercase: ->(value) { value.upcase },
+    to_integer: ->(value) { value.to_i },
+  }
+end
+```
+
+Or formatter per service
+
+```ruby
+PayloadTranslator::Service(config, formatters: to_integer: ->(value) { value.to_i })
+```

data/lib/payload_translator/config.rb

@@ -0,0 +1,22 @@
+module PayloadTranslator
+  class Config
+    attr_reader :handlers, :formatters, :adapters_configurations
+    def initialize
+      @handlers = {}
+      @formatters = {}
+      @adapters_configurations = {}
+    end
+
+    def handlers=(value)
+      @handlers.merge!(value)
+    end
+
+    def adapters_configurations=(value)
+      @adapters_configurations.merge!(value)
+    end
+
+    def formatters=(value)
+      @formatters.merge!(value)
+    end
+  end
+end

data/lib/payload_translator/field_resolver.rb

@@ -0,0 +1,90 @@
+module PayloadTranslator
+  class FieldResolver
+    attr_reader :config, :handlers, :formatters, :configuration, :payload
+
+    def initialize(field_config, configuration)
+      @configuration = configuration
+      @handlers = configuration.handlers
+      @formatters = configuration.formatters
+      @config = field_config
+    end
+
+    def resolve(payload)
+      @payload = payload
+      if deep_object?
+        resolve_deep_object
+      elsif config["$fnc"]
+        resolve_fnc
+      elsif config["$map"]
+        resolve_map
+      else
+        resolve_value
+      end
+    end
+
+    private
+
+    def resolve_value
+      with_formatter do
+        search_value(fetch_field)
+      end
+    end
+
+    def resolve_fnc
+      call_fnc(config.fetch("$fnc"))
+    end
+
+    def resolve_map
+      value = search_value(fetch_field)
+      if config["$map_formatter"]
+        fotmatter = formatters.fetch(config["$map_formatter"].to_sym)
+        value = fotmatter.call(value)
+      end
+
+      config["$map"].fetch(value) { config["$map_default"] }
+    end
+
+    def resolve_deep_object
+      config.each_with_object({}) do |(target_name, field_config), result|
+        result[target_name] = FieldResolver.new(field_config, configuration).resolve(payload)
+      end
+    end
+
+    def search_value(field_or_fields)
+      if field_or_fields.is_a?(Array)
+        field = field_or_fields.find { |field| payload[field] }
+        payload.fetch(field) { config["$default"] }
+      else
+        payload.fetch(field_or_fields) { config["$default"] }
+      end
+    end
+
+    def with_formatter
+      return yield unless config["$formatter"]
+      formatter = formatters.fetch(config["$formatter"].to_sym)
+      formatter.call(yield)
+    end
+
+    def fetch_field
+      config.fetch("$field") do
+        call_fnc(config.fetch("$field_fnc"))
+      end
+    end
+
+    def call_fnc(name)
+      handler = handlers.fetch(name.to_sym)
+      case handler.arity
+      when 0
+        handler.call
+      when 1
+        handler.call(payload)
+      when 2
+        handler.call(payload, config)
+      end
+    end
+
+    def deep_object?
+      !config.keys.any? {|key| key =~ /\$/ }
+    end
+  end
+end

data/lib/payload_translator/service.rb

@@ -0,0 +1,31 @@
+module PayloadTranslator
+  class Service
+    attr_reader :adapt_config, :configuration
+
+    def initialize(adapter_config_or_name, handlers: {}, formatters: {})
+      @configuration = merge_configuration(handlers: handlers, formatters: formatters)
+      @adapt_config = fetch_adapter_config(adapter_config_or_name)
+    end
+
+    def merge_configuration(handlers: , formatters:)
+      PayloadTranslator::Config.new.tap do |config|
+        config.handlers = PayloadTranslator.configuration.handlers.merge(handlers)
+        config.formatters = PayloadTranslator.configuration.formatters.merge(formatters)
+      end
+    end
+
+    def translate(payload)
+      adapt_config["payload"].each_with_object({}) do |(target_name, field_config), result|
+        result[target_name] = FieldResolver.new(field_config, configuration).resolve(payload)
+      end
+    end
+
+    private
+
+    def fetch_adapter_config(adapter_config_or_name)
+      return adapter_config_or_name if adapter_config_or_name.is_a?(Hash)
+
+      PayloadTranslator.configuration.adapters_configurations.fetch(adapter_config_or_name)
+    end
+  end
+end

data/lib/payload_translator.rb

@@ -0,0 +1,17 @@
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module PayloadTranslator
+  def self.configuration
+    @@config ||= Config.new
+  end
+
+  def self.configure
+    yield(configuration)
+    configuration
+  end
+
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: payload-translator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Savignano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use configuration to transform a payload to another payload
+email: migue.masx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/payload_translator.rb
+- lib/payload_translator/config.rb
+- lib/payload_translator/field_resolver.rb
+- lib/payload_translator/service.rb
+homepage: https://github.com/devmasx/payload-translator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.11
+signing_key: 
+specification_version: 4
+summary: PayloadTranslator
+test_files: []