response_mapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c76a14c4bd55e3571d20c84f80bb571fb611443
+  data.tar.gz: 59b49f26798a52e2ce508c0d6bfb92de67015a1f
+SHA512:
+  metadata.gz: 53f9bb135997d413a86f147749afe9aa61e2a35ba6a9723d5e4c5e59ff45b5b5045580d5d2d88a6621ed5543b1aab6e95414627e88e0ba115daa9a10517c7702
+  data.tar.gz: cb674456b6d0428fdb0ac2a0911382bbbe236f15079719200046bcbb2ec7c01554761f2470a6eeca605ed3d1e34dd95afe638a3f655454bc5b2f91553d84de52

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version
+.ruby-gemset
+*.swp
+tags
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+      - 'bin/**'
+      - 'vendor/**/*'
+      - 'eventify.gemspec'
+Metrics/LineLength:
+  Max: 80
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in response_mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sergii Makagon
+
+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,87 @@
+[![Build Status](https://travis-ci.org/smakagon/response_mapper.svg?branch=master)](https://travis-ci.org/smakagon/response_mapper)
+
+# ResponseMapper
+
+These days we all deal with many different APIs.
+It can be either third-party services, or our own microservices.
+Not all of them are well-designed and sometimes their attributes named in a really weird way.
+
+`ResponseMapper` allows to map attributes from API response to your domain language.
+
+For example:
+
+```ruby
+response = JSON.parse(response_from_api)
+# { "order_number" => 10, "order_items" => [{ order_item_id: 1, item_title: "Book" }] }
+```
+
+Once we parsed response, all keys are strings. Usually we want to do two things:
+
+1. Map response, so we can easily instantiate entity from response.
+2. Symbolize keys to keep things consistent.
+
+With `ResponseMapper` we can do this:
+
+```ruby
+mapping = { order_number: :id, order_item_id: :id,  order_items: :items, item_title: :title }
+
+order_attributes = ResponseMapper.map(data: response, mapping: mapping)
+# { id: 10, items: [{ id: 1, title: "Book" }] }
+```
+
+Now we have nice Hash with symbolized keys that correspond to attributes of `Order` in our system.
+For example further step could be just wrap this hash into `Order` entity:
+
+```ruby
+Entity::Order.new(order_attributes)
+```
+
+`ResponseMapper` maps and symbolizes keys even for nested arrays and hashes.
+It will work for more complex responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'response_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install response_mapper
+
+## Usage
+
+`ResponseMapper` provides one class method `.map` which has two required params: `data` and `mapping`.
+There is one optional parameter: `symbolize_keys` which is set to `true` by default.
+
+### data
+`data` can be anything, but `ResponseMapper` will try to map it only if it's a `Hash` or `Array`.
+If it's not a `Hash` or `Array` - `ResponseMapper` will return `data` as is.
+
+### mapping
+`mapping` should be a Hash with attributes you want to map:
+
+```
+{ order_number: :id }
+```
+
+It will map any occurence of `:order_number` in data to `:id`.
+If `mapping` is not a Hash (or empty Hash) - ResponseMapper will raise `ResponseMapper::Error`.
+
+### symbolize_keys
+`sybmolize_keys` is set to `true` by default.
+If your data contains hashes with strings as keys, they will be symbolized and then mapped.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/smakagon/response_mapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]
+
+task :console do
+  exec 'irb -r response_mapper -I ./lib'
+end
+
+task :build do
+  system 'gem build response_mapper.gemspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "response_mapper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/response_mapper.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Allows to map API response to domain language of your application
+#
+# ResponseMapper.map(
+#   data: { order_number: 1, order_items: [1,2,3] }
+#   mapping: { order_number: :id, order_items: :items }
+# )
+#
+# Returns nice Hash with proper naming
+# which could be used to instantiate order entity:
+# { id: 1, items: [1,2,3] }
+#
+class ResponseMapper
+  VERSION = '0.1.0'
+
+  Error = Class.new(StandardError)
+
+  def self.map(data:, mapping:, symbolize_keys: true)
+    new(data, mapping, symbolize_keys).map
+  end
+
+  def map
+    map_data(data)
+  end
+
+  private
+
+  attr_reader :data, :mapping, :symbolize_keys
+
+  def initialize(data, mapping, symbolize_keys)
+    @data = data
+    @mapping = mapping
+    @symbolize_keys = symbolize_keys
+
+    validate_mapping
+  end
+
+  def map_data(data)
+    case data
+    when Hash then map_hash(data)
+    when Array then map_array(data)
+    else
+      data
+    end
+  end
+
+  def map_hash(hash)
+    hash.each_with_object({}) do |(k, v), result|
+      k = k.to_sym if symbolize_keys
+
+      mapped_value = [Hash, Array].include?(v.class) ? map_data(v) : v
+      mapped_key = mapping.fetch(k, k)
+
+      result[mapped_key] = mapped_value
+    end
+  end
+
+  def map_array(array)
+    array.each_with_object([]) do |entity, arr|
+      if [Hash, Array].include?(entity.class)
+        arr.push(map_data(entity))
+      else
+        arr.push(mapping.fetch(entity, entity))
+      end
+    end
+  end
+
+  def validate_mapping
+    # rubocop:disable Style/GuardClause
+    if !mapping.is_a?(Hash) || mapping&.empty?
+      raise Error, 'Please, provide Hash with mapping, for example: { order_number: :id }' # rubocop:disable LineLength
+    end
+  end
+end

data/response_mapper.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'response_mapper'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'response_mapper'
+  spec.version       = ResponseMapper::VERSION
+  spec.authors       = ['Sergii Makagon']
+  spec.email         = ['makagon87@gmail.com']
+
+  # rubocop:disable LineLength
+  spec.summary       = 'Allows to map API response to domain language of your application'
+  spec.description   = 'Usually API returns data with naming that might not be the best fit for your application. You can map customer_id to user_id with ResponseMapper easily.'
+  spec.homepage      = 'https://github.com/smakagon/response_mapper'
+  spec.license       = 'MIT'
+  # rubocop:enable LineLength
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: response_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergii Makagon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Usually API returns data with naming that might not be the best fit for
+  your application. You can map customer_id to user_id with ResponseMapper easily.
+email:
+- makagon87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/response_mapper.rb
+- response_mapper.gemspec
+homepage: https://github.com/smakagon/response_mapper
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Allows to map API response to domain language of your application
+test_files: []