shaf_client 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a7f2a17ed01c0b131194c0ca4516280d219d5a36a2f3afc38f4ccc314a5f0a
-  data.tar.gz: f2c91a861378440ded31fa39bd364ad80d4ecf57408f1b51219c746883f254d8
+  metadata.gz: 19b9d623cc520b186b862d8604530daabf1723bc5a3b5d159dac3ecca706f1fb
+  data.tar.gz: 5ee331304969c4c873429914c521be63aaa849f94e5a09c94f6ba4fec06f9049
 SHA512:
-  metadata.gz: 4595ff9d2c6bf0665a0f541f428de36b8f420543a0ad0d6c208dbdc70b7b1d5aa0369dd16e8a5f2cfa254b995aabc7f2151047ab539d24ce32a0002a319d7e21
-  data.tar.gz: 1933d7180df83cba97c2be59b6bff59c86545151cf9caffab0a7b1e0e036cc152bcd1567c31a1a4f8f3ad0a5719139ff6c01bc09a4e47940a8c3a66925e33432
+  metadata.gz: 85305d86a68ad781d0608aca92c595dca9403a7a420900560fc50828af4b6a663a3731fe7de10b73efaab75e2f0430a5f52ffce1003dcb32b511380e85577358
+  data.tar.gz: f9fc05a4f34e6dad3f83ee583fa8329ae665bf537522a7a1e950a818e97cc869a4109a73f909000cf4ef49a90e4571f595b54b679ce74cedd15826e775dc6a29

data/lib/shaf_client.rb

@@ -6,7 +6,8 @@ require 'json'
 require 'shaf_client/error'
 require 'shaf_client/middleware/redirect'
 require 'shaf_client/resource'
-require 'shaf_client/form'
+require 'shaf_client/shaf_form'
+require 'shaf_client/hal_form'
 require 'shaf_client/api_error'
 require 'shaf_client/empty_resource'
 require 'shaf_client/unknown_resource'
@@ -44,7 +45,7 @@ class ShafClient
       )
 
       body = String(response.body)
-      response.headers['content-type'] = '__shaf_client_emtpy__' if body.empty?
+      response.headers['content-type'] = nil if body.empty?
 
       Resource.build(self, body, response.status, response.headers)
     end

data/lib/shaf_client/curie.rb

@@ -21,5 +21,10 @@ class ShafClient
       @href = href
       @templated = !!templated
     end
+
+    def resolve_templated(**args)
+      args[:rel] &&= args[:rel].to_s.sub(/#{name}:/, '')
+      super(**args)
+    end
   end
 end

data/lib/shaf_client/empty_resource.rb

@@ -4,7 +4,7 @@ class ShafClient
   class EmptyResource < Resource
     attr_reader :http_status, :headers
 
-    ResourceMapper.register('__shaf_client_emtpy__', self)
+    ResourceMapper.register(nil, self)
 
     def initialize(_client, _payload, status = nil, headers = {})
       @http_status = status

data/lib/shaf_client/field.rb

@@ -0,0 +1,75 @@
+require 'json'
+
+class ShafClient
+  class Field
+    attr_reader :name, :prompt, :required, :read_only,
+      :hidden, :templated, :type, :value, :regex
+
+    def initialize(
+      name:,
+      prompt: nil,
+      title: nil,
+      required: false,
+      read_only: false,
+      hidden: false,
+      templated: false,
+      type: nil,
+      value: nil,
+      regex: nil
+    )
+      @name = name.to_sym
+      @prompt = prompt || title || name
+      @required = required
+      @read_only = read_only
+      @hidden = hidden
+      @templated = templated
+      @type = type&.downcase
+      @value = value
+      @regex = parse_regexp(regex)
+    end
+
+    def valid?(value)
+      return false unless validate_required(value)
+      return false unless validate_number(value)
+      return false unless validate_string(value)
+      return false unless validate_regexp(value)
+      true
+    end
+
+    private
+
+    def validate_required(value)
+      return true unless required
+      return false if String(value).empty?
+      true
+    end
+
+    def validate_number(value)
+      return true if value.nil?
+      return true unless type
+      return true unless %w[int integer number].include? type
+      value.is_a? Numeric
+    end
+
+    def validate_string(value)
+      return true if value.nil?
+      return true unless type
+      return true unless %w[string text].include? type
+      value.is_a? String
+    end
+
+    def validate_regexp(value)
+      str = String(value)
+      return true if str.empty?
+      return true unless regex
+      str.match? regex
+    end
+
+    def parse_regexp(str)
+      return if String(str).empty?
+      Regexp.new(str)
+    rescue RegexpError
+      nil
+    end
+  end
+end

data/lib/shaf_client/form.rb

@@ -1,42 +1,65 @@
+# frozen_string_literal: true
+
 require 'json'
+require 'uri'
 require 'shaf_client/link'
+require 'shaf_client/field'
 
 class ShafClient
   class Form < Resource
 
-    profile 'shaf-form'
-
     def values
       return @values if defined? @values
 
-      @values = attribute(:fields).each_with_object({}) do |d, v|
-        v[d['name'].to_sym] = d['value']
+      @values = fields.each_with_object({}) do |field, values|
+        values[field.name] = field.value
       end
     end
 
     def [](key)
-      values[key.to_sym]
+      values.fetch(key.to_sym)
     end
 
     def []=(key, value)
+      values.fetch(key.to_sym) # Raise KeyError unless key exist!
       values[key.to_sym] = value
     end
 
+    def title
+      raise NotImplementedError
+    end
+
     def target
-      attribute(:href)
+      raise NotImplementedError
     end
 
     def http_method
-      attribute(:method).downcase.to_sym
+      raise NotImplementedError
+    end
+
+    def content_type
+      raise NotImplementedError
+    end
+
+    def fields
+      raise NotImplementedError
     end
 
     def submit
-      client.send(http_method, target, payload: @values)
+      client.send(
+        http_method,
+        target,
+        payload: encoded_payload,
+        headers: {'Content-Type' => content_type}
+      )
     end
 
     def valid?
-      attribute(:fields).all? do |field|
-        valid_field? field
+      field_value_mapping
+
+      fields.all? do |field|
+        value = values[field.name.to_sym]
+        field.valid? value
       end
     end
 
@@ -50,32 +73,24 @@ class ShafClient
       super
     end
 
-    def valid_field?(field)
-      key = field['name'].to_sym
-      return false unless validate_required(field, key)
-      return true  if values[key].nil?
-      return false unless validate_number(field, key)
-      return false unless validate_string(field, key)
-      true
-    end
-
     private
 
-    def validate_required(field, key)
-      return true unless field['required']
-      return false if values[key].nil?
-      return false if values[key].respond_to?(:empty) && values[key].empty?
-      true
+    def encoded_payload
+      if content_type&.downcase == 'application/x-www-form-urlencoded'
+        URI.encode_www_form(values)
+      else
+        JSON.generate(values) 
+      end
     end
 
-    def validate_string(field, key)
-      return true unless %w[string text].include? field.fetch('type', '').downcase
-      values[key].is_a? String
+    def field_names
+      fields.map { |f| f.name.to_sym }
     end
 
-    def validate_number(field, key)
-      return true unless %w[int integer number].include? field.fetch('type', '').downcase
-      values.fetch(key, 0).is_a? Numeric
+    def field_value_mapping
+      field_names.each_with_object({}) do |name, mapping|
+        mapping[name.to_sym] = values[name.to_sym]
+      end
     end
   end
 end

data/lib/shaf_client/hal_form.rb

@@ -0,0 +1,39 @@
+require 'shaf_client/form'
+
+class ShafClient
+  class HalForm < Form
+    attr_accessor :target
+
+    content_type 'application/prs.hal-forms+json'
+
+    def title
+      template[:title]
+    end
+
+    def name
+      attribute(:name)
+    end
+
+    def http_method
+      template[:method].downcase.to_sym
+    end
+
+    def content_type
+      template[:contentType]
+    end
+
+    def fields
+      template[:properties].map do |values|
+        Field.new(values.transform_keys(&:to_sym))
+      end
+    end
+
+    private
+
+    def template
+      @template ||= attributes
+        .dig(:_templates, 'default')
+        .transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/shaf_client/link.rb

@@ -2,8 +2,6 @@
 
 class ShafClient
   class Link
-    attr_reader :templated
-
     def self.from(data)
       if data.is_a? Array
         data.map { |d| new(href: d['href'], templated: d['templated']) }
@@ -17,7 +15,9 @@ class ShafClient
       @templated = !!templated
     end
 
-    alias templated? templated
+    def templated?
+      @templated
+    end
 
     def href
       @href.dup
@@ -26,10 +26,9 @@ class ShafClient
     def resolve_templated(**args)
       return href unless templated?
 
-      args.inject(href) do |uri, (key, value)|
-        value = value.to_s.sub(/.+:/, '')
-        uri.sub(/{#{key}}/, value)
-      end
+      href
+        .then { |href| resolve_required(href, **args) }
+        .then { |href| resolve_optional(href, **args) }
     end
 
     def to_h
@@ -38,5 +37,29 @@ class ShafClient
         templated: templated?
       }
     end
+
+    private
+
+    def resolve_required(href, **args)
+      String(href).gsub(/{(?!\?)([^}]*)}/) do
+        key = $1.to_sym
+        args.fetch key do
+          raise ArgumentError, "missing keyword: :#{key}"
+        end
+      end
+    end
+
+    def resolve_optional(href, **args)
+      String(href).gsub(/{\?([^}]*)}/) do
+        values = []
+        $1.split(',').each do |key|
+          next unless args.key? key.to_sym
+          values << "#{key}=#{args[key.to_sym]}"
+        end
+
+        next '' if values.empty?
+        "?#{values.join('&')}"
+      end
+    end
   end
 end

data/lib/shaf_client/resource.rb

@@ -49,6 +49,21 @@ class ShafClient
       client.get_doc(uri)
     end
 
+    def get_hal_form(rel)
+      href = link(rel).href
+      uri = rel.to_s
+      if uri.match? %r{:[^/]}
+        curie_name, rel = rel.split(':')
+        curie = curie(curie_name)
+        uri = curie.resolve_templated(rel: rel)
+      end
+
+      headers = {'Accept': 'application/prs.hal-forms+json'}
+      client.get(uri, headers: headers).tap do |form|
+        form.target = href if form.respond_to? :target= 
+      end
+    end
+
     def reload!
       self << get(:self, headers: {'Cache-Control': 'no-cache'})
     end

data/lib/shaf_client/resource_mapper.rb

@@ -3,12 +3,8 @@ require 'shaf_client/error'
 class ShafClient
   class ResourceMapper
     class << self
-      def all
-        @all ||= {}
-      end
-
       def for(content_type)
-        all[content_type&.to_sym].tap do |clazz|
+        mapping[content_type&.to_sym].tap do |clazz|
           next if clazz
           raise UnSupportedContentType,
             "Can't handle Content-Type: #{content_type}"
@@ -16,11 +12,17 @@ class ShafClient
       end
 
       def register(content_type, clazz)
-        all[content_type&.to_sym] = clazz
+        mapping[content_type&.to_sym] = clazz
       end
 
       def default=(clazz)
-        all.default = clazz
+        mapping.default = clazz
+      end
+
+      private
+
+      def mapping
+        @mapping ||= {}
       end
     end
   end

data/lib/shaf_client/shaf_form.rb

@@ -0,0 +1,34 @@
+require 'shaf_client/form'
+
+class ShafClient
+  class ShafForm < Form
+
+    profile 'shaf-form'
+
+    def title
+      attribute(:title)
+    end
+
+    def name
+      attribute(:name)
+    end
+
+    def target
+      attribute(:href)
+    end
+
+    def http_method
+      attribute(:method).downcase.to_sym
+    end
+
+    def content_type
+      attribute(:type)
+    end
+
+    def fields
+      attribute(:fields).map do |values|
+        Field.new(values.transform_keys(&:to_sym))
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shaf_client
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Sammy Henningsson
@@ -30,7 +30,7 @@ cert_chain:
   ZMhjYR7sRczGJx+GxGU2EaR0bjRsPVlC4ywtFxoOfRG3WaJcpWGEoAoMJX6Z0bRv
   M40=
   -----END CERTIFICATE-----
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -106,11 +106,14 @@ files:
 - lib/shaf_client/curie.rb
 - lib/shaf_client/empty_resource.rb
 - lib/shaf_client/error.rb
+- lib/shaf_client/field.rb
 - lib/shaf_client/form.rb
+- lib/shaf_client/hal_form.rb
 - lib/shaf_client/link.rb
 - lib/shaf_client/middleware/redirect.rb
 - lib/shaf_client/resource.rb
 - lib/shaf_client/resource_mapper.rb
+- lib/shaf_client/shaf_form.rb
 - lib/shaf_client/unknown_resource.rb
 homepage: https://github.com/sammyhenningsson/shaf_client
 licenses: