response_mapper 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc549437082ce5d64203d5adba12716fa3d9ac9b
-  data.tar.gz: fbde2d4b0d576363c523027659644f03e213ff57
+  metadata.gz: 115b2f49f2d22afd4ded0d05fabcc8b632e5001a
+  data.tar.gz: f4affaa06e80e1af007e4885286f6dcb16895a78
 SHA512:
-  metadata.gz: 6a85f28f3dfe0741002bcd33a512701a7edf613ebf8973bea20c560ee9080246f75deaa0a315407014dce3b4672207cd60c80dca9311da597395ba4463ad633c
-  data.tar.gz: 1e6a4aaa3a7b2e1afec8aa625674d12beddca2440919037b81b56a5490284e912693029428c25cb88131f7204767a0f42f41fd9ab21d56436b716b62bafa7168
+  metadata.gz: 7c1c5d68bd19e4478767fed125c54c61bbbd5d9807cc7985b06e9f81d1201adadcc8c384ec8106a5d266320b22bd3a78ce85a9b2363d4a432fdad126c8fa3bc7
+  data.tar.gz: 82a7c4b373f35b8003f68ac56a220d6b5ec7b0c1bfb607b73871f7f7cfe49f57e28b22e336e3efb197a005b557ee9a46edb9b15c362b0bea882798cfce8d64a4

data/README.md

@@ -1,35 +1,41 @@
 [![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 are named inconsistently.
 
-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 you to map attributes from an API response to your application’s domain language.
 
-`ResponseMapper` allows to map attributes from API response to your domain language.
+### An example of a common API response before ResponseMapper:
+```ruby
+{ "orderNumber" => 10, "orderItems" => [{ "orderItemId" 1, "itemTitle" "Book" }] }
+```
 
-For example:
+### An example of the above API response after ResponseMapper:
+```ruby
+{ id: 10, items: [{ id: 1, title: "Book" }] }
+```
 
+## What does ResponseMapper Do?
+Using the example above let’s look at a response we may get from a 3rd party API:
 ```ruby
 response = JSON.parse(response_from_api)
-# { "order_number" => 10, "order_items" => [{ order_item_id: 1, item_title: "Book" }] }
+# => { "orderNumber" => 10, "orderItems" => [{ "orderItemId" 1, "itemTitle" "Book" }] }
 ```
 
-Once we parsed response, all keys are strings. Usually we want to do two things:
-
+### 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:
+### With ResponseMapper we can do this:
 
 ```ruby
-mapping = { order_number: :id, order_item_id: :id,  order_items: :items, item_title: :title }
+mapping = { orderNumber: :id, orderItems: :items, orderItemId: :id, itemTitle: :title }
 
 order_attributes = ResponseMapper.map(data: response, mapping: mapping)
-# { id: 10, items: [{ id: 1, title: "Book" }] }
+# => { id: 10, items: [{ id: 1, title: "Book" }] }
 ```
 
-Now we have nice Hash with symbolized keys that correspond to attributes of `Order` in our system.
+Now we have a 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
@@ -58,30 +64,36 @@ 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
+ex.
+```ruby
+order_attributes = ResponseMapper.map(data: response, mapping: mapping)
+```
+
+### `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`
 `mapping` should be a Hash with attributes you want to map:
 
-```
-{ order_number: :id }
+```ruby
+mapping = { orderNumber: :id, orderItems: :items, orderItemId: :id, itemTitle: :title }
 ```
 
-It will map any occurence of `:order_number` in data to `:id`.
+It will map any occurrence of `:order_number` in data to `:id`.
 If `mapping` is not a Hash (or empty Hash) - ResponseMapper will raise `ResponseMapper::Error`.
 
-### symbolize_keys
+### `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.
 
 See [more examples here](https://github.com/smakagon/response_mapper/blob/master/examples/examples.rb).
 
+If you want to learn more, read an [article](http://rubyblog.pro/2017/09/how-to-protect-naming-conventions-when-working-with-microservices) on how `ResponseMapper` can help to protect naming conventions when working with microservices or third-party API.
+
 ## 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.

data/lib/response_mapper.rb

@@ -12,7 +12,7 @@
 # { id: 1, items: [1,2,3] }
 #
 class ResponseMapper
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 
   Error = Class.new(StandardError)
 
@@ -67,9 +67,9 @@ class ResponseMapper
   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
+    message = 'Please, provide Hash with mapping, for example: { order_number: :id }' # rubocop:disable LineLength
+    raise Error, message unless mapping.is_a?(Hash)
+
+    raise Error, message if mapping.empty?
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: response_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Sergii Makagon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler