abc_jsonapi 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96cedf5858ef1a23cdf9a35898055f3fdc755a24e6ca0964de971007cb94a14
-  data.tar.gz: 9d2e596d5b7fd8d01f8bc5dd156b6336d62acc182b605ef64c45dfd47e8caa50
+  metadata.gz: a32de4446187395c51ca0c74337fce16277306c3720a1a3a1343cc7a931ea2eb
+  data.tar.gz: d04e65627b5ebfbf07a179256e42468c159adc51a5956638b31a404274d5a745
 SHA512:
-  metadata.gz: ef73201e7743a4fd4354c413e11c6fa1267f494428318944438f5311181790d0dc2ea5ab9f38cabc110771cd4adbd227afc0f4d8d66eb62239eefc24fc65b2b9
-  data.tar.gz: c285d419c355103b866b27e9026d4c59f276d9b1539ff9d16057d0141f14361158498e45489a9dc29987e22544d6ca18cbb6205cbd3972130e1829402adcead8
+  metadata.gz: 7d98ad8a97ee7dc9b5ec4cfae77b55be6cbafe06fe64e1cf69c39f0b46f2392c15e1683a412bd82594e9cd07019fddb700831c530c118a12b795ce3344a60adb
+  data.tar.gz: cf1b1de98a118746bae5d939a83d524ac60cfd04b1a99423c8f84c6e5bb92ecd31f6339151d0fa4e0268c55e87c9b2a83e7e83b639138775a9bc3f29ec4141f2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abc_jsonapi (0.1.1)
+    abc_jsonapi (0.2.1)
       activesupport (>= 5.2)
       i18n
 

data/README.md

@@ -1,36 +1,140 @@
 # AbcJsonapi
 
 Minimalistic gem for JSON Serialization according to https://jsonapi.org spec
+Inspired by [https://github.com/Netflix/fast_jsonapi](https://github.com/Netflix/fast_jsonapi)
+Contributions are welcome.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
+
 gem 'abc_jsonapi'
+
 ```
 
 And then execute:
 
-    $ bundle
+\$ bundle
 
 Or install it yourself as:
 
-    $ gem install abc_jsonapi
+\$ gem install abc_jsonapi
+
+## Features
+
+- Relationships (belongs_to, has_many, has_one)
+- Compound documents ("include" option)
+- Custom include strategies. It is useful when serializing a collection of records to avoid N+1 problem.
+- _"Virtual"_ attributes or overriding default attribute serializing behavior
 
 ## Usage
 
-TODO: Write usage instructions here
+Syntax is very similar to Active Model Serializer.
+
+The serializer is able to work with any ruby ​​objects. Not only ActiveRecord. The idea is to use duck typing for getting object attributes, relationships and all other data.
+
+#### Model Example
+
+```ruby
+class Author
+	attr_reader :first_name, :last_name, :public_name, :contact_id
+end
+```
+
+#### Serializer Definition
+
+```ruby
+class AuthorSerializer
+	include AbcJsonapi::Serializer
+	resource_type :people (optional)
+	attributes :first_name, :last_name, :public_name
+	belongs_to :contact
+	has_many :books
+end
+```
+
+#### Custom resource type
+
+Default resource type of direct serializing model is taken from serializer filename. In case of `AuthorSerializer` with disabled pluralize_resources it will be `"author"`. Resource type of compound documents is downcased class of related object.
+
+#### Attributes
+
+Jsonapi attributes may be declared with class method of serializer - `attributes`:
+
+```ruby
+attributes :first_attribute, :second, *other
+```
+
+`attributes` arguments will be called on serializing model as methods.
+
+Also there is `attribute` method to declare single property. You can pass a block to define the way it should be returned.
+
+```ruby
+attribute :date_of_birth  do |object|
+	object.date_of_birth.strftime("%FT%T.%3N%:z") if object.stop.present?
+end
+```
+
+#### Serializer usage
+
+Return ruby hash:
+
+```ruby
+AuthorSerializer.new(resource).serializable_hash
+```
+
+Return json:
+
+```ruby
+AuthorSerializer.new(resource).serialized_json
+```
+
+## Compound Documents
+
+To include relationships you can pass `include` option at the serializer initialization stage.
+
+```ruby
+options = {}
+options[:include] = :books # or "books"
+AuthorSerializer.new(resource, options).serialized_json
+```
+
+## Configuration
+
+#### Global config options
+
+- **transform_keys** (_true/false_) - convert keys to any case or not. Default value: _true_
+- **key_transform_method** (_"camel"_ or _"snake"_) - certain key transform method to use with **transform_keys** option enabled. Default value: _"camel"_
+- **pluralize_resources** (_true/false_) - pluralize all resources types in response by default or not. Default value: _false_
+
+#### Usage
+
+```ruby
+AbcJsonapi.configure do |config|
+	config.transform_keys = true
+	config.key_transform_method = "camel"
+	config.pluralize_resources  =  true
+end
+```
 
 ## 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.
+**TODO**:
+
+- Write specs
+- Use custom include relationship strategies for downloading relationships json block (solve N+1 problem when serializing collection).
+- Meta per resource
+- Add other jsonapi features
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/[USERNAME]/abc_jsonapi.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ezname/abc_jsonapi.
 
 ## License
 

data/lib/abc_jsonapi/version.rb

@@ -1,3 +1,3 @@
 module AbcJsonapi
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abc_jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Zhmakin Evgeniy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Json API serializer gem