kippt 2.0.1 → 3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzljMzEzMTM0MmY0YTIxNTkwOTMzMDkzYzM4YmM5ZWU0ZmZjODYyYQ==
+  data.tar.gz: !binary |-
+    ZTAwMDNhNTJmYzU4NmM2MGVmYzJkNGRkZTNlYTFjZWNkMjFjMTg4ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTlhOWNlZWVhNmIxOWIwMDg4NDkxMmY0ZDg5M2ExMmI2YzE1MGJlZDg5OTQz
+    ZDkxMTQ1MDM5MThlYzNlNmQxMDk0MzYxZWM3NDVkN2FmMTY4NWRmZjFkNTBh
+    OWNmYzVlMDQ0ZTdlY2MwOGFhYTZhNWViMTRiY2M2Yzg2NDMwZmE=
+  data.tar.gz: !binary |-
+    MjMxZjYxMmU1MjMyNTFjODRlNzQ4MTVkNDZmOTRjYzc3ZWJkNjAyZTgwNGQw
+    MjkwMTdkOWNkYzQyNzNjNjg5NzNiZTQxMGUyNTIzYTdlYTc3YTk0Y2IyZmZi
+    ZWJmMGU3MzA1MTkwMTNhMDUwM2YxNGM2ZWJiYTU1MjBjNjQ4MTg=

data/.travis.yml

@@ -1,10 +1,7 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx-2.2.2
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 3.0 / December 23, 2013
+
+Changes all fetching to paginated HTTP endpoints to return a proxy so that you can control
+what you load. This causes breaking changes on some parts of the API.
+
+Adds method to get check if the authenticated user is following a list (`List#following?`).
+
+Adds support for fetching clips by URL or created after time.
+
+Adds support for favoriting and unfavoriting a clip.
+
+Adds new `#fetch` method that works like `#all` but better reflects the use of the method.
+
+Removes `#total_count` on fetched collections because it's been deprecated:
+https://github.com/kippt/api-documentation/blob/c104158674e55a4c103b93ccd41233e9a6daea0a/basics/pagination.md
+
+Improves test coverage.
+
+Deprecates support for Ruby 1.8.7.
+
+## 2.0.1 / August 6, 2013
+
+Adds ability to fetch the clips for a list. Contributed by [Darep](https://github.com/Darep).
+
 ## 2.0 / July 7, 2013
 
 After being long time in development this update adds support for all the

data/Gemfile

@@ -6,5 +6,9 @@ platform :jruby do
   gem "jruby-openssl"
 end
 
+group :test do
+  gem 'rubysl', platform: :rbx
+end
+
 # Specify your gem's dependencies in kippt.gemspec
 gemspec

data/README.md

@@ -80,7 +80,7 @@ Get all the lists:
 
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
-lists = client.lists.all # Returns Kippt::ListCollection
+lists = client.lists.fetch # Returns Kippt::ListCollection
 ```
 
 Get single list:
@@ -96,6 +96,10 @@ Get single lists’s clips:
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
 list_id = 10
+list = client.lists[list_id].clips # Returns a Kippt::ClipCollection
+
+# OR
+
 list = Kippt::List.new({ id: list_id }, client)
 list.clips # Returns a Kippt::ClipCollection
 ```
@@ -105,7 +109,13 @@ list.clips # Returns a Kippt::ClipCollection
 
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
-clips = client.clips.all # Returns Kippt::ClipCollection
+client.clips.fetch # Returns Kippt::ClipCollection
+
+# Returns first page of clips for an URL
+client.clips.fetch(url: "https://github.com/vesan/kippt")
+
+# Returns first page of clips added in the last day
+client.clips.fetch(since: Time.now.to_i - 86400)
 ```
 
 Both ListCollection and ClipCollection are Enumerable.
@@ -117,7 +127,7 @@ Lists and clips are paginated:
 
 ```ruby
 client = Kippt::Client.new(username: "vesan", token: "2544d6bfddf5893ec8617")
-clips = client.clips.all
+clips = client.clips.fetch
 
 clips.total_count
 clips.offset
@@ -136,7 +146,7 @@ clips.previous_page # Returns new Kippt::ClipCollection
 Limit and offset can be controlled manually:
 
 ```ruby
-client.clips.all(limit: 25, offset: 50)
+client.clips.fetch(limit: 25, offset: 50)
 ```
 
 

data/TODO.md

@@ -2,6 +2,22 @@
 * [DONE] Timestamps as time
 * Better exceptions
 
+# 3.0
+
+* [DONE] Add support for favorites
+* [DONE] Add support for filtering clips by URL
+* [DONE] Any other filtering that is missing?
+* [DONE] Convert to return proxy:
+** [DONE] list.clips
+** [DONE] clip.comments
+** [DONE] clip.likes
+** [DONE] clip.saves
+** [DONE] clips.feed
+** [DONE] user_clips.favorites
+* [DONE] Check that all end points have the same filtering capabilities
+* [DONE] Refactors users.search
+* [DONE] Make sure likes make sense. Now User & Like objects are somehow mixed.
+
 # Clip
 
 * [DONE] Getting the feed of authenticated user

data/lib/kippt.rb

@@ -1,8 +1,13 @@
-require "kippt/version"
-require "core_ext/open_struct"
+require_relative "kippt/version"
 require "faraday"
 require "faraday_middleware"
-require "kippt/client"
+
+require_relative "kippt/helpers"
+require_relative "kippt/resource"
+require_relative "kippt/collection_resource"
+require_relative "kippt/collection"
+require_relative "kippt/user"
+require_relative "kippt/client"
 
 module Kippt
   class APIError < StandardError; end

data/lib/kippt/client.rb

@@ -1,7 +1,7 @@
-require "kippt/connection"
-require "kippt/clips"
-require "kippt/lists"
-require "kippt/users"
+require_relative "connection"
+require_relative "root_clips"
+require_relative "lists"
+require_relative "users"
 
 class Kippt::Client
   include Kippt::Connection
@@ -52,7 +52,7 @@ class Kippt::Client
   end
 
   def clips
-    Kippt::Clips.new(self)
+    Kippt::RootClips.new(self)
   end
 
   def users
@@ -60,7 +60,7 @@ class Kippt::Client
   end
 
   def collection_resource_for(resource_class, *options)
-    resource_class.new(*([self] + options))
+    resource_class.new(*(options + [self]))
   end
 
   def resource_from_url(resource_class, url)

data/lib/kippt/clip.rb

@@ -1,9 +1,9 @@
-require "kippt/resource"
-require "kippt/list"
-require "kippt/comments"
-require "kippt/likes"
-require "kippt/saves"
-require "kippt/user"
+require_relative "comments"
+require_relative "clip_likes"
+require_relative "like"
+require_relative "saves"
+require_relative "list"
+require_relative "favorite"
 
 class Kippt::Clip
   include Kippt::Resource
@@ -53,7 +53,7 @@ class Kippt::Clip
   end
 
   def likes
-    Kippt::Likes.new(client, self)
+    Kippt::ClipLikes.new(client, self)
   end
 
   def all_likes_embedded?
@@ -81,10 +81,18 @@ class Kippt::Clip
   end
 
   def like
-    Kippt::Like.new(client, self).save
+    Kippt::Like.new(self, client).save
   end
 
   def unlike
-    Kippt::Like.new(client, self).destroy
+    Kippt::Like.new(self, client).destroy
+  end
+
+  def favorite
+    Kippt::Favorite.new(self, client).save
+  end
+
+  def unfavorite
+    Kippt::Favorite.new(self, client).destroy
   end
 end

data/lib/kippt/clip_collection.rb

@@ -1,5 +1,5 @@
-require "kippt/collection"
-require "kippt/clip"
+require_relative "collection"
+require_relative "clip"
 
 class Kippt::ClipCollection
   include Kippt::Collection

data/lib/kippt/clip_likes.rb

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

data/lib/kippt/clips.rb

@@ -1,18 +1,19 @@
-require "kippt/connection"
-require "kippt/collection_resource"
-require "kippt/clip_collection"
-require "kippt/clip"
+require_relative "clip_collection"
+require_relative "clip"
 
+# Generic clip proxy. Used to wrap endpoints that return clips as JSON.
 class Kippt::Clips
   include Kippt::CollectionResource
-  VALID_SEARCH_PARAMETERS = [:q, :list, :is_starred]
 
-  def initialize(client)
+  attr_reader :base_uri
+
+  def initialize(client, base_uri)
     @client = client
+    @base_uri = base_uri
   end
 
   def self.valid_filter_parameters
-    [:limit, :offset, :is_read_later, :is_starred]
+    [:limit, :offset, :is_read_later, :is_starred, :url, :since, :include_data]
   end
 
   def object_class
@@ -22,34 +23,4 @@ class Kippt::Clips
   def collection_class
     Kippt::ClipCollection
   end
-
-  def base_uri
-    "clips"
-  end
-
-  def feed
-    Kippt::ClipCollection.new(client.get("clips/feed").body, client)
-  end
-
-  def search(parameters)
-    if parameters.is_a?(String)
-      Kippt::ClipCollection.new(
-        client.get("search/clips", {:q => parameters}).body,
-        client)
-    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/collection.rb

@@ -1,7 +1,7 @@
 module Kippt::Collection
   include Enumerable
 
-  attr_reader :total_count, :limit, :offset
+  attr_reader :limit, :offset
 
   def initialize(data, client = nil)
     meta         = data.fetch("meta") { {} }
@@ -9,7 +9,6 @@ module Kippt::Collection
     @offset      = meta.fetch("offset") { nil }
     @next        = meta.fetch("next") { nil }
     @previous    = meta.fetch("previous") { nil }
-    @total_count = meta.fetch("total_count") { nil }
 
     @client  = client
 

data/lib/kippt/collection_resource.rb

@@ -1,76 +1,60 @@
-module Kippt::CollectionResource
-  # 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 all(options = {})
-    validate_collection_options(options)
+require_relative "read_collection_resource"
 
-    collection_class.new(client.get(base_uri, options).body, client)
-  end
+module Kippt
+  module CollectionResource
+    include Kippt::ReadCollectionResource
 
-  def build(attributes = {})
-    object_class.new(attributes, client)
-  end
+    class SaveResponse
+      attr_reader :response
 
-  def create(attributes = {})
-    build(attributes).save
-  end
+      def initialize(response)
+        @response = response
+      end
 
-  # 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
+      def [](key)
+        return @save_response[key] if @save_response
 
-  alias find []
+        @save_response = {success: response.success?, resource: response.body}
+        if response.body["message"]
+          @save_response[:error_message] = response.body["message"]
+        end
 
-  def collection_from_url(url)
-    raise ArgumentError.new("The parameter URL can't be blank") if url.nil? || url == ""
+        @save_response[key]
+      end
 
-    collection_class.new(client.get(url).body, client)
-  end
+      def success?
+        self[:success]
+      end
+    end
 
-  def save_resource(object)
-    if object.id
-      response = client.put("#{base_uri}/#{object.id}", :data => writable_parameters_from(object))
-    else
-      response = client.post("#{base_uri}", :data => writable_parameters_from(object))
+    def build(attributes = {})
+      object_class.new(attributes, client)
     end
 
-    save_response = {:success => response.success?}
-    save_response[:resource] = response.body
-    if response.body["message"]
-      save_response[:error_message] = response.body["message"]
+    def create(attributes = {})
+      build(attributes).save
     end
 
-    save_response
-  end
+    def save_resource(object)
+      if object.id
+        response = client.put("#{base_uri}/#{object.id}", :data => writable_parameters_from(object))
+      else
+        response = client.post("#{base_uri}", :data => writable_parameters_from(object))
+      end
 
-  def destroy_resource(resource)
-    if resource.id
-      client.delete("#{base_uri}/#{resource.id}").success?
+      SaveResponse.new(response)
     end
-  end
 
-  private
-
-  def validate_collection_options(options)
-    options.each do |key, _|
-      unless self.class.valid_filter_parameters.include?(key)
-        raise ArgumentError.new("Unrecognized argument: #{key}")
+    def destroy_resource(resource)
+      if resource.id
+        client.delete("#{base_uri}/#{resource.id}").success?
       end
     end
-  end
 
-  def writable_parameters_from(resource)
-    resource.writable_attributes_hash
-  end
+    private
 
-  def client
-    @client
+    def writable_parameters_from(resource)
+      resource.writable_attributes_hash
+    end
   end
 end