response_mapper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c76a14c4bd55e3571d20c84f80bb571fb611443
-  data.tar.gz: 59b49f26798a52e2ce508c0d6bfb92de67015a1f
+  metadata.gz: 500f3948bcf3d5089cb999bdf6e47b3549ec5e4a
+  data.tar.gz: 6ecaba7e3dccd2c653818f5ddbe4c8a1f76759f6
 SHA512:
-  metadata.gz: 53f9bb135997d413a86f147749afe9aa61e2a35ba6a9723d5e4c5e59ff45b5b5045580d5d2d88a6621ed5543b1aab6e95414627e88e0ba115daa9a10517c7702
-  data.tar.gz: cb674456b6d0428fdb0ac2a0911382bbbe236f15079719200046bcbb2ec7c01554761f2470a6eeca605ed3d1e34dd95afe638a3f655454bc5b2f91553d84de52
+  metadata.gz: deaa2ed34d84d029e56c0f42ac0766f54caaa3cfee77816c5dc48581a06258e31e00703f20dda3e32a8fff1456d3b661c611730310eadc33acd70bc1872670c9
+  data.tar.gz: 81a381969cdc7396308589e6f4d6a6da26cc94a7824df14d5f5dd9a431162a5ad322f9e8862bb70aad027059f38a47cf54f46b0422ef3a6567287d9c2721812b

data/.rubocop.yml

@@ -3,7 +3,7 @@ AllCops:
   Exclude:
       - 'bin/**'
       - 'vendor/**/*'
-      - 'eventify.gemspec'
+      - 'examples/**'
 Metrics/LineLength:
   Max: 80
 Metrics/BlockLength:

data/README.md

@@ -39,6 +39,8 @@ Entity::Order.new(order_attributes)
 `ResponseMapper` maps and symbolizes keys even for nested arrays and hashes.
 It will work for more complex responses.
 
+See [more examples here](https://github.com/smakagon/response_mapper/blob/master/examples/examples.rb).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -78,6 +80,8 @@ If `mapping` is not a Hash (or empty Hash) - ResponseMapper will raise `Response
 `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).
+
 ## 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/examples/examples.rb

@@ -0,0 +1,45 @@
+require 'response_mapper'
+require 'dry-struct'
+
+# With basic Hash:
+response = { "foo" => "bar" }
+ResponseMapper.map(data: response, mapping: { foo: :name })
+# { name: "bar" }
+
+# With Array of strings:
+response = ["order_number", "order_items"]
+ResponseMapper.map(data: response, mapping: { "order_number" => "id" })
+# ["id", "order_items"]
+
+# With Array of Hashes it still symbolizes and maps all keys:
+response = [
+  { "order_number" => 1, "order_items" => [{"order_id" => 11, "title" => "Foo" }] },
+  { "order_number" => 2, "order_items" => [{"order_id" => 21, "title" => "Bar" }] },
+]
+
+mapping = { order_number: :id, order_items: :items, order_id: :id }
+ResponseMapper.map(data: response, mapping: mapping)
+# [
+#   { id: 1, items: [{ id: 11, title: "Foo" }]},
+#   { id: 2, items: [{ id: 21, title: "Bar" }]}
+# ]
+
+
+# Dry-Struct Example
+module Types
+  include Dry::Types.module
+end
+
+class Order < Dry::Struct::Value
+  attribute :id, Types::Strict::Int
+  attribute :amount, Types::Strict::Int
+end
+
+response = { "order_number" => 1, "total_amount" => 200 }
+mapping = { order_number: :id, total_amount: :amount }
+
+order_attributes = ResponseMapper.map(data: response, mapping: mapping)
+
+order = Order.new(order_attributes)
+order.id # => 1
+order.amount # => 200

data/lib/response_mapper.rb

@@ -2,17 +2,17 @@
 
 # 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 }
-# )
+#   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:
+# which could be used to instantiate Order entity:
 # { id: 1, items: [1,2,3] }
 #
 class ResponseMapper
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
   Error = Class.new(StandardError)
 

data/response_mapper.gemspec

@@ -13,7 +13,10 @@ Gem::Specification.new do |spec|
 
   # 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.description   = '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.'
   spec.homepage      = 'https://github.com/smakagon/response_mapper'
   spec.license       = 'MIT'
   # rubocop:enable LineLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: response_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sergii Makagon
@@ -80,8 +80,11 @@ dependencies:
     - - "~>"
       - !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.
+description: |-
+  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.
 email:
 - makagon87@gmail.com
 executables: []
@@ -98,6 +101,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/examples.rb
 - lib/response_mapper.rb
 - response_mapper.gemspec
 homepage: https://github.com/smakagon/response_mapper