stream_rails 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d3432a8955f14a1c5bc68728636624f4e32feb7
-  data.tar.gz: 07c4acdc2ece3b24277052b51547a07095f335fa
+  metadata.gz: b2be56f2aac225bde0b2b22a82a981fee33411ef
+  data.tar.gz: 9606304c21188e469f650edb1aba96147a9a3f59
 SHA512:
-  metadata.gz: a03aafb8e658cc99d5808dc1ca1d56e2012ae647eefd26bd126b4b63a6ca74f3d026ea253bb56027a888e89e54192c74a4ddd4227c3981ce8e00999baa8a998f
-  data.tar.gz: 791fd74c07194ecbf7fdff17419531b1b71cdadc841a6e3df751c84bf34d2c0568c3b9ae7a8e6bac6d9b47b8ad3af60e7fe81ea1ce94e05c0e677f1e8ca68701
+  metadata.gz: ff2835f8309e581328db198c6e044ea47dfc2333936bcf3d98203c1dc638e1c53af498657c3452098f3662786461926679f08a678d96f22a997ddc95d9254520
+  data.tar.gz: 603245bbc79e09e0b57e38c29157b8e7981102f84c26bb94acdd46b96d855779f03b532f6e24d3bf8c0523a6791a66e56cd6231c5ecb16c2c9e2c51aa24f9a37

data/README.md

@@ -22,7 +22,7 @@ What you can build:
 
 You can check out our example app built using this library on Github [https://github.com/GetStream/Stream-Example-Rails](https://github.com/GetStream/Stream-Example-Rails)
 
-###Table of Contents
+### Table of Contents
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
@@ -62,7 +62,6 @@ or in your Gemfile:
 gem 'stream_rails'
 ```
 
-
 ### Setup
 
 Login with Github on getstream.io and get your ```api_key``` and ```api_secret``` from your app configuration (Dashboard screen).
@@ -86,9 +85,9 @@ StreamRails.configure do |config|
 end
 ```
 
-###Supported ORMs
+### Supported ORMs
 
-####ActiveRecord
+#### ActiveRecord
 
 The integration will look as follows:
 
@@ -103,7 +102,7 @@ class Pin < ActiveRecord::Base
 end
 ```
 
-####Sequel
+#### Sequel
 
 Please, use Sequel `~4`.
 
@@ -321,7 +320,7 @@ StreamRails.feed_manager.follow_user(user_id, target_id)
 
 ### Showing the newsfeed
 
-####Activity enrichment
+#### Activity enrichment
 
 When you read data from feeds, a pin activity will look like this:
 
@@ -329,7 +328,8 @@ When you read data from feeds, a pin activity will look like this:
 {"actor": "User:1", "verb": "like", "object": "Item:42"}
 ```
 
-This is far from ready for usage in your template. We call the process of loading the references from the database enrichment. An example is shown below:
+This is far from ready for usage in your template. We call the process of loading the references from the database 
+enrichment. An example is shown below:
 
 ```ruby
 enricher = StreamRails::Enrich.new
@@ -339,7 +339,56 @@ results = feed.get()['results']
 activities = enricher.enrich_activities(results)
 ```
 
-####Templating
+If you have additional metadata in your activity (by overriding `activity_extra_data` in the class where you add the 
+Stream Activity mixin), you can also enrich that field's data by doing the following:
+
+Step One: override the `activity_extra_data` method from our mixin:
+```ruby
+class Pin < ActiveRecord::Base
+  include StreamRails::Activity
+  as_activity
+
+  attr_accessor :extra_data
+
+  def activity_object
+    self.item
+  end
+
+  # override this method to add metadata to your activity
+  def activity_extra_data
+    @extra_data
+  end
+end
+```
+
+Now we'll create a 'pin' object which has a `location` metadata field. In this example, we will also have a 
+`location` table and model, and we set up our metadata in the `extra_data` field. It is important that the 
+symbol of the metadata as well as the value of the meta data match this pattern. The left half of the 
+`string:string` metadata value when split on `:` must also match the name of the model.
+
+We must also tell the enricher to also fetch locations when looking through our activities
+
+```ruby
+boulder = Location.new
+boulder.name = "Boulder, CO"
+boulder.save!
+
+# tell the enricher to also do a lookup on the `location` model
+enricher.add_fields([:location])
+
+pin = Pin.new
+pin.user = @tom
+pin.extra_data = {:location => "location:#{@boulder.id}"}
+```
+
+When we retrieve the activity later, the enrichment process will include our `location` model as well, giving us
+access to attributes and methods of the location model:
+```ruby
+place = activity[:location].name
+# Boulder, CO
+```
+
+#### Templating
 
 Now that you've enriched the activities you can render them in a view.
 For convenience we include a basic view:

data/lib/stream_rails/activity.rb

@@ -47,7 +47,7 @@ module StreamRails
     end
 
     def activity_object
-      fail NotImplementedError, "Activity models must define `#activity_object` - missing on `#{self.class}`"
+      raise NotImplementedError, "Activity models must define `#activity_object` - missing on `#{self.class}`"
     end
 
     def activity_target
@@ -70,8 +70,7 @@ module StreamRails
       StreamRails.create_reference(activity_target) if activity_target
     end
 
-    def activity_notify
-    end
+    def activity_notify; end
 
     def activity_extra_data
       {}
@@ -95,7 +94,7 @@ module StreamRails
         time: activity_time
       }
       activity[:to] = activity_notify.map(&:id) unless activity_notify.nil?
-      activity.merge(activity_extra_data)
+      activity.merge(activity_extra_data) if activity_extra_data != nil
     end
   end
 end

data/lib/stream_rails/enrich.rb

@@ -15,7 +15,7 @@ module StreamRails
     end
 
     def enriched?
-      @failed_to_enrich.keys.length == 0
+      @failed_to_enrich.keys.length.zero?
     end
 
     def not_enriched_fields
@@ -28,10 +28,16 @@ module StreamRails
   end
 
   class Enrich
+    attr_reader :fields
+
     def initialize(fields = nil)
       @fields = fields || [:actor, :object, :target]
     end
 
+    def add_fields(new_fields)
+      new_fields.each { |i| @fields << i }
+    end
+
     def model_field?(field_value)
       return false unless field_value.respond_to?('split')
       bits = field_value.split(':')
@@ -68,7 +74,7 @@ module StreamRails
       model_refs = Hash.new { |h, k| h[k] = {} }
       activities.each do |activity|
         activity.select { |k, _v| @fields.include? k.to_sym }.each do |_field, value|
-          next unless self.model_field?(value)
+          next unless model_field?(value)
           model, id = value.split(':')
           model_refs[model][id] = 0
         end
@@ -83,7 +89,7 @@ module StreamRails
     def inject_objects(activities, objects)
       create_activity_results(activities).each do |activity|
         activity.select { |k, _v| @fields.include? k.to_sym }.each do |field, value|
-          next unless self.model_field?(value)
+          next unless model_field?(value)
           model, id = value.split(':')
           activity[field] = objects[model][id] || value
           activity.track_not_enriched_field(field, value) if objects[model][id].nil?

data/lib/stream_rails/sync_policies.rb

@@ -12,7 +12,7 @@ module StreamRails
             end
           end
         else
-          fail 'Your ORM is not supported'
+          raise 'Your ORM is not supported'
         end
       end
 
@@ -38,7 +38,7 @@ module StreamRails
             end
           end
         else
-          fail 'Your ORM is not supported'
+          raise 'Your ORM is not supported'
         end
       end
 

data/lib/stream_rails/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.5.0'
+  VERSION = '2.5.1'.freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: stream_rails
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Tommaso Barbugli
+- Ian Douglas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -28,16 +29,16 @@ dependencies:
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: stream-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -70,44 +71,44 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.5.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.12
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.29'
 description: 
-email: tommaso@getstream.io
+email: support@getstream.io
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io