jsonapi_deserializer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fdf9fafbdfca4001e1524366b2f6e53248df5ca
+  data.tar.gz: 9e9965c7da3e9e1bdda4df87d07fe8dc57358a98
+SHA512:
+  metadata.gz: d178b73585336cb6cc0776c09aa61c9669fbdbba1f03fb59a2e61232959c6275da02737cdc3d302d456e00257f82bccce08ce0ec6d8394f3587a31beba4381aa
+  data.tar.gz: 7c1aab7ff2908b3479d8d852def4ea0fa3e60234db48f6528257ab5fe77f639332985dd3b4b58e76376e70bbba16178852dc388da33089755551f64fbe6400f0

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.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# 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 [INSERT EMAIL ADDRESS]. 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 jsonapi_deserializer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Popular Pays
+
+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,56 @@
+# jsonapi_deserializer
+
+[![Build Status](https://travis-ci.org/PopularPays/jsonapi_deserializer.svg)](https://travis-ci.org/PopularPays/jsonapi_deserializer) [![Dependency Status](https://gemnasium.com/PopularPays/jsonapi_deserializer.svg)](https://gemnasium.com/PopularPays/jsonapi_deserializer) [![Code Climate](https://codeclimate.com/github/PopularPays/jsonapi_deserializer/badges/gpa.svg)](https://codeclimate.com/github/PopularPays/jsonapi_deserializer)
+
+Deserialize your [json-api](http://jsonapi.org/)
+payloads into easy-to-use hashes
+with attribute properties.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_deserializer'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+```ruby
+response = {
+  data: {
+    type: 'dogs',
+    id: '1',
+    attributes: {
+      name: 'fluffy'
+    }
+  }
+}
+
+one_deserialized = JSONApi::Deserializer.new(response).deserialized_hash
+# one_deserialized.id == '1'
+# one_deserialized.name == 'fluffy'
+```
+
+
+## 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/popularpays/jsonapi_deserializer. 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
+
+[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_deserializer"
+
+# 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_deserializer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_deserializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_deserializer"
+  spec.version       = JSONApi::Deserializer::VERSION
+  spec.authors       = ["Trek Glowacki"]
+  spec.email         = ["trek@popularpays.com"]
+
+  spec.summary       = "Deserialize your json-api payloads into easy-to-use hashes with attribute properties."
+  spec.homepage      = "https://github.com/PopularPays/jsonapi_deserializer"
+  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"
+
+  spec.add_runtime_dependency "hashie"
+  spec.add_runtime_dependency "activesupport"
+end

data/lib/jsonapi_deserializer.rb

@@ -0,0 +1,77 @@
+require "hashie"
+require "active_support/core_ext/hash/indifferent_access"
+require "jsonapi_deserializer/version"
+
+module JSONApi
+  class Deserializer
+    class Assocation < Hashie::Mash
+      include Hashie::Extensions::MethodAccess
+      include Hashie::Extensions::IndifferentAccess
+
+      def initialize(hash)
+        hash[:id] = hash[:id].to_s
+        super
+      end
+    end
+
+    class Record < Hashie::Mash
+      include Hashie::Extensions::MethodAccess
+      include Hashie::Extensions::IndifferentAccess
+      include Hashie::Extensions::DeepFetch
+    end
+
+    def initialize(response)
+      @response = response.with_indifferent_access
+      @store = {}
+
+      all_data = ([] << @response[:data] << @response[:included]).flatten.compact
+      store_records(all_data)
+      build_associations(all_data)
+    end
+
+    def deserialized_hash
+      data = @response[:data]
+      if data.is_a? Array
+        data.map { |datum| @store[datum[:type]][datum[:id].to_s] }
+      else
+        @store[data[:type]][data[:id].to_s]
+      end
+    end
+
+    private
+
+    def store_records(data)
+      data.each do |datum|
+        type = datum[:type]
+        per_type = @store[type] ||= {}
+        record = Record.new(id: datum[:id].to_s, type: datum[:type]).merge(datum[:attributes] || {})
+
+        per_type[record.id] = record
+      end
+    end
+
+    def find_association(association)
+      return nil unless association
+      if @store[association[:type]] && @store[association[:type]][association[:id].to_s]
+        @store[association[:type]][association[:id].to_s]
+      else
+        Assocation.new(association)
+      end
+    end
+
+    def build_associations(data)
+      data.each do |datum|
+        record = @store[datum[:type]][datum[:id].to_s]
+
+        relationships = datum[:relationships] || {}
+        relationships.each do |relationship_name, relationship|
+          if relationship[:data].is_a? Array
+            record[relationship_name] = relationship[:data].map { |assoc| find_association(assoc) }
+          else
+            record[relationship_name] = find_association(relationship[:data])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi_deserializer/version.rb

@@ -0,0 +1,5 @@
+module JSONApi
+  class Deserializer
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_deserializer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trek Glowacki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-06 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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- trek@popularpays.com
+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_deserializer.gemspec
+- lib/jsonapi_deserializer.rb
+- lib/jsonapi_deserializer/version.rb
+homepage: https://github.com/PopularPays/jsonapi_deserializer
+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: Deserialize your json-api payloads into easy-to-use hashes with attribute
+  properties.
+test_files: []