json_api_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee5c767e4160048ed62bcbc7b9f8285142c7042f
+  data.tar.gz: c85ffe5e93fa30146724cd367420d1cf2c7641e1
+SHA512:
+  metadata.gz: e3145a51ab89a918439563acade05081f2bf8e7056653e53881d7fdba8bff2f4315a184b98430400fca1ebe00e86f8e2b51877487a70b18a61196ac7886b15d8
+  data.tar.gz: cb95f80bc149217ee25ecf5266f96034d07a7e511e5bcb89936cdfb454640a760d31750ee18732682578027c5bbcb882588abb3ca65fdbac7c3ac6355a21e1d9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jacob Burenstam Linder
+
+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,111 @@
+# JsonApiHelpers
+
+A set of helpers for generating JSON API compliant responses with together with the active_model_serializers gem.
+
+:warning: The API for this is still pretty rough.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json_api_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json_api_helpers
+
+## Usage
+
+:warning: You must configure `deserializer_klass` and `params_klass`, if you want to use the `Dersializer`.
+
+```ruby
+require 'json_api_helpers'
+
+include JsonApiHelpers::Alias
+
+JsonApiHelpers.configure do |config|
+  config.deserializer_klass = ActiveModelSerializers::Deserialization
+  config.params_klass = ActionController::Parameters
+  # optional (unaltered is the default)
+  config.key_transform = :dash # camel, camel_lower, underscore, unaltered
+end
+
+# Error
+errors = JsonApiHelpers::Serializers::Errors.new
+errors.add(status: 422, detail: 'too short', attribute: :first_name).to_h
+errors.to_h
+# => {
+#   errors: [{
+#     :status => 422,
+#     :detail => 'too short',
+#     :source => {
+#       :pointer => "/data/attributes/first-name"
+#     }
+#   }]
+# }
+
+# In ApplicationController you can define
+class ApplicationController < ActionController::Base
+  # Define these constants in your controllers that you'd like to have
+  # different/custom behavior
+  DEFAULT_SORTING = { created_at: :desc }.freeze
+  SORTABLE_FIELDS = [].freeze
+
+  ALLOWED_INCLUDES = [].freeze
+
+  TRANSFORMABLE_FILTERS = { created_at: :date_range }.freeze
+  ALLOWED_FILTERS = %i(created_at).freeze
+
+  def jsonapi_params
+    @_deserialized_params ||= JsonApiHelpers::Serializers::Deserializer.parse(params)
+  end
+
+  def include_params
+    @_include_params ||= JsonApiHelpers::Params::Includes.new(params[:include])
+  end
+
+  def fields_params
+    @_fields_params ||= JsonApiHelpers::Params::Fields.new(params[:fields])
+  end
+
+  def sort_params
+    sortable_fields = self.class::SORTABLE_FIELDS
+    default_sorting = self.class::DEFAULT_SORTING
+    @_sort_params = JsonApiHelpers::Params::Sort.build(params[:sort], sortable_fields, default_sorting)
+  end
+
+  def filter_params
+    filterable_fields = self.class::ALLOWED_FILTERS
+    transformable = self.class::TRANSFORMABLE_FILTERS
+    @_filter_params = JsonApiHelpers::Params::Filter.build(params[:filter], filterable_fields, transformable)
+  end
+
+  # ...
+end
+```
+
+## Development
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Future
+
+* Testing the `Serializer` class is currently not "possible" and the code in there is hard to follow and not very well extracted, this should be fixed :)
+* Better dependency injection
+* Test `JsonApiHelpers::Serializer` (currently those tests areas in the parent repos tests
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/buren/json_api_helpers/issues.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'json_api_helpers'
+
+# 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/lib/json_api_helpers/action_dispatch_request_wrapper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module JsonApiHelpers
+  # NOTE:
+  #   For some weird reason, ActiveModelSerializers call #original_url on
+  #   ActionDispatch::Request, which isn't defined. In order to avoid monkey matching,
+  #   this wrapper object delegates all methods to the request object and only adds one
+  #   method #request_url
+  class ActionDispatchRequestWrapper < Delegator
+    attr_reader :action_dispatch_request
+
+    def initialize(request)
+      super
+      @action_dispatch_request = request
+    end
+
+    def __getobj__
+      @action_dispatch_request
+    end
+
+    def __setobj__(request)
+      @action_dispatch_request = request
+    end
+
+    def request_url
+      "#{@action_dispatch_request.base_url}#{@action_dispatch_request.path}"
+    end
+  end
+end

data/lib/json_api_helpers/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module JsonApiHelpers
+  MAJOR = '0'
+  MINOR = '1'
+  PATCH = '0'
+  VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: json_api_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Burenstam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  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'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: A set of helpers for generating JSON API compliant responses with together
+  with the active_model_serializers gem.
+email:
+- burenstam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.MD
+- bin/console
+- bin/setup
+- lib/json_api_helpers/action_dispatch_request_wrapper.rb
+- lib/json_api_helpers/version.rb
+homepage: https://github.com/buren/json_api_helpers
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A set of helpers for generating JSON API compliant responses.
+test_files: []