pragmatic_ql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 771e0f65cd0dab969fbcceb1e6dc14080506a51f57ac2d79528f28dc5eb8e3b2
+  data.tar.gz: 826df108ac44f83691b2bd68b092d86b6230a8badef0fdfd3936604a4ca71819
+SHA512:
+  metadata.gz: e96dcf11d19d0313e68c65fb67bcc0b9ca5c1f93967dff1a41a4d6cbf4f0b08dad1b0d6cad3832bf19c395d2ecb5080c5a316291784778bd7fd56c9bda9ce16a
+  data.tar.gz: 315f268340952a8c6bf14ec9fb49dee2d49b1284e7a627ab11035bb69a969639d2c19c2e6a9b83c777ae6c649dd4a2f3c16c059ab228f3b8a853f243f5956a38

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+  - 2.6.1
+  - 2.6.2
+  - 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 pragmatic_ql.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    pragmatic_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)
+  pragmatic_ql!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+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,92 @@
+# Pragmatic QL
+
+[PragmaticQL](https://github.com/Pobble/pragmatic_ql) simple gem for building constructive/query based JSON API using GET requests.
+
+[![Build Status](https://travis-ci.org/Pobble/pragmatic_ql.svg?branch=master)](https://travis-ci.org/Pobble/pragmatic_ql)
+
+PragmaticQL is more a pragmatic tool and **philosophy** of how to write JSON API where
+Frontend constructs what data it needs using GET query.
+
+Gem is not a comprehensive API solution for [Ruby on Rails](https://rubyonrails.org), but we will show you how you
+can build one in your Rails application using this gem.
+
+
+Example of API endpoints
+
+```
+GET /student/123?include=student.name,student.dob
+GET /student/123?include=student.name,student.work.title,student.work_list
+GET /student/123?include=student.name,student.work.title,student.work_list.page.2
+GET /student/123?include=student.name,student.work.title,student.work_list.page.2.limit.10
+GET /student/123?include=student.name,student.work.title,student.work_list.page.2,student.work_list.limit.10
+GET /student/123?include=student.name,student.work.title,student.work_list.page.2,student.work_list.limit.10,student.work_list.order.desc
+
+
+GET /students?include=student.name,student.dob
+GET /students?include=student.name,student.work.title,student.work_list
+
+```
+
+> So the gem tries to do what GraphQL for obtaining data but obviously gem solution is more :hankey: ...but at the same time more pragmatic.
+
+
+> todo:  gem is ready I'm just writing up documentation, pls come back
+> soon
+
+
+#### why don't you use GraphQL ?
+
+We love [GraphQL](https://graphql.org) and recommending to use it
+instead of [PragmaticQL](https://github.com/equivalent/pragmatic_ql). 
+
+But Sometimes you are dealing with legacy REST API and you want to slowly
+introduce query language to the application API and you don't have the luxury of switching
+the entire project to GraphQL. This is where PragmaticQL may come in handy.
+You may slowly transition your API to query/constructive based API and then maybe
+make it GraphQL (but I doubt it as you will end up loving this :hankey:)
+
+Another benefit of PragmaticQL is that it's job is only to help you to GET
+/retrieve data. PragmaticQL is not imposing any way how to
+create/update/delete your data. That is up to you to decide how to do it
+(REST is pretty good in this actually)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pragmatic_ql'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+This is quite comprehensive topic. Pls read up section in `/docs`:
+
+* [01 really simple example](https://github.com/equivalent/pragmatic_ql/blob/master/docs/01_stupid_simple_implementation.md)
+* [02 serializer implementation](https://github.com/equivalent/pragmatic_ql/blob/master/docs/02_serializer_example.md)
+
+
+
+## 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`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/equivalent/pragmatic_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 PragmaticQL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/equivalent/pragmatic_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 "pragmatic_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/docs/01_stupid_simple_implementation.md

@@ -0,0 +1,62 @@
+## basic example implementation
+
+Most stupid simple implementation could be:
+
+
+```ruby
+# config/routes
+
+Rails.application.routes.draw do
+ resources :students, only: [:show]
+end
+```
+
+```ruby
+# app/controllers/students_controller.rb
+class StudentsController < ApplicationController
+
+  # GET /students/123?include?student.___
+  def show
+    student = Student.find(params[:id])
+
+    include_model = PragmaticQL.include_model(params[:include])
+    student_im = include_model.for(:student)
+
+    resp = { id: student.id }
+
+    resp.merge!({
+      first_name: student.first_name,
+      last_name: student.last_name
+    }) if student_im.include?(:names)
+
+    resp.merge!(date_of_birth: student.first_name) if student_im.include?(:dob)
+
+    render json: resp
+  end
+end
+```
+
+This way when you query `/students/123?include=student.names,student.dob` you get:
+
+
+```json
+{
+  "id": 123,
+  "first_name": "Tomas",
+  "last_name": "Valent",
+  "date_of_birth": "..some value..",
+}
+```
+
+This way when you query `/students/123?include=student.dob` you get:
+
+
+```json
+{
+  "id": 123,
+  "date_of_birth": "..some value..",
+}
+```
+
+> This is just demo of the most simple way how you can use this gem, I
+> don't recommend this solution. Pls check other examples :)

data/docs/02_serializer_example.md

@@ -0,0 +1,308 @@
+## SerializerImplementation
+
+
+
+```ruby
+# app/model/student.rb
+class Student < ApplicationRecord
+  # model has fields: "id", "first_name", "last_name", "date_of_birth", "private_note", "created_at", "updated_at"
+
+  has_many :works
+end
+```
+
+```ruby
+# app/model/work.rb
+class Work < ApplicationRecord
+  # model has fields: "id", "title", "content", "created_at", "updated_at", "published_at", "student_id"
+
+  belongs_to :student
+  has_many :images
+end
+```
+
+```ruby
+# app/model/image.rb
+class image < ApplicationRecord
+  # model has fields: "id", "priority", "work_id"
+
+  belongs_to :work
+  has_one_attached :picture   # rails 5.2 and above intreduce custom image upload called ActiveStorage
+end
+```
+
+```ruby
+# config/routes
+
+Rails.application.routes.draw do
+ resources :students, only: [:show]
+end
+```
+
+```ruby
+# app/controllers/students_controller.rb
+class StudentsController < ApplicationController
+
+  # GET /students/123?include?student.___
+  def show
+    student = Student.find(params[:id])
+    include_model = PragmaticQL.include_model(params[:include])
+    render json: StudentSerializer
+       .new(student)
+       .set_level_include_model(include_model)
+       .as_json
+  end
+end
+```
+
+create folder `app/serializers` Rails should auto-detect it
+
+```ruby
+# app/serializers/student_serializer.rb
+class StudentSerializer
+  attr_accessor :include_model
+  attr_reader :student
+
+  def initialize(student)
+    @student = student
+  end
+
+  def set_level_include_model(inc_model)
+    self.include_model = inc_model.for(:student)
+    self
+  end
+
+  def as_json
+    hash = {id: student.id}
+    hash.merge!(name_hash) if include_model.inclusive_of?(:name)
+    hash.merge!(dob_hash) if include_model.inclusive_of?(:dob)
+    hash.merge!(work_list_hash) if include_model.inclusive_of?(:work_list)
+    hash
+  end
+
+  private
+
+  # feel free to group multiple fields uder one include key
+  def name_hash
+    {
+       first_name: student.first_name,
+       last_name:  student.last_name
+    }
+  end
+
+  def dob_hash
+    {
+       date_of_birth: student.date_of_birth
+    }
+  end
+
+  def work_list_hash
+    { work_list: student.works.map { |work| work_as_json(work) } }
+  end
+
+  def work_as_json(work)
+    WorkSerializer
+      .new(work)
+      .set_level_include_model(include_model)
+      .as_json
+  end
+end
+```
+
+
+```ruby
+app/serializers/work_serializer.rb
+
+class WorkSerializer
+  attr_accessor :include_model
+  attr_reader :work
+
+  def initialize(work)
+    @work = work
+  end
+
+  def set_level_include_model(inc_model)
+    self.include_model = inc_model.for(:work)
+    self
+  end
+
+  def as_hash
+    hash = { id: work.id }
+    hash.merge!(title_hash) if include_model.inclusive_of?(:title)
+    hash.merge!(content_hash) if include_model.inclusive_of?(:content)
+    hash.merge!(timestamps_hash) if include_model.inclusive_of?(:timestamps)
+    hash.merge!(image_list_hash) if include_model.inclusive_of?(:image_list)
+    hash
+  end
+
+  private
+
+  def title_hash
+    { title: work.title }
+  end
+
+  # imagine the work.content is markdown text and it can be converted to HTML
+  def content_hash
+    {
+       content_markdown: work.content,
+       content_html: MarkdownToHTML.convert(work.content),
+       content_updated_at: work.updated_at
+    }
+  end
+
+  def timestamps_hash
+    {
+      created_at: work.created_at,
+      published_at: work.published_at
+    }
+  end
+
+  def image_list_hash
+    { images: work.images.map { |img| image_as_json(img) } }
+  end
+
+  def image_as_json(image
+    ImageSerializer
+      .new(image)
+      .set_level_include_model(include_model)
+      .as_json
+  end
+end
+```
+
+```ruby
+app/serializers/image_serializer.rb
+
+class ImageSerializer
+  attr_accessor :include_model
+  attr_reader :image
+
+  def initialize(image)
+    @image = image
+  end
+
+  def set_level_include_model(inc_model)
+    self.include_model = inc_model.for(:image)
+    self
+  end
+
+  def as_json
+    hash = { id: image.id }
+    hash.merge!(url_hash) if include_model.inclusive_of?(:url)
+    hash
+  end
+
+  private
+
+  def url_hash
+    url = if image.picture.attached?
+      h.url_for(image.picture)
+    end
+
+    if url
+      { url: url }
+    else
+      { __url_developer_note: "image is not attached" } #this helps your fellow FE develper to debug why the image is not displaying. Feel free to put this develepoper notes trough out your application in variaus situations. Makes debugging process more friendly.
+    end
+  end
+
+  def url_helper
+    Rails.application.routes.url_helpers
+  end
+end
+```
+
+
+
+
+This way when you query `/students/123?include=student.name,student.dob` you get:
+
+
+```json
+{
+  "id": 123,
+  "first_name": "Tomas",
+  "last_name": "Valent",
+  "date_of_birth": "..some value..",
+}
+```
+
+When you query `/students/123?include=student.dob` you get:
+
+
+```json
+{
+  "id": 123,
+  "date_of_birth": "..some value..",
+}
+```
+
+When you query `/students/123?include=student.name,student.work_list`
+
+
+```json
+{
+  "id": 123,
+  "first_name": "Tomas",
+  "last_name": "Valent",
+  "work_list": [
+    { "id": 111 },
+    { "id": 222 },
+  ]
+}
+```
+
+
+When you query `/students/123?include=student.name,student.work_list,student.work.title`
+
+
+
+```json
+{
+  "id": 123,
+  "first_name": "Tomas",
+  "last_name": "Valent",
+  "work_list": [
+    {
+       "id": 111,
+       "title": "Why is Parkway Drive one of the best bands"
+    },
+    {
+      "id": 222,
+      "title": "Influence of the band Atrey on Metalcore culture"
+    }
+  ]
+}
+```
+
+When you query `/students/123?include=student.name,student.work_list,student.work.title,student.work.image_list,student.work.image.url`
+
+```json
+{
+  "id": 123,
+  "first_name": "Tomas",
+  "last_name": "Valent",
+  "work_list": [
+    {
+       "id": 111,
+       "title": "Why is Parkway Drive one of the best bands",
+       "image_list": [
+         {
+           "id": "111111",
+           "url" "https://url-to-image.com/...."
+         }
+       ]
+    },
+    {
+      "id": 222,
+      "title": "Influence of the band Atrey on Metalcore culture",
+       "image_list": [
+         {
+           "id": "111111",
+           "__url_developer_note": "image is not attached"
+         }
+       ]
+    }
+  ]
+}
+```

data/lib/pragmatic_ql.rb

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

data/lib/pragmatic_ql/config.rb

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

data/lib/pragmatic_ql/include_model.rb

@@ -0,0 +1,40 @@
+module PragmaticQL
+  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/pragmatic_ql/pagination.rb

@@ -0,0 +1,31 @@
+module PragmaticQL
+  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 < PragmaticQL.config.pagination_max_limit
+        lim
+      else
+        PragmaticQL.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/pragmatic_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 PragmaticQL
+  # 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/pragmatic_ql/version.rb

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

data/pragmatic_ql.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pragmatic_ql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pragmatic_ql"
+  spec.version       = PragmaticQL::VERSION
+  spec.authors       = ["Tomas Valent", "Charlie Tarr", "Rene Ivanov", "Anas Alaoui", "Alexander Sidorenko" ]
+  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 and query string includes}
+  spec.homepage      = "https://github.com/Pobble/pragmatic_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,124 @@
+--- !ruby/object:Gem::Specification
+name: pragmatic_ql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+- Charlie Tarr
+- Rene Ivanov
+- Anas Alaoui
+- Alexander Sidorenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-12 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 and query string includes
+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
+- docs/01_stupid_simple_implementation.md
+- docs/02_serializer_example.md
+- lib/pragmatic_ql.rb
+- lib/pragmatic_ql/config.rb
+- lib/pragmatic_ql/include_model.rb
+- lib/pragmatic_ql/pagination.rb
+- lib/pragmatic_ql/params_parser.rb
+- lib/pragmatic_ql/version.rb
+- pragmatic_ql.gemspec
+homepage: https://github.com/Pobble/pragmatic_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: []