simple_json_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f79e962fb92a428343041ed39759f6e78564fce
-  data.tar.gz: 31d9bdcdfd654d50f96309080991040c0126ba59
+  metadata.gz: 2a442243658287849495015d9e7d70033be758c9
+  data.tar.gz: 47fa80783b4c0689f3e26051a012aeda9e077caf
 SHA512:
-  metadata.gz: 52ca5d094eb111beb2388bb9d57965b8f4d04aedbeb4169c4124d54d42b4ba5e05da2b70e90bce5ebdca243c8bbbe69214c4e960dac564762fe21a333994d4e9
-  data.tar.gz: e4304c2ed873421a9a82b0ef78e9e7d1edc54bb47f6e20b53a450e5ec8e5a1ffa84584a14499b4afc9892f95fa339454ef01d6dc03f55772af4be414b7883998
+  metadata.gz: 39b59ac72db54031090ca63f62bdc8387cef3ce49039a49841ca7cb0df7cd0ea3972dbf88af350ed81b3c6b34e2d77e6baf2996eb3714525c35811f2942787e4
+  data.tar.gz: 5d3a296127944821174cc21c352ad079989899501268d34517499b4700e44b88642d639b83770a35f7c210d5ad86a4bcf3939a14687c9789457ac280bcb3aff0

data/.travis.yml

@@ -1,11 +1,15 @@
 language: ruby
 rvm:
-  - 2.2.0
+  - 2.1
+  - 2.2
 env:
   - 'RAILS_VERSION=4.0'
   - 'RAILS_VERSION=4.1'
   - 'RAILS_VERSION=4.2'
   - 'RAILS_VERSION=master'
 matrix:
+  exclude:
+    - rvm: 2.1
+      env: 'RAILS_VERSION=master'
   allow_failures:
     - env: 'RAILS_VERSION=master'

data/README.md

@@ -22,11 +22,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Define serializers
 
+A serializer will need to be created for each resource. The serializer will defined the attributes and associations of the serialized json.
+
+```ruby
+class ProjectSerializer < SimpleJsonApi::ResourceSerializer
+  serializes :projects, model: Project
+  attribute :id
+  attribute :name, key: :project_name
+  attribute :description
+  attribute :position
+  has_one :todolist
+  has_many :tags
+  def href
+    "http://example.com/projects/#{_object.id}"
+  end
+end
+```
+
+Serializers are subclasses of `SimpleJsonApi::ResourceSerializer`. The `serializes` method defines the `root_class` for the object, specifying the model is optional, but may be necessary when the serializer cannot be determined for polymorphic associations.
+`attribute` defines the attributes of the serializer, the optional `key` allows the name to be changed during serialization.
+Associations are declared with `has_many`, `has_one`, and `belongs_to`. These can optionally set `polymorphic: true`. Also if the serializer cannot be determined by the name of the association, that is the name doesn't match any registered serializers, then the `serializer` parameter will need to be set.
+
+### Using serializers
+
+```ruby
+render json: SimpleJsonApi.render(
+                model: @projects,
+                serializer: ProjectSerializer,
+                fields: 'id,name',
+                include: 'todolist'
+              )
+```
+
+When rendering the model is the AR data to be serialized, if it is an Array the ArraySerializer will be used for the top collection.
+`fields` and `include` follow the jsonapi spec. [Include](http://jsonapi.org/format/#fetching-includes) will be the associations to be included in the generated json. [Fields](http://jsonapi.org/format/#fetching-sparse-fieldsets) is the list of attributes that will be included. The primary key will always be included.
 
 ## TODO
 
+0. Better documentation
+1. Handle meta section
+2. Handle links section
+3. Optimize queries (caching?)
+4. Handle PUTS/POSTS/DELETES
 
 ## Contributing
 

data/lib/simple_json_api/array_refinements.rb

@@ -6,7 +6,7 @@ module SimpleJsonApi
   module ArrayRefinements
     refine Array do
       using ActiveRecordRefinements
-      def already_linked?(key:, id:)
+      def already_linked?(key, id)
         find { |elem| elem[key] == id }
       end
     end

data/lib/simple_json_api/array_serializer.rb

@@ -4,7 +4,7 @@ module SimpleJsonApi
   class ArraySerializer < Serializer
     def serialize
       _object.map do |object|
-        serializer = _each_serializer.new(object: object, builder: _builder)
+        serializer = _each_serializer.new(object, _builder)
         serializer.serialize
       end
     end

data/lib/simple_json_api/field_list.rb

@@ -2,7 +2,7 @@
 module SimpleJsonApi
   # List of Fields for a resource
   class FieldList
-    def initialize(fields:, root_serializer:)
+    def initialize(fields, root_serializer)
       @fields = fields
       @root_serializer = root_serializer
     end

data/lib/simple_json_api/include_list.rb

@@ -2,7 +2,7 @@
 module SimpleJsonApi
   # List of Included associations for a resource
   class IncludeList
-    def initialize(include:)
+    def initialize(include)
       @include = include
       @include_list = []
     end

data/lib/simple_json_api/json_api_builder.rb

@@ -17,7 +17,7 @@ module SimpleJsonApi
     def_delegators :@field_list, :fields_for
 
     # TODO: sort: nil
-    def initialize(model:, serializer:, options: {})
+    def initialize(model, serializer, options = {})
       @model = model
       handle_options(options, serializer)
       @serializer = get_serializer(serializer)
@@ -28,12 +28,10 @@ module SimpleJsonApi
 
     def handle_options(options, serializer)
       @field_list = FieldList.new(
-        fields: options.fetch(:fields, nil),
-        root_serializer: serializer
+        options.fetch(:fields, nil),
+        serializer
       )
-      @include = IncludeList.new(
-        include: options.fetch(:include, nil)
-      ).parse
+      @include = IncludeList.new(options.fetch(:include, nil)).parse
     end
 
     def as_json(options = nil)
@@ -64,23 +62,17 @@ module SimpleJsonApi
 
     def add_to_linked(assoc_base, item, serializer)
       linked = @linked[serializer._root_name] ||= []
-      return if linked.already_linked?(key: item.json_pk, id: item.json_id)
-      linked << serializer.new(
-        object: item, builder: self, base: assoc_base
-      ).serialize
+      return if linked.already_linked?(item.json_pk, item.json_id)
+      linked << serializer.new(item, self, nil, assoc_base).serialize
     end
 
     private
 
     def get_serializer(serializer)
       if use_array_serializer?
-        ArraySerializer.new(
-          object: @model,
-          each_serializer: serializer,
-          builder: self
-        )
+        ArraySerializer.new(@model, self, serializer)
       else
-        serializer.new(object: @model, builder: self)
+        serializer.new(@model, self)
       end
     end
 

data/lib/simple_json_api/serializer.rb

@@ -9,7 +9,7 @@ module SimpleJsonApi
     attr_reader :_each_serializer
     attr_reader :_object
 
-    def initialize(object:, builder:, each_serializer: nil, base: nil)
+    def initialize(object, builder, each_serializer = nil, base = nil)
       @_object = object
       @_builder = builder
       @_each_serializer = each_serializer

data/lib/simple_json_api/version.rb

@@ -1,4 +1,4 @@
 # SimpleJsonApi
 module SimpleJsonApi
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/simple_json_api.rb

@@ -2,8 +2,8 @@ require 'simple_json_api/version'
 
 require 'simple_json_api/active_record_refinements'
 require 'simple_json_api/array_refinements'
-require 'simple_json_api/association'
-require 'simple_json_api/attribute'
+# require 'simple_json_api/association'
+# require 'simple_json_api/attribute'
 require 'simple_json_api/dsl'
 require 'simple_json_api/field_list'
 require 'simple_json_api/include_list'
@@ -16,12 +16,23 @@ require 'simple_json_api/json_api_builder'
 
 # SimpleJsonApi
 module SimpleJsonApi
+  # Wrapper for a linked association
+  Association = Struct.new(:name, :type, :serializer, :polymorphic, :key) do
+    def key
+      name_s = name.to_s
+      (type == :has_many) ? name_s.pluralize.to_sym : name_s.singularize.to_sym
+    end
+  end
+
+  # Attribute
+  Attribute = Struct.new(:name, :key) do
+    def key
+      self[:key] || self[:name]
+    end
+  end
+
   # Main hook to generate json
   def self.render(model:, serializer:, options: {})
-    JsonApiBuilder.new(
-      model: model,
-      serializer: serializer,
-      options: options
-    ).to_json
+    JsonApiBuilder.new(model, serializer, options).to_json
   end
 end

data/simple_json_api.gemspec

@@ -29,6 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'diffy'
   spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'minitest-reporters'
-  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'sqlite3'
 end

data/test/test_helper.rb

@@ -1,16 +1,17 @@
 require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.configuration.git_dir = '.'
 CodeClimate::TestReporter.start
 
-require 'bundler/setup'
-
 require 'simplecov'
 if ENV['COVERAGE']
   SimpleCov.start do
     add_filter '/test/'
   end
-  SimpleCov.minimum_coverage 95
+  SimpleCov.minimum_coverage 98
 end
 
+require 'bundler/setup'
+
 require 'minitest/autorun'
 require 'minitest/reporters'
 Minitest::Reporters.use!(

data/test/unit/field_list_test.rb

@@ -5,8 +5,8 @@ module SimpleJsonApi
   describe 'FieldListTest' do
     it 'should parse string field list' do
       fl = FieldList.new(
-        fields: 'id,name',
-        root_serializer: ProjectSerializer
+        'id,name',
+        ProjectSerializer
       )
       fl.fields_for(:projects).must_equal %w(id name)
       fl.fields_for(:todos).must_equal nil
@@ -14,11 +14,11 @@ module SimpleJsonApi
 
     it 'should parse hash field list' do
       fl = FieldList.new(
-        fields:
-          { 'projects' => 'id,name',
-            'todos' => 'id,description'
-          },
-        root_serializer: ProjectSerializer
+        {
+          'projects' => 'id,name',
+          'todos' => 'id,description'
+        },
+        ProjectSerializer
       )
       fl.fields_for(:projects).must_equal %w(id name)
       fl.fields_for(:todos).must_equal %w(id description)

data/test/unit/include_list_test.rb

@@ -4,17 +4,13 @@ require 'test_helper'
 module SimpleJsonApi
   describe 'IncludeListTest' do
     it 'should parse string include list' do
-      il = IncludeList.new(
-        include: 'todos,projects'
-      ).parse
+      il = IncludeList.new('todos,projects').parse
       assert il.include?(:projects)
       refute il.include?(:todo_lists)
     end
 
     it 'should parse string for nested include list' do
-      il = IncludeList.new(
-        include: 'todos,projects.todolists'
-      ).parse
+      il = IncludeList.new('todos,projects.todolists').parse
       refute il.include?(:projects)
       assert il.include?(:todos)
       assert il.include?(:todolists, [:projects])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gary Gordon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -170,8 +156,6 @@ files:
 - lib/simple_json_api/active_record_refinements.rb
 - lib/simple_json_api/array_refinements.rb
 - lib/simple_json_api/array_serializer.rb
-- lib/simple_json_api/association.rb
-- lib/simple_json_api/attribute.rb
 - lib/simple_json_api/dsl.rb
 - lib/simple_json_api/field_list.rb
 - lib/simple_json_api/include_list.rb

data/lib/simple_json_api/association.rb

@@ -1,10 +0,0 @@
-# SimpleJsonApi
-module SimpleJsonApi
-  # Wrapper for a linked association
-  Association = Struct.new(:name, :type, :serializer, :polymorphic, :key) do
-    def key
-      name_s = name.to_s
-      (type == :has_many) ? name_s.pluralize.to_sym : name_s.singularize.to_sym
-    end
-  end
-end

data/lib/simple_json_api/attribute.rb

@@ -1,9 +0,0 @@
-# SimpleJsonApi
-module SimpleJsonApi
-  # Attribute
-  Attribute = Struct.new(:name, :key) do
-    def key
-      self[:key] || self[:name]
-    end
-  end
-end