grape-sideload 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: b2c7145ff4dea294d4b1c8af54dd42d16de36f9b
4
+ data.tar.gz: 969f17f268d60365b02a6a26e5b7db3d1c9d03d0
5
+ SHA512:
6
+ metadata.gz: 8ae0d43d71014520bd632a22de4d774e16e87535a917e621ae2830e3e4e6f5b5a4aee785232ca645a03f6f223e3201f5c3265d0e3a14eff36acfcbde8c4ab6fb
7
+ data.tar.gz: 53a60a99641efd86f970412624b8ca08c8033f6575e6d42b44bf3081a7a08a94fad6acaf1ef0a52cb0acf74ea62b7a7b2a320520c1b6a6c90d3ccbc5e3ad1ff7
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.13.6
@@ -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 stokp1@gmail.com. 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
+ # Specify your gem's dependencies in grape-sideload.gemspec
4
+ gemspec
5
+
6
+ gem 'grape'
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Daniel Climent
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,49 @@
1
+ # Grape::Sideload
2
+
3
+ Add sideloading support to your Grape API so you can deliver multiple resources udner one endpoint.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'grape-sideload'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ ## Usage
18
+
19
+ example for sideloading with `present many`:
20
+
21
+ ```ruby
22
+ resources :nature do
23
+ get do
24
+ present_many { present: Animal.all, with: Animal::Entity },
25
+ { present: Fruit.all, with: Fruit::Entity}
26
+ end
27
+ end
28
+ ```
29
+
30
+ example for sideloading with `merge_payloads` to sideload using grape's present syntax:
31
+
32
+ ```ruby
33
+ resource :nature do
34
+ get do
35
+ merge_payloads present(Animal.all, with: Animal::Entity),
36
+ present(Fruit.all, with: Fruit::Entity)
37
+
38
+ end
39
+ end
40
+ ```
41
+
42
+ ## Contributing
43
+
44
+ Bug reports and pull requests are welcome on GitHub at https://github.com/4xposed/grape-sideload. 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.
45
+
46
+ ## License
47
+
48
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
49
+
data/Rakefile ADDED
@@ -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,27 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'grape/sideload/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "grape-sideload"
8
+ spec.version = Grape::Sideload::VERSION
9
+ spec.authors = ["Daniel Climent"]
10
+ spec.email = ["stokp1@gmail.com"]
11
+
12
+ spec.summary = %q{Sideload resources on your JSON response in your Grape API}
13
+ spec.description = %q{Sideload resources on your JSON response in your Grape API}
14
+ spec.homepage = "https://github.com/4xposed/grape-sideload"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0")
18
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
19
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency 'grape', '>= 0.14.0'
23
+
24
+ spec.add_development_dependency "bundler", "~> 1.13"
25
+ spec.add_development_dependency "rake", "~> 10.0"
26
+ spec.add_development_dependency "rspec", "~> 3.0"
27
+ end
@@ -0,0 +1 @@
1
+ require 'grape/sideload'
@@ -0,0 +1,18 @@
1
+ require 'grape'
2
+ require "grape/sideload/version"
3
+ require "grape/sideload/merge_payloads"
4
+ require "grape/sideload/present_many"
5
+
6
+ module Grape
7
+ module Sideload
8
+ def merge_payloads(*args)
9
+ MergePayloads.(*args)
10
+ end
11
+
12
+ def present_many(*args)
13
+ PresentMany.(*args, method(:present).to_proc)
14
+ end
15
+ end
16
+ end
17
+
18
+ Grape::Endpoint.send :include, Grape::Sideload
@@ -0,0 +1,24 @@
1
+ module Grape
2
+ module Sideload
3
+ class MergePayloads
4
+ def initialize(input)
5
+ @input = input
6
+ end
7
+
8
+ def self.call(*input)
9
+ new(input).merge_payloads
10
+ end
11
+
12
+ def merge_payloads
13
+ merged_payloads
14
+ end
15
+
16
+ private
17
+ attr_reader :input
18
+
19
+ def merged_payloads
20
+ input.reduce({}, :merge)
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,36 @@
1
+ require_relative 'merge_payloads'
2
+ module Grape
3
+ module Sideload
4
+ class PresentMany
5
+ def initialize(input, block)
6
+ @input = input
7
+ @block = block
8
+ end
9
+
10
+ def self.call(*input, block)
11
+ new(input, block).merge_presenters
12
+ end
13
+
14
+ def merge_presenters
15
+ merged_payload
16
+ end
17
+
18
+ private
19
+ attr_reader :input, :block
20
+
21
+ def merged_payload
22
+ MergePayloads.(*presented)
23
+ end
24
+
25
+ def presented
26
+ # call #present on Grape::API to format the resoruces using the entity passed by the user
27
+ input.map do |payload|
28
+ block.(
29
+ payload[:present],
30
+ with: payload[:with]
31
+ )
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,5 @@
1
+ module Grape
2
+ module Sideload
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,61 @@
1
+ require "spec_helper"
2
+
3
+ class Dummy
4
+ include Grape::Sideload
5
+
6
+ def self.present(*args)
7
+ present(*args)
8
+ end
9
+
10
+ def present(content, with:)
11
+ hash = {}
12
+ hash[with.to_sym] = content
13
+ hash[:api_version] = '1'
14
+ hash
15
+ end
16
+ end
17
+
18
+ describe Grape::Sideload do
19
+ let(:dummy_class) { Dummy }
20
+ let(:route) { dummy_class.new }
21
+
22
+ it "has a version number" do
23
+ expect(Grape::Sideload::VERSION).not_to be nil
24
+ end
25
+
26
+ describe "#merge_payloads" do
27
+ let(:presented1) { { fruits: [], api_version: '1' } }
28
+ let(:presented2) { { animals: [], api_version: '1' } }
29
+
30
+
31
+ let(:expected_result) { { fruits: [], animals: [], api_version: '1' } }
32
+
33
+ it "merges hashes built by Grape::Endpoint#present" do
34
+ response = route.merge_payloads presented1, presented2
35
+
36
+ expect(response).to eq(expected_result)
37
+ end
38
+ end
39
+
40
+ describe "#present_many" do
41
+ it "presents the resources witht he entities especified and merges them" do
42
+ response = route.present_many(
43
+ {
44
+ present: [],
45
+ with: 'fruits'
46
+ },
47
+ {
48
+ present: [],
49
+ with: 'animals'
50
+ }
51
+ )
52
+
53
+ expect(response).to eq({
54
+ animals: [],
55
+ fruits: [],
56
+ api_version: '1'
57
+ })
58
+ end
59
+ end
60
+
61
+ end
@@ -0,0 +1,2 @@
1
+ $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
2
+ require "grape/sideload"
metadata ADDED
@@ -0,0 +1,118 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: grape-sideload
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Daniel Climent
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-12-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: grape
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 0.14.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 0.14.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.13'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.13'
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: Sideload resources on your JSON response in your Grape API
70
+ email:
71
+ - stokp1@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
+ - grape-sideload.gemspec
85
+ - lib/grape-sideload.rb
86
+ - lib/grape/sideload.rb
87
+ - lib/grape/sideload/merge_payloads.rb
88
+ - lib/grape/sideload/present_many.rb
89
+ - lib/grape/sideload/version.rb
90
+ - spec/integration/sideload_spec.rb
91
+ - spec/spec_helper.rb
92
+ homepage: https://github.com/4xposed/grape-sideload
93
+ licenses:
94
+ - MIT
95
+ metadata: {}
96
+ post_install_message:
97
+ rdoc_options: []
98
+ require_paths:
99
+ - lib
100
+ required_ruby_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ required_rubygems_version: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ requirements: []
111
+ rubyforge_project:
112
+ rubygems_version: 2.5.1
113
+ signing_key:
114
+ specification_version: 4
115
+ summary: Sideload resources on your JSON response in your Grape API
116
+ test_files:
117
+ - spec/integration/sideload_spec.rb
118
+ - spec/spec_helper.rb