lifen 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f43d79863f669ef8d3c3bd3bc020c906b70bba38
-  data.tar.gz: bd2d87955f148b20fbb9f2cfb242d4086f0face7
+  metadata.gz: 2f5c85c29e8ab9cc7f36987098d50f12a5beb96d
+  data.tar.gz: 74e319a77102bbc00630fa6f24acdec72d4ee789
 SHA512:
-  metadata.gz: 30a1acc06def39ca6b5525215d0a7920cf9fed8118817bf8ea5793c45e0116d9a7f9cd9d586655233373fe958688f284a39459e652d76d1e84a6942575a5339a
-  data.tar.gz: 688364f874269d69368f788a5510a50274e9ad66d8c9958098a216e1c3ad15fdd9111448466d8595c5bf21dedbb47dc0ff502324a3de899af141f7a371ef0f98
+  metadata.gz: b6c8d52af33bb08e5c3926d8bbee08edbd50e6da9ded2303fe62f5b917e6c85c4e955d9233414f2ea79ab702624ef68589f16fe0c168f7e51aba58d68027ee32
+  data.tar.gz: 436d77f9de97847cf494d0336646a98a958ec12333bf9df5eaf7930d965e8b538fbba24da4d3338b4980fa2ba5986ec331756670f88a37b428c806cc96dc19d6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+1.0.2
+-----
+
+- Error messages contains more information about failing API requests
+
 1.0.1
 -----
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lifen (1.0.1)
+    lifen (1.0.2)
       faraday (>= 0.9)
       inflecto
       virtus (>= 1.0)

data/lib/lifen/app_authenticated_client.rb

@@ -3,22 +3,26 @@ module Lifen
 
     private
 
-      def handle_status!(response)
-        super(response)
+      def handle_errors(response, params)
+        super(response, params)
 
         case response.status
         when 400
-          raise Error, "Error 400"
+          raise Error, "Error 400, Unknown error, #{response_error(response, params)}"
         when 401
-          raise InvalidSecretTokenError
+          raise InvalidSecretTokenError, "Error 401, Invalid app bearer, #{response_error(response, params)}"
         when 403
-          raise UserAlreadyExistingError
+          raise UserAlreadyExistingError, "Error 403, User already existing, #{response_error(response, params)}"
         when 404
-          raise Error, "Error 404, Page not found"
+          raise Error, "Error 404, Page not found, #{response_error(response, params)}"
         end
 
       end
 
+      def response_error(response, params)
+        "App Client, #{super(response, params)}"
+      end
+
       def bearer
         Lifen.configuration.application_access_token
       end

data/lib/lifen/client.rb

@@ -14,7 +14,7 @@ module Lifen
         req.body = JSON.generate(params)
       end
 
-      handle_status!(response)
+      handle_errors(response, params)
 
       json = JSON.parse response.body
 
@@ -31,18 +31,19 @@ module Lifen
 
     private
 
-      def handle_status!(response)
+      def handle_errors(response, params)
         if response.status == 500
+
           json = JSON.parse response.body
 
           trace_id = json.fetch("X-B3-TraceId", "unknown")
-          raise Error, "Error 500, Internal server error (trace ID: #{trace_id})"
+
+          raise Error, "Error 500, Internal server error (trace ID: #{trace_id}), #{response_error(response, params)}"
         end
       end
 
       def faraday_client
         @faraday_client ||= Faraday.new(faraday_options) do |faraday|
-          faraday.request  :url_encoded             # form-encode POST params
           faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
         end
       end
@@ -66,6 +67,18 @@ module Lifen
       def before_request
       end
 
+      def response_error(response, params)
+        "#{response.env.method.upcase} '#{response.env.url}' with params '#{params.inspect}' and bearer '#{trucanted_bearer}'"
+      end
+
+      def trucanted_bearer
+        if m = /^(.{24})(.*)$/.match(bearer)
+          "#{m[1]}#{"*" * m[2].length}"
+        else
+          bearer
+        end
+      end
+
       def bearer
         raise "A bearer method must be defined"
       end

data/lib/lifen/user_authenticated_client.rb

@@ -9,20 +9,24 @@ module Lifen
 
     private
 
-      def handle_status!(response)
-        super(response)
+      def handle_errors(response, params)
+        super(response, params)
 
         case response.status
         when 400
-          raise InvalidParamsError, "Invalid params"
+          raise InvalidParamsError, "Error 400, Invalid params, #{response_error(response, params)}"
         when 401
-          raise UnauthorizedError, "Token is not valid"
+          raise UnauthorizedError, "Error 401, Token is not valid, #{response_error(response, params)}"
         when 403
-          raise Error, "Action is forbidden"
+          raise Error, "Error 403, Action is forbidden, #{response_error(response, params)}"
         end
 
       end
 
+      def response_error(response, params)
+        "User Client, #{super(response, params)}"
+      end
+
       def bearer
         token.value
       end

data/lib/lifen/version.rb

@@ -1,3 +1,3 @@
 module Lifen
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/flows_spec.rb

@@ -19,7 +19,7 @@ describe Lifen::Flow do
           VCR.use_cassette "flows/invalid_token" do
             user.flows
           end
