halchemy 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9624f3662fe7646de50ba70ca2606d3ff468e242c4ddfd6c9aaafff3bf249065
-  data.tar.gz: 76e2f1871a5ca28140b659561c6eae2ae8f54d29a13ae0d71a6ff06c10c0c069
+  metadata.gz: e87c54742bdb4c00801a6ae3fa7d138f2be9d9ac29684bc26a9b446acd95c57c
+  data.tar.gz: 9f87ff03c217d5f3c5f2404777c4e80fae0ab6d99acc6ef31e63af7cc588d05a
 SHA512:
-  metadata.gz: ef7bf7ea4b23440e81dab6487ba8e39405b45d971fdf83f7493bc575d66ff16280f31315febcbb9257303f8645d3d0761bebb1c2e21f392d80193c7d0ba3011a
-  data.tar.gz: 734e615c1f71ac9aa3e46061b2c8703b787f2c812004b41ffc3a0e10df14e74ac50bae48ec575ce1f5351b49f080813a56bb30a02323bed5557206d8462d8ad1
+  metadata.gz: c5618d243df3795345ca9957fe31f9ebb20257e15193ff85b999fe45e9b8ab0d0b43ed336021e0e7b1c3fba3e9eeac519d757d10c65921ee6ac5d142d62c7d17
+  data.tar.gz: 0c119ff94a610604d861bfd6d5a9e1e44842c3e31c7c43482bf89cd651d302ddcf3e9f163001cf0e9b76712407d00be5749b702bae94230a22ef1777c789493a

data/.idea/halchemy.iml

