shaf_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62a58d5dea41057a5152f4e366f88f2884409035aaf3dae28c0956119bcca8c5
-  data.tar.gz: d5dc2e8dc48071545d8d4f61ca6ba2ef5e3160e0b14dfed9fa4a9473795a9967
+  metadata.gz: c22649fc5b9cf64045bfe2a8d00c7ee333875b908683f59371b111e23baa6e68
+  data.tar.gz: ea3690f1f041619f9d1f6491ac21784fdc5bf31b5ee496c80d2fe3bd3195e9b1
 SHA512:
-  metadata.gz: b26661ac11a3181f0ce9ba65cfd78a6163dc0fed12cd767888439f2c9ab54534c4ad8ab2db542093f1fdece91e12d1147bc1a473706607b86660c89aafb27e2e
-  data.tar.gz: 493058b76326556d3e4bf587138d772b179cbbab4b0732a3c1dacdfcab0e4bb50ca5190743cd3d14ae43106541d7779624ac741fba4588f31f28b38f4817b3b0
+  metadata.gz: c79cfd0da579e74134d9c01a5745f0f69b8e9dcc72532fcd88bbd3ca3c82410c48a0e61ee41923becbdcef72d67e2af551d00760be1521534494f331634f19d2
+  data.tar.gz: 748c0dee85126f1bda4db6bffbe338ff4b1d71ea50b02e4bb3779cd9479cc963dadeeefc62c3c5e3d09911b57d42b4cfab77de4d18416fd8194a5fedf6ea0bb6

data/lib/shaf_client/base_resource.rb

@@ -17,11 +17,14 @@ class ShafClient
       parse
     end
 
-    def to_s
+    def to_h
       attributes
         .merge(_links: transform_values_to_s(links))
         .merge(_embedded: transform_values_to_s(embedded_resources))
-        .to_s
+    end
+
+    def to_s
+      JSON.pretty_generate(to_h)
     end
 
     def attribute(key)
@@ -48,12 +51,23 @@ class ShafClient
       links.keys
     end
 
-    private
+    protected
 
     def payload
       @payload ||= {}
     end
 
+    def <<(other)
+      @payload            = other.payload.dup
+      @attributes         = other.attributes.dup
+      @links              = other.links.dup
+      @curies             = other.curies.dup
+      @embedded_resources = other.embedded_resources.dup
+      self
+    end
+
+    private
+
     def parse
       @attributes = payload.transform_keys(&:to_sym)
       parse_links
@@ -61,11 +75,10 @@ class ShafClient
     end
 
     def parse_links
-      links = attributes.delete(:_links) || {}
       @links ||= {}
       @curies ||= {}
 
-      links.each do |key, value|
+      (attributes.delete(:_links) || {}).each do |key, value|
         next parse_curies(value) if key == 'curies'
         @links[key.to_sym] = Link.from(value)
       end
@@ -93,11 +106,8 @@ class ShafClient
     end
 
     def method_missing(method_name, *args, &block)
-      if attributes.key?(method_name)
-        attribute(method_name)
-      else
-        super
-      end
+      return super unless attributes.key?(method_name)
+      attribute(method_name)
     end
 
     def respond_to_missing?(method_name, include_private = false)
@@ -108,9 +118,9 @@ class ShafClient
     def transform_values_to_s(hash)
       hash.transform_values do |value|
         if value.is_a? Array
-          value.map(&:to_s)
+          value.map(&:to_h)
         else
-          value.to_s
+          value.to_h
         end
       end
     end

data/lib/shaf_client/form.rb

@@ -31,7 +31,21 @@ class ShafClient
     # def validate; end
 
     def submit
-      client.send(http_method, target, @values)
+      client.send(http_method, target, payload: @values)
+    end
+
+    def reload!
+      self << get_form(:self, skip_cache: true)
+    end
+
+    protected
+
+    def <<(other)
+      @values = {}
+      other.values.each do |key, value|
+        @values[key] = value.dup
+      end
+      super
     end
   end
 end

data/lib/shaf_client/link.rb

@@ -32,11 +32,11 @@ class ShafClient
       end
     end
 
-    def to_s
+    def to_h
       {
         href: href,
         templated: templated?
-      }.to_s
+      }
     end
   end
 end

data/lib/shaf_client/middleware/cache.rb

@@ -122,9 +122,11 @@ class ShafClient
       end
 
       def call(request_env)
-        key = cache_key(request_env)
+        key = cache_key(request_env[:url], request_env[:request_headers])
 
-        if request_env[:method] == :get
+        skip_cache = request_env[:request_headers].delete :skip_cache
+
+        if !skip_cache && request_env[:method] == :get
           cached = self.class.get(key: key)
           return Response.new(body: cached, headers: {}) if cached
         end
@@ -132,6 +134,8 @@ class ShafClient
         add_etag(request_env, key)
 
         @app.call(request_env).on_complete do |response_env|
+          # key might have changed in other middleware
+          key = cache_key(response_env[:url], request_env[:request_headers])
           add_cached_payload(response_env, key)
           cache_response(response_env, key)
           self.class.inc_request_count
@@ -139,7 +143,8 @@ class ShafClient
       end
 
       def add_etag(env, key = nil)
-        key ||= cache_key(env)
+        return unless %i[get head].include? env[:method]
+        key ||= cache_key(env[:url], env[:request_headers])
         etag = self.class.get_etag(key: key)
         env[:request_headers]['If-None-Match'] = etag if etag
       end
@@ -162,8 +167,8 @@ class ShafClient
         )
       end
 
-      def cache_key(env)
-        :"#{env[:url]}.#{env[:request_headers][auth_header]}"
+      def cache_key(url, request_headers)
+        :"#{url}.#{request_headers&.dig(auth_header)}"
       end
 
       def auth_header

data/lib/shaf_client/middleware/redirect.rb

@@ -0,0 +1,35 @@
+require 'uri'
+
+class ShafClient
+  module Middleware
+    class Redirect
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(request_env)
+        @app.call(request_env).on_complete do |response_env|
+          status = response_env[:status]
+          location = response_env[:response_headers]['Location']
+          next unless redirect? status
+          next unless location
+          update_env(request_env, status, location)
+          @app.call(request_env)
+        end
+      end
+
+      def redirect?(status)
+        [301, 302, 303, 307, 308].include? status
+      end
+
+      def update_env(request_env, status, location)
+        if status == 303
+          request_env[:method] = :get
+          request_env[:body] = nil
+        end
+        request_env[:url] = URI(location)
+      end
+    end
+  end
+end

data/lib/shaf_client/resource.rb

@@ -3,18 +3,20 @@ require 'shaf_client/base_resource'
 
 class ShafClient
   class Resource < BaseResource
+    attr_reader :http_status, :headers
 
-    def initialize(client, payload)
+    def initialize(client, payload, status = nil, headers = nil)
       @client = client
+      @http_status = status
+      @headers = headers
       super(payload)
     end
 
     %i[get put post delete patch get_form].each do |method|
-      define_method(method) do |rel, payload = nil|
+      define_method(method) do |rel, payload = nil, **options|
         href = link(rel).href
         args = [method, href]
-        args << payload unless method.to_s.start_with? 'get'
-        client.send(*args)
+        client.send(*args, payload: payload, **options)
       end
     end
 
@@ -32,6 +34,18 @@ class ShafClient
       client.get_doc(uri)
     end
 
+    def reload!
+      self << get(:self, skip_cache: true)
+    end
+
+    protected
+
+    def <<(other)
+      @http_status  = other.http_status.dup
+      @headers      = other.headers.dup
+      super
+    end
+
     private
 
     attr_reader :client

data/lib/shaf_client.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'json'
 require 'shaf_client/middleware/cache'
+require 'shaf_client/middleware/redirect'
 require 'shaf_client/resource'
 require 'shaf_client/form'
 
@@ -17,29 +20,34 @@ class ShafClient
     @client = Faraday.new(url: root_uri) do |conn|
       conn.basic_auth(@user, @pass) if basic_auth?
       conn.use Middleware::Cache, auth_header: auth_header
+      conn.use Middleware::Redirect
       conn.adapter adapter
     end
   end
 
-  def get_root
-    get(@root_uri)
+  def get_root(**options)
+    get(@root_uri, **options)
   end
 
-  def get_form(uri)
-    response = request(method: :get, uri: uri)
-    Form.new(self, response.body)
+  def get_form(uri, **options)
+    response = request(method: :get, uri: uri, opts: options)
+    Form.new(self, response.body, response.status, response.headers)
   end
 
-  def get_doc(uri)
-    response = request(method: :get, uri: uri)
+  def get_doc(uri, **options)
+    response = request(method: :get, uri: uri, opts: options)
     response&.body || ''
   end
 
   %i[get put post delete patch].each do |method|
-    define_method(method) do |uri, payload = nil|
-      with_resource do
-        request(method: method, uri: uri, payload: payload)
-      end
+    define_method(method) do |uri, payload: nil, **options|
+      response = request(
+        method: method,
+        uri: uri,
+        payload: payload,
+        opts: options
+      )
+      Resource.new(self, response.body, response.status, response.headers)
     end
   end
 
@@ -71,17 +79,15 @@ class ShafClient
     @user && @pass
   end
 
-  def with_resource
-    response = yield
-    Resource.new(self, response.body)
-  end
-
-  def request(method:, uri:, payload: nil, headers: {})
+  def request(method:, uri:, payload: nil, opts: {})
     payload = JSON.generate(payload) if payload&.is_a?(Hash)
+    headers = @default_headers.merge(opts.fetch(:headers, {}))
+    headers[:skip_cache] = true if opts[:skip_cache]
+
     @client.send(method) do |req|
       req.url uri
       req.body = payload if payload
-      req.headers.merge! @default_headers.merge(headers)
+      req.headers.merge! headers
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2018-12-09 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -92,6 +92,7 @@ files:
 - lib/shaf_client/form.rb
 - lib/shaf_client/link.rb
 - lib/shaf_client/middleware/cache.rb
+- lib/shaf_client/middleware/redirect.rb
 - lib/shaf_client/resource.rb
 homepage: https://github.com/sammyhenningsson/shaf_client
 licenses: