materialist 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad0c95193ee887dc776cdb28f54fa1fd7a00212a
-  data.tar.gz: 6e3dfb760278e54a275acdc667f5b32fe1809374
+  metadata.gz: 3e1d3d42e45eb0a9130ca412078f6df11e29da53
+  data.tar.gz: 0041f0349dfce34d055ff59a5a4f2d4fc694bb26
 SHA512:
-  metadata.gz: 54a84928a4d988d22741f038d02bc47757b331ff45f45cef201829691b204a239745a89abc9b67fac706f267fda054b0e65094ef1d62ac9836282e7ec608d448
-  data.tar.gz: 8758db7954c895a28ac969f4f166b570451f338a1a11d449ee9d9f8bae3e1dcc66cb57d1867af24bb9e3dcee1497d4c557411924a616171fbc2fd6580f2afb16
+  metadata.gz: 0df7a1d5dab2b2d6f4fe9769e73b67028b2398dca4b309081d172e7b97c3b8729088957ffb8fcd24c1e045f6eba287cd1af96f81d9811fb2fa5470f36800e6e5
+  data.tar.gz: bfaf53768945dc8b98cad7a6191aa9ef588b680898546353d5a756f4e4286a867ae3f00067c69961fe2efb9c5b820457ac620df2cf74f5ca1db5bb2983090ed9

data/.gitignore

@@ -9,3 +9,4 @@ tags
 *.swo
 coverage/
 .byebug_history
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+services:
+  - redis-server
+rvm:
+  - 2.4.0
+  - ruby-head
+script:
+  - bundle exec rspec

data/README.md

@@ -115,3 +115,28 @@ class ZoneMaterializer
   end
 end
 ```
+
+### Materialized record
+
+Imagine you have materialized rider from a routemaster topic and you need to access a key from the remote source that you HAVEN'T materialized locally.
+
+> NOTE that doing such thing is only acceptable if you use `caching` drain, otherwise every time the remote source is fetched a fresh http call is made which will result in hammering of the remote service.
+
+> Also it is unacceptable to iterate through a large set of records and call on remote sources. Any such data should be materialised because database (compared to redis cache) is more optimised to perform scan operations.
+
+```ruby
+class Rider
+  include Materialist::MaterializedRecord
+
+  source_link_reader :city
+  source_link_reader :country, via: :city
+end
+```
+
+Above will give you `.source`, `.city` and `.country` on any instances of `Rider`, allowing you to access remote keys.
+
+e.g.
+
+```ruby
+Rider.last.country.created_at
+```

data/lib/materialist/materialized_record.rb

@@ -0,0 +1,36 @@
+require 'routemaster/api_client'
+
+module Materialist
+  module MaterializedRecord
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def source_link_reader(*keys, via: nil)
+        keys.each do |key|
+          define_method(key) do
+            raw = source_raw
+            raw = raw.send(via).show if via
+            raw.send(key).show.body
+          end
+        end
+      end
+    end
+
+    def source
+      source_raw.body
+    end
+
+    def source_raw
+      api_client.get(source_url)
+    end
+
+    def api_client
+      @_api_client ||= Routemaster::APIClient.new(
+        response_class: Routemaster::Responses::HateoasResponse
+      )
+    end
+  end
+end

data/lib/materialist/materializer.rb

@@ -1,3 +1,4 @@
+require 'active_support/inflector'
 require 'routemaster/api_client'
 
 module Materialist
@@ -62,6 +63,9 @@ module Materialist
           materialist_options[:after_upsert] = method_name
         end
 
+        def after_destroy(method_name)
+          materialist_options[:after_destroy] = method_name
+        end
       end
 
       class Materializer
@@ -79,7 +83,11 @@ module Materialist
         end
 
         def destroy
-          model_class.where(source_url: url).destroy_all
+          model_class.find_by(source_url: url).tap do |entity|
+            entity.destroy!.tap do |entity|
+              instance.send(after_destroy, entity) if after_destroy
+            end if entity
+          end
         end
 
         private
@@ -101,6 +109,10 @@ module Materialist
           options[:after_upsert]
         end
 
+        def after_destroy
+          options[:after_destroy]
+        end
+
         def model_class
           options.fetch(:model_class).to_s.classify.constantize
         end

data/lib/materialist.rb

@@ -1,3 +1,3 @@
 module Materialist
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/materialist/materialized_record_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'support/uses_redis'
+require 'materialist/materialized_record'
+
+RSpec.describe Materialist::MaterializedRecord do
+  uses_redis
+
+  let!(:materialized_type) do
+    class Foobar
+      include Materialist::MaterializedRecord
+
+      attr_accessor :source_url
+      source_link_reader :city
+      source_link_reader :country, via: :city
+    end
+  end
+
+  let(:record) do
+    Foobar.new.tap { |r| r.source_url = source_url }
+  end
+
+  let(:country_url) { 'https://service.dev/countries/1' }
+  let(:country_body) {{ tld: 'fr' }}
+  let(:city_url) { 'https://service.dev/cities/1' }
+  let(:city_body) {{ _links: { country: { href: country_url }}, timezone: 'Europe/Paris' }}
+  let(:source_url) { 'https://service.dev/foobars/1' }
+  let(:source_body) {{ _links: { city: { href: city_url }}, name: 'jack', age: 30 }}
+  before do
+    stub_request(:get, source_url).to_return(
+      status: 200,
+      body: source_body.to_json,
+      headers:  { 'Content-Type' => 'application/json' }
+    )
+    stub_request(:get, country_url).to_return(
+      status: 200,
+      body: country_body.to_json,
+      headers:  { 'Content-Type' => 'application/json' }
+    )
+    stub_request(:get, city_url).to_return(
+      status: 200,
+      body: city_body.to_json,
+      headers:  { 'Content-Type' => 'application/json' }
+    )
+  end
+
+  describe "#source" do
+    it "returns the representation of the source" do
+      expect(record.source.name).to eq 'jack'
+      expect(record.source.age).to eq 30
+    end
+  end
+
+  describe "simple link reader" do
+    it "returns the representation of the link source" do
+      expect(record.city.timezone).to eq 'Europe/Paris'
+    end
+  end
+
+  describe "simple link reader via another link" do
+    it "returns the representation of the link source" do
+      expect(record.country.tld).to eq 'fr'
+    end
+  end
+end

data/spec/materialist/materializer_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
+require 'support/uses_redis'
 require 'materialist/materializer'
 
 RSpec.describe Materialist::Materializer do
+  uses_redis
+
   describe "#perform" do
     let!(:materializer_class) do
       class FoobarMaterializer
@@ -21,7 +24,62 @@ RSpec.describe Materialist::Materializer do
       end
     end
 
-    let!(:foobar_class) { class Foobar; end }
+    # this class mocks active record behaviour
+    class Foobar
+      attr_accessor :source_url, :name, :how_old, :age, :timezone, :country_tld
+
+      def update_attributes(attrs)
+        attrs.each { |k, v| send("#{k}=", v) }
+      end
+
+      def save!
+        self.class.all[source_url] = self
+      end
+
+      def destroy!
+        self.class.all.delete source_url
+      end
+
+      def reload
+        self.class.all[source_url]
+      end
+
+      def actions_called
+        @_actions_called ||= {}
+      end
+
+      class << self
+        def find_or_initialize_by(source_url:)
+          (all[source_url] || Foobar.new).tap do |record|
+            record.source_url = source_url
+          end
+        end
+
+        def find_by(source_url:)
+          all[source_url]
+        end
+
+        def create!(attrs)
+          new.tap do |record|
+            record.update_attributes attrs
+            record.save!
+          end
+        end
+
+        def all
+          @@_store ||= {}
+        end
+
+        def flush_all
+          @@_store = {}
+        end
+
+        def count
+          all.keys.size
+        end
+      end
+    end
+
     let(:country_url) { 'https://service.dev/countries/1' }
     let(:country_body) {{ tld: 'fr' }}
     let(:city_url) { 'https://service.dev/cities/1' }
@@ -29,6 +87,7 @@ RSpec.describe Materialist::Materializer do
     let(:source_url) { 'https://service.dev/foobars/1' }
     let(:source_body) {{ _links: { city: { href: city_url }}, name: 'jack', age: 30 }}
     before do
+      Foobar.flush_all
       stub_request(:get, source_url).to_return(
         status: 200,
         body: source_body.to_json,
@@ -46,47 +105,50 @@ RSpec.describe Materialist::Materializer do
       )
     end
 
-    let(:expected_attributes) do
-      { name: 'jack', how_old: 30, country_tld: 'fr', timezone: 'Europe/Paris' }
-    end
-
-    let(:record_double) { double() }
-    before do
-      allow(Foobar).to receive(:find_or_initialize_by).and_return record_double
-    end
-
     let(:action) { :create }
     let(:perform) { FoobarMaterializer.perform(source_url, action) }
 
-    def performs_upsert
-      expect(Foobar).to receive(:find_or_initialize_by)
-        .with(source_url: source_url)
-      expect(record_double).to receive(:update_attributes).with(expected_attributes)
-      expect(record_double).to receive(:save!)
-      perform
+    it "inserts record in db" do
+      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]
+      expect(inserted.timezone).to eq city_body[:timezone]
+      expect(inserted.country_tld).to eq country_body[:tld]
     end
 
-    def performs_destroy
-      expect(Foobar).to receive(:where)
-        .with(source_url: source_url)
-        .and_return record_double
-      expect(record_double).to receive(:destroy_all)
-      perform
-    end
+    context "when record already exists" do
+      let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
 
-    it { performs_upsert }
+      it "updates the existing record" do
+        expect{ perform }.to change { record.reload.name }
+          .from('mo').to('jack')
+      end
+
+      context "when action is :delete" do
+        let(:action) { :delete }
+
+        it "removes record from db" do
+          expect{perform}.to change{Foobar.count}.by -1
+        end
+      end
+    end
 
     %i(create update noop).each do |action_name|
       context "when action is :#{action_name}" do
         let(:action) { action_name }
-        it { performs_upsert }
+        it "inserts record in db" do
+          expect{perform}.to change{Foobar.count}.by 1
+        end
       end
     end
 
-    context "when action is :delete" do
+    context "when action is :delete and no existing record in db" do
       let(:action) { :delete }
 
-      it { performs_destroy }
+      it "does not remove anything from db" do
+        expect{perform}.to change{Foobar.count}.by 0
+      end
     end
 
     context "if resource returns 404" do
@@ -100,17 +162,15 @@ RSpec.describe Materialist::Materializer do
     context "if a linked resource returns 404" do
       before { stub_request(:get, city_url).to_return(status: 404) }
 
-      let(:expected_attributes) do
-        { name: 'jack', how_old: 30 }
-      end
-
       it "ignores keys from the relation" do
-        performs_upsert
+        expect{perform}.to change{Foobar.count}.by 1
+        inserted = Foobar.find_by(source_url: source_url)
+        expect(inserted.country_tld).to eq nil
       end
     end
 
     context "when after_upsert is configured" do
-      let(:expected_attributes) {{}}
+      let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
       let!(:materializer_class) do
         class FoobarMaterializer
           include Materialist::Materializer
@@ -119,7 +179,7 @@ RSpec.describe Materialist::Materializer do
           after_upsert :my_method
 
           def my_method(entity)
-            entity.after_upsert_action
+            entity.actions_called[:after_upsert] = true
           end
         end
       end
@@ -128,8 +188,7 @@ RSpec.describe Materialist::Materializer do
         context "when action is :#{action_name}" do
           let(:action) { action_name }
           it "calls after_upsert method" do
-            expect(record_double).to receive(:after_upsert_action)
-            performs_upsert
+            expect{ perform }.to change { record.actions_called[:after_upsert] }
           end
         end
       end
@@ -138,8 +197,48 @@ RSpec.describe Materialist::Materializer do
         let(:action) { :delete }
 
         it "does not call after_upsert method" do
-          expect(record_double).to_not receive(:after_upsert_action)
-          performs_destroy
+          expect{ perform }.to_not change { record.actions_called[:after_upsert] }
+        end
+      end
+
+    end
+
+    context "when after_destroy is configured" do
+      let!(:record) { Foobar.create!(source_url: source_url, name: 'mo') }
+      let!(:materializer_class) do
+        class FoobarMaterializer
+          include Materialist::Materializer
+
+          use_model :foobar
+          after_destroy :my_method
+
+          def my_method(entity)
+            entity.actions_called[:after_destroy] = true
+          end
+        end
+      end
+
+      %i(create update noop).each do |action_name|
+        context "when action is :#{action_name}" do
+          let(:action) { action_name }
+          it "does not call after_destroy method" do
+            expect{ perform }.to_not change { record.actions_called[:after_destroy] }
+          end
+        end
+      end
+
+      context "when action is :delete" do
+        let(:action) { :delete }
+
+        it "calls after_destroy method" do
+          expect{ perform }.to change { record.actions_called[:after_destroy] }
+        end
+
+        context "when resource doesn't exist locally" do
+          it "does not raise error" do
+            Foobar.flush_all
+            expect{ perform }.to_not raise_error
+          end
         end
       end
 

data/spec/support/uses_redis.rb

@@ -0,0 +1,11 @@
+module RspecSupportUsesRedis
+  def uses_redis
+    let(:redis) { ::Redis.new }
+
+    before do
+      redis.flushall
+    end
+  end
+end
+
+RSpec.configure { |c| c.extend RspecSupportUsesRedis }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- ".travis.yml"
 - Appraisals
 - Gemfile
 - Gemfile.lock
@@ -46,12 +47,15 @@ files:
 - lib/materialist.rb
 - lib/materialist/event_handler.rb
 - lib/materialist/event_worker.rb
+- lib/materialist/materialized_record.rb
 - lib/materialist/materializer.rb
 - materialist.gemspec
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/event_worker_spec.rb
+- spec/materialist/materialized_record_spec.rb
 - spec/materialist/materializer_spec.rb
 - spec/spec_helper.rb
+- spec/support/uses_redis.rb
 homepage: http://github.com/deliveroo/materialist
 licenses:
 - MIT
@@ -79,5 +83,7 @@ summary: Utilities to materialize routemaster topics
 test_files:
 - spec/materialist/event_handler_spec.rb
 - spec/materialist/event_worker_spec.rb
+- spec/materialist/materialized_record_spec.rb
 - spec/materialist/materializer_spec.rb
 - spec/spec_helper.rb
+- spec/support/uses_redis.rb