api_queries 0.1.3 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157e3ef3d1ccb494f1f857f7638e6f487ca095ce95b630fcb62cda9fa0cf9c40
-  data.tar.gz: f03b084df3c6fd7299d2a4a2a0a21c15b287568c313c0405134f679943df09b5
+  metadata.gz: 0e2ffc36bc14ef3fa1695201119ddb8039709924ae1a8d5ad08e0ff7ce518d95
+  data.tar.gz: d926f83065802c9b70b06773ea1b568adbf6e16f68b10857dfbca38dca48d424
 SHA512:
-  metadata.gz: a481ae1c8aac4c6e8c94a4537c258c51f941a28877ed6ee2d4004153120ce2599b2d25b07619072cefd09336eb9c1f3a5e3ca0f42801f547f14c2b32a18d457b
-  data.tar.gz: 6efd0a6e9963d03f84b1bfb9888e69dbaa747cfbcbf1fe384f92c20f8eabbe95c225126a63946a8c1d4763569c81a57541e4e0b0152b4d67dc8d83de3bb44e72
+  metadata.gz: 9b201d964f73f04127be2000eaad2aba229202aebfb6ffd240d9ae28ed3e7a2c972417c176d4509f6e6a7c51d78aa1f944adb271000429465775bced1a6e0b69
+  data.tar.gz: 83e7eeb5a9f5a8482960e6b86536117f306c3e1a2f702fd724973560cf6178382020a1ca10e5a298127d5447e40297378182be696922bdf3e81420078f9f9ad9

data/.rspec_status

@@ -1,10 +1,11 @@
 example_id                        | status | run_time        |
 --------------------------------- | ------ | --------------- |
-./spec/api_queries_spec.rb[1:1:1] | passed | 0.00603 seconds |
-./spec/api_queries_spec.rb[1:1:2] | passed | 0.01774 seconds |
-./spec/api_queries_spec.rb[1:1:3] | passed | 0.00072 seconds |
-./spec/api_queries_spec.rb[1:1:4] | passed | 0.00949 seconds |
-./spec/api_queries_spec.rb[1:1:5] | passed | 0.00301 seconds |
-./spec/api_queries_spec.rb[1:1:6] | passed | 0.00538 seconds |
-./spec/api_queries_spec.rb[1:1:7] | passed | 0.00325 seconds |
-./spec/api_queries_spec.rb[1:1:8] | passed | 0.00575 seconds |
+./spec/api_queries_spec.rb[1:1:1] | passed | 0.00588 seconds |
+./spec/api_queries_spec.rb[1:1:2] | passed | 0.0209 seconds  |
+./spec/api_queries_spec.rb[1:1:3] | passed | 0.00068 seconds |
+./spec/api_queries_spec.rb[1:1:4] | passed | 0.01339 seconds |
+./spec/api_queries_spec.rb[1:1:5] | passed | 0.00339 seconds |
+./spec/api_queries_spec.rb[1:1:6] | passed | 0.00318 seconds |
+./spec/api_queries_spec.rb[1:1:7] | passed | 0.00644 seconds |
+./spec/api_queries_spec.rb[1:1:8] | passed | 0.00293 seconds |
+./spec/api_queries_spec.rb[1:1:9] | passed | 0.00166 seconds |

data/.rubocop_todo.yml

@@ -1,48 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-21 23:51:29 +0800 using RuboCop version 0.58.1.
+# on 2018-08-06 14:56:48 +0800 using RuboCop version 0.58.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
-# Include: **/*.gemspec
-Gemspec/OrderedDependencies:
-  Exclude:
-
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: outdent, indent
-Layout/AccessModifierIndentation:
-  Exclude:
-
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterMagicComment:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
-Layout/EmptyLinesAroundModuleBody:
-  Exclude:
-
-
-# Offense count: 31
-# Cop supports --auto-correct.
-# Configuration parameters: Width, IgnoredPatterns.
-Layout/IndentationWidth:
-  Exclude:
-
-
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: .
@@ -50,152 +13,47 @@ Layout/IndentationWidth:
 Layout/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
 
-# Offense count: 57
-# Cop supports --auto-correct.
-# Configuration parameters: IndentationWidth.
-Layout/Tab:
-  Exclude:
-
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: final_newline, final_blank_line
-Layout/TrailingBlankLines:
-  Exclude:
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: AllowInHeredoc.
-Layout/TrailingWhitespace:
-  Exclude:
-
 # Offense count: 1
-Lint/UselessAssignment:
+Lint/UnreachableCode:
   Exclude:
+    # - 'lib/api_queries.rb'
 
 # Offense count: 1
 Metrics/AbcSize:
-  Max: 53
+  Max: 61
 
 # Offense count: 2
 # Configuration parameters: CountComments, ExcludedMethods.
 # ExcludedMethods: refine
 Metrics/BlockLength:
-  Max: 55
+  Max: 58
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
-  Max: 14
+  Max: 16
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 31
+  Max: 32
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 17
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: MaxKeyValuePairs.
-Performance/RedundantMerge:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: is_a?, kind_of?
-Style/ClassCheck:
-  Exclude:
-
-# Offense count: 1
-Style/DateTime:
-  Exclude:
-
-# Offense count: 2
-Style/Documentation:
-  Exclude:
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/Encoding:
-  Exclude:
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    # - 'lib/api_queries.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
-# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
-Style/HashSyntax:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: require_parentheses, require_no_parentheses, require_no_parentheses_except_multiline
-Style/MethodDefParentheses:
-  Exclude:
+  Max: 18
 
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
     - 'spec/db/helper.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/MutableConstant:
-  Exclude:
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Exclude:
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Exclude:
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/RescueModifier:
   Exclude:
     - 'spec/db/helper.rb'
 
-# Offense count: 30
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Exclude:
-
-
-# Offense count: 24
+# Offense count: 26
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 129
+  Max: 129

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api_queries (0.1.3)
+    api_queries (0.1.6)
       will_paginate (>= 3.0)
 
 GEM

data/README.md

@@ -30,6 +30,7 @@ include ApiQueries
 Optional Parameters:
 - `active_only [1, 0]`
 - `page [1 ~ n]`
+- `column_date`(Default is `updated_at`)
 
 Get data filtered by date:
 - `after`
@@ -63,7 +64,17 @@ Product.api_q(q: 'count')
 
 # Get last updated_at
 Product.api_q(q: 'last_updated_at')
+```
+
+You can catch exception `ApiQueries::Errors::UnknownColumn` in your `api_controller.rb` if the value of `column_date` is invalid or does not exist. Example below:
 
+```ruby
+# api_controller.rb
+rescue_from ApiQueries::Errors::UnknownColumn, with: render_unknown_column_error
+
+def render_unknown_column_error
+    render json: { errors: 'Your error message' }, status: 422
+end
 ```
 
 ## Contributing

data/lib/api_queries/errors/unknown_column.rb

@@ -0,0 +1,5 @@
+module ApiQueries
+  module Errors
+    class UnknownColumn < StandardError; end
+  end
+end

data/lib/api_queries/version.rb

@@ -1,3 +1,3 @@
 module ApiQueries
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/api_queries.rb

@@ -1,15 +1,23 @@
 require 'active_support/core_ext/string/conversions'
 require 'api_queries/version'
+require 'api_queries/errors/unknown_column'
+
 # ApiQueries
 module ApiQueries
   extend ActiveSupport::Concern
   # class method
   module ClassMethods
     def api_q(opts={})
+      # add default value
+      opts[:column_date] = 'updated_at' unless opts[:column_date].present?
+
+      # check if specified column exists
+      raise Errors::UnknownColumn, 'Invalid value for column_date.' if column_names.exclude?(opts[:column_date])
+
       # last updated at q
       if opts[:q] == 'last_updated_at'
         return { last_updated_at: (begin
-                                     order('updated_at DESC').limit(1).first.updated_at.strftime('%Y-%m-%dT%H:%M:%SZ')
+                                     order(opts[:column_date] => :desc).limit(1).first.updated_at.strftime('%Y-%m-%dT%H:%M:%SZ')
                                    rescue StandardError
                                      nil
                                    end) }
@@ -20,19 +28,19 @@ module ApiQueries
 
       # AFTER: updated_at > given_date
       if opts[:after].present?
-        conditions = ['updated_at > ?', fdate(opts[:after])]
+        conditions = ["#{opts[:column_date]} > ?", fdate(opts[:after])]
       # BEFORE: updated_at < given_date
       elsif opts[:before].present?
-        conditions = ['updated_at < ?', fdate(opts[:before])]
+        conditions = ["#{opts[:column_date]} < ?", fdate(opts[:before])]
       # FROM & TO: between "from date" to "to date"
       elsif opts[:from].present? && opts[:to].present?
-        conditions[:updated_at] = (fdate(opts[:from])..fdate(opts[:to]))
+        conditions[opts[:column_date].to_sym] = (fdate(opts[:from])..fdate(opts[:to]))
       # FROM: updated_at >= given_date
       elsif opts[:from].present?
-        conditions = ['updated_at >= ?', fdate(opts[:from])]
+        conditions = ["#{opts[:column_date]} >= ?", fdate(opts[:from])]
       # TO: updated_at <= given_date
       elsif opts[:to].present?
-        conditions = ['updated_at <= ?', fdate(opts[:to])]
+        conditions = ["#{opts[:column_date]} <= ?", fdate(opts[:to])]
       end
 
       # get by status

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_queries
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.6
 platform: ruby
 authors:
 - Nujian Den Mark Meralpis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: will_paginate
@@ -103,7 +103,11 @@ files:
 - bin/console
 - bin/setup
 - builds/api_queries-0.1.2.gem
+- builds/api_queries-0.1.3.gem
+- builds/api_queries-0.1.4.gem.bad_release
+- builds/api_queries-0.1.5.gem
 - lib/api_queries.rb
+- lib/api_queries/errors/unknown_column.rb
 - lib/api_queries/version.rb
 homepage: https://github.com/denmarkmeralpis/api_queries
 licenses: