web_function 0.1.0

checksums.yaml

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

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+    NewCops: enable
+    SuggestExtensions: false
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Layout/MultilineMethodCallBraceLayout:
+  EnforcedStyle: new_line
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Lint/SymbolConversion:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Style/ConditionalAssignment:
+  EnforcedStyle: assign_inside_condition

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-16
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Robin Clart
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# WebFunction
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/web_function`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/web_function.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/wfn

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "web_function"

data/lib/web_function/argument.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module WebFunction
+  class Argument
+    def initialize(argument)
+      @argument = argument
+    end
+
+    def name
+      @argument["name"]
+    end
+
+    def type
+      @argument["type"]
+    end
+
+    def flags
+      @argument["flags"]
+    end
+
+    def docs
+      @argument["docs"]
+    end
+
+    def to_s
+      ["  - #{name} (#{type}):", docs].join(" ")
+    end
+  end
+end

data/lib/web_function/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module WebFunction
+  class Client
+    def initialize(package, bearer_auth: nil)
+      @package = package
+      @endpoints = package.endpoints.to_h { |e| [e.name.gsub("-", "_").to_sym, e] }
+      @bearer_auth = bearer_auth
+    end
+
+    attr_reader :package
+
+    def self.from_package_endpoint(url, bearer_auth: nil)
+      response = Endpoint.invoke(url, bearer_auth: bearer_auth)
+      package = Package.new(response)
+
+      new(package, bearer_auth: bearer_auth)
+    end
+
+    def methods
+      super + @endpoints.keys
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @endpoints[method_name] || super
+    end
+
+    def method_missing(method_name, *args)
+      endpoint = @endpoints[method_name]
+
+      unless endpoint
+        super
+      end
+
+      url = URI.join(@package.base_url, endpoint.name).to_s
+      args = args.first
+
+      Endpoint.invoke(url, bearer_auth: @bearer_auth, args: args)
+    end
+  end
+end

data/lib/web_function/documentation.rb

@@ -0,0 +1,50 @@
+# 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

data/lib/web_function/endpoint.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module WebFunction
+  class Endpoint
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def self.invoke(url, bearer_auth: nil, args: {})
+      headers = {
+        "Content-Type": "application/json",
+        "Accept": "application/json",
+      }
+
+      if bearer_auth
+        headers["Authorization"] = "Bearer #{bearer_auth}"
+      end
+
+      response = Excon.post(url,
+        headers: headers,
+        body: JSON.generate(args),
+      )
+
+      result = JSON.parse(response.body)
+
+      if response.status == 400
+        case result
+        when Array
+          if result.length == 3 && result[0].is_a?(String) && result[1].is_a?(String)
+            code = result[0]
+            message = result[1]
+            details = result[2]
+
+            raise WebFunction::Error.new(message, code: code, details: details)
+          else
+            raise WebFunction::Error.new("Bad request", details: result)
+          end
+        when String
+          raise WebFunction::Error.new(result)
+        else
+          raise WebFunction::Error.new("Bad request", details: result)
+        end
+      end
+
+      if response.status != 200
+        raise WebFunction::Error.new("Something went wrong, unexpected status code [#{response.status}]")
+      end
+
+      result
+    end
+
+    def name
+      @endpoint["name"]
+    end
+
+    def returns
+      @endpoint["returns"]
+    end
+
+    def flags
+      @endpoint["flags"]
+    end
+
+    def docs
+      @endpoint["docs"]
+    end
+
+    def arguments
+      @endpoint["arguments"].map { |argument| Argument.new(argument) }
+    end
+  end
+end

data/lib/web_function/package.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module WebFunction
+  class Package
+    def initialize(package)
+      @package = package
+    end
+
+    def documentation
+      Documentation.new(self)
+    end
+
+    def base_url
+      @package["base_url"]
+    end
+
+    def name
+      @package["name"]
+    end
+
+    def flags
+      @package["flags"]
+    end
+
+    def docs
+      @package["docs"]
+    end
+
+    def endpoints
+      @package["endpoints"].map { |endpoint| Endpoint.new(endpoint) }
+    end
+  end
+end

data/lib/web_function/version.rb

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

data/lib/web_function.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "excon"
+require "json"
+require "uri"
+
+require_relative "web_function/version"
+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
+    attr_reader :code, :details
+
+    def initialize(message = nil, code: nil, details: nil)
+      super(message)
+      @code = code
+      @details = details
+    end
+  end
+end

data/sig/web_function.rbs

@@ -0,0 +1,4 @@
+module WebFunction
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: web_function
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robin Clart
+bindir: exe
+cert_chain: []
+date: 2025-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: 'A lightweight Web Function client for Ruby. Web Function is a radical
+  rethinking of API design: no verbs, no nested URLs, no bloat. Just function calls
+  over HTTP. This gem lets you invoke endpoints defined in a package, with full support
+  for argument validations, error triples, and bearer auth.'
+email:
+- robin@clart.be
+executables:
+- wfn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/wfn
+- lib/web_function.rb
+- lib/web_function/argument.rb
+- lib/web_function/client.rb
+- lib/web_function/documentation.rb
+- lib/web_function/endpoint.rb
+- lib/web_function/package.rb
+- lib/web_function/version.rb
+- sig/web_function.rbs
+homepage: https://github.com/robinclart/web_function
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/robinclart/web_function
+  source_code_uri: https://github.com/robinclart/web-functions-ruby
+  changelog_uri: https://github.com/robinclart/web-functions-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: A Web Function Client for Ruby
+test_files: []