materialist 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f551f35e47a806f9f5e3b475feb35358f4a034b5
-  data.tar.gz: 8134a56b74346d367618b99b09604c0ded38a815
+  metadata.gz: d4b55d54d4aa9644e1fee1055286166521f97120
+  data.tar.gz: ed6c12846d2b859f49efdb7b5b9581184cafa4ea
 SHA512:
-  metadata.gz: 2a647bde4177b45a090e8a91a1a34b1dde10f1ac38adbe8d1588c161182113cd8f065511edd59f08a82e38721ebaa1260650af9840d4e1f032160a4739561af1
-  data.tar.gz: c660872899ce6526370260e7852d886ecd34abf2a4c0cdaf7178b11680c524db318ade68d8640ce00aa2a50630158f4242f20eec20f79b49f496b877c6a0c678
+  metadata.gz: f3a97dd8a5a618d2600d23d3259979dcf3698860c83794f0314387db616b6ca8635a15dbe7caf5bfd5082426292682241d343e7c9de39a2ab8128facf320d912
+  data.tar.gz: 0b61ede028064fcd5e4aa8fc2a4040e2beb8f04e7b3606f723a68fd1e064472eb57faf8f39219a95f7f8b274a666f41045a7630392cc262e8a3bc161680d5249

data/README.md

@@ -14,6 +14,9 @@ In your `gemfile`
 
 ```ruby
 gem 'materialist'
+
+# or for sandbox features
+gem 'materialist', github: 'deliveroo/materialist', branch: 'sandbox'
 ```
 
 Then do

data/RELEASE_NOTES.md

@@ -2,6 +2,11 @@
 
 _description of next release_
 
+## 3.4.0
+
+- Add support for providing payload into the materializer
+- Enhance linked resource materialization to avoid `:noop` stats
+
 ## 3.3.0
 
 Features:

data/lib/materialist.rb

@@ -1,5 +1,5 @@
 require_relative './configuration'
 
 module Materialist
-  VERSION = '3.3.0'
+  VERSION = '3.4.0'
 end

data/lib/materialist/materializer/internals/class_methods.rb

@@ -4,9 +4,8 @@ module Materialist
       module ClassMethods
         attr_reader :__materialist_options, :__materialist_dsl_mapping_stack
 
-        def perform(url, action)
-          materializer = Materializer.new(url, self)
-          action == :delete ? materializer.destroy : materializer.upsert
+        def perform(url, action, *options)
+          Materializer.new(url, self, *options).perform(action)
         end
 
         def _sidekiq_options

data/lib/materialist/materializer/internals/field_mapping.rb

@@ -2,13 +2,13 @@ module Materialist
   module Materializer
     module Internals
       class FieldMapping
-        def initialize(key:, as:)
+        def initialize(key:, as: key)
           @key = key
           @as = as
         end
 
         def map(resource)
-          { @as => resource.body[@key] }
+          { @as => resource.dig(@key) }
         end
       end
     end

data/lib/materialist/materializer/internals/link_href_mapping.rb

@@ -9,8 +9,8 @@ module Materialist
         end
 
         def map(resource)
-          return unless link = resource.body._links[@key]
-          { @as => url_parser.call(link.href) }
+          return unless link = resource.dig(:_links, @key)
+          { @as => url_parser.call(link[:href]) }
         end
 
         private

data/lib/materialist/materializer/internals/link_mapping.rb

@@ -2,25 +2,22 @@ module Materialist
   module Materializer
     module Internals
       class LinkMapping
-        def initialize(key:, enable_caching: false)
+        def initialize(key:, mapping: [], enable_caching: false)
           @key = key
+          @mapping = mapping
           @enable_caching = enable_caching
-          @mapping = []
         end
 
+        attr_reader :mapping
+
         def map(resource)
           return unless linked_resource = linked_resource(resource)
           mapping.map{ |m| m.map(linked_resource) }.compact.reduce(&:merge)
         end
 
-        attr_reader :mapping
-
-        private
-
         def linked_resource(resource)
-          return unless resource.body._links.include?(@key)
-          return unless sub_resource = resource.send(@key)
-          sub_resource.show(enable_caching: @enable_caching)
+          return unless href = resource.dig(:_links, @key, :href)
+          resource.client.get(href, options: { enable_caching: @enable_caching })
         rescue Routemaster::Errors::ResourceNotFound
           nil
         end

data/lib/materialist/materializer/internals/materializer.rb

@@ -1,18 +1,29 @@
 require 'routemaster/api_client'
 require_relative '../../workers/event'
+require_relative './resources'
 
 module Materialist
   module Materializer
     module Internals
       class Materializer
