lhs 5.7.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8fe4ac73d6355f5299f3f30b469f2e13fb15bfe
-  data.tar.gz: fefa077f115710e969b0f09d5e82c0b9bde6e0dd
+  metadata.gz: 1375879a321c15e499ad2871e21ab93cda9b386b
+  data.tar.gz: dfa739b88f8c0f26bd47ce4722a9d145fb479ecd
 SHA512:
-  metadata.gz: 344f8f4704e193a8185f4f78a341afb80d160a59e52ae33845f8c9d8ee09f929aa2f3aa4401cd704a20e589316c7d425f8ad719e4d8b915849b3a28c654835c1
-  data.tar.gz: 79ea9e5130c14c4a0403ba11848f799d7f0d7015a4fea2b2a83c565981c223c686d16b617faa181f50cd26454a2aac2429b1b2a14e6127d5b8462eaf302e4d44
+  metadata.gz: b457566f62fc9aae5f60287eae881b2a5cf2cf46c2de118a283b301d20b6d98126d93f816d46a70ed4714bb485dd0a2d971f022846864e91eb58764802779232
+  data.tar.gz: da2266a749937a72f6fb2510c054024c1f2171493a7a05c4cdf7321b4e2af45aaf67229adc756d9e4f7da7aedd360d47638a6a2fc56e7dadac947959561018bc

data/README.md

