livefyre 1.3.2 → 2.0.0

data/lib/livefyre/{entity → dto}/topic.rb

@@ -1,7 +1,11 @@
+require 'json'
+
 module Livefyre
 	class Topic
     TOPIC_IDENTIFIER = ':topic='
 
+    attr_accessor :id, :label, :created_at, :modified_at
+    
     def initialize(id, label, created_at=nil, modified_at=nil)
       @id = id
       @label = label
@@ -9,38 +13,37 @@ module Livefyre
       @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 to_json(options = {})
+      to_hash.to_json(options)
+    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 }
+    def to_hash
+      hash = { :id => @id, :label => @label }
       if @created_at != nil
-        json[:createdAt] = @created_at
+        hash[:createdAt] = @created_at
       end
 
       if @modified_at != nil
-        json[:modifiedAt] = @modified_at
+        hash[:modifiedAt] = @modified_at
       end
 
-      json
+      hash
     end
 
     def self.generate_urn(core, id)
-      "#{core.get_urn}#{TOPIC_IDENTIFIER}#{id}"
+      "#{core.urn}#{TOPIC_IDENTIFIER}#{id}"
     end
 
-    def get_truncated_id
-      @id[@id.index(TOPIC_IDENTIFIER) + TOPIC_IDENTIFIER.length]
+    def truncated_id
+      @id[@id.index(TOPIC_IDENTIFIER) + TOPIC_IDENTIFIER.length..-1]
     end
 	end
 end

data/lib/livefyre/exceptions/api_exception.rb

@@ -0,0 +1,29 @@
+require 'livefyre/exceptions/livefyre_exception'
+
+module Livefyre
+  class ApiException < LivefyreException
+    attr_reader :object
+
+    def initialize(object, status_code)
+      message = ApiStatus::get_message(status_code)
+
+      super(message)
+      @object = object
+    end
+  end
+
+  module ApiStatus
+    STATUS_MAP = {400 => 'Please check the contents of your request. Error code 400.',
+                  401 => 'The request requires authentication via an HTTP Authorization header. Error code 401.',
+                  403 => 'The server understood the request, but is refusing to fulfill it. Error code 403.',
+                  404 => 'The requested resource was not found. Error code 404.',
+                  500 => 'Livefyre appears to be down. Please see status.livefyre.com or contact us for more information. Error code 500.',
+                  501 => 'The requested functionality is not currently supported. Error code 501.',
+                  502 => 'The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request at this time. Error code 502.',
+                  503 => 'The service is undergoing scheduled maintenance, and will be available again shortly. Error code 503.'}
+
+    def self.get_message(code)
+      STATUS_MAP[code]
+    end
+  end
+end

data/lib/livefyre/exceptions/livefyre_exception.rb

@@ -0,0 +1,9 @@
+module Livefyre
+  class LivefyreException < StandardError
+    attr_reader :object
+  
+    def initialize(object)
+      @object = object
+    end
+  end
+end

data/lib/livefyre/factory/cursor_factory.rb

@@ -1,15 +1,15 @@
-require 'livefyre/entity/timeline_cursor'
+require 'livefyre/cursor/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)
+      TimelineCursor::init(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)
+      resource = "#{network.get_urn_for_user(user)}:personalStream"
+      TimelineCursor::init(network, resource, limit, date)
     end
   end
 end

data/lib/livefyre/model/collection_data.rb

@@ -0,0 +1,30 @@
+require 'livefyre/exceptions/livefyre_exception'
+
+module Livefyre
+  class CollectionData
+    attr_accessor :id, :type, :title, :article_id, :url, :tags, :topics, :extensions
+
+    def initialize(type, title, article_id, url)
+      @type = type
+      @title = title
+      @article_id = article_id
+      @url = url
+    end
+
+    def as_hash
+      hash = {}
+      self.instance_variables.each {|var| hash[var.to_s.delete('@')] = self.instance_variable_get(var) }
+      hash['articleId'] = @article_id
+      hash.delete('article_id')
+      hash.delete('id')
+      hash
+    end
+
+    def id
+      if (defined?(@id)).nil?
+        raise LivefyreException, 'Call create_or_update on the collection to set the id.'
+      end
+      @id
+    end
+  end
+end

data/lib/livefyre/model/cursor_data.rb

@@ -0,0 +1,17 @@
+module Livefyre
+  class CursorData
+    attr_accessor :resource, :limit, :cursor_time, :next, :previous
+
+    def initialize(resource, limit, start_time)
+      @resource = resource
+      @limit = limit
+      @cursor_time = start_time.utc.iso8601(3)
+      @next = false
+      @previous = false
+    end
+
+    def set_cursor_time(date)
+      @cursor_time = date.utc.iso8601(3)
+    end
+  end
+end

data/lib/livefyre/model/network_data.rb

@@ -0,0 +1,10 @@
+module Livefyre
+  class NetworkData
+    attr_accessor :name, :key
+
+    def initialize(name, key)
+      @name = name
+      @key = key
+    end
+  end
+end

data/lib/livefyre/model/site_data.rb

@@ -0,0 +1,10 @@
+module Livefyre
+  class SiteData
+    attr_accessor :id, :key
+
+    def initialize(id, key)
+      @id = id
+      @key = key
+    end
+  end
+end

data/lib/livefyre/type/collection_type.rb

@@ -0,0 +1,11 @@
+module Livefyre
+  module CollectionType
+    BLOG = "liveblog"
+    CHAT = "livechat"
+    COMMENTS = "livecomments"
+    COUNTING = "counting"
+    RATINGS = "ratings"
+    REVIEWS = "reviews"
+    SIDENOTES = "sidenotes"
+  end
+end

data/lib/livefyre/type/subscription_type.rb

@@ -0,0 +1,5 @@
+module Livefyre
+  module SubscriptionType
+    PERSONAL_STREAM = 1
+  end
+end

data/lib/livefyre/utils/livefyre_util.rb

@@ -0,0 +1,24 @@
+require 'addressable/uri'
+
+module Livefyre
+  class LivefyreUtil
+    def self.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
+    
+    def self.get_network_from_core(core)
+      if core.class.name == 'Livefyre::Collection'
+        return core.site.network
+      elsif core.class.name == 'Livefyre::Site'
+        return core.network
+      else
+        return core
+      end
+    end
+  end
+end

data/lib/livefyre/validator/collection_validator.rb

@@ -0,0 +1,33 @@
+require 'livefyre/utils/livefyre_util'
+
+module Livefyre
+  class CollectionValidator
+    def self.validate(data)
+      reason = ''
+
+      reason += '\n Article id is null or blank' if data.article_id.to_s.empty?
+
+      if data.title.to_s.empty?
+        reason += '\n Title is null or blank'
+      elsif data.title.length > 255
+        reason += '\n Title is longer than 255 characters.'
+      end
+
+      if data.url.to_s.empty?
+        reason += '\n URL is null or blank.'
+      elsif !LivefyreUtil::uri?(data.url)
+        reason += '\n URL is not a valid url. see http://www.ietf.org/rfc/rfc2396.txt'
+      end
+
+      if data.type == nil
+        reason += '\n Type cannot be nil.'
+      elsif not CollectionType.const_defined?(data.type.start_with?('live') ? data.type.sub('live', '').upcase : data.type.upcase)
+        reason += '\n Type must be of valid, recognized type. See CollectionType.'
+      end
+
+      raise ArgumentError, "Problems with your collection input: #{reason}" if reason.length > 0
+
+      data
+    end
+  end
+end

data/lib/livefyre/validator/cursor_validator.rb

@@ -0,0 +1,15 @@
+module Livefyre
+  class CursorValidator
+    def self.validate(data)
+      reason = ''
+
+      reason += '\n Resource is null or blank' if data.resource.to_s.empty?
+      reason += '\n Limit is null or blank' if data.limit.to_s.empty?
+      reason += '\n Cursor time is null or blank' if data.cursor_time.to_s.empty?
+
+      raise ArgumentError, "Problems with your cursor input: #{reason}" if reason.length > 0
+
+      data
+    end
+  end
+end

data/lib/livefyre/validator/network_validator.rb

@@ -0,0 +1,19 @@
+module Livefyre
+  class NetworkValidator
+    def self.validate(data)
+      reason = ''
+
+      if data.name.to_s.empty?
+        reason += '\n Name is null or blank'
+      elsif !data.name.to_s.end_with? 'fyre.co'
+        reason += "\n Name must end with 'fyre.co'"
+      end
+
+      reason += '\n Key is null or blank' if data.key.to_s.empty?
+
+      raise ArgumentError, "Problems with your network input: #{reason}" if reason.length > 0
+
+      data
+    end
+  end
+end

