query_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8323efe71cd09abe2c93f83f4fc3762d64bfc11b
+  data.tar.gz: 9ee2064b4be6ad854034b82083825457496ae213
+SHA512:
+  metadata.gz: 4f37f39162c02d07e290e94b6bb5ef64cc2deb496f7bf2cb4b59bdda3108fe33c4bb90b4fc1b926751d21d56e3dd153ca4920e04ffc40635b93b61e95b2c95a2
+  data.tar.gz: 316c656c9e7d73bf2c93b5bfcb2e4482052c82408da8bb0ddeecba10484b625bc592251efe61e81706692ed5794a2d5e52074e3b97746be1f228e9da853da0e9

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in query_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 William Souza
+
+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,40 @@
+# Query Params
+
+Format URL parameters like a query.
+It allows you to send operators and the same parameter twice on the same request. 
+
+For example: 
+```
+http://domain.com/search?filters=age::ge(18)|age::le(25)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query-params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query-params
+
+## Usage
+
+```ruby
+puts QueryParams.build_uri(base_uri: "http://domain.com/search", q: "Mark", conditions: ["age <= 18", "type = 1"])
+# http://domain.com/search?q=Mark&filters=age::le(18)|type::eq(1)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/willmiranda/query-params/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "query_params"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/query_params/condition.rb

@@ -0,0 +1,32 @@
+require "query_params"
+
+class Condition
+
+  OPERATORS = { "=" => "eq", ">=" => "ge", "<=" => "le" }
+
+  def self.build_uri(queryParams, conditions)
+    
+    if conditions.kind_of?(Array)
+      conditions.each do |condition|
+        set_query(queryParams, condition)
+      end
+    else
+      set_query(queryParams, conditions)
+    end
+  end
+
+  def self.set_query(queryParams, condition)
+    tokens = condition.split(" ")
+    
+    raise(ArgumentError, "Invalid condition: #{condition}. Send operator separate for space.") if tokens.size < 3
+
+    field = tokens[0].strip
+    operator = tokens[1].strip
+    value = tokens[2..tokens.size].join(" ").strip.gsub(/['"]/,"")
+    
+    raise(ArgumentError, "Invalid operator. Accepted tokens: #{OPERATORS.values}") if OPERATORS[operator].nil?
+
+    queryParams.send(OPERATORS[operator], field, value)
+  end
+
+end

data/lib/query_params/filter.rb

@@ -0,0 +1,47 @@
+module Filter
+  
+  def full_text_search(query)
+    @query = "q=#{ERB::Util.url_encode(query.strip)}"
+  end
+
+  def q(query)
+    full_text_search(query)
+  end
+
+  def equal(key, value)
+    if value.kind_of?(Array)
+      @params.push("#{key}::in(#{value.join(",")})")
+    else
+      @params.push("#{key}::eq(#{value})")
+    end
+  end
+
+  def eq(key, value)
+    equal(key, value)
+  end
+
+  def greater_and_equal(key, value)
+    @params.push("#{key}::ge(#{value})")
+  end
+    
+  def ge(key, value)
+    greater_and_equal(key, value)
+  end
+
+  def less_and_equal(key, value)
+    @params.push("#{key}::le(#{value})")
+  end
+
+  def le(key, value)
+    less_and_equal(key, value)
+  end
+
+  def between(key, range_ini, range_end)
+    @params.push("#{key}::bt(#{range_ini},#{range_end})")
+  end
+
+  def bt(key, range_ini, range_end)
+    between(key, range_ini, range_end)
+  end
+
+end

data/lib/query_params/version.rb

@@ -0,0 +1,3 @@
+module QueryParams
+  VERSION = "0.1.0"
+end

data/lib/query_params.rb

@@ -0,0 +1,35 @@
+require "query_params/version"
+require "query_params/filter"
+require "query_params/condition"
+
+class QueryParams
+
+  include Filter
+
+  def initialize(base_uri = "")
+    @base_uri = base_uri.nil? ? "" : base_uri
+    @params = []
+    @query = ""
+  end
+
+  def build_uri()
+    uri = ""
+    unless @base_uri.empty?
+      uri += uri.include?('?') ? "&" : "?"
+    end
+    unless @query.empty?
+      uri += "#{@query}" 
+      uri += "&" unless @params.empty?
+    end
+    uri += "filters=#{ERB::Util.url_encode(@params.join("|"))}" unless @params.empty?
+    uri = "" if uri.length == 1
+    "#{@base_uri}#{uri}"
+  end
+
+  def self.build_uri(options = {})
+    queryParams = QueryParams.new(options[:base_uri])
+    Condition.build_uri(queryParams, options[:conditions]) if options[:conditions]
+    queryParams.full_text_search(options[:q]) if options[:q]
+    queryParams.build_uri()
+  end
+end

data/query_params.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_params"
+  spec.version       = QueryParams::VERSION
+  spec.authors       = ["William Souza"]
+  spec.email         = ["willmiranda@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.summary       = %q{Format URL parameters like a query.}
+  spec.description   = %q{It allows you to send operators and the same parameter twice on the same request.}
+  spec.homepage      = "https://github.com/willmiranda/query-params"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+end

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: query_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Souza
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It allows you to send operators and the same parameter twice on the same
+  request.
+email:
+- willmiranda@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/query_params.rb
+- lib/query_params/condition.rb
+- lib/query_params/filter.rb
+- lib/query_params/version.rb
+- query_params.gemspec
+- tasks/rspec.rake
+homepage: https://github.com/willmiranda/query-params
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Format URL parameters like a query.
+test_files: []