jsonapi-client 0.1.1.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2e9034a41c293b47e0e8316f9f44b61769b1d99
+  data.tar.gz: 457f801e7143c2e03f25716590ced6315acfc855
+SHA512:
+  metadata.gz: abba8780cd184a180682b68c9f1d3f72754c618a344477c7b32ff4d3d962031a6c1e0e4927d2352f93d866aa4a1b4f69231ac5037ea5bbe42982466e4992322c
+  data.tar.gz: 0dbaf0e531dd275d687c971af1157dcac0b6c39d016a58023838e897544ff8600e0cba0e26d068824432bb71a62c5d71542123ae1f0cb0503ceffe791cc58be3

data/README.md

@@ -0,0 +1,121 @@
+# jsonapi-client
+Ruby gem for consuming [JSON API](http://jsonapi.org) documents.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/jsonapi-client.svg)](https://badge.fury.io/rb/jsonapi-client)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/client.svg?branch=master)](http://travis-ci.org/jsonapi-rb/client?branch=master)
+
+## Installation
+```ruby
+# In Gemfile
+gem 'jsonapi-client'
+```
+then
+```
+$ bundle
+```
+or manually via
+```
+$ gem install jsonapi-client
+```
+
+## Usage
+
+First, require the gem:
+```ruby
+require 'jsonapi/client'
+```
+
+Then
+```ruby
+payload = {
+  "links" => {
+    "self" => "http://example.com/articles",
+    "next" => "http://example.com/articles?page[offset]=2",
+    "last" => "http://example.com/articles?page[offset]=10"
+  },
+  "data" => [
+    {
+      "type" => "articles",
+      "id" => "1",
+      "attributes" => {
+        "title" => "JSON API paints my bikeshed!"
+      },
+      "relationships" => {
+        "author" => {
+          "links" => {
+            "self" => "http://example.com/articles/1/relationships/author",
+            "related" => "http://example.com/articles/1/author"
+          },
+          "data" => { "type" => "people", "id" => "9" }
+        },
+        "comments" => {
+          "links" => {
+            "self" => "http://example.com/articles/1/relationships/comments",
+            "related" => "http://example.com/articles/1/comments"
+          },
+          "data" => [
+            { "type" => "comments", "id" => "5" },
+            { "type" => "comments", "id" => "12" }
+          ]
+        }
+      },
+      "links" => {
+        "self" => "http://example.com/articles/1"
+      }
+    }
+  ],
+  "included" => [
+    {
+      "type" => "people",
+      "id" => "9",
+      "attributes" => {
+        "first-name" => "Dan",
+        "last-name" => "Gebhardt",
+        "twitter" => "dgeb"
+      },
+      "links" => {
+        "self" => "http://example.com/people/9"
+      }
+    }, {
+      "type" => "comments",
+      "id" => "5",
+      "attributes" => {
+        "body" => "First!"
+      },
+      "relationships" => {
+        "author" => {
+          "data" => { "type" => "people", "id" => "2" }
+        }
+      },
+      "links" => {
+        "self" => "http://example.com/comments/5"
+      }
+    }, {
+      "type" => "comments",
+      "id" => "12",
+      "attributes" => {
+        "body" => "I like XML better"
+      },
+      "relationships" => {
+        "author" => {
+          "data" => { "type" => "people", "id" => "9" }
+        }
+      },
+      "links" => {
+        "self" => "http://example.com/comments/12"
+      }
+    }
+  ]
+}
+
+document = JSONAPI::Client::Document.new(json_hash)
+
+document.data[0].relationships['author'].data.attributes['first-name']
+# => "Dan"
+```
+
+## License
+
+jsonapi-client is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi/client.rb

@@ -0,0 +1,7 @@
+require 'jsonapi/parser'
+
+require 'jsonapi/client/document'
+require 'jsonapi/client/resource'
+require 'jsonapi/client/relationship'
+require 'jsonapi/client/link'
+require 'jsonapi/client/error'

data/lib/jsonapi/client/document.rb

@@ -0,0 +1,63 @@
+module JSONAPI
+  module Client
+    class Document
+      attr_reader :data, :included, :errors, :links, :meta
+
+      def initialize(document, link_data = true)
+        JSONAPI::Parser::Document.parse!(document)
+        parse_data!(document['data'], document['included'])
+        link_data! if link_data
+        parse_errors!(document['errors'])
+        parse_links!(document['links'])
+        parse_meta!(document['meta'])
+      end
+
+      private
+
+      def parse_data!(data, included)
+        return unless data
+        @data =
+          if data.respond_to?(:each)
+            data.map { |h| Resource.new(h) }
+          else
+            Resource.new(data)
+          end
+        @included = Array(included).map { |h| Resource.new(h) }
+      end
+
+      def index
+        return @index unless @index.nil?
+        @index = {}
+        (Array(@data) + @included).each do |resource|
+          resource_identifier = [resource.type, resource.id]
+          @index[resource_identifier] = resource
+        end
+
+        @index
+      end
+
+      def link_data!
+        (Array(@data) + @included).each do |resource|
+          resource.relationships.each do |_, rel|
+            rel.link_data!(index)
+          end
+        end
+      end
+
+      def parse_errors!(errors)
+        @errors = Array(errors).map { |h| Error.new(h) }
+      end
+
+      def parse_links!(links)
+        @links = {}
+        (links || {}).map do |key, h|
+          @links[key] = Link.new(h)
+        end
+      end
+
+      def parse_meta!(meta)
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/jsonapi/client/error.rb

@@ -0,0 +1,52 @@
+module JSONAPI
+  module Client
+    class Error
+      attr_reader :id, :links, :status, :code, :title, :detail, :source, :meta
+
+      def initialize(error)
+        parse_id!(error['id'])
+        parse_links!(error['links'])
+        parse_status!(error['status'])
+        parse_code!(error['code'])
+        parse_title!(error['title'])
+        parse_detail!(error['detail'])
+        parse_source!(error['source'])
+        parse_meta!(error['meta'])
+      end
+
+      def parse_id!(id)
+        @id = id
+      end
+
+      def parse_links!(links)
+        (links || {}).map do |key, h|
+          @links[key] = Link.new(h)
+        end
+      end
+
+      def parse_status!(status)
+        @status = status
+      end
+
+      def parse_code!(code)
+        @code = code
+      end
+
+      def parse_title!(title)
+        @title = title
+      end
+
+      def parse_detail!(detail)
+        @detail = detail
+      end
+
+      def parse_source!(source)
+        @source = source
+      end
+
+      def parse_meta!(meta)
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/jsonapi/client/link.rb

@@ -0,0 +1,26 @@
+module JSONAPI
+  module Client
+    class Link
+      attr_reader :href, :meta
+
+      def initialize(relationship)
+        if relationship.is_a?(String)
+          parse_href!(relationship)
+        else
+          parse_href!(relationship['href'])
+          parse_meta!(relationship['meta'])
+        end
+      end
+
+      private
+
+      def parse_href!(href)
+        @href = href
+      end
+
+      def parse_meta!(meta)
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/jsonapi/client/relationship.rb

@@ -0,0 +1,43 @@
+module JSONAPI
+  module Client
+    class Relationship
+      attr_reader :data, :links, :meta
+
+      def initialize(relationship)
+        parse_data!(relationship['data'])
+        parse_links!(relationship['links'])
+        parse_meta!(relationship['meta'])
+      end
+
+      # @api private
+      def link_data!(index)
+        if @data.is_a?(Array)
+          @data.map! do |ri|
+            ri = [ri['type'], ri['id']]
+            index[ri]
+          end
+        elsif !@data.nil?
+          ri = [@data['type'], @data['id']]
+          @data = index[ri]
+        end
+      end
+
+      private
+
+      def parse_data!(data)
+        @data = data
+      end
+
+      def parse_links!(links)
+        @links = {}
+        (links || {}).map do |key, h|
+          @links[key] = Link.new(h)
+        end
+      end
+
+      def parse_meta!(meta)
+        @meta = meta
+      end
+    end
+  end
+end

data/lib/jsonapi/client/resource.rb

@@ -0,0 +1,40 @@
+module JSONAPI
+  module Client
+    class Resource
+      attr_reader :id, :type, :attributes, :relationships, :links, :meta
+
+      def initialize(resource)
+        @id = resource['id']
+        @type = resource['type']
+        parse_attributes!(resource['attributes'])
+        parse_relationships!(resource['relationships'])
+        parse_links!(resource['links'])
+        parse_meta!(resource['meta'])
+      end
+
+      private
+
+      def parse_attributes!(attributes)
+        @attributes = attributes || {}
+      end
+
+      def parse_relationships!(relationships)
+        @relationships = {}
+        (relationships || {}).map do |key, h|
+          @relationships[key] = Relationship.new(h)
+        end
+      end
+
+      def parse_links!(links)
+        @links = {}
+        (links || {}).map do |key, h|
+          @links[key] = Link.new(h)
+        end
+      end
+
+      def parse_meta!(meta)
+        @meta = meta
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1.beta1
+platform: ruby
+authors:
+- Lucas Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Client library for the JSON API spec.
+email: lucas.hosseini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jsonapi/client.rb
+- lib/jsonapi/client/document.rb
+- lib/jsonapi/client/error.rb
+- lib/jsonapi/client/link.rb
+- lib/jsonapi/client/relationship.rb
+- lib/jsonapi/client/resource.rb
+homepage: https://github.com/jsonapi-rb/client
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Consume JSON API documents.
+test_files: []