rest-service-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ac0a3ad05b3b3b3d9e17840d32c9d8e7844a73c
-  data.tar.gz: ff5156657486903f275ac4ec8eb531ecc99a9866
+  metadata.gz: 52389c1e5a8b0ac92ab10c0fa513ae869f4fe4ed
+  data.tar.gz: f04aecbe71a578cea9eb99ded4dd50de9a1761b7
 SHA512:
-  metadata.gz: 141e9f10a76baa1d2a4c8e1a14b704fcb3f354b632ef692ba6a8c0639a42dcb348edbc778f09b05a91052466285d2d83bcd5f755c188cdb458819c34967b4f62
-  data.tar.gz: c53e460873fefdcf7f39077fe8170d64b0290931cc747407a3ce72702a5f30839be2f885b2dd86d1efcaebb4de90d276c60eba0a8174ddbec5a3eb8e760dd3eb
+  metadata.gz: 5b808ced71893baec3ea69ee7ff5b0f5567ec3026225bcbcacb8583e00bdb920eb84c870611deb7e6739c1d635d637feb070e0cc25a43a7a126adc697f9e3746
+  data.tar.gz: 5805fd955602cd8c0414df5dd2ea0f5ab5d92c7ccc50766dee113567f81fde3a0b3a3aedd0031f1fa82969673c0e71b88ec04c847dd51d3b1c867053a72d3ab1

data/README.md

@@ -77,13 +77,13 @@ end
 
 service = SimpleService.new
 
-p service.first_photo['id']
+p service.first_photo.result['id']
 # 1
 
-p service.second_photo['id']
+p service.second_photo.result['id']
 # 2
 
-p service.photo(id: 10)['id']
+p service.photo(id: 10).result['id']
 # 10
 
 ```
@@ -98,8 +98,8 @@ class SimpleService
 end
 
 service = SimpleService.new
-p service.photo['id']         # 1
-p service.photo(id: 2)['id']  # 2
+p service.photo.result['id']         # 1
+p service.photo(id: 2).result['id']  # 2
 ```
 
 ```ruby
@@ -112,7 +112,7 @@ end
 service = SimpleService.new
 # Sends the request to 'https://jsonplaceholder.typicode.com/photos/1'
 # includes Headers: { 'Authentication': 'my-token' }
-p service.first_photo['albumId'] # 1
+p service.first_photo.result['albumId'] # 1
 
 # Sends the request to 'https://jsonplaceholder.typicode.com/photos/1'
 # includes Headers: { 
@@ -120,7 +120,7 @@ p service.first_photo['albumId'] # 1
 #   'AnotherHeaderKey': 'AnotherHeaderValue' 
 # }
 another_headers = { AnotherHeaderKey: 'AnotherHeaderValue' }
-photo = service.first_photo(headers: another_headers)
+photo = service.first_photo(headers: another_headers).result
 p photo['albumId'] # 1
 
 ```
@@ -134,7 +134,7 @@ class SimpleService
 end
 
 service = SimpleService.new
-service.delete_photo id: 1
+service.delete_photo(id: 1).result
 ```
 
 ### POST
@@ -152,7 +152,10 @@ photo = {
     url: 'http://placehold.it/600/92c952',
     thumbnailUrl: 'http://placehold.it/150/92c952'
 }
-p service.add_photo payload: photo
+response = service.add_photo(payload: photo)
+p response.status # 201
+p response.headers # {:date=>"...}
+p response.result
 =begin
 {
   "albumId"=>1,
@@ -176,7 +179,7 @@ end
 
 service = SimpleService.new
 updated_photo = service.update_photo_data id: 1, payload: { title: 'new title'}
-p updated_photo['title']
+p updated_photo.result['title']
 # "new title"
 
 ```
@@ -199,7 +202,7 @@ class SimpleService
 end
 
 service = SimpleService.new
-service.photo
+service.photo.result
 =begin
  ______
 |