-        }.to raise_error(Lifen::UnauthorizedError)
+        }.to raise_error(Lifen::UnauthorizedError, "Error 401, Token is not valid, User Client, GET 'https://develop.lifen.fr/central/api/chats' with params '{}' and bearer 'invalid_token'")
       end
 
     end
@@ -31,7 +31,7 @@ describe Lifen::Flow do
           VCR.use_cassette "flows/internal_error" do
             user.flows
           end
-        }.to raise_error(Lifen::Error, "Error 500, Internal server error (trace ID: 2e2eac3a7e3fa2)")
+        }.to raise_error(Lifen::Error, "Error 500, Internal server error (trace ID: 2e2eac3a7e3fa2), User Client, GET 'https://develop.lifen.fr/central/api/chats' with params '{}' and bearer 'valid_token'")
       end
 
       it 'raises an error (without trace ID)' do
@@ -39,7 +39,7 @@ describe Lifen::Flow do
           VCR.use_cassette "flows/internal_error_without_trace_id" do
             user.flows
           end
-        }.to raise_error(Lifen::Error, "Error 500, Internal server error (trace ID: unknown)")
+        }.to raise_error(Lifen::Error, "Error 500, Internal server error (trace ID: unknown), User Client, GET 'https://develop.lifen.fr/central/api/chats' with params '{}' and bearer 'valid_token'")
       end
 
     end
@@ -122,7 +122,7 @@ describe Lifen::Flow do
           VCR.use_cassette "flows/attach_users/invalid_flow_uuid" do
             flow.attach_users(user)
           end
-        }.to raise_error(Lifen::InvalidParamsError)
+        }.to raise_error(Lifen::InvalidParamsError, "Error 400, Invalid params, User Client, POST 'https://develop.lifen.fr/central/api/chats/invalid-uuid/attach_users?rel=activeUsers' with params '[\"25588996-4ff1-2dbb-9643-eabb809fa654\"]' and bearer 'valid_token'")
       end
 
     end
@@ -141,7 +141,7 @@ describe Lifen::Flow do
             VCR.use_cassette "flows/attach_users/invalid_user_uuid" do
               flow.attach_users(invalid_user)
             end
-          }.to raise_error(Lifen::InvalidParamsError)
+          }.to raise_error(Lifen::InvalidParamsError, "Error 400, Invalid params, User Client, POST 'https://develop.lifen.fr/central/api/chats/11e6be18-7a35-d759-9177-0242ac110002/attach_users?rel=activeUsers' with params '[\"invalid-uuid\"]' and bearer 'valid_token'")
         end
       end
 

data/spec/users_spec.rb

@@ -17,7 +17,7 @@ describe Lifen::User do
           VCR.use_cassette "users/create/missing_fields" do
             user.create
           end
-        }.to raise_error(Lifen::Error)
+        }.to raise_error(Lifen::Error, "Error 401, Invalid app bearer, App Client, POST 'https://develop.lifen.fr/authentication/api/register/third_party' with params '{:emailAddress=>nil, :lastName=>nil, :firstName=>\"Marc\"}' and bearer 'valid_application_access******'")
       end
     end
 
@@ -36,7 +36,7 @@ describe Lifen::User do
           VCR.use_cassette "users/create/invalid_token" do
             user.create
           end
-        }.to raise_error(Lifen::InvalidSecretTokenError)
+        }.to raise_error(Lifen::InvalidSecretTokenError, "Error 401, Invalid app bearer, App Client, POST 'https://develop.lifen.fr/authentication/api/register/third_party' with params '{:emailAddress=>\"invalid-key-email@test.tld\", :lastName=>nil, :firstName=>nil}' and bearer 'invalid-secret-key'")
       end
     end
 
@@ -49,7 +49,7 @@ describe Lifen::User do
           VCR.use_cassette "users/create/existing_user" do
             user.create
           end
-        }.to raise_error(Lifen::UserAlreadyExistingError)
+        }.to raise_error(Lifen::UserAlreadyExistingError, "Error 403, User already existing, App Client, POST 'https://develop.lifen.fr/authentication/api/register/third_party' with params '{:emailAddress=>\"existing-user@domain.tld\", :lastName=>\"User\", :firstName=>\"Existing\"}' and bearer 'valid_application_access******'")
       end
     end
 
@@ -80,7 +80,7 @@ describe Lifen::User do
           VCR.use_cassette "users/token/refresh/invalid_user_uuid" do
             user.token.refresh
           end
-        }.to raise_error(Lifen::Error)
+        }.to raise_error(Lifen::Error, "Error 500, Internal server error (trace ID: unknown), App Client, POST 'https://develop.lifen.fr/oauth/admin/third_party/access_token?accountUuid=invalid-user-uuid' with params '{}' and bearer 'valid_application_access******'")
       end
     end
 
@@ -113,7 +113,7 @@ describe Lifen::User do
           VCR.use_cassette "users/status/refresh/invalid_token" do
             user.status.refresh
           end
-        }.to raise_error(Lifen::Error)
+        }.to raise_error(Lifen::Error, "Error 401, Token is not valid, User Client, GET 'https://develop.lifen.fr/central/api/chats/status' with params '{}' and bearer 'invalid_token'")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifen
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Etienne Depaulis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler