json_api_model 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8108fc0f24c943231c25e571dd4e53bbdd7c81b
-  data.tar.gz: 514bc267aaea9904075f23c714e997ad7c6a3632
+  metadata.gz: b3324fc4a9bc44c2e4f35bb8bfc07c85fa37d9b9
+  data.tar.gz: 8b131250bc286d8c6e6e7fbe3c47064d65f63942
 SHA512:
-  metadata.gz: 280163fa58e09398bf0798928a81040d178a3d35e202e2423b136ebde61cc0bae6e2ed4f1d48c1d25909ed81ee744ba47206aede851e6ab1292f7969ad789082
-  data.tar.gz: 5d01cb61d2fdf30de41080617bdc73d61b332b09d5d53942934d388351fb3839335afb65589251b07c62136ddd204bb82b0655b7db59c7b9cde2cc7f3e07bb6d
+  metadata.gz: f7338edaeb52f641a1b942c8d603c81274de36f91f9d4fd25b3d87b9d920b11baf240b4d0e829e2c0e737cbc02b7c313d2d9faa7177e83996822a70185e97ab8
+  data.tar.gz: 99f5989402ddff1c256cb6753347356e0f8fb7945d371e4993866c3d700bea5f3bbf06f7fa271b330359b1c7602cdacbe09119e01115187635b29d46a3319dc4

data/README.md

@@ -1,8 +1,8 @@
 # JsonApiModel
 
-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_api_model`. To experiment with that code, run `bin/console` for an interactive prompt.
+Much like `ActiveRecord` is an ORM on top of your database, [`JSON API Client`](https://github.com/JsonApiClient/json_api_client) is an ORM specific to a service. This gem is the `app/models/` on top of `json_api_client`. 
 
-TODO: Delete this and the text above, and describe your gem
+Yes, you can put business in the client, but if you need to distrubute the gem, you will want that to live somewhere else. This gem provides a thin wrapper layer to let you do that. 
 
 ## Installation
 
@@ -22,7 +22,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: finish writing this
+
+Sample Base Class
+
+```ruby
+module MyService
+  class Base < JsonApiModel::Model
+
+    wraps MyService::Client::Base
+
+    # delegates connection options to the Client::Base without having to modify the gem
+    self.connection do | conn |
+      conn.use Faraday::Response::Logger, Rails.logger
+
+      conn.faraday.options.merge!(
+        open_timeout: 5,
+        timeout: 5
+      )
+    end
+  end
+end
+```
+
+Inherited Class
+
+```ruby
+module MySerive
+  class MyModel < Base
+    wraps MyService::Client::MyModel
+
+    def instanece_level_business
+      42
+    end
+  end
+end
+```
+
+In the controller
+
+```ruby
+class WhateversController < ApplicationController
+  def index
+    render json: MyService::MyModel.where( request.query_parameters ).all.as_json
+  end
+end
+```
+
 
 ## Development
 

data/lib/json_api_model/result_set.rb

@@ -4,7 +4,7 @@ module JsonApiModel
       @set = client_result_set
     end
 
-    def as_json
+    def as_json( opts = {} )
       if block_given?
         yield @set, meta
       else

data/lib/json_api_model/version.rb

@@ -1,3 +1,3 @@
 module JsonApiModel
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_model
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client