json_api_model 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3324fc4a9bc44c2e4f35bb8bfc07c85fa37d9b9
-  data.tar.gz: 8b131250bc286d8c6e6e7fbe3c47064d65f63942
+  metadata.gz: c0c2e854a3a779030b0ab788040d6481ec4f72c8
+  data.tar.gz: 0bac3b49d6310dca35407b67411e615d6d422643
 SHA512:
-  metadata.gz: f7338edaeb52f641a1b942c8d603c81274de36f91f9d4fd25b3d87b9d920b11baf240b4d0e829e2c0e737cbc02b7c313d2d9faa7177e83996822a70185e97ab8
-  data.tar.gz: 99f5989402ddff1c256cb6753347356e0f8fb7945d371e4993866c3d700bea5f3bbf06f7fa271b330359b1c7602cdacbe09119e01115187635b29d46a3319dc4
+  metadata.gz: 4733844d6db1d48f8353d0e384bdfaa8e3695e51260668bdf546ca9e7c625ea21d218c295f5f663df34628301392d3d20517c7d8619559a7d5d3e67189e843db
+  data.tar.gz: 92d708f1e39de4cdb028785cc489edc3029b8c99e5d8631129500e225d62dfeca65d60a506fa30bd0f6f9f104d602e658f0055d01ef29cf32b68f5a76b823910

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    json_api_model (0.1.1)
+      json_api_client
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.3.1)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    json_api_client (1.5.3)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      addressable (~> 2.2)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  json_api_model!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -20,11 +20,94 @@ Or install it yourself as:
 
     $ gem install json_api_model
 
+## Disclaimer
+
+This is a work in progress. Right now only fetching data works. This will soon change.
+
 ## Usage
 
-TODO: finish writing this
+Using the model wrappers is pretty straighforward. It thinly wraps `JsonApiClient` to separate communication defintions from your in-app business specific logic. To specify what client class your model is wrapping, use the `wraps` method.
+
+Any instance or class(non-query) level method will fall thorugh to the client.
+
+### Example
+
+If you have an app that talks to a `user` service. Here's how your `User` model might look:
+
+```ruby
+module UserService
+  class User < JsonApiModel::Model
+    wraps UserService::Client::User
+
+    def lucky_number
+      42
+    end
+  end
+end
+```
+
+And the interaction with it is not that different from how you would work with the client:
+
+```ruby
+# fetching looks identical to as json_api_client (because it thinly wraps it)
+user = UserService::User.where( id: 8 ).first
+
+# now you can access your app logic
+user.lucky_number
+
+# => 42
+
+# but also transparently access the client properties
+user.id
+# => 8
+```
+
+### Rendering
+
+If you need to propagate your response set up, `JsonApiModel` adds `as_json` handling so that:
+
+```ruby
+class WhateversController < ApplicationController
+  def index
+    render json: MyService::MyModel.where( params ).all
+  end
+end
+```
+
+Would produce the standard JSONAPI response of:
+
+```ruby
+{
+  data: data,
+  meta: meta
+}
+```
+
+But if that's not the structure you want, you can modify the `to_json` output as:
+
+```ruby
+class MyModelInRussianConroller < ApplicationController
+
+  def индекс
+    @response = MyModel.where( params ).all
+
+    @response.as_json do |data, meta|
+      {
+        данные: data,
+        мета: {
+          счёт: meta["record_count"],
+          страницы: meta["page_count"]
+        }
+      }
+    end
+  end
+end
+```
+
+
+### Configuration
 
-Sample Base Class
+If you don't want to override the connection configuration of the client gem in an initializer, you can modify the connection options inside an inhrited class.
 
 ```ruby
 module MyService
@@ -45,31 +128,40 @@ module MyService
 end
 ```
 
-Inherited Class
+### Monitoring
 
-```ruby
-module MySerive
-  class MyModel < Base
-    wraps MyService::Client::MyModel
+`JsonApiModel` emits several `ActiveSupport::Notifications` events you can subscribe to:
 
-    def instanece_level_business
-      42
-    end
-  end
-end
-```
+* `find.json_api_model`: fires on every `find`/`all`/`to_a` call. Probably most common.
+
+  | key  | value |
+  |------|-------|
+  | url  | full url hit |
+  | args | args passed into the requestor |
 
-In the controller
+* `first.json_api_model`: fires on `Model.first`
+  
+  | key  | value |
+  |------|-------|
+  | url  | full url hit |
+
+* `last.json_api_model`: fired on `Model.last`
+  
+  | key  | value |
+  |------|-------|
+  | url  | full url hit |
+
+**NOTE**: By default the instrumenter is null, so be sure to configure your app to actually have a notifier and subscribe to the events
 
 ```ruby
-class WhateversController < ApplicationController
-  def index
-    render json: MyService::MyModel.where( request.query_parameters ).all.as_json
-  end
+# config/initializers/json_api_model.rb
+JsonApiModel.instrumenter = ActiveSupport::Notifications.instrumenter
+
+ActiveSupport::Notifications.subscribe "find.json_api_model" do |name, started, finished, unique_id, payload|
+  Rails.logger.debug ['notification:', name, started, finished, unique_id, payload].join(' ')
 end
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -78,7 +170,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/json_api_model. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/gaorlov/json_api_model. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -86,4 +178,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the JsonApiModel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/json_api_model/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the JsonApiModel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gaorlov/json_api_model/blob/master/CODE_OF_CONDUCT.md).

data/json_api_model.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webmock"
 end

data/lib/json_api_model/model.rb

@@ -13,6 +13,7 @@ module JsonApiModel
       def new_from_client( client )
         model = new
         model.client = client
+        model
       end
 
       def connection( &block )
@@ -26,7 +27,7 @@ module JsonApiModel
       end
     end
 
-    attr_reader :client
+    attr_accessor :client
 
     def initialize( attributes = {} )
       @client = self.class.client_class.new( attributes )
@@ -36,10 +37,10 @@ module JsonApiModel
       client.send m, *args, &block
     end
 
-    private
-
-    def client=( client )
-      @client = client
+    def as_json
+      client.as_json
     end
+
+    RESERVED_FIELDS = [ :type, :id ]
   end
 end

data/lib/json_api_model/result_set.rb

@@ -1,14 +1,17 @@
 module JsonApiModel
   class ResultSet
-    def initialize( client_result_set, resource_class )
-      @set = client_result_set
+    def initialize( client_result_set, model_class )
+      @set = client_result_set.clone
+      @set.map! do | resource |
+        model_class.new_from_client( resource )
+      end
     end
 
     def as_json( opts = {} )
       if block_given?
         yield @set, meta
       else
-        { data: @set,
+        { data: @set.map(&:as_json),
           meta: meta
         }
       end

data/lib/json_api_model/scope.rb

@@ -1,8 +1,8 @@
 module JsonApiModel
   class Scope
-    def initialize( resource_class )
-      @resource_class = resource_class
-      @client_scope   = JsonApiClient::Query::Builder.new( resource_class.client_class )
+    def initialize( model_class )
+      @model_class = model_class
+      @client_scope   = JsonApiClient::Query::Builder.new( model_class.client_class )
     end
 
     def to_a
@@ -17,24 +17,24 @@ module JsonApiModel
                                             args: args,
                                             url: url do
         results = @client_scope.find args
-        ResultSet.new( results, @resource_class )
+        ResultSet.new( results, @model_class )
       end
     end
 
     def first
       JsonApiModel.instrumenter.instrument 'first.json_api_model', url: url do
-        @resource_class.new_from_client @client_scope.first
+        @model_class.new_from_client @client_scope.first
       end
     end
 
     def last
       JsonApiModel.instrumenter.instrument 'last.json_api_model', url: url do
-        @resource_class.new_from_client @client_scope.last
+        @model_class.new_from_client @client_scope.last
       end
     end
 
     def build
-      @resource_class.new_from_client @client_scope.build
+      @model_class.new_from_client @client_scope.build
     end
 
     def params
@@ -53,7 +53,7 @@ module JsonApiModel
     private
 
     def url
-      @resource_class.client_class.requestor.send( :resource_path, params )
+      @model_class.client_class.requestor.send( :resource_path, params )
     end
   end
 end

data/lib/json_api_model/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Greg Orlov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-11 00:00:00.000000000 Z
+date: 2018-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.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: webmock
+  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'
 description: 
 email:
 - gaorlov@gmail.com
@@ -77,6 +105,7 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile