shitty_ql 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6d02828248f49d3beea4260b898d1886c4f5508dee38296eede664db397e4699
4
+ data.tar.gz: e852ca54aa69de2d60148478049b82a5b5d8911162a3836a96c55b9a08f1d8c9
5
+ SHA512:
6
+ metadata.gz: 7a8e0422c69e8569915500bb14f7dc438b72ac91bcce294965ebc32292a0fdfb36db16b7740ddbcc4796ce693f1972bd144ff89e7af5ef402e0e920f429f0cab
7
+ data.tar.gz: feafd5632fe9c2507fabe3df32d1d373e268b3c1f0b571469263e8f988bcc8c9126ca35acb9a58bc9dcd379c01d1391ae89e2bc72f04fcee085eec62df922547
@@ -0,0 +1,15 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ # rvm
14
+ .ruby-version
15
+ .ruby-gemset
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,7 @@
1
+ ---
2
+ sudo: false
3
+ language: ruby
4
+ cache: bundler
5
+ rvm:
6
+ - 2.6.3
7
+ before_install: gem install bundler -v 1.17.2
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at equivalent@eq8.eu. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in shitty_ql.gemspec
6
+ gemspec
@@ -0,0 +1,50 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ shitty_ql (0.1.0)
5
+ activesupport (> 4)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ activesupport (6.0.0)
11
+ concurrent-ruby (~> 1.0, >= 1.0.2)
12
+ i18n (>= 0.7, < 2)
13
+ minitest (~> 5.1)
14
+ tzinfo (~> 1.1)
15
+ zeitwerk (~> 2.1, >= 2.1.8)
16
+ concurrent-ruby (1.1.5)
17
+ diff-lcs (1.3)
18
+ i18n (1.6.0)
19
+ concurrent-ruby (~> 1.0)
20
+ minitest (5.11.3)
21
+ rake (10.5.0)
22
+ rspec (3.8.0)
23
+ rspec-core (~> 3.8.0)
24
+ rspec-expectations (~> 3.8.0)
25
+ rspec-mocks (~> 3.8.0)
26
+ rspec-core (3.8.2)
27
+ rspec-support (~> 3.8.0)
28
+ rspec-expectations (3.8.4)
29
+ diff-lcs (>= 1.2.0, < 2.0)
30
+ rspec-support (~> 3.8.0)
31
+ rspec-mocks (3.8.1)
32
+ diff-lcs (>= 1.2.0, < 2.0)
33
+ rspec-support (~> 3.8.0)
34
+ rspec-support (3.8.2)
35
+ thread_safe (0.3.6)
36
+ tzinfo (1.2.5)
37
+ thread_safe (~> 0.1)
38
+ zeitwerk (2.1.9)
39
+
40
+ PLATFORMS
41
+ ruby
42
+
43
+ DEPENDENCIES
44
+ bundler (~> 1.17)
45
+ rake (~> 10.0)
46
+ rspec (~> 3.0)
47
+ shitty_ql!
48
+
49
+ BUNDLED WITH
50
+ 1.17.2
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Tomas Valent
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,57 @@
1
+ # ShittyQl
2
+
3
+ [ShittyQl](https://github.com/equivalent/shitty_ql) simple gem for building constructive JSON API using GET requests.
4
+
5
+
6
+ It's more a pragmatic tool and philosophy of how to write JSON API where
7
+ Frontend constructs what data it needs using GET query
8
+
9
+ So the gem tries to do what GraphQL for obtaining data but obviously gem is more :hankey:
10
+
11
+
12
+ Example
13
+ `/accounts?include=account.name,account.books.page.2,account.books.limit.10`
14
+
15
+
16
+ > todo: gem is ready I'm just writing up documentation, pls come back
17
+ > soon
18
+
19
+
20
+
21
+ ## Installation
22
+
23
+ Add this line to your application's Gemfile:
24
+
25
+ ```ruby
26
+ gem 'shitty_ql'
27
+ ```
28
+
29
+ And then execute:
30
+
31
+ $ bundle
32
+
33
+ Or install it yourself as:
34
+
35
+ $ gem install shitty_ql
36
+
37
+ ## Usage
38
+
39
+ > todo: Usage in progress
40
+
41
+ ## Development
42
+
43
+ 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.
44
+
45
+ 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).
46
+
47
+ ## Contributing
48
+
49
+ 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.
50
+
51
+ ## License
52
+
53
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
54
+
55
+ ## Code of Conduct
56
+
57
+ 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).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "shitty_ql"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,16 @@
1
+ require 'active_support/core_ext/object'
2
+ require "shitty_ql/version"
3
+ require 'shitty_ql/config'
4
+ require 'shitty_ql/include_model'
5
+ require 'shitty_ql/params_parser'
6
+ require 'shitty_ql/pagination'
7
+
8
+ module ShittyQl
9
+ def self.include_model(include_string)
10
+ ShittyQl::ParamsParser.new(include_string: include_string).include_model
11
+ end
12
+
13
+ def self.config
14
+ @config ||= ShittyQl::Config.new
15
+ end
16
+ end
@@ -0,0 +1,9 @@
1
+ module ShittyQl
2
+ class Config
3
+ attr_writer :pagination_max_limit
4
+
5
+ def pagination_max_limit
6
+ @pagination_max_limit || 50
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,40 @@
1
+ module ShittyQl
2
+ class IncludeModel
3
+ def initialize(include_hash)
4
+ @include_hash = include_hash
5
+ end
6
+
7
+ def for(node_name)
8
+ node_hash = @include_hash.fetch(node_name.to_sym) { {} }
9
+ IncludeModel.new(node_hash)
10
+ end
11
+
12
+ def inclusive_of?(key_name)
13
+ level_keys.include?(key_name.to_sym)
14
+ end
15
+
16
+ def pagination
17
+ @pagination ||= Pagination.new(self)
18
+ end
19
+
20
+ def inclusive_of_any?
21
+ level_keys.any?
22
+ end
23
+
24
+ def empty?
25
+ level_keys.empty?
26
+ end
27
+
28
+ def inspect
29
+ "<#IncludeModel #{@include_hash.inspect}>"
30
+ end
31
+
32
+ def or(other)
33
+ self.empty? ? other : self
34
+ end
35
+
36
+ def level_keys
37
+ @include_hash.keys
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,31 @@
1
+ module ShittyQl
2
+ class Pagination
3
+ attr_reader :current_level_im
4
+
5
+ def initialize(current_level_im)
6
+ @current_level_im = current_level_im
7
+ end
8
+
9
+ def page
10
+ page = current_level_im.for(:page).level_keys.first.to_s.to_i
11
+ return 1 if page < 1
12
+ page
13
+ end
14
+
15
+ def limit
16
+ lim = current_level_im.for(:limit).level_keys.first.to_s.to_i
17
+
18
+ if lim > 0 && lim < ShittyQl.config.pagination_max_limit
19
+ lim
20
+ else
21
+ ShittyQl.config.pagination_max_limit
22
+ end
23
+ end
24
+
25
+ def order
26
+ value = current_level_im.for(:order).level_keys.first
27
+ return :desc if value == :desc
28
+ :asc
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,69 @@
1
+ #?include=student_type.works,student_type.works_per_page_10,student_works_page_1,student_type.work.names
2
+
3
+ module ShittyQl
4
+ # Main purpouse is to convert include_string from params (`account.names,account.email_identity.email`)
5
+ # to merged hash:
6
+ #
7
+ # {
8
+ # account: {
9
+ # names: {}
10
+ # email_identity: {
11
+ # email: {}
12
+ # }
13
+ # }
14
+ # }
15
+ #
16
+ # ...that will then get recognized by IncludeModel to respond to `IncludeModel#inclusive_of(:acount)
17
+ #
18
+ class ParamsParser
19
+ attr_reader :include_string
20
+
21
+ def initialize(include_string: )
22
+ @include_string = include_string
23
+ end
24
+
25
+ def include_model
26
+ @include_model ||= IncludeModel.new(include_hash)
27
+ end
28
+
29
+ private
30
+
31
+ def include_hash
32
+ return {} if include_string.blank?
33
+ include_list = include_string
34
+ .split(',')
35
+ .map { |con| con.split('.') }
36
+
37
+ include_hash = {}
38
+ parse_first_level(include_hash, include_list)
39
+ include_hash.deep_symbolize_keys
40
+ end
41
+
42
+ def parse_first_level(include_hash, include_list)
43
+ include_list.each do |conditions|
44
+ if conditions.is_a?(Array)
45
+ name = conditions.shift
46
+ include_hash[name] ||= {}
47
+ include_hash[name].merge!(parse_second_level(include_hash[name], conditions))
48
+ else
49
+ include_hash[conditions] = {}
50
+ end
51
+ end
52
+ include_hash
53
+ end
54
+
55
+ def parse_second_level(include_hash, item)
56
+ if item.is_a?(Array)
57
+ if item.any?
58
+ name = item.shift
59
+ include_hash[name] ||= {}
60
+ parse_second_level(include_hash[name], item)
61
+ else
62
+ {}
63
+ end
64
+ else
65
+ include_hash.merge!({item => item})
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,3 @@
1
+ module ShittyQl
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,30 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "shitty_ql/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "shitty_ql"
8
+ spec.version = ShittyQl::VERSION
9
+ spec.authors = ["Tomas Valent"]
10
+ spec.email = ["equivalent@eq8.eu"]
11
+
12
+ spec.summary = %q{Simple query language for JSON based APIs}
13
+ spec.description = %q{Imagine GraphQL alike query language for JSON based APIs usecase but with really pragmatic implementation using GET requests}
14
+ spec.homepage = "https://github.com/equivalent/shitty_ql"
15
+ spec.license = "MIT"
16
+
17
+ # Specify which files should be added to the gem when it is released.
18
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
19
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
20
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
21
+ end
22
+ spec.bindir = "exe"
23
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
24
+ spec.require_paths = ["lib"]
25
+
26
+ spec.add_dependency "activesupport", "> 4" # I use goodies like .try?() .blank?()
27
+ spec.add_development_dependency "bundler", "~> 1.17"
28
+ spec.add_development_dependency "rake", "~> 10.0"
29
+ spec.add_development_dependency "rspec", "~> 3.0"
30
+ end
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shitty_ql
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tomas Valent
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2019-09-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">"
18
+ - !ruby/object:Gem::Version
19
+ version: '4'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">"
25
+ - !ruby/object:Gem::Version
26
+ version: '4'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.17'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.17'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.0'
69
+ description: Imagine GraphQL alike query language for JSON based APIs usecase but
70
+ with really pragmatic implementation using GET requests
71
+ email:
72
+ - equivalent@eq8.eu
73
+ executables: []
74
+ extensions: []
75
+ extra_rdoc_files: []
76
+ files:
77
+ - ".gitignore"
78
+ - ".rspec"
79
+ - ".travis.yml"
80
+ - CODE_OF_CONDUCT.md
81
+ - Gemfile
82
+ - Gemfile.lock
83
+ - LICENSE.txt
84
+ - README.md
85
+ - Rakefile
86
+ - bin/console
87
+ - bin/setup
88
+ - lib/shitty_ql.rb
89
+ - lib/shitty_ql/config.rb
90
+ - lib/shitty_ql/include_model.rb
91
+ - lib/shitty_ql/pagination.rb
92
+ - lib/shitty_ql/params_parser.rb
93
+ - lib/shitty_ql/version.rb
94
+ - shitty_ql.gemspec
95
+ homepage: https://github.com/equivalent/shitty_ql
96
+ licenses:
97
+ - MIT
98
+ metadata: {}
99
+ post_install_message:
100
+ rdoc_options: []
101
+ require_paths:
102
+ - lib
103
+ required_ruby_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ required_rubygems_version: !ruby/object:Gem::Requirement
109
+ requirements:
110
+ - - ">="
111
+ - !ruby/object:Gem::Version
112
+ version: '0'
113
+ requirements: []
114
+ rubygems_version: 3.0.3
115
+ signing_key:
116
+ specification_version: 4
117
+ summary: Simple query language for JSON based APIs
118
+ test_files: []