ember_data_active_model_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31076fab33df0652b49cf8644852ed956e01eefe
+  data.tar.gz: b6899da4c8032f5ff839d015c940d6ad0b229dad
+SHA512:
+  metadata.gz: 3f99b3e115f000e221f71e6563a2ce51f6cdddfc79ce1e961f5a9f0bfe612fe67bce76f6525f31fe555de267a84d283ca6fd59d79feb793bab446b18909b2efa
+  data.tar.gz: 052262df9b34f76a0ed2e38b21ecb4514f5eeadaa416f0470ed5154ebe4ca0ac55b0d6f20bdbd2b845a87ceee08f0ebd117015c13d397b07c588cdf46ef124ad

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Valentin Mihov
+
+MIT License
+
+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 @@
+# EmberDataActiveModelParser
+
+This is a middleware for [Her](http://her-rb.org/) which makes it possible to consume API endpoints used by ember-data's [ActiveModelAdapter](http://emberjs.com/api/data/classes/DS.ActiveModelAdapter.html). You can read more about the data format in the ember-data's [docs](http://emberjs.com/api/data/classes/DS.ActiveModelAdapter.html)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ember_data_active_model_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ember_data_active_model_parser
+
+## Usage
+
+The parser expects that all your serializers are embedding the ids of the associations like this:
+
+```ruby
+class ProjectSerializer < ActiveModel::Serializer
+  embed :ids, embed_in_root: true
+
+  attributes :id, :name
+
+  has_many :tasks
+end
+
+class TaskSerializer < ActiveModel::Serializer
+  embed :ids, embed_in_root: true
+
+  attributes :id, :name, :completed
+end
+```
+
+also you need to specify that active_model_serializers format in the Her models:
+
+```ruby
+class Project
+  include Her::Model
+
+  parse_root_in_json true, format: :active_model_serializers
+
+  has_many :tasks
+end
+
+class Task
+  include Her::Model
+
+  parse_root_in_json true, format: :active_model_serializers
+
+  belongs_to :project
+end
+```
+
+In order to tell Her to use the serializer you need to replace the default JSON parser with it in an initializer (ex. config/initializers/her.rb):
+
+```ruby
+Her::API.setup url: "http://localhost:3000" do |c|
+  # Request
+  c.use Faraday::Request::UrlEncoded
+
+  # Response
+  c.use EmberDataActiveModelParser::Middleware
+
+  # Adapter
+  c.use Faraday::Adapter::NetHttp
+end
+```
+
+## Circular dependencies
+
+Be careful when defining your serializers not to fall into a circular dependency problems. For example including the project_id in the tasks:
+
+```ruby
+class ProjectSerializer < ActiveModel::Serializer
+  embed :ids, embed_in_root: true
+
+  attributes :id, :name
+
+  has_many :tasks
+end
+
+class TaskSerializer < ActiveModel::Serializer
+  embed :ids, embed_in_root: true
+
+  attributes :id, :name, :completed
+
+  # This is going to cause SystemStackError in her, because of the circular dependency between
+  # the models
+  attributes :project_id
+end
+```
+
+# Example projects
+
+You can see some example probjects here:
+
+* A Rails API with EmberJS as frontend for projects and tasks: [ember_rails_api_example](https://github.com/valo/ember_rails_api_example)
+* A Rails app which uses Her as ORM to consume data from the example project above: [ember_rails_api_consumer](https://github.com/valo/ember_rails_api_consumer)
+
+## Contributing
+
+1. Fork it ( https://github.com/valo/ember_data_active_model_parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ember_data_active_model_parser.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ember_data_active_model_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ember_data_active_model_parser"
+  spec.version       = EmberDataActiveModelParser::VERSION
+  spec.authors       = ["Valentin Mihov"]
+  spec.email         = ["valentin.mihov@gmail.com"]
+  spec.summary       = %q{A parser for Her compatible with ember-data's active_model_serializers format}
+  spec.description   = %q{A parser that enables Her to consume data exposed through active_model_serializers and compatible with the ember-data format}
+  spec.homepage      = "https://github.com/valo/ember_data_active_model_parser"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "her"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/ember_data_active_model_parser.rb

@@ -0,0 +1,19 @@
+require "ember_data_active_model_parser/version"
+require "ember_data_active_model_parser/embed_associations"
+require "faraday"
+
+module EmberDataActiveModelParser
+  class Middleware < Faraday::Response::Middleware
+    def parse(body)
+      json = MultiJson.load(body, symbolize_keys: true)
+
+      EmbedAssociations.new(json).call
+    end
+
+    def on_complete(env)
+      env[:body] = {
+        data: parse(env[:body])
+      }
+    end
+  end
+end

data/lib/ember_data_active_model_parser/embed_associations.rb

@@ -0,0 +1,63 @@
+require "active_support/inflector"
+
+module EmberDataActiveModelParser
+  class EmbedAssociations
+    def initialize(root_json)
+      @root_json = root_json
+    end
+
+    def call
+      root_json.each do |key, value|
+        walk(value)
+      end
+    end
+
+    private
+
+    attr_reader :root_json
+
+    def walk(object)
+      case object
+        when Array
+          object.each { |element| walk(element) }
+        when Hash
+          walk_hash(object)
+      end
+    end
+
+    def walk_hash(hash)
+      hash.keys.each do |key|
+        if association_ids_key(key, hash[key])
+          handle_association_ids(hash, hash.delete(key), association_name(key))
+        end
+      end
+    end
+
+    def handle_association_ids(hash, association_ids, association_name)
+      case association_ids
+        when Array
+          hash[association_name.pluralize.to_sym] = {
+            association_name.pluralize.to_sym => association_ids.map { |association_id|
+              association_array(association_name).find { |association_item| association_item[:id] == association_id }
+            }
+          }
+        when Fixnum
+          hash[association_name.to_sym] = {
+            association_name.to_sym => association_array(association_name).find { |association_item| association_item[:id] == association_ids }
+          }
+      end
+    end
+
+    def association_ids_key(key, value)
+      key.to_s =~ /(.+)_id(s?)$/ && association_array(association_name(key)) && (value.is_a?(Array) || value.is_a?(Fixnum))
+    end
+
+    def association_name(key)
+      key[/^(.+)_id(s?)$/, 1]
+    end
+
+    def association_array(association_name)
+      root_json[association_name.pluralize.to_sym]
+    end
+  end
+end

data/lib/ember_data_active_model_parser/version.rb

@@ -0,0 +1,3 @@
+module EmberDataActiveModelParser
+  VERSION = "0.0.1"
+end

data/spec/embed_associations_spec.rb

@@ -0,0 +1,173 @@
+require 'ember_data_active_model_parser'
+
+describe EmberDataActiveModelParser::EmbedAssociations do
+  describe "#call" do
+    context "with an object with some associations" do
+      let(:tasks) do
+        [{
+          id: 1,
+          name: "Milk",
+        },
+        {
+          id: 2,
+          name: "Bread"
+        },
+        {
+          id: 3,
+          name: "Butter"
+        }]
+      end
+
+      let(:json) do
+        {
+          project: { id: 1, name: "Shop list", task_ids: [1,2,3] },
+          tasks: tasks
+        }
+      end
+      let(:expected_json) do
+        {
+          project: { id: 1, name: "Shop list", tasks: { tasks: tasks } },
+          tasks: tasks
+        }
+      end
+      let(:embed_associations) { EmberDataActiveModelParser::EmbedAssociations.new(json) }
+
+      it "embeds the objects from the root to the proper parents" do
+        expect(embed_associations.call).to eq(expected_json)
+      end
+    end
+
+    context "with an array of objects with some associations" do
+      let(:tasks) do
+        [{
+          id: 1,
+          name: "Milk",
+          project_id: projects[0][:id]
+        },
+        {
+          id: 2,
+          name: "Bread",
+          project_id: projects[0][:id]
+        },
+        {
+          id: 3,
+          name: "Butter",
+          project_id: projects[1][:id]
+        }]
+      end
+
+      let(:projects) do
+        [{
+          id: 1,
+          name: "Shop list",
+          task_ids: [1,2]
+        }, {
+          id: 2,
+          name: "Other Shop list",
+          task_ids: [3]
+        }]
+      end
+
+      let(:json) do
+        {
+          projects: projects,
+          tasks: tasks
+        }
+      end
+
+      let(:expected_tasks) do
+        [{
+          id: 1,
+          name: "Milk",
+          project: { project: projects[0] }
+        },
+        {
+          id: 2,
+          name: "Bread",
+          project: { project: projects[0] }
+        },
+        {
+          id: 3,
+          name: "Butter",
+          project: { project: projects[1] }
+        }]
+      end
+
+      let(:expected_projects) do
+        [{ id: 1, name: "Shop list", tasks: { tasks: expected_tasks[0, 2] } }, { id: 2, name: "Other Shop list", tasks: { tasks: expected_tasks[2, 3] } }]
+      end
+
+      let(:expected_json) do
+        {
+          projects: expected_projects,
+          tasks: expected_tasks
+        }
+      end
+      let(:embed_associations) { EmberDataActiveModelParser::EmbedAssociations.new(json) }
+
+      it "embeds the objects from the root to the proper parents" do
+        expect(embed_associations.call).to eq(expected_json)
+      end
+    end
+
+
+    context "with an object with some associations that have associations" do
+      let(:tasks) do
+        [{
+          id: 1,
+          name: "Milk",
+          author_id: 1
+        },
+        {
+          id: 2,
+          name: "Bread",
+          author_id: 2
+        }]
+      end
+
+      let(:expected_tasks) do
+        [{
+          id: 1,
+          name: "Milk",
+          author: { author: authors[0] }
+        },
+        {
+          id: 2,
+          name: "Bread",
+          author: { author: authors[1] }
+        }]
+      end
+
+      let(:authors) do
+        [{
+          id: 1,
+          name: "Mom"
+        },
+        {
+          id:2,
+          name: "Dad"
+        }]
+      end
+
+      let(:json) do
+        {
+          project: { id: 1, name: "Shop list", task_ids: [1,2] },
+          tasks: tasks,
+          authors: authors
+        }
+      end
+      let(:expected_json) do
+        {
+          project: { id: 1, name: "Shop list", tasks: { tasks: expected_tasks } },
+          tasks: expected_tasks,
+          authors: authors
+        }
+      end
+      let(:embed_associations) { EmberDataActiveModelParser::EmbedAssociations.new(json) }
+
+      it "embeds the objects from the root to the proper parents" do
+        expect(embed_associations.call).to eq(expected_json)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ember_data_active_model_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valentin Mihov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: her
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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 parser that enables Her to consume data exposed through active_model_serializers
+  and compatible with the ember-data format
+email:
+- valentin.mihov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ember_data_active_model_parser.gemspec
+- lib/ember_data_active_model_parser.rb
+- lib/ember_data_active_model_parser/embed_associations.rb
+- lib/ember_data_active_model_parser/version.rb
+- spec/embed_associations_spec.rb
+homepage: https://github.com/valo/ember_data_active_model_parser
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A parser for Her compatible with ember-data's active_model_serializers format
+test_files:
+- spec/embed_associations_spec.rb