pinboard_api 0.7.0 → 1.0.0

data/spec/post_spec.rb

@@ -59,13 +59,91 @@ describe PinboardApi::Post do
   end
 
 
+  # #######################
+  # save
+  # #######################
+  describe "#save" do
+    describe "success" do
+      let(:url) { "http://phlippers.net/pinboard_api" }
+      let(:description) { "A Ruby client for the Pinboard.in API" }
+      let(:extended) { "Extended Awesomeness" }
+      let(:tags) { %w[ruby programming] }
+
+      before do
+        PinboardApi::VCR.use_cassette("posts/save") do
+          post.destroy(url: url) rescue nil  # make sure it adds one
+          params = {
+            url: url, description: description, extended: extended, tags: tags
+          }
+          @post1 = post.new(params).save
+          @post2 = post.find(url: url).first
+        end
+      end
+
+      it { @post1.must_be_kind_of PinboardApi::Post }
+      it { @post1.url.must_equal url }
+      it { @post1.description.must_equal description }
+      it { @post1.extended.must_equal extended }
+      it { @post1.tags.must_equal tags }
+
+      it { @post2.url.must_equal @post1.url }
+      it { @post2.description.must_equal @post1.description }
+      it { @post2.extended.must_equal @post1.extended }
+      it { @post2.tags.must_equal @post1.tags }
+    end
+
+    describe "failure" do
+      it { -> { post.new.save }.must_raise(PinboardApi::InvalidPostError) }
+    end
+  end
+
+
+  # #######################
+  # self.create
+  # #######################
+  describe "self.create" do
+    describe "success" do
+      let(:url) { "https://github.com/phlipper/pinboard_api" }
+      let(:description) { "PinboardAPI on Github" }
+      let(:extended) { "Extended Github Awesomeness" }
+      let(:tags) { %w[pinboard github] }
+
+      before do
+        PinboardApi::VCR.use_cassette("posts/create") do
+          post.destroy(url: url) rescue nil  # make sure it adds one
+          params = {
+            url: url, description: description, extended: extended, tags: tags
+          }
+          @post1 = post.create(params)
+          @post2 = post.find(url: url).first
+        end
+      end
+
+      it { @post1.must_be_kind_of PinboardApi::Post }
+      it { @post1.url.must_equal url }
+      it { @post1.description.must_equal description }
+      it { @post1.extended.must_equal extended }
+      it { @post1.tags.must_equal tags }
+
+      it { @post2.url.must_equal @post1.url }
+      it { @post2.description.must_equal @post1.description }
+      it { @post2.extended.must_equal @post1.extended }
+      it { @post2.tags.must_equal @post1.tags }
+    end
+
+    describe "failure" do
+      it { -> { post.create({}) }.must_raise(PinboardApi::InvalidPostError) }
+    end
+  end
+
+
   # #######################
   # destroy
   # #######################
   describe "#destroy" do
     describe "when successful" do
       it "returns self" do
-        VCR.use_cassette("posts/destroy/successful_instance") do
+        PinboardApi::VCR.use_cassette("posts/destroy/successful_instance") do
           post = PinboardApi::Post.find(url: "http://duckduckgo.com/").first
           post.destroy.must_equal post
         end
@@ -75,22 +153,33 @@ describe PinboardApi::Post do
     describe "when not successful" do
       it "raises an exception" do
         Faraday::Response.any_instance.stubs(:body).returns("")
-        VCR.use_cassette("posts/destroy/unsuccessful_instance") do
+        PinboardApi::VCR.use_cassette("posts/destroy/unsuccessful_instance") do
           post = PinboardApi::Post.new
-          -> { post.destroy }.must_raise(RuntimeError)
+          -> { post.destroy }.must_raise(PinboardApi::InvalidResponseError)
         end
       end
     end
   end
 
 
+  # #######################
+  # validate!
+  # #######################
+  describe "validate!" do
+    let(:exception) { PinboardApi::InvalidPostError }
+
+    it { -> { post.new.validate! }.must_raise(exception) }
+    it { -> { post.new(url: "x").validate! }.must_raise(exception) }
+  end
+
+
   # #######################
   # self.destroy
   # #######################
   describe "self.destroy" do
     describe "when successful" do
       it "returns self" do
-        VCR.use_cassette("posts/destroy/successful_class") do
+        PinboardApi::VCR.use_cassette("posts/destroy/successful_class") do
           post = PinboardApi::Post.destroy("http://www.bing.com/")
           post.must_be_kind_of PinboardApi::Post
         end
@@ -100,8 +189,10 @@ describe PinboardApi::Post do
     describe "when not successful" do
       it "raises an exception" do
         Faraday::Response.any_instance.stubs(:body).returns("")
