motion-json-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b00c290ef84e915cf55ea3e6f7d3a9e68a096951
+  data.tar.gz: 95b4a777808fe8751731487f047604f46648b3ad
+SHA512:
+  metadata.gz: 9184db4c31abc1e0646ea541d82d3f6d862fb5203f0fb6d51799ceaf16d7f75ea986b91e29d0e65fcab46a5b9f32c07a102a8069d3c9485b350f4d738a51fe6a
+  data.tar.gz: da1a3ed70b72a6af029eb7ef090dd1f03ea357cbc76e544c90404ff2f3cfbe1a8c6d462559e5af16c52fc9c7f9194f969d0ace50898e47c195cef464e2ae34fe

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Joffrey Jaffeux
+
+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,58 @@
+# MotionJsonApi
+
+A small library that helps you transform JSONApi server responses into objects.
+
+Note: this gem is not intended to create valid JSON Api payload to send to a server.
+If you have this need, feel free to contribute.
+
+
+## Usage
+
+```ruby
+
+# Define resources
+class User < MotionJsonApi::Resource
+  resource_type :users
+
+  attribute :name
+
+  has_one :blog
+end
+
+class Blog < MotionJsonApi::Resource
+  resource_type :blogs
+
+  attribute :title
+  has_many :articles
+end
+
+class Article < MotionJsonApi::Resource
+  resource_type :articles
+
+  attribute :title
+  attribute :body
+
+  has_one :user, as: :author
+end
+
+resource = MotionJsonApi.parse(server_response)
+
+resource.user
+resource.user.name
+resource.user.blog
+resource.user.blog.title
+resource.user.blog.articles
+resource.user.blog.articles.first.author
+
+resource.links
+resource.meta
+
+resource.user.links
+```
+
+## Run tests
+
+```
+bundle install
+rake test
+```

data/lib/motion-json-api.rb

@@ -0,0 +1,8 @@
+require 'motion-json-api/exceptions'
+require 'motion-json-api/resource'
+
+module MotionJsonApi
+  def self.parse(json)
+    Resource._object_handler(json, json.fetch("data", []), json.fetch("included", []))
+  end
+end

data/lib/motion-json-api/exceptions.rb

@@ -0,0 +1,3 @@
+module MotionJsonApi
+  class UndefinedResource < StandardError; end
+end

data/lib/motion-json-api/resource.rb

@@ -0,0 +1,100 @@
+module MotionJsonApi
+  class Resource
+    attr_accessor :id
+    attr_accessor :attributes
+    attr_accessor :relationships
+    attr_accessor :meta
+    attr_accessor :links
+    attr_accessor :top_level
+    attr_accessor :included
+
+    def initialize(object, top_level = [], included = [])
+      @id = object["data"]["id"]
+      @attributes = object["data"]["attributes"]
+      @relationships = object["data"]["relationships"]
+      @meta = object.fetch("meta", {})
+      @links = object.fetch("links", {})
+      @top_level = top_level
+      @included = included
+    end
+
+    @_resource_type = nil
+    def self.resource_type(resource_type)
+      @_resource_type = resource_type
+    end
+
+    def self._resource_type
+      @_resource_type
+    end
+
+    def self.attribute(attribute)
+      define_method(attribute) do
+        self.attributes.fetch(attribute.to_s)
+      end
+    end
+
+    def self.has_one(relation, options = {})
+      key = options.fetch(:as, relation).to_s
+      define_method(key) do
+        relationship = self.relationships.fetch(key)
+        data = relationship.fetch("data")
+        object = _find_in_included(data["id"], data["type"])
+        payload = {"data" => object, "links" => relationship.fetch("links", {})}
+        Resource._object_handler(payload, self.top_level, self.included)
+      end
+    end
+
+    def self.has_many(relation, options = {})
+      key = options.fetch(:as, relation).to_s
+      define_method(key) do
+        relationship = self.relationships.fetch(key)
+        relationship.fetch("data").map do |data|
+          object = _find_in_included(data["id"], data["type"])
+          Resource._object_handler({"data" => object}, self.top_level, self.included)
+        end
+      end
+    end
+
+    private
+
+    def _find_in_included(id, type)
+      object = self.included.find { |x| x["id"] == id && x["type"] == type }
+      if object.nil?
+        object = self.top_level.find { |x| x["id"] == id && x["type"] == type }
+      end
+      object
+    end
+
+    def self._klass_for_type(type)
+      resource_klass = Resource._descendants.select do |klass|
+        type == klass._resource_type.to_s
+      end.first
+
+      unless resource_klass
+        raise UndefinedResource, "Couldn’t find defined resource for type: #{type}"
+      end
+
+      resource_klass
+    end
+
+    def self._descendants
+      ObjectSpace.each_object(Class).select { |klass| klass < self }
+    end
+
+    def self._object_handler(object, top_level, included = nil)
+      included ||= self.included || object.fetch("included", [])
+      top_level ||= self.top_level || [object["data"]].flatten
+
+      case object["data"]
+      when Array
+        return object["data"].map do |data|
+          resource_klass = Resource._klass_for_type(data["type"])
+          resource_klass.new({"data" => data}, top_level, included)
+        end
+      when Hash
+        resource_klass = Resource._klass_for_type(object["data"]["type"])
+        resource_klass.new(object, top_level, included)
+      end
+    end
+  end
+end

data/lib/motion-json-api/version.rb

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: motion-json-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joffrey Jaffeux
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-20 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.9'
+description: A small library that helps you transform JSONApi server responses into
+  objects.
+email:
+- j.jaffeux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/motion-json-api.rb
+- lib/motion-json-api/exceptions.rb
+- lib/motion-json-api/resource.rb
+- lib/motion-json-api/version.rb
+homepage: https://github.com/jjaffeux/motion-json-api
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Simplified JSONApi client for RubyMotion iOS apps.
+test_files: []