resteze 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bbe0973ffabaab62515892208bebf19b154493382a272236d833c6b8e621b1e
-  data.tar.gz: f3674096d21235157673d5678d4586549b111e67842a24778e830b7507124123
+  metadata.gz: da5b0f1ce7cd3e8c2677b9fe22f2c67b755475ea464b25821fc71f4054629bb6
+  data.tar.gz: f8a4c6fa0bd2a169b7f8e818dacb14b11a0e6c69bebe49a6b77004a458351a9a
 SHA512:
-  metadata.gz: 0ddebadb823fc854a48f99c547134458f2be39f229d76d58bbc872ebae0aaa8b48296596565bb2d2f3e612bc0164949489e05ce212b1cb78f11bb0c40164d160
-  data.tar.gz: b534a50b9674cb29c570610d320bbead76f21548119bd8b5c9580938be459a8704a230eba2ef4dbb1a08b5ab9620c4978bd462356a4259429dec838e2c294ed7
+  metadata.gz: 9c64c532a62d217fc2819c729fb684590ba0d29eb7ca2f83e9c1ee36a3b9db5e32bb2bc5ae082b3c94b6f0b783bc097b634e7668ad362c09cf1b150f7e607e55
+  data.tar.gz: 6c5c871ed49367a69b401d32409200234352348ab305a0084b0aab8c61b22921115268dd32724c896d1b2eded83c3632e2d62c3ec8371437d5675b4a7fbc9e84

data/.rubocop.yml

@@ -7,6 +7,9 @@ inherit_mode:
   merge:
     - Exclude
 
+Layout/LineLength:
+  Max: 125
+
 Metrics/ParameterLists:
   Exclude:
     - lib/resteze/errors.rb
@@ -25,9 +28,15 @@ Metrics/ClassLength:
     - lib/resteze/client.rb
     - test/**/*
 
+Metrics/MethodLength:
+  Max: 15
+
 Minitest/MultipleAssertions:
   Max: 6
 
+Style/Documentation:
+  Enabled: false
+
 Style/FrozenStringLiteralComment:
   Enabled: false
 
@@ -37,5 +46,6 @@ Style/StringLiterals:
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 3.2
   Exclude:
-    - 'bin/*'
+    - "bin/*"

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/Guardfile

@@ -3,6 +3,5 @@ directories %w[lib test]
 guard :minitest, all_on_start: false do
   watch(%r{^lib/(.+)\.rb$}) { |m| "test/#{m[1]}_test.rb" }
   watch(%r{^test/.+_test\.rb$})
-  watch(%r{^test/factories\.rb$})   { "test" }
   watch(%r{^test/test_helper\.rb$}) { "test" }
 end

data/README.md

@@ -1,38 +1,84 @@
-# Resteze
+<div style="display: block; text-align: center;">
+  <img src="assets/resteze.svg" alt="Resteze API Ointment" width="128" style="margin: auto;">
+</div>
 
-TODO: Delete this and the text below, and describe your gem
+[![Continuous Integration](https://github.com/rwx-services/resteze/actions/workflows/ci.yml/badge.svg)](https://github.com/rwx-services/resteze/actions/workflows/ci.yml)
 
-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/resteze`. To experiment with that code, run `bin/console` for an interactive prompt.
+---
+
+Resteze is a Ruby library designed to simplify the creation of REST API client gems. It provides a flexible framework for defining API resources, handling requests and responses, managing configuration, and supporting common patterns like listing, saving, and error handling. Built on top of popular Ruby libraries such as Faraday, Hashie, and ActiveSupport, Resteze enables developers to quickly build robust, object-oriented clients for RESTful services, with features for custom resource paths, serialization, and thread-safe client management.
+
+But Resteze isn't just for REST! Its resource-oriented design lets you give any API—SOAP, RPC, GraphQL, or even quirky legacy endpoints—a clean, resourceful feel. You can wrap non-RESTful APIs in familiar objects, organize calls as resource methods, and enjoy the same convenience and clarity, no matter how your backend is structured. Resteze helps you tame any API and make it feel right at home in Ruby.
 
 ## 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.
+You can install Resteze from RubyGems or use it directly from source.
 
-Install the gem and add to the application's Gemfile by executing:
+### Install via RubyGems
+
+Add Resteze to your application's Gemfile:
+
+```ruby
+bundle add resteze
+```
+
+Then run:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it directly with:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install resteze
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Building an API Client with Resteze
+
+To build an API client using Resteze, define a Ruby module for your API and include the `Resteze` concern. Then, create resource classes under your module that inherit from `ApiResource` and define properties for your API objects.
 
-## Development
+Here's a simple example:
 
-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.
+```ruby
+require 'resteze'
+
+module MyCoolApi
+  include Resteze
+
+  # Configure your API client
+  configure do |config|
+    config.api_base = 'https://api.example.com/'
+    config.api_key = 'your-api-key'
+    config.logger = Logger.new($stdout)
+  end
+
+  # Define a resource
+  class Widget < ApiResource
+    property :id
+    property :name
+    property :status
+  end
+end
+
+# Usage example
+widget = MyCoolApi::Widget.retrieve(123)
+puts widget.name
+
+# List resources
+widgets = MyCoolApi::Widget.list
+widgets.each do |w|
+  puts w.id
+end
+```
 
-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).
+You can define additional resources, customize paths, and add methods as needed. Resteze handles requests, responses, and error management for you, so you can focus on your API's business logic.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/resteze.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rwx-services/resteze.
 
 ## License