livefyre 1.3.2 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MTMyOTJlNDUxZTNiZjI0MWJhNjVkNTZlODFkYmRiZjc5NmIxN2EyYg==
-  data.tar.gz: !binary |-
-    MjdiM2JmM2VkZDk1NDNiOGM3MjBhMTMwNGNjZTMxNjM0NzdiYmE3Mw==
+SHA1:
+  metadata.gz: f06aa9e52cc7fc5fda39f58fa711a26bcf6e8a73
+  data.tar.gz: 7ea049454d503278566baab91602b9dbd7aecec6
 SHA512:
-  metadata.gz: !binary |-
-    N2U1OGQzOTc1MmQyOTg2Nzc5YmYwMWNmZjQ3MzlmODY2NDE0OGMyOGQzNzg5
-    OTA4ZDA4YTU5NWRhMjk5OWZiNGU0ZDEyNzBhMjM5NjI0ZjQ4MDZlY2ZjYTQ4
-    NWI3MGViMjcxMzgzOTUyZTBhMDUxODg5NWI0N2YwZDQzYWQ0MDg=
-  data.tar.gz: !binary |-
-    OWY5Y2ZjNjI2YTRjMGZhN2M3ZTk4NTVkZTdlMzM4YmE3ZmQwOGRmZGI5Yzc4
-    NjQ5MmQ4MmFkMGY5Y2U5NjEzNTkwODEzNmJlMWVhNDBkNDFlMDlmYjFjOWIw
-    MmRiMzBhZjRhOWNlM2U4NjllOTYzYTE0Y2RmYjcyOGY1OWYwOTU=
+  metadata.gz: 01772d1963e0b7f0eaf7fc3f5fd125f87b707e29c9ee56fa81796428dd1d98901a30e501202cd1a5e8eb349d2c9803da4a914a40d49077ee2e59d2984ac95461
+  data.tar.gz: 257d7ff4facaa56fcf536488fe334c6972b3160c8c9b457f8e285eed1e537b108ab461258c045f3e881dc6fd03b096fb789595977c056ab5462a4e1558f29305

data/.gitignore

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

data/CHANGELOG

@@ -1,3 +1,13 @@
+=== 2.0.0 2014-10-18
+
+* Added many more tests and test config.
+* Added coveralls for test coverage.
+* Refactored Collection related methods into its own class.
+* Restructured the library.
+* Refactored many parts of the library and updated its dependencies.
+* Added requirements to have fyre.co at end of network name.
+* Made user auth check allow dash, underscore, and dots.
+
 === 1.3.2 2014-08-12
 
 * Added SSL toggle for all API requests.

data/README.md

@@ -1,5 +1,7 @@
 # Livefyre Ruby Utility Classes
 [![Gem Version](https://badge.fury.io/rb/livefyre.png)](http://badge.fury.io/rb/livefyre)
+[![Circle CI](https://circleci.com/gh/Livefyre/livefyre-ruby-utils.png?style=badge)](https://circleci.com/gh/Livefyre/livefyre-ruby-utils)
+[![Coverage Status](https://coveralls.io/repos/Livefyre/livefyre-ruby-utils/badge.png)](https://coveralls.io/r/Livefyre/livefyre-ruby-utils)
 
 Livefyre's official library for common server-side tasks necessary for getting Livefyre apps (comments, reviews, etc.) working on your website.
 
@@ -13,72 +15,7 @@ Or install it yourself:
 
     $ gem install livefyre
 
-## Usage
-
-Instantiating a network object:
-
-```ruby
-network = Livefyre.get_network('network_name', 'network_key')
-```
-
-Building a Livefyre token:
-
-```ruby
-network.build_livefyre_token
-```
-
-Building a user auth token:
-
-```ruby
-network.build_user_auth_token('user_id', 'display_name', expires)
-```
-
-To validate a Livefyre token:
-
-```ruby
-network.validate_livefyre_token('lf_token')
-```
-
-To send Livefyre a user sync url and then have Livefyre pull user data from that url:
-
-```ruby
-network.set_user_sync_url('url_template')
-network.sync_user('user_id')
-```
-
-Instantiating a site object:
-
-```ruby
-site = network.get_site('site_id', 'site_key')
-```
-
-Building a collection meta token:
-*The {options} argument is optional.*
-
-```ruby
-site.build_collection_meta_token('title', 'article_id', 'url', {options})
-```
-
-Building a checksum:
-*The 'tags' argument is optional.*
-
-```ruby
-site.build_checksum('title', 'url', 'tags')
-```
-
-To retrieve content collection data:
-
-```ruby
-site.get_collection_content('article_id')
-```
-
-To get a content collection's id:
-
-```ruby
-site.get_collection_id('article_id')
-```
-
-## Additional Documentation
+## Documentation
 
 Located [here](http://answers.livefyre.com/developers/libraries).
 

data/circle.yml

@@ -0,0 +1,10 @@
+dependencies:
+  pre:
+  - gem install bundler #temporary as circle uses 1.6.5 at the moment
+test:
+  override:
+  - bundle exec rspec spec
+
+machine:
+  timezone:
+    America/Los_Angeles

data/lib/livefyre.rb

@@ -2,6 +2,6 @@ require 'livefyre/core/network'
 
 module Livefyre
 	def self.get_network(network_name, network_key)
-		Network.new(network_name, network_key)
+		Network.init(network_name, network_key)
 	end
 end

data/lib/livefyre/api/domain.rb

@@ -0,0 +1,15 @@
+require 'livefyre/utils/livefyre_util'
+
+module Livefyre
+  class Domain
+    def self.quill(core)
+      network = LivefyreUtil::get_network_from_core(core)
+      network.ssl ? "https://#{network.network_name}.quill.fyre.co" : "http://quill.#{network.network_name}.fyre.co"
+    end
+
+    def self.bootstrap(core)
+      network = LivefyreUtil::get_network_from_core(core)
+      network.ssl ? "https://#{network.network_name}.bootstrap.fyre.co" : "http://bootstrap.#{network.network_name}.fyre.co"
+    end
+  end
+end

data/lib/livefyre/api/personalized_stream.rb

@@ -1,11 +1,13 @@
 require 'json'
 require 'jwt'
 require 'rest-client'
-require 'addressable/uri'
 
-require 'livefyre/entity/topic'
-require 'livefyre/entity/subscription'
 require 'livefyre/api/domain'
+require 'livefyre/dto/topic'
+require 'livefyre/dto/subscription'
+require 'livefyre/exceptions/livefyre_exception'
+require 'livefyre/type/subscription_type'
+require 'livefyre/utils/livefyre_util'
 
 module Livefyre
 	class PersonalizedStream
@@ -13,8 +15,8 @@ module Livefyre
 		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']
+			response = RestClient.get(url, self.get_headers(core)){|response, request, result| response }
+      data = self.analyze_response(response)
 
       Topic::serialize_from_json(data['topic'])
     end
@@ -32,8 +34,8 @@ module Livefyre
 			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']
+      response = RestClient.get(url, self.get_headers(core)){|response, request, result| response }
+      data = self.analyze_response(response)
 
       topics = []
       data['topics'].each do |topic|
@@ -59,11 +61,11 @@ module Livefyre
 
       topics_json = []
       topics.each do |topic|
-        topics_json << topic.to_dict
+        topics_json << topic.to_hash
       end
 
-      response = RestClient.post(url, {topics: topics_json}.to_json, headers)
-      JSON.parse(response)['data']
+      response = RestClient.post(url, { :topics => topics_json }.to_json, headers){|response, request, result| response }
+      self.analyze_response(response)
 
       return topics
 		end
@@ -72,66 +74,66 @@ module Livefyre
 			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)}
+      form = { :delete => self.get_ids(topics) }
 
-      response = RestClient.patch(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.patch(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+		def self.get_collection_topics(collection)
+			url = self.base_url(collection) + self.multiple_topic_path(collection)
 
-      response = RestClient.get(url, self.get_headers(site))
-      data = JSON.parse(response)['data']
+      response = RestClient.get(url, self.get_headers(collection)){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+		def self.add_collection_topics(collection, topics)
+			url = self.base_url(collection) + self.multiple_topic_path(collection)
+      headers = self.get_headers(collection)
       headers[:content_type] = :json
-      form = {topicIds: self.get_ids(topics)}
+      form = { :topicIds => self.get_ids(topics) }
 
-      response = RestClient.post(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.post(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+		def self.replace_collection_topics(collection, topics)
+			url = self.base_url(collection) + self.multiple_topic_path(collection)
+      headers = self.get_headers(collection)
       headers[:content_type] = :json
-      form = {topicIds: self.get_ids(topics)}
+      form = { :topicIds => self.get_ids(topics) }
 
-      response = RestClient.put(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.put(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+		def self.remove_collection_topics(collection, topics)
+			url = self.base_url(collection) + self.multiple_topic_path(collection)
+      headers = self.get_headers(collection)
       headers[:content_type] = :json
-      form = {delete: self.get_ids(topics)}
+      form = { :delete => self.get_ids(topics) }
 
-      response = RestClient.patch(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.patch(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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))
+			url = self.base_url(network) + self.user_subscription_path(network.get_urn_for_user(user_id))
 
-      response = RestClient.get(url, self.get_headers(network))
-      data = JSON.parse(response)['data']
+      response = RestClient.get(url, self.get_headers(network)){|response, request, result| response }
+      data = self.analyze_response(response)
 
       subscriptions = []
       if data.has_key?('subscriptions')
@@ -144,43 +146,46 @@ module Livefyre
 		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)
+      user_id = JWT.decode(user_token, network.data.key)['user_id']
+      user_urn = network.get_urn_for_user(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)}
+      form = { :subscriptions => self.to_subscriptions(topics, user_urn) }
 
-      response = RestClient.post(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.post(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+      user_id = JWT.decode(user_token, network.data.key)['user_id']
+      user_urn = network.get_urn_for_user(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)}
+      form = { :subscriptions => self.to_subscriptions(topics, user_urn) }
 
-      response = RestClient.put(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.put(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       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)
+      user_id = JWT.decode(user_token, network.data.key)['user_id']
+      user_urn = network.get_urn_for_user(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)}
+      form = { :delete => self.to_subscriptions(topics, user_urn) }
 
-      response = RestClient.patch(url, form.to_json, headers)
-      data = JSON.parse(response)['data']
+      response = RestClient.patch(url, form.to_json, headers){|response, request, result| response }
+      data = self.analyze_response(response)
 
       data.has_key?('removed') ? data['removed'] : 0
 		end
@@ -189,8 +194,8 @@ module Livefyre
 			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']
+      response = RestClient.get(url, self.get_headers(network)){|response, request, result| response }
+      data = self.analyze_response(response)
 
       subscriptions = []
       if data.has_key?('subscriptions')
@@ -203,18 +208,18 @@ module Livefyre
 		end
 
 		# Stream API
-		def self.get_timeline_stream(core, resource, limit=50, t_until=nil, t_since=nil)
-			url = self.stream_base_url(core) + TIMELINE_PATH
-      url += "?resource=#{resource}&limit=#{limit}"
-
-      if t_until != nil
-        url += "&until=#{t_until}"
-      elsif t_since != nil
-        url += "&since=#{t_since}"
+		def self.get_timeline_stream(cursor, is_next)
+			url = self.stream_base_url(cursor.core) + TIMELINE_PATH
+      url += "?resource=#{cursor.data.resource}&limit=#{cursor.data.limit}"
+
+      if is_next
+        url += "&since=#{cursor.data.cursor_time}"
+      else
+        url += "&until=#{cursor.data.cursor_time}"
       end
 
-      response = RestClient.get(url, self.get_headers(core))
-
+      response = RestClient.get(url, self.get_headers(cursor.core)){|response, request, result| response }
+      raise ApiException.new(self, response.code) if response.code >= 400
       JSON.parse(response)
     end
 
@@ -233,11 +238,7 @@ module Livefyre
     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/"
+      "/#{core.urn}:topics/"
     end
 
     def self.user_subscription_path(user_urn)
@@ -251,7 +252,8 @@ module Livefyre
     TIMELINE_PATH = '/timeline/'
 
     def self.get_headers(core, user_token=nil)
-      {:accepts => :json, :authorization => 'lftoken ' + (user_token == nil ? core.build_livefyre_token : user_token)}
+      network = LivefyreUtil::get_network_from_core(core)
+      {:accepts => :json, :authorization => 'lftoken ' + (user_token == nil ? network.build_livefyre_token : user_token)}
     end
 
     def self.get_ids(topics)
@@ -266,9 +268,14 @@ module Livefyre
     def self.to_subscriptions(topics, user)
       subscriptions = []
       topics.each do |topic|
-        subscriptions << Subscription.new(topic.id, user, SubscriptionType::PERSONAL_STREAM).to_dict
+        subscriptions << Subscription.new(topic.id, user, SubscriptionType::PERSONAL_STREAM).to_hash
       end
       subscriptions
     end
+
+    def self.analyze_response(response)
+      raise ApiException.new(self, response.code) if response.code >= 400
+      JSON.parse(response)['data']
+    end
 	end
 end