livefyre 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 8485f038f225230513e432efc38bc50629a307b3
-  data.tar.gz: b0fd207d915fda735de2ae7b4632c05b129d7c7c
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTM0MzdkZWZkMGMxZDYzYzdmYzM3NWU5MTgyYTE5YzYzMjVjNTA5MA==
+  data.tar.gz: !binary |-
+    NDU1MDZjNTJlOTkwNzZjNWQ4NjAxNTNkNzNmZDY3ZGM1NGViYzhjMw==
 SHA512:
-  metadata.gz: 2e33bd7d6919e7df762d43511eca7e151e36809f8fd5126e5f705d378f2f1eaa2c01f8fdb660de32e43401f6e52e2ba1c80c0c76b18cff039b101500a542bcc7
-  data.tar.gz: d2fd403948562ba625395d6d36b6496da1184c75ae5fb6879d2b068284f2fb0b5fc9526d5bd784565e302d67fe32988ddf0669992396b5c8b7bca7f96e954524
+  metadata.gz: !binary |-
+    NjRjMWViNDVmYzc1NGFhMmM4NTlkYzdmZmMwYjE2YzU1ZmIyZDI0ZjdkNzRm
+    Nzg2ODAxZGViODFkMGUwNDEzMjM2MDQzOTZlNmIwOGU0ZTIzNmM1ZTI5MjFk
+    Njg2NzQ0M2Q1ZDU0MmExNGQyNTMyMjYwNGNkYTE4NTJmYWFjYjM=
+  data.tar.gz: !binary |-
+    YzBkMTVjOTg4MTcwNTllMWJhNzZlNDIyODRhNjdkZjQ5ZDUzNjdmNzgyZGJk
+    MGZjMTdmNmE0NjRhZGIzYTRiZmE0OTM4M2E1ZDcxNDU2ZDQ0ZTdkOWI3ZDI4
+    MWM0ZGU1OGY5NmYzNjJmMTBiODliMjFmZmE0ZTc5Y2VmZGY5MDI=

data/.gitignore

@@ -7,7 +7,7 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc
+doc/
 lib/bundler/man
 pkg
 rdoc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014- Livefyre, inc. (http://livefyre.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,7 @@
-# Livefyre
+# Livefyre Ruby Utility Classes
+[![Gem Version](https://badge.fury.io/rb/livefyre.png)](http://badge.fury.io/rb/livefyre)
 
-Interface library for Livefyre's API. Currently a mishmash of the v2 and v3 APIs.
+Livefyre's official library for common server-side tasks necessary for getting Livefyre apps (comments, reviews, etc.) working on your website.
 
 ## Installation
 
@@ -16,154 +17,73 @@ Or install it yourself as:
 
     $ gem install livefyre
 
-## Documentation
-
-Full documentation is available [on GitHub](http://mashable.github.com/livefyre/frames.html).
-
-You can generate full documentation yourself from the source tree. Requires the yard-tomdoc plugin.
-
-    yard --plugin yard-tomdoc -o doc
-
 ## Usage
 
-You can set a default configuration object for Livefyre, which will prevent you from having to pass a client to
-all your object proxies manually.
-
-    Livefyre.config = {
-      :network      => "foo.fyre.co",
-      :network_key  => "blorgons",
-      :site_id      => 1234,
-      :site_key     => "minerva",
-      :system_token => "your_long_lived_system_token",
-      :domain       => "zor.t123.livefyre.com"
-    }
-
-If you're using this gem from Rails, we recommend doing this from an initializer.
-
-Once that's set, you're ready to start talking to Livefyre.
-
-    domain = Livefyre::Domain.new
-    domain.set_pull_url "http://foo.bar/users/{id}/pull/"
-
-    user = Livefyre::User.new("some_user_id")
-    user.refresh # Invoke ping-to-pull
-
-## Using with Rails
-
-Integration with Rails is straightforward, but does require some setup.
-
-### Controller integration
-
-You need to add a route to your routes file to handle profile pull requests from Livefyre. That'll look something like:
-
-    get "/livefyre/:id/pull", :to => "users#pull"
-
-Of course, you need a matching controller action
-
-    def pull
-      # Checks the validity of the JWT that Livefyre sends with pull requests. Throws an exception if it's no good.
-      validate_livefyre_request!
+Creating tokens:
 
-      user = User.find(params[:id])
+**Livefyre token:**
 
-      # livefile_profile will attempt to generate valid Livefire profile dump from the passed user record by guessing at field names.
-      # You can pass overides in a hash as the second option, or you can always generate your own data structure.
-      render :json => livefire_profile(user, :image => user.profile_image_url).to_json
-    end
+```ruby
+network = Livefyre.get_network(network_name, network_key)
+network.build_lf_token
+```
 
-Finally, you'll need to set up a pull URL. Since this is done via the API, you are expected to do it manually. From a Rails console is fine, though
-you may do it any other way you please, too. Livefyre will substitute the string "{id}" for the user ID it wants data for.
+**User auth token:**
 
-    Livefyre::Domain.new.set_pull_url "http://your.domain.com/livefyre/{id}/pull"
+```ruby
+network = Livefyre.get_network(network_name, network_key)
+network.build_user_auth_token(user_id, display_name, expires)
+```
 
-You may want to invoke user updates when you save the user record.
+**Collection meta token:**
 
-    def update
-      # ... user record updates here!
-      Livefyre::User.new( user._id ).refresh
-    end
+```ruby
+network = Livefyre.get_network(network_name, network_key)
 
-Or you can have the gem do it automatically from the model:
+site = network.get_site(site_id, site_key)
+site.build_collection_meta_token(title, article_id, url, tags)
+```
 
-    class User < ActiveRecord::Base
-      # ...
+To validate a Livefyre token:
 
-      livefyre_user :update_on => [:email, :display_name]
-    end
+```ruby
+network = Livefyre.get_network(network_name, network_key)
+network.validate_livefyre_token(token)
+```
 
-You can provide your own update callback, in case you want to use something like Sidekiq to do the updates:
+To send Livefyre a user sync url and then have Livefyre pull user data from that url:
 
-    class User < ActiveRecord::Base
-      # ...
+```ruby
+network = Livefyre.get_network(network_name, network_key)
 
-      livefyre_user :update_on => [:email, :display_name] do |user, livefyre_id|
-        Livefyre::User.delay.refresh livefyre_id
-      end
-    end
+network.set_user_sync_url('http://thisisa.test.url/{id}/')
+network.sync_user(system)
+```
 
-This will enqueue a ping-to-pull job in the "livefyre" queue. Make sure you have a worker running that'll handle that queue!
+To retrieve content collection data:
 
-### Handling Postbacks
+```ruby
+network = Livefyre.get_network(network_name, network_key)
 
-To handle postbacks, you'll need to set up a postback route:
+site = network.get_site(site_id, site_key)
+site.get_collection_content(article_id)
+```
 
-    match '/livefyre/postback',       to: 'comments#postback'
-
-You'll also need to tell Livefyre about this URL (similar to the ping-to-pull URL, via a console or elsewhere)
-
-    Livefyre::Site.new.set_postback_url "http://foo.com/livefyre/postback"
-
-Finally, the gem provides a helper for validating Livefyre postback requests.
-
-    class CommentsController < ApplicationController
-      validate_postback_signature :only => [:postback], :key => "your_site_key"
-
-      def postback
-        # Handle the postback
-      end
-    end
-
-### View integration
-
-
-In the location that you want to use your comment form, include something like the following:
-
-    <%= livefyre_comments post.id, post.title, post_url(post), post.tags %>
-
-You'll also need to boot Livefyre with Javascript. In your application.js, you'll want to include the Livefyre loader in your manifest:
-
-    //=require livefyre.js
-
-And then somewhere in your application.js, you'll want to actually boot:
-
-    window.initLivefyre({
-      login: function() {
-          // Things to do when the user clicks the "sign in" link. You probably want to
-          // take your user through a login cycle in a popup window, which includes calling
-          // the livefyre_login(user_id, user_name) method.
-          window.location = "/login";
-        },
-      logout: function() {
-          // things to do when the user clicks the "sign out" link. You probably want to take
-          // your user through the logout cycle, including a call to livefyre_logout.
-          window.location = "/logout";
-        },
-      viewProfile: function(handlers, author) {
-          // Handler for when a user's name is clicked in a comment
-          window.location = "/" + author;
-        },
-      editProfile: function(handlers, author) {
-          // Handler for when a user wants to edit their profile from the Livefyre user dropdown.
-          window.location = "/" + author + "/edit";
-        }
-    });
+## Documentation
 
-That's it!
+Located [here](answers.livefyre.com/libraries).
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Note: any feature update on any of Livefyre's libraries will need to be reflected on all language libraries. We will try and accommodate when we find a request useful, but please be aware of the time it may take.
+
+License
+=======
+
+MIT

data/Rakefile

@@ -1,12 +1,5 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new('spec')
-rescue LoadError
-  # Pass
-end
-
-task :doc do
-  sh %{yard --plugin yard-tomdoc -o doc}
+task :run_tests do
+  system("rspec spec/")
 end

data/lib/livefyre/core.rb

@@ -0,0 +1,102 @@
+require 'base64'
+require 'json'
+require 'jwt'
+require 'rest-client'
+require '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_lf_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_lf_token }
+				)
+			response.code == 200
+		end
+
+		def build_lf_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
+			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, stream='')
+				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
+				JWT.encode({
+						title: title,
+						url: url,
+						tags: tags,
+						articleId: article_id,
+						type: stream},
+					@site_key)
+			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 uri?(string)
+			  uri = URI.parse(string)
+			  %w( http https ).include?(uri.scheme)
+			rescue URI::BadURIError
+			  false
+			rescue URI::InvalidURIError
+			  false
+			end
+		end
+	end
+end

data/lib/livefyre/version.rb

@@ -1,3 +1,3 @@
 module Livefyre
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

data/lib/livefyre.rb

@@ -1,54 +1,7 @@
-require 'jwt'
-require 'faraday'
-require 'forwardable'
-require 'hmac-sha1'
+require "livefyre/core"
 
-# Public: Toplevel Livefyre namespace
 module Livefyre
-  # Public: Exception thrown when the Livefyre API does not return a success value
-  #         #message will be the response body from the Livefyre API.
-  class APIException < ::Exception; end
-
-  # Public: Set the default configuration object for Livefyre clients
-  #
-  # Returns [nil]
-  def self.config=(config)
-    config.keys.each do |key|
-      config[(key.to_sym rescue key) || key] = config.delete(key)
-    end if config.is_a? Hash
-    @@config = config
-    @@client = nil
-  end
-
-  # Public: Get the configuration object for default clients
-  #
-  # Returns [Hash] configuration hash
-  def self.config
-    @@config
-  end
-
-  # Public: Retreive a singleton instance of the Livefyre client
-  #
-  # Returns [Livefyre::Client] instance configured with the default settings
-  # Raises Exception if #config is nil
-  def self.client
-    raise "Invalid configuration" if @@config.nil?
-    @@client ||= Livefyre::Client.new(@@config)
-  end
-end
-
-require File.expand_path("livefyre/client", File.dirname(__FILE__))
-require File.expand_path("livefyre/user", File.dirname(__FILE__))
-require File.expand_path("livefyre/domain", File.dirname(__FILE__))
-require File.expand_path("livefyre/site", File.dirname(__FILE__))
-require File.expand_path("livefyre/activity", File.dirname(__FILE__))
-require File.expand_path("livefyre/conversation", File.dirname(__FILE__))
-require File.expand_path("livefyre/comment", File.dirname(__FILE__))
-
-if defined?(Rails)
-  require File.expand_path("livefyre/controller_extensions", File.dirname(__FILE__))
-  require File.expand_path("livefyre/helpers", File.dirname(__FILE__))
-  require File.expand_path("livefyre/model_extensions", File.dirname(__FILE__))
-  require File.expand_path("../railties/railtie", File.dirname(__FILE__))
-  require File.expand_path("livefyre/engine", File.dirname(__FILE__))
+	def self.get_network(network_name, network_key)
+		Network.new(network_name, network_key)
+	end
 end

data/livefyre.gemspec

@@ -1,39 +1,29 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
 require File.expand_path('../lib/livefyre/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ["Mashable"]
-  gem.email         = ["cheald@mashable.com"]
-  gem.description   = %q{Interface library for Livefyre's comment API with Rails helpers}
-  gem.summary       = %q{Interface library for Livefyre's comment API with Rails helpers}
-  gem.homepage      = "http://github.com/mashable/livefyre"
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.name          = "livefyre"
-  gem.require_paths = ["lib"]
-  gem.version       = Livefyre::VERSION
-
-  gem.signing_key = File.expand_path('~/.gemcert/cheald@mashable.com-private_key.pem')
-  gem.cert_chain  = ['gem-public_cert.pem']
+Gem::Specification.new do |spec|
+  spec.name          = "livefyre"
+  spec.version       = Livefyre::VERSION
+  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
+  !   Note: this is a completely new version of the livefyre gem from Livefyre.
+  !   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"
 
-  gem.add_dependency "faraday"
-  gem.add_dependency "jwt"
-  gem.add_dependency "ruby-hmac"
+  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"]
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "simplecov"
-  gem.add_development_dependency "simplecov-rcov"
-  gem.add_development_dependency "rails"
-  gem.add_development_dependency "resque"
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "yard-tomdoc"
-  gem.add_development_dependency "redcarpet"
-  gem.post_install_message = <<-MESSAGE
-  !    The 'livefyre' gem has been deprecated and has been replaced by 'livefyre-mashable'.
-  !    An official client library from Livefyre will replace this one in mid-April 2014.
-  !    See: https://rubygems.org/gems/livefyre-mashable
-  !    And: https://github.com/mashable/livefyre
-  MESSAGE
+  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"
 end

data/spec/livefyre/core_spec.rb

@@ -0,0 +1,33 @@
+require 'livefyre'
+
+describe Livefyre::Network do
+	before(:each) do
+		@network = Livefyre.get_network('test.fyre.com', 'testkeytest')
+	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_lf_token).should == true
+	end
+end
+
+describe Livefyre::Network::Site do
+	before(:each) do
+		@site = Livefyre.get_network('test.fyre.com', 'testkeytest').get_site("site", "secret")
+	end
+
+	it 'should raise ArgumentError if url is not a valid url' 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' do
+		expect{ @site.build_collection_meta_token('1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456', 'test', 'http://test.com', 'test') }.to raise_error(ArgumentError)
+	end
+end