codegram/hyperclient

View on GitHub
lib/hyperclient/resource.rb

Summary

Maintainability
A
25 mins
Test Coverage
require 'forwardable'

module Hyperclient
  # Public: Exception that is raised when passing in invalid representation data
  # for the resource.
  class InvalidRepresentationError < ArgumentError
    attr_reader :representation

    def initialize(error_description, representation)
      super(error_description)
      @representation = representation
    end
  end

  # Public: Represents a resource from your API. Its responsability is to
  # ease the way you access its  attributes, links and embedded resources.
  class Resource
    extend Forwardable

    # Public: Returns the attributes of the Resource as Attributes.
    attr_reader :_attributes

    # Public: Returns the links of the Resource as a LinkCollection.
    attr_reader :_links

    # Public: Returns the embedded resource of the Resource as a
    # ResourceCollection.
    attr_reader :_embedded

    # Public: Returns the response object for the HTTP request that created this
    # resource, if one exists.
    attr_reader :_response

    # Public: Delegate all HTTP methods (get, post, put, delete, options and
    # head) to its self link.
    def_delegators :_self_link, :_get, :_post, :_put, :_delete, :_options, :_head

    # Public: Initializes a Resource.
    #
    # representation - The hash with the HAL representation of the Resource.
    # entry_point    - The EntryPoint object to inject the configutation.
    def initialize(representation, entry_point, response = nil)
      representation = validate(representation)
      links = representation['_links'] || {}

      @_links       = LinkCollection.new(links, links['curies'], entry_point)
      @_embedded    = ResourceCollection.new(representation['_embedded'], entry_point)
      @_attributes  = Attributes.new(representation)
      @_entry_point = entry_point
      @_response    = response
    end

    def inspect
      "#<#{self.class.name} self_link:#{_self_link.inspect} attributes:#{@_attributes.inspect}>"
    end

    def _success?
      _response&.success?
    end

    def _status
      _response&.status
    end

    def [](name)
      send(name) if respond_to?(name)
    end

    def fetch(key, *args)
      return self[key] if respond_to?(key)

      if args.any?
        args.first
      elsif block_given?
        yield key
      else
        raise KeyError
      end
    end

    private

    # Internal: Ensures the received representation is a valid Hash-lookalike.
    def validate(representation)
      return {} if representation.nil? || representation.empty?

      if representation.respond_to?(:to_hash)
        representation.to_hash.dup
      else
        raise InvalidRepresentationError.new(
          "Invalid representation for resource (got #{representation.class}, expected Hash). " \
          "Is your web server returning JSON HAL data with a 'Content-Type: application/hal+json' header?",
          representation
        )
      end
    end

    # Internal: Returns the self Link of the Resource. Used to handle the HTTP
    # methods.
    def _self_link
      @_links['self']
    end

    # Internal: Delegate the method to various elements of the resource.
    #
    # This allows `api.posts` instead of `api.links.posts.resource`
    # as well as api.posts(id: 1) assuming posts is a link.
    def method_missing(method, *args, &block)
      if args.any? && args.first.is_a?(Hash)
        _links.send(method, [], &block)._expand(*args)
      elsif !Array.method_defined?(method)
        %i[_attributes _embedded _links].each do |target|
          target = send(target)
          return target.send(method, *args, &block) if target.respond_to?(method.to_s)
        end
        super
      end
    end

    # Internal: Accessory method to allow the resource respond to
    # methods that will hit method_missing.
    def respond_to_missing?(method, include_private = false)
      %i[_attributes _embedded _links].each do |target|
        return true if send(target).respond_to?(method, include_private)
      end
      false
    end
  end
end