web_function 0.4.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc10b3e4f558c7bec819e5f9029f672df3e37e5e5c66790df2e1159d2b06acec
-  data.tar.gz: deb73a647c14e886ef7b3be4e69a5a080fead74ef00119b56af86b57462452d5
+  metadata.gz: c025fe8ca089b9531bc819d3154438bb29eb0b5fa823509b212fb23858403b5f
+  data.tar.gz: 6e2efbc2c7a4ebaef81ef95b8485b8822666a01967ebb46a3220ddab2caf26a1
 SHA512:
-  metadata.gz: 37b3060aefd75b936ce0c5e9f3e1ec7e20f84ab118840f262d4631b020cebba24aaa9df251c1bb37560ff881df42412c688b6c6f519bacfe377aa4a5230676d3
-  data.tar.gz: 6240884af37b04edf66426653b9d8de19445be9817c93b624bccbb2ed0ca290ccce6dd98669ea2c2d7c114c8ec03c4b6c0fee1871c33e36fb7aeeb65d92517fb
+  metadata.gz: acbc56f7b1b5ec89c17eb8f44699197ded36a0c3db4e722b57087bf164c0fe1f2a3c62e15223971e488721008891ce1714d2b2ce8a82dd0267b950694e8b4a46
+  data.tar.gz: 9028501396902aa1adb0ebe548eaa4f16bf9065c11e3777512ae5ef31652e9d007dffa5b2bdff60c95c5bb451221145b6a5e08d0bd73a89e34befe73db534597

data/exe/wfn

@@ -2,3 +2,45 @@
 # frozen_string_literal: true
 
 require "web_function"
+require "json"
+
+# Usage:
+#   wfn call --auth token endpoint_url key1=value1 [key2=value2 ...]
+
+auth_token = nil
+auth_index = ARGV.index("--auth")
+if auth_index
+  auth_token = ARGV[auth_index + 1]
+  ARGV.slice!(auth_index, 2)
+end
+
+version = nil
+version_index = ARGV.index("--version")
+if version_index
+  version = ARGV[version_index + 1]
+  ARGV.slice!(version_index, 2)
+end
+
+command = ARGV[0]
+
+case command
+when "call"
+  endpoint_url = ARGV[1]
+  args = JSON.parse(ARGV[2] || "{}")
+
+  begin
+    response = WebFunction::Request.execute(endpoint_url, bearer_auth: auth_token, version: version, args: args)
+    puts JSON.pretty_generate(response)
+  rescue WebFunction::Error => e
+    puts e
+    warn "error: [#{e.code}] #{e.message}"
+    warn ""
+    if e.details
+      warn JSON.pretty_generate(e.details).lines.map { |line| "|  #{line}" }.join
+    end
+    exit 2
+  end
+else
+  warn "Usage:\n  wfn docs package_url endpoint_name\n  wfn call --auth token endpoint_url key1=value1 [key2=value2 ...]"
+  exit 1
+end

data/lib/web_function/argument.rb

@@ -1,29 +1,135 @@
 # frozen_string_literal: true
 
 module WebFunction
+  # Arguments are used to define Web Function {Endpoint} request parameters.
+  #
+  # See the [arguments section][0] on the Web Function website for more details.
+  #
+  # [0]: https://webfunction.org/package#arguments
+  #
   class Argument
-    def initialize(argument)
-      @argument = argument
-    end
+    include Flaggable
 
-    def name
-      @argument["name"]
+    def initialize(name:, type:, hint: nil, group: nil, choices: [], flags: [], docs: nil)
+      @name = name
+      @type = type
+      @hint = hint
+      @group = group
+      @choices = choices
+      @flags = flags
+      @docs = docs.to_s
     end
 
-    def type
-      @argument["type"]
-    end
+    class << self
+      # Instantiate a new Argument from a hash, typically coming from a {Package}.
+      #
+      # @param argument [Hash]
+      #
+      # @return [Argument, nil]
+      #
+      def from_hash(argument)
+        unless argument.is_a?(Hash)
+          return
+        end
+
+        unless argument["name"]
+          return
+        end
 
