kippt 2.0.1 → 3.0

data/lib/kippt/user_clips.rb

@@ -1,39 +1,19 @@
-require "kippt/connection"
-require "kippt/collection_resource"
-require "kippt/clip_collection"
-require "kippt/clip"
-
-class Kippt::UserClips
-  include Kippt::CollectionResource
+require_relative "clips"
 
+class Kippt::UserClips < Kippt::Clips
   attr_reader :user
 
-  def self.valid_filter_parameters
-    [:limit, :offset]
-  end
-
   def initialize(client, user)
-    @client = client
-    @user   = user
-  end
-
-  def object_class
-    Kippt::Clip
-  end
-
-  def collection_class
-    Kippt::ClipCollection
-  end
+    @user = user
 
-  def base_uri
-    "users/#{user.id}/clips"
+    super(client, "users/#{user.id}/clips")
   end
 
   def favorites
-    Kippt::ClipCollection.new(client.get("#{base_uri}/favorites").body, client)
+    Kippt::Clips.new(client, "#{base_uri}/favorites")
   end
 
   def likes
-    Kippt::ClipCollection.new(client.get("#{base_uri}/likes").body, client)
+    Kippt::Clips.new(client, "#{base_uri}/likes")
   end
 end

data/lib/kippt/user_collection.rb

@@ -1,6 +1,3 @@
-require "kippt/collection"
-require "kippt/user"
-
 class Kippt::UserCollection
   include Kippt::Collection
 

data/lib/kippt/user_likes.rb

@@ -0,0 +1,29 @@
+require_relative "read_collection_resource"
+
+# For fetching user's public likes.
+class Kippt::UserLikes
+  include Kippt::ReadCollectionResource
+
+  attr_reader :user
+
+  def initialize(client, user)
+    @client = client
+    @user   = user
+  end
+
+  def self.valid_filter_parameters
+    [:limit, :offset, :include_data]
+  end
+
+  def object_class
+    Kippt::Clip
+  end
+
+  def collection_class
+    Kippt::ClipCollection
+  end
+
+  def base_uri
+    "users/#{user.id}/clips/likes"
+  end
+end

data/lib/kippt/user_lists.rb

@@ -1,8 +1,3 @@
-require "kippt/connection"
-require "kippt/collection_resource"
-require "kippt/list_collection"
-require "kippt/list"
-
 # Loads public lists for a user.
 class Kippt::UserLists
   include Kippt::CollectionResource

data/lib/kippt/users.rb

@@ -1,10 +1,7 @@
-require "kippt/connection"
-require "kippt/collection_resource"
-require "kippt/user_collection"
-require "kippt/user"
+require_relative "user_collection"
 
 class Kippt::Users
-  include Kippt::CollectionResource
+  include Kippt::ReadCollectionResource
   VALID_SEARCH_PARAMETERS = [:q]
 
   def initialize(client)
@@ -29,9 +26,7 @@ class Kippt::Users
 
   def search(parameters)
     if parameters.is_a?(String)
-      Kippt::UserCollection.new(
-        client.get("#{base_uri}/search", {:q => parameters}).body,
-        client)
+      search({:q => parameters})
     else
       validate_search_parameters(parameters)
 

data/lib/kippt/version.rb

@@ -1,3 +1,3 @@
 module Kippt
-  VERSION = "2.0.1"
+  VERSION = "3.0"
 end

data/spec/kippt/client_spec.rb

@@ -67,6 +67,17 @@ describe Kippt::Client do
         end
       end
     end
+
+    context "when response status is 500" do
+      it "raises Kippt::APIError with unknown response text" do
+        stub_request(:get, "https://bob:secret@kippt.com/error_path").
+          to_return(:status => 500, :body => "500 Everything is broken")
+
+        expect {
+          subject.get("/error_path")
+        }.to raise_error(Kippt::APIError, "Unknown response from Kippt: 500 Everything is broken")
+      end
+    end
   end
 
   describe "#account" do
@@ -79,6 +90,15 @@ describe Kippt::Client do
       account = subject.account
       account.should be_a(Kippt::User)
     end
+
+    context "when asked for api token" do
+      it "asks for the token from the server" do
+        subject.should_receive(:get).with("account?include_data=api_token").and_return(
+          stub :body => {}
+        )
+        account = subject.account(true)
+      end
+    end
   end
 
   describe "#lists" do
@@ -93,9 +113,9 @@ describe Kippt::Client do
   describe "#clips" do
     subject { Kippt::Client.new(:username => "bob", :password => "secret") }
 
-    it "returns a Kippt::Clips instance" do
+    it "returns a Kippt::RootClips instance" do
       clips = subject.clips
