json-pie 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63d4d0b3a9e543fbb77724003a4e00b54b4019fc4aa96effde7517ea40967bf
-  data.tar.gz: a355d4b17fe3ae44c243073d86da4766825d2db1b52d876d7e8fe034be90ecfe
+  metadata.gz: ab34b7f1268256832d6e98ca5fb7961696c6fd7263355d84282dda185a0e4744
+  data.tar.gz: 3131e5fb56bfd504a6eabb34da5c8976227429cec6563e1c7002eff297471cfd
 SHA512:
-  metadata.gz: 0a295acde72a3e8d5b6b5fb2161e3112041948e3979a740782b7b50df0b8a601f189e3f0fbebf11601a6f2096078acccbbf370298a24618952f4b47fe6f8cd44
-  data.tar.gz: a6fb5a2ee5cb6c2ca9473fc3b2295c313302d58154a7378091168445df000bdf6d7344f3ecb84c75df205e1f9907aba493145ec274eff1966979beb018e88eba
+  metadata.gz: 878597c4caf0040464f44cb9eff1ce193d7ebdeaf00f79b727e981fb2c98d4b9a528e913bf6911560a1a5481686bb7464f1ec2f92be371b7600cc6cc46fe0825
+  data.tar.gz: c380f9cdbaa22f8fc524e2e17f733d27fbd05d340c8ecc485816b67a575ba113eb4607fc857180ad070d6816ab11e13a8a6259c26158d242fb767b1a692e69bc

data/.rubocop.yml

@@ -24,3 +24,4 @@ Metrics/BlockLength:
   Exclude:
     - Guardfile
     - "**/*_spec.rb"
+    - json-pie.gemspec

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## [unreleased]
 
-## [0.1.0] - 2022-02-27
+## [0.0.4] - 2022-03-03
 
-- Initial release
+- Imporved public description of the gem
+
+## [0.0.3] - 2022-03-03
+
+- Allow data structure to define resource ID when creating a new resource.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json-pie (0.0.1)
+    json-pie (0.0.3)
       rails (<= 7.1)
 
 GEM

data/README.md

@@ -1,39 +1,71 @@
-# 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.
+Parse JSON:API data structures into Rails ActiveRecord structures.
 
-TODO: Delete this and the text above, and describe your gem
+![Tests](https://github.com/ekampp/json-pie/actions/workflows/tests.yml/badge.svg)
+![Linting](https://github.com/ekampp/json-pie/actions/workflows/linting.yml/badge.svg)
 
 ## 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/resource_identity.rb

@@ -14,9 +14,8 @@ module JSON
       def initialize(type:, id: nil, **options)
         @options = options
         klass = determine_type(type).to_s.classify.constantize
-        @instance = id ? klass.find(id) : klass.new
+        @instance = klass.find_or_initialize_by klass.primary_key => id
       rescue NameError
-        pp options
         raise JSON::Pie::InvalidType, "#{type}(#{id})"
       end
 

data/lib/json/pie/resource_object.rb

@@ -41,7 +41,7 @@ module JSON
       end
 
       def assign_attributes!
-        instance.attributes = data.fetch :attributes, {}
+        instance.attributes = attributes_tuple.to_h
       rescue ActiveModel::UnknownAttributeError
         raise JSON::Pie::InvalidAttribute
       end
@@ -51,6 +51,13 @@ module JSON
           instance: instance,
           relationships: data.fetch(:relationships, {})
       end
+
+      def attributes_tuple
+        data.fetch(:attributes, {}).collect do |key, value|
+          key = options.dig(:attributes_map, data.fetch(:type), key).presence || key
+          [key, value]
+        end
+      end
     end
   end
 end

data/lib/json/pie/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-pie
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Emil Kampp
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,10 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '7.1'
-description: Allow a Rails API to use the JSON:API interface
+description: |
+  Easily parse JSON:API data structures into ActiveRecord resources.
+
+  This will parse deeply nested relationships as well as attributes.
 email:
 - emil@kampp.me
 executables: []
@@ -73,5 +76,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: JSON:API rails plugin
+summary: Easily parse JSON:API structures into ActiveRecord resources
 test_files: []