rack-adequate-json 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c972e073214d7cae4033a81d25e83628c67164c
+  data.tar.gz: c619d6b43799da62ce89ce25f5974ec3782c98a6
+SHA512:
+  metadata.gz: c91f1b16f176020919606b7358fb61981ddc6e95cfabe15532b0289619d7ed5fa6834324ce8af8a601cf45126d1d7e263a40bfba8b9a6d6f942fc1a5f8fcdf33
+  data.tar.gz: 30f17ba7860274793f22f35035d51d4dbce9c8d71ab4e4b11aba1a73e43052889d429b5ee892677d41b9f38c6a8dc0d2a4e1cfad568b4c0cd23e4ded07717672

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ashod Ayanyan
+
+MIT License
+
+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,58 @@
+# Rack Adequate Json
+
+Filters JSON response given attribute names to reduce payload size
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-adequate-json'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-adequate-json
+
+## Configure
+
+### Rails
+
+``` ruby  
+#config/application.rb
+module AppName
+  class Application < Rails::Application
+    # Middleware options
+    # root: the root key for the json payload     , default: nil
+    # target_param: query param of filter fields  , default: 'fields'
+    config.middleware.use 'Rack::AdequateJson' , { root: 'data' }
+  end
+end
+```
+
+### Sinatra
+
+``` ruby
+require 'rack/adequate_json'
+
+class AppName < Sinatra::Base
+  configure do
+    # Middleware options
+    # root: the root key for the json payload     , default: nil
+    # target_param: query param of filter fields  , default: 'fields'
+    use Rack::AdequateJson , { root: 'data' , target_param: 'select' }
+  end
+end
+
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rack-adequate-json/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack/adequate_json.rb

@@ -0,0 +1,2 @@
+require_relative './adequate_json/version'
+require_relative './adequate_json/adequate_json.rb'

data/lib/rack/adequate_json/adequate_json.rb

@@ -0,0 +1,75 @@
+module Rack
+  class AdequateJson
+    attr_reader :app, :root, :target_param, :status, :headers
+
+    def initialize(app , options={})
+      @app = app
+      @root = options.fetch(:root, nil)
+      @target_param = options.fetch(:target_param, "fields")
+    end
+
+    def call(env)
+      call_and_setup(env)
+      if content_type_json? && filter_fields
+        [ status, headers, response_stream { |b| filter_json_body(b) } ]
+      else
+        [status, headers, response_stream]
+      end
+    end
+
+    protected
+
+    def call_and_setup(env)
+      @status, @headers, @response = app.call(env)
+      @request = request(env)
+      @filter_fields = nil
+    end
+
+    def filter_json_body(body)
+      json_body = JSON.parse(body)
+      data = root ? json_body[root] : json_body
+
+      if data.is_a?(Hash)
+        slice_data!(data, filter_fields)
+      elsif data.is_a?(Array)
+        data.each{ |data| slice_data!(data, filter_fields) }
+      end
+
+      json_body.to_json
+    end
+
+    def filter_fields
+      if params[target_param] && !params[target_param].strip.empty?
+        @filter_fields ||= params[target_param].split(',').map(&:strip)
+      else
+        nil
+      end
+    end
+
+    def response_stream(&block)
+      body = []
+      @response.each do |body_part|
+        body << ( block ? block.call(body_part) : body_part)
+      end
+      body
+    end
+
+    def slice_data!(data, fields)
+      data.select!{|k,v| fields.include?(k) } if fields
+    end
+
+    def request(env)
+      Rack::Request.new(env)
+    end
+
+    def params
+      @request.params
+    end
+
+    def content_type_json?
+      @headers["Content-Type"].include?("json")
+    end
+
+
+  end
+end

data/lib/rack/adequate_json/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class AdequateJson
+    VERSION = "0.1.2"
+  end
+end

data/rack-adequate-json.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/adequate_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-adequate-json"
+  spec.version       = Rack::AdequateJson::VERSION
+  spec.authors       = ["Ashod Ayanyan"]
+  spec.email         = ["aayanyan@gmail.com"]
+  spec.summary       = %q{Rack Middleware to reduce size of json payload}
+  spec.description   = %q{Rack Middleware to reduce size of json payload - Allows clients consuming json apis to select attributes within payload}
+  spec.homepage      = "https://github.com/ashoda/rack-adequate-json"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake" , "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

data/spec/adequate_json_spec.rb

@@ -0,0 +1,55 @@
+require 'json'
+require 'rack/test'
+
+describe 'Rack::AdequateJson' do
+  include Rack::Test::Methods
+  let(:app) { ->(env) { [200,{"Content-Type" => "application/json" }, [original_json] ] } }
+  let(:stack) { Rack::AdequateJson.new(app, root: root_key ) }
+  let(:request) { Rack::MockRequest.new(stack) }
+
+  RSpec.shared_examples "json field filtering middleware" do
+    context "with filter fields provide" do
+      it { expect(response.body).to eq(filtered_json) }
+    end
+
+    context "with no filter fields provide" do
+      let(:query_params) { nil }
+      it { expect(response.body).to eq(original_json) }
+    end
+  end
+
+  describe "request passing through middleware" do
+    let(:url) { '/' }
+    let(:query_params) { '?fields=a,b' }
+    let(:response) { request.get("#{url}#{query_params}") }
+
+    context "given root element" do
+      let(:root_key) { "data" }
+      context "collection" do
+        let(:original_json) { {data:[{a:1, b:'test1', c:'rest2'},{a:2, b:'test2', c:'rest2'}]}.to_json }
+        let(:filtered_json) { {data:[{a:1, b:'test1'},{a:2, b:'test2'}]}.to_json }
+        it_behaves_like "json field filtering middleware"
+      end
+      context "object" do
+        let(:original_json) { {data:{a:1, b:'test1', c:'rest2'}}.to_json }
+        let(:filtered_json) { {data:{a:1, b:'test1'}}.to_json }
+        it_behaves_like "json field filtering middleware"
+      end
+    end
+
+    context "given no root element" do
+      let(:root_key) { nil }
+      context "given collection" do
+        let(:original_json) { [{a:1, b:'test1', c:'rest2'},{a:2, b:'test2', c:'rest2'}].to_json }
+        let(:filtered_json) { [{a:1, b:'test1'},{a:2, b:'test2'}].to_json }
+        it_behaves_like "json field filtering middleware"
+      end
+      context "given object" do
+        let(:original_json) { {a:1, b:'test1', c:'rest2'}.to_json }
+        let(:filtered_json) { {a:1, b:'test1'}.to_json }
+        it_behaves_like "json field filtering middleware"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+Bundler.require(:default, :development)
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+
+require 'rack/adequate_json'
+
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: rack-adequate-json
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ashod Ayanyan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Rack Middleware to reduce size of json payload - Allows clients consuming
+  json apis to select attributes within payload
+email:
+- aayanyan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/adequate_json.rb
+- lib/rack/adequate_json/adequate_json.rb
+- lib/rack/adequate_json/version.rb
+- rack-adequate-json.gemspec
+- spec/adequate_json_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ashoda/rack-adequate-json
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Rack Middleware to reduce size of json payload
+test_files:
+- spec/adequate_json_spec.rb
+- spec/spec_helper.rb
+has_rdoc: