wrappi 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf93a36321552af49d6edd7b1e613f36d8294098e3702a3182adfca15dc664d
-  data.tar.gz: 5c3ebb3d3507c5fc11ed7404a1f631fadc6a401c22828cffd0573b09c1f694ad
+  metadata.gz: 61be13fabeb0542feedb58078fe1308cf42286994dcafa91a7fccdf0de08200c
+  data.tar.gz: e0e8fe4b69ad694edc0ec1a0c2bb3f3a512f0415c8ceab94c7ed82065b721b37
 SHA512:
-  metadata.gz: 42e98a0e070fa90e2eff25dcf2731630a8e1f9583f4a7a834ce56f71e78044ee22af1c1d9fbd4df7ed1a9de99337108b7257b36eb7a0714c8662e85d80970e17
-  data.tar.gz: 13190e49c3a13054c473e7e2e345f26ba5602b35a679d0a70831c8359ca75fddfd3a31372266f89afb03e5ca7e9f76e9d95d3dbe4e8965baf932d1298012fec1
+  metadata.gz: 44cf1ab2fb72aadbddc0a191c1fccb6d3dee981189f28b08722947ae6295969dd05711f090524519ef832af938eec569d358649a1859a294e286fa1922096f27
+  data.tar.gz: 70ad84300904ab70b2758f306e925462f439b23d743b82fe2fc085dedaef06a2081541abb0c3aca8f0f7a19145fe818808c99257ae0b9d391d4f127ce31bad98

data/README.md

@@ -30,8 +30,10 @@ Or install it yourself as:
 
 __Github example:__
 
+You can test this examples running `bin/console`
+
 ```ruby
-module GithubAPI
+module GithubCLI
   class Client < Wrappi::Client
     setup do |config|
       config.domain = 'https://api.github.com'
@@ -51,13 +53,92 @@ end
 ```
 
 ```ruby
-user = GithubAPI::User.new(username: 'arturictus')
+user = GithubCLI::User.new(username: 'arturictus')
 user.success? # => true
 user.error? # => false
 user.status_code # => 200
 user.body # => {"login"=>"arturictus", "id"=>1930175, ...}
 ```
 
+### #success?
+
+The next behaviours are using `#success?` method. You can override by redefining your own success?
+
+The current `#success?` is defined like this:
+
+_wrappi/response.rb_
+```ruby
+  def success?
+    @success ||= request.code < 300 && request.code >= 200
+  end
+```
+
+Overrride your own in Endpoint
+```ruby
+  def success?
+    response.status == 201
+  end
+```
+
+##### #on_success | #on_error
+
+```ruby
+GithubCLI::User.new(username: 'arturictus')
+               .on_success do |inst|
+                 inst.status_code # => 200
+                 inst.body # => {"login"=>"arturictus", "id"=>1930175, ...}
+                 # do something useful
+               end.on_error do |inst|
+                 puts "Error retrieving use"
+               end
+```
+
+##### ::body
+If you just need to retrieve the body and handle the error response on your side
+
+```ruby
+GithubCLI::User.body(username: 'arturictus') # => {"login"=>"arturictus", "id"=>1930175, ...}
+```
+```ruby
+GithubCLI::User.body(username: 'sdfsdfasdjfojaspdjfpsajdpfoijsapdofijsadf')
+# => {"message"=>"Not Found", "documentation_url"=>"https://developer.github.com/v3/users/#get-a-single-user"}
+```
+
+##### ::call
+
+returns `false` if unsuccessful and instance if successful
+
+```ruby
+if req = GithubCLI::User.call(username: 'arturictus')
+  req.body # => {"login"=>"arturictus", "id"=>1930175, ...}
+else
+  # Handle error
+end
+```
+##### ::call!
+
+Raises error if unsuccessful, returns instance if successful
+
+```ruby
+begin
+  req = GithubCLI::User.call!(username: 'arturictus')
+  req.body # => {"login"=>"arturictus", "id"=>1930175, ...}
+rescue => Wrappi::UnsuccessfulResponse
+  # Handle error or not
+end
+```
+
+The error:
+
+```ruby
+GithubCLI::User.call!(username: 'sdfsdfasdjfojaspdjfpsajdpfoijsapdofijsadf')
+# Wrappi::UnsuccessfulResponse ()
+#     raw_body: {"message":"Not Found","documentation_url":"https://developer.github.com/v3/users/#get-a-single-user"}
+#     code: 404
+#     uri: https://api.github.com/users/sdfsdfasdjfojaspdjfpsajdpfoijsapdofijsadf
+#     success: false
+```
+
 #### Async
 Wrappi comes with a background Job out of the box. If you are in a Rails app the `#async`
 method will queue a new job (`< ActiveJob::Base`) that will make the request and trigger the async callback

data/lib/wrappi.rb

@@ -8,6 +8,20 @@ module Wrappi
   class TimeoutError < StandardError; end
   class NotAuthorizedAccessError < StandardError; end
   class JsonParseError < StandardError; end
+  class UnsuccessfulResponse < StandardError
+    def initialize(endpoint)
+      @endpoint = endpoint
+      @output = StringIO.new.tap { |s| s.puts "" }
+      super(_message)
+    end
+
+    def _message
+      @endpoint.response.to_h.each do |k, v|
+        @output.puts "    #{k}: #{v}"
+      end
+      @output.string
+    end
+  end
 end
 
 require 'wrappi/async_job'

data/lib/wrappi/endpoint.rb

@@ -19,6 +19,7 @@ module Wrappi
       basic_auth: proc { client.basic_auth }
     }
   )
+
     attr_reader :input_params, :options
     def initialize(input_params = {}, options = {})
       @input_params = input_params
@@ -29,10 +30,37 @@ module Wrappi
       new(*args).call
     end
 
+    def self.call!(*args)
+      new(*args).call!
+    end
+
+    def self.body(*args)
+      new(*args).body
+    end
+
+    def on_success(&block)
+      block.call(self) if success?
+      self  
+    end
+
+    def on_error(&block)
+      block.call(self) unless success?
+      self
+    end
+
+    def call
+      return false unless success?
+      self
+    end
+    
+    def call!
+      raise UnsuccessfulResponse.new(self) unless success?
+      self
+    end
+    
     def response
       @response ||= Executer.call(self)
     end
-    alias_method :call, :response
 
     def body; response.body end
     def success?; response.success? end

data/lib/wrappi/version.rb

@@ -1,3 +1,3 @@
 module Wrappi
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrappi
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Artur Pañach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-12 00:00:00.000000000 Z
+date: 2019-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler