materialist 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8665cde57cae1468db10b2d04ca02ee83baccef5
-  data.tar.gz: a2fe18fbfdb6e1aa039b3c1dc9a5c7150e67acf0
+  metadata.gz: f551f35e47a806f9f5e3b475feb35358f4a034b5
+  data.tar.gz: 8134a56b74346d367618b99b09604c0ded38a815
 SHA512:
-  metadata.gz: c630af56d05969a23fc7a19149b588eeda385e4d30f494f123ef7cc8f4971f7352fab65b81b6d92cbba919fe3d3e4a68bfa886638854b3997bff05836a224cc8
-  data.tar.gz: 330d44afc53a5214e4e95a3a5335f0fb83c3559fbdfd79d1ae215a030337269a6db68c48f277f216eb8fda2ce76144b742dda34290a37fd4559b8147765781b5
+  metadata.gz: 2a647bde4177b45a090e8a91a1a34b1dde10f1ac38adbe8d1588c161182113cd8f065511edd59f08a82e38721ebaa1260650af9840d4e1f032160a4739561af1
+  data.tar.gz: c660872899ce6526370260e7852d886ecd34abf2a4c0cdaf7178b11680c524db318ade68d8640ce00aa2a50630158f4242f20eec20f79b49f496b877c6a0c678

data/README.md

@@ -75,8 +75,9 @@ end
 
 - `topics` (only when using in `.subscribe`): A string array of topics to be used.  
 If not provided nothing would be materialized.
-- `sidekiq_options` (optional, default: `{ retry: 10 }`) -- See [Sidekiq docs](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) for list of optiosn
+- `sidekiq_options` (optional, default: `{ retry: 10 }`) -- See [Sidekiq docs](https://github.com/mperham/sidekiq/wiki/Advanced-Options#workers) for list of options
 - `metrics_client` (optional) -- You can pass your `STATSD` instance
+- `notice_error` (optional) -- You can pass a lambda accepting two parameters (`exception` and `event`) -- Typical use case is to enrich error and send to NewRelic APM
 
 ### Routemaster Configuration
 
@@ -160,8 +161,8 @@ Here is what each part of the DSL mean:
 
 #### `sidekiq_options <options>`
 allows to override options for the Sidekiq job which does the materialization.
-Typically it will specify which queue to put the job on or how many times 
-should the job try to retry. These options override the options specified in 
+Typically it will specify which queue to put the job on or how many times
+should the job try to retry. These options override the options specified in
 `Materialist.configuration.sidekiq_options`.
 
 #### `persist_to <model_name>`
@@ -180,6 +181,14 @@ describes mapping a resource key to a database column.
 #### `capture_link_href <key>, as: <column>`
 describes mapping a link href (as it appears on the hateous response) to a database column.
 
+You can optionally provide a block for parsing the url:
+
+```ruby
+capture_link_href :rider, as: :rider_id do |url|
+  url.split('/').last
+end
+```
+
 #### `link <key>, enable_caching: <enable_caching> (default: false)`
 describes materializing from a relation of the resource. This can be nested to any depth as shown above.
 

data/RELEASE_NOTES.md

@@ -1,8 +1,18 @@
+## Next
+
+_description of next release_
+
+## 3.3.0
+
+Features:
+- Add support for parsing url when using `capture_link_href`
+- Add support for providing `notice_error` on configuration.
+
 ## 3.2.0
 
 Features:
 - For linked resources specified by `link` an option to `enable_caching` can now be explicitly set. This
-tells Routemaster to use or not use the drain cache. 
+tells Routemaster to use or not use the drain cache.
 
 ## 3.1.0
 
@@ -12,8 +22,8 @@ Features:
 
 Notes:
 
-Materialist::EventWorker has been moved to Materialist::Workers::Event, but the original has 
-been left there for backwards compatibility. It will be removed in a later major release. 
+Materialist::EventWorker has been moved to Materialist::Workers::Event, but the original has
+been left there for backwards compatibility. It will be removed in a later major release.
 
 ## 3.0.0
 

data/lib/configuration.rb

@@ -14,12 +14,13 @@ module Materialist
   end
 
   class Configuration
-    attr_accessor :topics, :sidekiq_options, :metrics_client
+    attr_accessor :topics, :sidekiq_options, :metrics_client, :notice_error
 
     def initialize
       @topics = []
       @sidekiq_options = {}
       @metrics_client = NullMetricsClient
+      @notice_error = nil
     end
 
     class NullMetricsClient

data/lib/materialist.rb

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

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

@@ -10,8 +10,12 @@ module Materialist
           __materialist_dsl_mapping_stack.last << FieldMapping.new(key: key, as: as)
         end
 
-        def capture_link_href(key, as:)
-          __materialist_dsl_mapping_stack.last << LinkHrefMapping.new(key: key, as: as)
+        def capture_link_href(key, as:, &url_parser_block)
+          __materialist_dsl_mapping_stack.last << LinkHrefMapping.new(
+            key: key,
+            as: as,
+            url_parser: url_parser_block
+          )
         end
 
         def link(key, enable_caching: false)

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

@@ -7,7 +7,9 @@ module Materialist
           @as = as
         end
 
-        attr_reader :key, :as
+        def map(resource)
+          { @as => resource.body[@key] }
+        end
       end
     end
   end

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

@@ -2,12 +2,22 @@ module Materialist
   module Materializer
     module Internals
       class LinkHrefMapping
-        def initialize(key:, as:)
+        def initialize(key:, as:, url_parser: nil)
           @key = key
           @as = as
+          @url_parser = url_parser
         end
 
-        attr_reader :key, :as
+        def map(resource)
+          return unless link = resource.body._links[@key]
+          { @as => url_parser.call(link.href) }
+        end
+
+        private
+
+        def url_parser
+          @url_parser || ->url { url }
+        end
       end
     end
   end

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

@@ -8,7 +8,22 @@ module Materialist
           @mapping = []
         end
 
-        attr_reader :key, :enable_caching, :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)
+        rescue Routemaster::Errors::ResourceNotFound
+          nil
+        end
       end
     end
   end

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

@@ -75,7 +75,7 @@ module Materialist
           })
         end
 
-        def mapping
+        def mappings
           options.fetch :mapping
         end
 
@@ -112,49 +112,17 @@ module Materialist
         end
 
         def attributes
-          build_attributes root_resource, mapping
+          mappings.map{ |m| m.map(root_resource) }.compact.reduce(&:merge) || {}
         end
 
         def root_resource
-          @_root_resource ||= resource_at(url)
-        end
-
-        def build_attributes(resource, mapping)
-          return {} unless resource
-
-          mapping.inject({}) do |result, m|
-            case m
-              when FieldMapping
-                result.tap { |r| r[m.as] = resource.body[m.key] }
-              when LinkHrefMapping
-                result.tap do |r|
-                  if resource.body._links.include?(m.key)
-                    r[m.as] = resource.body._links[m.key].href
-                  end
-                end
-              when LinkMapping
-                resource.body._links.include?(m.key) ?
-                  result.merge(build_attributes(linked_resource(resource, m), m.mapping || [])) :
-                  result
-              else
-                result
-            end
+          @_root_resource ||= begin
+            api_client.get(url, options: { enable_caching: false })
+          rescue Routemaster::Errors::ResourceNotFound
+            nil
           end
         end
 
-        def linked_resource(resource, mapping)
-          resource_at(resource.send(mapping.key).url, enable_caching: mapping.enable_caching)
-        end
-
-        def resource_at(url, enable_caching: false)
-          api_client.get(url, options: { enable_caching: enable_caching })
-        rescue Routemaster::Errors::ResourceNotFound
-          # this is due to a race condition between an upsert event
-          # and a :delete event
-          # when this happens we should silently ignore the case
-          nil
-        end
-
         def api_client
           @_api_client ||= Routemaster::APIClient.new(
             response_class: Routemaster::Responses::HateoasResponse

data/lib/materialist/workers/event.rb

@@ -16,8 +16,9 @@ module Materialist
 
         report_latency(topic, timestamp) if timestamp
         report_stats(topic, action, :success)
-      rescue
+      rescue Exception => exception
         report_stats(topic, action, :failure)
+        notice_error(exception, event)
         raise
       end
 
@@ -38,6 +39,11 @@ module Materialist
           tags: ["action:#{action}", "topic:#{topic}"]
         )
       end
+
+      def notice_error(exception, event)
+        return unless handler = Materialist.configuration.notice_error
+        handler.call(exception, event)
+      end
     end
   end
 end

data/spec/materialist/materializer_spec.rb

@@ -15,6 +15,9 @@ RSpec.describe Materialist::Materializer do
         capture :name
         capture :age, as: :how_old
         capture_link_href :city, as: :city_url
+        capture_link_href :city, as: :city_id do |url|
+          url.split('/').last.to_i
+        end
         capture_link_href :account, as: :account_url
 
         materialize_link :city
@@ -81,6 +84,8 @@ RSpec.describe Materialist::Materializer do
       expect(inserted.timezone).to eq city_body[:timezone]
       expect(inserted.country_tld).to eq country_body[:tld]
       expect(inserted.account_url).to be_nil
+      expect(inserted.city_url).to eq city_url
+      expect(inserted.city_id).to eq 1
     end
 
     it "materializes linked record separately in db" do

data/spec/materialist/workers/event_spec.rb

@@ -48,6 +48,20 @@ RSpec.describe Materialist::Workers::Event do
         )
         expect{ perform }.to raise_error error
       end
+
+      context 'when there is notice_error configured' do
+        let(:configuration) { Materialist::Configuration.new.tap{ |c| c.notice_error = func } }
+        let(:func) { double }
+
+        before do
+          allow(Materialist).to receive(:configuration).and_return configuration
+        end
+
+        it 'calls the configured notice_error func' do
+          expect(func).to receive(:call).with(error, event)
+          expect{ perform }.to raise_error error
+        end
+      end
     end
 
     context 'when event has a timestamp' do

data/spec/schema.rb

@@ -9,6 +9,7 @@ ActiveRecord::Schema.define do
     t.string :timezone
     t.string :country_tld
     t.string :city_url
+    t.integer :city_id
     t.string :account_url
 
     t.timestamps

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: materialist
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Mo Valipour
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq