json_api_query_parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e208a1cad10acab77450d08d69e6bb89032e47f
+  data.tar.gz: 6b5a0d3535178821cea8c1743e62fb45f619e7ee
+SHA512:
+  metadata.gz: 6702e32d7185ae8985ffc5b783a0ddbd8c230975d1ef68528432c772c77071e65027ee1e0e0a54089b6a3cf06f16ad0dabd7ba03963c334cf37c2b5edce7c8c7
+  data.tar.gz: 933a91824a77326c045e0ba783d7f2738879a5a5ee80fcff5d7314d359b690bf8315592a9069ac6e6b6b9061da800aca18ecd202cb58d5abcf72c79b5986d266

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.6
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tavares.gleydson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_api_query_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Gleydson Tavares
+
+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,42 @@
+# JSON API query parser
+
+To be used for ruby projects that make use of [JSON API](http://jsonapi.org/)
+
+
+## Installation
+
+```sh
+$ gem install json_api_query_parser
+```
+
+Or in the gemfile of the rails project
+
+```ruby
+gem 'json_api_query_parser'
+```
+
+## Usage
+
+Require the gem 'json_api_query_parser' into your application and use the 'parseRequest' method to convert the request.url to an easy
+usable Hash.
+
+```ruby
+require('json_api_query_parser')
+JsonApiQueryParser.parseRequest("movies/5?include=actors,actors.agency&fields[movies]=title,year&fields[actors]=name&page[limit]=20")
+```
+
+## Return data information
+
+The Hash returned by the JsonApiQueryParser.parseRequest will always be the same structure.
+
+```ruby
+{
+  :resourceType=>"movies", 
+  :identifier=>"5", 
+  :queryData=>{
+    :include=>["actors", "actors.agency"], 
+    :fields=>{:movies=>["title", "year"], :actors=>["name"]},
+    :page=>{"limit"=>"20"}
+  }
+} 
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json_api_query_parser"
+
+# 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(__FILE__)

data/bin/setup

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

data/json_api_query_parser.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_api_query_parser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_api_query_parser"
+  spec.version       = JsonApiQueryParser::VERSION
+  spec.authors       = ["Gleydson Tavares"]
+  spec.email         = ["tavares.gleydson@gmail.com"]
+
+  spec.summary       = %q{Gem to parse endpoint and its query parameters to a usable request object}
+  spec.homepage      = "https://github.com/g13ydson/json_api_query_parser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/json_api_query_parser/version.rb

@@ -0,0 +1,3 @@
+module JsonApiQueryParser
+  VERSION = "0.1.1"
+end

data/lib/json_api_query_parser.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "json_api_query_parser/version"
+
+module JsonApiQueryParser
+  PARSE_PARAM = {
+    parseInclude: /^include\=(.*?)/i,
+    parseFields: /^fields\[(.*?)\]\=.*?$/i,
+    parsePage: /^page\[(.*?)\]\=.*?$/i
+  }.freeze
+
+  def self.parseRequest(url)
+    requestData = {
+      resourceType: nil,
+      identifier: nil,
+      queryData: {
+        include: [],
+        fields: {},
+        page: {}
+      }
+    }
+
+    urlSplit = url.split("?")
+    requestData = parseEndpoint(urlSplit[0], requestData) if urlSplit[0]
+
+    if urlSplit[1]
+      requestData[:queryData] = parseQueryParameters(urlSplit[1], requestData[:queryData])
+    end
+
+    requestData
+  end
+
+  def self.parseQueryParameters(queryString, requestData)
+    querySplit = queryString.split("&")
+
+    querySplit.each do |query|
+      delegateToParser(query, requestData)
+    end
+
+    requestData
+  end
+
+  def self.parseEndpoint(endpointString, requestData)
+    requestSplit = endpointString.split("/")
+
+    requestData[:resourceType] = requestSplit[0]
+    requestData[:identifier] = requestSplit.length >= 2 ? requestSplit[1] : nil
+
+    requestData
+  end
+
+  def self.delegateToParser(query, requestData)
+    PARSE_PARAM.each do |functionName, _value|
+      if query =~ PARSE_PARAM[functionName.to_sym]
+        requestData = send(functionName, query, requestData)
+      end
+    end
+  end
+
+  def self.parseInclude(includeString, requestData)
+    targetString = includeString.split("=")[1]
+    requestData[:include] = targetString.split(",")
+
+    requestData
+  end
+
+  def self.parseFields(fieldsString, requestData)
+    targetResource, targetFields, targetFieldsString = ""
+    fieldNameRegex = /^fields.*?\=(.*?)$/i
+
+    targetResource = fieldsString.scan(PARSE_PARAM[:parseFields])
+
+    targetFieldsString = fieldsString.scan(fieldNameRegex)
+
+    requestData[:fields][targetResource[0][0]] = !requestData[:fields][targetResource[0][0]] ? [] : targetResource[0][0]
+    targetFields = targetFieldsString[0][0].split(",")
+
+    targetFields.each do |targetField|
+      requestData[:fields][targetResource[0][0]] << targetField
+    end
+
+    requestData
+  end
+
+  def self.parsePage (pageString, requestData)
+    pageSettingKey, pageSettingValue = ""
+    pageValueRegex = /^page.*?\=(.*?)$/i
+
+    pageSettingKey = pageString.scan(PARSE_PARAM[:parsePage])
+
+    pageSettingValue = pageString.scan(pageValueRegex)
+
+    requestData[:page][pageSettingKey[0][0]] = pageSettingValue[0][0]
+
+    requestData
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: json_api_query_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gleydson Tavares
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tavares.gleydson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_api_query_parser.gemspec
+- lib/json_api_query_parser.rb
+- lib/json_api_query_parser/version.rb
+homepage: https://github.com/g13ydson/json_api_query_parser
+licenses:
+- MIT
+metadata: {}
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Gem to parse endpoint and its query parameters to a usable request object
+test_files: []