@@ -35,6 +35,7 @@
     <orderEntry type="library" scope="PROVIDED" name="http-2 (v1.0.2, RVM: ruby-3.4.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http_status_codes (v0.1.0, RVM: ruby-3.4.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="httpx (v1.4.0, RVM: ruby-3.4.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="iniparse (v1.5.0, RVM: ruby-3.4.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="json (v2.9.1, RVM: ruby-3.4.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, RVM: ruby-3.4.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="logger (v1.6.5, RVM: ruby-3.4.1) [gem]" level="application" />

data/__tests__/make_http_requests/http_response_details.rb

@@ -58,3 +58,27 @@ Then(/^I can access the error details$/) do
     end
   end
 end
+
+When(/^I make a request that returns JSON in the body$/) do
+  response_body = {
+    "_status" => "ERR",
+    "_error" => {
+      "code" => 404,
+      "message" => "The requested URL was not found on the server. " /
+                   "If you entered the URL manually please check your spelling and try again."
+    }
+  }.to_json
+  stub_request(:any, /.*/).to_return(body: response_body, status: 404)
+
+  @resource = {}
+  ALL_METHODS.each do |method|
+    @resource[method] = @api.follow(@root_resource).to("resource1").public_send(method)
+  end
+end
+
+Then(/^I can use the body in the way my language supports JSON$/) do
+  ALL_METHODS.each do |method|
+    response = @resource[method]._halchemy.response
+    expect(response.body.respond_to?("to_json")).to be true
+  end
+end

data/__tests__/make_http_requests/with_parameters.rb

@@ -5,7 +5,7 @@ When(/^I supply (.*)$/) do |parameters|
   @requests = make_requests(ALL_METHODS, requester)
 end
 
-Then(/^the parameters are added to the URL as a RFC 3986 compliant (.*)$/) do |query_string|
+Then(/^the parameters are added to the URL as an RFC 3986 compliant (.*)$/) do |query_string|
   ALL_METHODS.each do |method|
     request_path = normalize_path(@requests[method].uri.to_s)
     correct_query_string = normalize_path("/path?#{query_string}")[5..]

data/lib/halchemy/api.rb

@@ -4,29 +4,31 @@ require "cicphash"
 require "httpx"
 require "http_status_codes"
 
-require_relative "requester"
-require_relative "follower"
+require_relative "configurator"
 require_relative "error_handling"
-require_relative "status_codes"
-require_relative "resource"
+require_relative "follower"
 require_relative "http_model"
 require_relative "metadata"
+require_relative "requester"
+require_relative "status_codes"
+require_relative "resource"
 
 module Halchemy
   # This is the Halchemy::Api class, that is the main class for interacting with HAL-based APIs
   class Api
     attr_accessor :base_url, :headers, :error_handling, :parameters_list_style
 
-    def initialize(base_url = "http://localhost:2112", headers: {})
-      @base_url = base_url
-      configure
+    def initialize(base_url = nil, headers: {})
+      config = Configurator.new.config
+      configure_base(config)
+      configure_headers(config)
+      configure_error_handling(config)
 
+      @base_url = base_url unless base_url.nil?
       @headers.merge!(headers)
     end
 
-    def root
-      using_endpoint("/", is_root: true)
-    end
+    def root = using_endpoint("/", is_root: true)
 
     def using_endpoint(target, is_root: false)
       if is_root
@@ -37,13 +39,11 @@ module Halchemy
     end
 
     # @param [Hash[String, string]] headers
-    def add_headers(headers)
-      @headers.merge!(headers)
-    end
+    def add_headers(headers) = @headers.merge!(headers)
 
-    # @param [Array[String] headers
+    # @param [Array[String] header_keys
     def remove_headers(header_keys)
-      header_keys.map { |key| @headers.delete(key) }
+      header_keys.each { |key| @headers.delete(key) }
     end
 
     def request(method, target, headers = nil, data = nil)
@@ -52,16 +52,13 @@ module Halchemy
       request_headers = headers.nil? ? @headers : @headers.merge(headers)
       request = HttpModel::Request.new(method, url, data, request_headers)
 
-      http = HTTPX.with(headers: request_headers)
-      result = http.public_send(method, url, body: data)
+      result = HTTPX.with(headers: request_headers).send(method, url, body: data)
 
       raise_for_errors(result)
       build_resource(request, result)
     end
 
-    def follow(resource)
-      Follower.new(self, resource)
-    end
+    def follow(resource) = Follower.new(self, resource)
 
     def optimistic_concurrency_header(resource)
       etag = resource._halchemy.response.headers["Etag"] || resource[@etag_field]
@@ -70,15 +67,21 @@ module Halchemy
 
     private
 
-    def configure
-      @headers = CICPHash.new.merge!({
-                                       "Authorization" => "Basic cm9vdDpwYXNzd29yZA==",
-                                       "Content-type" => "application/json",
-                                       "Accept" => "application/hal+json, application/json;q=0.9, */*;q=0.8"
-                                     })
+    # @return [void]
+    def configure_headers(config)
+      @headers = CICPHash.new.merge!(config["headers"])
+    end
+
+    def configure_error_handling(config)
       @error_handling = ErrorHandling.new
-      @parameters_list_style = "repeat_key"
-      @etag_field = "_etag"
+      @error_handling.raise_for_status_codes = config["error_handling"]["raise_for_status_codes"]
+      @error_handling.raise_for_network_errors = config["error_handling"]["raise_for_network_errors"]
+    end
+
+    def configure_base(config)
+      @base_url = config["halchemy"]["base_url"] if @base_url.nil?
+      @parameters_list_style = config["halchemy"]["parameters_list_style"]
+      @etag_field = config["halchemy"]["etag_field"]
     end
 
     def build_url(target)

data/lib/halchemy/configurator.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "iniparse"
+require "pathname"
+
+# provides default configuration values, which can be overridden by a config file in the home directory
+# or the project directory
+class Configurator
+  DEFAULT_CONFIG = {
+    "halchemy" => {
+      "base_url" => "http://localhost:2112",
+      "parameters_list_style" => "repeat_key",
+      "etag_field" => "_etag"
+    },
+    "headers" => {
+      "Content-type" => "application/json",
+      "Accept" => "application/hal+json, application/json;q=0.9, */*;q=0.8",
+      "Authorization" => "Basic cm9vdDpwYXNzd29yZA==" # root:password
+    },
+    "error_handling" => {
+      "raise_for_network_errors" => true,
+      "raise_for_status_codes" => nil
+    }
+  }.freeze
+
+  attr_reader :config
+
+  def initialize(filename = ".halchemy")
+    @filename = filename
+    @config = DEFAULT_CONFIG.dup
+    load_config
+  end
+
+  private
+
+  # Find the project root by searching for known indicators
+  def find_project_root(current_dir = nil)
+    current_dir ||= determine_current_dir
+    return nil unless current_dir
+
+    root_indicators = root_indicator_files
+
+    traverse_to_root(current_dir, root_indicators)
+  end
+
+  def determine_current_dir
+    caller_location = caller(1..1)&.first
+    file_path = caller_location&.split(":")&.first
+    file_path ? File.expand_path(File.dirname(file_path)) : nil
+  end
+
+  def root_indicator_files
+    %w[.git Gemfile Gemfile.lock config.ru Rakefile .project .idea .vscode .halchemy]
+  end
+
+  def traverse_to_root(current_dir, root_indicators)
+    while current_dir != File.dirname(current_dir) # Stop at filesystem root
+      return current_dir if root_indicators.any? { |indicator| File.exist?(File.join(current_dir, indicator)) }
+
+      current_dir = File.dirname(current_dir)
+    end
+    nil
+  end
+
+  # Parse an INI file into a nested hash
+  def ini_to_hash(file_path)
+    return {} unless File.exist?(file_path)
+
+    IniParse.parse(File.read(file_path)).to_h
+  rescue StandardError => e
+    warn "Failed to parse INI file: #{file_path}\nError: #{e.message}"
+    {}
+  end
+
+  # Load configuration from both the project root and home directory
+  def load_config
+    home_config = ini_to_hash(File.join(Dir.home, @filename))
+    merge_config(home_config)
+
+    project_root = find_project_root
+    return unless project_root
+
+    project_config = ini_to_hash(File.join(project_root, @filename))
+    merge_config(project_config)
+  end
+
+  # Deep merge configurations
+  def merge_config(new_config)
+    @config.each_key do |section|
+      next unless new_config[section]
+
+      @config[section].merge!(new_config[section])
+    end
+  end
+end

data/lib/halchemy/requester.rb

@@ -2,22 +2,22 @@
 
 require "uri_template"
 
-LIST_STYLE_HANDLERS = {
-  "repeat_key" => ->(key, array) { array.map { |item| [key, URI.encode_www_form_component(item.to_s)] } },
-  "bracket" => ->(key, array) { array.map { |item| ["#{key}[]", URI.encode_www_form_component(item.to_s)] } },
-  "index" => lambda { |key, array|
-    array.each_with_index.map do |item, index|
-      ["#{key}[#{index}]", URI.encode_www_form_component(item.to_s)]
-    end
-  },
-  "comma" => ->(key, array) { [[key, array.map { |item| URI.encode_www_form_component(item.to_s) }.join(",")]] },
-  "pipe" => ->(key, array) { [[key, array.map { |item| URI.encode_www_form_component(item.to_s) }.join("|")]] }
-}.freeze
-
 module Halchemy
   # The results of a Follower#to is a Requester.  In the case of a GET for the root resource, the Requester is Read Only
   # Otherwise it is a full Requester.  Both requester types share much in common.  This is defined in BaseRequester
   class BaseRequester
+    LIST_STYLE_HANDLERS = {
+      "repeat_key" => ->(key, array) { array.map { |item| [key, URI.encode_www_form_component(item.to_s)] } },
+      "bracket" => ->(key, array) { array.map { |item| ["#{key}[]", URI.encode_www_form_component(item.to_s)] } },
+      "index" => lambda { |key, array|
+        array.each_with_index.map do |item, index|
+          ["#{key}[#{index}]", URI.encode_www_form_component(item.to_s)]
+        end
+      },
+      "comma" => ->(key, array) { [[key, array.map { |item| URI.encode_www_form_component(item.to_s) }.join(",")]] },
+      "pipe" => ->(key, array) { [[key, array.map { |item| URI.encode_www_form_component(item.to_s) }.join("|")]] }
+    }.freeze
+
     # @param [Halchemy::Api] api
     # @param [String | Tuple[HalResource, String]] target
     # @return [void]

data/lib/halchemy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Halchemy
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/sig/configurator.rbs

@@ -0,0 +1,23 @@
+class Configurator
+  DEFAULT_CONFIG: Hash[String, Object]
+
+  @filename: String
+
+  attr_reader config: Hash[String, Object]
+
+  private
+
+  def determine_current_dir: -> (String | nil)
+
+  def find_project_root: -> void
+
+  def ini_to_hash: -> Hash[String, Object]
+
+  def load_config: -> Hash[String, Object]
+
+  def merge_config: -> void
+
+  def root_indicator_files: -> Array[String]
+
+  def traverse_to_root: -> void
+end

data/sig/halchemy/api.rbs

@@ -37,7 +37,11 @@ module Halchemy
 
     def build_url: -> String
 
-    def configure: -> void
+    def configure_base: -> void
+
+    def configure_error_handling: -> void
+
+    def configure_headers: -> void
 
     def do_settings_include_status_code: -> bool
 

data/sig/halchemy/base_requester.rbs

@@ -1,5 +1,7 @@
 module Halchemy
   class BaseRequester
+    LIST_STYLE_HANDLERS: Hash[String, Object]
+
     @_data: Object | nil
     @_headers: CICPHash
     @_is_templated: bool

data/test.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cucumber ../../features/ -r __tests__/ --publish-quiet

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: halchemy
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Michael Ottoson
 bindir: exe
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies: []
 description: Do you have an API that serves data following the HAL specification?  The
   **halchemy** library makes it easy for your client to make the most of that API.
@@ -42,6 +42,7 @@ files:
 - bdd
 - lib/halchemy.rb
 - lib/halchemy/api.rb
+- lib/halchemy/configurator.rb
 - lib/halchemy/error_handling.rb
 - lib/halchemy/follower.rb
 - lib/halchemy/http_model.rb
@@ -54,6 +55,7 @@ files:
 - sig/__tests__/halchemy.rbs
 - sig/__tests__/headers.rbs
 - sig/__tests__/remove_headers.rbs
+- sig/configurator.rbs
 - sig/halchemy/api.rbs
 - sig/halchemy/base_requester.rbs
 - sig/halchemy/error_handling.rbs
@@ -65,9 +67,9 @@ files:
 - sig/halchemy/read_only_requester.rbs
 - sig/halchemy/requester.rbs
 - sig/halchemy/resource.rbs
-- sig/list_style_handlers.rbs
 - sig/matchers.rbs
 - sig/patterns.rbs
+- test.sh
 homepage: https://github.com/pointw-dev/halchemy
 licenses:
 - MIT

data/sig/list_style_handlers.rbs

@@ -1 +0,0 @@
-LIST_STYLE_HANDLERS: Hash[String, Object]