okay 8.0.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 480936344226fb0983ee94c29f233d6a8b3c1c811e13f58430243b4d4cef27a7
-  data.tar.gz: bd70ea5928905aa0123f45d3edb46ab41cc811c5bc8076a73a975d0ab8e967a1
+  metadata.gz: d440392d2c9d86cd93c694b618d46f18935339c70897e5b6869a8b556ed17953
+  data.tar.gz: 63cb6c74cacfa7985707ae8bae9213b680ec5b097c184d588199ed7b7f5d6a21
 SHA512:
-  metadata.gz: a8c3331f360a7f716ed90c8d215c260e425a21c5ee29fec75dccc78180028459c6046f5c698a7e9310fc473cfa12b290112aaacf2a30caa313261af6f2745c9f
-  data.tar.gz: c3123c13c16a882d17d655ef928d415fb7531ed657884ce72af709d347a9ab20a5f3d4f3bcb1d6c00b53e363ac766c49a6f304a02d36109824e186674d3a4834
+  metadata.gz: f45cc9fe3188a53c2492459b1e4c614ab0d7400a0b891a5b1324304b0d34c5650e9a6f048c71427c770bc7205fd283f167e537244efd31df299454445ddfb477
+  data.tar.gz: e6d44d3186e410d8e9f95050534c4e1f13f7c86a53d6b0e4eb6197d0e3e053ba7184251166d21495b537b86bde07ea757fc37d0f246950f4027a734a103467c8

data/.cirrus.yml

@@ -0,0 +1,23 @@
+# Allow compute credits usage by collaborators and bors.
+use_compute_credits: $CIRRUS_USER_COLLABORATOR == 'true' || $CIRRUS_BRANCH == 'master' || $CIRRUS_BRANCH == 'staging' || $CIRRUS_BRANCH == 'trying'
+
+Linux_task:
+  container:
+    matrix:
+      - image: ruby:2.6-slim
+      - image: ruby:2.7-slim
+      - image: ruby:3.0-slim
+  install_script:
+    # git is installed since the gemspec uses it.
+    - apt-get update && apt-get install -y git
+    - gem install bundler
+    - bundle install
+  script:
+    - ruby --version
+    - bundle exec rake spec
+
+task:
+  name: CI Success
+  container: {image: "busybox"}
+  depends_on:
+    - Linux

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile

@@ -1,4 +1,15 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
+# Okay only supports Ruby versions under "normal maintenance".
+# This number should be updated when a Ruby version goes into security
+# maintenance.
+#
+# Ruby maintenance info: https://www.ruby-lang.org/en/downloads/branches/
+#
+# NOTE: Update how_is.gemspec when this is updated!
+ruby ">= 2.6"
+
 # Specify your gem's dependencies in okay.gemspec
 gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    okay (11.0.0)
+      cacert
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cacert (0.6.0)
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-freebsd-13
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  okay!
+  rake (~> 12.3)
+  rspec (~> 3.8)
+
+RUBY VERSION
+   ruby 3.0.1p64
+
+BUNDLED WITH
+   2.2.15

data/README.md

@@ -43,7 +43,7 @@ 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.
+* TLS is used automatically for HTTPS URLs.
 * Does not handle HTTP 307 redirects correctly. (Because it changes it to a GET
   request.)
 
@@ -108,6 +108,26 @@ response.body.from_json
 
 ```
 
+### Template Engine
+
+Okay also provides a basic templating engine.
+
+It is literally just a wrapper around `Kernel.format()` and `Pathname`.
+
+Assuming a `./templates/example.html` containing: `a %{foo} c %{bar} e`
+
+```ruby
+require "okay/template"
+
+template = Okay::Template.new("./templates/")
+template.apply("example.html", {foo: "b", bar: "d"}) #=> "a b c d e"
+```
+
+### SimpleOpts (OptionParser improvements)
+
+See the [example usage in
+HowIs](https://github.com/how-is/how_is/blob/ad81620/lib/how_is/cli.rb#L39-L74).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/httpbin

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+docker run -p 80:80 kennethreitz/httpbin

data/bors.toml

@@ -0,0 +1,5 @@
+status = ["CI Success"]
+
+# Uncomment this to use a two hour timeout.
+# The default is one hour.
+#timeout_sec = 7200

data/lib/okay.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 require "okay/version"
 
+##
+# A collection of classes/modules providing simple implementations of
+# useful things.
 module Okay
   # Your code goes here...
 end

data/lib/okay/default.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require "okay/version"
 
+# :nodoc:
 module Okay
+  # :nodoc:
   module DefaultValue
     def self.nil?
       true

data/lib/okay/graphql.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 require "okay/version"
 require "okay/http"
 require "json"
 
 module Okay
+  ##
+  # A simple GraphQL client.
+  #
   # Example usage:
   #
   #     require "okay/graphql"
@@ -12,7 +17,9 @@ module Okay
   #             login
   #         }
   #     }
-  #     response = request.submit!(:github, {bearer_token: ENV["DEMO_GITHUB_TOKEN"]})
+  #
+  #     token = ENV["DEMO_GITHUB_TOKEN"]
+  #     response = request.submit!(:github, {bearer_token: token})
   #     pp JSON.parse(response.body)
   class GraphQL
     Container = Struct.new(:value) do
@@ -21,6 +28,8 @@ module Okay
       end
     end
 
+    ##
+    # Implements the GraphQL DSL.
     class QueryDSL
       def initialize(indent = 0, &query)
         @query = ""
@@ -29,15 +38,16 @@ module Okay
         instance_exec(&query)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def method_missing(name, *args, **kwargs, &block)
         query_part = @indent_str + name.to_s
-        if args.length > 0 || kwargs.length > 0
+        if !args.empty? || !kwargs.empty?
           query_part += "("
 
           query_args = []
           query_args += args unless args.empty?
-          query_args += kwargs.map { |k,v|
-            [k,v.inspect].join(": ")
+          query_args += kwargs.map { |k, v|
+            [k, v.inspect].join(": ")
           }
           query_part += query_args.join(", ")
 
@@ -52,12 +62,15 @@ module Okay
 
         @query += "#{query_part}\n"
       end
+      # rubocop:enable Metrics/AbcSize
 
       def to_s
         @query
       end
     end
 
+    ##
+    # A class for submitting GraphQL queries.
     class Query
       def initialize(raw_query = nil, &query)
         @query = raw_query || QueryDSL.new(&query)
@@ -83,12 +96,13 @@ module Okay
         end
 
         data = {
-          "query" => to_s
+          "query" => to_s,
         }.to_json
         Okay::HTTP.post(url, headers: headers, data: data)
       end
 
-    private
+      private
+
       def default_github_headers(token)
         {
           "Accept" => "application/vnd.github.v4.idl",
@@ -103,6 +117,8 @@ module Okay
   end
 end
 
+# :nodoc:
+# rubocop:disable all
 class Object
   def self.const_missing(name)
     # HACK: if const_missing is called inside Okay::GraphQL#initialize,
@@ -122,3 +138,4 @@ class Object
     end
   end
 end
+# rubocop:enable all

data/lib/okay/http.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require "okay/version"
-require "openssl/better_defaults"
 require "net/https"
 require "cacert"
 
 Cacert.set_in_env
 
+# :nodoc:
 module Net
+  # :nodoc:
   class HTTPResponse
     # Returns false if the server encountered an error, true otherwise.
     def okay?
@@ -29,18 +32,18 @@ module Net
     #
     #     Okay::HTTP.get("https://example.org/blah.json").or_raise!.from_json
     def from_json
+      return nil unless okay?
+
       require "json"
 
-      if okay?
-        JSON.parse(body)
-      else
-        nil
-      end
+      JSON.parse(body)
     end
   end
 end
 
 module Okay
+  ##
+  # A wrapper around Net::HTTP, focused on ease of use and flexibility.
   module HTTP
     RedirectLimitError = Class.new(StandardError)
 
@@ -62,7 +65,8 @@ module Okay
     #   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."
+        raise ArgumentError,
+              "cannot specify data and form_data arguments simultaneously."
       end
 
       if form_data.nil?
@@ -74,6 +78,8 @@ module Okay
       send_request(:Post, url, nil, body, headers)
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     # Helper method for actually creating a request.
     #
     # @param http_method [Symbol] A symbol representing the class name for
@@ -82,7 +88,8 @@ module Okay
     # @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)
+    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
@@ -91,11 +98,13 @@ module Okay
       uri = URI.parse(url)
 
       # Set the query string for the request.
-      uri.query = URI.encode_www_form(parameters) unless parameters.nil?
+      unless parameters.nil? || parameters.empty?
+        uri.query = URI.encode_www_form(parameters)
+      end
 
       options = {
         # If the URI starts with "https://", enable SSL/TLS.
-        use_ssl: (uri.scheme == "https")
+        use_ssl: (uri.scheme == "https"),
       }
 
       # Net::HTTP.start() keeps a connection to the host alive
@@ -106,7 +115,7 @@ module Okay
         request_class = Net::HTTP.const_get(http_method)
 
         # Create the request object, but don't send it.
-        request  = request_class.new(uri)
+        request = request_class.new(uri)
 
         headers.each do |k, v|
           request[k] = v
@@ -123,13 +132,26 @@ module Okay
           # Follow a redirect.
           # 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)
+          new_url = response["location"]
+          if new_url.start_with?("/")
+            new_uri = uri.dup
+            new_uri.path = response["location"]
+            new_url = new_uri.to_s
+          elsif new_url.start_with?(".")
+            new_uri = uri.dup
+            new_uri.path += "/" + response["location"]
+            new_url = new_uri.to_s
+          end
+          send_request(:Get, new_url, parameters, body, headers,
+                       redirect_limit - 1)
         else
           response
         end
       end
     end
 
+    # rubocop:enable Metrics/AbcSize
+
     # Make +send_request+ a private method.
     private_class_method :send_request
   end

data/lib/okay/simple_opts.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "okay/version"
+require "optparse"
+
+module Okay
+  ##
+  # An OptionParser wrapper providing a few convenience functions.
+  class SimpleOpts < OptionParser
+    def initialize(*args, defaults: nil)
+      super(*args)
+      @okay_options = defaults || {}
+    end
+
+    # simple(..., :a)
+    # simple(..., :b)
+    #   ==
+    # options = {}
+    # on(...) { |val| options[:a] = val }
+    # on(...) { |val| options[:b] = val }
+    def simple(*args)
+      key = args.pop
+      on(*args) { |*x| @okay_options[key] = x[0] }
+    end
+
+    def parse(args)
+      parse!(args.dup)
+      @okay_options
+    end
+  end
+end

data/lib/okay/template.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "okay/version"
+require "okay/warning_helpers"
+require "pathname"
+
+module Okay
+  ##
+  # An extremely simple templating engine.
+  #
+  # General usage:
+  #
+  #     template = Okay::Template.new("./templates")
+  #     puts template.apply("some_template.html", {"some_key": "some value"})
+  #     template.directory #=> "./templates"
+  class Template
+    include WarningHelpers
+
+    attr_reader :directory
+
+    ##
+    # Create an Okay::Templates object.
+    #
+    # @param directory [String] Path of the directory containing the templates.
+    def initialize(directory)
+      @directory = directory
+    end
+
+    ##
+    # Apply the template referenced by +template_name+ to +data+.
+    #
+    # @param template_name [String] Name of the template to use,
+    #   relative to +@directory+ (as passed to +#initialize+).
+    # @param data [Hash] Data to apply the template to.
+    #
+    # @return [String] Result of applying the template to +data+.
+    def apply(template_name, data)
+      template_file = Pathname.new(@directory).join(template_name)
+      template = template_file.read
+
+      # Silence warnings while applying the template, since we don't
+      # generally care about unused keys.
+      silence_warnings { Kernel.format(template, data) }
+    end
+  end
+end

data/lib/okay/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Okay
-  VERSION = "8.0.0"
+  VERSION = "12.0.0"
 end

data/lib/okay/warning_helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "okay/version"
+
+module Okay
+  ##
+  # Helper functions for suppressing warnings when we know it's okay.
+  module WarningHelpers
+    def silence_warnings(&block)
+      with_warnings(nil, &block)
+    end
+
+    def with_warnings(flag, &_block)
+      old_verbose = $VERBOSE
+      $VERBOSE = flag
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end

data/okay.gemspec

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # coding: utf-8
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "okay/version"
@@ -21,11 +23,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "openssl-better_defaults"
+  # Okay only supports Ruby versions under "normal maintenance".
+  # This number should be updated when a Ruby version goes into security
+  # maintenance.
+  #
+  # Ruby maintenance info: https://www.ruby-lang.org/en/downloads/branches/
+  #
+  # NOTE: Update Gemfile when this is updated!
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_runtime_dependency "cacert"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: okay
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Ellen Marie Dash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: openssl-better_defaults
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: cacert
   requirement: !ruby/object:Gem::Requirement
@@ -44,56 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.8'
 description: Okay, minimalist implementations of common utilities in Ruby. E.g., HTTP
   fetchers.
 email:
@@ -102,29 +74,35 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".cirrus.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/httpbin
 - bin/setup
+- bors.toml
 - examples/github-graphql-example.rb
 - examples/github-graphql-intentional-failure-example.rb
 - lib/okay.rb
 - lib/okay/default.rb
 - lib/okay/graphql.rb
 - lib/okay/http.rb
+- lib/okay/simple_opts.rb
+- lib/okay/template.rb
 - lib/okay/version.rb
+- lib/okay/warning_helpers.rb
 - okay.gemspec
 homepage: https://github.com/duckinator/okay
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,16 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Okay, minimalist implementations of common utilities.
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.15.0