stream_rails 2.5.2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec6bf2eb4ddd56e7c1f6f79f34eacde9c4a347bc
-  data.tar.gz: 4ebbf3afbb2c43585d214eaf926fb0a69935e791
+  metadata.gz: 918a0d96ce448ae5d5a70af7ce1d503baa645cd7
+  data.tar.gz: 4de71bec91d909a6f77deebcea62857ecbec3da0
 SHA512:
-  metadata.gz: 82cabcff2d1037dc6f42a613a8b526760a503ece29f72b2da3368abedfe58f20342a550ef8bab06557c7d330605f3e256a9580fc9fed889467fa715279ea7352
-  data.tar.gz: 12f6eb6f0770930ad46a221f0bc05da1b608fd8136384793e6a8ebc3d06f58afb74977a1101ac44e4c0a43861d4902ced531aed079b93985e2fd0ee1963f8d3a
+  metadata.gz: 7192657abdb0d6235adee6872cabda56348bc38fcd4967c96979747cb31d99aedfe678f34733fe553ff2ac76fcd2d27121f6f36415948f3c77535b216348a86f
+  data.tar.gz: a0f8b7d10f012dc9f462aab72376edbe74f8a5d27d6257001dec7c77e0a30fdc04d0eb7f1f06103e80cd4437f39d05222c3dc6f9c2bb06a8e47c89adafbab45d

data/LICENSE

@@ -1,27 +1,27 @@
-Copyright (c) 2014, Tommaso Barbugli
+Copyright (c) 2014-2017 Stream.io Inc, and individual contributors.
+
 All rights reserved.
 
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
+Redistribution and use in source and binary forms, with or without modification, are permitted
+provided that the following conditions are met:
 
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
+    1. Redistributions of source code must retain the above copyright notice, this list of
+    conditions and the following disclaimer.
 
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
+    2. Redistributions in binary form must reproduce the above copyright notice, this list of
+    conditions and the following disclaimer in the documentation and/or other materials
+    provided with the distribution.
 
-* Neither the name of the {organization} nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
+    3. Neither the name of the copyright holder nor the names of its contributors may
+    be used to endorse or promote products derived from this software without specific prior
+    written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -4,7 +4,11 @@ Stream Rails
 [![image](https://secure.travis-ci.org/GetStream/stream-rails.png?branch=master)](http://travis-ci.org/GetStream/stream-rails)
 [![Gem Version](https://badge.fury.io/rb/stream_rails.svg)](http://badge.fury.io/rb/stream_rails)
 
-This package helps you create activity streams & newsfeeds with Ruby on Rails and [GetStream.io](https://getstream.io).
+[stream-rails](https://github.com/GetStream/stream-rails) is a Ruby on Rails client for [Stream](https://getstream.io/).
+
+You can sign up for a Stream account at https://getstream.io/get_started.
+
+Note there is also a lower level [Ruby - Stream integration](https://github.com/getstream/stream-ruby) library which is suitable for all Ruby applications.
 
 ### Activity Streams & Newsfeeds
 
@@ -72,10 +76,11 @@ Then you can add the StreamRails configuration in ```config/initializers/stream_
 require 'stream_rails'
 
 StreamRails.configure do |config|
-  config.api_key     = "YOUR API KEY"
-  config.api_secret  = "YOUR API SECRET"
-  config.timeout     = 30                # Optional, defaults to 3
-  config.location    = 'us-east'         # Optional, defaults to 'us-east'
+  config.api_key      = "YOUR API KEY"
+  config.api_secret   = "YOUR API SECRET"
+  config.timeout      = 30                  # Optional, defaults to 3
+  config.location     = 'us-east'           # Optional, defaults to 'us-east'
+  config.api_hostname = 'stream-io-api.com' # Optional, defaults to 'stream-io-api.com' 
   # If you use custom feed names, e.g.: timeline_flat, timeline_aggregated,
   # use this, otherwise omit:
   config.news_feeds = { flat: "timeline_flat", aggregated: "timeline_aggregated" }
@@ -142,7 +147,7 @@ end
 ```
 Everytime a Pin is created it will be stored in the feed of the user that created it.  When a Pin instance is deleted, the feed will be removed as well.
 
-####Activity fields
+#### Activity fields
 
 ActiveRecord models are stored in your feeds as activities; Activities are objects that tell the story of a person performing an action on or with an object, in its simplest form, an activity consists of an actor, a verb, and an object. In order for this to happen your models need to implement this methods:
 
@@ -171,7 +176,7 @@ class Pin < ActiveRecord::Base
 end
 ```
 
-####Activity extra data
+#### Activity extra data
 
 Often you'll want to store more data than just the basic fields. You achieve this by implementing ```#activity_extra_data``` in your model.
 
@@ -195,7 +200,7 @@ class Pin < ActiveRecord::Base
 end
 ```
 
-####Activity creation
+#### Activity creation
 
 If you want to control when to create an activity you should implement
 the ```#activity_should_sync?``` method in your model.
@@ -221,7 +226,7 @@ end
 
 This will create an activity only when `self.published` is true.
 
-###Feed manager
+### Feed manager
 
 ```stream_rails``` comes with a Feed Manager class that helps with all common feed operations. You can get an instance of the manager with ```StreamRails.feed_manager```.
 
@@ -229,18 +234,18 @@ This will create an activity only when `self.published` is true.
 feed = StreamRails.feed_manager.get_user_feed(current_user.id)
 ```
 
-####Feeds bundled with feed_manager
+#### Feeds bundled with feed_manager
 
 To get you started the manager has 4 feeds pre-configured. You can add more feeds if your application requires it.
 Feeds are divided into three categories.
 
-#####User feed:
+##### User feed:
 The user feed stores all activities for a user. Think of it as your personal Facebook page. You can easily get this feed from the manager.
 ```ruby
 feed = StreamRails.feed_manager.get_user_feed(current_user.id)
 ```
 
-#####News feeds:
+##### News feeds:
 News feeds store activities from the people you follow.
 There is both a flat newsfeed (similar to twitter) and an aggregated newsfeed (like facebook).
 
@@ -249,7 +254,7 @@ feed = StreamRails.feed_manager.get_news_feeds(current_user.id)[:flat]
 aggregated_feed = StreamRails.feed_manager.get_news_feeds(current_user.id)[:aggregated]
 ```
 
-#####Notification feed:
+##### Notification feed:
 The notification feed can be used to build notification functionality.
 
 ![Notification feed](http://feedly.readthedocs.org/en/latest/_images/fb_notification_system.png)
@@ -306,7 +311,7 @@ class Follow < ActiveRecord::Base
 end
 ```
 
-####Follow a feed
+#### Follow a feed
 
 In order to populate newsfeeds, you need to notify the system about follow relationships.
 
@@ -328,7 +333,7 @@ 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 
+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
@@ -339,7 +344,7 @@ results = feed.get()['results']
 activities = enricher.enrich_activities(results)
 ```
 
-If you have additional metadata in your activity (by overriding `activity_extra_data` in the class where you add the 
+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:
@@ -361,9 +366,9 @@ class Pin < ActiveRecord::Base
 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 
+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
@@ -432,7 +437,7 @@ e.g. renders the activity partial using the `notifications` partial root, which
 <%= render_activity activity, :partial_root => "notifications" %>
 ```
 
-####Pagination
+#### Pagination
 
 For simple pagination you can use the [stream-ruby API](https://github.com/getstream/stream-ruby),
 as follows in your controller:
@@ -452,10 +457,20 @@ require 'stream_rails'
 StreamRails.enabled = false
 ```
 
-###Running specs
+### Running specs
 
 From the project root directory:
 
 ```
 ./bin/run_tests.sh
 ```
+
+### Full documentation and Low level APIs access
+
+When needed you can also use the [low level Ruby API](https://github.com/getstream/stream-ruby) directly. Documentation is available at the [Stream website](https://getstream.io/docs/?language=ruby).
+
+### Copyright and License Information
+
+Copyright (c) 2014-2017 Stream.io Inc, and individual contributors. All rights reserved.
+
+See the file "LICENSE" for information on the history of this software, terms & conditions for usage, and a DISCLAIMER OF ALL WARRANTIES.

data/lib/stream_rails/config.rb

@@ -4,6 +4,7 @@ module StreamRails
     attr_accessor :api_key
     attr_accessor :api_secret
     attr_accessor :location
+    attr_accessor :api_hostname
     attr_accessor :api_site_id
     attr_accessor :enabled
     attr_accessor :timeout
@@ -14,7 +15,7 @@ module StreamRails
 
     def initialize
       @enabled    = true
-      @news_feeds = { flat: 'flat', aggregated: 'aggregated' }
+      @news_feeds = { timeline: 'timeline', timeline_aggregated: 'timeline_aggregated' }
       @notification_feed = 'notification'
       @user_feed = 'user'
       @timeout = 3

data/lib/stream_rails/version.rb

@@ -1,3 +1,3 @@
 module StreamRails
-  VERSION = '2.5.2'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/lib/stream_rails.rb

@@ -19,7 +19,8 @@ module StreamRails
       config.api_secret,
       config.api_site_id,
       location: config.location,
-      default_timeout: config.timeout
+      default_timeout: config.timeout,
+      api_hostname: config.api_hostname
     )
   end
 
@@ -51,11 +52,12 @@ module StreamRails
   # All available options and their defaults are in the example below:
   # @example Initializer for Rails
   #   StreamRails.configure do |config|
-  #     config.api_key     = "key"
-  #     config.api_secret  = "secret"
-  #     config.api_site_id = "42"
-  #     config.location    = "us-east"
-  #     config.enabled     = true
+  #     config.api_key      = "key"
+  #     config.api_secret   = "secret"
+  #     config.api_site_id  = "42"
+  #     config.location     = "us-east"
+  #     config.api_hostname = "stream-io-api.com"
+  #     config.enabled      = true
   #   end
   def self.configure(&_block)
     yield(config) if block_given?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stream_rails
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.0
 platform: ruby
 authors:
 - Tommaso Barbugli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: A gem that provides a client interface for getstream.io