-        VCR.use_cassette("posts/delete/unsuccessful_class") do
-          -> { PinboardApi::Post.destroy("xxBOGUSxxINVALIDxx") }.must_raise(RuntimeError)
+        PinboardApi::VCR.use_cassette("posts/delete/unsuccessful_class") do
+          -> {
+            PinboardApi::Post.destroy("xxBOGUSxxINVALIDxx")
+          }.must_raise(PinboardApi::InvalidResponseError)
         end
       end
     end
@@ -115,7 +206,7 @@ describe PinboardApi::Post do
     describe "found" do
       describe "with default values" do
         before do
-          VCR.use_cassette("posts/all/default_values", preserve_exact_body_bytes: true) do
+          PinboardApi::VCR.use_cassette("posts/all/default_values") do
             @posts = PinboardApi::Post.all
           end
         end
@@ -127,7 +218,7 @@ describe PinboardApi::Post do
 
       describe "with custom count" do
         before do
-          VCR.use_cassette("posts/all/custom_count", preserve_exact_body_bytes: true) do
+          PinboardApi::VCR.use_cassette("posts/all/custom_count") do
             @posts = PinboardApi::Post.all(results: 3)
           end
         end
@@ -139,7 +230,7 @@ describe PinboardApi::Post do
 
       describe "with custom tag" do
         before do
-          VCR.use_cassette("posts/all/custom_tag", preserve_exact_body_bytes: true) do
+          PinboardApi::VCR.use_cassette("posts/all/custom_tag") do
             @posts = PinboardApi::Post.all(tag: %w[ruby programming])
           end
           @tags = @posts.map(&:tags).flatten
@@ -150,12 +241,23 @@ describe PinboardApi::Post do
         it { @tags.must_include "programming" }
       end
 
+      describe "with meta" do
+        before do
+          PinboardApi::VCR.use_cassette("posts/all/with_meta") do
+            @posts = PinboardApi::Post.all(meta: true)
+          end
+        end
+
+        it { @posts.must_be_kind_of Array }
+        it { @posts.first.meta.wont_be_empty }
+      end
+
       describe "with custom times" do
-        let(:fromdt) { Time.new(2012, 05, 01).utc }
-        let(:todt)   { Time.new(2012, 06, 01).utc }
+        let(:fromdt) { Time.gm(2012, 05, 01) }
+        let(:todt)   { Time.gm(2012, 06, 01) }
 
         before do
-          VCR.use_cassette("posts/all/custom_times", preserve_exact_body_bytes: true) do
+          PinboardApi::VCR.use_cassette("posts/all/custom_times") do
             @posts = PinboardApi::Post.all(fromdt: fromdt, todt: todt)
           end
           @times = @posts.map(&:time).flatten
@@ -168,7 +270,7 @@ describe PinboardApi::Post do
 
     describe "not found" do
       before do
-        VCR.use_cassette("posts/all/not_found") do
+        PinboardApi::VCR.use_cassette("posts/all/not_found") do
           @posts = PinboardApi::Post.all(tag: "xxNOTxxFOUNDxx")
         end
       end
@@ -184,7 +286,7 @@ describe PinboardApi::Post do
   describe "self.find" do
     describe "found" do
       before do
-        VCR.use_cassette("posts/find/found", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/find/found") do
           @posts = PinboardApi::Post.find(tag: "test")
         end
       end
@@ -196,7 +298,7 @@ describe PinboardApi::Post do
 
     describe "not found" do
       before do
-        VCR.use_cassette("posts/find/not_found") do
+        PinboardApi::VCR.use_cassette("posts/find/not_found") do
           @posts = PinboardApi::Post.find(tag: "xxBOGUSxxINVALIDxx")
         end
       end
@@ -211,7 +313,7 @@ describe PinboardApi::Post do
   # #######################
   describe "self.last_update" do
     before do
-      VCR.use_cassette("posts/update") do
+      PinboardApi::VCR.use_cassette("posts/update") do
         @last_update = PinboardApi::Post.last_update
       end
     end
@@ -225,7 +327,7 @@ describe PinboardApi::Post do
   # #######################
   describe "self.suggest" do
     before do
-      VCR.use_cassette("posts/suggest") do
+      PinboardApi::VCR.use_cassette("posts/suggest") do
         @suggestions = PinboardApi::Post.suggest("http://blog.com")
       end
     end
@@ -244,7 +346,7 @@ describe PinboardApi::Post do
   describe "self.recent" do
     describe "with default values" do
       before do
-        VCR.use_cassette("posts/recent/default_values", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/recent/default_values") do
           @posts = PinboardApi::Post.recent
         end
       end
@@ -256,7 +358,7 @@ describe PinboardApi::Post do
 
     describe "with custom count" do
       before do
-        VCR.use_cassette("posts/recent/custom_count", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/recent/custom_count") do
           @posts = PinboardApi::Post.recent(count: 3)
         end
       end
@@ -268,7 +370,7 @@ describe PinboardApi::Post do
 
     describe "with custom tag" do
       before do
-        VCR.use_cassette("posts/recent/custom_tag", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/recent/custom_tag") do
           @posts = PinboardApi::Post.recent(tag: %w[ruby programming])
         end
         @tags = @posts.map(&:tags).flatten
@@ -287,7 +389,7 @@ describe PinboardApi::Post do
   describe "self.dates" do
     describe "with default values" do
       before do
-        VCR.use_cassette("posts/dates/default_values", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/dates/default_values") do
           @dates = PinboardApi::Post.dates
         end
         @date = @dates.first
@@ -303,7 +405,7 @@ describe PinboardApi::Post do
 
     describe "with custom tag" do
       before do
-        VCR.use_cassette("posts/dates/custom_tag", preserve_exact_body_bytes: true) do
+        PinboardApi::VCR.use_cassette("posts/dates/custom_tag") do
           @all_dates = PinboardApi::Post.dates
           @tag_dates = PinboardApi::Post.dates(tag: "ruby")
         end
@@ -392,24 +494,4 @@ describe PinboardApi::Post do
       it { @urls.must_include "http://www.baz.qux" }
     end
   end
-
-  # #######################
-  # self.dt_param_string
-  # #######################
-  describe "self.dt_param_string" do
-    let(:time) { Time.new(2012, 01, 01, 0, 0, 0, 0) }
-
-    it { post.dt_param_string(nil).must_be_nil }
-    it { post.dt_param_string(time).must_equal "2012-01-01T00:00:00Z" }
-  end
-
-  # #######################
-  # self.tag_param_string
-  # #######################
-  describe "self.tag_param_string" do
-    it { post.tag_param_string(nil).must_be_nil }
-    it { post.tag_param_string("foo").must_equal "foo" }
-    it { post.tag_param_string("foo,bar").must_equal "foo,bar" }
-    it { post.tag_param_string(%w[foo bar]).must_equal "foo,bar" }
-  end
 end

data/spec/support/pinboard_configuration.rb

@@ -1,5 +1,6 @@
 PinboardApi.username = ENV["PINBOARD_USERNAME"]
 PinboardApi.password = ENV["PINBOARD_PASSWORD"]
+PinboardApi.auth_token = ENV["PINBOARD_AUTH_TOKEN"]
 
 PinboardApi.ssl_options = ENV["PINBOARD_SSL_OPTIONS"] || begin
   if File.exists?("/opt/local/share/curl/curl-ca-bundle.crt")

data/spec/support/request_utils_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe PinboardApi::RequestUtils do
+  before do
+    class Helper
+      include PinboardApi::RequestUtils
+    end
+  end
+
+  describe "yes_no" do
+    it { Helper.new.yes_no(nil).must_be_nil }
+    it { Helper.new.yes_no(true).must_equal "yes" }
+    it { Helper.new.yes_no(false).must_equal "no" }
+  end
+
+  describe "self.dt_param_string" do
+    let(:time) { Time.new(2012, 01, 01, 0, 0, 0, 0) }
+
+    it { Helper.dt_param_string(nil).must_be_nil }
+    it { Helper.dt_param_string(time).must_equal "2012-01-01T00:00:00Z" }
+  end
+
+  describe "self.tag_param_string" do
+    it { Helper.tag_param_string(nil).must_be_nil }
+    it { Helper.tag_param_string("foo").must_equal "foo" }
+    it { Helper.tag_param_string("foo,bar").must_equal "foo,bar" }
+    it { Helper.tag_param_string(%w[foo bar]).must_equal "foo,bar" }
+  end
+end

data/spec/support/vcr.rb

@@ -4,11 +4,21 @@ require "base64"
 VCR.configure do |c|
   c.default_cassette_options = { record: :once, serialize_with: :json }
   c.hook_into :faraday
-  c.cassette_library_dir = "spec/fixtures/vcr_cassettes"
-  c.filter_sensitive_data("[USERNAME]") { PinboardApi.username }
-  c.filter_sensitive_data("[PASSWORD]") { PinboardApi.password }
+  c.cassette_library_dir = "spec/vcr_cassettes"
+  c.filter_sensitive_data("[USERNAME]")  { PinboardApi.username }
+  c.filter_sensitive_data("[PASSWORD]")  { PinboardApi.password }
+  c.filter_sensitive_data("[AUTHTOKEN]") { PinboardApi.auth_token }
   c.filter_sensitive_data("[FILTERED]") do
     credentials = [PinboardApi.username, PinboardApi.password].join(":")
     Base64.encode64(credentials).chomp
   end
 end
+
+module PinboardApi
+  class VCR
+    def self.use_cassette(name, options = {}, &block)
+      options.merge!(preserve_exact_body_bytes: true)
+      ::VCR.use_cassette name, options, &block
+    end
+  end
+end

data/spec/tag_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe PinboardApi::Tag do
-  let(:tag) { PinboardApi::Tag.new({"name" => "tag", "count" => 1}) }
+  let(:tag) { PinboardApi::Tag.new(name: "tag", count: 1) }
 
   it { tag.must_respond_to :name }
   it { tag.name.must_equal "tag" }
@@ -12,7 +12,7 @@ describe PinboardApi::Tag do
 
   describe "self.all" do
     before do
-      VCR.use_cassette("tags/all") do
+      PinboardApi::VCR.use_cassette("tags/all") do
         @tags = PinboardApi::Tag.all
       end
     end
@@ -27,7 +27,7 @@ describe PinboardApi::Tag do
   describe "self.find" do
     describe "found" do
       before do
-        VCR.use_cassette("tags/find/found") do
+        PinboardApi::VCR.use_cassette("tags/find/found") do
           @tags = PinboardApi::Tag.all
           @tag  = PinboardApi::Tag.find(@tags.first.name)
         end
@@ -39,7 +39,7 @@ describe PinboardApi::Tag do
 
     describe "not found" do
       before do
-        VCR.use_cassette("tags/find/not_found") do
+        PinboardApi::VCR.use_cassette("tags/find/not_found") do
           @tag = PinboardApi::Tag.find("xxBOGUSxxINVALIDxx")
         end
       end
@@ -52,7 +52,7 @@ describe PinboardApi::Tag do
   describe "#rename" do
     describe "when successful" do
       before do
-        VCR.use_cassette("tags/rename/successful") do
+        PinboardApi::VCR.use_cassette("tags/rename/successful") do
           tag = PinboardApi::Tag.all.first
           @new_name = "z_#{tag.name}"
           @new_tag  = tag.rename(@new_name)
@@ -64,9 +64,9 @@ describe PinboardApi::Tag do
 
     describe "when rename fails" do
       it "raises an exception" do
-        VCR.use_cassette("tags/rename/unsuccessful") do
+        PinboardApi::VCR.use_cassette("tags/rename/unsuccessful") do
           @tag = PinboardApi::Tag.all.first
-          -> { @tag.rename("") }.must_raise(RuntimeError)
+          -> { @tag.rename("") }.must_raise(PinboardApi::InvalidResponseError)
         end
       end
     end
@@ -76,7 +76,7 @@ describe PinboardApi::Tag do
   describe "#destroy" do
     describe "when successful" do
       it "returns self when the remote tag has been destroyed" do
-        VCR.use_cassette("tags/destroy/successful_instance") do
+        PinboardApi::VCR.use_cassette("tags/destroy/successful_instance") do
           tag = PinboardApi::Tag.find("junk")
           tag.destroy.must_equal tag
         end
@@ -87,9 +87,9 @@ describe PinboardApi::Tag do
     describe "when not successful" do
       it "raises an exception" do
         Faraday::Response.any_instance.stubs(:body).returns("")
-        VCR.use_cassette("tags/destroy/unsuccessful_instance") do
-          tag = PinboardApi::Tag.new("name" => "xxINVALIDxxBOGUSxx", "count" => 1)
-          -> { tag.destroy }.must_raise(RuntimeError)
+        PinboardApi::VCR.use_cassette("tags/destroy/unsuccessful_instance") do
+          tag = PinboardApi::Tag.new(name: "xxINVALIDxxBOGUSxx", count: 1)
+          -> { tag.destroy }.must_raise(PinboardApi::InvalidResponseError)
         end
       end
     end
@@ -98,7 +98,7 @@ describe PinboardApi::Tag do
   describe "self.destroy" do
     describe "when successful" do
       it "returns self when the remote tag has been destroyed" do
-        VCR.use_cassette("tags/destroy/successful_class") do
+        PinboardApi::VCR.use_cassette("tags/destroy/successful_class") do
           tag = PinboardApi::Tag.destroy("junk")
           tag.must_be_kind_of PinboardApi::Tag
         end
@@ -109,7 +109,9 @@ describe PinboardApi::Tag do
       it "raises an exception" do
         Faraday::Response.any_instance.stubs(:body).returns("")
         VCR.use_cassette("tags/destroy/unsuccessful_class") do
-          -> { PinboardApi::Tag.destroy("xxINVALIDxxBOGUSxx") }.must_raise(RuntimeError)
+          -> {
+            PinboardApi::Tag.destroy("xxINVALIDxxBOGUSxx")
+          }.must_raise(PinboardApi::InvalidResponseError)
         end
       end
     end