livefyre 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTM0MzdkZWZkMGMxZDYzYzdmYzM3NWU5MTgyYTE5YzYzMjVjNTA5MA==
+    MWNjYjgzNjFhMWJlNjc4YWY1MjQ5OTcwYzlkNTBjMjdlMjc0ZjM5OA==
   data.tar.gz: !binary |-
-    NDU1MDZjNTJlOTkwNzZjNWQ4NjAxNTNkNzNmZDY3ZGM1NGViYzhjMw==
+    MGNhN2I5NjY5NjVjMTczYWNiNjEwNmViOWZhOGIxMjNhNDkzNGQzMg==
 SHA512:
   metadata.gz: !binary |-
-    NjRjMWViNDVmYzc1NGFhMmM4NTlkYzdmZmMwYjE2YzU1ZmIyZDI0ZjdkNzRm
-    Nzg2ODAxZGViODFkMGUwNDEzMjM2MDQzOTZlNmIwOGU0ZTIzNmM1ZTI5MjFk
-    Njg2NzQ0M2Q1ZDU0MmExNGQyNTMyMjYwNGNkYTE4NTJmYWFjYjM=
+    NTk5NDRmYzE2NzhmMTkzZTZlZTlmMTIzYzdhZDUxZTllZTFhZGM1ZDVjZWZj
+    MzhmYmI2ODZmNzA5YWRlYzQ3ZWZhZGYyZWQ4YmY1Njk3MmNkOWFjMThkM2Uw
+    YWJmMGFhOTY3NGUxNzYxZWMyYTRjYjRiMGY1ZDJiYmJhMzY5M2Q=
   data.tar.gz: !binary |-
-    YzBkMTVjOTg4MTcwNTllMWJhNzZlNDIyODRhNjdkZjQ5ZDUzNjdmNzgyZGJk
-    MGZjMTdmNmE0NjRhZGIzYTRiZmE0OTM4M2E1ZDcxNDU2ZDQ0ZTdkOWI3ZDI4
-    MWM0ZGU1OGY5NmYzNjJmMTBiODliMjFmZmE0ZTc5Y2VmZGY5MDI=
+    MmRhNDlhN2UwNDc2MDI4MjFjYjRhZGNiM2UzYmFlMWIzOTNkZmEyMGE3Yjkw
+    Njc1MGYwNGZkZjQ1NThkZjg2OWViNTFlYmU3NzgwNjI1ZWU5OGM4ZjExYjg3
+    Y2NmYTgxYzZmM2JlM2E4ZjljMDY0MzE0ZTE0MTdmYjhmMTRlOGY=

data/README.md

@@ -9,69 +9,71 @@ Add this line to your application's Gemfile:
 
     gem 'livefyre'
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install livefyre
 
 ## Usage
 
-Creating tokens:
-
-**Livefyre token:**
+Instantiating a network object:
 
 ```ruby
-network = Livefyre.get_network(network_name, network_key)
-network.build_lf_token
+network = Livefyre.get_network('network_name', 'network_key')
 ```
 
-**User auth token:**
+Building a Livefyre token:
 
 ```ruby
-network = Livefyre.get_network(network_name, network_key)
-network.build_user_auth_token(user_id, display_name, expires)
+network.build_livefyre_token
 ```
 
-**Collection meta token:**
+Building a user auth token:
 
 ```ruby
-network = Livefyre.get_network(network_name, network_key)
-
-site = network.get_site(site_id, site_key)
-site.build_collection_meta_token(title, article_id, url, tags)
+network.build_user_auth_token('user_id', 'display_name', expires)
 ```
 
 To validate a Livefyre token:
 
 ```ruby
-network = Livefyre.get_network(network_name, network_key)
-network.validate_livefyre_token(token)
+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 = Livefyre.get_network(network_name, network_key)
+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')
+```
 
-network.set_user_sync_url('http://thisisa.test.url/{id}/')
-network.sync_user(system)
+Building a collection meta token:
+*The 'tags' and stream' arguments are optional.*
+
+```ruby
+site.build_collection_meta_token('title', 'article_id', 'url', 'tags', 'stream')
 ```
 
 To retrieve content collection data:
 
 ```ruby
-network = Livefyre.get_network(network_name, network_key)
+site.get_collection_content('article_id')
+```
+
+To get a content collection's id:
 
-site = network.get_site(site_id, site_key)
-site.get_collection_content(article_id)
+```ruby
+site.get_collection_id('article_id')
 ```
 
 ## Documentation
 
-Located [here](answers.livefyre.com/libraries).
+Located [here](http://answers.livefyre.com/developers/libraries).
 
 ## Contributing
 

data/lib/livefyre/core.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'digest'
 require 'json'
 require 'jwt'
 require 'rest-client'
@@ -20,7 +21,7 @@ module Livefyre
 			response =
 				RestClient.post(
 					"http://#{@network_name}",
-					{ actor_token: build_lf_token, pull_profile_url: url_template }
+					{ actor_token: build_livefyre_token, pull_profile_url: url_template }
 				)
 			response.code == 204
 		end
@@ -29,12 +30,12 @@ module Livefyre
 			response =
 				RestClient.post(
 					"http://#{@network_name}/api/v3_0/user/#{user_id}/refresh",
-					{ lftoken: build_lf_token }
+					{ lftoken: build_livefyre_token }
 				)
 			response.code == 200
 		end
 
-		def build_lf_token
+		def build_livefyre_token
 			build_user_auth_token(DEFAULT_USER, DEFAULT_USER, DEFAULT_EXPIRES)
 		end
 
@@ -68,16 +69,21 @@ module Livefyre
 				@site_key = site_key
 			end
 	
-			def build_collection_meta_token(title, article_id, url, tags, stream='')
+			def build_collection_meta_token(title, article_id, url, tags='', stream=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
-				JWT.encode({
-						title: title,
-						url: url,
-						tags: tags,
-						articleId: article_id,
-						type: stream},
-					@site_key)
+				
+				collection_meta = { url: url, tags: tags, title: title }
+				checksum = Digest::MD5.new.update(collection_meta.to_json).hexdigest
+
+				collection_meta[:articleId] = article_id
+				collection_meta[:checksum] = checksum
+
+				if stream
+					collection_meta[:type] = stream
+				end
+
+				JWT.encode(collection_meta, @site_key)
 			end
 	
 			def get_collection_content(article_id)
@@ -89,6 +95,13 @@ module Livefyre
 				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 = URI.parse(string)
 			  %w( http https ).include?(uri.scheme)

data/lib/livefyre/version.rb

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

data/spec/livefyre/core_spec.rb

@@ -2,7 +2,7 @@ require 'livefyre'
 
 describe Livefyre::Network do
 	before(:each) do
-		@network = Livefyre.get_network('test.fyre.com', 'testkeytest')
+		@network = Livefyre.get_network('networkName', 'networkKey')
 	end
 
 	it 'should raise ArgumentError if url_template does not contain {id}' do
@@ -14,13 +14,13 @@ describe Livefyre::Network do
 	end
 
 	it 'should validate a livefyre token' do
-		@network.validate_livefyre_token(@network.build_lf_token).should == true
+		@network.validate_livefyre_token(@network.build_livefyre_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")
+		@site = Livefyre.get_network('networkName', 'networkKey').get_site('siteId', "siteKey")
 	end
 
 	it 'should raise ArgumentError if url is not a valid url' do
@@ -30,4 +30,8 @@ describe Livefyre::Network::Site do
 	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
+
+	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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livefyre
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Livefyre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler