resteze 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5b0f1ce7cd3e8c2677b9fe22f2c67b755475ea464b25821fc71f4054629bb6
-  data.tar.gz: f8a4c6fa0bd2a169b7f8e818dacb14b11a0e6c69bebe49a6b77004a458351a9a
+  metadata.gz: 4be8c1254251ae0e6d2fb624d9ebbfff5ddc309d903ffe1ded346d816b4a3cf0
+  data.tar.gz: b49908651339547627e4a46b13944d9029ce06bea3a1a189fc63538b7fb54cb2
 SHA512:
-  metadata.gz: 9c64c532a62d217fc2819c729fb684590ba0d29eb7ca2f83e9c1ee36a3b9db5e32bb2bc5ae082b3c94b6f0b783bc097b634e7668ad362c09cf1b150f7e607e55
-  data.tar.gz: 6c5c871ed49367a69b401d32409200234352348ab305a0084b0aab8c61b22921115268dd32724c896d1b2eded83c3632e2d62c3ec8371437d5675b4a7fbc9e84
+  metadata.gz: d318326b40178c6bbcfb949908e37742d56c74c1e366ec4522c217bc5886b21f2884536b94d814f17e1c2ab7262a5820df0b43ed481302f5b6bcc6071af2e64d
+  data.tar.gz: 62db4cc4bc2edf0761b258ef64b7e4edf42faea613099c3ab7091434c0d4fea100bcca33604e910e0943c07a242f807f6165f06d9e94195aba10f9deb6381d47

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.3.1]
+
+### Added
+
+- Minitest and RSpec testing helpers for resources and configuration.
+
+## [0.3.0]
+
+### Added
+
+- Initial implementation of Resteze, a framework for building REST API client gems.
+- Support for defining API resources, requests, and responses.
+- Configuration management for API clients.
+- Integration with Faraday, Hashie, and ActiveSupport.
+- Middleware for error handling and request transformation.
+- Serialization and deserialization of API responses.
+- Thread-safe client management.
+- Flexible resource paths and property mapping.
+
+## [0.1.0] - 2025-08-12
+
+### Added
+
+- First public release.
+- Documentation and usage examples.
+- CI workflow for RuboCop and tests across Ruby 3.2–3.4.4.
+- Code coverage reporting integration.

data/README.md

@@ -3,6 +3,8 @@
 </div>
 
 [![Continuous Integration](https://github.com/rwx-services/resteze/actions/workflows/ci.yml/badge.svg)](https://github.com/rwx-services/resteze/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/resteze.svg)](https://badge.fury.io/rb/resteze)
+[![Coverage Status](https://coveralls.io/repos/github/rwx-services/resteze/badge.svg?branch=main)](https://coveralls.io/github/rwx-services/resteze?branch=main)
 
 ---
 

data/lib/resteze/testing/minitest/configuration.rb

@@ -0,0 +1,18 @@
+module Resteze
+  module Testing
+    module Configuration
+      extend ActiveSupport::Concern
+
+      # Assert that a config property is supported and can be assigned
+      def assert_config_property(property, value = nil, subject: nil)
+        subject ||= (defined?(@subject) && @subject) || subject()
+        original_value = subject.send(property)
+
+        assert_equal value, subject.send(property), "config property #{property} value did not match expectation"
+      ensure
+        # Make sure to set the original value at the end
+        subject.send("#{property}=", original_value)
+      end
+    end
+  end
+end

data/lib/resteze/testing/minitest/object.rb

@@ -0,0 +1,58 @@
+module Resteze
+  module Testing
+    module Minitest
+      module Object
+        include ActiveSupport::Concern
+
+        private
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Naming/PredicatePrefix
+        def has_property(name, **options)
+          assert subject.property?(name.to_sym), "Expected #{subject} to have property: #{name}"
+          assert_property_default(name, options[:default]) if options.key?(:default)
+          assert_property_translation(name, options[:from]) if options.key?(:from)
+          assert_property_transformed(name, transformed: options[:transformed]) if options.key?(:transformed)
+          assert_property_required(name, required: options[:required]) if options.key?(:required)
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Naming/PredicatePrefix
+
+        def assert_property_transformed(name, transformed: true)
+          translation = subject.translations_hash.dig(subject.translations.key(name.to_sym), name.to_sym)
+          transformation_defined = translation.is_a?(Proc) || subject.transformation_exists?(name.to_sym)
+
+          if transformed
+            assert transformation_defined, "Expected #{subject} to transform property: #{name}"
+          else
+            refute transformation_defined, "Expected #{subject} not to transform property: #{name}"
+          end
+        end
+
+        def assert_property_required(name, required: true)
+          if required
+            assert subject.required?(name.to_sym), "Expected #{subject} to require property: #{name}"
+          else
+            refute subject.required?(name.to_sym), "Expected #{subject} not to require property: #{name}"
+          end
+        end
+
+        def assert_property_translation(name, from)
+          assert_equal(
+            from.to_sym,
+            subject.translations.key(name.to_sym),
+            "Expected #{subject} to map property #{name} from #{from}"
+          )
+        end
+
+        def assert_property_default(name, default)
+          assert_equal(
+            default,
+            subject.defaults[name.to_sym],
+            "Expected #{subject} to have default for property #{name}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/resteze/testing/minitest.rb

@@ -0,0 +1,10 @@
+require_relative "minitest/configuration"
+require_relative "minitest/object"
+
+module Resteze
+  module Testing
+    module Minitest
+      # Namespace for Minitest-specific testing helpers
+    end
+  end
+end

data/lib/resteze/testing/rspec/configure.rb

@@ -0,0 +1,16 @@
+module Resteze
+  module Testing
+    module Configuration
+      # Assert that a config property is supported and can be assigned
+      def assert_config_property(property, value = nil, subject: nil)
+        subject ||= (defined?(@subject) && @subject) || self.subject
+        original_value = subject.send(property)
+
+        expect(subject.send(property)).to eq(value), "config property #{property} value did not match expectation"
+      ensure
+        # Make sure to set the original value at the end
+        subject.send("#{property}=", original_value)
+      end
+    end
+  end
+end

data/lib/resteze/testing/rspec/object.rb

@@ -0,0 +1,49 @@
+module Resteze
+  module Testing
+    module RSpec
+      module Object
+        extend RSpec::Matchers
+
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Naming/PredicatePrefix
+        def has_property(name, **options)
+          expect(subject.property?(name.to_sym)).to be(true), "Expected #{subject} to have property: #{name}"
+          assert_property_default(name, options[:default]) if options.key?(:default)
+          assert_property_translation(name, options[:from]) if options.key?(:from)
+          assert_property_transformed(name, transformed: options[:transformed]) if options.key?(:transformed)
+          assert_property_required(name, required: options[:required]) if options.key?(:required)
+        end
+        # rubocop:enable Naming/PredicatePrefix
+
+        def assert_property_transformed(name, transformed: true)
+          translation = subject.translations_hash.dig(subject.translations.key(name.to_sym), name.to_sym)
+          transformation_defined = translation.is_a?(Proc) || subject.transformation_exists?(name.to_sym)
+
+          if transformed
+            expect(transformation_defined).to be(true), "Expected #{subject} to transform property: #{name}"
+          else
+            expect(transformation_defined).to be(false), "Expected #{subject} not to transform property: #{name}"
+          end
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def assert_property_required(name, required: true)
+          if required
+            expect(subject.required?(name.to_sym)).to be(true), "Expected #{subject} to require property: #{name}"
+          else
+            expect(subject.required?(name.to_sym)).to be(false), "Expected #{subject} not to require property: #{name}"
+          end
+        end
+
+        def assert_property_translation(name, from)
+          expect(subject.translations.key(name.to_sym)).to eq(from.to_sym),
+                                                           "Expected #{subject} to map property #{name} from #{from}"
+        end
+
+        def assert_property_default(name, default)
+          expect(subject.defaults[name.to_sym]).to eq(default), "Expected #{subject} to have default for property #{name}"
+        end
+      end
+    end
+  end
+end

data/lib/resteze/testing/rspec.rb

@@ -0,0 +1,10 @@
+require_relative "rspec/configure"
+require_relative "rspec/object"
+
+module Resteze
+  module Testing
+    module RSpec
+      # Namespace for RSpec-specific testing helpers
+    end
+  end
+end

data/lib/resteze/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resteze
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resteze
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - JD Hendrickson
@@ -75,6 +75,7 @@ files:
 - ".rubocop"
 - ".rubocop.yml"
 - ".ruby-version"
+- CHANGELOG.md
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -93,6 +94,12 @@ files:
 - lib/resteze/request.rb
 - lib/resteze/response.rb
 - lib/resteze/save.rb
+- lib/resteze/testing/minitest.rb
+- lib/resteze/testing/minitest/configuration.rb
+- lib/resteze/testing/minitest/object.rb
+- lib/resteze/testing/rspec.rb
+- lib/resteze/testing/rspec/configure.rb
+- lib/resteze/testing/rspec/object.rb
 - lib/resteze/util.rb
 - lib/resteze/version.rb
 - sig/resteze.rbs