livefyre-mashable 0.2.0

data/lib/livefyre/version.rb

@@ -0,0 +1,3 @@
+module Livefyre
+  VERSION = "0.2.0"
+end

data/livefyre.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: 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-mashable"
+  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.add_dependency "faraday"
+  gem.add_dependency "jwt"
+  gem.add_dependency "ruby-hmac"
+
+  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
+end

data/railties/railtie.rb

@@ -0,0 +1,9 @@
+module Livefyre
+  class Railtie < Rails::Railtie
+    initializer "livefyre.initializer" do
+      ActionController::Base.send :include, Livefyre::Controller
+      ActionView::Base.send :include, Livefyre::Helpers
+      ActiveRecord::Base.send :include, Livefyre::Model if defined?(ActiveRecord)
+    end
+  end
+end

data/spec/livefyre/client_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Livefyre::Client do
+  it "should not initialize without a host" do
+    expect { Livefyre::Client.new(:key => "x", :system_token => "x") }.to raise_error Exception
+  end
+
+  it "should not initialize without a key" do
+    expect { Livefyre::Client.new(:host => "x", :system_token => "x") }.to raise_error Exception
+  end
+
+  it "should not initialize without a system token" do
+    expect { Livefyre::Client.new(:key => "x", :host => "x") }.to raise_error Exception
+  end
+
+  it "should initialize with a key, host, and system token" do
+    Livefyre::Client.new(:key => "x", :network => "x", :system_token => "x").should be_a Livefyre::Client
+  end
+
+  context "an instance" do
+    subject { Livefyre::Client.new(:key => "x", :host => "x", :system_token => "x") }
+
+    describe "#sign" do
+      before { @token = subject.sign({:foo => "bar"}) }
+
+      it "should return a string token" do
+        @token.should be_a String
+      end
+
+      it "should validate" do
+        subject.validate(@token).should be_a Hash
+      end
+
+      it "should decode" do
+        subject.validate(@token)["foo"].should == "bar"
+      end
+    end
+
+    describe "#user" do
+      before { @user = subject.user(1234, "foobar") }
+      it "should return a user" do
+        @user.should be_a Livefyre::User
+      end
+
+      it "should have its ID set" do
+        @user.id.should == 1234
+      end
+
+      it "should have a reference to this client" do
+        @user.instance_variable_get("@client").should == subject
+      end
+    end
+
+    describe "#set_user_role" do
+      context "with a valid role and scope" do
+        let(:client) { double "client" }
+
+        before do
+          subject.stub(:http_client).and_return(client)
+        end
+
+        it "should post an affiliation update for a domain" do
+          client.should_receive(:post).with("/api/v1.1/private/management/user/123@x/role/", {:affiliation=>"admin", :lftoken=>"x", :domain_wide=>1}).and_return( double(:success? => true) )
+          subject.set_user_role(123, "admin", "domain").should == true
+        end
+
+        context "when updating a site affiliation" do
+          it "should fail if no scope ID is passed" do
+            client.should_not_receive(:post)
+            expect { subject.set_user_role(123, "admin", "site") }.to raise_error Exception
+          end
+
+          it "should post an affiliation update for a site" do
+            client.should_receive(:post).with("/api/v1.1/private/management/user/123@x/role/", {:affiliation=>"admin", :lftoken=>"x", :site_id=>123}).and_return( double(:success? => true) )
+            subject.set_user_role(123, "admin", "site", 123).should == true
+          end
+        end
+
+        context "when updating a conversation affiliation" do
+          it "should fail if no scope ID is passed" do
+            client.should_not_receive(:post)
+            expect { subject.set_user_role(123, "admin", "conv") }.to raise_error Exception
+          end
+
+          it "should post an affiliation update for a site" do
+            client.should_receive(:post).with("/api/v1.1/private/management/user/123@x/role/", {:affiliation=>"admin", :lftoken=>"x", :conv_id=>123}).and_return( double(:success? => true) )
+            subject.set_user_role(123, "admin", "conv", 123).should == true
+          end
+        end
+
+        context "when it fails" do
+          it "should raise an exception" do
+            client.should_receive(:post).and_return( double(:success? => false, :body => "Failure due to zombie outbreak") )
+            expect { subject.set_user_role(123, "admin", "domain") }.to raise_error(Livefyre::APIException)
+          end
+        end
+      end
+    end
+
+    it "should have a valid string representation" do
+      subject.to_s.should match(/Livefyre::Client/)
+    end
+  end
+end

data/spec/livefyre/domain_spec.rb

@@ -0,0 +1,294 @@
+require 'spec_helper'
+
+describe Livefyre::Domain do
+  context "an instance" do
+    subject { Livefyre::Domain.new }
+
+    describe "#sites" do
+      context "on success" do
+        before do
+          client = double( :get => double(:success? => true, :body => [{:id => "foo.com"}].to_json), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        its(:sites) { should be_a Array }
+
+        its("sites.first") { should be_a Livefyre::Site }
+        its("sites.first.id") { should == "foo.com" }
+      end
+
+      context "on failure" do
+        before do
+          client = double( :get => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.sites }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#users" do
+      context "on success" do
+        before do
+          client = double( :get => double(:success? => true, :body => [{:id => "foo"}].to_json), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        its(:users) { should be_a Array }
+
+        its("users.first") { should be_a Livefyre::User }
+        its("users.first.id") { should == "foo" }
+      end
+
+      context "on failure" do
+        before do
+          client = double( :get => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.users }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#add_user" do
+      context "on success" do
+        before do
+          client = double( :post => double(:success? => true), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should return true" do
+          subject.add_user({"id" => "valid ID"}).should be true
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :post => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.add_user({"id" => "valid ID"}) }.to raise_error(Livefyre::APIException)
+        end
+
+        it "should raise an exception when passed an invalid ID" do
+          expect { subject.add_user({"bad_id" => "invalid ID"}) }.to raise_error("Invalid ID")
+        end
+      end
+    end
+
+    describe "#create_site" do
+      context "on success" do
+        before do
+          client = double( :post => double(:success? => true, :body => {"id" => "foo"}.to_json), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+          @site = subject.create_site("some URL")
+        end
+
+        it "should return a Site" do
+          @site.should be_a Livefyre::Site
+        end
+
+        it "should be prepopulated with the values we just passed" do
+          @site.id.should == "foo"
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :post => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.create_site("some_url") }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#owners" do
+      context "on success" do
+        before do
+          client = double( :get => double(:success? => true, :body => ["foo@bar"].to_json), :system_token => "x" )
+          client.should_receive(:user).with("foo").and_return( Livefyre.client.user("foo") )
+          subject.stub(:client).and_return(client)
+        end
+
+        its(:owners) { should be_a Array }
+
+        its("owners.first") { should be_a Livefyre::User }
+        its("owners.first.id") { should == "foo" }
+      end
+
+      context "on failure" do
+        before do
+          client = double( :get => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.owners }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#add_owner" do
+      context "on success" do
+        before do
+          client = double( :post => double(:success? => true), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should return true" do
+          subject.add_owner("some ID").should be true
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :post => double(:success? => false, :body => ""), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.add_owner("some user ID") }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#remove_owner" do
+      context "on success" do
+        before do
+          client = double( :delete => double(:success? => true), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should return true" do
+          subject.remove_owner("some ID").should be true
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :delete => double(:success? => false, :body => ""), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.remove_owner("some user ID") }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+
+    describe "#admins" do
+      context "on success" do
+        before do
+          client = double( :get => double(:success? => true, :body => ["foo@bar"].to_json), :system_token => "x" )
+          client.should_receive(:user).with("foo").and_return( Livefyre.client.user("foo") )
+          subject.stub(:client).and_return(client)
+        end
+
+        its(:admins) { should be_a Array }
+
+        its("admins.first") { should be_a Livefyre::User }
+        its("admins.first.id") { should == "foo" }
+      end
+
+      context "on failure" do
+        before do
+          client = double( :get => double(:success? => false, :body => ""), :system_token => "x" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.admins }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#add_admin" do
+      context "on success" do
+        before do
+          client = double( :post => double(:success? => true), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should return true" do
+          subject.add_admin("some ID").should be true
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :post => double(:success? => false, :body => ""), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.add_admin("some user ID") }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#remove_admin" do
+      context "on success" do
+        before do
+          client = double( :delete => double(:success? => true), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should return true" do
+          subject.remove_admin("some ID").should be true
+        end
+      end
+
+      context "on failure" do
+        before do
+          client = double( :delete => double(:success? => false, :body => ""), :system_token => "x", :host => "some_host", :key => "some_key" )
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.remove_admin("some user ID") }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    describe "#set_pull_url" do
+      context "when it succeeds" do
+        before do
+          response = double(:success? => true)
+          client = double(:post => response, :system_token => "x")
+          subject.stub(:client).and_return(client)
+          @response = subject.set_pull_url 'http://foo.bar/{id}/'
+        end
+
+        it "should return true" do
+          @response.should == true
+        end
+      end
+
+      context "when it fails" do
+        before do
+          response = double(:success? => false, :body => "failure")
+          client = double(:post => response, :system_token => "x")
+          subject.stub(:client).and_return(client)
+        end
+
+        it "should raise an exception" do
+          expect { subject.set_pull_url 'http://foo.bar/{id}/' }.to raise_error(Livefyre::APIException)
+        end
+      end
+    end
+
+    it "should have a valid string representation" do
+      subject.to_s.should match(/Livefyre::Domain.*host='#{subject.client.host}'/)
+    end
+  end
+end