wrappi 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61be13fabeb0542feedb58078fe1308cf42286994dcafa91a7fccdf0de08200c
-  data.tar.gz: e0e8fe4b69ad694edc0ec1a0c2bb3f3a512f0415c8ceab94c7ed82065b721b37
+  metadata.gz: 5ebe424766ef9fa2db743cf82b52ff134c17ad752dc431477d6265f052e9e26c
+  data.tar.gz: 2fd7b9bc1ed174b20c016214de557c216163834f542f13f4d90ffd53183c5734
 SHA512:
-  metadata.gz: 44cf1ab2fb72aadbddc0a191c1fccb6d3dee981189f28b08722947ae6295969dd05711f090524519ef832af938eec569d358649a1859a294e286fa1922096f27
-  data.tar.gz: 70ad84300904ab70b2758f306e925462f439b23d743b82fe2fc085dedaef06a2081541abb0c3aca8f0f7a19145fe818808c99257ae0b9d391d4f127ce31bad98
+  metadata.gz: 2cae0bd674b5596b4901a38a7e4135c51efbbb7f0489b85841243d3b1179ceec170d3141e3b44a26c73e55cd79691fa99a69771c980a0d15d641239952be41f5
+  data.tar.gz: c7f06f0f12e49ad69a4f9ca737b55fdcf8df3dc83dbaf3453f6db02f2fa87d9711e0da6dc3d482118c26c7b62c183cbe937b4bd7a4d9b8d9fbfe1ef74e46406c

data/README.md

@@ -6,7 +6,7 @@
 Making APIs fun again!
 
 Wrappi is a Framework to create API clients. The intention is to bring the best practices and standardize how API clients behave.
-It allows to create API clients in a declarative way improving readability and unifying the behavior. It abstracts complex operations like caching, retries background requests and error handling.
+It allows to create API clients in a declarative way improving readability and unifying the behavior. It abstracts complex operations like caching, retries, background requests and error handling.
 
 Enjoy!
 
@@ -60,23 +60,29 @@ user.status_code # => 200
 user.body # => {"login"=>"arturictus", "id"=>1930175, ...}
 ```
 
-### #success?
+#### #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_
+_wrappi/endpoint.rb_
 ```ruby
-  def success?
-    @success ||= request.code < 300 && request.code >= 200
+  def self.success?(request)
+    request.code < 300 && request.code >= 200
   end
 ```
 
 Overrride your own in Endpoint
 ```ruby
-  def success?
-    response.status == 201
+  class User < Wrappi::Endpoint
+    client Client
+    verb :get
+    path "users/:username"
+
+    def self.success?(request)
+      request.status == 200
+    end
   end
 ```
 
@@ -174,7 +180,7 @@ Github::User.new(username: 'arturictus').async(create: true, set: { wait: 10.min
 ```
 
 #### Cache
-You can enable cache per endpoint.
+You can enable cache per endpoint. It depends on `::success?` method to determine if it will be cached or nor.
 
 Set the cache Handler in your client.
 It must behave like `Rails.cache` and respond to:
@@ -237,8 +243,8 @@ This will retry if status code is not `200`
     client Client
     verb :get
     path "users/:username"
-    retry_if do |response, endpoint|
-      endpoint.status_code != 200
+    retry_if do |response|
+      response.code != 200
     end
   end
 ```
@@ -653,7 +659,42 @@ user = GithubCLI.user(username: 'arturictus')
 user.success?
 ```
 
-### In your project
+#### Customization in you parent project
+
+Once you created a gem Wrappi allows to parent projects to customize endpoints without having to change the gem's code.
+
+example customizing `GithubCLI::User`
+
+```ruby
+GithubCLI::User.setup do
+  cache true
+  async_callback do |opts|
+    if success?
+      # do something
+    end
+  end
+end
+```
+
+Example customizing all the Endpoints, adding loging to all the requests and changing client depending of enviroment:
+
+```ruby
+GithubCLI::Endpoint.setup do
+  client do
+    if ENV['production']
+      GithubCLI::Client
+    else
+      GithubCLI::MyStagingClient
+    end
+  end
+
+  around_request do |request, endpoint|
+    endpoint.logger.info("making a request to #{endpoint.url} with params: #{endpoint.consummated_params}")
+    request.call # IMPORTANT
+    endpoint.logger.info("response status is: #{request.status_code}")
+  end
+end
+```
 
 ## The HTTP clients war
 