@@ -174,6 +174,7 @@ After fetching [single](#find-single-records) or [multiple](#find-multiple-recor
 You can apply options to the request chain. Those options will be forwarded to the request perfomed by the chain/query.
 
 ```ruby
+  # Authenticate with OAuth
   options = { auth: { bearer: '123456' } }
   
   AuthenticatedRecord = Record.options(options)
@@ -365,22 +366,22 @@ After include:
 
 When including linked resources with `includes`, known/defined services and endpoints are used to make those requests.
 That also means that options for endpoints of linked resources are applied when requesting those in addition.
-This allows you to include protected resources (e.g. OAuth) as endpoint options for oauth authentication get applied.
+This allows you to include protected resources (e.g. Basic auth) as endpoint options for oauth authentication get applied.
 
 The [Auth Inteceptor](https://github.com/local-ch/lhc-core-interceptors#auth-interceptor) from [lhc-core-interceptors](https://github.com/local-ch/lhc-core-interceptors) is used to configure the following endpoints.
 
 ```ruby
 class Favorite < LHS::Record
 
-  endpoint ':datastore/:user_id/favorites', auth: { bearer: -> { bearer_token } }
-  endpoint ':datastore/:user_id/favorites/:id', auth: { bearer: -> { bearer_token } }
+  endpoint ':datastore/:user_id/favorites', auth: { basic: { username: 'steve', password: 'can' } }
+  endpoint ':datastore/:user_id/favorites/:id', auth: { basic: { username: 'steve', password: 'can' } }
 
 end
 
 class Place < LHS::Record
 
-  endpoint ':datastore/v2/places', auth: { bearer: -> { bearer_token } }
-  endpoint ':datastore/v2/places/:id', auth: { bearer: -> { bearer_token } }
+  endpoint ':datastore/v2/places', auth: { basic: { username: 'steve', password: 'can' } }
+  endpoint ':datastore/v2/places/:id', auth: { basic: { username: 'steve', password: 'can' } }
 
 end
 
@@ -388,6 +389,16 @@ Favorite.includes(:place).where(user_id: current_user.id)
 # Will include places and applies endpoint options to authenticate the request.
 ```
 
+### Forward options used for request made to include referenced resources
+
+Provide options to the requests made to include referenced resources:
+
+```
+
+  Favorite.includes(:place).references(place: { auth: { bearer: '123' }})
+
+```
+
 ## Map data
 
 To influence how data is accessed/provied, you can use mappings to either map deep nested data or to manipulate data when its accessed. Simply create methods inside the LHS::Record. They can access underlying data:
@@ -629,3 +640,7 @@ The behaviour of `count` and `length` is based on ActiveRecord's behaviour.
 `count` Determine the number of elements by taking the number of total elements that is provided by the endpoint/api.
 
 `length` This returns the number of elements loaded from an endpoint/api. In case of paginated resources this can be different to count, as it depends on how many pages have been loaded.
+
+## License
+
+[GNU Affero General Public License Version 3.](https://www.gnu.org/licenses/agpl-3.0.en.html)

data/lhs.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |s|
   s.test_files   = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
 
-  s.requirements << 'Ruby >= 1.9.2'
-  s.required_ruby_version = '>= 1.9.2'
+  s.requirements << 'Ruby >= 2.0.0'
+  s.required_ruby_version = '>= 2.0.0'
 
   s.add_dependency 'lhc', '>= 3.5.2'
   s.add_dependency 'lhc-core-interceptors', '>= 2.0.1'
@@ -31,4 +31,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'ciderizer'
   s.add_development_dependency 'capybara'
+  
+  s.license = 'GPL-3'
 end

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

@@ -5,22 +5,35 @@ class LHS::Record
   module Includes
     extend ActiveSupport::Concern
 
+    included do
+      cattr_accessor :including, :referencing
+    end
+
     module ClassMethods
-      def including
-        @including
+      def includes(*args)
+        class_clone_factory(args).tap do |class_clone|
+          class_clone.including = unfold_args(args)
+        end
       end
 
-      def including=(including)
-        @including = including
+      def references(*args)
+        class_clone_factory(args).tap do |class_clone|
+          class_clone.referencing = unfold_args(args)
+        end
       end
 
-      def includes(*args)
+      private
+
+      def unfold_args(args)
+        args.size == 1 ? args[0] : args
+      end
+
+      def class_clone_factory(args)
         name = "#{self}#{args.object_id}"
         constant = Object.const_set(name.demodulize, self.dup) # rubocop:disable Style/RedundantSelf
         class_clone = constant
         class_clone.endpoints = endpoints
         class_clone.mapping = mapping
-        class_clone.including = args.size == 1 ? args[0] : args
         class_clone
       end
     end

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

@@ -19,20 +19,19 @@ class LHS::Record
       # Convert URLs in options to endpoint templates
       def convert_options_to_endpoints(options)
         if options.is_a?(Array)
-          options.map { |option| convert_option_to_endpoints(option) }
+          options.map { |request_options| convert_options_to_endpoint(request_options) }
         else
-          convert_option_to_endpoints(options)
+          convert_options_to_endpoint(options)
         end
       end
 
-      def convert_option_to_endpoints(option)
-        return unless option.present?
-        new_options = option.dup
-        url = option[:url]
+      def convert_options_to_endpoint(options)
+        return unless options.present?
+        url = options[:url]
         endpoint = LHS::Endpoint.for_url(url)
         return unless endpoint
         template = endpoint.url
-        new_options = new_options.merge(params: LHC::Endpoint.values_as_params(template, url))
+        new_options = options.deep_merge(params: LHC::Endpoint.values_as_params(template, url))
         new_options[:url] = template
         new_options
       end
@@ -80,17 +79,18 @@ class LHS::Record
         end
       end
 
-      def handle_includes(includes, data)
+      def handle_includes(includes, data, references = {})
+        references ||= {}
         if includes.is_a? Hash
-          includes.each { |included, sub_includes| handle_include(included, data, sub_includes) }
+          includes.each { |included, sub_includes| handle_include(included, data, sub_includes, references[included]) }
         elsif includes.is_a? Array
-          includes.each { |included| handle_includes(included, data) }
+          includes.each { |included| handle_includes(included, data, references[included]) }
         else
-          handle_include(includes, data)
+          handle_include(includes, data, nil, references[includes])
         end
       end
 
-      def handle_include(included, data, sub_includes = nil)
+      def handle_include(included, data, sub_includes = nil, references = nil)
         return if data.blank? || skip_loading_includes?(data, included)
         options =
           if data.collection?
@@ -100,10 +100,22 @@ class LHS::Record
           else
             url_option_for(data, included)
           end
+        options = extend_with_references(options, references)
         addition = load_include(options, data, sub_includes)
         extend_raw_data!(data, addition, included)
       end
 
+      # Extends request options with options provided for this reference
+      def extend_with_references(options, references)
+        return options unless references
+        options ||= {}
+        if options.is_a?(Array)
+          options.map { |request_options| request_options.merge(references) }
+        else
+          options.merge(references)
+        end
+      end
+
       def skip_loading_includes?(data, included)
         if data.collection?
           data.to_a.none? { |item| item[included].present? }
@@ -140,7 +152,7 @@ class LHS::Record
         data = restore_with_nils(data, locate_nils(options)) # nil objects in data provide location information for mapping
         unless data.empty?
           data = LHS::Data.new(data, nil, self)
-          handle_includes(including, data) if including
+          handle_includes(including, data, referencing) if including
         end
         data
       end
@@ -200,7 +212,7 @@ class LHS::Record
         endpoint = find_endpoint(options[:params])
         response = LHC.request(process_options(options, endpoint))
         data = LHS::Data.new(response.body, nil, self, response.request, endpoint)
-        handle_includes(including, data) if including
+        handle_includes(including, data, referencing) if including
         data
       end
 

data/lib/lhs/version.rb

@@ -1,3 +1,3 @@
 module LHS
-  VERSION = "5.7.1"
+  VERSION = "6.0.0"
 end

data/spec/proxy/load_spec.rb

@@ -42,4 +42,22 @@ describe LHS::Proxy do
         .to raise_error LHC::NotFound
     end
   end
+
+  context 'endpoint options' do
+    before(:each) do
+      class AnotherRecord < LHS::Record
+        endpoint ':datastore/v2/feedbacks', params: { color: :blue }
+      end
+    end
+
+    let(:record) do
+      AnotherRecord.new(href: 'http://datastore/v2/feedbacks')
+    end
+
+    it 'applys endpoint options on load!' do
+      stub_request(:get, 'http://datastore/v2/feedbacks?color=blue')
+        .to_return(body: {}.to_json)
+      record.load!
+    end
+  end
 end

data/spec/record/includes_spec.rb

@@ -336,4 +336,34 @@ describe LHS::Record do
       expect(place.contracts.first.products.href).to eq "#{datastore}/place/1/contacts/1/products"
     end
   end
+
+  context 'includes with options' do
+    before(:each) do
+      class Customer < LHS::Record
+        endpoint ':datastore/customers/:id'
+      end
+
+      class Place < LHS::Record
+        endpoint ':datastore/places'
+      end
+    end
+
+    it 'forwards includes options to requests made for those includes' do
+      stub_request(:get, "#{datastore}/customers/1")
+        .to_return(body: {
+          'places' => {
+            'href' => "#{datastore}/places"
+          }
+        }.to_json)
+      stub_request(:get, "#{datastore}/places?forwarded_params=123")
+        .to_return(body: {
+          'items' => [{ id: 1 }]
+        }.to_json)
+      customer = Customer
+        .includes(:places)
+        .references(places: { params: { forwarded_params: 123 } })
+        .find(1)
+      expect(customer.places.first.id).to eq 1
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lhs
 version: !ruby/object:Gem::Version
-  version: 5.7.1
+  version: 6.0.0
 platform: ruby
 authors:
 - https://github.com/local-ch/lhs/graphs/contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lhc
@@ -328,7 +328,8 @@ files:
 - spec/support/load_json.rb
 - spec/views/form_for_spec.rb
 homepage: https://github.com/local-ch/lhs
-licenses: []
+licenses:
+- GPL-3
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -338,14 +339,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- Ruby >= 1.9.2
+- Ruby >= 2.0.0
 rubyforge_project: 
 rubygems_version: 2.2.2
 signing_key: