.order (#5)

* adding .order

* fix rubocop

Author: spape

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))

lib/dhs/concerns/record/chainable.rb

@@ -222,6 +222,20 @@ def where(args = nil)
         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

lib/dhs/version.rb

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

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