jsonapi-utils 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 061fed9fa47dbb57c871087a1dc759c62432e08b
+  data.tar.gz: ccd60a2cb0094254c59beb832725a88189b0d826
+SHA512:
+  metadata.gz: e9c65099d501f11f4559c84623dbcf27b36ae357c5563885e559ba584ea7f21ed692d0fb91bf851b1028d103e7977a2654f379635c99f62f51f96f83857cda34
+  data.tar.gz: f6585b1f810f2728525f0d9b7b8b57c87381c8bf45a6d5a413fc4434c81ff565233b53e80aefacb2c971f5e4d0dccbe5a612ed6185d3f3980429300f81abd722

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.sw*
+*.o
+*.a
+*.gem
+.DS_Store
+mkmf.log
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tiago Guedes
+
+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,50 @@
+# JSONAPI::Utils
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi-utils`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+Required doc:
+
+* Describe something about the awesome `jsonapi-resources` gem
+* Describe how it's easy to serialize JSON API-based responses using the `jsonapi-utils` gem
+* JSONAPI::Utils#jsonapi_render (show options like `json`, `resource`, `model`, `scope` and `count`)
+* JSONAPI::Utils#jsonapi_serialize
+* Example of a model
+* Example of a resource
+* Example of a base controller and another whatever controller
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-utils'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-utils
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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]/jsonapi-utils. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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 "jsonapi/utils"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsonapi-utils.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi/utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi-utils"
+  spec.version       = JSONAPI::Utils::VERSION
+  spec.authors       = ["Tiago Guedes", "Douglas André"]
+  spec.email         = ["tiagopog@gmail.com", "douglas@beautydate.com.br"]
+
+  spec.summary       = %q{Full-featured JSON API serialization in a simple way}
+  spec.description   = %q{A Rails-style way to get your API's data serialized, following the standards set by JSON API's specs (http://jsosapi.org)}
+  spec.homepage      = "https://github.com/b2beauty/jsonapi-utils"
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/jsonapi/utils.rb

@@ -0,0 +1,110 @@
+require "jsonapi/utils/version"
+
+module JSONAPI
+  module Utils
+    extend ActiveSupport::Concern
+
+    include do
+      helper_method :jsonapi_serialize
+    end
+
+    def jsonapi_render(options)
+      if options.has_key?(:json)
+        response_body = jsonapi_serialize(options[:json], options[:options] || {})
+        render json: response_body, status: (options[:status] || :ok)
+      end
+    end
+
+    def jsonapi_serialize(records, options = {})
+      fix_request_options(params, records)
+      results = JSONAPI::OperationResults.new
+
+      if records.respond_to?(:to_ary)
+        records = fix_when_hash(records, options) if records.all? { |e| e.is_a?(Hash) }
+        @resources = build_collection(records, options)
+        results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, @resources, result_options(options)))
+      else
+        @resource = turn_into_resource(records, options)
+        results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @resource))
+      end
+      create_response_document(results).contents
+    end
+
+    def jsonapi_error(exception)
+      JSONAPI::ErrorsOperationResult.new(exception.errors[0].code, exception.errors).as_json
+    end
+
+    private
+
+    def fix_request_options(params, records)
+      return if request.method !~ /get/i ||
+                params.nil? ||
+                %w(index show create update destroy).include?(params[:action])
+      action = records.respond_to?(:to_ary) ? 'index' : 'show'
+      @request.send("setup_#{action}_action", params)
+    end
+
+    def result_options(options)
+      hash = {}
+
+      if JSONAPI.configuration.top_level_links_include_pagination
+        hash[:pagination_params] = pagination_params(options)
+      end
+
+      if JSONAPI.configuration.top_level_meta_include_record_count
+        hash[:record_count] = count_records(@resources, options)
+      end
+
+      hash
+    end
+
+    def pagination_params(options)
+      @paginator ||= paginator(params)
+      if @paginator && JSONAPI.configuration.top_level_links_include_pagination
+        options = {}
+        options[:record_count] = count_records(@resources, options) if @paginator.class.requires_record_count
+        return @paginator.links_page_params(options)
+      else
+        return {}
+      end
+    end
+
+
+    def build_collection(records, options = {})
+      return [] unless records.present?
+      paginator(@request.params).apply(records, nil).map do |record|
+        turn_into_resource(record, options)
+      end
+    end
+
+    def turn_into_resource(record, options = {})
+      if options[:resource]
+        options[:resource].new(record)
+      else
+        @request.resource_klass.new(record)
+      end
+    end
+
+    def paginator(params)
+      PagedPaginator.new(ActionController::Parameters.new(params[:page]))
+    end
+
+    def fix_when_hash(records, options)
+      return [] unless options[:model]
+      records.map { |hash| options[:model].new(hash) }
+    rescue
+      ids = records.map { |e| e[:id] || e['id'] }
+      scope = options[:scope] ? options[:model].send(options[:scope]) : options[:model]
+      scope.where(id: ids)
+    end
+
+    def count_records(records, options)
+      if records.size.zero? then 0
+      elsif options[:count] then options[:count]
+      elsif options[:model] && options[:scope] then options[:model].send(options[:scope]).count
+      elsif options[:model] then options[:model].count
+      else records.first.model.class.count
+      end
+    end
+  end
+end

data/lib/jsonapi/utils/version.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  module Utils
+    VERSION = "0.1.3"
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-utils
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Tiago Guedes
+- Douglas André
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails-style way to get your API's data serialized, following the standards
+  set by JSON API's specs (http://jsosapi.org)
+email:
+- tiagopog@gmail.com
+- douglas@beautydate.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi-utils.gemspec
+- lib/jsonapi/utils.rb
+- lib/jsonapi/utils/version.rb
+homepage: https://github.com/b2beauty/jsonapi-utils
+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: Full-featured JSON API serialization in a simple way
+test_files: []