okay 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 821cdf5fa5035a799e732e2988fee9ec3666155a
-  data.tar.gz: dd1f9595882d529f39e18e6bb7205637b555c05d
+SHA256:
+  metadata.gz: 9995a83167cde5a2a18a0ae55c1db1492f4c6ee8642658879f0ab3ca8ed33ad3
+  data.tar.gz: 796de237563159535c7e8493b4cc1a41badcffd9b21888ff3faa3110f2842de1
 SHA512:
-  metadata.gz: df138d22cd54965b5c7e788a99a5c09d4b8952dc13026e0f6d3190529e503f50e34798e4c37f21b2976384dc6977b31bdb519d6d987ac2d910180cda102c0bfb
-  data.tar.gz: f5bde4d3e7b9863580717bdd3c5c892c88e518eae484a5892ae3fd61e778d06bd7fcb6d4bd50655a630e93fd97f83ce851aedfef672eab6bb18d0e9e2917d8ca
+  metadata.gz: a9ec2986376209d09718a1eb1583385595f4eb623022c6d05e801dd0c6de811f413dd62337b35a477d2718cdc415eeb092f6bdaba2633a90256865010712800f
+  data.tar.gz: ba34fcc968de9b609509510596e687e25bbdc339e1bcf64fc9c4b9b3c5a119704d123069967f2b1b0b6f99a5ad765c6084495af981ef21c98025b3a845a515e8

data/README.md

@@ -8,8 +8,7 @@ Goals:
 
 * Concise, but easy-to-understand code.
 * Be reasonably robust, but don't chase every potential edgecase. Handle
-  them as they come, and try to find a way to the code easy to
-  understand.
+  them as they come.
 * Well-documented codebase.
   * Document known limitations, not just features.
   * Document tests, not just the implementation.
@@ -23,17 +22,6 @@ or ask questions if you aren't sure it'll work for your usecase.
 If it doesn't, I may decide I want to add support for it, or be able to
 help you find something that works for you!
 
-## Utilities
-
-Currently implemented utilities:
-
-* HTTP fetcher.
-  * `GET` requests implemented.
-  * `POST` requests implemented.
-  * Other types of requests should be fairly easy to add, but haven't
-    been added.
-  * TLS is supported, using [`openssl/better_defaults`](https://github.com/duckinator/openssl-better_defaults/) to improve security on old Ruby versions.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -54,6 +42,11 @@ Or install it yourself as:
 
 ### HTTP
 
+* `GET` and `POST` requests supported.
+* TLS is supported, using [`openssl/better_defaults`](https://github.com/duckinator/openssl-better_defaults/) to improve security on old Ruby versions.
+* Does not handle HTTP 307 redirects correctly. (Because it changes it to a GET
+  request.)
+
 ```ruby
 require 'okay/http'
 

data/lib/okay/http.rb

@@ -11,16 +11,17 @@ class Okay
     #
     # @param url [String] The URL to request.
     # @param parameters [Hash] A hash representing a query string.
-    def self.get(url, parameters: {})
-      send_request(:Get, url, parameters, nil)
+    def self.get(url, parameters: {}, headers: {})
+      send_request(:Get, url, parameters, nil, headers)
     end
 
     # Make an HTTP POST request.
     #
     # @param url [String] The URL to request.
-    # @param data [String] Raw data to for the body of the POST request.
-    # @param form_data [Hash] Form data, treated as though.
-    def self.post(url, data: nil, form_data: nil)
+    # @param data [String] Raw data to for the body of the request.
+    # @param form_data [Hash] Data for the request body, encoded as though it
+    #   were a form.
+    def self.post(url, data: nil, form_data: nil, headers: {})
       if !data.nil? && !form_data.nil?
         raise ArgumentError, "cannot specify data and form_data arguments simultaneously."
       end
@@ -31,11 +32,19 @@ class Okay
         body = URI.encode_www_form(form_data)
       end
 
-      send_request(:Post, url, nil, body)
+      send_request(:Post, url, nil, body, headers)
     end
 
-    def self.send_request(http_method, url, parameters, body, limit = DEFAULT_REDIRECT_LIMIT)
-      if limit <= 0
+    # Helper method for actually creating a request.
+    #
+    # @param http_method [Symbol] A symbol representing the class name for
+    #   +Net::HTTP+. E.g., +:Get+ for GET requests, +:Post+ for POST, etc.
+    # @param url [String] URL for the request.
+    # @param parameters [Hash, nil] Request parameters (for the query string).
+    # @param body [String, nil] Request body.
+    # @param redirect_limit [Numeric] The maximum number of redirects allowed.
+    def self.send_request(http_method, url, parameters, body, headers, redirect_limit = DEFAULT_REDIRECT_LIMIT)
+      if redirect_limit <= 0
         raise RedirectLimitError, "request exceeded redirect limit"
       end
 
@@ -57,8 +66,13 @@ class Okay
         # E.g., if it's a post request, this returns Net::HTTP::Post.
         request_class = Net::HTTP.const_get(http_method)
 
-        # Create the request object, but don't send it yet.
+        # Create the request object, but don't send it.
         request  = request_class.new(uri)
+
+        headers.each do |k, v|
+          request[k] = v
+        end
+
         # Set the request body, if there is one.
         request.body = body unless body.nil?
 
@@ -66,24 +80,18 @@ class Okay
         response = http.request(request)
 
         # Handle responses.
-        case response
-        when Net::HTTPSuccess
-          # Request succeeded; return the result.
-          response
-        when Net::HTTPRedirection
+        if response.is_a?(Net::HTTPRedirection)
           # Follow a redirect.
-          # Decrements +limit+ while doing so, to avoid redirect loops.
-          #
-          # NOTE: This does not handle HTTP 307 correctly, as it always
-          #       changes to a GET request. https://httpstatuses.com/307
-          send_request(:Get, response['location'], parameters, body, limit - 1)
+          # Decrements +redirect_limit+ while doing so, to avoid redirect loops.
+          # NOTE: Does not handle HTTP 307. https://httpstatuses.com/307
+          send_request(:Get, response['location'], parameters, body, headers, redirect_limit - 1)
         else
-          # This seemingly-innocent method raises an exception if the request
-          # isn't successful.
-          response.value
+          response
         end
       end
     end
+
+    # Make +send_request+ a private method.
     private_class_method :send_request
   end
 end

data/lib/okay/version.rb

@@ -1,3 +1,3 @@
 module Okay
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okay
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-12 00:00:00.000000000 Z
+date: 2017-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl-better_defaults
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Okay, minimalist implementations of common utilities.