thumbtack 0.0.2 → 0.0.3

data/lib/thumbtack/user.rb

@@ -1,21 +1,42 @@
 # encoding: utf-8
 
 module Thumbtack
-  # Internal: Wraps API calls related to users.
+  # Wraps API calls related to users
   class User
-    # Internal: Creates a new User.
+    # Initialize a User
     #
-    # client - a Thumbtack::Client to communicate with the Pinboard API.
+    # @param [Client] client
+    #   client to communicate with the Pinboard API
+    #
+    # @api private
     def initialize(client)
       @client = client
     end
 
-    # Public: Returns the user's secret RSS key for viewing private feeds.
+    # Fetch the secret RSS key for viewing private feeds
+    #
+    # @example
+    #   rss_key = user.secret
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    # @see https://pinboard.in/api/#user_secret
     def secret
       @client.get('/user/secret').fetch('result')
     end
 
-    # Public: Returns the user's API token for making calls without a password.
+    # Fetch the API token for making calls without a password
+    #
+    # @example
+    #   api_token = user.api_token
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    # @see https://pinboard.in/api/#user_api_token
     def api_token
       @client.get('/user/api_token').fetch('result')
     end

data/lib/thumbtack/version.rb

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

data/test/test_helper.rb

@@ -5,16 +5,10 @@ CodeClimate::TestReporter.start
 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
+def mock_client(url, params, response)
+  client = Minitest::Mock.new
+  client.expect(:get, response, [url, params].compact)
+  client
 end
 
 include Thumbtack

data/test/thumbtack/client_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 class ClientTest < Minitest::Test
   def setup
-    @client = Client.new(username, token)
+    @client = Client.new(nil, nil)
   end
 
   def test_posts

data/test/thumbtack/integration/client_test.rb

@@ -5,12 +5,15 @@ require 'test_helper'
 module Integration
   class ClientTest < Minitest::Test
     def setup
-      @client = Client.new(username, token)
+      path = File.expand_path('../../../auth_token.txt', __FILE__)
+      auth_token = File.open(path).read.strip
+      @username, @token = auth_token.split(':')
+      @client = Client.new(@username, @token)
     end
 
     def test_requests_return_parsed_json
       response = @client.get('/user/api_token')
-      assert_equal({ 'result' => token }, response)
+      assert_equal({ 'result' => @token }, response)
     end
 
     def test_request_query_parameters

data/test/thumbtack/note_summary_test.rb

@@ -16,7 +16,7 @@ class NoteSummaryTest < Minitest::Test
 
     assert_equal '8e5d6964bb810e0050b0', note.id
     assert_equal 'StarCraft beta coming this week!', note.title
-    assert_equal '0c9c30f60cadabd31415', note.hash
+    assert_equal '0c9c30f60cadabd31415', note.digest
     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

data/test/thumbtack/notes_test.rb

@@ -3,12 +3,6 @@
 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,
@@ -41,7 +35,7 @@ class NotesTest < Minitest::Test
     assert_equal '8e5d6964bb810e0050b0', result[1].id
   end
 
-  def test_list
+  def test_get
     client = mock_client('/notes/8e5d6964bb810e0050b0',
                          nil,
                          {

data/test/thumbtack/posts_test.rb

@@ -3,12 +3,6 @@
 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,
@@ -130,16 +124,15 @@ class PostsTest < Minitest::Test
   def test_suggest
     client = mock_client('/posts/suggest',
                          {url: 'http://blog.com'},
-                         {
-                           'popular' => ['blog', 'blogs', 'people', 'writing'],
-                           'recommended' => ['blog', 'writing', 'weblog']
-                         })
+                         [
+                           { 'popular' => ['blog', 'blogs', 'people'] },
+                           { '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
+    assert_equal 'blog', response.popular.first
+    assert_equal 'weblog', response.recommended.last
     client.verify
   end
 

data/test/thumbtack/suggestion_test.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'test_helper'
+
+class NoteSummaryTest < Minitest::Test
+  def test_from_array
+    array = [
+      { 'popular' => ['ifttt'] },
+      { 'recommended' => ['ifttt', 'twitter'] }
+    ]
+    suggestion = Suggestion.from_array(array)
+
+    assert_equal ['ifttt'], suggestion.popular
+    assert_equal ['ifttt', 'twitter'], suggestion.recommended
+  end
+end

data/test/thumbtack/tags_test.rb

@@ -3,12 +3,6 @@
 require 'test_helper'
 
 class TagsTest < 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('/tags/get',
                          nil,

data/test/thumbtack/user_test.rb

@@ -3,12 +3,6 @@
 require 'test_helper'
 
 class UserTest < Minitest::Test
-  def mock_client(url, params, response)
-    client = Minitest::Mock.new
-    client.expect(:get, response, [url, params].compact)
-    client
-  end
-
   def test_secret
     client = mock_client('/user/secret',
                          nil,

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: thumbtack
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nate Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,20 +53,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 10.3.2
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
-description: Thumbtack is a simple wrapper for the Pinboard API
+        version: 0.8.7.4
+description: Thumbtack is a simple client for the Pinboard API
 email:
 - nwjsmith@gmail.com
 executables: []
@@ -81,6 +81,7 @@ files:
 - lib/thumbtack/post.rb
 - lib/thumbtack/posts.rb
 - lib/thumbtack/specification.rb
+- lib/thumbtack/suggestion.rb
 - lib/thumbtack/tags.rb
 - lib/thumbtack/types.rb
 - lib/thumbtack/types/boolean.rb
@@ -104,6 +105,7 @@ files:
 - test/thumbtack/post_test.rb
 - test/thumbtack/posts_test.rb
 - test/thumbtack/specification_test.rb
+- test/thumbtack/suggestion_test.rb
 - test/thumbtack/tags_test.rb
 - test/thumbtack/types/boolean_test.rb
 - test/thumbtack/types/date_test.rb
@@ -128,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -150,6 +152,7 @@ test_files:
 - test/thumbtack/post_test.rb
 - test/thumbtack/posts_test.rb
 - test/thumbtack/specification_test.rb
+- test/thumbtack/suggestion_test.rb
 - test/thumbtack/tags_test.rb
 - test/thumbtack/types/boolean_test.rb
 - test/thumbtack/types/date_test.rb
@@ -162,3 +165,4 @@ test_files:
 - test/thumbtack/types/title_test.rb
 - test/thumbtack/types/url_test.rb
 - test/thumbtack/user_test.rb
+has_rdoc: