tiny-rest-client 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbbf391dfae3b7c9331328d57465ee906873ada7424306f2338c33802a46f1d4
-  data.tar.gz: 300105bfe2e54479fb613cb977188b6eea7e80eafd56442a0f2ac9a85387fe9d
+  metadata.gz: f09282185efbece684932d3948209e72499ec8c4031addb174aebbcfd63b1fe9
+  data.tar.gz: b0def93e35f743ce5527d84f3bd6252b25162f98416fed14cfa1281c3fa9c092
 SHA512:
-  metadata.gz: ba5ff7eb795d3b30c97c96da58f5831a504a411730ae30f171debceac4d2254226929a100b6b264521c3c450f8028e71a768f8a54edc8c63bcd064404eb2b760
-  data.tar.gz: 1ced9f35ca6a4df30e55039dae8d1927143c95de9460bcc157e3e40d43e1c421814ddd33d27b84202d3718f1b761ab736773ace5adb27cd970247fe67f203013
+  metadata.gz: 4a652a084126647ff8db999ac13e0179f054637e26ada3000a1e0088658e073151639e5f764bb5081f7c7a2212b4a12d5369e45f3d45d4329bd0982774edf30b
+  data.tar.gz: 6bde4f84e45822efcf26fe96964907d84987435ea9934bdfe7e3d5cbd0e0d71065a87bc82e095e970ff93e80d5a63a0ee1c06d451c08b4eaf493aecf682b03a6

data/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.1] - 2026-03-03
+
+### Fixed
+- Ensure the gem can be required without `require:` option in Gemfile
+- Add `lib/tiny-rest-client.rb` loader file for RubyGems auto-require compatibility
+
+## [0.2.0] - 2026-03-03
+
+### Added
+- Rails generator `tiny_rest_client:client` for scaffolding API client classes
+  - Supports nested client names (e.g. `api/v1/stripe`)
+  - Optional base URL argument
+  - Configurable root namespace via `--namespace`
+  - Automatically generates properly namespaced client classes under `app/`
+
 ## [0.1.0] - 2026-02-22
 
 ### Added
@@ -19,5 +34,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Full Minitest suite (classic + spec style examples)
 - Basic README documentation
 
-[Unreleased]: https://github.com/Dabrovsky/tiny_rest_client/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/Dabrovsky/tiny_rest_client/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/Dabrovsky/tiny_rest_client/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/Dabrovsky/tiny_rest_client/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/Dabrovsky/tiny_rest_client/releases/tag/v0.1.0

data/README.md

