shitty_ql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d02828248f49d3beea4260b898d1886c4f5508dee38296eede664db397e4699
+  data.tar.gz: e852ca54aa69de2d60148478049b82a5b5d8911162a3836a96c55b9a08f1d8c9
+SHA512:
+  metadata.gz: 7a8e0422c69e8569915500bb14f7dc438b72ac91bcce294965ebc32292a0fdfb36db16b7740ddbcc4796ce693f1972bd144ff89e7af5ef402e0e920f429f0cab
+  data.tar.gz: feafd5632fe9c2507fabe3df32d1d373e268b3c1f0b571469263e8f988bcc8c9126ca35acb9a58bc9dcd379c01d1391ae89e2bc72f04fcee085eec62df922547

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rvm
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

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 equivalent@eq8.eu. 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 shitty_ql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    shitty_ql (0.1.0)
+      activesupport (> 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  shitty_ql!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Tomas Valent
+
+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,57 @@
+# ShittyQl
+
+[ShittyQl](https://github.com/equivalent/shitty_ql) simple gem for building constructive JSON API using GET requests.
+
+
+It's more a pragmatic tool and philosophy of how to write JSON API where
+Frontend constructs what data it needs using GET query
+
+So the gem tries to do what GraphQL for obtaining data but obviously gem is more :hankey:
+
+
+Example
+`/accounts?include=account.name,account.books.page.2,account.books.limit.10`
+
+
+> todo:  gem is ready I'm just writing up documentation, pls come back
+> soon
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shitty_ql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shitty_ql
+
+## Usage
+
+> todo:  Usage in progress
+
+## 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 tags, 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]/shitty_ql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 ShittyQl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shitty_ql/blob/master/CODE_OF_CONDUCT.md).

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 "shitty_ql"
+
+# 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/lib/shitty_ql.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/object'
+require "shitty_ql/version"
+require 'shitty_ql/config'
+require 'shitty_ql/include_model'
+require 'shitty_ql/params_parser'
+require 'shitty_ql/pagination'
+
+module ShittyQl
+  def self.include_model(include_string)
+    ShittyQl::ParamsParser.new(include_string: include_string).include_model
+  end
+
+  def self.config
+    @config ||= ShittyQl::Config.new
+  end
+end

data/lib/shitty_ql/config.rb

@@ -0,0 +1,9 @@
+module ShittyQl
+  class Config
+    attr_writer :pagination_max_limit
+
+    def pagination_max_limit
+      @pagination_max_limit || 50
+    end
+  end
+end

data/lib/shitty_ql/include_model.rb

@@ -0,0 +1,40 @@
+module ShittyQl
+  class IncludeModel
+    def initialize(include_hash)
+      @include_hash = include_hash
+    end
+
+    def for(node_name)
+      node_hash = @include_hash.fetch(node_name.to_sym) { {} }
+      IncludeModel.new(node_hash)
+    end
+
+    def inclusive_of?(key_name)
+      level_keys.include?(key_name.to_sym)
+    end
+
+    def pagination
+      @pagination ||= Pagination.new(self)
+    end
+
+    def inclusive_of_any?
+      level_keys.any?
+    end
+
+    def empty?
+      level_keys.empty?
+    end
+
+    def inspect
+      "<#IncludeModel #{@include_hash.inspect}>"
+    end
+
+    def or(other)
+      self.empty? ? other : self
+    end
+
+    def level_keys
+      @include_hash.keys
+    end
+  end
+end

data/lib/shitty_ql/pagination.rb

@@ -0,0 +1,31 @@
+module ShittyQl
+  class Pagination
+    attr_reader :current_level_im
+
+    def initialize(current_level_im)
+      @current_level_im = current_level_im
+    end
+
+    def page
+      page = current_level_im.for(:page).level_keys.first.to_s.to_i
+      return 1 if page < 1
+      page
+    end
+
+    def limit
+      lim = current_level_im.for(:limit).level_keys.first.to_s.to_i
+
+      if lim > 0 && lim < ShittyQl.config.pagination_max_limit
+        lim
+      else
+        ShittyQl.config.pagination_max_limit
+      end
+    end
+
+    def order
+      value = current_level_im.for(:order).level_keys.first
+      return :desc if value == :desc
+      :asc
+    end
+  end
+end

data/lib/shitty_ql/params_parser.rb

@@ -0,0 +1,69 @@
+#?include=student_type.works,student_type.works_per_page_10,student_works_page_1,student_type.work.names
+
+module ShittyQl
+  # Main purpouse is to convert include_string from params (`account.names,account.email_identity.email`)
+  # to merged hash:
+  #
+  # {
+  #   account: {
+  #     names: {}
+  #     email_identity: {
+  #       email: {}
+  #     }
+  #   }
+  # }
+  #
+  # ...that will then  get recognized by IncludeModel to respond to `IncludeModel#inclusive_of(:acount)
+  #
+  class ParamsParser
+    attr_reader :include_string
+
+    def initialize(include_string: )
+      @include_string = include_string
+    end
+
+    def include_model
+      @include_model ||= IncludeModel.new(include_hash)
+    end
+
+    private
+
+    def include_hash
+      return {} if include_string.blank?
+      include_list = include_string
+        .split(',')
+        .map { |con| con.split('.') }
+
+      include_hash = {}
+      parse_first_level(include_hash, include_list)
+      include_hash.deep_symbolize_keys
+    end
+
+    def parse_first_level(include_hash, include_list)
+      include_list.each do |conditions|
+        if conditions.is_a?(Array)
+          name = conditions.shift
+          include_hash[name] ||= {}
+          include_hash[name].merge!(parse_second_level(include_hash[name], conditions))
+        else
+          include_hash[conditions] = {}
+        end
+      end
+      include_hash
+    end
+
+    def parse_second_level(include_hash, item)
+      if item.is_a?(Array)
+        if item.any?
+          name = item.shift
+          include_hash[name] ||= {}
+          parse_second_level(include_hash[name], item)
+        else
+          {}
+        end
+      else
+        include_hash.merge!({item => item})
+      end
+    end
+  end
+end

data/lib/shitty_ql/version.rb

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

data/shitty_ql.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shitty_ql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shitty_ql"
+  spec.version       = ShittyQl::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{Simple query language for JSON based APIs}
+  spec.description   = %q{Imagine GraphQL alike query language for JSON based APIs usecase but with really pragmatic implementation using GET requests}
+  spec.homepage      = "https://github.com/equivalent/shitty_ql"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency "activesupport", "> 4" # I use goodies like .try?() .blank?()
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: shitty_ql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: Imagine GraphQL alike query language for JSON based APIs usecase but
+  with really pragmatic implementation using GET requests
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shitty_ql.rb
+- lib/shitty_ql/config.rb
+- lib/shitty_ql/include_model.rb
+- lib/shitty_ql/pagination.rb
+- lib/shitty_ql/params_parser.rb
+- lib/shitty_ql/version.rb
+- shitty_ql.gemspec
+homepage: https://github.com/equivalent/shitty_ql
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Simple query language for JSON based APIs
+test_files: []