thumbtack 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 865dedec8bc24d93f1134a1a4b0515decd1ab4cb
-  data.tar.gz: 55d72d32a1a29eeee1578fb3736ba20f643f721d
+SHA256:
+  metadata.gz: fdeb8a886aee18bb6a5bebb004f07d96b8cca96e84169de995f115cc5ffdf933
+  data.tar.gz: 05a649480964bb21531aa85c47e6c0fd0b87707ef810961a92447982fec28bc0
 SHA512:
-  metadata.gz: 5eb64b30a1a0f11dc500e9e48017467f807026e6526278c046602424a65fdc1bbd419f634a46323b86994181d6d80de59fe91f67312f9717695bb1c12ce0288d
-  data.tar.gz: 4d9462b77cfe56905794db3e876c93bd20a487a4ed5d510de210f37c714a5efeea55c60bd12eb5fe6b1f75ca787075262965ca8afc4d6dd2c95d9dfcb27cfb63
+  metadata.gz: 39c4e82c954f3ea963582a0e8518b3b1c15b96ede42cd02e0a8aae535a65bfbc5c5183e0218a41aebd49667b399952e946d7bb06b98a4a2ba4e34b3f76f94d0f
+  data.tar.gz: 94c148bf9e8697116a442504e2b16965bf4a7163876d0f62ffd6031e36a07cb446073977feb478958eab2eb8979737c07bbcf43b296f911073fa2e4fba47a0b2

data/lib/thumbtack.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # A simple Pinboard API wrapper
 module Thumbtack
@@ -20,21 +20,21 @@ module Thumbtack
   EMPTY_ARRAY = [].freeze
 end
 
-require 'date'
 require 'json'
 require 'net/http'
+require 'time'
 require 'uri'
 
 require 'thumbtack/types/range_validation'
 require 'thumbtack/types/length_validation'
 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/time'
 require 'thumbtack/types/title'
 require 'thumbtack/types/url'
 require 'thumbtack/specification'

data/lib/thumbtack/adapters/basic_adapter.rb

@@ -1,17 +1,23 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   module Adapters
     # A basic adapter using Ruby's builtin HTTP and JSON parsing libraries
     class BasicAdapter
       # The status code for rate limited responses from the Pinboard API
-      TOO_MANY_REQUESTS_CODE = '429'.freeze
+      TOO_MANY_REQUESTS_CODE = '429'
 
       # The response format requested from the Pinboard API
-      RESPONSE_FORMAT = 'json'.freeze
+      RESPONSE_FORMAT = 'json'
 
       # The base Pinboard API URL.
-      BASE_URL = 'https://api.pinboard.in/v1'.freeze
+      BASE_URL = 'https://api.pinboard.in/v1'
+
+      # A secure version of SSL
+      SSL_VERSION = 'TLSv1_2'
+
+      # Secure cipher list
+      SSL_CIPHERS = 'TLSv1.2:!aNULL:!eNULL'
 
       # Initialize a BasicAdapter
       #
@@ -60,8 +66,27 @@ module Thumbtack
       # @api private
       # @raise [RateLimitError] if the response is rate-limited
       def http_response(uri)
-        Net::HTTP.get_response(uri).tap do |response|
-          fail RateLimitError if response.code == TOO_MANY_REQUESTS_CODE
+        request = Net::HTTP::Get.new(uri)
+        connection(uri.host, uri.port).request(request).tap do |response|
+          raise RateLimitError if response.code == TOO_MANY_REQUESTS_CODE
+        end
+      end
+
+      # Construct a secure HTTP connection to the Pinboard API
+      #
+      # @param [String] host
+      #   the Pinboard API host
+      # @param [Fixnum] port
+      #   the Pinboard API port
+      # @return [Net::HTTP]
+      #   the connection
+      #
+      # @api private
+      def connection(host, port)
+        Net::HTTP.new(host, port).tap do |connection|
+          connection.use_ssl = true
+          connection.ssl_version = SSL_VERSION
+          connection.ciphers = SSL_CIPHERS
         end
       end
 

data/lib/thumbtack/client.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Wraps each interaction with the Pinboard API
@@ -91,8 +91,9 @@ module Thumbtack
     def action(path, params)
       response = @adapter.get(path, params)
       unless response['result_code'] == 'done'
-        fail ResultError, response['result_code']
+        raise ResultError, response['result_code']
       end
+
       self
     end
 

data/lib/thumbtack/hash_to_digest.rb

@@ -1,12 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
-  # Handles renaming the hash attribute to digest from response hashes.
+  # Handles renaming the hash attribute to digest from response hashes. This is
+  # required in order to avoid collisions with the `Object#hash` method.
   #
   # @api private
   class HashToDigest
-    HASH = 'hash'.freeze
-    DIGEST = 'digest'.freeze
+    HASH = 'hash'
+    DIGEST = 'digest'
 
     # Rename any attribute called hash to digest
     #

data/lib/thumbtack/note.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Represents a note
@@ -8,14 +8,14 @@ module Thumbtack
     # The attributes for a Note
     #
     # @api private
-    ATTRIBUTES = [
-      :id,
-      :title,
-      :created_at,
-      :updated_at,
-      :digest,
-      :text,
-      :length
+    ATTRIBUTES = %i[
+      id
+      title
+      created_at
+      updated_at
+      digest
+      text
+      length
     ].freeze
 
     # The identifier for the note
@@ -41,25 +41,25 @@ module Thumbtack
     # The time at which the note was created
     #
     # @example
-    #   note.created_at  # => #<DateTime: 2014-08-13T19:53:16+00:00...
+    #   note.created_at  # => 2014-08-13 19:53:16 +0000
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     def created_at
-      Types::DateTime.deserialize_from_note(@created_at)
+      Types::Time.deserialize_from_note(@created_at)
     end
 
     # The time at which the note was last updated
     #
     # @example
-    #   note.updated_at  # => #<DateTime: 2014-08-13T19:53:16+00:00...
+    #   note.updated_at  # => 2014-08-13 19:53:16 +0000
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     def updated_at
-      Types::DateTime.deserialize_from_note(@updated_at)
+      Types::Time.deserialize_from_note(@updated_at)
     end
 
     # 20 character hexadecimal SHA1 hash of the note text

data/lib/thumbtack/note_summary.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Represents a note summary as returned from Notes#list.
@@ -9,13 +9,13 @@ module Thumbtack
     # The attributes for a NoteSummary
     #
     # @api private
-    ATTRIBUTES = [
-      :id,
-      :title,
-      :digest,
-      :created_at,
-      :updated_at,
-      :length
+    ATTRIBUTES = %i[
+      id
+      title
+      digest
+      created_at
+      updated_at
+      length
     ].freeze
 
     # The identifier for the note
@@ -41,25 +41,25 @@ module Thumbtack
     # The time at which the note was created
     #
     # @example
-    #   note.created_at  # => #<DateTime: 2014-08-13T19:53:16+00:00...
+    #   note.created_at  # => 2014-08-13 19:53:16 +0000
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     def created_at
-      Types::DateTime.deserialize_from_note(@created_at)
+      Types::Time.deserialize_from_note(@created_at)
     end
 
     # The time at which the note was last updated
     #
     # @example
-    #   note.updated_at  # => #<DateTime: 2014-08-13T19:53:16+00:00...
+    #   note.updated_at  # => 2014-08-13 19:53:16 +0000
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     def updated_at
-      Types::DateTime.deserialize_from_note(@updated_at)
+      Types::Time.deserialize_from_note(@updated_at)
     end
 
     # 20 character hexadecimal SHA1 hash of the note text

data/lib/thumbtack/notes.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Wraps API calls related to notes

data/lib/thumbtack/post.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Represents a bookmark
@@ -8,16 +8,16 @@ module Thumbtack
     # The attributes for a Post
     #
     # @api private
-    ATTRIBUTES = [
-      :href,
-      :description,
-      :extended,
-      :meta,
-      :digest,
-      :time,
-      :shared,
-      :toread,
-      :tags
+    ATTRIBUTES = %i[
+      href
+      description
+      extended
+      meta
+      digest
+      time
+      shared
+      toread
+      tags
     ].freeze
 
     # The url of the post
@@ -73,13 +73,13 @@ module Thumbtack
     # The time at which the post was created
     #
     # @example
-    #   post.time  # => #<DateTime: 2014-09-17T13:45:27+00:00...
+    #   post.time  # => 2014-08-13 19:53:16 +0000
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     def time
-      Types::DateTime.deserialize(@time)
+      Types::Time.deserialize(@time)
     end
 
     # If true, this post is public

data/lib/thumbtack/posts.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Wraps API calls related to posts
@@ -18,14 +18,14 @@ module Thumbtack
     # @example
     #   update_time = posts.update
     #
-    # @return [DateTime]
+    # @return [Time]
     #
     # @api public
     #
     # @see https://pinboard.in/api/#posts_update
     def update
       response = @client.get('/posts/update')
-      Types::DateTime.deserialize response.fetch('update_time')
+      Types::Time.deserialize response.fetch('update_time')
     end
 
     # Add a bookmark
@@ -43,7 +43,7 @@ module Thumbtack
     #   a description of the bookmark
     # @option options [Array[String]] :tags
     #   a list of up to 100 tags
-    # @option options [DateTime] :dt
+    # @option options [Time] :dt
     #   the creation time for this bookmark
     # @option options [Boolean] :replace
     #   if true, replace any existing bookmark with the same URL
@@ -63,7 +63,7 @@ module Thumbtack
         description: Types::Text,
         extended: Types::Text,
         tags: Types::Tags,
-        dt: Types::DateTime,
+        dt: Types::Time,
         replace: Types::Boolean,
         shared: Types::Boolean,
         toread: Types::Boolean
@@ -100,7 +100,7 @@ module Thumbtack
     #   options to filter the results by
     # @option options [Array<String>] :tag
     #   up to three tags to filter by
-    # @option options [DateTime] :dt
+    # @option options [Time] :dt
     #   which day the results were bookmarked
     # @option options [String] :url
     #   the URL for this bookmark
@@ -115,7 +115,7 @@ module Thumbtack
     def get(options = EMPTY_HASH)
       parameters = Specification.new(
         tag: Types::Tags,
-        dt: Types::DateTime,
+        dt: Types::Time,
         url: Types::URL,
         meta: Types::Boolean
       ).parameters(options)
@@ -160,9 +160,9 @@ module Thumbtack
     #   an offset value
     # @option options [Array<String>] :results
     #   number of results to return
-    # @option options [DateTime] :fromdt
+    # @option options [Time] :fromdt
     #   limit results to those created after this time
-    # @option options [DateTime] :todt
+    # @option options [Time] :todt
     #   limit results to those created before this time
     # @option options [Boolean] :meta
     #   if true, include the change detection signature in the results
@@ -177,8 +177,8 @@ module Thumbtack
         tag: Types::Tags,
         start: Types::Integer,
         results: Types::Integer,
-        fromdt: Types::DateTime,
-        todt: Types::DateTime,
+        fromdt: Types::Time,
+        todt: Types::Time,
         meta: Types::Boolean
       ).parameters(options)
       results = @client.get('/posts/all', parameters)

data/lib/thumbtack/specification.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Validates and translates user-provided parameters to their Pinboard

data/lib/thumbtack/suggestion.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Represents a suggestion
@@ -8,12 +8,12 @@ module Thumbtack
     # The key associated with popular tags
     #
     # @api private
-    POPULAR_KEY = 'popular'.freeze
+    POPULAR_KEY = 'popular'
 
     # The key associated with suggested tags
     #
     # @api private
-    RECOMMENDED_KEY = 'recommended'.freeze
+    RECOMMENDED_KEY = 'recommended'
 
     # A list of popular tags for URL
     #

data/lib/thumbtack/symbolize_keys.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Handles converting string keys to symbols in a response hash

data/lib/thumbtack/tags.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   # Wraps API calls related to tags

data/lib/thumbtack/types/boolean.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Thumbtack
   module Types
@@ -21,7 +21,7 @@ module Thumbtack
         when TrueClass, FalseClass
           self
         else
-          fail ValidationError, "#{value} must be true or false"
+          raise ValidationError, "#{value} must be true or false"
         end
       end