@@ -19,6 +19,7 @@ A minimal, opinionated HTTP client wrapper for Rails, built on top of Typhoeus.
 
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
+- [Rails Generator](#rails-generator)
 - [Configuration](#configuration)
 - [Authorization](#authorization)
 - [Making Requests](#making-requests)
@@ -31,7 +32,7 @@ A minimal, opinionated HTTP client wrapper for Rails, built on top of Typhoeus.
 Add this line to your Gemfile:
 
 ```bash
-gem "tiny-rest-client"
+gem "tiny-rest-client", require: "tiny_rest_client"
 ```
 
 Or install it manually:
@@ -87,6 +88,38 @@ client.update_todo(status: "finished")
 client.destroy_todo(1)
 ```
 
+## Rails Generator
+
+The gem includes a built-in Rails generator to quickly scaffold new API clients.
+
+```bash
+rails generate tiny_rest_client:client NAME [URL] [options]
+```
+
+### Available options
+
+| Option          | Default       | Description                                                 | Example Usage        |
+|-----------------|---------------|-------------------------------------------------------------|----------------------|
+| NAME            | (required)    | Client name (supports nesting like `api/v1/stripe`)         | `rails g ... api/v1/stripe` |
+| URL             | (none)        | Base API URL | `rails g ... stripe https://api.stripe.com`  |
+| --namespace     | `clients`     | Root folder under `app/` (e.g. `app/services/...`)          | `--namespace=services` |
+
+### Basic usage
+
+```bash
+# Basic client
+rails generate tiny_rest_client:client stripe
+
+# Custom base URL
+rails generate tiny_rest_client:client stripe https://api.stripe.com/v1
+
+# Nested namespace (creates app/clients/api/v1/payment_client.rb)
+rails generate tiny_rest_client:client api/v1/payment https://api.example.com/v1
+
+# Custom namespace (creates app/custom/stripe_client.rb)
+rails generate tiny_rest_client:client stripe https://api.example.com/v1 --namespace=custom
+```
+
 ## Configuration
 
 You can configure client setup at the class level:
@@ -176,7 +209,7 @@ MyClient.new(auth: { basic_auth: { user: "name", password: "secret" } })
 
 ## Making Requests
 
-The standard HTTP methods are available directly on every client instance automatically include any headers and/or authorization configuration you defined.
+The standard HTTP methods are available directly on every client instance automatically include any headers or authorization configuration you defined.
 
 ```ruby
 get("/users", page: 1, per_page: 10)            # GET request with query parameters
@@ -206,7 +239,7 @@ helpers:
 ```ruby
 response.success?    # true if code 200–299
 response.failure?    # opposite
-response.code        # HTTP status code (Integer)
+response.code        # HTTP status code
 response.status      # Typhoeus return_code symbol
 response.body        # auto-parsed JSON hash or raw string
 response.headers     # hash of response headers

data/lib/generators/tiny_rest_client/client_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module TinyRestClient
+  module Generators
+    class ClientGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      argument :name, type: :string, required: true, banner: "NAME"
+      argument :api_path, type: :string, required: false, default: "your_api_path", banner: "URL"
+
+      class_option :namespace, type: :string, default: "clients", desc: "Namespace (default clients)"
+
+      desc "Generates a TinyRestClient subclass"
+
+      def create_client_file
+        client_path = "app/#{namespace.downcase}/#{name.downcase}_client.rb"
+        template "client.rb.tt", client_path
+      end
+
+      def create_test_files
+        return if options[:skip_tests]
+
+        framework = options[:test_framework] || detect_test_framework
+
+        case framework
+        when "rspec"
+          client_test_path = "spec/#{namespace.downcase}/#{name.downcase}_client_spec.rb"
+          template "client_spec.rb.tt", client_test_path
+        when "minitest"
+          client_test_path = "test/#{namespace.downcase}/#{name.downcase}_client_test.rb"
+          template "client_test.rb.tt", client_test_path
+        else
+          say "Unknown test framework: #{framework}", :yellow
+        end
+      end
+
+      private
+
+      def detect_test_framework
+        if defined?(RSpec) || File.exist?(File.join(destination_root, "spec"))
+          "rspec"
+        else
+          "minitest"
+        end
+      end
+
+      def module_names
+        name.split("/").map(&:capitalize).join("::")
+      end
+
+      def class_name
+        "#{module_names}Client"
+      end
+
+      def namespace
+        options[:namespace].split("/").first
+      end
+    end
+  end
+end

data/lib/generators/tiny_rest_client/templates/client.rb.tt

@@ -0,0 +1,18 @@
+class <%= class_name %> < TinyRestClient::Core
+  api_path "<%= api_path %>"
+
+  # Define authorization type (optionally)
+  # authorization :bearer (:api_key or :basic_auth)
+  #
+  # Include headers (optionally)
+  # header "Content-Type", "application/json"
+
+  # Define helper methods
+  # def fetch_todos
+  #   get("/todos")
+  # end
+  #
+  # def fetch_todo(id)
+  #   get("/todos/#{id}")
+  # end
+end

data/lib/generators/tiny_rest_client/templates/client_spec.rb.tt

@@ -0,0 +1,19 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %>, type: :client do
+  subject(:client) { described_class.new }
+
+  describe "#initialize" do
+    it "sets the api path" do
+      expect(client.api_path).to eq("<%= api_path %>")
+    end
+  end
+
+  describe "inheritance" do
+    it "inherits from TinyRestClient::Core" do
+      expect(client).to be_a(TinyRestClient::Core)
+    end
+  end
+
+  # Add your client-specific tests below
+end

data/lib/generators/tiny_rest_client/templates/client_test.rb.tt

@@ -0,0 +1,19 @@
+require "test_helper"
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  attr_reader :client
+
+  setup do
+    @client = <%= class_name %>.new
+  end
+
+  test "initializes with api path" do
+    assert_equal "<%= api_path %>", client.api_path
+  end
+
+  test "inherits from TinyRestClient::Core" do
+    assert_kind_of TinyRestClient::Core, client
+  end
+
+  # Add your client-specific tests below
+end

data/lib/tiny-rest-client.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/tiny_rest_client"

data/lib/tiny_rest_client/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails"
+require "rails/generators"
+
+module TinyRestClient
+  class Railtie < ::Rails::Railtie
+    initializer "tiny_rest_client.load_generators" do
+      require "generators/tiny_rest_client/client_generator"
+    end
+  end
+end

data/lib/tiny_rest_client/response.rb

@@ -6,14 +6,14 @@ class Response
   attr_reader :code, :status, :body, :headers
 
   def initialize(code: nil, status: nil, body: nil, headers: nil)
-    @code = code
+    @code = code&.to_i
     @status = status
     @headers = headers
     @body = parse_body(body)
   end
 
   def success?
-    code.to_i.between?(200, 299)
+    code.between?(200, 299)
   end
 
   def failure?

data/lib/tiny_rest_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinyRestClient
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/lib/tiny_rest_client.rb

@@ -12,6 +12,8 @@ require "tiny_rest_client/request"
 require "tiny_rest_client/response"
 require "tiny_rest_client/version"
 
+require "tiny_rest_client/railtie" if defined?(Rails)
+
 module TinyRestClient
   class Core
     class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny-rest-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dabrovski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-02-28 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -35,10 +35,13 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
+- lib/generators/tiny_rest_client/client_generator.rb
+- lib/generators/tiny_rest_client/templates/client.rb.tt
+- lib/generators/tiny_rest_client/templates/client_spec.rb.tt
+- lib/generators/tiny_rest_client/templates/client_test.rb.tt
+- lib/tiny-rest-client.rb
 - lib/tiny_rest_client.rb
+- lib/tiny_rest_client/railtie.rb
 - lib/tiny_rest_client/request.rb
 - lib/tiny_rest_client/response.rb
 - lib/tiny_rest_client/strategies/auth/api_key.rb

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/bin/console

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "tiny_rest_client"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here