web_function 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8699012072dba58c29800e828b4fd2b5805943b174e8337b94d42d84f8429608
-  data.tar.gz: 8e15d51256a8ee847983cdf1c354bcddf8295698ad3a47357e251678606fe083
+  metadata.gz: 9884aca52c6ecf876a98ad979dabe109a30b1243238af1abb4bd42d76fbe3a9c
+  data.tar.gz: ee0208280fdc2918884de3206a1bfc79d4086f13c0b072b925d2008d0ef024a0
 SHA512:
-  metadata.gz: ad6f0306060921364ae8f2adf8c426d211fbf9fc7daed884868c1317c35b165af9833c596e82492e76bff6d2ef6a229d29916887e51de7ea64a724495c8c54ca
-  data.tar.gz: 191cd221a27797e9eee811fe921ceb99d71d1dfb7ad61a60f8a0e77eed29af7061b71b2b7d8a6637da43b3f89afa3e01064ce22ffc0e855e51e8bd91da8792b2
+  metadata.gz: 1d2eb14f9d599d6e43c27da2a08276e6e874d125f5b7d6de0e0b5ca14404afb143498fced7ab1a2101f8412a25ccf079281cf6741ba91118b00cb29c535c64c8
+  data.tar.gz: 0f157e34a23c7c45a5c48423014fe0ae707419bd73500d89d18fb08fb907ce93acf147e6b52cb22557c84b4cc748c30fb03683ac29479d4f0aa25f90dffd2396

data/lib/web_function/argument.rb

@@ -14,6 +14,10 @@ module WebFunction
       @argument["type"]
     end
 
+    def choices
+      @argument["choices"]
+    end
+
     def flags
       @argument["flags"]
     end
@@ -21,9 +25,5 @@ module WebFunction
     def docs
       @argument["docs"]
     end
-
-    def to_s
-      ["  - #{name} (#{type}):", docs].join(" ")
-    end
   end
 end

data/lib/web_function/documented_error.rb

@@ -0,0 +1,15 @@
+module WebFunction
+  class DocumentedError
+    def initialize(error)
+      @error = error
+    end
+
+    def code
+      @error["code"]
+    end
+
+    def docs
+      @error["docs"]
+    end
+  end
+end

data/lib/web_function/endpoint.rb

@@ -61,12 +61,28 @@ module WebFunction
       @endpoint["flags"]
     end
 
+    def group
+      @endpoint["group"]
+    end
+
     def docs
       @endpoint["docs"]
     end
 
     def arguments
+      unless @endpoint["arguments"].is_a?(Array)
+        return []
+      end
+
       @endpoint["arguments"].map { |argument| Argument.new(argument) }
     end
+
+    def errors
+      unless @endpoint["errors"].is_a?(Array)
+        return []
+      end
+
+      @endpoint["errors"].map { |argument| DocumentedError.new(error) }
+    end
   end
 end

data/lib/web_function/package.rb

@@ -6,10 +6,6 @@ module WebFunction
       @package = package
     end
 
-    def documentation
-      Documentation.new(self)
-    end
-
     def base_url
       @package["base_url"]
     end
@@ -27,7 +23,19 @@ module WebFunction
     end
 
     def endpoints
+      unless @package["endpoints"].is_a?(Array)
+        return []
+      end
+
       @package["endpoints"].map { |endpoint| Endpoint.new(endpoint) }
     end
+
+    def errors
+      unless @package["errors"].is_a?(Array)
+        return []
+      end
+
+      @package["errors"].map { |argument| DocumentedError.new(error) }
+    end
   end
 end

data/lib/web_function/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebFunction
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/web_function.rb

@@ -9,7 +9,6 @@ require_relative "web_function/client"
 require_relative "web_function/package"
 require_relative "web_function/endpoint"
 require_relative "web_function/argument"
-require_relative "web_function/documentation"
 
 module WebFunction
   class Error < StandardError

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: web_function
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robin Clart
 bindir: exe
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -57,7 +57,7 @@ files:
 - lib/web_function.rb
 - lib/web_function/argument.rb
 - lib/web_function/client.rb
-- lib/web_function/documentation.rb
+- lib/web_function/documented_error.rb
 - lib/web_function/endpoint.rb
 - lib/web_function/package.rb
 - lib/web_function/version.rb
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Web Function Client for Ruby
 test_files: []

data/lib/web_function/documentation.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module WebFunction
-  class Documentation
-    def initialize(package)
-      @package = package
-    end
-
-    def generate
-      buffer = ""
-
-      buffer << @package.docs.strip
-      buffer << "\n\n"
-      @package.endpoints.each do |endpoint|
-        arguments = endpoint.arguments
-        buffer << endpoint.docs.strip
-        buffer << "\n\n"
-        buffer << "Signature:"
-        buffer << "\n"
-        buffer << "```"
-        buffer << "\n"
-        buffer << endpoint.name
-        buffer << " { "
-        buffer << arguments.map { |a| "#{a.name}: #{a.type}" }.join(", ")
-        buffer << " } -> ("
-        buffer << endpoint.returns.join(" | ")
-        buffer << ")"
-        buffer << "\n"
-        buffer << "```"
-        buffer << "\n\n"
-        buffer << "Arguments:"
-        buffer << "\n"
-        arguments.each do |argument|
-          buffer << "  - "
-          buffer << "#{argument.name} (#{argument.type}): "
-          if argument.flags.include?("required")
-            buffer << "**Required.** "
-          else
-            buffer << "**Optional.** "
-          end
-          buffer << argument.docs.strip
-          buffer << "\n"
-        end
-        buffer << "\n"
-      end
-
-      buffer
-    end
-  end
-end