thumbtack 0.0.1

data/lib/thumbtack/types/md5.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Thumbtack
+  module Types
+    # Internal: Handles validation of MD5 types as the values supported by the
+    # Pinboard API.
+    class MD5 < Identity
+      # The length of an MD5 value.
+      LENGTH = 32
+      # The valid characters in an MD5 value.
+      CHARACTERS = '0123456789abcdf'.freeze
+
+      # Validate something is a valid MD5 parameter.
+      #
+      # value - A String containing the MD5 to validate.
+      #
+      # Returns nothing.
+      # Raises Types::ValidationError if the value is not a 32 character
+      # hexadecimal MD5 hash.
+      def self.validate(value)
+        unless value.length == 32 &&
+            value.each_char.all? { |char| CHARACTERS.include?(char) }
+          fail ValidationError,
+               "#{value} must be a 32 character hexadecimal MD5 hash"
+        end
+        self
+      end
+    end
+  end
+end

data/lib/thumbtack/types/tags.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module Thumbtack
+  module Types
+    # Internal: Handles validation of tag lists as the values supported by the
+    # Pinboard API.
+    class Tags
+      # The maximum tag length.
+      MAXIMUM_LENGTH = 255
+      # Tags cannot have commas.
+      INVALID_CHARACTER = ','.freeze
+      # Tag parameters are separated by spaces.
+      SEPARATOR = ' '.freeze
+
+      # Validate a tags value.
+      #
+      # value - A String containing a single tag or an Array containing many
+      #         tags.
+      #
+      # Returns nothing.
+      # Raises Types::ValidationError if any tag contains commas or are longer
+      # than 255 characters.
+      def self.validate(value)
+        Array(value).each do |tag|
+          unless tag.length < MAXIMUM_LENGTH && !tag.include?(INVALID_CHARACTER)
+            fail ValidationError,
+                 "#{tag} cannot contain commas or be longer than 255 characters"
+          end
+        end
+        self
+      end
+
+      # Convert a tag value to a parameter acceptable to the Pinboard API.
+      #
+      # value - A String containing a single tag or an Array containing many
+      #         tags.
+      #
+      # Returns a String containing the tags, space-separated.
+      def self.to_parameter(value)
+        Array(value).map(&:strip).join(SEPARATOR)
+      end
+
+      # Convert a parameter from the Pinboard API to an Array of tags.
+      #
+      # parameter - A String containing space-separated tags.
+      #
+      # Returns an Array of tags.
+      def self.from_parameter(parameter)
+        parameter.split(SEPARATOR)
+      end
+    end
+  end
+end

data/lib/thumbtack/types/text.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Thumbtack
+  module Types
+    # Internal: Handles validation of text values as supported by Pinboard.
+    class Text < Identity
+      # Maximum length of a text value.
+      MAXIMUM_LENGTH = 65_536
+
+      # Validate text.
+      #
+      # value - A String containing the text to validate.
+      #
+      # Returns nothing.
+      # Raises Types::ValidationError if the value is longer than 65536
+      # characters.
+      def self.validate(value)
+        unless value.length <= MAXIMUM_LENGTH
+          fail ValidationError,
+               "#{value} cannot be greater than #{MAXIMUM_LENGTH} characters"
+        end
+        self
+      end
+    end
+  end
+end

data/lib/thumbtack/types/title.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Thumbtack
+  module Types
+    # Internal: Handles validation of title values as supported by Pinboard.
+    class Title < Identity
+      # Maximum length of a title value.
+      MAXIMUM_LENGTH = 255
+
+      # Validate a title.
+      #
+      # value - A String containing the title to validate.
+      #
+      # Returns nothing.
+      # Raises Types::ValidationError if the value is longer than 255
+      # characters.
+      def self.validate(value)
+        unless value.length <= MAXIMUM_LENGTH
+          fail ValidationError,
+               "#{value} cannot be greater than #{MAXIMUM_LENGTH} characters"
+        end
+        self
+      end
+    end
+  end
+end

data/lib/thumbtack/types/url.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Thumbtack
+  module Types
+    # Internal: Handles validation of URL values as supported by Pinboard.
+    class URL < Identity
+      # Valid URL schemes.
+      VALID_SCHEMES = %w(http https javascript mailto ftp file feed).freeze
+
+      # Validate a URL.
+      #
+      # value - A String containing the URL to validate.
+      #
+      # Returns nothing.
+      # Raises Types::ValidationError if the URL's scheme isn't one of http,
+      # https, javascript, mailto, ftp, file, or feed.
+      def self.validate(value)
+        unless VALID_SCHEMES.include? URI(value).scheme
+          fail ValidationError,
+               "scheme must be one of #{VALID_SCHEMES.join(', ')}"
+        end
+        self
+      end
+    end
+  end
+end

data/lib/thumbtack/types.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+module Thumbtack
+  # Handlers for each of the data types in the Pinboard API. See
+  # https://pinboard.in/api/#data
+  module Types
+    # Internal: Raised when given an invalid argument
+    class ValidationError < StandardError; end
+  end
+end

data/lib/thumbtack/user.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Thumbtack
+  # Internal: Wraps API calls related to users.
+  class User
+    # Internal: Creates a new User.
+    #
+    # client - a Thumbtack::Client to communicate with the Pinboard API.
+    def initialize(client)
+      @client = client
+    end
+
+    # Public: Returns the user's secret RSS key for viewing private feeds.
+    def secret
+      @client.get('/user/secret').fetch('result')
+    end
+
+    # Public: Returns the user's API token for making calls without a password.
+    def api_token
+      @client.get('/user/api_token').fetch('result')
+    end
+  end
+end

data/lib/thumbtack/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module Thumbtack
+  # Gem version
+  VERSION = '0.0.1'.freeze
+end

data/lib/thumbtack.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+# A simple Pinboard API wrapper
+module Thumbtack
+end
+
+require 'date'
+require 'json'
+require 'net/http'
+require 'uri'
+
+require 'thumbtack/types'
+require 'thumbtack/types/boolean'
+require 'thumbtack/types/date'
+require 'thumbtack/types/date_time'
+require 'thumbtack/types/identity'
+require 'thumbtack/types/integer'
+require 'thumbtack/types/md5'
+require 'thumbtack/types/tags'
+require 'thumbtack/types/text'
+require 'thumbtack/types/title'
+require 'thumbtack/types/url'
+require 'thumbtack/specification'
+require 'thumbtack/post'
+require 'thumbtack/posts'
+require 'thumbtack/tags'
+require 'thumbtack/user'
+require 'thumbtack/note'
+require 'thumbtack/note_summary'
+require 'thumbtack/notes'
+require 'thumbtack/client'
+require 'thumbtack/version'

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'thumbtack'
+require 'minitest/autorun'
+
+def auth_token
+  File.open(File.expand_path('../auth_token.txt', __FILE__)).read.strip
+end
+
+def username
+  auth_token.split(':').first
+end
+
+def token
+  auth_token.split(':').last
+end
+
+include Thumbtack

data/test/thumbtack/client_test.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class ClientTest < Minitest::Test
+  def setup
+    @client = Client.new(username, token)
+  end
+
+  def test_requests_return_parsed_json
+    response = @client.get('/user/api_token')
+    assert_equal({ 'result' => token }, response)
+  end
+
+  def test_request_query_parameters
+    response = @client.get('/tags/delete', tag: 'thumbtack-test-query-params')
+    assert_equal({ 'result' => 'done' }, response)
+  end
+
+  def test_posts
+    assert_instance_of Posts, @client.posts
+  end
+
+  def test_tags
+    assert_instance_of Tags, @client.tags
+  end
+
+  def test_user
+    assert_instance_of User, @client.user
+  end
+
+  def test_notes
+    assert_instance_of Notes, @client.notes
+  end
+end

data/test/thumbtack/note_summary_test.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class NoteSummaryTest < Minitest::Test
+  def test_from_hash
+    hash = {
+      'id' => '8e5d6964bb810e0050b0',
+      'title' => 'StarCraft beta coming this week!',
+      'hash' => '0c9c30f60cadabd31415',
+      'created_at' => '2010-02-11 03:46:56',
+      'updated_at' => '2010-02-11 03:47:47',
+      'length' => 19,
+    }
+    note = NoteSummary.from_hash(hash)
+
+    assert_equal '8e5d6964bb810e0050b0', note.id
+    assert_equal 'StarCraft beta coming this week!', note.title
+    assert_equal '0c9c30f60cadabd31415', note.hash
+    assert_equal '2010-02-11 03:46:56', note.created_at
+    assert_equal '2010-02-11 03:47:47', note.updated_at
+    assert_equal 19, note.length
+  end
+end

data/test/thumbtack/note_test.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class NoteTest < Minitest::Test
+  def test_from_hash
+    hash = {
+      'id' => '8e5d6964bb810e0050b0',
+      'title' => 'StarCraft beta coming this week!',
+      'hash' => '0c9c30f60cadabd31415',
+      'created_at' => '2010-02-11 03:46:56',
+      'updated_at' => '2010-02-11 03:47:47',
+      'length' => 19,
+      'text' => 'This is a test note'
+    }
+    note = Note.from_hash(hash)
+
+    assert_equal '8e5d6964bb810e0050b0', note.id
+    assert_equal 'StarCraft beta coming this week!', note.title
+    assert_equal '0c9c30f60cadabd31415', note.hash
+    assert_equal '2010-02-11 03:46:56', note.created_at
+    assert_equal '2010-02-11 03:47:47', note.updated_at
+    assert_equal 19, note.length
+    assert_equal 'This is a test note', note.text
+  end
+end

data/test/thumbtack/notes_test.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class NotesTest < Minitest::Test
+  def mock_client(url, params, response)
+    client = Minitest::Mock.new
+    client.expect(:get, response, [url, params].compact)
+    client
+  end
+
+  def test_list
+    client = mock_client('/notes/list',
+                         nil,
+                         {
+                           'count' => 2,
+                           'notes' => [
+                             {
+                               'id' => 'cf73bfc02e00edaa1e2b',
+                               'title' => 'Paul Graham on Hirin\' The Ladies',
+                               'hash' => '0bbca3cba9246bbbda2c',
+                               'created_at' => '2011-10-28 13:37:23',
+                               'updated_at' => '2011-10-28 13:37:23',
+                               'length' => '890',
+                             },
+                             {
+                               'id' => '8e5d6964bb810e0050b0',
+                               'title' => 'StarCraft beta coming this week!',
+                               'hash' => '0c9c30f60cadabd31415',
+                               'created_at' => '2010-02-11 03:46:56',
+                               'updated_at' => '2010-02-11 03:47:47',
+                               'length' => '153',
+                             },
+                           ]
+                         })
+    notes = Notes.new(client)
+    result = notes.list
+
+    assert_equal 2, result.length
+    assert_equal 'cf73bfc02e00edaa1e2b', result[0].id
+    assert_equal '8e5d6964bb810e0050b0', result[1].id
+  end
+
+  def test_list
+    client = mock_client('/notes/8e5d6964bb810e0050b0',
+                         nil,
+                         {
+                           'id' => '8e5d6964bb810e0050b0',
+                           'title' => 'StarCraft beta coming this week!',
+                           'text' => 'This is a test note',
+                           'hash' => '0c9c30f60cadabd31415',
+                           'created_at' => '2010-02-11 03:46:56',
+                           'updated_at' => '2010-02-11 03:47:47',
+                           'length' => 19
+                         })
+    notes = Notes.new(client)
+    result = notes.get('8e5d6964bb810e0050b0')
+    assert_equal '8e5d6964bb810e0050b0', result.id
+    assert_equal 19, result.length
+  end
+end

data/test/thumbtack/post_test.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class PostTest < Minitest::Test
+  def test_from_hash
+    hash = {
+      'href' => 'http://example.org',
+      'description' => 'example.org',
+      'extended' => '',
+      'meta' => '46ca40b9b92ee0ea1284785a5d2a9b38',
+      'hash' => 'dab521de65f9250b4cca7383feef67dc',
+      'time' => '2014-06-29T16:57:45Z',
+      'shared' => 'yes',
+      'toread' => 'no',
+      'tags' => 'test123'
+    }
+    post = Post.from_hash(hash)
+
+    assert_equal 'http://example.org', post.href
+    assert_equal 'example.org', post.description
+    assert_equal '', post.extended
+    assert_equal '46ca40b9b92ee0ea1284785a5d2a9b38', post.meta
+    assert_equal 'dab521de65f9250b4cca7383feef67dc', post.hash
+    assert_equal '2014-06-29T16:57:45Z', post.time
+    assert_equal 'yes', post.shared
+    assert_equal 'no', post.toread
+    assert_equal 'test123', post.tags
+  end
+end

data/test/thumbtack/posts_test.rb

