json-pie 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63d4d0b3a9e543fbb77724003a4e00b54b4019fc4aa96effde7517ea40967bf
-  data.tar.gz: a355d4b17fe3ae44c243073d86da4766825d2db1b52d876d7e8fe034be90ecfe
+  metadata.gz: 8bc688a815ec0c446b67a8f9a05bb742ff0ae19e9f3207b9241630b9d13acbd9
+  data.tar.gz: ee0357b235fabfdc886ad9821cd8d4d096a59d0016b4acbc6cfc32c88ca8bf96
 SHA512:
-  metadata.gz: 0a295acde72a3e8d5b6b5fb2161e3112041948e3979a740782b7b50df0b8a601f189e3f0fbebf11601a6f2096078acccbbf370298a24618952f4b47fe6f8cd44
-  data.tar.gz: a6fb5a2ee5cb6c2ca9473fc3b2295c313302d58154a7378091168445df000bdf6d7344f3ecb84c75df205e1f9907aba493145ec274eff1966979beb018e88eba
+  metadata.gz: c9f9617599a2ff972f648d986436bbc645a605fc5e2ac396ffadb4527cb189ac5a0af0dae1c10cafbcab69424c2f951e0e9a204b9823bdd90eaea68dee56e840
+  data.tar.gz: 471dd338d3caa975998bad5d77f03ee4c474801126825f13fb72a876d40e974583b9bba0dd9695c6d5cb96cd1533a3756aaa082e39bb8de287854d27ef6c288d

data/README.md

@@ -1,39 +1,68 @@
-# Json::Pie
+# JSON::Pie
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/json/pie`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Parse JSON:API data structures into Rails ActiveRecord structures.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'json-pie'
+```
+gem "json-pie"
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
+## Usage
 
-    $ gem install json-pie
+Your models:
 
-## Usage
+```ruby
+class User < ActiveRecord::Base
+  has_many :articles
+end
 
-TODO: Write usage instructions here
+class Article < ActiveRecord::Base
+  belongs_to :user
+end
+```
 
-## Development
+In your controller:
 
-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.
+```ruby
+class ArticleController
+  def create
+    article = JSON::Pie.parse params
+    article.save!
+    render json: article, status: :created
+  end
+end
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Then send this JSON structure to your application will create a new article with `#<User @id=1 ...>` as the author.
+
+```json
+{
+  "data": {
+    "type": "article",
+    "attributes": {
+      "title": "New article"
+    },
+    "relationships": {
+      "user": {
+        "data": {
+          "type": "user",
+          "id": 1
+        }
+      }
+    }
+  }
+}
+```
 
-## Contributing
+### Decoupling from your models
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json-pie.
+It's fairly easy to decouple the publis JSON:API that you parse from the actual data structure beneath by using the options.
 
-## License
+```ruby
+JSON::Pie.parse(params, **options)
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+| option | description |
+| ------ | ----------- |
+| `type_map` | A hash that maps JSON:API types to the actual models in your system. E.g. `{ author: :user }` |

data/lib/json/pie/version.rb

@@ -2,6 +2,6 @@
 
 module JSON
   module Pie
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-pie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Emil Kampp