jsonapi-params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5a249c1dc7ab63566967bc11cfda5a9cadcf9c3
+  data.tar.gz: 227888eacf0c5c0f538451b031d1344d63b42a5a
+SHA512:
+  metadata.gz: d07526167def4f51cf4f7cfaa8e854028e95891d66a1c41f6a81ba205ac71cf672b3fccc015f930865a70ef0a127e4120fa45b8960358a2cf790559a5ef45d4e
+  data.tar.gz: 772e64b470a3ff2f43da7724ace3898123b3b9033ca9e54447d0907643415d91af1e1a9cf0ae873b086b61e5b4847290774ff7d32d13b69c554ca7907677a827

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,134 @@
+# Jsonapi::Params
+
+This gem handles the parameters of a request that uses the jsonapi specification and provides simple control over input parameters and manipulation of attributes, relationships and other...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-params
+
+## Usage
+
+To use jsonapi-params you should create a class to handle with your parameters. Example:
+
+```ruby
+class AuthorParam
+  include JSONAPI::Param
+
+  params :name
+end
+
+class ArticleParam
+  include JSONAPI::Param
+
+  params :title, :text, :other_text
+
+  belongs_to :author
+end
+
+article = ArticleParam.new(
+  'data' => {
+    'id' => 1,
+    'type' => 'x',
+    'attributes' => {
+      'title' => 'The guy',
+      'text' => 'Loren Ipsun',
+      'other-text' => 'Hello'
+    },
+    'relationships' => {
+      'author' => {
+        'data' => {
+          'id' => 123,
+          'type' => 'authors',
+          'attributes' => {
+            'name' => 'Antonio'
+          }
+        }
+      }
+    }
+  }
+)
+```
+
+### Available methods to handle with params
+
+#### param
+
+Adds a parameter to whitelist attributes
+
+```ruby
+class AuthorParam
+  param :name
+  param :gender
+end
+```
+
+#### params
+
+Adds a list of parameters to whitelist attributes
+
+```ruby
+class AuthorParam
+  params :name, :gender
+end
+```
+
+#### belongs_to
+
+Creates a one-to-one relationship to update or create objects
+
+```ruby
+class AuthorParam
+  param :name
+end
+
+class ArticleParam
+  param :title
+
+  belongs_to :author
+end
+```
+
+#### attributes
+
+Returns a list of attributes based on whitelist.
+
+```ruby
+class ArticleParam
+  param :title
+end
+
+article_params = ArticleParam.new('data' => { 'attributes' => { 'title' => 'The day' }})
+article_params.attributes # { 'title' => 'The day' }
+```
+
+## TODO
+
+* one-to-many relationships
+* many-to-many relationships
+* metadata
+
+## 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]/jsonapi-params.
+
+## License
+
+jsonapi-params is released under the MIT License.

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-params"
+
+# 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/jsonapi-params.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi-params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi-params"
+  spec.version       = JSONAPI::Param::VERSION
+  spec.authors       = ["Noverde Team"]
+  spec.email         = ["dev@noverde.com.br"]
+
+  spec.summary       = %q{Gem to handle with parameters according to jsonapi specification}
+  spec.homepage      = "https://github.com/Noverde/jsonapi-params"
+
+  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 "activesupport", "> 4"
+
+  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-byebug"
+end

data/lib/jsonapi-params/param.rb

@@ -0,0 +1,117 @@
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/string/inflections'
+
+module JSONAPI
+  module Param
+    def self.included(target)
+      target.send(:include, InstanceMethods)
+      target.extend ClassMethods
+    end
+
+    module ClassMethods
+      attr_accessor :whitelist_attributes, :whitelist_relationships
+
+      # Adds the parameters to whitelist of parameters
+      #
+      # @param name [Symbol] The name of parameter
+      # @return [nil]
+      def param(name)
+        add_param(name)
+      end
+
+      # Adds a list of parameters to whitelist of parameters
+      #
+      # @param name [Array<Symbol>] Names of parameters
+      # @return [nil]
+      def params(*names)
+        names.each { |name| add_param(name) }
+      end
+
+      # Adds a relationship one-to-one to whitelist of relationships
+      #
+      # @param name [Array<Symbol>] Names of relationships
+      # @return [nil]
+      def belongs_to(relationship_names)
+        @whitelist_relationships ||= []
+        @whitelist_relationships << relationship_names.to_s.dasherize
+      end
+
+      private
+
+      # Creates the whitelist of attributes
+      #
+      # @param [Symbol]
+      # @return [nil]
+      # @!scope class
+      # @!visibility private
+      def add_param(name)
+        @whitelist_attributes ||= []
+        @whitelist_attributes << name.to_s.dasherize
+      end
+    end
+
+    module InstanceMethods
+      def initialize(params)
+        raise InvalidParam, 'Data is required' if params.nil? || params['data'].nil?
+
+        @data = params['data']
+      end
+
+      # @returns [Integer]
+      # @!attribute [r]
+      def id
+        @data['id']
+      end
+
+      # @returns [String]
+      # @!attribute [r]
+      def type
+        @data['type']
+      end
+
+      # Handles parameters to return sanitized attributes and their relationships
+      #
+      # @return [Hash]
+      def attributes
+        attributes = @data['attributes'] || {}
+        attributes = attributes.slice(*self.class.whitelist_attributes)
+        attributes = attributes.merge(relationships)
+        attributes
+      end
+
+      # Handles parameters to return relationships
+      #
+      # @return [Hash]
+      # @raise [RuntimeError] if the relationship is a one-to-many relationship.
+      def relationships
+        relationships = @data['relationships'] || {}
+        relationships = relationships.slice(*self.class.whitelist_relationships)
+
+        relationships.inject({}) do |relationships, (relationship_key, relationship_object)|
+          data = relationship_object['data']
+
+          if data.is_a?(Array)
+            raise 'One-to-many relationship is not supported'
+          elsif data.is_a?(Hash)
+            params = params_klass(relationship_key).new(relationship_object)
+
+            relationships["#{relationship_key}_id"] = params.id
+          end
+
+          relationships
+        end
+      end
+
+      private
+
+      # Get the key to create a constant of param class.
+      #
+      # @param [String]
+      # @return [Object]
+      # @!visibility private
+      def params_klass(key)
+        "#{key}Param".classify.constantize
+      end
+    end
+  end
+end

data/lib/jsonapi-params/version.rb

@@ -0,0 +1,5 @@
+module JSONAPI
+  module Param
+    VERSION = "0.1.0"
+  end
+end

data/lib/jsonapi-params.rb

@@ -0,0 +1,8 @@
+require 'jsonapi-params/version'
+require 'jsonapi-params/param'
+
+module JSONAPI
+  module Param
+    class InvalidParam < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Noverde Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !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-byebug
+  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: 
+email:
+- dev@noverde.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi-params.gemspec
+- lib/jsonapi-params.rb
+- lib/jsonapi-params/param.rb
+- lib/jsonapi-params/version.rb
+homepage: https://github.com/Noverde/jsonapi-params
+licenses: []
+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: Gem to handle with parameters according to jsonapi specification
+test_files: []