@@ -232,6 +235,22 @@ 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`
 
+## Errors
+
+```ruby
+class SimpleService
+  include RestServiceClient
+  debug true
+  host 'https://jsonplaceholder.typicode.com'
+  get :bad_url, '/bad_url'
+end
+
+service = SimpleService.new
+response = service.bad_url
+p response.status # 404
+p response.message # "404 Not Found"
+
+```
 ### Example
 ```ruby
   class Photo
@@ -293,12 +312,58 @@ And you need to add your serializer to your service using:
 
   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
+  p service.find_photo(id: 1).result.album_id # 1
+  p service.photos.result.find { |p| p.id == 3 }.id # 1
+  p service.find_post(id: 1).result.user_id # 1
 
 ``` 
 
+
+## Response Object
+
+#### Response
+If request was completely sent, the class of response be `RestServiceClient::Response`
+This object has `:status`, `:headers`, `:body` and `:result` fields.
+
+`:status` contains the number(integer) of http status code.
+
+`:headers` contains the http headers from response.
+
+`:body` will be a http body as plain text.
+
+`:result` will contain deserialized http body.
+
+#### ResponseWithError
+If the request failed, the class of response will be RestServiceClient::ResponseWithError
+This object has `:status`, `:headers`, `:body`, `:result` and `:message`
+All fields except of `:message` are equals to `RestServiceClient::Response` fields.
+
+`:message` will contain the string with error message
+
+You are able to check the response before trying to use result to avoid exceptions:
+```ruby
+class SimpleService
+  include RestServiceClient
+  host 'https://jsonplaceholder.typicode.com'
+  get :get_photo, '/photos/:id' 
+  get :bad_url, '/bad_url' 
+end
+
+service = SimpleService.new
+
+response = service.get_photo id: 1
+if response.status == 200
+  p "Photo with name: #{response.result['name']} has been loaded"
+end
+
+response = service.bad_url
+if response.status != 200
+  p "Something was wrong. Reason: #{response.message}"
+  # "Something was wrong. Reason: 404 Not Found" 
+end
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/restserviceclient.rb

@@ -115,18 +115,36 @@ module RestServiceClient
           puts "|    Payload: #{payload}"
         end
 
-        response = make_request http_method, endpoint, payload, headers
+        begin
+          result = make_request http_method, endpoint, payload, headers
+          response = RestServiceClient::Response.new(
+            result.code,
+            result.headers,
+            result.body,
+            serializer.deserialize(result.body)
+          )
+        rescue RestClient::Exception => e
+          response = RestServiceClient::ResponseWithError.new(
+              e.http_code,
+              e.http_headers,
+              e.http_body,
+              e.http_body,
+              e.message
+          )
+        end
 
         if @debug
           puts '|'
           puts "|  #{self.class.name} is processing the response on #{http_method.upcase} request to #{endpoint}"
-          puts "|    Status: #{response.code}"
-          puts "|    Body: #{response.body}"
+          puts "|    Status: #{response.status}"
+          puts "|    Headers: #{response.headers}"
+          puts "|    Result: #{response.result}"
+          puts "|    Error message: #{response.message}" if response.is_a?(RestServiceClient::ResponseWithError)
           puts '|______'
           puts
         end
 
-        serializer.deserialize(response.body)
+        response
       end
     end
   end
@@ -136,4 +154,23 @@ module RestServiceClient
       JSON.parse(data)
     end
   end
+
+  class Response
+    attr_reader :status, :headers, :body, :result
+
+    def initialize(status, headers, body, result)
+      @status = status
+      @headers = headers
+      @body = body
+      @result = result
+    end
+  end
+
+  class ResponseWithError < Response
+    attr_reader :message
+    def initialize(status, headers, body, result, message)
+      super(status, headers, body, result)
+      @message = message
+    end
+  end
 end

data/lib/restserviceclient/version.rb

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

data/rest-service-client.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
 
-  spec.add_dependency 'rest-client'
-  spec.add_dependency 'json'
+  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.add_dependency 'json', '~> 2.1'
 
   spec.required_ruby_version = '>= 2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-service-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Igor Bespalov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,30 +56,30 @@ dependencies:
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: 
 email:
 - gravisbesya@list.ru