pattern_query_helper 0.1.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b868a9d24784bf1635be621ee9ab43542f176774
-  data.tar.gz: e1595a029ff272c8c7fc8dfe872615b672ab40dc
+  metadata.gz: 65460f1546e868997cf4f1b0d049ee2d16f68ff4
+  data.tar.gz: 347f43fb24fad0aed12bfd4c5e3c901edc5b5b87
 SHA512:
-  metadata.gz: 267714428ec883cd37a8879ae59ca3442fbd20296012575d3b5cb84796535f6a22f74d14fa93ab56ff0bf1c97dff1bfb04d32f7c9eeba2c30285d2bb7955cd79
-  data.tar.gz: 0f84d630e8e6c7174b80135cb6a5e27a22f519d18131ca148545278f38e64abb97f1faa6a0a7b9a0e80593480863e118fe1d578aaf133299510703eeae42e0a5
+  metadata.gz: 8db937be84711841bd756d37f43021ad0e73541bcc9f16401641d03f1fbb0429c505c5e6668d0a4e7eb80128246c69734aab59b3b6f977e5811f2404eda7a78b
+  data.tar.gz: f198e72b5325b64221fc4105da3259f8e6ed2127b5fd625549f0b13fed206bccb850cbfa049d9aceb6eb9b32723bb4a5125a2d8b7a88b416c5188f4001e20f67

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pattern_query_helper (0.1.10)
+    pattern_query_helper (0.2.0)
       activerecord (~> 5.0)
       kaminari
 

data/README.md

@@ -1,8 +1,6 @@
 # PatternQueryHelper
 
-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/pattern_query_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby Gem developed and used at Pattern to paginate, sort, filter, and include associations on sql and active record queries.
 
 ## Installation
 
@@ -20,15 +18,196 @@ Or install it yourself as:
 
     $ gem install pattern_query_helper
 
-## Usage
+## Use
+
+### Active Record Queries
 
-TODO: Write usage instructions here
+To run an active record query execute
+```ruby
+PatternQueryHelper.run_sql_query(active_record_call, query_helpers, single_record)
+```
+active_record_call: Valid active record syntax (i.e. ```Object.where(state: 'Active')```)
+query_helpers: See docs below
+single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
 
-## Development
+### Custom SQL Queries
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To run a custom sql query execute
+```ruby
+PatternQueryHelper.run_sql_query(model, query, query_params, query_helpers, single_record)
+```
+model: A valid ActiveRecord model
+query: A string containing your custom SQL query
+query_params: a symbolized hash of binds to be included in your SQL query
+query_helpers: See docs below
+single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
+
+## Query Helpers
+query_helpers is a symbolized hash passed in with information about pagination, associations, filtering and sorting.
+
+### Pagination
+There are two pagination keys you can pass in as part of the query_helpers objects
+
+```ruby
+{
+  page: 1,
+  per_page: 20
+}
+```
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If at least one of these keys is present, paginated results will be returned.
+
+### Sorting
+Sorting is controlled by the `sort` key in the query_helpers object
+
+```ruby
+{
+    sort: "column_name:sort_direction"
+}
+```
+Sort direction can be either asc or desc.  If you wish to lowercase string before sorting include the following:
+```ruby
+{
+    sort: "name:desc:lowercase"
+}
+```
+
+### Filtering
+Filtering is controlled by the `filter` object in the query_helpers hash
+
+```ruby
+{
+  filter: {
+    "column_1" => {
+      "gte" => 20,
+      "lt" => 40
+    },
+    "column_2" => {
+      "eql" => "my_string"
+    }
+}
+```
+
+The following operator codes are valid
+
+```
+“gte”: >=
+“lte”: <=
+“gt”: >
+“lt”: <
+“eql”: =
+“noteql”: !=
+“in”: in
+“notin” not in
+“null”: “is null” or “is not null” (pass in true or false as the value)
+```
+
+### Associations
+
+To include associated objects in the payload, pass in the following as part of the query_helpers hash:
+
+```ruby
+{
+  include: ['associated_object_1', 'associated_object_2']
+}
+```
+
+### Example
+
+The following is an example of a query_helpers object that can be passed into the sql and active record methods
+
+```ruby
+query_helpers = {
+  page: 1,
+  per_page: 20,
+  sort: "name:desc"
+  include: ["child"]
+  filter: {
+    "id" => {
+      "gte" => 20,
+      "lt" => 40
+    }
+}
+```
+
+## Payload Formats
+
+The PatternQueryHelper gem will return results in one of three formats
+
+### Paginated List Payload
+```json
+{
+  "pagination": {
+    "count": 18,
+    "current_page": 1,
+    "next_page": 2,
+    "previous_page": null,
+    "total_pages": 6,
+    "per_page": 3,
+    "first_page": true,
+    "last_page": false,
+    "out_of_range": false
+  },
+  "data": [
+    {
+      "id": 1,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 2,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 3,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+  ]
+}
+```
+
+### List Payload
+```json
+{
+  "data": [
+    {
+      "id": 1,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 2,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 3,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+  ]
+}
+```
+
+### Single Record Payload
+```json
+{
+  "data": {
+    "id": 1,
+    "attribute_1": "string_attribute",
+    "attribute_2": 12345,
+    "attribute_3": 0.3423212
+  }
+}
+```
 
 ## Contributing
 

data/lib/pattern_query_helper/version.rb

@@ -1,3 +1,3 @@
 module PatternQueryHelper
-  VERSION = "0.1.10"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern_query_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler