pragmatic_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f989efdf00a8f3a04142577c76d5190a430287dd
+  data.tar.gz: e5eaca6087d796aab8a7edf1356edf151185c953
+SHA512:
+  metadata.gz: 5e3221363a8f0aeea292f117efeae5fbd2c716a9f94cc9f521057565b56f1778dc8f876c55f47327393f4dab73f40cba74584a323a0ec9f90fbc656e449e0080
+  data.tar.gz: 683b346ef7875cd0a0129101523a73f3d5961a86b2e6f834ff4812914a08f79f66186ca40d7f502e4fafa5531e482cb8907f8744a738b66e35105ba1d0dd0518

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset
+.vimrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.3.0
+  - 2.2.4
+  - 2.2.3
+  - 2.2.2
+  - 2.2.1
+  - 2.2.0
+before_install: gem install bundler -v 1.12.2

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 equivalent@eq8.eu. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pragmatic_serializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tomas Valent
+
+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,132 @@
+[![Build Status](https://travis-ci.org/Pobble/pragmatic_serializer.svg?branch=master)](https://travis-ci.org/Pobble/pragmatic_serializer)
+
+# PragmaticSerializer
+
+Pragmatic Serializer for Ruby & Ruby on Rails JSON API.
+
+
+## About
+
+Although we agre that [JSON API standard proposal](http://jsonapi.org/)
+is great, it may be overkill to implement some of it's features (like the way nesting is done) for smaller
+API Endpoints.
+
+Therefore if you feel that implementing
+[Active Model Serializer](https://github.com/rails-api/active_model_serializers) (JSON API Rails gem)
+is not the best choice for your situation/app this gem may be useful for you
+too.
+
+We were heavily inspired by [Stormpath API talk on JSON API](https://www.youtube.com/watch?v=hdSrT4yjS1g)
+and the pragmatic way they solve some common issues.
+
+Also the gem don't extend anything Rails wise (therefore Sinatra can use
+it too), it just provides a generic
+way to build Plain Ruby Object Serializers that you can call `as_json`
+on to produce hash that you can then pass to `render json:
+DocumentSerializer.new(document: Document.last).as_json`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pragmatic_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pragmatic_serializer
+
+## Usage
+
+
+#### Collections
+
+```ruby
+r1 = Band.first
+r2 = Band.last
+
+class BandPolicy
+  attr_reader :current_user
+
+  def initialize(current_user:)
+    @current_user = current_user
+  end
+
+  def can_view_counters?
+    current_user.admin == true
+  end
+end
+
+class MySerializer
+  include PragmaticSerializer::All
+
+  attr_accessor :policy
+
+  def main_json
+    hash = { title: band.title }
+    hash.merge!(view_count: band.view_count) if policy.can_view_counters?
+    hash
+  end
+end
+
+policy = BandPolicy.new(current_user: current_user)
+
+serializer = MySerializer.collection([r1, r2], resource_options: { :"policy=" => policy })
+serializer.as_json
+```
+
+As regular user:
+
+```json
+{
+  "id":"123",
+  "type":"band",
+  "title":"Bring Me The Horizon"
+}
+```
+
+As admin
+
+```json
+{
+  "id":"123",
+  "type":"band",
+  "title":"Bring Me The Horizon",
+  "view_count": 2001
+}
+```
+
+#### Change ID field
+
+by default the ID field is models `#id`. To change it
+
+```
+# config/initializers/pragmatic_serializer.rb
+
+PragmaticSerializer.config.default_id_source = :public_uid  # if you using https://github.com/equivalent/public_uid
+
+# ..or
+PragmaticSerializer.config.default_id_source = :url_slug    # custom field
+```
+
+
+## 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`. 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]/pragmatic_serializer. 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/bin/console

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

@@ -0,0 +1,12 @@
+module PragmaticSerializer
+  module All
+    def self.included(base)
+      base.send(:include, PragmaticSerializer::ConfigInterface)
+      base.send(:include, PragmaticSerializer::Prefixes)
+      base.send(:include, PragmaticSerializer::GeneralInitialization)
+      base.send(:include, PragmaticSerializer::GeneralBaseJSON)
+      base.send(:include, PragmaticSerializer::GeneralResourceJSON)
+      base.send(:include, PragmaticSerializer::CollectionInterface)
+    end
+  end
+end

data/lib/pragmatic_serializer/collection_interface.rb

@@ -0,0 +1,16 @@
+module PragmaticSerializer
+  module CollectionInterface
+    module ClassMethods
+      def collection(resources, resource_options: {})
+        PragmaticSerializer::CollectionSerializer.new
+          .tap { |cs| cs.resource_serializer = self }
+          .tap { |cs| cs.resources = resources }
+          .tap { |cs| cs.resource_options = resource_options }
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+  end
+end

data/lib/pragmatic_serializer/collection_serializer.rb

@@ -0,0 +1,62 @@
+module PragmaticSerializer
+  class CollectionSerializer
+    OverMaximumLimit = Class.new(StandardError)
+
+    extend Forwardable
+    include PragmaticSerializer::ConfigInterface
+
+    attr_writer :limit, :offset, :serialization_method, :resource_options
+    attr_accessor :resources, :resource_serializer, :pagination_evaluator
+
+    def serialization_method
+      @serialization_method ||= config.default_resource_serialization_method
+    end
+
+    def limit
+      @limit ||= config.default_limit
+      raise OverMaximumLimit if @limit > config.max_limit
+      @limit
+    end
+
+    def offset
+      @offset ||= config.default_offset
+    end
+
+    def as_json
+      hash = { collection_prefix => as_unprefixed_json }
+      hash.merge!(pagination_json.as_json) if pagination_evaluator
+      hash
+    end
+
+    def as_unprefixed_json
+      collection_serializers.map { |rs| rs.send(serialization_method) }
+    end
+
+    private
+      def_delegators :resource_serializer, :resource_prefix, :collection_prefix
+
+      def collection_serializers
+        resources.map do |resource|
+          resource_object = resource_serializer.new(resource_prefix => resource)
+
+          resource_options.each do |method_name, value|
+            resource_object.send(method_name, value)
+          end
+
+          resource_object
+        end
+      end
+
+      def pagination_json
+        @pagination_json ||= PragmaticSerializer::PaginationJSON.new({
+          limit: limit,
+          offset: offset,
+          pagination_evaluator: pagination_evaluator
+        })
+      end
+
+      def resource_options
+        @resource_options ||= {}
+      end
+  end
+end

data/lib/pragmatic_serializer/config_interface.rb

@@ -0,0 +1,19 @@
+module PragmaticSerializer
+  module ConfigInterface
+    module ClassMethods
+      def config
+        PragmaticSerializer.config
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    protected
+
+    def config
+      self.class.config
+    end
+  end
+end

data/lib/pragmatic_serializer/configuration.rb

@@ -0,0 +1,25 @@
+module PragmaticSerializer
+  class Configuration
+    attr_writer :default_id_source
+
+    def default_offset
+      0
+    end
+
+    def default_limit
+      50
+    end
+
+    def max_limit
+      200
+    end
+
+    def default_id_source
+      @default_id_source ||= :id
+    end
+
+    def default_resource_serialization_method
+      :as_unprefixed_json
+    end
+  end
+end

data/lib/pragmatic_serializer/general_base_json.rb

@@ -0,0 +1,31 @@
+module PragmaticSerializer
+  module GeneralBaseJSON
+    IDHasNoValue = Class.new(StandardError)
+
+    def base_json
+      {
+        "id": (json_id_value).to_s,
+        "type": json_type_value,
+      }
+        .tap do |hash|
+          hash.merge!(href: json_href_value) if json_href_value
+        end
+    end
+
+    protected
+
+    def json_id_value
+      send(prefix).send(json_id_source) || raise(IDHasNoValue)
+    end
+
+    def json_id_source
+      config.default_id_source
+    end
+
+    def json_type_value
+      prefix.to_s
+    end
+
+    def json_href_value;end
+  end
+end

data/lib/pragmatic_serializer/general_initialization.rb

@@ -0,0 +1,14 @@
+module PragmaticSerializer
+  module GeneralInitialization
+    def self.included(base)
+      base.send(:attr_reader, base.resource_prefix)
+    end
+
+    def initialize(**options)
+      value = options.fetch(prefix) do |x|
+        raise ArgumentError.new("missing keyword: #{x}")
+      end
+      instance_variable_set("@#{prefix}", value)
+    end
+  end
+end

data/lib/pragmatic_serializer/general_resource_json.rb

@@ -0,0 +1,19 @@
+module PragmaticSerializer
+  module GeneralResourceJSON
+    def as_unprefixed_json
+      base_json.merge(main_json)
+    end
+
+    def as_json
+      {
+        prefix.to_sym => as_unprefixed_json
+      }
+    end
+
+    def as_base_json
+      {
+        prefix.to_sym => base_json
+      }
+    end
+  end
+end

data/lib/pragmatic_serializer/pagination_json.rb

@@ -0,0 +1,40 @@
+module PragmaticSerializer
+  class PaginationJSON
+    attr_reader :limit, :offset, :pagination_evaluator
+    attr_accessor :maximum_offset
+
+    def initialize(limit:, offset:, pagination_evaluator:)
+      @limit = limit
+      @offset = offset
+      @pagination_evaluator = pagination_evaluator
+      @maximum_offset = Float::INFINITY
+    end
+
+    def as_json
+      {
+        limit: limit,
+        offset: offset,
+        href: href,
+        first: first,
+        next: self.next,
+        prev: prev,
+      }
+    end
+
+    def first
+      pagination_evaluator.call(limit: limit, offset: 0)
+    end
+
+    def next
+      pagination_evaluator.call(limit: limit, offset: offset+1) unless offset >= maximum_offset
+    end
+
+    def prev
+      pagination_evaluator.call(limit: limit, offset: offset-1) if offset > 0
+    end
+
+    def href
+      pagination_evaluator.call(limit: limit, offset: offset)
+    end
+  end
+end

data/lib/pragmatic_serializer/prefixes.rb

@@ -0,0 +1,21 @@
+module PragmaticSerializer
+  module Prefixes
+    module ClassMethods
+      def collection_prefix
+        name.demodulize.underscore.gsub('_serializer', '').pluralize.to_sym
+      end
+
+      def resource_prefix
+        name.demodulize.underscore.gsub('_serializer', '').singularize.to_sym
+      end
+    end
+
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    def prefix
+      self.class.resource_prefix
+    end
+  end
+end

data/lib/pragmatic_serializer/version.rb

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

data/lib/pragmatic_serializer.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+require 'active_support/core_ext/string/inflections'
+
+require "pragmatic_serializer/version"
+require "pragmatic_serializer/configuration"
+require "pragmatic_serializer/config_interface"
+
+require "pragmatic_serializer/prefixes"
+require "pragmatic_serializer/general_initialization"
+require "pragmatic_serializer/general_base_json"
+require "pragmatic_serializer/general_resource_json"
+
+require "pragmatic_serializer/pagination_json"
+require "pragmatic_serializer/collection_serializer"
+require "pragmatic_serializer/collection_interface"
+
+require "pragmatic_serializer/all"
+
+module PragmaticSerializer
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/pragmatic_serializer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pragmatic_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pragmatic_serializer"
+  spec.version       = PragmaticSerializer::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+
+  spec.summary       = %q{JSON API serializer following Pragmatic JSON standard}
+  spec.description   = %q{JSON API Serializer to produce RESTful serializer using plain Ruby Ojects that follows common sense and heavily inspired by StormpathAPI talks}
+  spec.homepage      = "https://github.com/equivalent/pragmatic_serializer"
+  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_dependency "activerecord", "~> 4.2"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: pragmatic_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: 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: JSON API Serializer to produce RESTful serializer using plain Ruby Ojects
+  that follows common sense and heavily inspired by StormpathAPI talks
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pragmatic_serializer.rb
+- lib/pragmatic_serializer/all.rb
+- lib/pragmatic_serializer/collection_interface.rb
+- lib/pragmatic_serializer/collection_serializer.rb
+- lib/pragmatic_serializer/config_interface.rb
+- lib/pragmatic_serializer/configuration.rb
+- lib/pragmatic_serializer/general_base_json.rb
+- lib/pragmatic_serializer/general_initialization.rb
+- lib/pragmatic_serializer/general_resource_json.rb
+- lib/pragmatic_serializer/pagination_json.rb
+- lib/pragmatic_serializer/prefixes.rb
+- lib/pragmatic_serializer/version.rb
+- pragmatic_serializer.gemspec
+homepage: https://github.com/equivalent/pragmatic_serializer
+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.4.8
+signing_key: 
+specification_version: 4
+summary: JSON API serializer following Pragmatic JSON standard
+test_files: []