-      clips.should be_a(Kippt::Clips)
+      clips.should be_a(Kippt::RootClips)
     end
   end
 
@@ -108,6 +128,20 @@ describe Kippt::Client do
     end
   end
 
+  describe "#collection_resource_for" do
+    subject { Kippt::Client.new(valid_user_credentials) }
+
+    it "returns instance of the resource class" do
+      subject.collection_resource_for(Kippt::Clip, {}).should be_a(Kippt::Clip)
+    end
+
+    it "passes itself and the passed arguments as parameters" do
+      resource_class = double :resource
+      resource_class.should_receive(:new).with(:option1, :option2, subject)
+      subject.collection_resource_for(resource_class, :option1, :option2)
+    end
+  end
+
   describe "#resource_from_url" do
     subject { Kippt::Client.new(valid_user_credentials) }
 

data/spec/kippt/clip_likes_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+require "kippt/clip_likes"
+
+describe Kippt::ClipLikes do
+  let(:client) { Kippt::Client.new(valid_user_credentials) }
+  subject { Kippt::Clip.new({:id => 10}, client).likes }
+  let(:base_uri) { "clips/10/likes" }
+  let(:singular_fixture) { "user" }
+  let(:collection_fixture) { "users" }
+  let(:collection_class) { Kippt::UserCollection }
+  let(:resource_class) { Kippt::User }
+
+  it_behaves_like "read collection resource"
+end

data/spec/kippt/clip_spec.rb

@@ -92,17 +92,83 @@ describe Kippt::Clip do
         "count" => 2, "data" => [{}]
       }} }
 
-      it "returns true" do
+      it "returns false" do
         subject.all_comments_embedded?.should be_false
       end
     end
   end
 
+  describe "#likes" do
+    it "returns Kippt::ClipLikes" do
+      subject.likes.should be_a Kippt::ClipLikes
+    end
+
+    it "returns object where clip is set" do
+      subject.likes.clip.should eq subject
+    end
+  end
+
+  describe "#all_likes_embedded?" do
+    context "when like count and number of like objects matches" do
+      let(:data) { {"likes" => {
+        "count" => 2, "data" => [{}, {}]
+      }} }
+
+      it "returns true" do
+        subject.all_likes_embedded?.should be_true
+      end
+    end
+
+    context "when like count and number of like objects doesn't match" do
+      let(:data) { {"likes" => {
+        "count" => 2, "data" => [{}]
+      }} }
+
+      it "returns false" do
+        subject.all_likes_embedded?.should be_false
+      end
+    end
+  end
+
+  describe "#likes_count" do
+    it "returns the likes count from the response" do
+      subject.likes_count.should eq 0
+    end
+  end
+
+  describe "#likes_data" do
+    it "returns the likes data from the response" do
+      subject.likes_data.should eq []
+    end
+  end
+
+  describe "#saves" do
+    it "returns Kippt::Saves" do
+      subject.saves.should be_a Kippt::Saves
+    end
+
+    it "returns object where clip is set" do
+      subject.saves.clip.should eq subject
+    end
+  end
+
+  describe "#saves_count" do
+    it "returns the saves count from the response" do
+      subject.saves_count.should eq 0
+    end
+  end
+
+  describe "#saves_data" do
+    it "returns the saves data from the response" do
+      subject.saves_data.should eq []
+    end
+  end
+
   describe "#like" do
     let(:like) { stub :like }
 
     it "instantiates a Kippt::Like and saves it" do
-      Kippt::Like.should_receive(:new).with(client, subject).and_return(like)
+      Kippt::Like.should_receive(:new).with(subject, client).and_return(like)
       like.should_receive(:save)
       subject.like
     end
@@ -112,9 +178,29 @@ describe Kippt::Clip do
     let(:like) { stub :like }
 
     it "instantiates a Kippt::Like and destroys it" do
-      Kippt::Like.should_receive(:new).with(client, subject).and_return(like)
+      Kippt::Like.should_receive(:new).with(subject, client).and_return(like)
       like.should_receive(:destroy)
       subject.unlike
     end
   end
+
+  describe "#favorite" do
+    let(:favorite) { stub :favorite }
+
+    it "instantiates a Kippt::Favorite and saves it" do
+      Kippt::Favorite.should_receive(:new).with(subject, client).and_return(favorite)
+      favorite.should_receive(:save)
+      subject.favorite
+    end
+  end
+
+  describe "#unlike" do
+    let(:favorite) { stub :favorite }
+
+    it "instantiates a Kippt::Favorite and destroys it" do
+      Kippt::Favorite.should_receive(:new).with(subject, client).and_return(favorite)
+      favorite.should_receive(:destroy)
+      subject.unfavorite
+    end
+  end
 end

data/spec/kippt/clips_spec.rb

@@ -6,18 +6,40 @@ describe Kippt::Clips do
   subject { client.clips }
   let(:base_uri) { "clips" }
   let(:singular_fixture) { "clip" }
+  let(:collection_fixture) { "clips" }
   let(:collection_class) { Kippt::ClipCollection }
   let(:resource_class) { Kippt::Clip }
 
   it_behaves_like "collection resource"
 
+  describe "#build" do
+    it "returns new resource" do
+      subject.build.should be_a(resource_class)
+    end
+
+    it "accepts parameters" do
+      subject.object_class.should_receive(:new).with({:an => "attribute"}, client)
+      subject.build(:an => "attribute")
+    end
+  end
+
   describe "#feed" do
     subject { Kippt::Client.new(valid_user_credentials).clips }
 
-    it "returns ClipCollection" do
-      stub_get("/clips/feed").
-        to_return(:status => 200, :body => fixture("feed.json"))
-      subject.feed.should be_a Kippt::ClipCollection
+    it "returns Clips" do
+      feed = subject.feed
+      feed.should be_a Kippt::Clips
+      feed.base_uri.should eq "clips/feed"
+    end
+  end
+
+  describe "#favorites" do
+    subject { Kippt::Client.new(valid_user_credentials).clips }
+
+    it "returns Clips" do
+      feed = subject.favorites
+      feed.should be_a Kippt::Clips
+      feed.base_uri.should eq "clips/favorites"
     end
   end
 
@@ -83,7 +105,7 @@ describe Kippt::Clips do
 
         clip = Kippt::Clip.new(:url => "http://kiskolabs.com")
         response = subject.save_resource(clip)
-        response[:success].should be_false
+        response.success?.should be_false
         response[:error_message].should eq "No good."
       end
     end

data/spec/kippt/comment_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 require "kippt/comment"
 
 describe Kippt::Comment do
-  subject { Kippt::Comment.new(data, client, clip) }
+  subject { Kippt::Comment.new(data, clip, client) }
   let(:client) { Kippt::Client.new(valid_user_credentials) }
   let(:clip) { stub(:clip) }
   let(:collection_resource_class) { Kippt::Comments }

data/spec/kippt/comments_spec.rb

@@ -10,28 +10,54 @@ describe Kippt::Comments do
   let(:collection_class) { Kippt::CommentCollection }
   let(:resource_class) { Kippt::Comment }
 
+  it_behaves_like "collection resource"
+
   def collection_fixture
     base_uri.split("/").last
   end
 
-  describe "#all" do
+  describe "#build" do
+    it "returns new resource" do
+      subject.build.should be_a(resource_class)
+    end
+
+    it "accepts parameters" do
+      subject.object_class.should_receive(:new).with({:an => "attribute"}, client, clip)
+      subject.build({:an => "attribute"})
+    end
+  end
+
+
+  describe "#fetch" do
     it "returns collection class" do
       stub_get("/#{base_uri}").
         to_return(:status => 200, :body => fixture("#{collection_fixture}.json"))
-      all_resources = subject.all
+      all_resources = subject.fetch
       all_resources.is_a? collection_class
     end
 
     it "accepts limit and offset options" do
       stub_get("/#{base_uri}?limit=10&offset=100").
         to_return(:status => 200, :body => fixture("#{collection_fixture}.json"))
-      resources = subject.all(:limit => 10, :offset => 100)
+      resources = subject.fetch(:limit => 10, :offset => 100)
+    end
+
+    context "when comments are embedded" do
+      let(:clip) { stub :clip,
+                        id: 100,
+                        all_comments_embedded?: true,
+                        comments_data: [{body: "Embedded body"}] }
+
+      it "uses the embedded data to create comments" do
+        comments = subject.fetch
+        comments.first.body.should eq "Embedded body"
+      end
     end
 
     context "when passed unrecognized arguments" do
       it "raises error" do
         lambda {
-          subject.all(:foobar => true)
+          subject.fetch(:foobar => true)
         }.should raise_error(
           ArgumentError, "Unrecognized argument: foobar")
       end
@@ -57,7 +83,6 @@ describe Kippt::Comments do
           to_return(:status => 404, :body => {"message" => "Resource not found."})
         lambda {
           subject[10]
-          subject.all(:foobar => true)
         }.should raise_error(
           Kippt::APIError, "Resource could not be loaded: Resource not found.")
       end