livefyre 1.1.4 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YWNlMjA0YzI2MmY2MTE4ZDVjODFhMmIyOWU4NGQ4MjY5NDBlMGQ2ZQ==
+    ZGUyOTkxOWQwN2MzZWRmYTZiMjhlMjhiNTliNTU4NTg2N2M5YjVkYg==
   data.tar.gz: !binary |-
-    YmNkMGRkZWE5MDY3N2Y1NmM2MDI2NzFiNjg0ZjcwMTkxMTA0NDAyOQ==
+    ZTlmOWRlMWU4NTI0NzI5ODM1YmJlN2U1NzkzODA2M2MxMzExOGJmYQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmY0ODM1ZmZiMzk1Y2EwNzJmMmFjY2MwMTc2ZDc2NTY2MjlhNTFjZDI3YmE4
-    ZjcwNDI2NWQxMzkwZjZmNDJlOTk0YWJhMzZiMTEyMjhjZDUwZjc0MGMwN2Mz
-    NDNiMmJlOTFlZmVlYWVhYjE0MWFmNzYyMmMwOWY3M2E0ZDdkMDE=
+    YjM4ZWIyMWM2YjdhMzVhMjRiZTI4YTZjMzMwNzNjNjFhZjIwMTFkZDE3OTkx
+    YmRkZDIzZTY3MjlmOGM4NmY0ZDEzNmMxZDA2YWYyZDBlMmQxZDU0YTg1MzZi
+    ZGQxNmJlOTA0ZGEwMDBkZGQ0MjNmYzFiOTA4MTg0N2UwNzhmZjE=
   data.tar.gz: !binary |-
-    MDRlYmJjN2U5MWExNmUyZWI4ZDUzYmYyYmU4ZDliMGIxMzdhM2Y4YWIwZjg1
-    NjkyNzZmYWRkM2E0ZTg0ZGRhNWM2NTQ5MDVkZTU3ZjM0ZDQ4NjkyYTQ5ZGJm
-    OTRhM2ZlZTUzZDg0MjBmZWU4NzQ3OThjZDBmNzhhZjNkNDFjYjg=
+    MmY1NjUwNjk3OTE4Nzc2ZTI4ZWI3MWFkMzFjYmFkZmIwNzJjZGMyMjJiODZh
+    OGRmNjc2NDlmNDRhODM4N2NhNzgzYmZkZGI5NWQyODdmMGU3ZDQ3YWJiNTcy
+    OTAxOTZhMTgxYzA3MzA5ODM5N2E5MmI3NmEzNzI4ZmVjODc4MjQ=

data/.gitignore

@@ -15,3 +15,9 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+.idea/livefyre-ruby-utils.iml
+
+.idea/workspace.xml
+
+.idea/livefyre-ruby-utils.iml

data/.idea/.name

@@ -0,0 +1 @@
+livefyre-ruby-utils

data/.idea/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build livefyre-1.1.4.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Build and install livefyre-1.1.4.gem into system gems" fullCmd="install" taksId="install" /><RakeTask description="Create tag v1.1.4 and build and push livefyre-1.1.4.gem to Rubygems" fullCmd="release" taksId="release" /><RakeTask description="" fullCmd="run_tests" taksId="run_tests" /></RakeGroup></Settings>

data/.idea/encodings.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
+</project>
+

data/.idea/misc.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-1.9.3-p484 [global]" project-jdk-type="RUBY_SDK" />
+</project>
+

data/.idea/modules.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/livefyre-ruby-utils.iml" filepath="$PROJECT_DIR$/.idea/livefyre-ruby-utils.iml" />
+    </modules>
+  </component>
+</project>
+

data/.idea/scopes/scope_settings.xml

@@ -0,0 +1,5 @@
+<component name="DependencyValidationManager">
+  <state>
+    <option name="SKIP_IMPORT_STATEMENTS" value="false" />
+  </state>
+</component>

data/.idea/vagrant.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VagrantProjectSettings">
+    <option name="instanceFolder" value="" />
+    <option name="provider" value="" />
+  </component>
+</project>
+

data/.idea/vcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
+

data/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>livefyre-ruby-utils</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 1.3.0 2014-07-30
+
+*** CAUTION: THIS VERSION HAS UPDATED METHODS THAT MAKE PREVIOUS FUNCTION CALLS OBSOLETE ***
+
+* Jumped from 1.1.0 to 1.3.0 to match other libraries.
+* Added personal stream and timeline support.
+* Updated most API to use SSL.
+* Added create_collection method.
+* Updated checksum formula to match other libraries.
+* Refactored core objects.
+* Updated create_collection_meta to take in a dict of optional params.
+
 === 1.1.4 2014-05-07
 
 * Added changelog.

data/README.md

@@ -53,10 +53,10 @@ site = network.get_site('site_id', 'site_key')
 ```
 
 Building a collection meta token:
-*The 'tags' and type' arguments are optional.*
+*The {options} argument is optional.*
 
 ```ruby
-site.build_collection_meta_token('title', 'article_id', 'url', 'tags', 'type')
+site.build_collection_meta_token('title', 'article_id', 'url', {options})
 ```
 
 Building a checksum:
@@ -78,7 +78,7 @@ To get a content collection's id:
 site.get_collection_id('article_id')
 ```
 
-## Documentation
+## Additional Documentation
 
 Located [here](http://answers.livefyre.com/developers/libraries).
 

data/lib/livefyre.rb

@@ -1,4 +1,4 @@
-require "livefyre/core"
+require 'livefyre/core/network'
 
 module Livefyre
 	def self.get_network(network_name, network_key)

data/lib/livefyre/api/personalized_stream.rb

@@ -0,0 +1,271 @@
+require 'json'
+require 'jwt'
+require 'rest-client'
+require 'addressable/uri'
+
+require 'livefyre/entity/topic'
+require 'livefyre/entity/subscription'
+
+module Livefyre
+	class PersonalizedStream
+		# Topic API
+		def self.get_topic(core, topic_id)
+			url =  self.base_url(core) + self.topic_path(core, topic_id)
+
+			response = RestClient.get(url, self.get_headers(core))
+      data = JSON.parse(response)['data']
+
+      Topic::serialize_from_json(data['topic'])
+    end
+
+    def self.create_or_update_topic(core, topic_id, label)
+      PersonalizedStream::create_or_update_topics(core, { "#{topic_id}" => label })[0]
+    end
+
+    def self.delete_topic(core, topic)
+      PersonalizedStream::delete_topics(core, [topic]) == 1
+    end
+
+		# Multiple Topic API
+		def self.get_topics(core, limit=100, offset=0)
+			url = self.base_url(core) + self.multiple_topic_path(core)
+      url += "?limit=#{limit}&offset=#{offset}"
+
+      response = RestClient.get(url, self.get_headers(core))
+      data = JSON.parse(response)['data']
+
+      topics = []
+      data['topics'].each do |topic|
+        topics << Topic::serialize_from_json(topic)
+      end
+
+      topics
+		end
+
+		def self.create_or_update_topics(core, topic_map)
+      topics = []
+
+      topic_map.each do |key, value|
+        if not value or value.length > 128
+            raise ArgumentError, 'label cannot be longer than 128 chars.'
+        end
+        topics << Topic::create(core, key, value)
+      end
+
+			url = self.base_url(core) + self.multiple_topic_path(core)
+      headers = self.get_headers(core)
+      headers[:content_type] = :json
+
+      topics_json = []
+      topics.each do |topic|
+        topics_json << topic.to_dict
+      end
+
+      response = RestClient.post(url, {topics: topics_json}.to_json, headers)
+      JSON.parse(response)['data']
+
+      return topics
+		end
+
+		def self.delete_topics(core, topics)
+			url = self.base_url(core) + self.multiple_topic_path(core)
+      headers = self.get_headers(core)
+      headers[:content_type] = :json
+      form = {delete: self.get_ids(topics)}
+
+      response = RestClient.patch(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      data.has_key?('deleted') ? data['deleted'] : 0
+		end
+
+		# Collection Topic API
+		def self.get_collection_topics(site, collection_id)
+			url = self.base_url(site) + self.collection_topics_path(site, collection_id)
+
+      response = RestClient.get(url, self.get_headers(site))
+      data = JSON.parse(response)['data']
+
+      data.has_key?('topicIds') ? data['topicIds'] : []
+		end
+
+		def self.add_collection_topics(site, collection_id, topics)
+			url = self.base_url(site) + self.collection_topics_path(site, collection_id)
+      headers = self.get_headers(site)
+      headers[:content_type] = :json
+      form = {topicIds: self.get_ids(topics)}
+
+      response = RestClient.post(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      data.has_key?('added') ? data['added'] : 0
+		end
+
+		def self.replace_collection_topics(site, collection_id, topics)
+			url = self.base_url(site) + self.collection_topics_path(site, collection_id)
+      headers = self.get_headers(site)
+      headers[:content_type] = :json
+      form = {topicIds: self.get_ids(topics)}
+
+      response = RestClient.put(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      return data.has_key?('added') ? data['added'] : 0, data.has_key?('removed') ? data['removed'] : 0
+		end
+
+		def self.remove_collection_topics(site, collection_id, topics)
+			url = self.base_url(site) + self.collection_topics_path(site, collection_id)
+      headers = self.get_headers(site)
+      headers[:content_type] = :json
+      form = {delete: self.get_ids(topics)}
+
+      response = RestClient.patch(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      data.has_key?('removed') ? data['removed'] : 0
+		end
+
+		# Subscription API
+		def self.get_subscriptions(network, user_id)
+			url = self.base_url(network) + self.user_subscription_path(network.get_user_urn(user_id))
+
+      response = RestClient.get(url, self.get_headers(network))
+      data = JSON.parse(response)['data']
+
+      subscriptions = []
+      if data.has_key?('subscriptions')
+        data['subscriptions'].each do |sub_json|
+          subscriptions << Subscription::serialize_from_json(sub_json)
+        end
+      end
+
+      subscriptions
+		end
+
+		def self.add_subscriptions(network, user_token, topics)
+      user_id = JWT.decode(user_token, network.key)['user_id']
+      user_urn = network.get_user_urn(user_id)
+			url = self.base_url(network) + self.user_subscription_path(user_urn)
+      headers = self.get_headers(network, user_token)
+      headers[:content_type] = :json
+      form = {subscriptions: self.to_subscriptions(topics, user_urn)}
+
+      response = RestClient.post(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      data.has_key?('added') ? data['added'] : 0
+		end
+
+		def self.replace_subscriptions(network, user_token, topics)
+      user_id = JWT.decode(user_token, network.key)['user_id']
+      user_urn = network.get_user_urn(user_id)
+			url = self.base_url(network) + self.user_subscription_path(user_urn)
+      headers = self.get_headers(network, user_token)
+      headers[:content_type] = :json
+      form = {subscriptions: self.to_subscriptions(topics, user_urn)}
+
+      response = RestClient.put(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      return data.has_key?('added') ? data['added'] : 0, data.has_key?('removed') ? data['removed'] : 0
+		end
+
+		def self.remove_subscriptions(network, user_token, topics)
+      user_id = JWT.decode(user_token, network.key)['user_id']
+      user_urn = network.get_user_urn(user_id)
+			url = self.base_url(network) + self.user_subscription_path(user_urn)
+      headers = self.get_headers(network, user_token)
+      headers[:content_type] = :json
+      form = {delete: self.to_subscriptions(topics, user_urn)}
+
+      response = RestClient.patch(url, form.to_json, headers)
+      data = JSON.parse(response)['data']
+
+      data.has_key?('removed') ? data['removed'] : 0
+		end
+
+		def self.get_subscribers(network, topic, limit=100, offset=0)
+			url = self.base_url(network) + self.topic_subscription_path(topic)
+      url += "?limit=#{limit}&offset=#{offset}"
+
+      response = RestClient.get(url, self.get_headers(network))
+      data = JSON.parse(response)['data']
+
+      subscriptions = []
+      if data.has_key?('subscriptions')
+        data['subscriptions'].each do |sub_json|
+          subscriptions << Subscription::serialize_from_json(sub_json)
+        end
+      end
+
+      subscriptions
+		end
+
+		# Stream API
+		def self.get_timeline_stream(core, resource, limit=50, t_until=nil, t_since=nil)
+			url = STREAM_BASE_URL + TIMELINE_PATH
+      url += "?resource=#{resource}&limit=#{limit}"
+
+      if t_until != nil
+        url += "&until=#{t_until}"
+      elsif t_since != nil
+        url += "&since=#{t_since}"
+      end
+
+      response = RestClient.get(url, self.get_headers(core))
+
+      JSON.parse(response)
+    end
+
+    private
+
+    def self.base_url(core)
+      "https://#{core.network_name}.quill.fyre.co/api/v4"
+    end
+
+    STREAM_BASE_URL = 'https://bootstrap.livefyre.com/api/v4'
+
+    def self.topic_path(core, topic_id)
+      "/#{Topic.generate_urn(core, topic_id)}/"
+    end
+
+    def self.multiple_topic_path(core)
+      "/#{core.get_urn}:topics/"
+    end
+
+    def self.collection_topics_path(site, collection_id)
+      "/#{site.get_urn}:collection=#{collection_id}:topics/"
+    end
+
+    def self.user_subscription_path(user_urn)
+      "/#{user_urn}:subscriptions/"
+    end
+
+    def self.topic_subscription_path(topic)
+      "/#{topic.id}:subscribers/"
+    end
+
+    TIMELINE_PATH = '/timeline/'
+
+    def self.get_headers(core, user_token=nil)
+      {:accepts => :json, :authorization => 'lftoken ' + (user_token == nil ? core.build_livefyre_token : user_token)}
+    end
+
+    def self.get_ids(topics)
+      ids = []
+      topics.each do |topic|
+          ids << topic.id
+      end
+
+      ids
+    end
+
+    def self.to_subscriptions(topics, user)
+      subscriptions = []
+      topics.each do |topic|
+        subscriptions << Subscription.new(topic.id, user, SubscriptionType::PERSONAL_STREAM).to_dict
+      end
+      subscriptions
+    end
+	end
+end

data/lib/livefyre/core/network.rb

@@ -0,0 +1,75 @@
+require 'addressable/uri'
+require 'jwt'
+require 'rest-client'
+
+require 'livefyre/core/site'
+
+module Livefyre
+	class Network
+		DEFAULT_USER = 'system'
+		DEFAULT_EXPIRES = 86400
+
+		def initialize(name, key)
+			@name = name
+			@key = key
+      @network_name = name.split('.')[0]
+    end
+
+    attr_reader :name
+    attr_reader :key
+    attr_reader :network_name
+
+		def set_user_sync_url(url_template)
+			raise ArgumentError, 'url_template should contain {id}' if !url_template.include?('{id}')
+			
+			response = RestClient.post(
+					"http://#{@name}",
+					{ actor_token: build_livefyre_token, pull_profile_url: url_template }
+				)
+			response.code == 204
+		end
+
+		def sync_user(user_id)
+			response = RestClient.post(
+					"http://#{@name}/api/v3_0/user/#{user_id}/refresh",
+					{ lftoken: build_livefyre_token }
+				)
+			response.code == 200
+		end
+
+		def build_livefyre_token
+			build_user_auth_token(DEFAULT_USER, DEFAULT_USER, DEFAULT_EXPIRES)
+		end
+
+		def build_user_auth_token(user_id, display_name, expires)
+			raise ArgumentError, 'user_id must be alphanumeric' if !(user_id =~ /\A\p{Alnum}+\z/)
+
+			JWT.encode({
+					domain: @name,
+      user_id: user_id,
+          display_name: display_name,
+          expires: Time.new.to_i + expires},
+          @key)
+    end
+
+    def validate_livefyre_token(lf_token)
+      token_attributes = JWT.decode(lf_token, @key)
+
+      token_attributes['domain'] == @name \
+				&& token_attributes['user_id'] == DEFAULT_USER \
+        && token_attributes['expires'] >= Time.new.to_i
+    end
+
+    def get_site(site_id, site_key)
+      Site.new(self, site_id, site_key)
+    end
+
+    def get_urn
+      "urn:livefyre:#{@name}"
+    end
+
+    def get_user_urn(user)
+      "#{get_urn}:user=#{user}"
+    end
+	end
+end

data/lib/livefyre/core/site.rb

@@ -0,0 +1,102 @@
+require 'base64'
+require 'digest'
+require 'json'
+require 'jwt'
+require 'rest-client'
+require 'addressable/uri'
+
+module Livefyre
+	class Site
+		TYPE = %w(reviews sidenotes ratings counting liveblog livechat livecomments)
+
+		def initialize(network, id, key)
+			@network = network
+			@id = id
+			@key = key
+    end
+
+    attr_reader :network
+    attr_reader :id
+    attr_reader :key
+
+		def build_collection_meta_token(title, article_id, url, options={})
+			raise ArgumentError, 'provided url is not a valid url' if !uri?(url)
+			raise ArgumentError, 'title length should be under 255 char' if title.length > 255
+			
+			collection_meta = {
+				url: url,
+				title: title,
+				articleId: article_id
+			}
+
+			if options.has_key?(:type) && !TYPE.include?(options[:type])
+        raise ArgumentError, 'type is not a recognized type. should be liveblog, livechat, livecomments, reviews, sidenotes, or an empty string'
+			end
+
+			JWT.encode(collection_meta.merge(options), @key)
+		end
+
+		def build_checksum(title, url, tags='')
+			raise ArgumentError, 'provided url is not a valid url' if !uri?(url)
+			raise ArgumentError, 'title length should be under 255 char' if title.length > 255
+			
+			collection_meta = { tags: tags, title: title, url: url }
+			Digest::MD5.new.update(collection_meta.to_json).hexdigest
+		end
+
+
+    def create_collection(title, article_id, url, options={})
+      uri = "https://#{network_name}.quill.fyre.co/api/v3.0/site/#{@id}/collection/create/?sync=1"
+      data = {
+        articleId: article_id,
+        collectionMeta: build_collection_meta_token(title, article_id, url, options),
+        checksum: build_checksum(title, url, options.has_key?(:tags) ? options[:tags] : '')
+      }
+      headers = {:accepts => :json, :content_type => :json}
+
+      response = RestClient.post(uri, data.to_json, headers)
+
+      if response.code == 200
+        return JSON.parse(response)['data']['collectionId']
+      end
+
+      nil
+    end
+
+		def get_collection_content(article_id)
+			response = RestClient.get(
+					"https://bootstrap.livefyre.com/bs3/#{@network.name}/#{@id}/#{Base64.encode64(article_id.to_s).chomp}/init",
+					:accepts => :json
+				)
+			response.code == 200 ? JSON.parse(response) : nil
+		end
+
+		def get_collection_id(article_id)
+			content = get_collection_content(article_id)
+			if content
+				content['collectionSettings']['collectionId']
+			end
+    end
+
+    def network_name
+			@network.network_name
+    end
+
+    def build_livefyre_token
+      @network.build_livefyre_token
+    end
+
+		def get_urn
+			"#{@network.get_urn}:site=#{@id}"
+		end
+
+		def uri?(string)
+		  uri = Addressable::URI.parse(string)
+		  %w( ftp ftps http https ).include?(uri.scheme)
+		rescue Addressable::URI::BadURIError
+		  false
+		rescue Addressable::URI::InvalidURIError
+		  false
+		end
+	end
+end

data/lib/livefyre/entity/subscription.rb

@@ -0,0 +1,32 @@
+module Livefyre
+	class Subscription
+    def initialize(to, by, type, created_at=nil)
+      @to = to
+      @by = by
+      @type = type
+      @created_at = created_at
+    end
+
+    attr_reader :to
+    attr_reader :by
+    attr_reader :type
+    attr_reader :created_at
+
+    def self.serialize_from_json(json)
+      new(json['to'], json['by'], json['type'], json['createdAt'])
+    end
+
+    def to_dict
+      dict = { :to => @to, :by => @by, :type => @type }
+      if @created_at != nil
+        dict[:createdAt] = @created_at
+      end
+      dict
+    end
+
+  end
+
+  module SubscriptionType
+    PERSONAL_STREAM = 1
+  end
+end

data/lib/livefyre/entity/timeline_cursor.rb

@@ -0,0 +1,41 @@
+require 'livefyre/api/personalized_stream'
+
+module Livefyre
+	class TimelineCursor
+    def initialize(core, resource, limit, date)
+      @core = core
+      @resource = resource
+      @limit = limit
+      @next = false
+      @previous = false
+      
+      @cursor_time = date.utc.iso8601(3)
+    end
+
+    def next(limit=@limit)
+      data = PersonalizedStream::get_timeline_stream(@core, @resource, limit, nil, @cursor_time)
+      cursor = data['meta']['cursor']
+
+      @next = cursor['hasNext']
+      @previous = cursor['next'] != nil
+      @cursor_time = cursor['next']
+
+      data
+    end
+
+    def previous(limit=@limit)
+      data = PersonalizedStream::get_timeline_stream(@core, @resource, limit, @cursor_time, nil)
+      cursor = data['meta']['cursor']
+
+      @previous = cursor['hasPrev']
+      @next = cursor['prev'] != nil
+      @cursor_time = cursor['prev']
+
+      data
+    end
+    
+    def set_cursor_time(time)
+      @cursor_time = time.utc.iso8601(3)
+    end
+	end
+end

data/lib/livefyre/entity/topic.rb

@@ -0,0 +1,46 @@
+module Livefyre
+	class Topic
+    TOPIC_IDENTIFIER = ':topic='
+
+    def initialize(id, label, created_at=nil, modified_at=nil)
+      @id = id
+      @label = label
+      @created_at = created_at
+      @modified_at = modified_at
+    end
+
+    attr_reader :id
+    attr_reader :label
+    attr_reader :created_at
+    attr_reader :modified_at
+
+    def self.create(core, id, label)
+      new(Topic::generate_urn(core, id), label)
+    end
+
+    def self.serialize_from_json(json)
+      new(json['id'], json['label'], json['createdAt'], json['modifiedAt'])
+    end
+
+    def to_dict
+      json = { :id => @id, :label => @label }
+      if @created_at != nil
+        json[:createdAt] = @created_at
+      end
+
+      if @modified_at != nil
+        json[:modifiedAt] = @modified_at
+      end
+
+      json
+    end
+
+    def self.generate_urn(core, id)
+      "#{core.get_urn}#{TOPIC_IDENTIFIER}#{id}"
+    end
+
+    def get_truncated_id
+      @id[@id.index(TOPIC_IDENTIFIER) + TOPIC_IDENTIFIER.length]
+    end
+	end
+end

data/lib/livefyre/factory/cursor_factory.rb

@@ -0,0 +1,15 @@
+require 'livefyre/entity/timeline_cursor'
+
+module Livefyre
+  class CursorFactory
+    def self.get_topic_stream_cursor(core, topic, limit=50, date=Time.new)
+      resource = "#{topic.id}:topicStream"
+      TimelineCursor.new(core, resource, limit, date)
+    end
+
+    def self.get_personal_stream_cursor(network, user, limit=50, date=Time.new)
+      resource = "#{network.get_user_urn(user)}:personalStream"
+      TimelineCursor.new(network, resource, limit, date)
+    end
+  end
+end

data/lib/livefyre/version.rb

@@ -1,3 +1,3 @@
 module Livefyre
-  VERSION = "1.1.4"
+  VERSION = '1.3.0'
 end

data/spec/livefyre/api/personalized_stream_spec.rb

@@ -0,0 +1,65 @@
+require 'livefyre'
+require 'jwt'
+require 'livefyre/api/personalized_stream'
+require 'livefyre/factory/cursor_factory'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :broken => true
+end
+
+describe Livefyre::Network, :broken => true do
+  before(:each) do
+    @network = Livefyre.get_network(NETWORK_NAME, NETWORK_KEY)
+    @site = @network.get_site(SITE_ID, SITE_KEY)
+  end
+
+  it 'should test that personalized streams api work for topics' do
+    Livefyre::PersonalizedStream::create_or_update_topic(@network, 1, 'EINS')
+    topic = Livefyre::PersonalizedStream::get_topic(@network, 1)
+    Livefyre::PersonalizedStream::delete_topic(@network, topic).should == true
+
+    Livefyre::PersonalizedStream::create_or_update_topics(@network, {1 => 'EINS', 2 => 'ZWEI'})
+    topics = Livefyre::PersonalizedStream::get_topics(@network)
+    Livefyre::PersonalizedStream::delete_topics(@network, topics)
+  end
+
+  it 'should test that personalized streams api work for subscriptions' do
+    topics = Livefyre::PersonalizedStream::create_or_update_topics(@network, {1 => 'EINS', 2 => 'ZWEI'})
+    user_token = @network.build_user_auth_token(USER_ID, "#{USER_ID}@#{NETWORK_NAME}", Livefyre::Network::DEFAULT_EXPIRES)
+
+    Livefyre::PersonalizedStream::add_subscriptions(@network, user_token, topics)
+    Livefyre::PersonalizedStream::get_subscriptions(@network, USER_ID)
+    Livefyre::PersonalizedStream::replace_subscriptions(@network, user_token, [topics[1]])
+    Livefyre::PersonalizedStream::get_subscribers(@network, topics[1])
+    Livefyre::PersonalizedStream::remove_subscriptions(@network, user_token, [topics[1]])
+  end
+
+  it 'should test that personalized streams api work for timelines and cursors' do
+    topic = Livefyre::PersonalizedStream::create_or_update_topic(@network, 1, 'EINS')
+    cursor = Livefyre::CursorFactory::get_topic_stream_cursor(@network, topic)
+
+    cursor.next
+    cursor.previous
+
+    Livefyre::PersonalizedStream::delete_topic(@network, topic)
+  end
+
+  it 'should test that personalized streams api work for topics' do
+    Livefyre::PersonalizedStream::create_or_update_topic(@site, 1, 'EINS')
+    topic = Livefyre::PersonalizedStream::get_topic(@site, 1)
+    Livefyre::PersonalizedStream::delete_topic(@site, topic).should == true
+
+    Livefyre::PersonalizedStream::create_or_update_topics(@site, {1 => 'EINS', 2 => 'ZWEI'})
+    topics = Livefyre::PersonalizedStream::get_topics(@site)
+    Livefyre::PersonalizedStream::delete_topics(@site, topics)
+  end
+
+  it 'should test that personalized streams api work for collections' do
+    topics = Livefyre::PersonalizedStream::create_or_update_topics(@site, {1 => 'EINS', 2 => 'ZWEI'})
+
+    Livefyre::PersonalizedStream::add_collection_topics(@site, COLLECTION_ID, topics)
+    Livefyre::PersonalizedStream::get_collection_topics(@site, COLLECTION_ID)
+    Livefyre::PersonalizedStream::replace_collection_topics(@site, COLLECTION_ID, [topics[1]])
+    Livefyre::PersonalizedStream::remove_collection_topics(@site, COLLECTION_ID, [topics[1]])
+  end
+end

data/spec/livefyre/core/network_spec.rb

@@ -0,0 +1,24 @@
+require 'livefyre'
+require 'jwt'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :broken => true
+end
+
+describe Livefyre::Network do
+  before(:each) do
+    @network = Livefyre.get_network(NETWORK_NAME, NETWORK_KEY)
+  end
+
+  it 'should raise ArgumentError if url_template does not contain {id}' do
+    expect{ @network.set_user_sync_url('blah.com/') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise ArgumentError if user_id is not alphanumeric' do
+    expect{ @network.build_user_auth_token('fjoiwje.1fj', 'test', 100) }.to raise_error(ArgumentError)
+  end
+
+  it 'should validate a livefyre token' do
+    @network.validate_livefyre_token(@network.build_livefyre_token).should == true
+  end
+end

data/spec/livefyre/core/site_spec.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+require 'livefyre'
+require 'jwt'
+
+RSpec.configure do |c|
+  c.filter_run_excluding :broken => true
+end
+
+describe Livefyre::Site do
+  before(:each) do
+    @site = Livefyre.get_network(NETWORK_NAME, NETWORK_KEY).get_site(SITE_ID, SITE_KEY)
+  end
+
+  it 'should raise ArgumentError if url is not a valid url for cmt' do
+    expect{ @site.build_collection_meta_token('test', 'test', 'blah.com/', 'test') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise ArgumentError if title is more than 255 characters for cmt' do
+    expect{ @site.build_collection_meta_token('1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456', 'test', 'http://test.com', 'test') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise ArgumentError if not a valid type is passed in when building a collection meta token' do
+    expect{ @site.build_collection_meta_token('', '', 'http://livefyre.com', {type: 'bad type'}) }.to raise_error(ArgumentError)
+  end
+
+  it 'should check type and assign them to the correct field in the collection meta token' do
+    @token = @site.build_collection_meta_token('', '', 'http://livefyre.com', {tags: '', type: 'reviews'})
+    @decoded = JWT.decode(@token, SITE_KEY)
+
+    expect(@decoded['type']).to eq('reviews')
+
+    @token = @site.build_collection_meta_token('', '', 'http://livefyre.com', {type: 'liveblog'})
+    @decoded = JWT.decode(@token, SITE_KEY)
+
+    expect(@decoded['type']).to eq('liveblog')
+  end
+
+  it 'should return a collection meta token' do
+    expect{ @site.build_collection_meta_token('title', 'article_id', 'https://www.url.com', 'tags') }.to be_true
+  end
+
+  it 'should raise ArgumentError if url is not a valid url for checksum' do
+    expect{ @site.build_checksum('test', 'blah.com/', 'test') }.to raise_error(ArgumentError)
+  end
+
+  it 'should raise ArgumentError if title is more than 255 characters for checksum' do
+    expect{ @site.build_checksum('1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456', 'http://test.com', 'test') }.to raise_error(ArgumentError)
+  end
+
+  it 'should return a valid checksum' do
+    expect(@site.build_checksum('title', 'https://www.url.com', 'tags')).to eq('4464458a10c305693b5bf4d43a384be7')
+  end
+
+  it 'should check for valid and invalid urls' do
+    expect{ @site.build_checksum('', 'test.com', '') }.to raise_error(ArgumentError)
+
+    @site.build_checksum('', 'http://localhost:8000', '')
+    @site.build_checksum('', 'http://清华大学.cn', '')
+    @site.build_checksum('', 'http://www.mysite.com/myresumé.html', '')
+    @site.build_checksum('', 'https://test.com/', '')
+    @site.build_checksum('', 'ftp://test.com/', '')
+    @site.build_checksum('', "https://test.com/path/test.-_~!$&'()*+,;=:@/dash", '')
+  end
+
+  it 'should test basic site api', :broken => true do
+    @site.get_collection_content(ARTICLE_ID)
+
+    name = "RubyCreateCollection#{Time.new}"
+    id = @site.create_collection(name, name, 'http://answers.livefyre.com/RUBY')
+    expect(@site.get_collection_id(name)).to eq(id)
+  end
+end

data/spec/livefyre/test_spec.rb

@@ -0,0 +1,7 @@
+NETWORK_NAME = '<NETWORK-NAME>'
+NETWORK_KEY = '<NETWORK-KEY>'
+SITE_ID = '<SITE-ID>'
+SITE_KEY = '<SITE-KEY>'
+COLLECTION_ID = '<COLLECTION-ID>'
+USER = '<USER-ID>'
+ARTICLE_ID = '<ARTICLE-ID>'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livefyre
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Livefyre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,16 +126,34 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .idea/.name
+- .idea/.rakeTasks
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/scopes/scope_settings.xml
+- .idea/vagrant.xml
+- .idea/vcs.xml
+- .project
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/livefyre.rb
-- lib/livefyre/core.rb
+- lib/livefyre/api/personalized_stream.rb
+- lib/livefyre/core/network.rb
+- lib/livefyre/core/site.rb
+- lib/livefyre/entity/subscription.rb
+- lib/livefyre/entity/timeline_cursor.rb
+- lib/livefyre/entity/topic.rb
+- lib/livefyre/factory/cursor_factory.rb
 - lib/livefyre/version.rb
 - livefyre.gemspec
-- spec/livefyre/core_spec.rb
+- spec/livefyre/api/personalized_stream_spec.rb
+- spec/livefyre/core/network_spec.rb
+- spec/livefyre/core/site_spec.rb
+- spec/livefyre/test_spec.rb
 homepage: http://github.com/livefyre/livefyre-ruby-utils
 licenses:
 - MIT
@@ -164,5 +182,8 @@ signing_key:
 specification_version: 4
 summary: Livefyre Ruby utility classes
 test_files:
-- spec/livefyre/core_spec.rb
+- spec/livefyre/api/personalized_stream_spec.rb
+- spec/livefyre/core/network_spec.rb
+- spec/livefyre/core/site_spec.rb
+- spec/livefyre/test_spec.rb
 has_rdoc: 

data/lib/livefyre/core.rb

@@ -1,129 +0,0 @@
-require 'base64'
-require 'digest'
-require 'json'
-require 'jwt'
-require 'rest-client'
-require 'addressable/uri'
-
-module Livefyre
-	class Network
-		DEFAULT_USER = 'system'
-		DEFAULT_EXPIRES = 86400
-
-		def initialize(network_name, network_key)
-			@network_name = network_name
-			@network_key = network_key  
-		end
-
-		def set_user_sync_url(url_template)
-			raise ArgumentError, 'url_template should contain {id}' if !url_template.include?('{id}')
-			
-			response =
-				RestClient.post(
-					"http://#{@network_name}",
-					{ actor_token: build_livefyre_token, pull_profile_url: url_template }
-				)
-			response.code == 204
-		end
-
-		def sync_user(user_id)
-			response =
-				RestClient.post(
-					"http://#{@network_name}/api/v3_0/user/#{user_id}/refresh",
-					{ lftoken: build_livefyre_token }
-				)
-			response.code == 200
-		end
-
-		def build_livefyre_token
-			build_user_auth_token(DEFAULT_USER, DEFAULT_USER, DEFAULT_EXPIRES)
-		end
-
-		def build_user_auth_token(user_id, display_name, expires)
-			raise ArgumentError, 'user_id must be alphanumeric' if !(user_id =~ /\A\p{Alnum}+\z/)
-
-			JWT.encode({
-					domain: @network_name,
-					user_id: user_id,
-					display_name: display_name,
-					expires: Time.new.to_i + expires},
-				@network_key)
-		end
-		
-		def validate_livefyre_token(lf_token)
-			token_attributes = JWT.decode(lf_token, @network_key)
-
-			token_attributes['domain'] == @network_name \
-				&& token_attributes['user_id'] == DEFAULT_USER \
-				&& token_attributes['expires'] >= Time.new.to_i
-		end
-		
-		def get_site(site_id, site_key)
-			Site.new(@network_name, site_id, site_key)
-		end
-
-		class Site
-			TYPE = ['reviews', 'sidenotes', 'ratings', 'counting', 'liveblog', 'livechat', 'livecomments']
-
-			def initialize(network_name, site_id, site_key)
-				@network_name = network_name
-				@site_id = site_id
-				@site_key = site_key
-			end
-	
-			def build_collection_meta_token(title, article_id, url, tags='', type=nil)
-				raise ArgumentError, 'provided url is not a valid url' if !uri?(url)
-				raise ArgumentError, 'title length should be under 255 char' if title.length > 255
-				
-				collection_meta = {
-					url: url,
-					tags: tags,
-					title: title,
-					articleId: article_id
-				}
-				if type
-					if TYPE.include? type
-						collection_meta[:type] = type
-					else
-						raise ArgumentError, 'type is not a recognized type. should be liveblog, livechat, livecomments, reviews, sidenotes, or an empty string'
-					end
-				end
-
-				JWT.encode(collection_meta, @site_key)
-			end
-
-			def build_checksum(title, url, tags='')
-				raise ArgumentError, 'provided url is not a valid url' if !uri?(url)
-				raise ArgumentError, 'title length should be under 255 char' if title.length > 255
-				
-				collection_meta = { url: url, tags: tags, title: title }
-				Digest::MD5.new.update(collection_meta.to_json).hexdigest
-			end
-	
-			def get_collection_content(article_id)
-				response = 
-					RestClient.get(
-						"http://bootstrap.#{@network_name}/bs3/#{@network_name}/#{@site_id}/#{Base64.encode64(article_id.to_s()).chomp}/init",
-						:accepts => :json
-					)
-				response.code == 200 ? JSON.parse(response) : nil
-			end
-
-			def get_collection_id(article_id)
-				content = get_collection_content(article_id)
-				if content
-					content['collectionSettings']['collectionId']
-				end
-			end
-
-			def uri?(string)
-			  uri = Addressable::URI.parse(string)
-			  %w( ftp ftps http https ).include?(uri.scheme)
-			rescue Addressable::URI::BadURIError
-			  false
-			rescue Addressable::URI::InvalidURIError
-			  false
-			end
-		end
-	end
-end

data/spec/livefyre/core_spec.rb

@@ -1,79 +0,0 @@
-# coding: utf-8
-
-require 'livefyre'
-require 'jwt'
-
-describe Livefyre::Network do
-	before(:each) do
-		@network = Livefyre.get_network('networkName', 'networkKey')
-	end
-
-	it 'should raise ArgumentError if url_template does not contain {id}' do
-		expect{ @network.set_user_sync_url('blah.com/') }.to raise_error(ArgumentError)
-	end
-
-	it 'should raise ArgumentError if user_id is not alphanumeric' do
-		expect{ @network.build_user_auth_token('fjoiwje.1fj', 'test', 100) }.to raise_error(ArgumentError)
-	end
-
-	it 'should validate a livefyre token' do
-		@network.validate_livefyre_token(@network.build_livefyre_token).should == true
-	end
-end
-
-describe Livefyre::Network::Site do
-	before(:each) do
-		@site = Livefyre.get_network('networkName', 'networkKey').get_site('siteId', 'siteKey')
-	end
-
-	it 'should raise ArgumentError if url is not a valid url for cmt' do
-		expect{ @site.build_collection_meta_token('test', 'test', 'blah.com/', 'test') }.to raise_error(ArgumentError)
-	end
-
-	it 'should raise ArgumentError if title is more than 255 characters for cmt' do
-		expect{ @site.build_collection_meta_token('1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456', 'test', 'http://test.com', 'test') }.to raise_error(ArgumentError)
-	end
-
-	it 'should raise ArgumentError if not a valid type is passed in when building a collection meta token' do
-		expect{ @site.build_collection_meta_token('', '', 'http://livefyre.com', '', 'bad type') }.to raise_error(ArgumentError)
-	end
-
-	it 'should check type and assign them to the correct field in the collection meta token' do
-		@token = @site.build_collection_meta_token('', '', 'http://livefyre.com', '', 'reviews')
-		@decoded = JWT.decode(@token, 'siteKey')
-
-		expect(@decoded['type']).to eq('reviews')
-
-		@token = @site.build_collection_meta_token('', '', 'http://livefyre.com', '', 'liveblog')
-		@decoded = JWT.decode(@token, 'siteKey')
-
-		expect(@decoded['type']).to eq('liveblog')
-	end
-
-	it 'should return a collection meta token' do
-		expect{ @site.build_collection_meta_token('title', 'article_id', 'https://www.url.com', 'tags') }.to be_true
-	end
-
-	it 'should raise ArgumentError if url is not a valid url for checksum' do
-		expect{ @site.build_checksum('test', 'blah.com/', 'test') }.to raise_error(ArgumentError)
-	end
-
-	it 'should raise ArgumentError if title is more than 255 characters for checksum' do
-		expect{ @site.build_checksum('1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456', 'http://test.com', 'test') }.to raise_error(ArgumentError)
-	end
-
-	it 'should return a valid checksum' do
-		expect(@site.build_checksum('title', 'https://www.url.com', 'tags')).to eq('6e2e4faf7b95f896260fe695eafb34ba')
-	end
-
-	it 'should check for valid and invalid urls' do
-		expect{ @site.build_checksum('', 'test.com', '') }.to raise_error(ArgumentError)
-		
-		@site.build_checksum('', 'http://localhost:8000', '')
-		@site.build_checksum('', 'http://清华大学.cn', '')
-		@site.build_checksum('', 'http://www.mysite.com/myresumé.html', '')
-		@site.build_checksum('', 'https://test.com/', '')
-		@site.build_checksum('', 'ftp://test.com/', '')
-		@site.build_checksum('', "https://test.com/path/test.-_~!$&'()*+,;=:@/dash", '')
-	end
-end