webfunction 1.0.0

data/lib/webfunction/utils.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module WebFunction
+  # Internal utility methods.
+  #
+  # @api private
+  #
+  module Utils
+    module_function
+
+    # Normalizes a collection. Yields each item to the block if a block is given, otherwise returns the item.
+    # Any `nil` items are removed.
+    #
+    # @param collection [Array] The collection to normalize
+    #
+    # @return [Array] The normalized array
+    #
+    def normalize_array(collection)
+      unless collection.is_a?(Array)
+        return []
+      end
+
+      items = collection.map do |item|
+        if block_given?
+          yield item
+        else
+          item
+        end
+      end
+
+      items.compact
+    end
+
+    # Normalizes an array of strings. Uses #normalize_array under the hood.
+    #
+    # @param collection [Array] The collection to normalize
+    #
+    # @return [Array] The normalized array
+    #
+    def normalize_array_of_strings(collection)
+      normalize_array(collection) { |item| item.to_s }
+    end
+
+    def get_body_from_url(url, extra_query_params: {})
+      url = add_query_params(url, extra_query_params)
+      response = ::Excon.get(url, headers: {
+        "User-Agent": "webfunction/#{::WebFunction::VERSION}",
+        "Accept-Encoding": "gzip",
+      })
+
+      response.body
+    end
+
+    def add_query_params(url, params = {})
+      uri = ::URI.parse(url)
+      existing_params = ::URI.decode_www_form(uri.query || "").to_h
+      new_params = params.reject { |_, value| value.nil? }.transform_keys(&:to_s)
+      merged_params = existing_params.merge(new_params)
+
+      unless merged_params.empty?
+        uri.query = ::URI.encode_www_form(merged_params)
+      end
+
+      uri.to_s
+    end
+  end
+end

data/lib/webfunction/version.rb

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

data/lib/webfunction.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "excon"
+require "json"
+require "uri"
+
+require_relative "webfunction/version"
+require_relative "webfunction/request"
+require_relative "webfunction/page"
+require_relative "webfunction/client"
+require_relative "webfunction/flaggable"
+require_relative "webfunction/package"
+require_relative "webfunction/endpoint"
+require_relative "webfunction/argument"
+require_relative "webfunction/attribute"
+require_relative "webfunction/object_schema"
+require_relative "webfunction/documented_error"
+require_relative "webfunction/pipeline"
+require_relative "webfunction/promise"
+require_relative "webfunction/type"
+require_relative "webfunction/utils"
+
+module WebFunction
+  # A base error class for WebFunction. All errors inherit from this class.
+  #
+  # @api private
+  #
+  class Error < StandardError
+    attr_reader :code, :details
+
+    def initialize(message = nil, code: self.class.error_code, details: nil)
+      super(message)
+      @code = code
+      @details = details
+    end
+
+    # Returns the error code for the error. Used as default error code if no code is provided.
+    #
+    # @return [String] The error code
+    #
+    def self.error_code
+      name.sub(/^WebFunction::/, "WFN_")
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .upcase
+    end
+  end
+
+  UnresolvedPromiseError = Class.new(Error)
+  UnexpectedStatusCodeError = Class.new(Error)
+  JsonParseError = Class.new(Error)
+  BadRequestError = Class.new(Error)
+end

data/sig/webfunction.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,131 @@
+--- !ruby/object:Gem::Specification
+name: webfunction
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robin Clart
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/web_function.rb
+- lib/webfunction.rb
+- lib/webfunction/argument.rb
+- lib/webfunction/attribute.rb
+- lib/webfunction/client.rb
+- lib/webfunction/documented_error.rb
+- lib/webfunction/endpoint.rb
+- lib/webfunction/flaggable.rb
+- lib/webfunction/object_schema.rb
+- lib/webfunction/package.rb
+- lib/webfunction/page.rb
+- lib/webfunction/pipeline.rb
+- lib/webfunction/promise.rb
+- lib/webfunction/request.rb
+- lib/webfunction/type.rb
+- lib/webfunction/type/any.rb
+- lib/webfunction/type/array_of.rb
+- lib/webfunction/type/base.rb
+- lib/webfunction/type/union.rb
+- lib/webfunction/utils.rb
+- lib/webfunction/version.rb
+- sig/webfunction.rbs
+homepage: https://github.com/webfunction-protocol/webfunction-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/webfunction-protocol/webfunction-ruby
+  source_code_uri: https://github.com/webfunction-protocol/webfunction-ruby
+  changelog_uri: https://github.com/webfunction-protocol/webfunction-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.9
+specification_version: 4
+summary: A Web Function Client for Ruby
+test_files: []