kippt 2.0.1 → 3.0

data/lib/kippt/comment.rb

@@ -1,6 +1,4 @@
-require "kippt/resource"
-require "kippt/user"
-require "kippt/clip"
+require_relative "comments"
 
 class Kippt::Comment
   include Kippt::Resource
@@ -12,7 +10,7 @@ class Kippt::Comment
 
   attr_reader :clip
 
-  def initialize(attributes = {}, client = nil, clip = nil)
+  def initialize(attributes = {}, clip = nil, client = nil)
     super(attributes, client)
     @clip = clip
   end

data/lib/kippt/comment_collection.rb

@@ -1,5 +1,4 @@
-require "kippt/collection"
-require "kippt/comment"
+require_relative "comment"
 
 class Kippt::CommentCollection
   include Kippt::Collection

data/lib/kippt/comments.rb

@@ -1,5 +1,5 @@
-require "kippt/comment_collection"
-require "kippt/comment"
+require_relative "comment_collection"
+require_relative "comment"
 
 class Kippt::Comments
   include Kippt::CollectionResource
@@ -27,7 +27,7 @@ class Kippt::Comments
     "clips/#{clip.id}/comments"
   end
 
-  def all(options = {})
+  def fetch(options = {})
     validate_collection_options(options)
 
     if options.empty? && @clip.all_comments_embedded?
@@ -37,6 +37,8 @@ class Kippt::Comments
     end
   end
 
+  alias all fetch
+
   def build(attributes = {})
     object_class.new(attributes, client, clip)
   end

data/lib/kippt/connection.rb

@@ -9,7 +9,7 @@ module Kippt::Connection
       begin
         MultiJson.load(body) unless body.strip.empty?
       rescue MultiJson::DecodeError
-        nil
+        body
       end
     end
   end
@@ -63,8 +63,12 @@ module Kippt::Connection
       end
     end
 
-    if response.status == 401
-      raise Kippt::APIError.new(response.body["message"])
+    if response.status == 401 || (500..599).include?(response.status)
+      if response.body && response.body["message"]
+        raise Kippt::APIError.new(response.body["message"])
+      else
+        raise Kippt::APIError.new("Unknown response from Kippt: #{response.body}")
+      end
     end
 
     response

data/lib/kippt/favorite.rb

@@ -0,0 +1,46 @@
+require_relative "favorites"
+
+class Kippt::Favorite
+  attr_reader :clip, :errors
+
+  def initialize(clip, client)
+    @client = client
+    @errors = []
+    @clip   = clip
+  end
+
+  def id
+    nil
+  end
+
+  def collection_resource_class
+    Kippt::Favorites
+  end
+
+  def writable_attributes_hash
+    nil
+  end
+
+  def save
+    @errors = []
+    response = collection_resource.save_resource(self)
+    if response[:error_message]
+      errors << response[:error_message]
+    end
+    response[:success]
+  end
+
+  def destroy
+    collection_resource.destroy_resource(self)
+  end
+
+  private
+
+  def collection_resource
+    @collection_resource ||= client.collection_resource_for(collection_resource_class, clip)
+  end
+
+  def client
+    @client
+  end
+end

data/lib/kippt/favorites.rb

@@ -0,0 +1,20 @@
+# This class is only meant to be used by Kippt::Favorite class for favoriting
+# and unfavoriting clips.
+class Kippt::Favorites
+  include Kippt::CollectionResource
+
+  attr_reader :clip
+
+  def initialize(client, clip)
+    @client = client
+    @clip   = clip
+  end
+
+  def base_uri
+    "clips/#{clip.id}/favorites"
+  end
+
+  def destroy_resource(resource)
+    client.delete(base_uri).success?
+  end
+end

data/lib/kippt/followers.rb

@@ -1,12 +1,14 @@
-require "kippt/collection_resource"
-require "kippt/user_collection"
-require "kippt/user"
+require_relative "user_collection"
 
 class Kippt::Followers
-  include Kippt::CollectionResource
+  include Kippt::ReadCollectionResource
 
   attr_reader :user
 
+  def self.valid_filter_parameters
+    [:limit, :offset]
+  end
+
   def initialize(client, user)
     @client = client
     @user   = user

data/lib/kippt/following.rb

@@ -1,12 +1,14 @@
-require "kippt/collection_resource"
-require "kippt/user_collection"
-require "kippt/user"
+require_relative "user_collection"
 
 class Kippt::Following
-  include Kippt::CollectionResource
+  include Kippt::ReadCollectionResource
 
   attr_reader :user
 
+  def self.valid_filter_parameters
+    [:limit, :offset]
+  end
+
   def initialize(client, user)
     @client = client
     @user   = user

data/lib/kippt/helpers.rb

@@ -0,0 +1,17 @@
+module Kippt::Helpers
+  private
+
+  def assert_valid_keys(hash, *valid_keys)
+    valid_keys.flatten!
+    hash.each_key do |k|
+      raise ArgumentError.new("Unrecognized argument: #{k}") unless valid_keys.include?(k)
+    end
+  end
+
+  def symbolize_keys! hash
+    hash.keys.each do |key|
+      hash[(key.to_sym rescue key) || key] = hash.delete(key)
+    end
+    hash
+  end
+end

data/lib/kippt/like.rb

@@ -1,7 +1,9 @@
-require "kippt/users"
+require_relative "likes"
 
 class Kippt::Like
-  def initialize(client, clip)
+  attr_reader :clip, :errors
+
+  def initialize(clip, client)
     @client = client
     @errors = []
     @clip   = clip
@@ -41,8 +43,4 @@ class Kippt::Like
   def client
     @client
   end
-
-  def clip
-    @clip
-  end
 end

data/lib/kippt/like_collection.rb

@@ -0,0 +1,11 @@
+class Kippt::LikeCollection
+  include Kippt::Collection
+
+  def object_class
+    Kippt::Like
+  end
+
+  def collection_resource_class
+    Kippt::Likes
+  end
+end

data/lib/kippt/likes.rb

@@ -1,7 +1,5 @@
-require "kippt/user_collection"
-require "kippt/user"
-require "kippt/like"
-
+# This class is only meant to be used by Kippt::Like class for liking and
+# unliking clips.
 class Kippt::Likes
   include Kippt::CollectionResource
 
@@ -12,36 +10,10 @@ class Kippt::Likes
     @clip   = clip
   end
 
-  def self.valid_filter_parameters
-    []
-  end
-
-  def object_class
-    Kippt::User
-  end
-
-  def collection_class
-    Kippt::UserCollection
-  end
-
   def base_uri
     "clips/#{clip.id}/likes"
   end
 
-  def all(options = {})
-    validate_collection_options(options)
-
-    if options.empty? && @clip.all_likes_embedded?
-      collection_class.new({"objects" => @clip.likes_data}, client)
-    else
-      collection_class.new(client.get(base_uri, options).body, client)
-    end
-  end
-
-  def build
-    Kippt::Like.new(client, clip)
-  end
-
   def destroy_resource(resource)
     client.delete(base_uri).success?
   end

data/lib/kippt/list.rb

@@ -1,4 +1,4 @@
-require "kippt/user"
+require_relative "clips"
 
 class Kippt::List
   include Kippt::Resource
@@ -22,7 +22,13 @@ class Kippt::List
   end
 
   def clips
-    Kippt::ClipCollection.new(client.get("lists/#{id}/clips").body, client)
+    Kippt::Clips.new(client, "lists/#{id}/clips")
+  end
+
+  def following?
+    response = client.get("#{resource_uri}relationship")
+    raise Kippt::APIError.new("There was an error with the request: #{response.body["message"]}") unless response.success?
+    response.body["following"]
   end
 
   def follow

data/lib/kippt/list_collection.rb

@@ -1,5 +1,5 @@
-require "kippt/collection"
-require "kippt/list"
+require_relative "lists"
+require_relative "list"
 
 class Kippt::ListCollection
   include Kippt::Collection

data/lib/kippt/lists.rb

@@ -1,7 +1,5 @@
-require "kippt/connection"
-require "kippt/collection_resource"
-require "kippt/list_collection"
-require "kippt/list"
+require_relative "list_collection"
+require_relative "list"
 
 class Kippt::Lists
   include Kippt::CollectionResource

data/lib/kippt/read_collection_resource.rb

@@ -0,0 +1,43 @@
+module Kippt::ReadCollectionResource
+  include Kippt::Helpers
+
+  # For certain objects you can get extra data by giving option `include_data`.
+  # For example with clips you can add `include_data: "list,via"`.
+  def fetch(options = {})
+    validate_collection_options(options)
+
+    collection_class.new(client.get(base_uri, options).body, client)
+  end
+
+  alias all fetch
+
+  # For certain objects you can get extra data by giving option `include_data`.
+  # For example with clips you can add `include_data: "list,via"`.
+  def [](resource_id, options = {})
+    response = client.get("#{base_uri}/#{resource_id}", options)
+    if response.success?
+      object_class.new(response.body, client)
+    else
+      raise Kippt::APIError.new("Resource could not be loaded: #{response.body["message"]}")
+    end
+  end
+
+  alias find []
+
+  def collection_from_url(url)
+    raise ArgumentError.new("The parameter URL can't be blank") if url.nil? || url == ""
+
+    collection_class.new(client.get(url).body, client)
+  end
+
+  private
+
+  def validate_collection_options(options)
+    symbolize_keys! options
+    assert_valid_keys options, self.class.valid_filter_parameters
+  end
+
+  def client
+    @client
+  end
+end

data/lib/kippt/root_clips.rb

@@ -0,0 +1,39 @@
+require_relative "clips"
+
+# The root "/clips" resource that exposes features like feed, favorites and
+# search.
+class Kippt::RootClips < Kippt::Clips
+  VALID_SEARCH_PARAMETERS = [:q, :list, :is_starred]
+
+  def initialize(client)
+    super(client, "clips")
+  end
+
+  def feed
+    Kippt::Clips.new(client, "clips/feed")
+  end
+
+  def favorites
+    Kippt::Clips.new(client, "clips/favorites")
+  end
+
+  def search(parameters)
+    if parameters.is_a?(String)
+      search({:q => parameters})
+    else
+      validate_search_parameters(parameters)
+
+      Kippt::ClipCollection.new(
+        client.get("search/clips", parameters).body,
+        client)
+    end
+  end
+
+  private
+
+  def validate_search_parameters(parameters)
+    parameters.each do |key, value|
+      raise ArgumentError.new("'#{key}' is not a valid search parameter") unless VALID_SEARCH_PARAMETERS.include?(key)
+    end
+  end
+end

data/lib/kippt/saves.rb

@@ -1,5 +1,4 @@
-require "kippt/user_collection"
-require "kippt/user"
+require_relative "user_collection"
 
 class Kippt::Saves
   attr_reader :clip
@@ -13,10 +12,12 @@ class Kippt::Saves
     Kippt::UserCollection
   end
 
-  def all(options = {})
+  def fetch(options = {})
     collection_class.new({"objects" => @clip.saves_data}, client)
   end
 
+  alias all fetch
+
   private
 
   def client

data/lib/kippt/user.rb

@@ -1,9 +1,9 @@
-require "kippt/users"
-require "kippt/followers"
-require "kippt/following"
-require "kippt/follow_relationship"
-require "kippt/user_clips"
-require "kippt/user_lists"
+require_relative "users"
+require_relative "followers"
+require_relative "following"
+require_relative "follow_relationship"
+require_relative "user_lists"
+require_relative "user_likes"
 
 class Kippt::User
   include Kippt::Resource
@@ -36,6 +36,10 @@ class Kippt::User
     Kippt::Following.new(client, self)
   end
 
+  def likes
+    Kippt::UserLikes.new(client, self)
+  end
+
   # Tells if authenticated user is following the user.
   def following?
     Kippt::FollowRelationship.new(client, self).following?