fetcha 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e8c9c65052bf4b3c082ad8a2e43ed4f0fa8cac6
+  data.tar.gz: 3d389201efbcc9c6e791742121a76eb2673b2f7c
+SHA512:
+  metadata.gz: 7f131e308da5f23d5804987c7c3ca8cd42c7c470e651ee2523c65ee0c4510b02175dba5ed5a990c318adcca080976ff5d35c5f4fcdffe38a9549c94d2fe7df9e
+  data.tar.gz: 8defd0ec82fec37fa4b1b6c02241cba77c7458eca7393fdb11c0535a20b99fe2b63023cf7490a7971f329ea017c946683082ada55a6e7ab1a0fa3f0479d83c42

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,41 @@
+# Fetcha
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fetcha`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fetcha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fetcha
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/fetcha. 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](http://opensource.org/licenses/MIT).
+

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 "fetcha"
+
+# 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

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/fetcha.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fetcha/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fetcha"
+  spec.version       = Fetcha::VERSION
+  spec.authors       = ["Vincenzo Ferrara"]
+  spec.email         = ["vinceferro92@gmail.com"]
+
+  spec.summary       = %q{Enable api to respond to jsonapi query string}
+  spec.homepage      = "https://github.com/vinceferro/fetcha"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("activesupport", ">= 3.0.0")
+  
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/fetcha.rb

@@ -0,0 +1,159 @@
+require "fetcha/version"
+require "active_support/concern"
+
+module Fetcha
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    def fetch(params = {})
+      results = self.all
+      query_scope = params['scope']
+      filters = params['filter']
+      sorting = params['sort']
+      pages = params['page']
+      results = process_scope(results, query_scope) if query_scope
+      results = process_filtering(results, filters) if filters
+      results = process_sorting(results, sorting) if sorting
+      results = process_pagination!(results, pages) if pages
+      results
+    end
+
+    private
+
+    def fetchable_opts
+      @fetchable_opts ||=
+        {
+          filtering: {},
+          sorting: {},
+          scopes: Set.new(),
+          pagination: {
+            default_size: 10,
+            max_size: 50
+          }
+        }
+    end
+
+    def filterable_on(*fields)
+      fields.each do |field|
+        fetchable_opts[:filtering][field.to_s] = nil
+      end
+    end
+
+    def sortable_on(*fields)
+      fetchable_opts[:sorting] = Set.new(fields)
+    end
+
+    def scopable_with(*fields)
+      fetchable_opts[:scopes] = Set.new(fields)
+    end
+
+    def paginatable(args = {})
+      fetchable_opts[:pagination].keys.each do |k|
+        next unless args.keys.include? k
+        fetchable_opts[:pagination][k] = args[k]
+      end
+    end
+
+    def process_scope(datasource, query_scope)
+      datasource.send(query_scope) if (fetchable_opts[:scopes].include? query_scope.to_sym)
+    end
+
+    def process_filtering(datasource, filters = {})
+      filter_opts = fetchable_opts[:filtering]
+      includes = Set.new()
+      
+      real_filters = filters.select do |k| 
+        next unless filter_opts.keys.include? k
+        values = k.split('.')
+        includes << values.first if values.second.present?
+        true
+      end
+      results = includes.empty? ? datasource : datasource.includes(includes.to_a)
+
+      real_filters.each do |key, value|
+        results = process_operation(results, key, value)
+      end
+      results
+    end
+
+    def process_sorting(datasource, sorting)
+      sort_params = SortParams.sorted_fields(sorting, fetchable_opts[:sorting])
+      datasource = datasource.order(sort_params) if sort_params
+      datasource
+    end
+
+    def process_operation(datasource, field, value)
+      results = datasource
+      if value.is_a? Hash
+        value.each do |operation, value|
+          results = send("#{operation}_filter", results, field, value)
+        end
+      else
+        results = results.where({field => value})
+      end
+      results
+    end
+
+    def process_pagination!(datasource, page = {})
+      page_opts = fetchable_opts[:pagination]
+      max_size = page_opts[:max_size]
+      size = (page['size'] || page_opts[:default_size]).to_i
+      number = (page['number'] || '1').to_i - 1
+      raise ForbiddenError if size > max_size || size < 1 || number < 0
+      offset = number * size
+      datasource = datasource.offset(offset).limit(size)
+    end
+
+    def presence_filter(datasource, field, value)
+      if value
+        datasource.where.not(field => nil)
+      else
+        datasource.where(field => nil)
+      end
+    end
+
+    def contains_filter(datasource, field, value)
+      datasource.where("#{field} ilike ?", "%#{value}%")
+    end
+
+
+    def starts_with_filter(datasource, field, value)
+      datasource.where("#{field} ilike ?", "#{value}%")
+    end
+
+    def ends_with_filter(datasource, field, value)
+      datasource.where("#{field} ilike ?", "%#{value}")
+    end
+
+    def method_missing(name, *args, block)
+      raise ForbiddenError if name.match /.*_filter$/
+      super
+    end
+  end
+
+  module SortParams
+    def self.sorted_fields(sort, allowed_set)
+      fields = sort.to_s.split(',')
+
+      ordered_fields = convert_to_ordered_hash(fields)
+      filtered_fields = ordered_fields.select { |k| allowed_set.include? k }
+
+      filtered_fields.present? ? filtered_fields : nil
+    end
+
+    def self.convert_to_ordered_hash(fields)
+      fields.each_with_object({}) do |field, hash|
+        if field.start_with?('-')
+          field = field[1..-1]
+          hash[field] = :desc
+        else
+          hash[field] = :asc
+        end
+      end
+    end
+  end
+
+
+  class ForbiddenError < StandardError; end
+end

data/lib/fetcha/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fetcha
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vincenzo Ferrara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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:
+- vinceferro92@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
+- fetcha.gemspec
+- lib/fetcha.rb
+- lib/fetcha/version.rb
+homepage: https://github.com/vinceferro/fetcha
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Enable api to respond to jsonapi query string
+test_files: []