@@ -0,0 +1,178 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class PostsTest < Minitest::Test
+  def mock_client(url, params, response)
+    client = Minitest::Mock.new
+    client.expect(:get, response, [url, params].compact)
+    client
+  end
+
+  def test_update
+    client = mock_client('/posts/update',
+                         nil,
+                         { 'update_time' => '2014-06-26T19:01:33Z' })
+    posts = Posts.new(client)
+
+    assert_equal DateTime.new(2014, 6, 26, 19, 1, 33), posts.update
+    client.verify
+  end
+
+  def test_add
+    client = mock_client('/posts/add',
+                         { url: 'http://example.org',
+                           description: 'example.org' },
+                         { 'result_code' => 'done' })
+    posts = Posts.new(client)
+
+    assert_equal posts, posts.add('http://example.org', 'example.org')
+    client.verify
+  end
+
+  def test_add_with_tags
+    client = mock_client('/posts/add',
+                         { url: 'http://example.org',
+                           description: 'example.org',
+                           tags: 'thumbtack test' },
+                         { 'result_code' => 'done' })
+    posts = Posts.new(client)
+
+    assert_equal posts,
+      posts.add('http://example.org', 'example.org', tags: %w(thumbtack test))
+    client.verify
+  end
+
+  def test_delete
+    client = mock_client('/posts/delete',
+                         { url: 'http://example.org' },
+                         { 'result_code' => 'done' })
+    posts = Posts.new(client)
+
+    assert_equal posts, posts.delete('http://example.org')
+    client.verify
+  end
+
+  def test_get
+    client = mock_client('/posts/get',
+                         { url: 'http://example.org' },
+                         {
+                           'date' => '2014-06-29T16:57:45Z',
+                           'user' => 'nwjsmith',
+                           'posts' => [{
+                             'href' => 'http://example.org',
+                             'description' => 'example.org',
+                             'extended' => '',
+                             'meta' => '46ca40b9b92ee0ea1284785a5d2a9b38',
+                             'hash' => 'dab521de65f9250b4cca7383feef67dc',
+                             'time' => '2014-06-29T16:57:45Z',
+                             'shared' => 'yes',
+                             'toread' => 'no',
+                             'tags' => 'test123'
+                           }]
+                         })
+    posts = Posts.new(client)
+    response = posts.get(url: 'http://example.org')
+
+    assert_equal 1, response.size
+    assert_equal 'http://example.org', response.first.href
+    client.verify
+  end
+
+  def test_recent
+    client = mock_client('/posts/recent',
+                         {tag: 'webdev'},
+                         {
+                           'date' => '2014-06-29T16:57:45Z',
+                           'user' => 'nwjsmith',
+                           'posts' => [{
+                             'href' => 'http://example.org',
+                             'description' => 'example.org',
+                             'extended' => '',
+                             'meta' => '46ca40b9b92ee0ea1284785a5d2a9b38',
+                             'hash' => 'dab521de65f9250b4cca7383feef67dc',
+                             'time' => '2014-06-29T16:57:45Z',
+                             'shared' => 'yes',
+                             'toread' => 'no',
+                             'tags' => 'webdev'
+                           }]
+                         })
+    posts = Posts.new(client)
+    response = posts.recent(tag: 'webdev')
+
+    assert_equal 1, response.size
+    assert_equal 'http://example.org', response.first.href
+    client.verify
+  end
+
+  def test_all
+    client = mock_client('/posts/all',
+                         {tag: 'webdev'},
+                         [{
+                           'href' => 'http://example.org',
+                           'description' => 'example.org',
+                           'extended' => '',
+                           'meta' => '46ca40b9b92ee0ea1284785a5d2a9b38',
+                           'hash' => 'dab521de65f9250b4cca7383feef67dc',
+                           'time' => '2014-06-29T16:57:45Z',
+                           'shared' => 'yes',
+                           'toread' => 'no',
+                           'tags' => 'webdev'
+                         }])
+    posts = Posts.new(client)
+    response = posts.all(tag: 'webdev')
+
+    assert_equal 1, response.size
+    assert_equal 'http://example.org', response.first.href
+    client.verify
+  end
+
+  def test_suggest
+    client = mock_client('/posts/suggest',
+                         {url: 'http://blog.com'},
+                         {
+                           'popular' => ['blog', 'blogs', 'people', 'writing'],
+                           'recommended' => ['blog', 'writing', 'weblog']
+                         })
+    posts = Posts.new(client)
+    response = posts.suggest('http://blog.com')
+
+    assert_equal 2, response.size
+    assert_equal 'blog', response[:popular].first
+    assert_equal 'weblog', response[:recommended].last
+    client.verify
+  end
+
+  def test_dates
+    client = mock_client('/posts/dates',
+                         {tag: 'argentina'},
+                         {
+                           'user' => 'user',
+                           'tag' => 'argentina',
+                           'dates' => {
+                              '2010-11-29' => '5',
+                              '2010-11-28' => '15',
+                              '2010-11-26' => '2',
+                              '2010-11-25' => '2',
+                              '2010-11-23' => '7',
+                              '2010-11-22' => '20',
+                              '2010-11-21' => '16',
+                              '2010-11-19' => '4'
+                           }
+                         })
+    posts = Posts.new(client)
+    response = posts.dates(tag: 'argentina')
+
+    assert_equal({
+      Date.new(2010, 11, 29) => 5,
+      Date.new(2010, 11, 28) => 15,
+      Date.new(2010, 11, 26) => 2,
+      Date.new(2010, 11, 25) => 2,
+      Date.new(2010, 11, 23) => 7,
+      Date.new(2010, 11, 22) => 20,
+      Date.new(2010, 11, 21) => 16,
+      Date.new(2010, 11, 19) => 4
+    }, response)
+    client.verify
+  end
+end

data/test/thumbtack/specification_test.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class SpecificationTest < Minitest::Test
+  def test_parameters
+    type_handler = Minitest::Mock.new
+    type_handler.expect(:validate, type_handler, ['value'])
+    type_handler.expect(:to_parameter, 'parameterized', ['value'])
+
+    assert_equal({ key: 'parameterized' },
+      Specification.new(key: type_handler).parameters(key: 'value'))
+    type_handler.verify
+  end
+end