rest-service-client 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c37e95966924381049dab3f9deacb8ea478be2ae
-  data.tar.gz: f8cee3614200f6a6ddad42abbcf0f7a104160b42
+  metadata.gz: 9ac0a3ad05b3b3b3d9e17840d32c9d8e7844a73c
+  data.tar.gz: ff5156657486903f275ac4ec8eb531ecc99a9866
 SHA512:
-  metadata.gz: 711aacdeabfc911e55c603f0fbb5f42d388782ad1702ea7a7d187fd3ed1d3ab9518b75f59268c224d8ce003c7440142a56f86d9c1f97f0d4b775fea7c3f6d229
-  data.tar.gz: 3e1f7ef761e81d6b6c411c23d8d1258c672f03d5fb0677418b90fb3b76fdc90f16e4c6ef8ade505a680fbbe8742d0d128c79b91fbfef87055e8fd0d2430ba77a
+  metadata.gz: 141e9f10a76baa1d2a4c8e1a14b704fcb3f354b632ef692ba6a8c0639a42dcb348edbc778f09b05a91052466285d2d83bcd5f755c188cdb458819c34967b4f62
+  data.tar.gz: c53e460873fefdcf7f39077fe8170d64b0290931cc747407a3ce72702a5f30839be2f885b2dd86d1efcaebb4de90d276c60eba0a8174ddbec5a3eb8e760dd3eb

data/README.md

@@ -1,4 +1,6 @@
 # Rest Service Client
+[![Gem Version](https://badge.fury.io/rb/rest-service-client.svg)](https://badge.fury.io/rb/rest-service-client)
+
 
 ## Installation
 
@@ -34,7 +36,7 @@ class MyAwesomeService
 
     # Sets the default headers for every requests.
     # Will be replaced using: MyAwesomeService.new.find_photo(id: 1, headers: { 'Authorization' => 'Bearer 123456' })
-    headers 'Authorization' => 'OAuth 1111|111'
+    headers Authorization: 'OAuth 1111|111'
 
     # Sets the default params for every requests.
     # Will be replaced using: MyAwesomeService.new.find_photo(id: 20)
@@ -92,7 +94,7 @@ p service.photo(id: 10)['id']
 class SimpleService
   include RestServiceClient
   host 'https://jsonplaceholder.typicode.com'
-  get :photo, '/photos/:id', { id: 1 }
+  get :photo, '/photos/:id', params: { id: 1 }
 end
 
 service = SimpleService.new
@@ -104,8 +106,7 @@ p service.photo(id: 2)['id']  # 2
 class SimpleService
   include RestServiceClient
   host 'https://jsonplaceholder.typicode.com'
-  
-  get :first_photo, '/photos/1', {}, { Authentication: 'my-token' }
+  get :first_photo, '/photos/1', headers: { Authentication: 'my-token' }
 end
 
 service = SimpleService.new
@@ -189,8 +190,12 @@ class SimpleService
   include RestServiceClient
   debug true
   host 'https://jsonplaceholder.typicode.com'
-  headers key1: 'value1', 'key2': 'value2'
-  get :photo, '/photos/1'
+  headers key1: 'value1', 'key2' => 'value2'
+  get :photo, 
+      '/photos/:id', 
+      params: { id: 1 }, 
+      headers: { key3: 'value3' },
+      payload: { data: { type: 'get_photo_by_id' }}
 end
 
 service = SimpleService.new
@@ -199,8 +204,8 @@ service.photo
  ______
 |
 |  SimpleService is processing GET request to https://jsonplaceholder.typicode.com/photos/1
-|    Headers: {:key1=>"value1", :key2=>"value2"}
-|    Payload: {}
+|    Headers: {:key1=>"value1", "key2"=>"value2", :key3=>"value3"}
+|    Payload: {:data=>{:type=>"get_photo_by_id"}}
 |
 |  SimpleService is processing the response on GET request to https://jsonplaceholder.typicode.com/photos/1
 |    Status: 200
@@ -215,7 +220,84 @@ service.photo
 =end
 
 ```
+## Serializer
+
+By the default RestServiceClient uses JSON serializer and returns the arrays and hashes
+with key as string
+
+You can use custom serializer.
+For do this, create a serializer class with `self.deserialize` method which 
+gets the one argument with response body and returns whatever you want.
+
+And you need to add your serializer to your service using: 
+`serializer MyAwesomSerializer`
+
+### Example
+```ruby
+  class Photo
+    attr_accessor :id, :title, :album_id
+  end
+
+  class PhotoSerializer
+    class Object::String
+      def underscore
+        gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+    end
+
+    def self.deserialize(json)
+      data = JSON.parse(json)
+
+      return build_photo(data) if data.is_a? Hash
+      return data.map { |p| build_photo(p) } if data.is_a? Array
+    end
+
+    def self.build_photo(data)
+      object = Photo.new
+      data.each_with_object(object) do |(k, v), o|
+        setter = "#{k.underscore}=".to_sym
+        o.send(setter, v) if o.respond_to?(setter)
+      end
+      object
+    end
+  end
+
+  class Post
+    attr_accessor :id, :title, :user_id
+  end
+
+  class PostSerializer
+    def self.deserialize(json)
+      data = JSON.parse(json)
+      object = Post.new
+      object.id = data['id']
+      object.title = data['title']
+      object.user_id = data['userId']
+      object
+    end
+  end
+
+
+  class MyService
+    include RestServiceClient
+    host 'https://jsonplaceholder.typicode.com'
+    serializer PhotoSerializer
+    get :photos, '/photos'
+    get :find_photo, '/photos/:id'
+    get :find_post, '/posts/:id', serializer: PostSerializer
+  end
+
+  service = MyService.new
+
+  p service.find_photo(id: 1).album_id # 1
+  p service.photos.find { |p| p.id == 3 }.id # 1
+  p service.find_post(id: 1).user_id # 1
 
+``` 
 
 ## Development
 

data/lib/restserviceclient/version.rb

@@ -1,5 +1,5 @@
 module RestServiceClient
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.2.0'.freeze
 
   def self.version
     VERSION

data/lib/restserviceclient.rb

@@ -64,33 +64,39 @@ module RestServiceClient
       define_method :get_debug, &-> { flag }
     end
 
-    def get(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
-      add_method :get, method_name, path, default_params, default_headers, default_payload
+    def get(method_name, path = '', options = {})
+      add_method :get, method_name, path, options
     end
 
-    def post(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
-      add_method :post, method_name, path, default_params, default_headers, default_payload
+    def post(method_name, path = '', options = {})
+      add_method :post, method_name, path, options
     end
 
-    def put(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
-      add_method :put, method_name, path, default_params, default_headers, default_payload
+    def put(method_name, path = '', options = {})
+      add_method :put, method_name, path, options
     end
 
-    def patch(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
-      add_method :patch, method_name, path, default_params, default_headers, default_payload
+    def patch(method_name, path = '', options = {})
+      add_method :patch, method_name, path, options
     end
 
-    def delete(method_name, path = '', default_params = {}, default_headers = {}, default_payload = {})
-      add_method :delete, method_name, path, default_params, default_headers, default_payload
+    def delete(method_name, path = '', options = {})
+      add_method :delete, method_name, path, options
     end
 
     private
 
-    def add_method(http_method, method_name, path, default_params, default_headers, default_payload)
+    # default_params, default_headers, default_payload, serializer
+    def add_method(http_method, method_name, path, options)
       define_method method_name do |headers: {}, payload: {}, parameters: {}, **params|
-        params = @default_params.merge(default_params.merge(params.merge(parameters)))
-        headers = @default_headers.merge(default_headers.merge(headers))
-        payload = default_payload.merge payload
+        options_params = options.fetch(:params, {})
+        options_headers = options.fetch(:headers, {})
+        options_payload = options.fetch(:payload, {})
+        serializer = options.fetch(:serializer, @serializer)
+
+        params = @default_params.merge(options_params.merge(params.merge(parameters)))
+        headers = @default_headers.merge(options_headers.merge(headers))
+        payload = options_payload.merge payload
 
         uri = path.clone
 
@@ -120,7 +126,7 @@ module RestServiceClient
           puts
         end
 
-        @serializer.deserialize(response.body)
+        serializer.deserialize(response.body)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-service-client
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Bespalov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler