lhs 3.3.6 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6e194ca0104d33690c704260ef36ef265ab9979
-  data.tar.gz: 63de1464cea6731ab54c58e01c5ef46d74d6b46c
+  metadata.gz: c6ba978add2aba0196bb5d98ecb6e114445db064
+  data.tar.gz: be48ebe2badd12166f55dac56e6579bef5fbed77
 SHA512:
-  metadata.gz: 71f0954b3bea0a23ba9f8c6169e86df4a92b4d81b8702f3634eeb770b9e989a0b4795703f2de97b533ffd521711fac0a54a5e540426978a55413c83c393f0cce
-  data.tar.gz: 84ac812bc020fe427adc6d34ae0d87a1c528701b8cb644da0bfe50b613e7a12dd7eb0bcf00c5c8b046afb024fb6d112cd36cbe729dbb2f89c39479fa8bb0e66b
+  metadata.gz: e96f1f2d0baa2658854f73222e50a7569ccc5afd4075614eaadb99f656afbe041f839ca7332f358a41e7e3fad18d5f30e1b90724ba4dac5dd9969ca42ceab61a
+  data.tar.gz: 960bce0293960b60fd428d80d272038db342001416ab93cd00f5715e3a7eb1ee96d1f7d28456dbbc89163e2f3e81e6611060bb596be8040c060086794a0cf0ab

data/README.md

@@ -368,7 +368,24 @@ Feedback.where(limit: 50, offset: 51)
 `limit` provides amount of items per page.
 `offset` provides how many items where skipped to start the current page.
 
-## Partial Kaminari support
+### Configure the name of the keys for offset, limit, total and name of items
+
+Endpoints provide different interfaces to deal with paginated resources.
+They differ for example for the key that is used for providing the current page items, the total amount of items, the current page size etc.
+In order to have `LHS::Record` deal with those different interfaces you can configure it:
+
+```ruby
+class Search < LHS::Record
+  configuration items: :docs, limit: :size, offset: :start, total: :totalResults
+  endpoint ':search/:type'
+end
+```
+`items` key used to determine items of the current page.
+`limit` key used to work with page limits.
+`offset` key used to paginate multiple pages.
+`total` key used to determine the total amount of items.
+
+### Partial Kaminari support
 
 LHS implements an interface that makes it partially working with Kaminari.
 
@@ -384,7 +401,7 @@ For example, you can use kaminari to render paginations based on LHS Records:
 = paginate @items
 ```
 
-## form_for Helper
+### form_for Helper
 Rails `form_for` view-helper can be used in combination with instances of LHS::Record to autogenerate forms:
 ```
 <%= form_for(@instance, url: '/create') do |f| %>

data/lib/lhs/collection.rb

@@ -7,17 +7,18 @@ class LHS::Collection < LHS::Proxy
   include InternalCollection
 
   delegate :select, to: :_collection
+  delegate :_record, to: :_data
 
   def total
-    _data._raw[:total]
+    _data._raw[_record.total_key]
   end
 
   def limit
-    _data._raw[:limit]
+    _data._raw[_record.limit_key]
   end
 
   def offset
-    _data._raw[:offset]
+    _data._raw[_record.offset_key]
   end
 
   def href
@@ -26,8 +27,8 @@ class LHS::Collection < LHS::Proxy
 
   def _collection
     raw = _data._raw if _data._raw.is_a?(Array)
-    raw ||= _data._raw[:items]
-    Collection.new(raw, _data, _data._record_class)
+    raw ||= _data._raw[_record.items_key]
+    Collection.new(raw, _data, _record)
   end
 
   delegate :_raw, to: :_data

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

@@ -7,8 +7,7 @@ class LHS::Item < LHS::Proxy
     extend ActiveSupport::Concern
 
     def destroy
-      record = _data._root._record_class
-      _data._request = record.request(method: :delete, url: href)._request
+      _data._request = _data.class.request(method: :delete, url: href)._request
       _data
     end
   end

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

@@ -14,7 +14,7 @@ class LHS::Item < LHS::Proxy
     end
 
     def save!
-      record = _data._root._record_class
+      record = _data.class
       data = _data._raw.dup
       url =
         if href.present?

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

@@ -14,9 +14,8 @@ class LHS::Item < LHS::Proxy
     end
 
     def update!(params)
-      record = _data._root._record_class
-      _data.merge_raw!(LHS::Data.new(params))
-      response_data = record.request(
+      _data.merge_raw!(LHS::Data.new(params, _data.parent, _data.class))
+      response_data = _data.class.request(
         method: :post,
         url: href,
         body: _data.to_json,

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

@@ -30,7 +30,7 @@ class LHS::Item < LHS::Proxy
     private
 
     def validation_endpoint
-      endpoint = _data._record_class.find_endpoint(_data._raw)
+      endpoint = _data._record.find_endpoint(_data._raw)
       endpoint ||= LHS::Endpoint.for_url(_data.href) if _data.href
       validates = endpoint.options && endpoint.options.fetch(:validates, false)
       fail 'Endpoint does not support validations!' unless validates

data/lib/lhs/concerns/record/all.rb

@@ -5,6 +5,8 @@ class LHS::Record
   module All
     extend ActiveSupport::Concern
 
+    DEFAULT_LIMIT = 100
+
     module ClassMethods
       # Should be an edge case but sometimes all objects from a certain resource
       # are required. In this case we load the first page with the default max limit,
@@ -12,12 +14,10 @@ class LHS::Record
       # for the following pages and concatenate all the results in order to return
       # all the objects for a given resource.
       def all(params = {})
-        all = []
-        default_max_limit = 100
-        data = request(params: params.merge(limit: default_max_limit))
-        all.concat(all_items_from(data))
-        request_all_the_rest(data, all, params) if data._raw.is_a?(Hash) && data._raw[:total]
-        data._record_class.new(LHS::Data.new(all, nil, self))
+        limit = params[limit_key] || DEFAULT_LIMIT
+        data = request(params: params.merge(limit_key => limit))
+        request_all_the_rest(data, params) if data._raw.is_a?(Hash) && data._raw[total_key]
+        data._record.new(LHS::Data.new(data, nil, self))
       end
 
       private
@@ -26,18 +26,23 @@ class LHS::Record
         if data._raw.is_a?(Array)
           data._raw
         else
-          data._raw[:items]
+          data._raw[items_key]
         end
       end
 
-      def request_all_the_rest(data, all, params)
-        total_left = data._raw[:total] - data.count
-        limit = data._raw[:limit] || data.count
+      def request_all_the_rest(data, params)
+        total_left = data._raw[total_key] - data.count
+        limit = data._raw[limit_key] || data.count
         if limit > 0
           requests = total_left / limit
           requests.times do |i|
             offset = limit * (i + 1) + 1
-            all.concat request(params: params.merge(limit: limit, offset: offset))._raw[:items]
+            data._raw[items_key].concat all_items_from request(
+              params: params.merge(
+                data._record.limit_key => limit,
+                data._record.offset_key => offset
+              )
+            )
           end
         end
       end

data/lib/lhs/concerns/record/batch.rb

@@ -8,10 +8,10 @@ class LHS::Record
     module ClassMethods
       # Process single entries fetched in batches
       def find_each(options = {})
-        find_in_batches(options) do |data|
-          data.each do |record|
-            item = LHS::Item.new(LHS::Data.new(record, data, self))
-            yield new(LHS::Data.new(item, data, self))
+        find_in_batches(options) do |records|
+          records.each do |record|
+            item = LHS::Item.new(record)
+            yield new(LHS::Data.new(item, records._data, self))
           end
         end
       end

data/lib/lhs/concerns/record/configuration.rb

@@ -0,0 +1,34 @@
+require 'active_support'
+
+class LHS::Record
+
+  # Allows configuring endpoints
+  # like which keys are used for the items, offset, total etc.
+  module Configuration
+    extend ActiveSupport::Concern
+
+    mattr_accessor :configuration
+
+    module ClassMethods
+      def configuration(args)
+        @configuration ||= args.freeze || {}
+      end
+
+      def items_key
+        @configuration.try(:[], :items) || :items
+      end
+
+      def limit_key
+        @configuration.try(:[], :limit) || :limit
+      end
+
+      def total_key
+        @configuration.try(:[], :total) || :total
+      end
+
+      def offset_key
+        @configuration.try(:[], :offset) || :offset
+      end
+    end
+  end
+end

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

@@ -13,13 +13,13 @@ class LHS::Record
         data = LHS::Data.new(json, nil, self, e.response.request)
         item = LHS::Item.new(data)
         item.errors = LHS::Errors.new(e.response)
-        data._record_class.new(LHS::Data.new(item, data))
+        data._record.new(LHS::Data.new(item, data))
       end
 
       def create!(data = {})
         url = compute_url!(data)
         data = request(url: url, method: :post, body: data.to_json, headers: { 'Content-Type' => 'application/json' })
-        data._record_class.new(data)
+        data._record.new(data)
       end
     end
   end

data/lib/lhs/concerns/record/endpoints.rb

@@ -31,7 +31,7 @@ class LHS::Record
 
       def for_url(url)
         return unless url
-        _template, record = LHS::Record::Endpoints.all.detect do |template, _record_class|
+        _template, record = LHS::Record::Endpoints.all.detect do |template, _|
           LHC::Endpoint.match?(url, template)
         end
         record

data/lib/lhs/concerns/record/find.rb

@@ -14,8 +14,8 @@ class LHS::Record
           else
             find_by_id(args)
           end
-        return data unless data._record_class
-        data._record_class.new(data)
+        return data unless data._record
+        data._record.new(data)
       end
 
       private

data/lib/lhs/concerns/record/find_by.rb

@@ -26,7 +26,7 @@ class LHS::Record
         if data._proxy.is_a?(LHS::Collection)
           data.first || fail(LHC::NotFound.new('No item was found.', data._request.response))
         else
-          data._record_class.new(data)
+          data._record.new(data)
         end
       end
     end

data/lib/lhs/concerns/record/where.rb

@@ -9,7 +9,7 @@ class LHS::Record
       # Used to query data from the service.
       def where(params = {})
         data = request(params: params)
-        data._record_class.new(data)
+        data._record.new(data)
       end
     end
   end

data/lib/lhs/data.rb

@@ -5,14 +5,16 @@ Dir[File.dirname(__FILE__) + '/concerns/data/*.rb'].each { |file| require file }
 class LHS::Data
   include Json
 
+  delegate :instance_methods, :items_key, :limit_key, :total_key, :offset_key, to: :class
+
   # prevent clashing with attributes of underlying data
-  attr_accessor :_proxy, :_raw, :_parent, :_record_class, :_request
+  attr_accessor :_proxy, :_raw, :_parent, :_record, :_request
 
   def initialize(input, parent = nil, record = nil, request = nil)
     self._raw = raw_from_input(input)
-    self._proxy = proxy_from_input(input)
-    self._record_class = record
     self._parent = parent
+    self._record = record
+    self._proxy = proxy_from_input(input)
     self._request = request
   end
 
@@ -30,7 +32,7 @@ class LHS::Data
   end
 
   def class
-    _root._record_class
+    _root._record
   end
 
   # enforce internal data structure to have deep symbolized keys
@@ -50,14 +52,14 @@ class LHS::Data
   end
 
   def respond_to_missing?(name, include_all = false)
-    (root_item? && _root._record_class.instance_methods.include?(name)) ||
+    (root_item? && instance_methods.include?(name)) ||
       _proxy.respond_to?(name, include_all)
   end
 
   private
 
   def collection_proxy?(input)
-    !! (input.is_a?(Hash) && input[:items]) || input.is_a?(Array) || _raw.is_a?(Array)
+    !! (input.is_a?(Hash) && input[items_key]) || input.is_a?(Array) || _raw.is_a?(Array)
   end
 
   def root_item

data/lib/lhs/endpoint.rb

@@ -2,7 +2,7 @@
 class LHS::Endpoint
 
   def self.for_url(url)
-    template, record = LHS::Record::Endpoints.all.detect do |template, _record_class|
+    template, record = LHS::Record::Endpoints.all.detect do |template, _record|
       LHC::Endpoint.match?(url, template)
     end
     record.endpoints.detect { |endpoint| endpoint.url == template } if record

data/lib/lhs/proxy.rb

@@ -17,8 +17,7 @@ class LHS::Proxy
 
   def reload!
     fail 'No href found' unless _data.href
-    record = _data._root._record_class
-    data = record.request(url: _data.href, method: :get)
+    data = _data.class.request(url: _data.href, method: :get)
     _data.merge_raw!(data)
     self._loaded = true
     self

data/lib/lhs/record.rb

@@ -3,6 +3,7 @@ Dir[File.dirname(__FILE__) + '/concerns/record/*.rb'].each { |file| require file
 class LHS::Record
   include All
   include Batch
+  include Configuration
   include Create
   include Endpoints
   include Find

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "3.3.6"
+  VERSION = "3.4.0"
 end

data/spec/collection/configurable_spec.rb

@@ -0,0 +1,44 @@
+require 'rails_helper'
+
+describe LHS::Collection do
+  let(:search) { 'http://local.ch/search' }
+  let(:limit) { 10 }
+  let(:total) { 20 }
+  let(:offset) { 0 }
+  let(:first_response_data) do
+    {
+      docs: (1..10).to_a,
+      start: offset,
+      size: limit,
+      totalResults: total
+    }
+  end
+  let(:second_response_data) do
+    {
+      docs: (11..20).to_a,
+      start: offset,
+      size: limit,
+      totalResults: total
+    }
+  end
+
+  before(:each) do
+    LHC.config.placeholder('search', search)
+    class Search < LHS::Record
+      configuration items: :docs, limit: :size, offset: :start, total: :totalResults
+      endpoint ':search/:type'
+    end
+    stub_request(:get, "http://local.ch/search/phonebook?size=10").to_return(body: first_response_data.to_json)
+    stub_request(:get, "http://local.ch/search/phonebook?size=10&start=11").to_return(body: second_response_data.to_json)
+  end
+
+  context 'lets you configure how to deal with collections' do
+    it 'initalises and gives access to collections according to configuration' do
+      results = Search.all(type: :phonebook, size: 10)
+      expect(results.count).to eq total
+      expect(results.total).to eq total
+      expect(results.limit).to eq limit
+      expect(results.offset).to eq offset
+    end
+  end
+end

data/spec/data/collection_spec.rb

@@ -6,7 +6,13 @@ describe LHS::Data do
   end
 
   let(:data) do
-    LHS::Data.new(json)
+    LHS::Data.new(json, nil, Record)
+  end
+
+  before(:each) do
+    class Record < LHS::Record
+      endpoint ':datastore/v2/data'
+    end
   end
 
   context 'collections' do

data/spec/data/raw_spec.rb

@@ -10,15 +10,12 @@ describe LHS::Data do
   end
 
   let(:data_from_raw) do
-    LHS::Data.new(
-      href: 'http://www.local.ch/v2/stuff',
-      id: '123123123'
-    )
+    LHS::Data.new({ href: 'http://www.local.ch/v2/stuff', id: '123123123' }, nil, Record)
   end
 
   let(:data_from_item) do
     raw = { href: 'http://www.local.ch/v2/stuff' }
-    item = LHS::Item.new(LHS::Data.new(raw))
+    item = LHS::Item.new(LHS::Data.new(raw, nil, Record))
     LHS::Data.new(item)
   end
 

data/spec/data/select_spec.rb

@@ -6,7 +6,13 @@ describe LHS::Data do
   end
 
   let(:data) do
-    LHS::Data.new(raw)
+    LHS::Data.new(raw, nil, Record)
+  end
+
+  before(:each) do
+    class Record < LHS::Record
+      endpoint ':datastore/v2/data'
+    end
   end
 
   context 'select' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 3.3.6
+  version: 3.4.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -186,6 +186,7 @@ files:
 - lib/lhs/concerns/item/validation.rb
 - lib/lhs/concerns/record/all.rb
 - lib/lhs/concerns/record/batch.rb
+- lib/lhs/concerns/record/configuration.rb
 - lib/lhs/concerns/record/create.rb
 - lib/lhs/concerns/record/endpoints.rb
 - lib/lhs/concerns/record/find.rb
@@ -207,6 +208,7 @@ files:
 - script/ci/build.sh
 - spec/.DS_Store
 - spec/collection/collection_items_spec.rb
+- spec/collection/configurable_spec.rb
 - spec/collection/delegate_spec.rb
 - spec/collection/enumerable_spec.rb
 - spec/collection/meta_data_spec.rb
@@ -331,6 +333,7 @@ summary: Rails gem providing an easy, active-record-like interface to use http b
   services
 test_files:
 - spec/collection/collection_items_spec.rb
+- spec/collection/configurable_spec.rb
 - spec/collection/delegate_spec.rb
 - spec/collection/enumerable_spec.rb
 - spec/collection/meta_data_spec.rb