lhs 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1020f5e98607e2dc01ebebe52f23961c9e9a4034
-  data.tar.gz: b15fddb284dcdca4254c155e07d09075a5dacfe4
+  metadata.gz: 2de08930a39d1136d185c43d33b8353abe09847d
+  data.tar.gz: 0ff2a9b46b4d66aece4ec6c7eeb33b5124511a5f
 SHA512:
-  metadata.gz: c0106d5e6468c5a81a60e3fe216406225fa937364884def8a8e1d5c6ce6065259c306909f7e25bea56eee9f8fbcf67df42490974ee672b2596dd23803c2e938f
-  data.tar.gz: 5a22af86fa15061d27946df81439b75a8dde9773be8d8ff7c7bceda700f50c632a3d1f75678408875ce6b916a7fbecaf40a331322cb68ad3c426a5657cfa9c80
+  metadata.gz: 047e5066a227d3631690a4f61d90c21fe9ca8424ee0361713a552700ca54f890fbb7f4de58654de3b12ac8f819e6fe1a673c4588a89d9aee61221fb9c89e414f
+  data.tar.gz: 8ca3222a86205b07a1e853073f365729137c941642c4b500f359c4a9b70dd68d3d4e8463deec067fb46c51ce988136cd8675e5f82fb79b9cf2b26d26cfff0ae8

data/README.md

@@ -282,6 +282,80 @@ When creation fails, the object contains errors. It provides them through the `e
   record.errors.message # ratings must be set when review or name or review_title is set | The property value is required; it cannot be null, empty, or blank."
 ```
 
+## Create records through associations (nested resources)
+
+```ruby
+  class Review < LHS::Record
+    endpoint ':service/reviews'
+  end 
+
+  class Comment < LHS::Record
+    endpoint ':service/reviews/:review_id/comments'
+  end
+```
+
+### Item
+```ruby
+  review = Review.find(1)
+  # Review#1
+  # :href => ':service/reviews/1
+  # :text => 'Simply awesome'
+  # :comment => { :href => ':service/reviews/1/comments }
+
+  review.comment.create(text: 'Thank you!')
+  # Comment#1
+  # :href => ':service/reviews/1/comments
+  # :text => 'Thank you!'
+
+  review
+  # Review#1
+  # :href => ':service/reviews/1
+  # :text => 'Simply awesome'
+  # :comment => { :href => ':service/reviews/1/comments, :text => 'Thank you!' }
+```
+
+If the item already exists `ArgumentError` is raised.
+
+### Expanded collection
+```ruby
+  review = Review.includes(:comments).find(1)
+  # Review#1
+  # :href => ':service/reviews/1'
+  # :text => 'Simply awesome'
+  # :comments => { :href => ':service/reviews/1/comments, :items => [] }
+
+  review.comments.create(text: 'Thank you!')
+  # Comment#1
+  # :href => ':service/reviews/1/comments/1'
+  # :text => 'Thank you!'
+
+  review
+  # Review#1
+  # :href => ':service/reviews/1'
+  # :text => 'Simply awesome'
+  # :comments => { :href => ':service/reviews/1/comments, :items => [{ :href => ':service/reviews/1/comments/1', :text => 'Thank you!' }] }
+```
+
+### Not expanded collection
+```ruby
+  review = Review.find(1)
+  # Review#1
+  # :href => ':service/reviews/1'
+  # :text => 'Simply awesome'
+  # :comments => { :href => ':service/reviews/1/comments' }
+
+  review.comments.create(text: 'Thank you!')
+  # Comment#1
+  # :href => ':service/reviews/1/comments/1'
+  # :text => 'Thank you!'
+
+  review
+  # Review#1
+  # :href => ':service/reviews/1
+  # :text => 'Simply awesome'
+  # :comments => { :href => ':service/reviews/1/comments', :items => [{ :href => ':service/reviews/1/comments/1', :text => 'Thank you!' }] }
+```
+
 ## Build new records
 
 Build and persist new items from scratch are done either with `new` or it's alias `build`.

data/lib/lhs/collection.rb

@@ -5,6 +5,7 @@ Dir[File.dirname(__FILE__) + '/concerns/collection/*.rb'].each { |file| require
 # that contains multiple items
 class LHS::Collection < LHS::Proxy
   include InternalCollection
+  include Create
 
   delegate :select, :length, :size, to: :_collection
   delegate :_record, :_raw, to: :_data
@@ -28,6 +29,10 @@ class LHS::Collection < LHS::Proxy
     true
   end
 
+  def item?
+    false
+  end
+
   protected
 
   def method_missing(name, *args, &block)

data/lib/lhs/concerns/collection/internal_collection.rb

@@ -12,7 +12,8 @@ class LHS::Collection < LHS::Proxy
       include Enumerable
 
       attr_accessor :raw
-      delegate :length, :size, :last, :sample, :[], :present?, :blank?, :empty?, to: :raw
+      delegate :length, :size, :last, :sample, :[], :present?, :blank?, :empty?,
+               :<<, :push, to: :raw
 
       def initialize(raw, parent, record)
         self.raw = raw

data/lib/lhs/concerns/item/validation.rb

@@ -32,7 +32,7 @@ class LHS::Item < LHS::Proxy
 
     def merge_validation_params!(endpoint)
       validates_params = endpoint.options[:validates].select { |key, _| key.to_sym != :path }
-      params = endpoint.options.fetch(:params, {}).merge(params_from_embeded_href)
+      params = endpoint.options.fetch(:params, {}).merge(params_from_link)
       params = params.merge(validates_params) if validates_params.is_a?(Hash)
       params
     end
@@ -50,20 +50,11 @@ class LHS::Item < LHS::Proxy
     end
 
     def validation_endpoint
-      endpoint = embeded_endpoint if _data.href # take embeded first
+      endpoint = endpoint_from_link if _data.href # take embeded first
       endpoint ||= _data._record.find_endpoint(_data._raw)
       validates = endpoint.options && endpoint.options.fetch(:validates, false)
       raise 'Endpoint does not support validations!' unless validates
       endpoint
     end
-
-    def embeded_endpoint
-      LHS::Endpoint.for_url(_data.href)
-    end
-
-    def params_from_embeded_href
-      return {} if !_data.href || !embeded_endpoint
-      LHC::Endpoint.values_as_params(embeded_endpoint.url, _data.href)
-    end
   end
 end

data/lib/lhs/concerns/proxy/create.rb

@@ -0,0 +1,43 @@
+require 'active_support'
+
+class LHS::Proxy
+
+  module Create
+    extend ActiveSupport::Concern
+
+    def create(data = {}, options = nil)
+      record_creation!(options) do
+        record_from_link.create(
+          data,
+          options_for_creation(options)
+        )
+      end
+    end
+
+    def create!(data = {}, options = nil)
+      record_creation!(options) do
+        record_from_link.create!(
+          data,
+          options_for_creation(options)
+        )
+      end
+    end
+
+    private
+
+    def record_creation!(options)
+      raise(ArgumentError, 'Record already exists') if _raw.keys != [:href] && item?
+
+      record = yield
+      # Needed to handle unexpanded collection which looks the same as item
+      reload!(options) if record.errors.empty?
+      record
+    end
+
+    def options_for_creation(options)
+      return options if params_from_link.blank?
+      options = {} if options.blank?
+      options.deep_merge(params: params_from_link)
+    end
+  end
+end

data/lib/lhs/concerns/proxy/link.rb

@@ -0,0 +1,24 @@
+require 'active_support'
+# require File.dirname(__FILE__) + '/../../proxy'
+
+class LHS::Proxy
+
+  module Link
+    extend ActiveSupport::Concern
+
+    private
+
+    def record_from_link
+      LHS::Record.for_url(_data.href)
+    end
+
+    def endpoint_from_link
+      LHS::Endpoint.for_url(_data.href)
+    end
+
+    def params_from_link
+      return {} if !_data.href || !endpoint_from_link
+      LHC::Endpoint.values_as_params(endpoint_from_link.url, _data.href)
+    end
+  end
+end

data/lib/lhs/item.rb

@@ -4,6 +4,7 @@ Dir[File.dirname(__FILE__) + '/concerns/item/*.rb'].each { |file| require file }
 # An item is a concrete record.
 # It can be part of another proxy like collection.
 class LHS::Item < LHS::Proxy
+  include Create
   include Destroy
   include Save
   include Update
@@ -21,6 +22,10 @@ class LHS::Item < LHS::Proxy
     super(data)
   end
 
+  def collection?
+    false
+  end
+
   def item?
     true
   end

data/lib/lhs/proxy.rb

@@ -1,7 +1,12 @@
+Dir[File.dirname(__FILE__) + '/concerns/proxy/*.rb'].each { |file| require file }
+
 # Proxy makes different kind of data accessible
 # If href is present it also alows loading/reloading
 class LHS::Proxy
 
+  include Create
+  include Link
+
   # prevent clashing with attributes of underlying data
   attr_accessor :_data, :_loaded
 
@@ -10,17 +15,18 @@ class LHS::Proxy
     self._loaded = false
   end
 
-  def load!
+  def load!(options = nil)
     return self if _loaded
-    reload!
+    reload!(options)
   end
 
-  def reload!
+  def reload!(options = nil)
     raise 'No href found' unless _data.href
-    data = _data.class.request(url: _data.href, method: :get)
+    options = {} if options.blank?
+
+    data = _data.class.request(options.merge(url: _data.href, method: :get))
     _data.merge_raw!(data)
     self._loaded = true
     self
   end
-
 end

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "7.1.0"
+  VERSION = "7.2.0"
 end

data/spec/proxy/create_sub_resource_spec.rb

@@ -0,0 +1,180 @@
+require 'rails_helper'
+
+describe LHS::Item do
+  before(:each) do
+    class Feedback < LHS::Record
+      endpoint 'http://datastore/v2/feedbacks/:id'
+    end
+
+    class Review < LHS::Record
+      endpoint 'http://datastore/v2/feedbacks/:feedback_id/reviews'
+    end
+  end
+
+  context 'create sub-resource' do
+    let!(:create_review_request) do
+      stub_request(:post, "http://datastore/v2/feedbacks/1/reviews")
+        .to_return(body: {
+          href: 'http://datastore/v2/feedbacks/1/reviews/1',
+          title: 'Simply awesome'
+        }.to_json)
+    end
+
+    context 'for a nested item' do
+      let(:feedback) { Feedback.find(1) }
+      let(:review) do
+        feedback.review.create(
+          title: 'Simply awesome'
+        )
+      end
+
+      before do
+        stub_request(:get, "http://datastore/v2/feedbacks/1/reviews")
+          .to_return(body: {
+            href: 'http://datastore/v2/feedbacks/1/reviews',
+            title: 'Simply awesome'
+          }.to_json)
+      end
+
+      context 'without the object' do
+        before(:each) do
+          stub_request(:get, "http://datastore/v2/feedbacks/1")
+            .to_return(body: {
+              review: {
+                href: 'http://datastore/v2/feedbacks/1/reviews'
+              }
+            }.to_json)
+        end
+
+        it 'creates an item' do
+          review
+          assert_requested(create_review_request)
+
+          expect(feedback.review.title).to eq 'Simply awesome'
+          expect(review.title).to eq 'Simply awesome'
+        end
+      end
+
+      context 'with existing item' do
+        before(:each) do
+          stub_request(:get, "http://datastore/v2/feedbacks/1")
+            .to_return(body: {
+              review: {
+                href: 'http://datastore/v2/feedbacks/1/reviews',
+                title: 'Simply awesome'
+              }
+            }.to_json)
+        end
+
+        it 'raises error' do
+          expect { review }.to raise_error(ArgumentError)
+
+          assert_not_requested(create_review_request)
+        end
+      end
+    end
+
+    context 'for a nested collection' do
+      let(:review) do
+        feedback.reviews.create(
+          title: 'Simply awesome'
+        )
+      end
+
+      before do
+        stub_request(:get, "http://datastore/v2/feedbacks/1/reviews")
+          .to_return(body: {
+            items: [{
+              href: 'http://datastore/v2/feedbacks/1/reviews/1',
+              title: 'Simply awesome'
+            }]
+          }.to_json)
+      end
+
+      context 'when expanded' do
+        before(:each) do
+          stub_request(:get, "http://datastore/v2/feedbacks/1")
+            .to_return(body: {
+              reviews: {
+                href: 'http://datastore/v2/feedbacks/1/reviews',
+                items: []
+              }
+            }.to_json)
+        end
+
+        let(:feedback) { Feedback.includes(:reviews).find(1) }
+
+        it 'creates an item' do
+          review
+          assert_requested(create_review_request)
+
+          expect(feedback.reviews.first.title).to eq 'Simply awesome'
+          expect(review.title).to eq 'Simply awesome'
+        end
+      end
+
+      context 'when not expanded' do
+        before(:each) do
+          stub_request(:get, "http://datastore/v2/feedbacks/1")
+            .to_return(body: {
+              reviews: {
+                href: 'http://datastore/v2/feedbacks/1/reviews'
+              }
+            }.to_json)
+        end
+
+        let(:feedback) { Feedback.find(1) }
+
+        it 'creates an item' do
+          review
+          assert_requested(create_review_request)
+
+          expect(feedback.reviews.first.title).to eq 'Simply awesome'
+          expect(review.title).to eq 'Simply awesome'
+        end
+      end
+    end
+  end
+
+  context 'error messages' do
+    let!(:create_review_request) do
+      stub_request(:post, "http://datastore/v2/feedbacks/1/reviews")
+        .to_return(
+          status: 400,
+          body: {
+            status: 400,
+            message: 'Validation failed',
+            field_errors: [{
+              code: 'UNSATISFIED_PROPERTY_VALUE_MAXIMUM_LENGTH',
+              path: ['title'],
+              message: 'Title is too long'
+            }]
+          }.to_json
+        )
+    end
+
+    let(:feedback) { Feedback.find(1) }
+    let(:review) do
+      feedback.review.create(
+        title: 'Simply awesome'
+      )
+    end
+
+    before do
+      stub_request(:get, "http://datastore/v2/feedbacks/1")
+        .to_return(body: {
+          review: {
+            href: 'http://datastore/v2/feedbacks/1/reviews'
+          }
+        }.to_json)
+    end
+
+    it 'are propagated when creation fails' do
+      review
+      assert_requested(create_review_request)
+
+      expect(review.title).to eq 'Simply awesome'
+      expect(review.errors.messages[:title]).to include('UNSATISFIED_PROPERTY_VALUE_MAXIMUM_LENGTH')
+    end
+  end
+end

data/spec/proxy/load_spec.rb

@@ -54,10 +54,22 @@ describe LHS::Proxy do
       AnotherRecord.new(href: 'http://datastore/v2/feedbacks')
     end
 
-    it 'applys endpoint options on load!' do
+    it 'applies endpoint options on load!' do
       stub_request(:get, 'http://datastore/v2/feedbacks?color=blue')
         .to_return(body: {}.to_json)
       record.load!
     end
   end
+
+  context 'per request options' do
+    let(:record) do
+      Record.new(href: 'http://datastore/v2/feedbacks')
+    end
+
+    it 'applies options passed to load' do
+      stub_request(:get, 'http://datastore/v2/feedbacks?color=blue')
+        .to_return(body: {}.to_json)
+      record.load!(params: { color: 'blue' })
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -202,6 +202,8 @@ files:
 - lib/lhs/concerns/item/save.rb
 - lib/lhs/concerns/item/update.rb
 - lib/lhs/concerns/item/validation.rb
+- lib/lhs/concerns/proxy/create.rb
+- lib/lhs/concerns/proxy/link.rb
 - lib/lhs/concerns/record/all.rb
 - lib/lhs/concerns/record/batch.rb
 - lib/lhs/concerns/record/chainable.rb
@@ -301,6 +303,7 @@ files:
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
 - spec/pagination/pages_left_spec.rb
+- spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/rails_helper.rb
 - spec/record/all_spec.rb
@@ -373,7 +376,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Ruby >= 2.0.0
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Rails gem providing an easy, active-record-like interface for http json services
@@ -451,6 +454,7 @@ test_files:
 - spec/item/update_spec.rb
 - spec/item/validation_spec.rb
 - spec/pagination/pages_left_spec.rb
+- spec/proxy/create_sub_resource_spec.rb
 - spec/proxy/load_spec.rb
 - spec/rails_helper.rb
 - spec/record/all_spec.rb