binking 0.2.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c4a89903d0af0d6e06d1dcf076c14fe601aeb75e3ec4625989fbaf5e7976496
-  data.tar.gz: 2f86c3d4f3e38cbdfd05ba08395b5335a5c5069a0777690f7306353ab0c1a617
+  metadata.gz: 54fdf60bb43b4cf3b4c6f77cd5d626c187a45a8d4979ff149ed6bccedf7d5ec5
+  data.tar.gz: d73151ea1958e927bc0af2197963b06e294efa13ae33a44a8f25e52c1767db3b
 SHA512:
-  metadata.gz: f33edd70bce295acc722cf3d7f1d58a6ea6934561df3a09ffe4dea1607c61c8c8cd4d423cf01e5521d01f29b361dded60f43f9461f9a6eb246db5823dafb602e
-  data.tar.gz: fa9fd94576c15edbd6c980ffc501c762ac7e521a0e36c3b399dcb533eb961696fdda0c6c43e22268dba772bb8f39a990e7c0e63db37fff2c7ccb35838c237810
+  metadata.gz: c4696cd3627a8c0394b4d4841822c1c1a101a4cdd7b53d89017ba8940f1b1fc4cbdc5c14a0e82ebb8968c9c6ba58d588a753bb5c29c647826f0d82797804ae04
+  data.tar.gz: 7cd854902ad446e1c8452f87430bc65a09a4a099c8125ec2c20bb4920ab756c252b47bdc51a26870020c673a461802cf012e8e2457078a59ad6265cb709d2c6a

data/lib/binking/cache_middalware.rb

@@ -0,0 +1,84 @@
+class CacheMiddalware < Faraday::Middleware
+  DEFAULT_CONDITIONS = ->(env) { env.method == :get || env.method == :head }
+  DEFAULT_CACHE_KEY = ->(env) { env.url }
+
+  def initialize(app, store, *args)
+    super(app)
+    options = args.first || {}
+
+    @store         = store
+    @conditions    = options.fetch(:conditions, DEFAULT_CONDITIONS)
+    @expires_in    = options.fetch(:expires_in, 30)
+    @logger        = options.fetch(:logger, nil)
+    @cache_key     = options.fetch(:cache_key, DEFAULT_CACHE_KEY)
+  end
+
+  def call(env)
+    dup.call!(env)
+  end
+
+  protected
+
+  def call!(env)
+    response_env = cached_response(env)
+
+    if response_env
+      response_env.response_headers['x-faraday-manual-cache'] = 'HIT'
+      to_response(response_env)
+    else
+      @app.call(env).on_complete do |response_env|
+        response_env.response_headers['x-faraday-manual-cache'] = 'MISS'
+        cache_response(response_env)
+      end
+    end
+  end
+
+  def cache_response(env)
+    return unless cacheable?(env) && !env.request_headers['x-faraday-manual-cache']
+
+    info "Cache WRITE: #{key(env)}"
+    @store.write(
+      key(env),
+      env,
+      expires_in: expires_in(env)
+    )
+  end
+
+  def cacheable?(env)
+    @conditions.call(env)
+  end
+
+  def cached_response(env)
+    if cacheable?(env) && !env.request_headers['x-faraday-manual-cache']
+      response_env = @store.fetch(key(env))
+    end
+
+    if response_env
+      info "Cache HIT: #{key(env)}"
+    else
+      info "Cache MISS: #{key(env)}"
+    end
+
+    response_env
+  end
+
+  def info(message)
+    @logger.info(message) unless @logger.nil?
+  end
+
+  def key(env)
+    @cache_key.call(env)
+  end
+
+  def expires_in(env)
+    @expires_in.respond_to?(:call) ? @expires_in.call(env) : @expires_in
+  end
+
+  def to_response(env)
+    env = env.dup
+    env.response_headers['x-faraday-manual-cache'] = 'HIT'
+    response = Faraday::Response.new
+    response.finish(env) unless env.parallel?
+    env.response = response
+  end
+end

data/lib/binking/client.rb

@@ -1,22 +1,23 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "faraday_middleware"
 
 module Binking
   class Client
-    attr_accessor :api_token, :host, :sandbox, :cache, :logger, :options
+    attr_accessor :api_token, :host, :sandbox, :cache, :cache_expires_in, :logger, :options
 
     def initialize(api_token: Binking.config.api_token,
                    host: Binking.config.host,
                    sandbox: Binking.config.sandbox,
                    cache: Binking.config.cache,
+                   cache_expires_in: Binking.config.cache_expires_in,
                    logger: Binking.config.logger,
                    options: Binking.config.request_options)
       @api_token = api_token
       @host = host
       @sandbox = sandbox
       @cache = cache
+      @cache_expires_in = cache_expires_in
       @logger = logger
       @options = options
     end
@@ -32,7 +33,11 @@ module Binking
 
     def connection
       @connection ||= Faraday.new(host, request: options) do |builder|
-        builder.use(FaradayMiddleware::Caching, cache) if cache
+        builder.use(
+          CacheMiddalware,
+          cache,
+          expires_in: cache_expires_in
+        ) if cache
         builder.use Faraday::Response::RaiseError
         builder.request :url_encoded
         builder.response :json

data/lib/binking/config.rb

@@ -4,18 +4,20 @@ module Binking
   class Config
     DEFAULT_HOST = "https://api.binking.io"
 
-    attr_accessor :api_token, :host, :sandbox, :cache, :logger, :request_options
+    attr_accessor :api_token, :host, :sandbox, :cache, :cache_expires_in, :logger, :request_options
 
     def initialize(api_token: nil,
                    host: DEFAULT_HOST,
                    sandbox: false,
                    cache: nil,
+                   cache_expires_in: 2592000,
                    logger: nil,
                    request_options: {})
       @api_token = api_token
       @host = host
       @sandbox = sandbox
       @cache = cache
+      @cache_expires_in = cache_expires_in
       @logger = logger
       @request_options = request_options
     end

data/lib/binking/request_resource.rb

@@ -16,9 +16,11 @@ module Binking
       params[RESOURCES_KEYS[resource.to_s]] = value
       params[:fields] = fields.join(",") unless fields.empty?
 
-      Client.new(sandbox: sandbox)
-            .get("/#{resource}", params)
-            .body
+      response = Client.new(sandbox: sandbox).get("/#{resource}", params)
+
+      return {} if response.body == 'null'
+
+      response.body
     end
   end
 end

data/lib/binking/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Binking
-  VERSION = "0.2.1"
+  VERSION = "0.2.4"
 end

data/lib/binking.rb

@@ -2,6 +2,7 @@
 
 require_relative "binking/version"
 require "binking/config"
+require "binking/cache_middalware"
 require "binking/client"
 require "binking/fields"
 require "binking/request_resource"
@@ -22,7 +23,7 @@ module Binking
   end
 
   %i[form bank banks].each do |resource_name|
-    define_singleton_method(resource_name) do |*args| 
+    define_singleton_method(resource_name) do |*args|
       raise NotConfiguredError unless configured?
 
       RequestResource.get(resource_name, *args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binking
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Anton Kostyuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.1
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '2.0'
 description: 
 email:
 - anton.kostuk.2012@gmail.com
@@ -60,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/binking.rb
+- lib/binking/cache_middalware.rb
 - lib/binking/client.rb
 - lib/binking/config.rb
 - lib/binking/fields.rb