grape-sideload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2c7145ff4dea294d4b1c8af54dd42d16de36f9b
+  data.tar.gz: 969f17f268d60365b02a6a26e5b7db3d1c9d03d0
+SHA512:
+  metadata.gz: 8ae0d43d71014520bd632a22de4d774e16e87535a917e621ae2830e3e4e6f5b5a4aee785232ca645a03f6f223e3201f5c3265d0e3a14eff36acfcbde8c4ab6fb
+  data.tar.gz: 53a60a99641efd86f970412624b8ca08c8033f6575e6d42b44bf3081a7a08a94fad6acaf1ef0a52cb0acf74ea62b7a7b2a320520c1b6a6c90d3ccbc5e3ad1ff7

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.1
+before_install: gem install bundler -v 1.13.6

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 stokp1@gmail.com. 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'
+
+# Specify your gem's dependencies in grape-sideload.gemspec
+gemspec
+
+gem 'grape'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Climent
+
+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,49 @@
+# Grape::Sideload
+
+Add sideloading support to your Grape API so you can deliver multiple resources udner one endpoint.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-sideload'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+example for sideloading with `present many`:
+
+```ruby
+resources :nature do
+  get do
+    present_many { present: Animal.all, with: Animal::Entity },
+                 { present: Fruit.all, with: Fruit::Entity}
+  end
+end
+```
+
+example for sideloading with `merge_payloads` to sideload using grape's present syntax:
+
+```ruby
+resource :nature do
+  get do
+    merge_payloads present(Animal.all, with: Animal::Entity),
+                   present(Fruit.all, with: Fruit::Entity)
+
+  end
+end
+```
+
+## Contributing
+
+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.
+
+## 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/grape-sideload.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/sideload/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-sideload"
+  spec.version       = Grape::Sideload::VERSION
+  spec.authors       = ["Daniel Climent"]
+  spec.email         = ["stokp1@gmail.com"]
+
+  spec.summary       = %q{Sideload resources on your JSON response in your Grape API}
+  spec.description   = %q{Sideload resources on your JSON response in your Grape API}
+  spec.homepage      = "https://github.com/4xposed/grape-sideload"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'grape', '>= 0.14.0'
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/grape-sideload.rb

@@ -0,0 +1 @@
+require 'grape/sideload'

data/lib/grape/sideload.rb

@@ -0,0 +1,18 @@
+require 'grape'
+require "grape/sideload/version"
+require "grape/sideload/merge_payloads"
+require "grape/sideload/present_many"
+
+module Grape
+  module Sideload
+    def merge_payloads(*args)
+      MergePayloads.(*args)
+    end
+
+    def present_many(*args)
+      PresentMany.(*args, method(:present).to_proc)
+    end
+  end
+end
+
+Grape::Endpoint.send :include, Grape::Sideload

data/lib/grape/sideload/merge_payloads.rb

@@ -0,0 +1,24 @@
+module Grape
+  module Sideload
+    class MergePayloads
+      def initialize(input)
+        @input = input
+      end
+
+      def self.call(*input)
+        new(input).merge_payloads
+      end
+
+      def merge_payloads
+        merged_payloads
+      end
+
+      private
+      attr_reader :input
+
+      def merged_payloads
+        input.reduce({}, :merge)
+      end
+    end
+  end
+end

data/lib/grape/sideload/present_many.rb

@@ -0,0 +1,36 @@
+require_relative 'merge_payloads'
+module Grape
+  module Sideload
+    class PresentMany
+      def initialize(input, block)
+        @input = input
+        @block = block
+      end
+
+      def self.call(*input, block)
+        new(input, block).merge_presenters
+      end
+
+      def merge_presenters
+        merged_payload
+      end
+
+      private
+      attr_reader :input, :block
+
+      def merged_payload
+        MergePayloads.(*presented)
+      end
+
+      def presented
+        # call #present on Grape::API to format the resoruces using the entity passed by the user
+        input.map do |payload|
+          block.(
+            payload[:present],
+            with: payload[:with]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/grape/sideload/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Sideload
+    VERSION = "0.1.0"
+  end
+end

data/spec/integration/sideload_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+class Dummy
+  include Grape::Sideload
+
+  def self.present(*args)
+    present(*args)
+  end
+
+  def present(content, with:)
+    hash = {}
+    hash[with.to_sym] = content
+    hash[:api_version] = '1'
+    hash
+  end
+end
+
+describe Grape::Sideload do
+  let(:dummy_class) { Dummy }
+  let(:route) { dummy_class.new }
+
+  it "has a version number" do
+    expect(Grape::Sideload::VERSION).not_to be nil
+  end
+
+  describe "#merge_payloads" do
+    let(:presented1) { { fruits: [], api_version: '1' } }
+    let(:presented2) { { animals: [], api_version: '1' } }
+
+
+    let(:expected_result) { { fruits: [], animals: [], api_version: '1' } }
+
+    it "merges hashes built by Grape::Endpoint#present" do
+      response = route.merge_payloads presented1, presented2
+
+      expect(response).to eq(expected_result)
+    end
+  end
+
+  describe "#present_many" do
+    it "presents the resources witht he entities especified and merges them" do
+      response = route.present_many(
+        {
+          present: [],
+          with: 'fruits'
+        },
+        {
+          present: [],
+          with: 'animals'
+        }
+      )
+
+      expect(response).to eq({
+        animals: [],
+        fruits: [],
+        api_version: '1'
+      })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "grape/sideload"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: grape-sideload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Climent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: Sideload resources on your JSON response in your Grape API
+email:
+- stokp1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-sideload.gemspec
+- lib/grape-sideload.rb
+- lib/grape/sideload.rb
+- lib/grape/sideload/merge_payloads.rb
+- lib/grape/sideload/present_many.rb
+- lib/grape/sideload/version.rb
+- spec/integration/sideload_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/4xposed/grape-sideload
+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: Sideload resources on your JSON response in your Grape API
+test_files:
+- spec/integration/sideload_spec.rb
+- spec/spec_helper.rb