api_batch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9c5e1c60e142c0b7b4d40caa8d65d21552e4105
+  data.tar.gz: 2ed58d3fcac5da34a347efb8032b852c206c8f7d
+SHA512:
+  metadata.gz: 683e92c5cb3b7cfc38644dd0f3b1cc182b822815809370504a3289b09e0ed4e608dcab355738242c96c35abb0ab5e705b2491205ec25d544e76d06504b56dfb6
+  data.tar.gz: c5b63e5e814775240f4e6f81e7268fdfb57164fc1b31e42b02c472fb74a9a65bdb1b24232a7a0f3ddf515469d8e5813fcb454b06ab03e5eb6ae7bacc237d12f4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

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 vaughan.britton@sage.com. 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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_batch.gemspec
+gemspec
+
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 vaughanbrittonsage
+
+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,61 @@
+# ApiBatch
+
+Welcome to ApiBatch!
+
+ApiBatch adds a BatchController to your api that allows multiple api requests to be sent to your api within a single http request saving round trips to the server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_batch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_batch
+
+## Usage
+
+Once the gem has been installed a controller will have been added to the following route:
+
+    /batch
+
+batch requests are sent to the server through a query string parameter array:
+
+paths[]=........
+
+Example:
+
+    http://[host]/batch?paths[]=/countries/id/1&paths[]=/countrygroups/id/2
+
+The above batch request would send 2 requests to the server for processing:
+
+- /countries/id/1
+- /countrygroups/id/2
+
+These 2 request will be passed to the appropriate controllers and processed on the server as if they had bee sent as individual requests. The response from the batch request will return an array of the responses from each request specified in the paths[] array parameter in the order they were specified in the request.
+
+> Example:
+> [{response to /countries/id/1}, {response to /countrygroups/id/2}]
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/api_batch. 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/api_batch.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_batch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_batch"
+  spec.version       = ApiBatch::VERSION
+  spec.authors       = ["vaughanbrittonsage"]
+  spec.email         = ["vaughan.britton@sage.com"]
+
+  spec.summary       = "API Batch adds batch call functionality to rails api's allowing a single batch http request to perform multiple api requests in one visit to the server."
+  spec.description   = "API Batch adds batch call functionality to rails api's allowing a single batch http request to perform multiple api requests in one visit to the server."
+  spec.homepage      = "https://github.com/vaughanbrittonsage/api_batch"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/app/controllers/api_batch/batch_controller.rb

@@ -0,0 +1,29 @@
+require 'rails'
+
+module ApiBatch
+  class BatchController < ActionController::Base
+
+    def get
+
+      response = []
+
+      request = params[:paths]
+      request.each do |r|
+
+        request_params = Rails.application.routes.recognize_path(r, :method => :get)
+        controller = "#{request_params[:controller].camelcase}Controller".constantize.new
+        controller.action_name = request_params[:action]
+        controller.request = ActionDispatch::Request.new('rack.input' => [])
+        controller.request.path_parameters = request_params.with_indifferent_access
+        controller.response = ActionDispatch::Response.new
+        controller.send request_params[:action]
+        response.push(controller.response.body)
+
+      end
+
+      render :json => response
+
+    end
+
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_batch"
+
+# 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/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'batch' => 'api_batch/batch#get'
+end

data/lib/api_batch/engine.rb

@@ -0,0 +1,5 @@
+module ApiBatch
+  class Engine < Rails::Engine
+
+  end
+end

data/lib/api_batch/version.rb

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

data/lib/api_batch.rb

@@ -0,0 +1,3 @@
+require "api_batch/version"
+require 'api_batch/engine'
+

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: api_batch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- vaughanbrittonsage
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API Batch adds batch call functionality to rails api's allowing a single
+  batch http request to perform multiple api requests in one visit to the server.
+email:
+- vaughan.britton@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_batch.gemspec
+- app/controllers/api_batch/batch_controller.rb
+- bin/console
+- bin/setup
+- config/routes.rb
+- lib/api_batch.rb
+- lib/api_batch/engine.rb
+- lib/api_batch/version.rb
+homepage: https://github.com/vaughanbrittonsage/api_batch
+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: API Batch adds batch call functionality to rails api's allowing a single
+  batch http request to perform multiple api requests in one visit to the server.
+test_files: []
+has_rdoc: