kippt 0.0.3 → 0.0.4

data/README.md

@@ -111,12 +111,10 @@ You can get next and previous set of results:
 ```ruby
 clips.next_page? #=> true
 clips.next_page # Returns new Kippt::ClipCollection
-clips.prev_page? #=> true
-clips.prev_page # Returns new Kippt::ClipCollection
+clips.previous_page? #=> true
+clips.previous_page # Returns new Kippt::ClipCollection
 ```
 
-There's also `#previous\_page?` and `#previous\_page`.
-
 Limit and offset can be controlled manually:
 
 ```ruby
@@ -173,6 +171,8 @@ clip.destroy #=> true
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Do your changes
+4. Run the tests (`rspec spec`)
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request (`https://github.com/vesan/kippt/pulls`)

data/kippt.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rspec", "~> 2.9.0"
   gem.add_development_dependency "webmock", "~> 1.8.6"
+  gem.add_development_dependency "simplecov", "~> 0.6.4"
 end

data/lib/kippt/collection.rb

@@ -6,7 +6,7 @@ module Kippt::Collection
     @limit       = meta.fetch("limit")
     @offset      = meta.fetch("offset")
     @next        = meta.fetch("next") { nil }
-    @prev        = meta.fetch("prev") { nil }
+    @previous    = meta.fetch("previous") { nil }
     @total_count = meta.fetch("total_count")
 
     @collection_resource  = collection_resource
@@ -31,16 +31,20 @@ module Kippt::Collection
   end
 
   def next_page
-    # TODO: Raise error if there is no page
+    raise Kippt::APIError.new("There is no next page") if @next.nil? || @next == ""
+
     @collection_resource.collection_from_url(@next)
   end
 
-  def prev_page?
-    @prev
+  def previous_page?
+    @previous
   end
+  alias_method :prev_page?, :previous_page?
+
+  def previous_page
+    raise Kippt::APIError.new("There is no previous page") if @previous.nil? || @previous == ""
 
-  def prev_page
-    # TODO: Raise error if there is no page
-    @collection_resource.collection_from_url(@prev)
+    @collection_resource.collection_from_url(@previous)
   end
+  alias_method :prev_page, :previous_page
 end

data/lib/kippt/collection_resource.rb

@@ -14,6 +14,8 @@ module Kippt::CollectionResource
   end
 
   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, self)
   end
 

data/lib/kippt/version.rb

@@ -1,3 +1,3 @@
 module Kippt
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/clips_with_multiple_pages.json

@@ -0,0 +1 @@
+{"meta": {"next": "/api/clips/?limit=2&offset=4", "total_count": 10, "previous": "/api/clips/?limit=2&offset=0", "limit": 2, "offset": 2}, "objects": [{"url_domain": "karrisaarinen.com", "updated": "1335090586", "is_starred": false, "title": "Karri Saarinen", "url": "http://karrisaarinen.com/", "notes": "Cool site, bro", "created": "1335090567", "list": "/api/lists/44525/", "id": 1589450, "resource_uri": "/api/clips/1589450/"}]}

data/spec/fixtures/lists_with_multiple_pages.json

@@ -0,0 +1 @@
+{"meta": {"next": "/api/lists/?limit=2&offset=4", "total_count": 40, "previous": "/api/lists/?limit=2&offset=0", "limit": 2, "offset": 2}, "objects": [{"rss_url": "https://kippt.com/feed/vesan/0VLW0SSjVBRJ1oQEpe9OmSf1q2Q6lvq/inspiration", "updated": "1335090586", "title": "Inspiration", "created": "1335090037", "slug": "inspiration", "id": 10, "resource_uri": "/api/lists/10/"}, {"rss_url": "https://kippt.com/feed/vesan/0VLW0SSjVBRJ1oQEpe9OmSf1q2Q6lvq/moikka-vesa", "updated": "1319441679", "title": "Moikka Vesa!", "created": "1319435972", "slug": "moikka-vesa", "id": 134, "resource_uri": "/api/lists/134/"}, {"rss_url": "https://kippt.com/feed/vesan/0VLW0SSjVBRJ1oQEpe9OmSf1q2Q6lvq/read-later", "updated": "1319434196", "title": "Read Later", "created": "1319434196", "slug": "read-later", "id": 133, "resource_uri": "/api/lists/133/"}, {"rss_url": "https://kippt.com/feed/vesan/0VLW0SSjVBRJ1oQEpe9OmSf1q2Q6lvq/inbox", "updated": "1319434196", "title": "Inbox", "created": "1319434196", "slug": "inbox", "id": 132, "resource_uri": "/api/lists/132/"}]}

data/spec/kippt/client_spec.rb

@@ -4,11 +4,19 @@ require "kippt/client"
 describe Kippt::Client do
   describe "#initialize" do
     context "when there is no username" do
-      it "raises error"
+      it "raises error" do
+        lambda {
+          Kippt::Client.new(password: "secret")
+        }.should raise_error(ArgumentError, "username is required")
+      end
     end
 
     context "when there is no password or token" do
-      it "raises error"
+      it "raises error" do
+        lambda {
+          Kippt::Client.new(username: "vesan")
+        }.should raise_error(ArgumentError, "password or token is required")
+      end
     end
   end
 
@@ -22,8 +30,48 @@ describe Kippt::Client do
         subject.get("/foobar")
       end
     end
+
+    describe "error handling" do
+      context "when response status is 401" do
+        it "raises Kippt::APIError with message received from the server" do
+          stub_request(:get, "https://bob:secret@kippt.com/error_path").
+            to_return(:status => 401, :body => "{\"message\": \"Something horrible.\"}")
+
+          lambda {
+            subject.get("/error_path")
+          }.should raise_error(Kippt::APIError, "Something horrible.")
+        end
+      end
+    end
+  end
+
+  describe "#account" do
+    subject { Kippt::Client.new(:username => "bob", :password => "secret") }
+
+    it "returns a Kippt::Account instance" do
+      subject.should_receive(:get).with("account").and_return(
+        stub body: {}
+      )
+      account = subject.account
+      account.should be_a(Kippt::Account)
+    end
   end
 
   describe "#lists" do
+    subject { Kippt::Client.new(:username => "bob", :password => "secret") }
+
+    it "returns a Kippt::Lists instance" do
+      lists = subject.lists
+      lists.should be_a(Kippt::Lists)
+    end
+  end
+
+  describe "#clips" do
+    subject { Kippt::Client.new(:username => "bob", :password => "secret") }
+
+    it "returns a Kippt::Clips instance" do
+      clips = subject.clips
+      clips.should be_a(Kippt::Clips)
+    end
   end
 end

data/spec/kippt/clip_collection_spec.rb

@@ -3,7 +3,12 @@ require "kippt/clip_collection"
 
 describe Kippt::ClipCollection do
   let(:data) { MultiJson.load(fixture("clips.json").read) }
+  let(:data_with_multiple_pages) {
+    MultiJson.load(fixture("clips_with_multiple_pages.json").read)
+  }
   subject { Kippt::ClipCollection.new(data) }
+  let(:subject_with_multiple_pages) { Kippt::ClipCollection.new(data_with_multiple_pages, collection_resource) }
+  let(:collection_resource) { nil }
 
   it_behaves_like "collection"
 end

data/spec/kippt/list_collection_spec.rb

@@ -2,7 +2,12 @@ require "spec_helper"
 
 describe Kippt::ListCollection do
   let(:data) { MultiJson.load(fixture("lists.json").read) }
+  let(:data_with_multiple_pages) {
+    MultiJson.load(fixture("lists_with_multiple_pages.json").read)
+  }
   subject { Kippt::ListCollection.new(data) }
+  let(:subject_with_multiple_pages) { Kippt::ListCollection.new(data_with_multiple_pages, collection_resource) }
+  let(:collection_resource) { nil }
 
   it_behaves_like "collection"
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "simplecov"
+SimpleCov.start
+
 require "kippt"
 require "rspec"
 require "webmock/rspec"
@@ -65,6 +68,17 @@ shared_examples_for "collection resource" do
       collection = subject.collection_from_url("/api/#{base_uri}/?limit=20&offset=20")
       collection.should be_a(collection_class)
     end
+
+    context "when passed URL is blank" do
+      it "raises ArgumentError" do
+        lambda {
+          subject.collection_from_url("")
+        }.should raise_error(ArgumentError, "The parameter URL can't be blank")
+        lambda {
+          subject.collection_from_url(nil)
+        }.should raise_error(ArgumentError, "The parameter URL can't be blank")
+      end
+    end
   end
 
   describe "#build" do
@@ -92,6 +106,102 @@ shared_examples_for "collection" do
       subject.limit.should eq 20
     end
   end
+
+  describe "#objects" do
+    it "returns the objects generated from the data" do
+      subject.objects.each do |object|
+        object.should be_a(subject.object_class)
+      end
+    end
+  end
+
+  describe "#[]" do
+    it "returns a object by index" do
+      subject[0].id.should eq data["objects"][0]["id"]
+    end
+  end
+
+  describe "#each" do
+    it "loops through the objects" do
+      ids = []
+      subject.each {|object| ids << object.id }
+      ids.should eq data["objects"].map { |node| node["id"] }
+    end
+  end
+
+  describe "#next_page?" do
+    context "there is a next page" do
+      it "returns url of the page" do
+        subject_with_multiple_pages.next_page?.should eq data_with_multiple_pages["meta"]["next"]
+      end
+    end
+
+    context "there is no next page" do
+      it "returns nil" do
+        subject.next_page?.should eq nil
+      end
+    end
+  end
+
+  describe "#next_page" do
+    context "if there is a next page" do
+      let(:collection_resource) { stub }
+
+      it "gets the next page of results from the collection resource" do
+        results = stub
+        collection_resource.should_receive(:collection_from_url).
+          with(data_with_multiple_pages["meta"]["next"]).
+          and_return(results)
+
+        subject_with_multiple_pages.next_page.should eq results
+      end
+    end
+
+    context "if there is no next page" do
+      it "raises an error" do
+        lambda {
+          subject.next_page
+        }.should raise_error(Kippt::APIError, "There is no next page")
+      end
+    end
+  end
+
+  describe "#previous_page?" do
+    context "there is a previous page" do
+      it "returns url of the page" do
+        subject_with_multiple_pages.previous_page?.should eq data_with_multiple_pages["meta"]["previous"]
+      end
+    end
+
+    context "there is no previous page" do
+      it "returns nil" do
+        subject.previous_page?.should be_nil
+      end
+    end
+  end
+
+  describe "#previous_page" do
+    context "if there is a previous page" do
+      let(:collection_resource) { stub }
+
+      it "gets the previous page of results from the collection resource" do
+        results = stub
+        collection_resource.should_receive(:collection_from_url).
+          with(data_with_multiple_pages["meta"]["previous"]).
+          and_return(results)
+
+        subject_with_multiple_pages.previous_page.should eq results
+      end
+    end
+
+    context "if there is no previous page" do
+      it "raises an error" do
+        lambda {
+          subject.previous_page
+        }.should raise_error(Kippt::APIError, "There is no previous page")
+      end
+    end
+  end
 end
 
 shared_examples_for "resource" do
@@ -103,6 +213,13 @@ shared_examples_for "resource" do
     end
   end
 
+  describe "#destroy" do
+    it "sends delete request to the server" do
+      collection_resource.should_receive(:destroy_resource).with(subject).and_return(true)
+      subject.destroy.should be_true
+    end
+  end
+
   describe "#save" do
     context "with valid parameters" do
       it "sends POST request to server" do

metadata

@@ -1,115 +1,119 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: kippt
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
 platform: ruby
-authors: 
-- !binary |
-  VmVzYSBWw6Ruc2vDpA==
-
+authors:
+- Vesa Vänskä
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-29 00:00:00 +03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: faraday
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 7
-        - 6
+      - !ruby/object:Gem::Version
         version: 0.7.6
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: faraday_middleware
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.6
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
+      - !ruby/object:Gem::Version
         version: 0.8.7
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
         version: 1.3.4
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 2
-        - 9
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
   name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 1
-        - 8
-        - 6
+      - !ruby/object:Gem::Version
         version: 1.8.6
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 description: Client library for using Kippt.com API
-email: 
+email:
 - vesa@vesavanska.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -135,8 +139,10 @@ files:
 - lib/kippt/version.rb
 - spec/fixtures/clip.json
 - spec/fixtures/clips.json
+- spec/fixtures/clips_with_multiple_pages.json
 - spec/fixtures/list.json
 - spec/fixtures/lists.json
+- spec/fixtures/lists_with_multiple_pages.json
 - spec/kippt/account_spec.rb
 - spec/kippt/client_spec.rb
 - spec/kippt/clip_collection_spec.rb
@@ -146,45 +152,37 @@ files:
 - spec/kippt/list_spec.rb
 - spec/kippt/lists_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/vesan/kippt
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Client library for using Kippt.com API
-test_files: 
+test_files:
 - spec/fixtures/clip.json
 - spec/fixtures/clips.json
+- spec/fixtures/clips_with_multiple_pages.json
 - spec/fixtures/list.json
 - spec/fixtures/lists.json
+- spec/fixtures/lists_with_multiple_pages.json
 - spec/kippt/account_spec.rb
 - spec/kippt/client_spec.rb
 - spec/kippt/clip_collection_spec.rb