query_string 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34e92e657e8f11169706f1d3e43c13e4f9c85d353aec420e116825fbef34a6de
+  data.tar.gz: 86bb197ccd1dfb64ea89e13197ddb76db2b5463b5e56377bcbbb3a1d6e04da99
+SHA512:
+  metadata.gz: 9e1614029543337217106fa9ccca8c19287722de469f1c04f508826046147cbc73eb8ca4744b75ab3f4a1e5c559347fb2c391c42ed11906d5e0fd6394bc08ecd
+  data.tar.gz: 73195f9516fe105883a2678b3c23cd96ba40b06aae16432e59e0e51d1b77d57e029a33abbce664576f987b9ac9d2af101f2379e81875d0cd432719d7875f9e38

data/.circleci/config.yml

@@ -0,0 +1,76 @@
+version: 2
+
+steps: &steps
+  steps:
+    - checkout
+    # Download and cache dependencies
+    - restore_cache:
+        keys:
+        - dependencies-{{ checksum "Gemfile.lock" }}
+        # fallback to using the latest cache if no exact match is found
+        - dependencies-
+    - run:
+        name: install dependencies
+        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+    - save_cache:
+        paths:
+          - ./vendor/bundle
+        key: dependencies-{{ checksum "Gemfile.lock" }}
+
+    - run: bundle exec rake run_task_from_env
+
+jobs:
+  ruby-2.2:
+    docker:
+      - image: circleci/ruby:2.2
+    environment:
+      - TASK: spec
+    <<: *steps
+
+  ruby-2.3:
+    docker:
+      - image: circleci/ruby:2.3
+    environment:
+      - TASK: spec
+    <<: *steps
+
+  ruby-2.4:
+    docker:
+      - image: circleci/ruby:2.4
+    environment:
+      - TASK: spec
+    <<: *steps
+
+  ruby-2.5:
+    docker:
+      - image: circleci/ruby:2.5
+    environment:
+      - TASK: spec
+      - CODECOV: true
+    <<: *steps
+
+  jruby-9.2:
+    docker:
+      - image: circleci/jruby:9.2
+    environment:
+      - TASK: spec
+    <<: *steps
+
+  rubocop:
+    docker:
+      - image: circleci/ruby:2.5
+    environment:
+      - TASK: rubocop
+    <<: *steps
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - ruby-2.2
+      - ruby-2.3
+      - ruby-2.4
+      - ruby-2.5
+      - jruby-9.2
+      - rubocop

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Simen Svale Skogsrud, 2018 Alexander Popov (AlexWayfer)
+
+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,21 @@
+# QueryString
+
+[![CircleCI branch](https://img.shields.io/circleci/project/github/AlexWayfer/query_string/master.svg?style=flat-square)](https://circleci.com/gh/AlexWayfer/query_string/tree/master)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/query_string/master.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/query_string/branch/master)
+[![license](https://img.shields.io/github/license/AlexWayfer/query_string.svg?style=flat-square)](https://github.com/AlexWayfer/query_string/blob/master/LICENSE)
+
+A straight forward gem to build HTTP query strings from Ruby Hashes and Arrays following the query string conventions of Rails and Sinatra. It supports Hashes, Arrays, nested Hashes and Arrays of Hashes and all combinations thereof. E.g.:
+
+```ruby
+QueryString.build(a: 1, b: 'c')
+#=> 'a=1&b=c'
+
+QueryString.build(a: { b: 'c', d: 'e' }, f: 'g')
+#=> 'a[b]=c&a[d]=e&f=g'
+
+QueryString.build(a: ['foo', 'bar'])
+#=> 'a[]=foo&a[]=bar'
+
+QueryString.build(a: [{ b:'c', d:'e' }, { b:'g' }])
+#=> 'a[][b]=c&a[][d]=e&a[][b]=g'
+```

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task :run_task_from_env do
+  sh "bundle exec rake #{ENV['TASK']}"
+end

data/lib/query_string/version.rb

@@ -0,0 +1,3 @@
+module QueryString
+  VERSION = '1.0.0'.freeze
+end

data/lib/query_string.rb

@@ -0,0 +1,31 @@
+require 'query_string/version'
+
+# Module with class methods for convertation
+module QueryString
+  class << self
+    def build(value, prefix = nil)
+      case value
+      when Hash
+        build_hash(value, prefix)
+      when Array
+        value.map { |v| build(v, "#{prefix}[]") }.join('&')
+      when nil then prefix.to_s
+      else
+        raise ArgumentError, 'value must be a Hash' if prefix.nil?
+        "#{prefix}=#{escape(value)}"
+      end
+    end
+
+    private
+
+    def build_hash(hash, prefix)
+      hash.map do |k, v|
+        build(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
+      end.join('&')
+    end
+
+    def escape(value)
+      URI.encode_www_form_component(value)
+    end
+  end
+end

data/query_string.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/query_string/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'query_string'
+  s.version     = QueryString::VERSION
+  s.authors     = ['Simen Svale Skogsrud', 'Alexander Popov']
+  s.email       = ['simen@bengler.no', 'alex.wayfer@gmail.com']
+  s.homepage    = 'https://github.com/AlexWayfer/query_string'
+  s.summary     = 'Build HTTP query strings from nested Ruby Hashes and Arrays.'
+  s.description =
+    'It supports Hashes, Arrays, nested Hashes and Arrays of Hashes ' \
+    'and all combinations thereof.'
+
+  s.license = 'MIT'
+
+  s.required_ruby_version = '>= 2.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'codecov', '~> 0.1'
+  s.add_development_dependency 'rake', '~> 12'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'rubocop', '~> 0.57.2'
+  s.add_development_dependency 'simplecov', '~> 0.16'
+  # s.add_runtime_dependency 'rest-client'
+end

data/spec/query_string_spec.rb

@@ -0,0 +1,88 @@
+require 'bundler'
+Bundler.require
+
+describe QueryString do
+  describe '.build' do
+    subject { described_class.build(input) }
+
+    context 'input is empty Hash' do
+      let(:input) { {} }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'input is nil' do
+      let(:input) { nil }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'input is String' do
+      let(:input) { 'foo=bar' }
+
+      it do
+        expect { subject }.to raise_error(ArgumentError, 'value must be a Hash')
+      end
+    end
+
+    context 'input is one-level Hash' do
+      let(:input) { { a: 1, b: 'c', d: :e, f: 2.34 } }
+
+      it { is_expected.to eq 'a=1&b=c&d=e&f=2.34' }
+    end
+
+    context 'input is nested Hashes' do
+      let(:input) { { a: { b: 'c', d: 'e' }, f: 'g' } }
+
+      it { is_expected.to eq 'a[b]=c&a[d]=e&f=g' }
+    end
+
+    context 'input is Hash with Array' do
+      let(:input) { { a: %w[foo bar] } }
+
+      it { is_expected.to eq 'a[]=foo&a[]=bar' }
+    end
+
+    context 'input is Hash with Array of Hashes' do
+      let(:input) { { a: [{ b: 'c', d: 'e' }, { b: 'g' }] } }
+
+      it { is_expected.to eq 'a[][b]=c&a[][d]=e&a[][b]=g' }
+    end
+
+    context 'input is Hash with unencoded keys and values' do
+      let(:input) { { 'test field' => { 'another weird' => 'foo/(bar)' } } }
+
+      it { is_expected.to eq 'test+field[another+weird]=foo%2F%28bar%29' }
+    end
+
+    context 'input is Hash with nil value' do
+      let(:input) { { a: nil, b: '', d: nil } }
+
+      it { is_expected.to eq 'a&b=&d' }
+    end
+
+    context 'input is Hash with nil in Array value' do
+      let(:input) { { a: [nil] } }
+
+      it { is_expected.to eq 'a[]' }
+    end
+
+    context 'input is Hash with empty String in Array value' do
+      let(:input) { { a: [''] } }
+
+      it { is_expected.to eq 'a[]=' }
+    end
+
+    context 'input is Hash with empty Hash value' do
+      let(:input) { { a: {} } }
+
+      it { is_expected.to eq '' }
+    end
+
+    context 'input is Hash with empty Array value' do
+      let(:input) { { a: [] } }
+
+      it { is_expected.to eq '' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+SimpleCov.start
+
+if ENV['CODECOV']
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: query_string
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Simen Svale Skogsrud
+- Alexander Popov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+description: It supports Hashes, Arrays, nested Hashes and Arrays of Hashes and all
+  combinations thereof.
+email:
+- simen@bengler.no
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/query_string.rb
+- lib/query_string/version.rb
+- query_string.gemspec
+- spec/query_string_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/AlexWayfer/query_string
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Build HTTP query strings from nested Ruby Hashes and Arrays.
+test_files:
+- spec/query_string_spec.rb
+- spec/spec_helper.rb