shaf_client 0.6.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4ef66759fc8f50747be3c2db4cc9b723ccdb0d0fcce0ed1889b485de2376577
-  data.tar.gz: ae7f83ed0066939cf04784ce5fbcd128b193db0b708327129d47f53b3028b09f
+  metadata.gz: 688d7345f3b3c1962b973d323845060cf57b92aeb7b60de4b6f680e566414edf
+  data.tar.gz: 4ccaecadff24f4a78a805f9998af50f93857ac461505c4fc48832e34884123d4
 SHA512:
-  metadata.gz: 0bf113e75dc7c84a6801d8e665886938c1987426b251cfbebfb9e35161504a1053d32f6b7d87143f79997057d262590b1f2ebda86889871fc4aa9d8d7af1d6e4
-  data.tar.gz: dddad11c115f767ef389b4052b5e4ae302bccd19ecbed3db27b5818a61a37922ac4445a3b5ea17f42d94ddfa8c39f20b5c6a167854fa214b37e11755fce439aa
+  metadata.gz: 8904fef8dc91ed8baa3fa92d434569b4f83a443e1274df372334a27a1a4fb84d3b5a8bfd5956ca85abf08957ec0c28520c424216ec7eaf9edf5719d72d336cde
+  data.tar.gz: 5328f8b5053b81c590b755c25bf8423b9902f7ea0cfe2a03aacf2317f7eccbe49032276e1a6d2abb304823283436eb5e3f6445b2ceb4785d79f8fdc99d51289e

data/bin/shaf_client

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(__dir__, '../lib/')
+
+require 'irb'
+require 'optparse'
+require 'shaf_client'
+
+url = ARGV.shift || String(ENV['SHAF_CLIENT_URL'])
+options = {
+  user: ENV['SHAF_CLIENT_USER'],
+  password: ENV['SHAF_CLIENT_PASSWORD']
+}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: shaf_client [url]"
+
+  opts.on("-u", "--user user", "Username used for authentication") do |user|
+    options[:user] = user
+  end
+
+  opts.on("-p", "--password password", "Password used for authentication") do |pass|
+    options[:password] = pass
+  end
+end.parse! ARGV
+
+client = ShafClient.new(url, **options) unless url.empty?
+TOPLEVEL_BINDING.local_variable_set(:client, client)
+
+IRB.start

data/lib/faraday_http_cache_patch.rb

@@ -0,0 +1,17 @@
+faraday_version = Gem.loaded_specs['faraday']&.version.to_s
+faraday_http_cache_version = Gem.loaded_specs['faraday-http-cache']&.version.to_s
+
+if faraday_version.start_with?("0.16") && faraday_http_cache_version <= '2.0.0'
+  module Faraday
+    class HttpCache < Faraday::Middleware
+      def create_response(env)
+        hash = env.to_hash
+        {
+          status: hash[:status],
+          body: hash[:response_body] || hash[:body],
+          response_headers: hash[:response_headers]
+        }
+      end
+    end
+  end
+end

data/lib/shaf_client.rb

@@ -2,20 +2,36 @@
 
 require 'faraday'
 require 'faraday-http-cache'
+
+# FIXME remove this when faraday-http-cache has released  this fix
+# https://github.com/plataformatec/faraday-http-cache/pull/116
+require 'faraday_http_cache_patch'
+
 require 'json'
 require 'shaf_client/error'
+require 'shaf_client/mime_types'
 require 'shaf_client/middleware/redirect'
 require 'shaf_client/resource'
 require 'shaf_client/shaf_form'
 require 'shaf_client/hal_form'
 require 'shaf_client/api_error'
+require 'shaf_client/problem_json'
+require 'shaf_client/alps_json'
 require 'shaf_client/empty_resource'
 require 'shaf_client/unknown_resource'
+require 'shaf_client/hypertext_cache_strategy'
 
 class ShafClient
-  MIME_TYPE_JSON = 'application/json'
-  MIME_TYPE_HAL  = 'application/hal+json'
+  extend HypertextCacheStrategy
+  include MimeTypes
+
   DEFAULT_ADAPTER = :net_http
+  DEFAULT_ACCEPT_HEADER = [
+    MIME_TYPE_HAL,
+    MIME_TYPE_PROBLEM_JSON,
+    MIME_TYPE_ALPS_JSON,
+    '*/*;q=0.8',
+  ].join(', ')
 
   def initialize(root_uri, **options)
     @root_uri = root_uri.dup
@@ -30,12 +46,7 @@ class ShafClient
     get(@root_uri, **options)
   end
 
-  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|
+  %i[head get put post delete patch].each do |method|
     define_method(method) do |uri, payload: nil, **options|
       response = request(
         method: method,
@@ -45,17 +56,12 @@ class ShafClient
       )
 
       body = String(response.body)
-      response.headers['content-type'] = nil if body.empty?
+      content_type = response.headers['content-type'] unless body.empty?
 
-      Resource.build(self, body, response.status, response.headers)
+      Resource.build(self, body, content_type, response.status, response.headers)
     end
   end
 
-  def stubs
-    return unless @adapter == :test
-    @stubs ||= Faraday::Adapter::Test::Stubs.new
-  end
-
   private
 
   attr_reader :options, :auth_header
@@ -63,7 +69,7 @@ class ShafClient
   def setup_default_headers
     @default_headers = {
       'Content-Type' => options.fetch(:content_type, MIME_TYPE_JSON),
-      'Accept' => options.fetch(:accept, MIME_TYPE_HAL)
+      'Accept' => options.fetch(:accept, DEFAULT_ACCEPT_HEADER)
     }
     return unless token = options[:auth_token]
 
@@ -101,9 +107,11 @@ class ShafClient
   end
 
   def connect_adapter(connection)
-    args = [@adapter]
-    args << stubs if @adapter == :test
-    connection.adapter(*args)
+    connection.adapter(*adapter_args)
+  end
+
+  def adapter_args
+    [@adapter]
   end
 
   def request(method:, uri:, payload: nil, opts: {})

data/lib/shaf_client/alps/descriptor.rb

@@ -0,0 +1,60 @@
+require 'shaf_client/alps/extension'
+
+class ShafClient
+  module Alps
+    class Descriptor
+      attr_reader :id, :href, :name, :type, :doc, :ext
+
+      def initialize(id:, **kwargs)
+        @id   = id.to_sym
+        @href = kwargs[:href]
+        @name = kwargs[:name]
+        @type = kwargs[:type]
+        @doc  = kwargs[:doc]
+        @ext  = parse_extentions(kwargs[:ext])
+      end
+
+      alias extensions ext
+
+      def to_h
+        {
+          id: id,
+          href: href,
+          name: name,
+          type: type,
+          doc: doc,
+          ext: extensions.map(&:to_h),
+        }
+      end
+
+      def semantic?
+        type == 'semantic'
+      end
+
+      def safe?
+        type == 'safe'
+      end
+
+      def idempotent?
+        type == 'idempotent'
+      end
+
+      def unsafe?
+        type == 'unsafe'
+      end
+
+      def extension(id)
+        extensions.find { |ext| ext.id == id.to_sym }
+      end
+
+      private
+
+      def parse_extentions(extensions)
+        extensions ||= []
+        extensions = [extensions] unless extensions.is_a? Array
+        extensions.map { |ext| Extension.new(**ext.transform_keys(&:to_sym)) }
+      end
+    end
+  end
+end
+

data/lib/shaf_client/alps/extension.rb

@@ -0,0 +1,35 @@
+class ShafClient
+  module Alps
+    class Extension
+      attr_reader :id, :href, :value
+
+      def initialize(id:, href: nil, value: nil)
+        @id = id.to_sym
+        @href = href
+        @value = value
+      end
+
+      def to_h
+        {
+          id: id,
+          href: href,
+          value: value,
+        }
+      end
+
+      private
+
+      def method_missing(method_name, *args, &block)
+        name = method_name.to_s
+        return super unless name.end_with? '?'
+
+        id.to_s == name[0..-2]
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        return true if method_name.to_s.end_with? '?'
+        super
+      end
+    end
+  end
+end

data/lib/shaf_client/alps_json.rb

@@ -0,0 +1,44 @@
+require 'shaf_client/alps/descriptor'
+
+class ShafClient
+  class AlpsJson < Resource
+    content_type MIME_TYPE_ALPS_JSON
+
+    attr_reader :descriptors
+
+    def initialize(_client, payload, status = nil, headers = {})
+      super
+
+      @links = {}.freeze
+      @curies = {}.freeze
+      @embedded_resources = {}.freeze
+    end
+
+    def to_h
+      attributes.merge(
+        descriptors: descriptors.map(&:to_h)
+      )
+    end
+
+    def descriptor(id)
+      descriptors.find { |desc| desc.id == id.to_sym }
+    end
+
+    def each_descriptor(&block)
+      descriptors.each(&block)
+    end
+
+    private
+
+    def parse
+      alps = payload&.dig('alps') || {}
+      @attributes = {
+        version: alps['version'],
+        doc: alps['doc'],
+      }
+      @descriptors = alps.fetch('descriptor', []).map do |desc|
+        Alps::Descriptor.new(**desc.transform_keys(&:to_sym))
+      end
+    end
+  end
+end

data/lib/shaf_client/api_error.rb

@@ -4,7 +4,8 @@ require 'shaf_client/link'
 class ShafClient
   class ApiError < Resource
 
-    profile 'shaf-error'
+    profile 'shaf-error' # Legacy profiles
+    profile 'urn:shaf:error' # New style. Shaf version >= 2.1.0
 
     def title
       attribute(:title)

data/lib/shaf_client/base_resource.rb

@@ -10,8 +10,13 @@ class ShafClient
       @payload =
         if payload&.is_a? String
           JSON.parse(payload)
+        elsif payload.respond_to? :to_h
+          payload.to_h
         else
-          payload
+          raise Error, <<~ERR
+            Trying to create an instance of #{self.class} with a payload that
+            cannot be coerced into a Hash
+          ERR
         end
 
       parse
@@ -19,8 +24,9 @@ class ShafClient
 
     def to_h
       attributes.dup.tap do |hash|
-        hash[:_links] = transform_values_to_s(links)
-        embedded = transform_values_to_s(embedded_resources)
+        hash[:_links] = transform_values_to_h(links)
+        hash[:_links].merge!(curies: curies.values.map(&:to_h)) unless curies.empty?
+        embedded = transform_values_to_h(embedded_resources)
         hash[:_embedded] = embedded unless embedded.empty?
       end
     end
@@ -33,32 +39,28 @@ class ShafClient
       to_s
     end
 
-    def attribute(key)
-      raise Error, "No attribute for key: #{key}" unless attributes.key? key
-      attributes.fetch(key.to_sym)
+    def attribute(key, &block)
+      block ||= proc { raise Error, "No attribute for key: #{key}" }
+      _attribute(key, &block)
     end
 
-    def link(rel)
-      rewritten_rel = best_match(links.keys, rel)
-      raise Error, "No link with rel: #{rel}" unless links.key? rewritten_rel
-      links[rewritten_rel]
+    def link(rel, &block)
+      block ||= proc { raise Error, "No link with rel: #{rel}" }
+      _link(rel, &block)
     end
 
-    def curie(rel)
-      raise Error, "No curie with rel: #{rel}" unless curies.key? rel.to_sym
-      curies[rel.to_sym]
+    def curie(rel, &block)
+      block ||= proc { raise Error, "No curie with rel: #{rel}" }
+      _curie(rel, &block)
     end
 
-    def embedded(rel)
-      rewritten_rel = best_match(embedded_resources.keys, rel)
-      unless embedded_resources.key? rewritten_rel
-        raise Error, "No embedded resources with rel: #{rel}"
-      end
-      embedded_resources[rewritten_rel]
+    def embedded(rel, &block)
+      block ||= proc { raise Error, "No embedded resources with rel: #{rel}" }
+      _embedded(rel, &block)
     end
 
     def rel?(rel)
-      !link(rel).nil?
+      !link(rel).nil? || !embedded(rel).nil?
     rescue StandardError
       false
     end
@@ -77,6 +79,40 @@ class ShafClient
       @payload ||= {}
     end
 
+    def _attribute(key, &block)
+      if block
+        attributes.fetch(key.to_sym, &block)
+      else
+        attributes[key.to_sym]
+      end
+    end
+
+    def _link(rel, &block)
+      rewritten_rel = best_match(links.keys, rel)
+      if block
+        links.fetch(rewritten_rel, &block)
+      else
+        links[rewritten_rel]
+      end
+    end
+
+    def _curie(rel, &block)
+      if block
+        curies.fetch(rel.to_sym, &block)
+      else
+        curies[rel.to_sym]
+      end
+    end
+
+    def _embedded(rel, &block)
+      rewritten_rel = best_match(embedded_resources.keys, rel)
+      if block
+        embedded_resources.fetch(rewritten_rel, &block)
+      else
+        embedded_resources[rewritten_rel]
+      end
+    end
+
     def <<(other)
       @payload            = other.payload.dup
       @attributes         = other.attributes.dup
@@ -118,13 +154,17 @@ class ShafClient
       embedded.each do |key, value|
         @embedded_resources[key.to_sym] =
           if value.is_a? Array
-            value.map { |d| BaseResource.new(d) }
+            value.map { |d| build_embedded_resource(d) }
           else
-            BaseResource.new(value)
+            build_embedded_resource(value)
           end
       end
     end
 
+    def build_embedded_resource(payload)
+      BaseResource.new(payload)
+    end
+
     def method_missing(method_name, *args, &block)
       return super unless attributes.key?(method_name)
       attribute(method_name)
@@ -148,7 +188,7 @@ class ShafClient
       best_match(rels, rel.to_s.tr('_', '-')) if rel.to_s.include? '_'
     end
 
-    def transform_values_to_s(hash)
+    def transform_values_to_h(hash)
       hash.transform_values do |value|
         if value.is_a? Array
           value.map(&:to_h)