-        def initialize(url, klass)
+        def initialize(url, klass, resource_payload: nil, api_client: nil)
           @url = url
           @instance = klass.new
           @options = klass.__materialist_options
+          @api_client = api_client || Routemaster::APIClient.new(response_class: HateoasResource)
+          if resource_payload
+            @resource = PayloadResource.new(resource_payload, client: @api_client)
+          end
+        end
+
+        def perform(action)
+          action.to_sym == :delete ? destroy : upsert
         end
 
+        private
+
         def upsert(retry_on_race_condition: true)
-          return unless root_resource
+          return unless resource
 
           if materialize_self?
             upsert_record.tap do |entity|
@@ -42,9 +53,7 @@ module Materialist
           end
         end
 
-        private
-
-        attr_reader :url, :instance, :options
+        attr_reader :url, :instance, :options, :api_client
 
         def materialize_self?
           options.include? :model_class
@@ -53,7 +62,7 @@ module Materialist
         def upsert_record
           model_class.find_or_initialize_by(source_lookup(url)).tap do |entity|
             send_messages(before_upsert, entity) unless before_upsert.nil?
-            entity.update_attributes! attributes
+            entity.update_attributes!(attributes)
           end
         end
 
@@ -63,16 +72,11 @@ module Materialist
         end
 
         def materialize_link(key, opts)
-          return unless root_resource.body._links.include?(key)
+          return unless link = resource.dig(:_links, key)
+          return unless materializer_class = MaterializerFactory.class_from_topic(opts.fetch(:topic))
 
-          # this can't happen asynchronously
-          # because the handler options are unavailable in this context
-          # :(
-          ::Materialist::Workers::Event.new.perform({
-            'topic' => opts[:topic],
-            'url' => root_resource.body._links[key].href,
-            'type' => 'noop'
-          })
+          # TODO: perhaps consider doing this asynchronously some how?
+          materializer_class.perform(link[:href], :noop)
         end
 
         def mappings
@@ -112,21 +116,17 @@ module Materialist
         end
 
         def attributes
-          mappings.map{ |m| m.map(root_resource) }.compact.reduce(&:merge) || {}
+          mappings.map{ |m| m.map(resource) }.compact.reduce(&:merge) || {}
         end
 
-        def root_resource
-          @_root_resource ||= begin
-            api_client.get(url, options: { enable_caching: false })
-          rescue Routemaster::Errors::ResourceNotFound
-            nil
-          end
+        def resource
+          @resource ||= fetch_resource
         end
 
-        def api_client
-          @_api_client ||= Routemaster::APIClient.new(
-            response_class: Routemaster::Responses::HateoasResponse
-          )
+        def fetch_resource
+          api_client.get(url, options: { enable_caching: false })
+        rescue Routemaster::Errors::ResourceNotFound
+          nil
         end
 
         def send_messages(messages, arguments)

data/lib/materialist/materializer/internals/resources.rb

@@ -0,0 +1,22 @@
+module Materialist
+  module Materializer
+    module Internals
+      class PayloadResource
+        attr_reader :client
+
+        delegate :dig, to: :@payload
+
+        def initialize(payload, client:)
+          @payload = payload
+          @client = client
+        end
+      end
+
+      class HateoasResource < PayloadResource
+        def initialize(response, client:)
+          super(response.body, client: client)
+        end
+      end
+    end
+  end
+end

data/lib/materialist/materializer_factory.rb

@@ -1,9 +1,7 @@
 module Materialist
   class MaterializerFactory
     def self.class_from_topic(topic)
-      "#{topic.to_s.singularize.classify}Materializer".constantize
-    rescue NameError
-      nil
+      "#{topic.to_s.singularize.classify}Materializer".safe_constantize
     end
   end
 end

data/spec/materialist/materializer/internals/link_mapping_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+require 'materialist/materializer/internals'
+
+include Materialist::Materializer::Internals
+
+RSpec.describe Materialist::Materializer::Internals::LinkMapping, type: :internals do
+  let(:key) { :details }
+  subject(:instance) { described_class.new(key: key, mapping: mappings) }
+  let(:mappings) { [ FieldMapping.new(key: :name) ] }
+
+  let(:url_sub) { 'https://deliveroo.co.uk/details/1001' }
+  let(:payload) { { _links: { details: { href: url_sub } } } }
+  let(:payload_sub) { { name: "jack", age: 20 } }
+
+  let(:client) { double }
+  let(:resource_class) { Materialist::Materializer::Internals::PayloadResource }
+  let(:resource) { resource_class.new(payload, client: client) }
+  let(:resource_sub) { resource_class.new(payload_sub, client: client) }
+
+  before do
+    allow(client).to receive(:get).with(url_sub, anything).and_return resource_sub
+  end
+
+  describe '#map' do
+    subject(:perform) { instance.map resource }
+
+    it 'returns a hash corresponding to the mapping' do
+      is_expected.to eq({ name: 'jack' })
+    end
+
+    context 'when multiple mappings given' do
+      let(:mappings) do
+        [
+          FieldMapping.new(key: :age),
+          LinkMapping.new(key: :wont_find_me),
+          FieldMapping.new(key: :name)
+        ]
+      end
+
+      it 'returns a hash corresponding to the mapping' do
+        is_expected.to eq({ age: 20, name: 'jack' })
+      end
+    end
+
+    describe 'missing sub resource' do
+      context 'when given link is not present' do
+        let(:key) { :foo }
+
+        it { is_expected.to be nil }
+      end
+
+      context 'when given link is malformed' do
+        let(:payload) { { _links: { details: { foo: url_sub } } } }
+
+        it { is_expected.to be nil }
+      end
+
+      context 'when client returns nil' do
+        let(:resource_sub) { nil }
+
+        it { is_expected.to be nil }
+      end
+
+      context 'when client throws not-found error' do
+        before do
+          allow(client).to receive(:get)
+            .with(url_sub, anything)
+            .and_raise Routemaster::Errors::ResourceNotFound.new(double(body: nil))
+        end
+
+        it { is_expected.to be nil }
+      end
+
+      context 'when caching enabled' do
+        let(:instance) { described_class.new(key: key, mapping: mappings, enable_caching: true) }
+
+        it 'passes on the option to client' do
+          expect(client).to receive(:get)
+            .with(url_sub, options: { enable_caching: true})
+          perform
+        end
+      end
+    end
+  end
+
+end

data/spec/materialist/materializer_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 require 'support/uses_redis'
 require 'materialist/materializer'
 
-RSpec.describe Materialist::Materializer do
+RSpec.describe Materialist::Materializer::Internals::Materializer do
   uses_redis
 
   describe ".perform" do
@@ -60,8 +60,9 @@ RSpec.describe Materialist::Materializer do
       )
     end
 
+    let!(:source_stub) { stub_resource source_url, source_body }
+
     before do
-      stub_resource source_url, source_body
       stub_resource country_url, country_body
       stub_resource city_url, city_body
       stub_resource defined_source_url, defined_source_body
@@ -77,7 +78,7 @@ RSpec.describe Materialist::Materializer do
     let(:actions_called) { materializer_class.class_variable_get(:@@actions_called) }
 
     it "materializes record in db" do
-      expect{perform}.to change{Foobar.count}.by 1
+      expect{ perform }.to change{ Foobar.count }.by 1
       inserted = Foobar.find_by(source_url: source_url)
       expect(inserted.name).to eq source_body[:name]
       expect(inserted.how_old).to eq source_body[:age]
@@ -95,6 +96,23 @@ RSpec.describe Materialist::Materializer do
       expect(inserted.name).to eq city_body[:name]
     end
 
+    context 'when materializing using payload' do
+      let(:perform) { materializer_class.perform(source_url, action, resource_payload: source_body) }
+
+      it 'does not fetch resource' do
+        perform
+        expect(source_stub).to_not have_been_requested
+      end
+
+      it "materializes record in db" do
+        expect{ perform }.to change{ Foobar.count }.by 1
+      end
+
+      it "materializes linked record in db" do
+        expect{ perform }.to change{ City.count }.by 1
+      end
+    end
+
     context "when record already exists" do
       let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -212,11 +212,13 @@ files:
 - lib/materialist/materializer/internals/link_href_mapping.rb
 - lib/materialist/materializer/internals/link_mapping.rb
 - lib/materialist/materializer/internals/materializer.rb
+- lib/materialist/materializer/internals/resources.rb
 - lib/materialist/materializer_factory.rb
 - lib/materialist/workers/event.rb
 - materialist.gemspec
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/materialized_record_spec.rb
+- spec/materialist/materializer/internals/link_mapping_spec.rb
 - spec/materialist/materializer_factory_spec.rb
 - spec/materialist/materializer_spec.rb
 - spec/materialist/workers/event_spec.rb
@@ -251,6 +253,7 @@ summary: Utilities to materialize routemaster topics
 test_files:
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/materialized_record_spec.rb
+- spec/materialist/materializer/internals/link_mapping_spec.rb
 - spec/materialist/materializer_factory_spec.rb
 - spec/materialist/materializer_spec.rb
 - spec/materialist/workers/event_spec.rb