fetcha 0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +41 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/fetcha.gemspec +26 -0
- data/lib/fetcha.rb +159 -0
- data/lib/fetcha/version.rb +3 -0
- metadata +113 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 5e8c9c65052bf4b3c082ad8a2e43ed4f0fa8cac6
|
4
|
+
data.tar.gz: 3d389201efbcc9c6e791742121a76eb2673b2f7c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7f131e308da5f23d5804987c7c3ca8cd42c7c470e651ee2523c65ee0c4510b02175dba5ed5a990c318adcca080976ff5d35c5f4fcdffe38a9549c94d2fe7df9e
|
7
|
+
data.tar.gz: 8defd0ec82fec37fa4b1b6c02241cba77c7458eca7393fdb11c0535a20b99fe2b63023cf7490a7971f329ea017c946683082ada55a6e7ab1a0fa3f0479d83c42
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at TODO: Write your email address. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 TODO: Write your name
|
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.
|
data/README.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
# Fetcha
|
2
|
+
|
3
|
+
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.
|
4
|
+
|
5
|
+
TODO: Delete this and the text above, and describe your gem
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'fetcha'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install fetcha
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
TODO: Write usage instructions here
|
26
|
+
|
27
|
+
## Development
|
28
|
+
|
29
|
+
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.
|
30
|
+
|
31
|
+
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).
|
32
|
+
|
33
|
+
## Contributing
|
34
|
+
|
35
|
+
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.
|
36
|
+
|
37
|
+
|
38
|
+
## License
|
39
|
+
|
40
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
41
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "fetcha"
|
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
|
data/bin/setup
ADDED
data/fetcha.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'fetcha/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "fetcha"
|
8
|
+
spec.version = Fetcha::VERSION
|
9
|
+
spec.authors = ["Vincenzo Ferrara"]
|
10
|
+
spec.email = ["vinceferro92@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Enable api to respond to jsonapi query string}
|
13
|
+
spec.homepage = "https://github.com/vinceferro/fetcha"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
17
|
+
spec.bindir = "exe"
|
18
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency("activesupport", ">= 3.0.0")
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
24
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
25
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
26
|
+
end
|
data/lib/fetcha.rb
ADDED
@@ -0,0 +1,159 @@
|
|
1
|
+
require "fetcha/version"
|
2
|
+
require "active_support/concern"
|
3
|
+
|
4
|
+
module Fetcha
|
5
|
+
extend ActiveSupport::Concern
|
6
|
+
|
7
|
+
module ClassMethods
|
8
|
+
|
9
|
+
def fetch(params = {})
|
10
|
+
results = self.all
|
11
|
+
query_scope = params['scope']
|
12
|
+
filters = params['filter']
|
13
|
+
sorting = params['sort']
|
14
|
+
pages = params['page']
|
15
|
+
results = process_scope(results, query_scope) if query_scope
|
16
|
+
results = process_filtering(results, filters) if filters
|
17
|
+
results = process_sorting(results, sorting) if sorting
|
18
|
+
results = process_pagination!(results, pages) if pages
|
19
|
+
results
|
20
|
+
end
|
21
|
+
|
22
|
+
private
|
23
|
+
|
24
|
+
def fetchable_opts
|
25
|
+
@fetchable_opts ||=
|
26
|
+
{
|
27
|
+
filtering: {},
|
28
|
+
sorting: {},
|
29
|
+
scopes: Set.new(),
|
30
|
+
pagination: {
|
31
|
+
default_size: 10,
|
32
|
+
max_size: 50
|
33
|
+
}
|
34
|
+
}
|
35
|
+
end
|
36
|
+
|
37
|
+
def filterable_on(*fields)
|
38
|
+
fields.each do |field|
|
39
|
+
fetchable_opts[:filtering][field.to_s] = nil
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
def sortable_on(*fields)
|
44
|
+
fetchable_opts[:sorting] = Set.new(fields)
|
45
|
+
end
|
46
|
+
|
47
|
+
def scopable_with(*fields)
|
48
|
+
fetchable_opts[:scopes] = Set.new(fields)
|
49
|
+
end
|
50
|
+
|
51
|
+
def paginatable(args = {})
|
52
|
+
fetchable_opts[:pagination].keys.each do |k|
|
53
|
+
next unless args.keys.include? k
|
54
|
+
fetchable_opts[:pagination][k] = args[k]
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
def process_scope(datasource, query_scope)
|
59
|
+
datasource.send(query_scope) if (fetchable_opts[:scopes].include? query_scope.to_sym)
|
60
|
+
end
|
61
|
+
|
62
|
+
def process_filtering(datasource, filters = {})
|
63
|
+
filter_opts = fetchable_opts[:filtering]
|
64
|
+
includes = Set.new()
|
65
|
+
|
66
|
+
real_filters = filters.select do |k|
|
67
|
+
next unless filter_opts.keys.include? k
|
68
|
+
values = k.split('.')
|
69
|
+
includes << values.first if values.second.present?
|
70
|
+
true
|
71
|
+
end
|
72
|
+
results = includes.empty? ? datasource : datasource.includes(includes.to_a)
|
73
|
+
|
74
|
+
real_filters.each do |key, value|
|
75
|
+
results = process_operation(results, key, value)
|
76
|
+
end
|
77
|
+
results
|
78
|
+
end
|
79
|
+
|
80
|
+
def process_sorting(datasource, sorting)
|
81
|
+
sort_params = SortParams.sorted_fields(sorting, fetchable_opts[:sorting])
|
82
|
+
datasource = datasource.order(sort_params) if sort_params
|
83
|
+
datasource
|
84
|
+
end
|
85
|
+
|
86
|
+
def process_operation(datasource, field, value)
|
87
|
+
results = datasource
|
88
|
+
if value.is_a? Hash
|
89
|
+
value.each do |operation, value|
|
90
|
+
results = send("#{operation}_filter", results, field, value)
|
91
|
+
end
|
92
|
+
else
|
93
|
+
results = results.where({field => value})
|
94
|
+
end
|
95
|
+
results
|
96
|
+
end
|
97
|
+
|
98
|
+
def process_pagination!(datasource, page = {})
|
99
|
+
page_opts = fetchable_opts[:pagination]
|
100
|
+
max_size = page_opts[:max_size]
|
101
|
+
size = (page['size'] || page_opts[:default_size]).to_i
|
102
|
+
number = (page['number'] || '1').to_i - 1
|
103
|
+
raise ForbiddenError if size > max_size || size < 1 || number < 0
|
104
|
+
offset = number * size
|
105
|
+
datasource = datasource.offset(offset).limit(size)
|
106
|
+
end
|
107
|
+
|
108
|
+
def presence_filter(datasource, field, value)
|
109
|
+
if value
|
110
|
+
datasource.where.not(field => nil)
|
111
|
+
else
|
112
|
+
datasource.where(field => nil)
|
113
|
+
end
|
114
|
+
end
|
115
|
+
|
116
|
+
def contains_filter(datasource, field, value)
|
117
|
+
datasource.where("#{field} ilike ?", "%#{value}%")
|
118
|
+
end
|
119
|
+
|
120
|
+
|
121
|
+
def starts_with_filter(datasource, field, value)
|
122
|
+
datasource.where("#{field} ilike ?", "#{value}%")
|
123
|
+
end
|
124
|
+
|
125
|
+
def ends_with_filter(datasource, field, value)
|
126
|
+
datasource.where("#{field} ilike ?", "%#{value}")
|
127
|
+
end
|
128
|
+
|
129
|
+
def method_missing(name, *args, block)
|
130
|
+
raise ForbiddenError if name.match /.*_filter$/
|
131
|
+
super
|
132
|
+
end
|
133
|
+
end
|
134
|
+
|
135
|
+
module SortParams
|
136
|
+
def self.sorted_fields(sort, allowed_set)
|
137
|
+
fields = sort.to_s.split(',')
|
138
|
+
|
139
|
+
ordered_fields = convert_to_ordered_hash(fields)
|
140
|
+
filtered_fields = ordered_fields.select { |k| allowed_set.include? k }
|
141
|
+
|
142
|
+
filtered_fields.present? ? filtered_fields : nil
|
143
|
+
end
|
144
|
+
|
145
|
+
def self.convert_to_ordered_hash(fields)
|
146
|
+
fields.each_with_object({}) do |field, hash|
|
147
|
+
if field.start_with?('-')
|
148
|
+
field = field[1..-1]
|
149
|
+
hash[field] = :desc
|
150
|
+
else
|
151
|
+
hash[field] = :asc
|
152
|
+
end
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
156
|
+
|
157
|
+
|
158
|
+
class ForbiddenError < StandardError; end
|
159
|
+
end
|
metadata
ADDED
@@ -0,0 +1,113 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fetcha
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Vincenzo Ferrara
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-09-05 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: 3.0.0
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 3.0.0
|
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.12'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.12'
|
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:
|
70
|
+
email:
|
71
|
+
- vinceferro92@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- CODE_OF_CONDUCT.md
|
80
|
+
- Gemfile
|
81
|
+
- LICENSE.txt
|
82
|
+
- README.md
|
83
|
+
- Rakefile
|
84
|
+
- bin/console
|
85
|
+
- bin/setup
|
86
|
+
- fetcha.gemspec
|
87
|
+
- lib/fetcha.rb
|
88
|
+
- lib/fetcha/version.rb
|
89
|
+
homepage: https://github.com/vinceferro/fetcha
|
90
|
+
licenses:
|
91
|
+
- MIT
|
92
|
+
metadata: {}
|
93
|
+
post_install_message:
|
94
|
+
rdoc_options: []
|
95
|
+
require_paths:
|
96
|
+
- lib
|
97
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - ">="
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
103
|
+
requirements:
|
104
|
+
- - ">="
|
105
|
+
- !ruby/object:Gem::Version
|
106
|
+
version: '0'
|
107
|
+
requirements: []
|
108
|
+
rubyforge_project:
|
109
|
+
rubygems_version: 2.5.1
|
110
|
+
signing_key:
|
111
|
+
specification_version: 4
|
112
|
+
summary: Enable api to respond to jsonapi query string
|
113
|
+
test_files: []
|