feat: Accept position params in non-data request methods

jgraichen · jgraichen · commit 536fe7761420 · 2025-02-14T21:10:31.000+01:00
These are merged with the keyword argument params, with the latter being
preferred. This allows writing shorter methods, such as:

    gh.rel(:user).get({user: 'jgraichen'}).value!

The commit further expands the testing on the request methods, for
params and data handling.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
   `#post`, `#put`, and `#patch` still take an optional first positional data/body argument. Change `post(body, {}, {headers: ...})` to `post(body, headers: ...)`.
 
+  `#get`, `#head`, and `#delete` accept a hash as the first positional argument, which is merged with `params:`. Therefore, passing parameters as data works too: `get({id: 1})`.
+
 ### Fixes
 
 ### Breaks
diff --git a/examples/github_last.rb b/examples/github_last.rb
@@ -17,7 +17,7 @@
 end
 
 gh    = Restify.new('https://api.github.com', headers:).get.value!
-user  = gh.rel(:user).get(user: 'jgraichen').value!
+user  = gh.rel(:user).get({user: 'jgraichen'}).value!
 repos = user.rel(:repos).get.value!
 
 commits = repos.map do |repo|
diff --git a/examples/github_thread.rb b/examples/github_thread.rb
@@ -14,7 +14,7 @@
 end
 
 gh   = Restify.new('https://api.github.com', headers:).get.value
-repo = gh.rel(:repository).get(owner: 'jgraichen', repo: 'restify').value
+repo = gh.rel(:repository).get({owner: 'jgraichen', repo: 'restify'}).value
 cmt  = repo.rel(:commits).get.value.first
 
 puts "Last commit: #{cmt['sha']}"
diff --git a/lib/restify/relation.rb b/lib/restify/relation.rb
@@ -23,28 +23,31 @@ def request(method:, params: {}, **opts)
       context.request(method, expand(params), **opts)
     end
 
-    def get(**opts)
-      request(**opts, method: :get)
+    def get(data = {}, params: {}, **opts)
+      request(**opts, method: :get, params: data.merge(params))
     end
 
-    def head(**opts)
-      request(**opts, method: :head)
+    def head(data = {}, params: {}, **opts)
+      request(**opts, method: :head, params: data.merge(params))
     end
 
-    def delete(**opts)
-      request(**opts, method: :head)
+    def delete(data = {}, params: {}, **opts)
+      request(**opts, method: :delete, params: data.merge(params))
     end
 
     def post(data = nil, **opts)
-      request(**opts, method: :post, data: data)
+      opts[:data] = data unless opts.key?(:data)
+      request(**opts, method: :post)
     end
 
     def put(data = nil, **opts)
-      request(**opts, method: :put, data: data)
+      opts[:data] = data unless opts.key?(:data)
+      request(**opts, method: :put)
     end
 
     def patch(data = nil, **opts)
-      request(**opts, method: :patch, data: data)
+      opts[:data] = data unless opts.key?(:data)
+      request(**opts, method: :patch)
     end
 
     def ==(other)
diff --git a/spec/restify/relation_spec.rb b/spec/restify/relation_spec.rb
@@ -7,7 +7,7 @@
   subject(:relation) { described_class.new context, pattern }
 
   let(:context)  { Restify::Context.new('http://test.host/') }
-  let(:pattern)  { '/resource/{id}' }
+  let(:pattern)  { '/resource/{id}{?q*}' }
 
   describe '#==' do
     it 'equals pattern' do
@@ -120,4 +120,115 @@ def to_param
       it { expect { expanded }.to raise_exception TypeError, /Can't convert Hash into String./ }
     end
   end
+
+  shared_examples 'non-data-request' do |method|
+    it "issues a #{method.upcase} request" do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/'
+        expect(opts).to be_nil
+      end
+      relation.send(method)
+    end
+
+    it 'accepts params as keyword argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to be_nil
+      end
+      relation.send(method, params: {id: 1})
+    end
+
+    it 'accepts params as positional argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to be_nil
+      end
+      relation.send(method, {id: 1})
+    end
+
+    it 'merges keyword params into positional params' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1?a=2&b=3'
+        expect(opts).to be_nil
+      end
+      relation.send(method, {id: 1, q: {a: 1, c: 1}}, params: {q: {a: 2, b: 3}})
+    end
+  end
+
+  describe '#get' do
+    include_examples 'non-data-request', :get
+  end
+
+  describe '#head' do
+    include_examples 'non-data-request', :head
+  end
+
+  describe '#delete' do
+    include_examples 'non-data-request', :delete
+  end
+
+  shared_examples 'data-request' do |method|
+    let(:data) { Object.new }
+
+    it "issues a #{method.upcase} request" do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/'
+        expect(opts).to eq({data: nil})
+      end
+      relation.send(method)
+    end
+
+    it 'accepts params as keyword argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to eq({data: nil})
+      end
+      relation.send(method, params: {id: 1})
+    end
+
+    it 'accepts data as keyword argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to eq({data:})
+      end
+      relation.send(method, data:, params: {id: 1})
+    end
+
+    it 'accepts data as position argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to eq({data:})
+      end
+      relation.send(method, data, params: {id: 1})
+    end
+
+    it 'prefers data from keyword argument' do
+      expect(context).to receive(:request) do |meth, uri, opts|
+        expect(meth).to eq method
+        expect(uri.to_s).to eq 'http://test.host/resource/1'
+        expect(opts).to eq({data:})
+      end
+      relation.send(method, 'DATA', data:, params: {id: 1})
+    end
+  end
+
+  describe '#post' do
+    include_examples 'data-request', :post
+  end
+
+  describe '#put' do
+    include_examples 'data-request', :put
+  end
+
+  describe '#patch' do
+    include_examples 'data-request', :patch
+  end
 end
