pinboard 0.0.0 → 0.0.2

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.DS_Store
+.bundle
+.rvmrc
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*
+log/*
+vendor/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - jruby
+  - ree
+  - ruby-head

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ryan Walker
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+The Pinboard Ruby Gem
+=====================
+A Ruby wrapper for the [Pinboard API](http://pinboard.in/api/).
+
+Installation
+------------
+    gem install pinboard
+
+Examples
+--------
+
+I'm currently exploring two API interfaces:
+
+    pinboard = Pinboard::Client.new(:username => 'foo', :password => 'bar')
+    posts = pinboard.posts
+
+or:
+
+    posts = Pinboard::Post.all(:username => 'foo', :password => 'bar')
+
+Both examples work.
+
+Future Examples (I don't need them, so I haven't written them)
+--------------------------------------------------------------
+
+    pinboard.posts(:tag => 'ruby') #all posts tagged 'ruby'
+    pinboard.posts(:start => 20) #starting on the 20th post
+    pinboard.posts(:results => 20) #return only first 20 matching posts
+    pinboard.posts(:from => 4.days.ago) #all posts in past 4 days
+    pinboard.posts(:to => 4.days.ago) #all posts up to 4 days ago
+    pinboard.posts(:meta => true) #include meta data in post models
+
+Ruby Support & Continuous Integration
+-------------------------------------
+I am using [travis-ci.org](http://travis-ci.org) for continuous
+integration and support of the following rubies in rvm:
+
+ * 1.8.7
+ * 1.9.2
+ * jruby
+ * ree
+ * ruby-head
+
+[![Build Status](https://secure.travis-ci.org/ryw/pinboard.png)](http://travis-ci.org/ryw/pinboard)
+
+Links
+-----
+  * [Pinboard API Documentation](http://pinboard.in/api/)
+
+How to Contribute
+-----------------
+If you find what looks like a bug:
+
+  * Check the [GitHub issue tracker](http://github.com/ryw/pinboard/issues/)
+    to see if anyone else has had the same issue.
+  * 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.
+  * Send me a pull request.
+
+TODO
+----
+
+* Throttle requests to one per second:
+  http://datagraph.rubyforge.org/rack-throttle/
+* If get 503 response, double the throttle to two seconds
+
+Copyright
+---------
+Copyright (c) 2011 Ryan Walker. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/pinboard.rb

@@ -1,7 +1,15 @@
-class Pinboard
+require 'pinboard/util'
+require 'pinboard/client'
+require 'pinboard/post'
 
-  def self.hello
-    puts 'hi'
-  end
+module Pinboard
+  class << self
+    def new(options={})
+      Pinboard::Client.new(options)
+    end
 
+    def endpoint
+      Pinboard::Client.base_uri
+    end
+  end
 end

data/lib/pinboard/client.rb

@@ -0,0 +1,19 @@
+require 'httparty'
+
+module Pinboard
+  class Client
+    include HTTParty
+    base_uri 'api.pinboard.in:443/v1'
+
+    def initialize(options={})
+      @auth = { :username => options[:username],
+                :password => options[:password] }
+    end
+
+    def posts
+      options = { :basic_auth => @auth }
+      posts = self.class.get('/posts/all', options)['posts']['post']
+      posts.map { |p| Post.new(Util.symbolize_keys(p)) }
+    end
+  end
+end

data/lib/pinboard/post.rb

@@ -0,0 +1,19 @@
+module Pinboard
+  class Post < Struct.new(:href, :description, :tag, :time)
+    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(" ")
+
+      attributes.each do |attribute, value|
+        send("#{attribute}=", value) if respond_to?("#{attribute}=")
+      end
+    end
+  end
+end

data/lib/pinboard/util.rb

@@ -0,0 +1,19 @@
+module Pinboard
+  module Util
+    extend self
+
+    def symbolize_keys(hash)
+      hash.inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+    end
+
+    def parse_time(time)
+      return time if time.is_a?(Time)
+      return time.to_time if time.is_a?(Date)
+
+      Time.parse(time)
+    end
+  end
+end

data/pinboard.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.add_development_dependency 'yard', '~> 0.7'
+  s.add_development_dependency 'rake', '~> 0.9'
+  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_runtime_dependency 'httparty', '~> 0.7'
+  s.name = 'pinboard'
+  s.version = '0.0.2'
+  s.date = '2011-10-13'
+  s.summary = "Ruby wrapper for the Pinboard API"
+  s.description = "Ruby wrapper for the Pinboard API"
+  s.authors = ["Ryan Waker"]
+  s.email = 'ry@anotherventure.com'
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+  s.homepage = 'http://github.com/ryw/pinboard'
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+end

data/spec/fixtures/posts_all.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<posts user="user">
+  <post href="http://foo.com/"
+        time="2011-07-26T17:52:04Z"
+        description="Foo!"
+        extended=""
+        tag="foo bar"
+        hash="0c85c54332a588d18a85e963257e8fbc"
+        meta="5cea9129d6a4f10e4790cc8665c48423"
+        toread="yes"
+        />
+  <post href="http://bar.com/"
+        time="2011-07-26T17:52:04Z"
+        description="Bar!"
+        extended=""
+        tag="foo bar"
+        hash="0c85c54332a588d18a85e963257e8fbc"
+        meta="5cea9129d6a4f10e4790cc8665c48423"
+        toread="yes"
+        />
+</posts>
+

data/spec/helper.rb

@@ -0,0 +1,25 @@
+require 'pinboard'
+require 'rspec'
+require 'webmock/rspec'
+
+def auth_params
+  { :username => 'user',
+    :password => 'pass' }
+end
+
+def a_get(path)
+  a_request(:get, Pinboard.endpoint + path)
+end
+
+def stub_get(path)
+  uri = "https://#{auth_params[:username]}:#{auth_params[:password]}@api.pinboard.in/v1/#{path}"
+  stub_request(:get, uri)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/pinboard/client_spec.rb

@@ -0,0 +1,30 @@
+require 'helper'
+
+describe Pinboard::Client do
+  describe "#posts" do
+    let(:client) { Pinboard::Client.new(auth_params) }
+
+    before do
+      stub_get("posts/all").
+        to_return(:body => fixture("posts_all.xml"),
+        :headers => { 'content-type' => 'text/xml' })
+    end
+
+    it "returns a collection of posts" do
+      expected = [
+        Pinboard::Post.new(
+          :href => "http://foo.com/",
+          :description => "Foo!",
+          :tag => 'foo bar',
+          :time => Time.parse("2011-07-26T17:52:04Z")),
+        Pinboard::Post.new(
+          :href => "http://bar.com/",
+          :description => "Bar!",
+          :tag => 'foo bar',
+          :time => Time.parse("2011-07-26T17:52:04Z"))
+      ]
+
+      client.posts.should == expected
+    end
+  end
+end

data/spec/pinboard/post_spec.rb

@@ -0,0 +1,43 @@
+require 'helper'
+
+describe Pinboard::Post do
+
+  describe ".all" do
+    let(:posts) { Pinboard::Post.all(auth_params) }
+
+    before do
+      stub_get("posts/all").
+        to_return(:body => fixture("posts_all.xml"),
+                  :headers => { 'content-type' => 'text/xml' })
+    end
+
+    it "returns a collection" do
+      posts.count.should == 2
+    end
+
+    it "loads posts with valid attributes" do
+      post = posts.first
+      post.href.should == "http://foo.com/"
+      post.description.should == "Foo!"
+      post.tag.should == ["foo", "bar"]
+      post.time.should == Time.parse('Tue Jul 26 17:52:04 UTC 2011')
+    end
+  end
+  
+  describe ".new" do
+    let(:post) {
+      Pinboard::Post.new(
+        :href => 'http://foo.com',
+        :description => 'Foo!',
+        :tag => 'rspec pinboard',
+        :time => Time.mktime(2011, 1, 1))
+    }
+
+    it "initializes attributes" do
+      post.href.should        == 'http://foo.com'
+      post.description.should == 'Foo!'
+      post.tag.should         == %w{rspec pinboard}
+      post.time.should        == Time.mktime(2011, 1, 1)
+    end
+  end
+end

data/spec/pinboard_spec.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+describe Pinboard do
+
+  describe ".new" do
+
+    it "returns a Pinboard client" do
+      Pinboard.new.should be_a Pinboard::Client
+    end
+
+  end
+
+  describe ".endpoint" do
+
+    it "sets the endpoint" do
+      Pinboard.endpoint.should == 'https://api.pinboard.in:443/v1'
+    end
+
+  end
+
+end

metadata

@@ -1,26 +1,142 @@
 --- !ruby/object:Gem::Specification 
 name: pinboard
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 0
-  version: 0.0.0
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
-- Ry Waker
+- Ryan Waker
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2011-10-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: growl_notify
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rb-fsevent
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id008
 description: Ruby wrapper for the Pinboard API
-email: ry@rywalker.com
+email: ry@anotherventure.com
 executables: []
 
 extensions: []
@@ -28,9 +144,26 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .autotest
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
 - lib/pinboard.rb
-has_rdoc: true
-homepage: http://rubygems.org/gems/pinboard
+- lib/pinboard/client.rb
+- lib/pinboard/post.rb
+- lib/pinboard/util.rb
+- pinboard.gemspec
+- spec/fixtures/posts_all.xml
+- spec/helper.rb
+- spec/pinboard/client_spec.rb
+- spec/pinboard/post_spec.rb
+- spec/pinboard_spec.rb
+homepage: http://github.com/ryw/pinboard
 licenses: []
 
 post_install_message: 
@@ -52,16 +185,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Pinboard API
-test_files: []
-
+test_files: 
+- spec/fixtures/posts_all.xml
+- spec/helper.rb
+- spec/pinboard/client_spec.rb
+- spec/pinboard/post_spec.rb
+- spec/pinboard_spec.rb