data/lib/livefyre/validator/site_validator.rb

@@ -0,0 +1,14 @@
+module Livefyre
+  class SiteValidator
+    def self.validate(data)
+      reason = ''
+
+      reason += '\n Id is null or blank.' if data.id.to_s.empty?
+      reason += '\n Key is null or blank.' if data.key.to_s.empty?
+
+      raise ArgumentError, "Problems with your site input: #{reason}" if reason.length > 0
+
+      data
+    end
+  end
+end

data/lib/livefyre/version.rb

@@ -1,3 +1,3 @@
 module Livefyre
-  VERSION = '1.3.2'
+  VERSION = '2.0.0'
 end

data/livefyre.gemspec

@@ -2,10 +2,10 @@
 require File.expand_path('../lib/livefyre/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name          = "livefyre"
+  spec.name          = 'livefyre'
   spec.version       = Livefyre::VERSION
-  spec.authors       = ["Livefyre"]
-  spec.email         = ["tools@livefyre.com"]
+  spec.authors       = ['Livefyre']
+  spec.email         = ['tools@livefyre.com']
   spec.description   = %q{Livefyre Ruby utility classes}
   spec.summary       = %q{Livefyre Ruby utility classes}
   spec.post_install_message = <<-MESSAGE
@@ -13,18 +13,21 @@ Gem::Specification.new do |spec|
   !   Users that were using the previous livefyre gem (v.0.1.2) should now refer to livefyre-mashable.
   !   These two gems cannot be used in conjunction with one another as they share the same namespace.
   MESSAGE
-  spec.homepage      = "http://github.com/livefyre/livefyre-ruby-utils"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/livefyre/livefyre-ruby-utils'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rest-client", '~> 1.6', ">= 1.6.7"
-  spec.add_development_dependency "jwt", '~> 0.1', ">= 0.1.11"
-  spec.add_development_dependency "rspec", '~> 2.14', ">= 2.14.1"
-  spec.add_development_dependency "addressable", '~> 2.3', ">= 2.3.6"
+  spec.add_runtime_dependency 'rake'
+  spec.add_runtime_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
+  spec.add_runtime_dependency 'jwt', '~> 0.1', '>= 0.1.13'
+  spec.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.6'
+  spec.add_development_dependency 'bundler', '~> 1.7', '>= 1.7.4'
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1'
+  spec.add_development_dependency 'coveralls', '~> 0.7.1'
+  spec.add_development_dependency 'simplecov', '~> 0.9.1'
+  
 end

data/spec/livefyre/api/domain_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'livefyre'
+require 'livefyre/api/domain'
+require 'jwt'
+
+include Livefyre
+
+describe Livefyre::Domain do
+  before(:each) do
+    @network = Livefyre.get_network(NETWORK_NAME, NETWORK_KEY)
+    @site = @network.get_site(SITE_ID, SITE_KEY)
+    @collection = @site.build_comments_collection(TITLE, ARTICLE_ID, URL)
+  end
+
+  it 'should correctly form quill URLs from core objects' do
+    quill_domain_ssl = "https://#{@network.network_name}.quill.fyre.co"
+    expect(Domain::quill(@network)).to eq(quill_domain_ssl)
+    expect(Domain::quill(@site)).to eq(quill_domain_ssl)
+    expect(Domain::quill(@collection)).to eq(quill_domain_ssl)
+
+    quill_domain = "http://quill.#{@network.network_name}.fyre.co"
+    @network.ssl = false
+    expect(Domain::quill(@network)).to eq(quill_domain)
+    expect(Domain::quill(@site)).to eq(quill_domain)
+    expect(Domain::quill(@collection)).to eq(quill_domain)
+  end
+
+  it 'should correctly form bootstrap URLs from core objects' do
+    bootstrap_domain_ssl = "https://#{@network.network_name}.bootstrap.fyre.co"
+    expect(Domain::bootstrap(@network)).to eq(bootstrap_domain_ssl)
+    expect(Domain::bootstrap(@site)).to eq(bootstrap_domain_ssl)
+    expect(Domain::bootstrap(@collection)).to eq(bootstrap_domain_ssl)
+
+    bootstrap_domain = "http://bootstrap.#{@network.network_name}.fyre.co"
+    @network.ssl = false
+    expect(Domain::bootstrap(@network)).to eq(bootstrap_domain)
+    expect(Domain::bootstrap(@site)).to eq(bootstrap_domain)
+    expect(Domain::bootstrap(@collection)).to eq(bootstrap_domain)
+  end
+end

data/spec/livefyre/api/personalized_stream_spec.rb

@@ -1,65 +1,82 @@
+require 'spec_helper'
 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
+include Livefyre
 
-describe Livefyre::Network, :broken => true do
+describe Livefyre::PersonalizedStream 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
+  it 'should throw an exception if topic label does not fit the criteria' do
+    expect{ PersonalizedStream::create_or_update_topic(@network, 1, '1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890') }.to raise_error(ArgumentError)
+  end
+
+  it 'should test that personalized streams topic api work for networks' do
+    PersonalizedStream::create_or_update_topic(@network, 1, 'EINS')
+    topic = PersonalizedStream::get_topic(@network, 1)
+    expect(PersonalizedStream::delete_topic(@network, topic)).to be true
+
+    PersonalizedStream::create_or_update_topics(@network, {1 => 'EINS', 2 => 'ZWEI'})
+    topics = PersonalizedStream::get_topics(@network)
+
+    name = "RUBY PSSTREAM TEST #{Time.new}"
+    collection = @site.build_comments_collection(name, name, URL)
+    collection.data.topics = topics
+    collection.create_or_update
 
-    Livefyre::PersonalizedStream::create_or_update_topics(@network, {1 => 'EINS', 2 => 'ZWEI'})
-    topics = Livefyre::PersonalizedStream::get_topics(@network)
-    Livefyre::PersonalizedStream::delete_topics(@network, topics)
+    PersonalizedStream::delete_topics(@network, topics)
+  end
+
+  it 'should test that personalized streams topic api work for sites' do
+    PersonalizedStream::create_or_update_topic(@site, 1, 'EINS')
+    topic = PersonalizedStream::get_topic(@site, 1)
+    expect(PersonalizedStream::delete_topic(@site, topic)).to be true
+
+    PersonalizedStream::create_or_update_topics(@site, {1 => 'EINS', 2 => 'ZWEI'})
+    topics = PersonalizedStream::get_topics(@site)
+
+    name = "RUBY PSSTREAM TEST #{Time.new}"
+    collection = @site.build_comments_collection(name, name, URL)
+    collection.data.topics = topics
+    collection.create_or_update
+
+    PersonalizedStream::delete_topics(@site, 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]])
+    topics = PersonalizedStream::create_or_update_topics(@network, {1 => 'EINS', 2 => 'ZWEI'})
+    user_token = @network.build_user_auth_token(USER_ID, "#{USER_ID}@#{NETWORK_NAME}", Network::DEFAULT_EXPIRES)
+
+    PersonalizedStream::add_subscriptions(@network, user_token, topics)
+    PersonalizedStream::get_subscriptions(@network, USER_ID)
+    PersonalizedStream::replace_subscriptions(@network, user_token, [topics[1]])
+    PersonalizedStream::get_subscribers(@network, topics[1])
+    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)
+    topic = PersonalizedStream::create_or_update_topic(@network, 1, 'EINS')
+    cursor = 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)
+    PersonalizedStream::delete_topic(@network, topic)
   end
 
   it 'should test that personalized streams api work for collections' do
-    topics = Livefyre::PersonalizedStream::create_or_update_topics(@site, {1 => 'EINS', 2 => 'ZWEI'})
+    topics = PersonalizedStream::create_or_update_topics(@site, {1 => 'EINS', 2 => 'ZWEI'})
+    name = "RUBY PSSTREAM TEST #{Time.new}"
+    collection = @site.build_comments_collection(name, name, URL).create_or_update
 
-    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]])
+    PersonalizedStream::add_collection_topics(collection, topics)
+    PersonalizedStream::get_collection_topics(collection)
+    PersonalizedStream::replace_collection_topics(collection, [topics[1]])
+    PersonalizedStream::remove_collection_topics(collection, [topics[1]])
   end
 end