pinboard 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87e4728ac5ff02326e59e0e45c4fe16fc9d6ce5f
+  data.tar.gz: 14d81e89e3e115e54b28734c3aa7e5fcbc57f78b
+SHA512:
+  metadata.gz: 29a4d7c10d0d505d206480eb8cdac5c2c50cb856fc06dae85d242ab24abb5b15e5e467195707da4238f6f88cb8af50f4d4ae80b6ec723aeda989d22a298719a9
+  data.tar.gz: 7400003c1fd60bdf8c0f070d42249040012da1f6de16b21989c62dd357922ea5d04d7e18b7146678df578aab14c06b0300c185eb1b2fcc9f6dab126ca2481873

data/Guardfile

@@ -1,7 +1,10 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(%r|^.*\.gemspec|)
+end
+
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/helper.rb')  { "spec" }
-
 end
-

data/README.md

@@ -33,6 +33,13 @@ Passing arguments: (works only for the Client API Interface)
     pinboard.posts(:todt => 4.days.ago) #all posts up to 4 days ago
 ```
 
+Adding new posts:
+
+```ruby
+  pinboard.add(:url => "http://example.com/", :description => 'Example post')
+```
+
+
 Future Examples (I don't need them, so I haven't written them)
 --------------------------------------------------------------
 
@@ -51,6 +58,8 @@ integration and support of the following rubies in rvm:
 
 [![Build Status](https://secure.travis-ci.org/ryw/pinboard.png)](http://travis-ci.org/ryw/pinboard)
 
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/ryw/pinboard)
+
 Links
 -----
   * [Pinboard API Documentation](http://pinboard.in/api/)
@@ -64,7 +73,7 @@ If you find what looks like a bug:
   * If you don’t see anything, create an issue with information on how to reproduce it.
 
 If you want to contribute an enhancement or a fix:
- 
+
   * Fork the [project on github](http://github.com/ryw/pinboard).
   * Make your changes with specs.
   * Commit the changes without messing with the Rakefile, VERSION, or history.

data/lib/pinboard/client.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 
 module Pinboard
+  Error = Class.new(StandardError)
+
   class Client
     include HTTParty
     base_uri 'api.pinboard.in:443/v1'
@@ -19,5 +21,32 @@ module Pinboard
       posts = [posts] if posts.class != Array
       posts.map { |p| Post.new(Util.symbolize_keys(p)) }
     end
+
+    def add(params={})
+      options = {}
+      options[:basic_auth] = @auth
+
+      # Pinboard expects multiple tags=foo,bar separated by comma instead of tag=foo&tag=bar
+      params[:tags] = Array(params[:tags]).join(',') if params[:tags]
+
+      # Pinboard expects replace, shared and toread as yes/no instead of true/false
+      [:replace, :shared, :toread].each do |boolean|
+          params[boolean] = params[boolean] ? 'yes' : 'no' if params.has_key?(boolean)
+      end
+
+      options[:query] = params
+      result_code = self.class.post('/posts/add', options).parsed_response["result"]["code"]
+
+      raise Error.new(result_code) if result_code != "done"
+    end
+
+    def delete(params={})
+      options = {}
+      options[:basic_auth] = @auth
+      options[:query] = params
+      result_code = self.class.get('/posts/delete', options).parsed_response["result"]["code"]
+
+      raise Error.new(result_code) if result_code != "done"
+    end
   end
 end

data/lib/pinboard/post.rb

@@ -1,12 +1,12 @@
 module Pinboard
-  class Post < Struct.new(:href, :description, :tag, :time)
+  class Post < Struct.new(:href, :description, :extended, :tag, :time, :replace, :shared, :toread)
     def self.all(options={})
       client = Pinboard::Client.new(options)
       posts = client.class.get('/posts/all',
                 :basic_auth => options)['posts']['post']
       posts.map { |p| Post.new(Util.symbolize_keys(p)) }
     end
-    
+
     def initialize(attributes={})
       self.time = Util.parse_time(attributes.delete(:time))
       self.tag  = attributes.delete(:tag).split(" ")

data/pinboard.gemspec

@@ -4,14 +4,15 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.6'
   s.add_development_dependency 'webmock', '~> 1.6'
   s.add_development_dependency 'guard-rspec', '~> 0.5'
-  if RUBY_PLATFORM =~ /darwin/
-    s.add_development_dependency "growl_notify"
-    s.add_development_dependency "rb-fsevent"
-  end
-  
+  s.add_development_dependency 'guard-bundler'
+  s.add_development_dependency 'libnotify'
+  s.add_development_dependency 'rb-inotify'
+  s.add_development_dependency 'rb-fsevent'
+  s.add_development_dependency 'terminal-notifier-guard'
+
   s.add_runtime_dependency 'httparty', '= 0.7.8'
   s.name = 'pinboard'
-  s.version = '0.0.4'
+  s.version = '0.0.5'
   s.date = '2012-05-08'
   s.summary = "Ruby wrapper for the Pinboard API"
   s.description = "Ruby wrapper for the Pinboard API"

data/spec/fixtures/created.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<result code="done" />

data/spec/fixtures/deleted.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+	<result code="done" />

data/spec/fixtures/missing_description.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<result code="missing description"/>

data/spec/fixtures/missing_url.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<result code="missing url"/>

data/spec/fixtures/multiple_posts.xml

@@ -3,7 +3,7 @@
   <post href="http://foo.com/"
         time="2011-07-26T17:52:04Z"
         description="Foo!"
-        extended=""
+        extended="long description Foo"
         tag="foo bar"
         hash="0c85c54332a588d18a85e963257e8fbc"
         meta="5cea9129d6a4f10e4790cc8665c48423"
@@ -12,7 +12,7 @@
   <post href="http://bar.com/"
         time="2011-07-26T17:52:04Z"
         description="Bar!"
-        extended=""
+        extended="long description Bar"
         tag="foo bar"
         hash="0c85c54332a588d18a85e963257e8fbc"
         meta="5cea9129d6a4f10e4790cc8665c48423"

data/spec/fixtures/not_found.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+	<result code="item not found"/>

data/spec/helper.rb

@@ -12,8 +12,15 @@ def a_get(path)
 end
 
 def stub_get(path)
-  uri = "https://#{auth_params[:username]}:#{auth_params[:password]}@api.pinboard.in/v1/#{path}"
-  stub_request(:get, uri)
+  stub_request(:get, uri(path))
+end
+
+def stub_post(path)
+  stub_request(:post, uri(path))
+end
+
+def uri(path)
+  "https://#{auth_params[:username]}:#{auth_params[:password]}@api.pinboard.in/v1/#{path}"
 end
 
 def fixture_path

data/spec/pinboard/client_spec.rb

@@ -17,12 +17,16 @@ describe Pinboard::Client do
             Pinboard::Post.new(
               :href => "http://foo.com/",
               :description => "Foo!",
+              :extended => "long description Foo",
               :tag => 'foo bar',
+              :toread => 'yes',
               :time => Time.parse("2011-07-26T17:52:04Z")),
             Pinboard::Post.new(
               :href => "http://bar.com/",
               :description => "Bar!",
+              :extended => "long description Bar",
               :tag => 'foo bar',
+              :toread => 'yes',
               :time => Time.parse("2011-07-26T17:52:04Z")),
           ]
 
@@ -54,4 +58,181 @@ describe Pinboard::Client do
       end
     end
   end
+
+  describe "#delete" do
+    let(:client) { Pinboard::Client.new(auth_params) }
+
+    context "when there are many posts" do
+      before do
+        stub_get("posts/delete?url=http://bar.com/").
+          to_return(:body => fixture("deleted.xml"),
+                    :headers => { 'content-type' => 'text/xml' })
+      end
+
+      it "succeeds without raising an error" do
+        expect{client.delete(:url => "http://bar.com/")}.to_not raise_error
+      end
+    end
+
+    context "when specified url is not found" do
+      before do
+        stub_get("posts/delete?url=http://baz.com/").
+          to_return(:body => fixture("not_found.xml"),
+                    :headers => { 'content-type' => 'text/xml' })
+      end
+
+      it "throws an error" do
+        expect{client.delete(:url => "http://baz.com/")}.to raise_error(Pinboard::Error, 'item not found')
+      end
+    end
+  end
+
+  describe "#add" do
+    let(:client) do
+      Pinboard::Client.new(auth_params)
+    end
+
+    context "where the post does not exist yet" do
+
+      context 'and the url is missing' do
+        before do
+          stub_post("posts/add").
+            to_return(:body => fixture("missing_url.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "throws an error" do
+          expect { client.add(nil) }.to raise_error
+        end
+      end
+
+      context 'and the description is missing' do
+        before do
+          stub_post("posts/add?url=http://baz.com/").
+            to_return(:body => fixture("missing_description.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "throws an error" do
+          expect { client.add(:url => "http://baz.com/") }.to raise_error(Pinboard::Error, 'missing description')
+        end
+      end
+
+      context 'and the description is present' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title')}.to_not raise_error
+        end
+      end
+
+      context 'and toread is set to true' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&toread=yes").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :toread => true)}.to_not raise_error
+        end
+      end
+
+      context 'and toread is set to false' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&toread=no").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :toread => false)}.to_not raise_error
+        end
+      end
+
+      context 'and replace is set to true' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&replace=yes").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :replace => true)}.to_not raise_error
+        end
+      end
+
+      context 'and replace is set to false' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&replace=no").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :replace => false)}.to_not raise_error
+        end
+      end
+
+      context 'and shared is set to true' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&shared=yes").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :shared => true)}.to_not raise_error
+        end
+      end
+
+      context 'and shared is set to false' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&shared=no").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/", :description => 'title', :shared => false)}.to_not raise_error
+        end
+      end
+
+      context 'and replace, shared, and toread are all set to true' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&replace=yes&shared=yes&toread=yes").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/",
+                             :description => 'title',
+                             :replace => true,
+                             :shared => true,
+                             :toread => true)}.to_not raise_error
+        end
+      end
+
+      context 'and replace, shared, and toread are all set to false' do
+        before do
+          stub_post("posts/add?url=http://baz.com/&description=title&replace=no&shared=no&toread=no").
+            to_return(:body => fixture("created.xml"),
+                      :headers => { 'content-type' => 'text/xml' })
+        end
+
+        it "succeeds without raising an exception" do
+          expect {client.add(:url => "http://baz.com/",
+                             :description => 'title',
+                             :replace => false,
+                             :shared => false,
+                             :toread => false)}.to_not raise_error
+        end
+      end
+    end
+  end
 end

data/spec/pinboard/post_spec.rb

@@ -19,6 +19,7 @@ describe Pinboard::Post do
       post = posts.first
       post.href.should == "http://foo.com/"
       post.description.should == "Foo!"
+      post.extended.should == "long description Foo"
       post.tag.should == ["foo", "bar"]
       post.time.should == Time.parse('Tue Jul 26 17:52:04 UTC 2011')
     end
@@ -29,6 +30,7 @@ describe Pinboard::Post do
       Pinboard::Post.new(
         :href => 'http://foo.com',
         :description => 'Foo!',
+        :extended => "long description Foo",
         :tag => 'rspec pinboard',
         :time => Time.mktime(2011, 1, 1))
     }
@@ -36,6 +38,7 @@ describe Pinboard::Post do
     it "initializes attributes" do
       post.href.should        == 'http://foo.com'
       post.description.should == 'Foo!'
+      post.extended.should    == "long description Foo"
       post.tag.should         == %w{rspec pinboard}
       post.time.should        == Time.mktime(2011, 1, 1)
     end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinboard
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Ryan Waker
@@ -13,92 +12,158 @@ date: 2012-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70278122833360 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70278122833360
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70278122832800 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70278122832800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70278122832180 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70278122832180
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70278122831160 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70278122831160
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70278122829380 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70278122829380
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: growl_notify
-  requirement: &70278122828800 !ruby/object:Gem::Requirement
-    none: false
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70278122828800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70278122827920 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70278122827920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70278122820580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.7.8
   type: :runtime
   prerelease: false
-  version_requirements: *70278122820580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.8
 description: Ruby wrapper for the Pinboard API
 email: ry@anotherventure.com
 executables: []
@@ -119,8 +184,13 @@ files:
 - lib/pinboard/post.rb
 - lib/pinboard/util.rb
 - pinboard.gemspec
+- spec/fixtures/created.xml
+- spec/fixtures/deleted.xml
+- spec/fixtures/missing_description.xml
+- spec/fixtures/missing_url.xml
 - spec/fixtures/multiple_posts.xml
 - spec/fixtures/no_posts.xml
+- spec/fixtures/not_found.xml
 - spec/fixtures/single_post.xml
 - spec/helper.rb
 - spec/pinboard/client_spec.rb
@@ -128,31 +198,35 @@ files:
 - spec/pinboard_spec.rb
 homepage: http://github.com/ryw/pinboard
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrapper for the Pinboard API
 test_files:
+- spec/fixtures/created.xml
+- spec/fixtures/deleted.xml
+- spec/fixtures/missing_description.xml
+- spec/fixtures/missing_url.xml
 - spec/fixtures/multiple_posts.xml
 - spec/fixtures/no_posts.xml
+- spec/fixtures/not_found.xml
 - spec/fixtures/single_post.xml
 - spec/helper.rb
 - spec/pinboard/client_spec.rb