thumbtack 1.0.0 → 1.1.0

data/lib/thumbtack/types/range_validation.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
+
 module Thumbtack
   module Types
     # Handles validation of values within a certain range
-    # Pinboard
     #
     # @api private
     class RangeValidation
@@ -15,15 +16,16 @@ module Thumbtack
       # @param [Range] range
       #   the range of valid values
       #
-      # @return [undefined]
+      # @return [self]
       #
       # @raise [Types::ValidationError]
-      #   if the value is not between 0001-01-01 and 2100-01-01
+      #   if the value is not within the range
       def self.validate(value, range)
         unless range.cover?(value)
           fail ValidationError,
                "#{value} must be between #{range.begin} and #{range.end}"
         end
+        self
       end
     end
   end

data/lib/thumbtack/types/tags.rb

@@ -19,13 +19,13 @@ module Thumbtack
       # @param [String, Array<String>] value
       #   a single tag or an array of many tags
       #
-      # @return [undefined]
+      # @return [self]
       #
       # @raise [Types::ValidationError]
-      #   if any tag contains commas or are longer than 255 characters
+      #   if any tags contain 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)
+          unless tag_valid?(tag)
             fail ValidationError,
                  "#{tag} cannot contain commas or be longer than 255 characters"
           end
@@ -53,6 +53,19 @@ module Thumbtack
       def self.from_parameter(parameter)
         parameter.split(SEPARATOR)
       end
+
+      # If true, the tag is valid
+      #
+      # @param [String] tag
+      #   a tag to validate
+      #
+      # @return [Boolean]
+      #
+      # @api private
+      def self.tag_valid?(tag)
+        tag.length < MAXIMUM_LENGTH && !tag.include?(INVALID_CHARACTER)
+      end
+      private_class_method :tag_valid?
     end
   end
 end

data/lib/thumbtack/types/text.rb

@@ -14,7 +14,7 @@ module Thumbtack
       # @param [String] value
       #   text to validate
       #
-      # @return [undefined]
+      # @return [self]
       #
       # @raise [Types::ValidationError]
       #   if the value is longer than 65536 characters

data/lib/thumbtack/types/title.rb

@@ -14,7 +14,7 @@ module Thumbtack
       # @param [String] value
       #   the title to validate
       #
-      # @return [undefined]
+      # @return [self]
       #
       # @raise [Types::ValidationError]
       #   if the value is longer than 255 characters

data/lib/thumbtack/types/url.rb

@@ -14,7 +14,7 @@ module Thumbtack
       # @param [String] value
       #   the URL to validate
       #
-      # @return [undefined]
+      # @return [self]
       #
       # @raise [Types::ValidationError]
       #   if the URL's scheme isn't one of http, https, javascript, mailto, ftp,

data/lib/thumbtack/version.rb

@@ -2,5 +2,5 @@
 
 module Thumbtack
   # Gem version
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/test/test_helper.rb

@@ -11,9 +11,9 @@ def mock_client_get(url, params, response)
   client
 end
 
-def mock_client_action(url, params, response)
+def mock_client_action(url, params)
   client = Minitest::Mock.new
-  client.expect(:action, response, [url, params].compact)
+  client.expect(:action, { 'result' => 'done' }, [url, params].compact)
   client
 end
 

data/test/thumbtack/client_test.rb

@@ -4,7 +4,8 @@ require 'test_helper'
 
 class ClientTest < Minitest::Test
   def setup
-    @client = Client.new(nil, nil)
+    @adapter = Minitest::Mock.new
+    @client = Client.new(nil, nil, adapter: @adapter)
   end
 
   def test_posts
@@ -22,4 +23,31 @@ class ClientTest < Minitest::Test
   def test_notes
     assert_instance_of Notes, @client.notes
   end
+
+  def test_default_adapter
+    assert_kind_of Adapters::BasicAdapter, Client.new(nil, nil).adapter
+  end
+
+  def test_get
+    @adapter.expect(:get,
+                    { 'posts' => [] },
+                    ['/posts/recent', { tag: 'thumbtack' }])
+    @client.get('/posts/recent', tag: 'thumbtack')
+    @adapter.verify
+  end
+
+  def test_action
+    @adapter.expect(:get, { 'result_code' => 'done' }, ['/posts/update', {}])
+    @client.action('/posts/update', {})
+    @adapter.verify
+  end
+
+  def test_action_result_error
+    assert_raises ResultError do
+      @adapter.expect(:get,
+                      { 'result_code' => 'notdone' },
+                      ['/posts/update', {}])
+      @client.action('/posts/update', {})
+    end
+  end
 end

data/test/thumbtack/integration/basic_adapter_test.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+module Integration
+  class BasicAdapterTest < Minitest::Test
+    def setup
+      path = File.expand_path('../../../auth_token.txt', __FILE__)
+      auth_token = File.open(path).read.strip
+      @username, @token = auth_token.split(':')
+      @adapter = Adapters::BasicAdapter.new(@username, @token)
+    end
+
+    def test_requests_return_parsed_json
+      response = @adapter.get('/user/api_token')
+      assert_equal({ 'result' => @token }, response)
+    end
+
+    def test_request_query_parameters
+      response = @adapter.get('/posts/recent', tag: 'thumbtack-test-xyz123')
+      assert_equal([], response['posts'])
+    end
+  end
+end

data/test/thumbtack/note_summary_test.rb

@@ -10,7 +10,7 @@ class NoteSummaryTest < Minitest::Test
       'hash' => '0c9c30f60cadabd31415',
       'created_at' => '2010-02-11 03:46:56',
       'updated_at' => '2010-02-11 03:47:47',
-      'length' => 19,
+      'length' => 19
     }
     note = NoteSummary.from_hash(hash)
 

data/test/thumbtack/notes_test.rb

@@ -4,29 +4,29 @@ require 'test_helper'
 
 class NotesTest < Minitest::Test
   def test_list
-    client = mock_client_get('/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',
-                             },
-                           ]
-                         })
+    client = mock_client_get(
+      '/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
 
@@ -36,17 +36,17 @@ class NotesTest < Minitest::Test
   end
 
   def test_get
-    client = mock_client_get('/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
-                         })
+    client = mock_client_get(
+      '/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

data/test/thumbtack/post_test.rb

@@ -25,6 +25,6 @@ class PostTest < Minitest::Test
     assert_equal DateTime.new(2014, 6, 29, 16, 57, 45), post.time
     assert_equal true, post.shared
     assert_equal false, post.toread
-    assert_equal ['test123', 'another'], post.tags
+    assert_equal %w(test123 another), post.tags
   end
 end

data/test/thumbtack/posts_test.rb

@@ -4,9 +4,11 @@ require 'test_helper'
 
 class PostsTest < Minitest::Test
   def test_update
-    client = mock_client_get('/posts/update',
-                         nil,
-                         { 'update_time' => '2014-06-26T19:01:33Z' })
+    client = mock_client_get(
+      '/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
@@ -14,10 +16,11 @@ class PostsTest < Minitest::Test
   end
 
   def test_add
-    client = mock_client_action('/posts/add',
-                         { url: 'http://example.org',
-                           description: 'example.org' },
-                         { 'result_code' => 'done' })
+    client = mock_client_action(
+      '/posts/add',
+      url: 'http://example.org',
+      description: 'example.org'
+    )
     posts = Posts.new(client)
 
     assert_equal posts, posts.add('http://example.org', 'example.org')
@@ -25,22 +28,28 @@ class PostsTest < Minitest::Test
   end
 
   def test_add_with_tags
-    client = mock_client_action('/posts/add',
-                         { url: 'http://example.org',
-                           description: 'example.org',
-                           tags: 'thumbtack test' },
-                         { 'result_code' => 'done' })
+    client = mock_client_action(
+      '/posts/add',
+      url: 'http://example.org',
+      description: 'example.org',
+      tags: 'thumbtack test'
+    )
     posts = Posts.new(client)
 
     assert_equal posts,
-      posts.add('http://example.org', 'example.org', tags: %w(thumbtack test))
+                 posts.add(
+                   'http://example.org',
+                   'example.org',
+                   tags: %w(thumbtack test)
+                 )
     client.verify
   end
 
   def test_delete
-    client = mock_client_action('/posts/delete',
-                         { url: 'http://example.org' },
-                         { 'result_code' => 'done' })
+    client = mock_client_action(
+      '/posts/delete',
+      url: 'http://example.org'
+    )
     posts = Posts.new(client)
 
     assert_equal posts, posts.delete('http://example.org')
@@ -48,23 +57,23 @@ class PostsTest < Minitest::Test
   end
 
   def test_get
-    client = mock_client_get('/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'
-                           }]
-                         })
+    client = mock_client_get(
+      '/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')
 
@@ -74,23 +83,23 @@ class PostsTest < Minitest::Test
   end
 
   def test_recent
-    client = mock_client_get('/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'
-                           }]
-                         })
+    client = mock_client_get(
+      '/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')
 
@@ -100,19 +109,23 @@ class PostsTest < Minitest::Test
   end
 
   def test_all
-    client = mock_client_get('/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'
-                         }])
+    client = mock_client_get(
+      '/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')
 
@@ -122,12 +135,14 @@ class PostsTest < Minitest::Test
   end
 
   def test_suggest
-    client = mock_client_get('/posts/suggest',
-                         {url: 'http://blog.com'},
-                         [
-                           { 'popular' => ['blog', 'blogs', 'people'] },
-                           { 'recommended' => ['blog', 'writing', 'weblog'] }
-                         ])
+    client = mock_client_get(
+      '/posts/suggest',
+      { url: 'http://blog.com' },
+      [
+        { 'popular' => %w(blog blogs people) },
+        { 'recommended' => %w(blog writing weblog) }
+      ]
+    )
     posts = Posts.new(client)
     response = posts.suggest('http://blog.com')
 
@@ -137,35 +152,38 @@ class PostsTest < Minitest::Test
   end
 
   def test_dates
-    client = mock_client_get('/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'
-                           }
-                         })
+    client = mock_client_get(
+      '/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)
+    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