-    def choices
-      @argument["choices"]
+        unless argument["type"]
+          return
+        end
+
+        new(
+          name: argument["name"],
+          type: argument["type"],
+          hint: argument["hint"],
+          group: argument["group"],
+          choices: [*argument["choices"]],
+          flags: Utils.normalize_array_of_strings(argument["flags"]),
+          docs: argument["docs"],
+        )
+      end
+
+      # Instantiate a collection of Argument from an array of hash, typically coming from a {Package}. Uses
+      # {Argument#from_hash} under the hood.
+      #
+      # @param arguments [Array<Hash>]
+      #
+      # @return [Array<Argument>]
+      #
+      def from_array(arguments)
+        Utils.normalize_array arguments do |argument|
+          from_hash(argument)
+        end
+      end
     end
 
-    def flags
-      @argument["flags"]
+    # The name of the argument.
+    #
+    # @return [String]
+    #
+    attr_reader :name
+
+    # The type of the argument. It must be one of:
+    #
+    # - object
+    # - array
+    # - string
+    # - number
+    # - boolean
+    #
+    # @return [String]
+    #
+    attr_reader :type
+
+    # A hint that further defines what kind of value to expect for an argument.
+    #
+    # See the [hints section][1] on the Web Function website for the full list of possible hints.
+    #
+    # @return [String]
+    #
+    # [1]: https://webfunction.org/package#hints
+    #
+    attr_reader :hint
+
+    # A name used to categorize or group similar arguments together. This should be used by documentation tools to
+    # organize related arguments.
+    #
+    # @return [String]
+    #
+    attr_reader :group
+
+    # An array specifying the exact, case-sensitive values that are permitted for this argument. Each value in the 
+    # choices array must conform to the data type specified in the argument's type key.
+    #
+    # Note that if the argument type is array, choices may contain strings or numbers representing the allowed values
+    # that can be included in the array.
+    #
+    # @return [Array]
+    #
+    attr_reader :choices
+
+    # Description of the argument. It must be formatted as markdown.
+    #
+    # @return [String]
+    #
+    attr_reader :docs
+
+    # Whether the argument is required.
+    #
+    # @return [Boolean]
+    #
+    def required?
+      flag?("required")
     end
 
-    def docs
-      @argument["docs"]
+    # Whether the argument is optional.
+    #
+    # @return [Boolean]
+    #
+    def optional?
+      !required?
     end
   end
 end

data/lib/web_function/attribute.rb

@@ -1,29 +1,124 @@
 # frozen_string_literal: true
 
 module WebFunction
+  # Attributes define output fields that may be produced and returned by a Web Function {Endpoint} when the type of the 
+  # return is `object`.
+  #
+  # See the [attributes section][0] on the Web Function website for more details about attribute definitions, 
+  # recognized keys, and usage.
+  #
+  # [0]: https://webfunction.org/package#attributes
+  #
   class Attribute
-    def initialize(attribute)
-      @attribute = attribute
-    end
+    include Flaggable
 
-    def name
-      @attribute["name"]
+    def initialize(name:, type:, hint: nil, values: [], flags: [], docs: nil)
+      @name = name
+      @type = type
+      @hint = hint
+      @values = values
+      @flags = flags
+      @docs = docs.to_s
     end
 
-    def type
-      @attribute["type"]
-    end
+    class << self
+      # Creates a new Attribute from a hash. Typically coming from a {Package}.
+      #
+      # @param attribute [Hash] The attribute hash
+      #
+      # @return [Attribute] A new Attribute instance
+      #
+      def from_hash(attribute)
+        unless attribute.is_a?(Hash)
+          return
+        end
 
-    def values
-      @attribute["values"]
-    end
+        unless attribute["name"]
+          return
+        end
+
+        unless attribute["type"]
+          return
+        end
+
+        new(
+          name: attribute["name"],
+          type: attribute["type"],
+          hint: attribute["hint"],
+          values: [*attribute["values"]],
+          flags: Utils.normalize_array_of_strings(attribute["flags"]),
+          docs: attribute["docs"],
+        )
+      end
 
-    def flags
-      @attribute["flags"]
+      # Creates a new Attribute from an array of hashes. Typically coming from a {Package}. Uses {Attribute#from_hash}
+      # under the hood.
+      #
+      # @param attributes [Array<Hash>] The attribute array of hashes
+      #
+      # @return [Array<Attribute>] A new array of Attribute instances
+      #
+      def from_array(attributes)
+        Utils.normalize_array attributes do |attribute|
+          from_hash(attribute)
+        end
+      end
     end
 
-    def docs
-      @attribute["docs"]
+    # The name of the attribute as it will appear in the endpoint's output
+    # object.
+    #
+    # This is required for the argument to be valid.
+    #
+    # @return [String]
+    #
+    attr_reader :name
+
+    # The type of value returned for this attribute. Must be one of:
+    #
+    # - object
+    # - array
+    # - string
+    # - number
+    # - boolean
+    #
+    # This is required for the argument to be valid.
+    #
+    # @return [String]
+    #
+    attr_reader :type
+
+    # A string hinting about the semantics of this attribute. See the [hints section][1] for possible values and 
+    # documentation tooling guidance.
+    #
+    # [1]: https://webfunction.org/package#hints
+    #
+    # @return [String, nil]
+    #
+    attr_reader :hint
+
+    # An array specifying the exact, case-sensitive values that may be returned for this attribute. Each value in the 
+    # values array must conform to the data type specified in the "type" key.
+    #
+    # This is useful for attributes that can only take a select set of values (enums or constants).
+    #
+    # @return [Array]
+    #
+    attr_reader :values
+
+    # A markdown string describing this attribute and its purpose in the output object. Used by documentation tools, 
+    # and highly recommended.
+    #
+    # @return [String]
+    #
+    attr_reader :docs
+
+    # Whether the attribute can be null.
+    #
+    # @return [Boolean]
+    #
+    def nullable?
+      flag?("nullable")
     end
   end
 end

data/lib/web_function/client.rb

@@ -1,52 +1,116 @@
 # frozen_string_literal: true
 
 module WebFunction
-  class Client
-    def initialize(package, bearer_auth: nil, pipeline: nil)
+  # A {Client} is a wrapper around a Web Function {Package} that provides a convenient interface for invoking endpoints.
+  #
+  # @example
+  #   client = WebFunction::Client.from_package_endpoint("https://api.webfunction.com/package")
+  #   client.list_items(a: "b") # => { "c" => "d" }
+  #
+  class Client < BasicObject
+    def initialize(base_url:, endpoints: [], package: nil, bearer_auth: nil, version: nil, pipeline: nil)
       @package = package
-      @endpoints = package.endpoints.to_h { |e| [e.name.gsub("-", "_").to_sym, e] }
+      @base_url = base_url
+      @endpoints = endpoints.to_h { |e| [e.gsub("-", "_").to_sym, e] }
       @bearer_auth = bearer_auth
+      @version = version
       @pipeline = pipeline
     end
 
-    attr_reader :package
+    class << self
+      # Creates a new {Client} from an url.
+      #
+      # @param url [String] The URL of the package endpoint
+      # @param bearer_auth [String] The bearer authentication token
+      # @param version [String] The API version to use
+      # @param pipelined [Boolean] Whether to have the client use call pipelining
+      #
+      # @return [Client]
+      #
+      def from_package_endpoint(url, bearer_auth: nil, version: nil, pipelined: false)
+        response = ::WebFunction::Request.execute(url, bearer_auth: bearer_auth, version: version)
+        package = ::WebFunction::Package.from_hash(response)
+
+        from_package(package, bearer_auth: bearer_auth, version: version, pipelined: pipelined)
+      end
+
+      # Creates a new {Client} from a {Package}.
+      #
+      # @param package [Package] A package
+      # @param bearer_auth [String] The bearer authentication token
+      # @param version [String] The API version to use
+      # @param pipelined [Boolean] Whether to have the client use call pipelining
+      #
+      # @return [Client]
+      #
+      def from_package(package, bearer_auth: nil, version: nil, pipelined: nil)
+        pipeline = nil
 
-    def self.from_package_endpoint(url, bearer_auth: nil, pipeline_url: nil, pipeline: nil)
-      response = Endpoint.invoke(url, bearer_auth: bearer_auth)
-      package = Package.new(response)
+        if pipelined
+          pipeline = package.pipeline
+        end
 
-      if pipeline.is_a?(String)
-        pipeline = WebFunction::Pipeline.new(pipeline)
+        client = new(
+          package: package,
+          base_url: package.base_url,
+          endpoints: package.endpoints.map(&:name),
+          bearer_auth: bearer_auth,
+          version: version,
+          pipeline: pipeline,
+        )
+
+        package.endpoints.each do |endpoint|
+          endpoint.client = client
+        end
+
+        client
       end
+    end
+
+    # Call an endpoint by name with the given arguments.
+    #
+    # @param endpoint_name [String] The name of the endpoint to call
+    # @param args [Hash] The arguments to send to the endpoint
+    #
+    # @return [Object] The decoded response returned by the endpoint
+    #
+    def call(endpoint_name, args = {})
+      url = ::URI.join(@base_url, endpoint_name).to_s
+      request = ::WebFunction::Request.new(url,
+        bearer_auth: @bearer_auth,
+        version: @version,
+        args: args,
+      )
 
-      new(package, bearer_auth: bearer_auth, pipeline: pipeline)
+      if @pipeline
+        @pipeline.add_step(request.as_pipeline_step)
+      else
+        request.execute
+      end
     end
 
-    def methods
-      super + @endpoints.keys
+    # The package that this client is wrapping.
+    #
+    # @return [Package]
+    #
+    attr_reader :package
+
+    def methods # :nodoc:
+      @endpoints.keys
     end
 
-    def respond_to_missing?(method_name, include_private = false)
-      @endpoints[method_name] || super
+    def respond_to_missing?(method_name, include_private = false) # :nodoc:
+      @endpoints[method_name]
     end
 
-    def method_missing(method_name, *args)
-      endpoint = @endpoints[method_name]
+    def method_missing(method_name, *args) # :nodoc:
+      endpoint_name = @endpoints[method_name]
 
-      unless endpoint
+      unless endpoint_name
         super
       end
 
-      url = URI.join(@package.base_url, endpoint.name).to_s
-      args = args.first
-
-      if @pipeline
-        step = Endpoint.invoke(url, bearer_auth: @bearer_auth, args: args, as_step: true)
-        promise = @pipeline.add_step(step)
-        return promise
-      end
-
-      Endpoint.invoke(url, bearer_auth: @bearer_auth, args: args)
+      call(endpoint_name, args.first)
     end
   end
 end

data/lib/web_function/documented_error.rb

@@ -1,15 +1,67 @@
+# frozen_string_literal: true
+
 module WebFunction
+  # Represents an error definition as described in a Web Function package.
+  #
+  # An error definition documents the possible errors that an endpoint might return, including a machine-readable error
+  # code and a human-readable description.
+  #
+  # See the [error definition documentation][0] on the Web Function website for more details, including recognized keys
+  # and usage recommendations.
+  #
+  # [0]: https://webfunction.org/package#error-definition
+  #
   class DocumentedError
-    def initialize(error)
-      @error = error
+    def initialize(code:, docs: nil)
+      @code = code
+      @docs = docs.to_s
     end
 
-    def code
-      @error["code"]
-    end
+    class << self
+      # Creates a new DocumentedError from a hash.
+      #
+      # @param error [Hash] The error hash
+      #
+      # @return [DocumentedError] A new DocumentedError instance
+      #
+      def from_hash(error)
+        unless error.is_a?(Hash)
+          return
+        end
+
+        unless error["code"]
+          return
+        end
 
-    def docs
-      @error["docs"]
+        new(
+          code: error["code"],
+          docs: error["docs"],
+        )
+      end
+
+      # Creates a new DocumentedError from an array of hashes. Uses {DocumentedError#from_hash} under the hood.
+      #
+      # @param errors [Array<Hash>] The error array of hashes
+      #
+      # @return [Array<DocumentedError>] A new array of DocumentedError instances
+      #
+      def from_array(errors)
+        Utils.normalize_array errors do |error|
+          from_hash(error)
+        end
+      end
     end
+
+    # The machine-readable code of the error.
+    #
+    # @return [String]
+    #
+    attr_reader :code
+
+    # The documentation of the error.
+    #
+    # @return [String]
+    #
+    attr_reader :docs
   end
-end
+end