dhs 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1880fd170b224c3968acc2c3d77f2aa2b31bf6205f0427a30d8041081feafda9
-  data.tar.gz: 85e87c2fd8b9f0931286d7b4343839c9951f6a22f201d2dcd1135fad0dccf4f7
+  metadata.gz: ca31fdaf95b8fbff1a8de50591e9861554d00fed99645e79f01cd2363de9e8b7
+  data.tar.gz: 06d8d350c5da6878fd6c54a76826bb56c4fb506f6bc8c9be732743014b875f50
 SHA512:
-  metadata.gz: 15623d271f53db3a97af63412ee8a325ffa3ed8039bfbe3716a5fb337341f978cfde0893f811111eaee487d4f01d8c6e32cd70d5f6de5389d0a6d7a66a65d4bc
-  data.tar.gz: 507dd7ccbcd98f21060dfb1c90fa1e849aa63319e842bc1f70d8aa06398aeb4edbc9f7763890090b9252df93606851f598e901451e750ad4fd4ae0c772a04ead
+  metadata.gz: 00035a95ea3b634fc97f6af5c7592b32e09a7135a371d29e234c54ee240da99b1b71ce8305b6342aa61b7fb9103c26576a6e729cfead930d7754745d106b5bda
+  data.tar.gz: 8f844da13a8f5d011b6179310b5ac1629853f3be24496eeba52b425412a5d7159fd2cb89744953afa2a0d615ef696c04993e3b3f921891bac060bd8d1702d63d

data/README.md

@@ -305,6 +305,20 @@ records = Record.blue.available(true)
 GET https://service.example.com/records?color=blue&available=true
 ```
 
+#### order
+
+Set the expected order of things using `.order`
+
+```ruby
+# app/controllers/some_controller.rb
+
+Record.where(color: 'blue').order(:name, { created_at: :desc })
+
+```
+```
+  GET https://service.example.com/records?color=blue&order[name]=asc&order[created_at]=desc
+```
+
 #### all
 
 You can fetch all remote records by using `all`. Pagination will be performed automatically (See: [Record pagination](#record-pagination))

data/lib/dhs/concerns/record/chainable.rb

@@ -222,6 +222,20 @@ class DHS::Record
         end
       end
 
+      def order(*args)
+        order_params = {}
+        args.each do |arg|
+          if arg.is_a?(Hash)
+            arg.each do |key, value|
+              order_params[key] = value
+            end
+          else
+            order_params[arg.to_s] = 'asc'
+          end
+        end
+        push(Parameter.new(order: order_params))
+      end
+
       def all(hash = nil)
         push([Parameter.new(hash), Option.new(all: true)])
       end

data/lib/dhs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DHS
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/record/order_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe DHS::Record do
+  context 'order in where chains' do
+    before do
+      class Record < DHS::Record
+        endpoint 'http://records'
+      end
+    end
+
+    context 'single parameter for order' do
+      before do
+        stub_request(:get, 'http://records/?color=blue&order[created_at]=desc')
+          .to_return(body: [{ name: 'ordered by created_at desc' }].to_json)
+      end
+
+      it 'allows to add order params with .order' do
+        records = Record.where(color: 'blue').order(created_at: :desc)
+        expect(records.first.name).to eq 'ordered by created_at desc'
+      end
+    end
+
+    context 'multiple parameters for order' do
+      before do
+        stub_request(:get, 'http://records/?color=blue&order[name]=asc&order[created_at]=desc')
+          .to_return(body: [{ name: 'ordered by name asc (implicitly) and created_at desc (explicitly)' }].to_json)
+      end
+
+      it 'allows to add order params with .order' do
+        records = Record.where(color: 'blue').order(:name, created_at: :desc)
+        expect(records.first.name).to eq 'ordered by name asc (implicitly) and created_at desc (explicitly)'
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - https://github.com/DePayFi/dhs/graphs/contributors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -517,6 +517,7 @@ files:
 - spec/record/new_spec.rb
 - spec/record/options_getter_spec.rb
 - spec/record/options_spec.rb
+- spec/record/order_spec.rb
 - spec/record/paginatable_collection_spec.rb
 - spec/record/pagination_chain_spec.rb
 - spec/record/pagination_links_spec.rb
@@ -752,6 +753,7 @@ test_files:
 - spec/record/new_spec.rb
 - spec/record/options_getter_spec.rb
 - spec/record/options_spec.rb
+- spec/record/order_spec.rb
 - spec/record/paginatable_collection_spec.rb
 - spec/record/pagination_chain_spec.rb
 - spec/record/pagination_links_spec.rb