pw_query 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f954be61950ee22765fde8146ab319fc066209ded37810791701f94f01c4624
+  data.tar.gz: cf0007aa854ac28a03395a50438aa4a12b4af5066c990f4b3b9fe822c6cbc4cd
+SHA512:
+  metadata.gz: 5ac11cbc9e45b5b023c83e5c73adb07f25f48b912761b04ed373b7722d0649b6a05d7719ebfa7758e5d420228e01bec1c58b27219594070d500aa56ba4ecdb50
+  data.tar.gz: '097d80461758f64234e7bd4fa3048ba252241f01b63a37014ef676ba21f8ef4836e9afbd8dcbad1cd90716eb9add91de338e0810e626cd778a76266bb36002b3'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-07
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jeffrey Dabo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# PwQuery
+
+TODO: Delete this and the text below, and describe your gem
+
+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/pw_query`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pw_query. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/pw_query/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PwQuery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pw_query/blob/main/CODE_OF_CONDUCT.md).

data/lib/pw_query/service.rb

@@ -0,0 +1,261 @@
+require 'active_record'
+
+module PwQuery
+  class Service
+    DEFAULT_LIMIT = 50
+
+    def initialize(model, params, options = {}, associations = nil)
+      @model = model
+      @params = params
+      @options = options
+      @associations = associations
+      @total = @model.count
+      @limit = @params.fetch(:limit, DEFAULT_LIMIT).to_i
+      @meta = {
+        total: @total,
+        limit: @limit,
+        page: @params.fetch(:page, 1).to_i,
+        page_size: @total,
+        total_pages: (@total.to_f / @limit).ceil
+      }
+    end
+
+    def perform
+      query = @model.all
+      query = include_associations(query, @associations)
+      query = apply_filters(query, @params[:filters])
+      query = apply_sorting(query, @params)
+      query = apply_field_selection(query, @params)
+      query = apply_date_range(query, @params[:date_range]) if @options[:date_scope]
+      query = apply_time_range(query, @params[:time_range])
+      query = apply_search(query, @params[:search])
+      query = apply_range(query, @params[:range])
+      query = apply_pagination(query, @params)
+      query = apply_aggregation(query, @params[:aggregation])
+
+      handle_query(query)
+
+      { meta: @meta, data: query }
+    end
+
+    def include_associations(query, associations)
+      query.includes(associations)
+    end
+
+    def apply_filters(query, filters)
+      return query if filters.blank?
+
+      filters.each do |key, value|
+        next if value.blank?
+
+        values = value.to_s.split(',').map(&:strip)
+        condition = values.size > 1 ? values : value
+        query = query.where(key => condition)
+      end
+
+      query
+    end
+
+    def apply_sorting(query, params)
+      if params[:sort_by]
+        apply_multi_sort(query, params[:sort_by])
+      else
+        apply_sort(query, params[:sort] || 'created_at:DESC')
+      end
+    end
+
+    def apply_sort(query, value)
+      sort_field, sort_order = value.split(':')
+      query.order("#{sort_field} #{sort_order}")
+    end
+
+    def apply_multi_sort(query, value)
+      sort_params = value.split(',')
+      sorting_criteria = sort_params.map { |param| param.split(':').join(' ') }
+      query.order(sorting_criteria.join(', '))
+    end
+
+    def apply_field_selection(query, params)
+      if params[:projection] || params[:fields]
+        fields = params[:projection] || params[:fields]
+        query.select(fields.split(','))
+      else
+        query
+      end
+    end
+
+    def apply_date_range(query, value)
+      start_date = value ? parse_date(value['start']) : 1.month.ago.beginning_of_day
+      end_date = value ? parse_date(value['end']) : Time.current
+      query.where(created_at: start_date...end_date)
+    end
+
+    def apply_time_range(query, value)
+      return query if value.blank?
+
+      start_time = parse_time(value['start'] || '00:00:00')
+      end_time = parse_time(value['end'] || '23:59:59')
+
+      table_name = query.model.table_name
+      if start_time <= end_time
+        query.where("CAST(#{table_name}.created_at AS time) BETWEEN ? AND ?", start_time, end_time)
+      else
+        query.where("CAST(#{table_name}.created_at AS time) >= ? OR CAST(#{table_name}.created_at AS time) <= ?",
+                    start_time, end_time)
+      end
+    end
+
+    def apply_search(query, filters)
+      return query if filters.blank?
+
+      filters = filters.to_unsafe_h
+      conditions = build_filter_conditions(query, filters)
+      apply_conditions(query, conditions)
+    end
+
+    def build_filter_conditions(query, filters)
+      filters.map do |key, value|
+        next if value.blank?
+
+        key.include?('.') ? association_condition(query, key, value) : direct_condition(query, key, value)
+      end.compact
+    end
+
+    def association_condition(query, key, value)
+      association_chain = key.split('.')
+      attribute = association_chain.pop
+      current_table = build_join_chain(query, association_chain)
+      create_condition(current_table, attribute, value)
+    end
+
+    def build_join_chain(query, chain)
+      current_model = query.klass
+      current_table = current_model.table_name
+      join_chain = []
+
+      chain.each do |assoc|
+        reflection = current_model.reflect_on_association(assoc.to_sym) or raise "Unknown association: #{assoc} for model #{current_model}"
+        table_alias = "#{reflection.klass.table_name}_as_#{current_table}"
+        join_chain << { table: reflection.klass.table_name, alias: table_alias, foreign_key: reflection.foreign_key,
+                        parent_table: current_table }
+        current_table = table_alias
+        current_model = reflection.klass
+      end
+
+      query.joins(join_chain.map do |join|
+        "LEFT JOIN #{join[:table]} AS #{join[:alias]} ON #{join[:alias]}.id = #{join[:parent_table]}.#{join[:foreign_key]}"
+      end.join(' '))
+    end
+
+    def direct_condition(query, key, value)
+      create_condition(query.klass.table_name, key, value)
+    end
+
+    def create_condition(table, attribute, value)
+      values = value.to_s.split(',').map(&:strip)
+      column = get_column_type(table, attribute)
+
+      case column&.type
+      when :string, :text
+        condition = if values.size > 1
+                      values.map do |_v|
+                        "LOWER(#{table}.#{attribute}::text) LIKE LOWER(?)"
+                      end.join(' OR ')
+                    else
+                      "LOWER(#{table}.#{attribute}::text) LIKE LOWER(?)"
+                    end
+        values = values.size > 1 ? values.map { |v| "%#{escape_like(v)}%" } : ["%#{escape_like(value)}%"]
+        [condition, *values]
+      else
+        values.size > 1 ? ["#{table}.#{attribute} IN (?)", values] : ["#{table}.#{attribute} = ?", value]
+      end
+    end
+
+    def apply_conditions(query, conditions)
+      return query unless conditions.any?
+
+      where_clause = conditions.map(&:first).join(' OR ')
+      where_values = conditions.map(&:last).flatten
+      query.where(where_clause, *where_values)
+    end
+
+    def apply_range(query, ranges)
+      return query if ranges.blank?
+
+      ranges.each do |key, value|
+        range_values = value.split(',')
+        min_value = range_values[0].to_f if range_values[0].present?
+        max_value = range_values[1].to_f if range_values[1].present?
+
+        if min_value.present? && max_value.present?
+          query = query.where("#{key} BETWEEN ? AND ?", min_value, max_value)
+        elsif min_value.present?
+          query = query.where("#{key} >= ?", min_value)
+        elsif max_value.present?
+          query = query.where("#{key} <= ?", max_value)
+        end
+      end
+
+      query
+    end
+
+    def apply_pagination(query, params)
+      page = params.fetch(:page, 1).to_i
+      offset_value = page == 1 ? 0 : (page - 1) * @limit
+      total_pages = (@total.to_f / @limit).ceil
+
+      page <= total_pages ? query.offset(offset_value).limit(@limit) : query.none
+    end
+
+    def apply_aggregation(query, value)
+      return query if value.nil? || value.empty?
+
+      aggregation_type, aggregation_field = value.split(':')
+
+      case aggregation_type
+      when 'count'
+        query.count
+      when 'sum'
+        query.sum(aggregation_field)
+      when 'average'
+        query.average(aggregation_field)
+      when 'max'
+        query.maximum(aggregation_field)
+      when 'min'
+        query.minimum(aggregation_field)
+      else
+        query
+      end
+    end
+
+    def get_column_type(table, attribute)
+      klass = table.classify.constantize
+      klass.columns_hash[attribute.to_s]
+    rescue StandardError
+      nil
+    end
+
+    def escape_like(string)
+      string.gsub(/[\\%_]/) { |m| "\\#{m}" }
+    end
+
+    def parse_time(time_string)
+      Time.parse(time_string).strftime('%H:%M:%S')
+    rescue ArgumentError
+      '00:00:00'
+    end
+
+    def parse_date(date_string)
+      Date.parse(date_string) if date_string.present?
+    rescue ArgumentError
+      nil
+    end
+
+    private
+
+    def handle_query(query)
+      @meta['page_size'] = query.count
+      query
+    end
+  end
+end

data/lib/pw_query/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PwQuery
+  VERSION = "1.0.0"
+end

data/lib/pw_query.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'pw_query/version'
+require_relative 'pw_query/service'
+
+module PwQuery
+  class Error < StandardError; end
+
+  def self.execute(model, params, options = {}, associations = nil)
+    Service.new(model, params, options, associations).perform
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: pw_query
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeffrey Dabo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This gem provides an advanced querying service for interacting with Purple
+  Wave's Rails-backed APIs, enabling efficient data retrieval and manipulation.
+email:
+- jeffrey.dabo@purplewave.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/pw_query.rb
+- lib/pw_query/service.rb
+- lib/pw_query/version.rb
+homepage: https://github.com/purplewave/pw_query
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/purplewave/pw_query
+  source_code_uri: https://github.com/purplewave/pw_query
+  changelog_uri: https://github.com/purplewave/pw_query/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Advanced querying service for Purple Wave Rails-backed APIs
+test_files: []