rest-easy 1.0.0

data/lib/rest_easy/settings.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+
+module RestEasy
+  class Settings
+    extend Dry::Configurable
+
+    setting :base_url, default: "https://example.com", reader: true
+    setting :max_retries, default: 3, reader: true
+    setting :authentication, default: Auth::Null.new, reader: true
+    setting :attribute_convention, default: :PascalCase, reader: true
+  end
+end

data/lib/rest_easy/version.rb

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

data/lib/rest_easy.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "dry/inflector"
+require "dry/types"
+require "faraday"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/__rest_easy")
+loader.ignore("#{__dir__}/rest_easy/__*.rb")
+loader.inflector.inflect(
+  "psk" => "PSK"
+)
+loader.setup
+
+module RestEasy
+  # Make Boolean available as a bare type constant (Ruby has no built-in Boolean)
+  ::Object.const_set(:Boolean, Dry::Types["params.bool"]) unless defined?(::Boolean)
+
+  # ── Error hierarchy ──────────────────────────────────────────────────
+
+  class Error < StandardError; end
+  class AttributeError < Error; end
+
+  class MissingAttributeError < AttributeError
+    attr_reader :attribute_name
+
+    def initialize(attribute_name)
+      @attribute_name = attribute_name
+      super("Missing required attribute: #{attribute_name}")
+    end
+  end
+
+  class ConstraintError < AttributeError
+    attr_reader :attribute_name, :value
+
+    def initialize(attribute_name, value, message = nil)
+      @attribute_name = attribute_name
+      @value = value
+      super(message || "Constraint violation for attribute '#{attribute_name}' with value: #{value.inspect}")
+    end
+  end
+
+  class RequestError < Error
+    attr_reader :response
+
+    def initialize(response_or_message = nil)
+      if response_or_message.respond_to?(:status)
+        @response = response_or_message
+        super("Request failed: #{response_or_message.status}")
+      else
+        super(response_or_message)
+      end
+    end
+  end
+  class AuthenticationError < Error; end
+  class RemoteServerError < Error; end
+  class RateLimitError < Error; end
+
+  # ── Types ────────────────────────────────────────────────────────────
+
+  module Types
+    include Dry.Types()
+  end
+
+  # ── Module extension (ClassMethods) ──────────────────────────────────
+
+  module ClassMethods
+    def config
+      self::Settings.config
+    end
+
+    def settings(&block)
+      self::Settings.class_eval(&block) if block_given?
+    end
+
+    def configure(&block)
+      if block_given?
+        if block.arity == 0
+          dsl = Resource::ConfigureDSL.new(self::Settings.config)
+          dsl.instance_eval(&block)
+        else
+          yield self::Settings.config
+        end
+      end
+    end
+
+    def connection(&block)
+      if block_given?
+        @connection_block = block
+      end
+      @connection_block
+    end
+
+    def faraday_connection
+      @faraday_connection ||= Faraday.new(url: config.base_url) do |f|
+        f.request :json
+        f.response :json
+        @connection_block&.call(f)
+      end
+    end
+
+    def authentication
+      config.authentication
+    end
+
+    # ── HTTP primitives ─────────────────────────────────────────────────
+
+    def get(path:, params: {}, headers: {})
+      request_with_auth(:get, path, params:, headers:)
+    end
+
+    def post(path:, body: nil, headers: {})
+      request_with_auth(:post, path, body:, headers:)
+    end
+
+    def put(path:, body: nil, headers: {})
+      request_with_auth(:put, path, body:, headers:)
+    end
+
+    def delete(path:, headers: {})
+      request_with_auth(:delete, path, headers:)
+    end
+
+    private
+
+    def request_with_auth(method, path, body: nil, params: {}, headers: {})
+      auth = config.authentication
+      max_retries = config.max_retries
+      attempts = 0
+
+      begin
+        response = faraday_connection.run_request(method, path, body, nil) do |req|
+          req.params.update(params) if params.any?
+          headers.each { |k, v| req.headers[k] = v }
+          auth.apply(req)
+        end
+
+        raise RequestError.new(response) unless response.success?
+        response.body
+
+      rescue RequestError => e
+        attempts += 1
+        if attempts <= max_retries
+          auth.on_rejected(e.response)
+          retry
+        end
+        raise
+      end
+    end
+
+  end
+
+  # ── Type bridge ─────────────────────────────────────────────────────
+  # Make bare Ruby types work with Dry::Types features like `constrained`
+  # inside Class.new blocks where constant lookup uses lexical scope.
+
+  TYPE_BRIDGE = {
+    ::String  => Types::Coercible::String,
+    ::Integer => Types::Coercible::Integer,
+    ::Float   => Types::Coercible::Float
+  }.freeze
+
+  [::String, ::Integer, ::Float].each do |klass|
+    unless klass.respond_to?(:constrained)
+      klass.define_singleton_method(:constrained) do |**opts|
+        RestEasy::TYPE_BRIDGE[self].constrained(**opts)
+      end
+    end
+  end
+
+  # ── Module setup ─────────────────────────────────────────────────────
+
+  CHECK_ANCESTORS = false
+
+  class << self
+    def extended(base)
+      super
+
+      # Guard against double registration and constant collisions
+      if base.const_defined?(:ExtendedByRestEasy, CHECK_ANCESTORS)
+        raise Error, "Double registration of #{base}."
+      end
+
+      if base.const_defined?(:Settings, CHECK_ANCESTORS)
+        raise Error, "#{base} already defines Settings. RestEasy needs this constant."
+      end
+
+      # Clone settings so each API module gets its own config state.
+      settings = Class.new(Settings)
+
+      base.const_set(:Settings, settings)
+      base.const_set(:ExtendedByRestEasy, true)
+      base.extend ClassMethods
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: rest-easy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Schubert Erlandsson
+- Claude Code
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Boilerplate for REST API libraries, using on dry-rb
+email:
+- jonas@accodeing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rest_easy.rb
+- lib/rest_easy/attribute.rb
+- lib/rest_easy/auth.rb
+- lib/rest_easy/auth/basic.rb
+- lib/rest_easy/auth/null.rb
+- lib/rest_easy/auth/psk.rb
+- lib/rest_easy/conventions.rb
+- lib/rest_easy/meta.rb
+- lib/rest_easy/refinements.rb
+- lib/rest_easy/resource.rb
+- lib/rest_easy/settings.rb
+- lib/rest_easy/version.rb
+homepage: https://github.com/accodeing/rest-easy
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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.3.7
+signing_key:
+specification_version: 4
+summary: Boilerplate for REST API libraries, using on dry-rb
+test_files: []