data/lib/wrappi/endpoint.rb

@@ -20,12 +20,8 @@ module Wrappi
     }
   )
 
-    attr_reader :input_params, :options
-    def initialize(input_params = {}, options = {})
-      @input_params = input_params
-      @options = options
-    end
-
+    ##############    ClassMethods     ################
+    # ============ API class metnods ================
     def self.call(*args)
       new(*args).call
     end
@@ -38,6 +34,50 @@ module Wrappi
       new(*args).body
     end
 
+    def self.setup(&block)
+      instance_exec(&block)
+    end
+
+    # =============      Configs     =================
+    def self.async_callback(&block)
+      @async_callback = block
+    end
+    
+    def self.around_request(&block)
+      @around_request = block
+    end
+    
+    def self.retry_if(&block)
+      @retry_if = block
+    end
+    
+    def self.cache_options(&block)
+      @cache_options = block
+    end
+    
+    # =============      Inheritance     =================
+    def self.inherited(subclass)
+      super(subclass)
+      subclass.instance_variable_set(:@async_callback, @async_callback)
+      subclass.instance_variable_set(:@around_request, @around_request)
+      subclass.instance_variable_set(:@retry_if, @retry_if)
+      subclass.instance_variable_set(:@cache_options, @cache_options)
+    end
+
+    # ============== success behaviour   ===================
+    # overridable
+    def self.success?(request)
+      request.code >= 200 && request.code < 300
+    end
+    #######################################################
+    
+    attr_reader :input_params, :options
+    def initialize(input_params = {}, options = {})
+      @input_params = input_params
+      @options = options
+    end
+
+
     def on_success(&block)
       block.call(self) if success?
       self  
@@ -88,23 +128,6 @@ module Wrappi
       end.to_s
     end
 
-
-    def self.async_callback(&block)
-      @async_callback = block
-    end
-
-    def self.around_request(&block)
-      @around_request = block
-    end
-
-    def self.retry_if(&block)
-      @retry_if = block
-    end
-
-    def self.cache_options(&block)
-      @cache_options = block
-    end
-
     def perform_async_callback(async_options = {})
       instance_exec(async_options, &async_callback)
     end
@@ -114,6 +137,7 @@ module Wrappi
       @cache_key ||= "[#{verb.to_s.upcase}]##{url}#{params_cache_key}"
     end
 
+    
     def around_request
       self.class.instance_variable_get(:@around_request)
     end
@@ -121,6 +145,7 @@ module Wrappi
     def retry_if
       self.class.instance_variable_get(:@retry_if)
     end
+
     def cache_options
       self.class.instance_variable_get(:@cache_options)
     end
@@ -131,7 +156,6 @@ module Wrappi
       self.class.instance_variable_get(:@async_callback) || proc {}
     end
 
-
     def logger
       client.logger
     end

data/lib/wrappi/executer.rb

@@ -39,7 +39,7 @@ module Wrappi
     end
 
     def make_request
-      res = Response.new { Request.new(endpoint).call }
+      res = Response.new(endpoint.class) { Request.new(endpoint).call }
       around_request.call(res, endpoint)
       res.called? ? res : UncalledRequest.new
     end

data/lib/wrappi/response.rb

@@ -4,8 +4,9 @@ module Wrappi
   # https://github.com/httprb/http/wiki/Response-Handling
   class Response
 
-    attr_reader :block
-    def initialize(&block)
+    attr_reader :block, :endpoint_klass
+    def initialize(endpoint_klass, &block)
+      @endpoint_klass = endpoint_klass
       @block = block
     end
 
@@ -24,7 +25,7 @@ module Wrappi
     end
 
     def success?
-      @success ||= request.code < 300 && request.code >= 200
+      @success ||= endpoint_klass.success?(request)
     end
 
     def error?

data/lib/wrappi/version.rb

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

metadata

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