simple-feed 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6f18bbf9e002e7f1ee3fa49a7675ea66320bc4
-  data.tar.gz: 1325dfc4fed1fe485aef9d2fcd0a75442022caee
+  metadata.gz: c0041dae8cf2aeff75f069680843b654093dad50
+  data.tar.gz: 6c21de78f66d8e964eecd08296f415061f288423
 SHA512:
-  metadata.gz: d90c16eaca736fe56ae19a4c2df0688a9267f00863f18a713ac678ec9150210e94553945636450651563af35706f4ec68dcb113fa451a7109c7376bcb5704363
-  data.tar.gz: 758243acc5437bc4f022dfbeaa5b93d3af01525ec972760fe33cca1756de220e4b2b344c5e2f7e771578f8fdb24aef662e4abad8a9ba09ace74776c0512e37d8
+  metadata.gz: 3a3377a50d75428dcc155bbb3d156fd6b8e394c845c690ec23d5a2b6e083a39feded268a40a80e16e5fe9cb33ad6f68f872a51690a0c4c3f7ada8587aad3ec54
+  data.tar.gz: 5c436ae8b4c7cac404f40aef9c7cf614c8dd8788a998d567139bd2cca0fc10c1a815943bc80374f10db8ef8375f5f6db3ee74af6c89253570b5e9b4ed78b5baf

data/.travis.yml

@@ -1,7 +1,7 @@
 cache: bundler
 rvm:
-- 2.3.1
-- 2.4.0-preview2
+- 2.3.3
+- 2.4.0
 services:
 - redis-server
 before_script:

data/README.md

@@ -1,69 +1,56 @@
 # SimpleFeed — Scalable, easy to use activity feed implementation.
 
-[![Gem Version](https://badge.fury.io/rb/simple-feed.svg)](https://badge.fury.io/rb/simple-feed)
+
+[![Gem Version](https://img.shields.io/gem/v/simple-feed.svg)](https://rubygems.org/gems/simple-feed)
 [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kigster/simple-feed/master/LICENSE.txt)
+
 [![Build Status](https://travis-ci.org/kigster/simple-feed.svg?branch=master)](https://travis-ci.org/kigster/simple-feed)
 [![Code Climate](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/badges/8b899f6df4fc1ed93759/gpa.svg)](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/feed)
 [![Test Coverage](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/badges/8b899f6df4fc1ed93759/coverage.svg)](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/coverage)
 [![Issue Count](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/badges/8b899f6df4fc1ed93759/issue_count.svg)](https://codeclimate.com/repos/58339a5b3d9faa74ac006b36/feed)
 [![Inline docs](http://inch-ci.org/github/kigster/simple-feed.svg?branch=master)](http://inch-ci.org/github/kigster/simple-feed)
+[![Talk on Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/kigster/simple-feed)
 
-This is a fast, pure-ruby implementation of an activity feed concept commonly used in social networking applications. The implementation is optimized for **read-time performance** and high concurrency (lots of users), and can be extended with custom backend providers. Two providers come bundled: the production-ready Redis provider, and a naive pure Hash-based provider.
-
-__Important Notes and Acknowledgements:__
+---
 
- * SimpleFeed *does not depend on Ruby on Rails* and is a __pure-ruby__ implementation. 
- * __SimpleFeed requires ruby 2.3 or later.__
- * SimpleFeed is currently live in production.
- * We'd like to thank __[Simbi, Inc — Symbiotic Economy](http://simbi.com)__ for their sponsorship of the development of this open source library.
+**February 20th, 2017**: Please read the blog post [Feeding Frenzy with SimpleFeed](http://kig.re/2017/02/19/feeding-frenzy-with-simple-feed-activity-feed-ruby-gem.html) launching this library. Please leave comments or questions in the discussion thread at the bottom of that post. Thanks! 
 
-## What is an activity feed?
+---
 
-> Activity feed is a visual representation of a time-ordered, reverse chronological list of events which can be:
->
-> * personalized for a given user or a group, or global
-> * aggregated across several actors for a similar event type, eg. "John, Mary, etc.. followed George"
-> * filtered by a certain characteristic, such as:
->   * the actor producing an event — i.e. people you follow on a social network, or "yourself" for your own activity
->   * the type of an event (i.e. posts, likes, comments, stories, etc)
->   * the target of an event (commonly a user, but can also be a thing you are interested in, e.g. a github repo you are watching)
+If you like to see this project grow, your donation of any amount is much appreciated.
 
-Here is an example of a real feed powered by this library, and which is very common on today's social media sites:
+[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=FSFYYNEQ8RKWU)
 
-[![Example](https://raw.githubusercontent.com/kigster/simple-feed/master/man/activity-feed-action.png)](https://raw.githubusercontent.com/kigster/simple-feed/master/man/activity-feed-action.png)
+---
 
-What you publish into your feed — i.e. _stories_ or _events_, will depend entirely on your application. SimpleFeed should be able to power the most demanding *write-time* feeds.
+This is a fast, pure-ruby implementation of an activity feed concept commonly used in social networking applications. The implementation is optimized for **read-time performance** and high concurrency (lots of users), and can be extended with custom backend providers. Two providers come bundled: the production-ready Redis provider, and a naive Ruby Hash-based provider.
 
-## Challenges 
+__Important Notes and Acknowledgements:__
 
-Building a personalized activity feed tends to be a challenging task, due to the diversity of event types that it often includes, the personalization requirement, and the need for it to often scale to very large numbers of concurrent users.  Therefore common implementations tend to focus on either:
+ * SimpleFeed *does not depend on Ruby on Rails* and is a __pure-ruby__ implementation
+ * SimpleFeed requires ruby 2.3 or later
+ * SimpleFeed is currently live in production
+ * SimpleFeed is open source thanks to the generosity of __[Simbi, Inc](http://simbi.com)__.
 
- * optimizing the read time performance by pre-computing the feed for each user ahead of time
- * OR optimizing the various ranking algorithms by computing the feed at read time, with complex forms of caching addressing the performance requirements.
- 
-The first type of feed is much simpler to implement on a large scale (up to a point), and it scales well if the data is stored in a light-weight in-memory storage such as Redis. This is exactly the approach this library takes.
+## Background, Examples, Serialization, etc
 
-For more information about various types of feed, and the typical architectures that power them — please read:
+Please read the additional documentation, including the examples, on the [project's Github Wiki](https://github.com/kigster/simple-feed/wiki).
 
- - ["How would you go about building an activity feed like Facebook?"](https://hashnode.com/post/architecture-how-would-you-go-about-building-an-activity-feed-like-facebook-cioe6ea7q017aru53phul68t1/answer/ciol0lbaa02q52s530vfqea0t) by [Lee Byron](https://hashnode.com/@leebyron).
- - ["Feeding Frenzy: Selectively Materializing Users’ Event Feeds"](http://jeffterrace.com/docs/feeding-frenzy-sigmod10-web.pdf) (Yahoo! Research paper).
+## Usage
 
-## Overview
+A key concept to understanding SimpleFeed gem, is that of a _provider_, which is effectively a persistence implementation for the events belonging to each user.
 
-The feed library aims to address the following goals:
+Two providers are supplied with this gem:
 
-* To define a minimalistic API for a typical event-based simple feed, without tying it to any concrete provider implementation
-* To make it easy to implement and plug in a new type of provider, eg. using *Couchbase* or *MongoDB*
-* To provide a scalable default provider implementation using Redis, which can support millions of users via sharding
-* To support multiple simple feeds within the same application, but used for different purposes, eg. simple feed of my followers, versus simple feed of my own actions.
+ * The production-ready `:redis` provider, which uses the [sorted set Redis data type](https://redislabs.com/ebook/redis-in-action/part-2-core-concepts-2/chapter-3-commands-in-redis/3-5-sorted-sets) to store and fetch the events, scored by time (but not necessarily). 
 
-## Usage
+ * The naïve `:hash` provider based on the ruby `Hash` class, that can be useful in unit tests, or in simple simulations. 
 
-First you need to configure the Feed with a valid provider implementation and a name.
+You initialize a provider by using the `SimpleFeed.provider([Symbol])` method.
 
 ### Configuration
 
-Below we configure a feed called `:newsfeed`, which presumably will be populated with the events coming from the followers.
+Below we configure a feed called `:newsfeed`, which in this example will be populated with the various events coming from the followers. 
 
 ```ruby
 require 'simplefeed'
@@ -110,7 +97,7 @@ application, not just the one that published the event (which is the
 case for the "toy" `Hash::Provider`.
 
 ```ruby
-activity.paginate(page: 1)
+activity.paginate(page: 1, reset_last_read: true)
 # => [ <SimpleFeed::Event#0x2134afa value='hello' at='2016-11-20 23:32:56 -0800'> ]
 ```
 
@@ -158,8 +145,8 @@ activity.unread_count                                     # => 0
 activity.store(value: 'hello')                            # => true
 activity.store(value: 'goodbye', at: Time.now - 20)       # => true
 activity.unread_count                                     # => 2
-# Now we can paginate the events, which by default resets "last_read" timestamp the user
-activity.paginate(page: 1)
+# Now we can paginate the events, while resetting this user's last-read timestamp:
+activity.paginate(page: 1, reset_last_read: true)
 # [
 #     [0] #<SimpleFeed::Event: value=good bye, at=1480475294.0579991>,
 #     [1] #<SimpleFeed::Event: value=hello, at=1480475294.057138>
@@ -179,7 +166,7 @@ end
 activity.total_count                                      # => 0
 ```
 
-You can fetch all items (optionally filtered by time) in the feed using `#fetch`, and you can
+You can fetch all items (optionally filtered by time) in the feed using `#fetch`, 
 `#paginate` and reset the `last_read` timestamp by passing the `reset_last_read: true` as a parameter.
 
 <a name="batch-api"/>
@@ -296,7 +283,10 @@ end
 # => [Response] { user_id => [Boolean], ... } true if user activity was found and deleted, false otherwise
 
 # Return a paginated list of all items, optionally with the total count of items
-@multi.paginate(page:, per_page:, with_total: false, reset_last_read: false)
+@multi.paginate(page: 1, 
+                per_page: @multi.feed.per_page, 
+                with_total: false, 
+                reset_last_read: false)
 # => [Response] { user_id => [Array]<Event>, ... }
 # Options:
 #   reset_last_read: false — reset last read to Time.now (true), or the provided timestamp
@@ -325,21 +315,26 @@ end
 
 ```
 
-## Providers
+## Providers in Depth 
 
-A provider is an underlying implementation that persists the events for each user, together with some meta-data for each feed.
+As we've discussed above, a provider is an underlying persistence mechanism implementation. 
 
 It is the intention of this gem that:
 
- * it should be easy to swap providers
- * it should be easy to add new providers
+ * it should be easy to write new providers 
+ * it should be easy to swap out providers
 
-Each provider must implement exactly the public API of a provider shown
-above (the `Feed` version, that receives `user_ids:` as arguments).
+To create a new provider please use `SimpleFeed::Providers::Hash::Provider` class as a starting point.
 
 Two providers are available with this gem:
 
- * `SimpleFeed::Providers::Redis::Provider` is the production-ready provider that uses the [sorted set Redis data type](https://redislabs.com/ebook/redis-in-action/part-2-core-concepts-2/chapter-3-commands-in-redis/3-5-sorted-sets) and their operations operations to store the events, scored by their time typically (but not necessarily). This provider is highly optimized for massive writes and can be sharded by using a _Twemproxy_ backend, and many small Redis shards.
+### `SimpleFeed::Providers::Redis::Provider` 
+
+Redis Provider is a production-ready persistence adapter that uses the [sorted set Redis data type](https://redislabs.com/ebook/redis-in-action/part-2-core-concepts-2/chapter-3-commands-in-redis/3-5-sorted-sets). 
+
+This provider is optimized for large writes and can use either a single Redis instance for all users of your application, or any number of Redis [shards](https://en.wikipedia.org/wiki/Shard_(database_architecture)) by using a [_Twemproxy_](https://github.com/twitter/twemproxy) in front of the Redis shards. 
+
+While future 
 
  * `SimpleFeed::Providers::HashProvider` is a pure Hash-like implementation of a provider that can be useful in unit tests of a host application. This provider could be used to write and read events within a single ruby process, can be serialized to and from a YAML file, and is therefore intended primarily for Feed emulations in automated tests.
   

data/Rakefile

@@ -4,6 +4,20 @@ require 'rspec/core/rake_task'
 require 'yard'
 
 
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :permissions do
+  shell('rm -rf pkg/')
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task :build => :permissions
+
+
 YARD::Rake::YardocTask.new(:doc) do |t|
   t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE.txt)
   t.options.unshift('--title', '"SimpleFeed — Fast and Scalable "write-time" Simple Feed for Social Networks, with a Redis-based default backend implementation."')

data/examples/shared/provider_example.rb

@@ -40,8 +40,8 @@ with_activity(@activity) do
 
   header 'paginate(page: 1, per_page: 2)'
   paginate(page: 1, per_page: 2) { |r| puts r[@uid].map(&:to_color_s) }
-  header 'paginate(page: 2, per_page: 2)'
-  paginate(page: 2, per_page: 2) { |r| puts r[@uid].map(&:to_color_s) }
+  header 'paginate(page: 2, per_page: 2, reset_last_read: true)'
+  paginate(page: 2, per_page: 2, reset_last_read: true) { |r| puts r[@uid].map(&:to_color_s) }
 
   hr
 

data/lib/simplefeed.rb

@@ -1,6 +1,8 @@
 require 'hashie/extensions/symbolize_keys'
 require 'simplefeed/version'
 
+Hashie.logger = Logger.new(nil)
+
 ::Dir.glob(::File.expand_path('../simplefeed/*.rb', __FILE__)).each { |f| require_relative(f) }
 
 require 'simplefeed/providers/redis'

data/lib/simplefeed/providers/base/provider.rb

@@ -20,12 +20,6 @@ module SimpleFeed
           SimpleFeed::Providers.register(class_to_registry(klass), klass)
         end
 
-        # SimpleFeed::Providers::REQUIRED_METHODS.each do |m|
-        #   define_method(m) do |*|
-        #     raise ::SimpleFeed::Providers::NotImplementedError.new(self, m)
-        #   end
-        # end
-
         protected
 
         def reset_last_read_value(user_ids:, at: nil)

data/lib/simplefeed/providers/redis/driver.rb

@@ -121,12 +121,7 @@ SimpleFeed::Redis::Driver.new(redis: { host: 'localhost', port: 6379, db: 1, tim
           send_proc = redis_method if redis_method.respond_to?(:call)
           send_proc ||= ->(redis) { redis.send(redis_method, *args, &block) }
 
-          if opts[:pipelined]
-            opts.delete :pipelined
-            with_pipelined { |redis| send_proc.call(redis) }
-          else
-            with_redis { |redis| send_proc.call(redis) }
-          end
+          with_redis { |redis| send_proc.call(redis) }
         end
 
         class MockRedis

data/lib/simplefeed/providers/redis/provider.rb

@@ -9,8 +9,6 @@ require 'simplefeed/providers/key'
 require_relative 'driver'
 require_relative 'stats'
 
-require 'pp'
-
 module SimpleFeed
   module Providers
     module Redis

data/lib/simplefeed/version.rb

@@ -1,3 +1,3 @@
 module SimpleFeed
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-feed
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Konstantin Gredeskoul
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-29 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base62-rb
@@ -314,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Create multiple types of social networking activity feeds with simple-feed