okay 9.0.0 → 12.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 771620de5d44a7098a96b5e95672a07582327108f8ebe18a0c7aadbfcaa6272e
-  data.tar.gz: 448f409cce2467dc0ecd9f3e940590c1620c69528fe011305848e3b63fe83c8f
+  metadata.gz: 8d00ba14dec86133bf583190685d2df4145dad9bcc741b9934a6f1deed7efdbc
+  data.tar.gz: 9f2997054914a1df28dbc968f3d0d7f950253b572dfbc9e7981d0c4847e61978
 SHA512:
-  metadata.gz: '0678fc09142e31bf1fcee8199fad6121fad65d55f3d6d09cc89e46e6be10f35beaa539534e8ef5be709ae89576825686922d455818f1cd19f2a33f5acf949c38'
-  data.tar.gz: e2c75f5898ffbb543a63bc407df09ccadd7e98ea7dc7dfe29f25f72bf0159ac7df5b54c07a60223ffbd11d2fd5c32491d4fc3fd28abbd537b93e5641b55d736c
+  metadata.gz: 2bc3352be68702f3dda8c9c214103c75bbd39b4def0592d0b5797c744e1b18f7bf9ae0975aa267cf4b7c49415536f3e23b55a9a76c99537995bc2af717be0d8a
+  data.tar.gz: 1460955b26d90c22373590a5a6573e5696c5ca8d023a1403f532b60729d48d14d44a1608bf4c761bff482d12c400b7bb9d64bc8c09d8b434c1aea4755f368b12

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/lib/okay/graphql.rb

@@ -17,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
@@ -36,6 +38,7 @@ 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.empty? || !kwargs.empty?
@@ -59,6 +62,7 @@ module Okay
 
         @query += "#{query_part}\n"
       end
+      # rubocop:enable Metrics/AbcSize
 
       def to_s
         @query

data/lib/okay/http.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "okay/version"
-require "openssl/better_defaults"
 require "net/https"
 require "cacert"
 
@@ -66,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?
@@ -78,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
@@ -86,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
@@ -95,7 +98,9 @@ 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.
@@ -127,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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Okay
-  VERSION = "9.0.0"
+  VERSION = "12.0.1"
 end

data/okay.gemspec

@@ -16,18 +16,25 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/duckinator/okay"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files -z`.split("\x0").select do |f|
+    f.match(%r{^(README.md|LICENSE.txt|okay.gemspec|lib)})
   end
   spec.bindir        = "exe"
   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", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop", "~> 0.49.1"
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: okay
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 12.0.1
 platform: ruby
 authors:
 - Ellen Marie Dash
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-02-02 00:00:00.000000000 Z
+date: 2021-09-12 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
@@ -80,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.1
 description: Okay, minimalist implementations of common utilities in Ruby. E.g., HTTP
   fetchers.
 email:
@@ -102,24 +74,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github_changelog_generator"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- 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
@@ -128,7 +89,7 @@ homepage: https://github.com/duckinator/okay
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +97,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: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.3.0.dev
+signing_key:
 specification_version: 4
 summary: Okay, minimalist implementations of common utilities.
 test_files: []

data/.github_changelog_generator

@@ -1,2 +0,0 @@
-user=how-is
-project=how_is

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.rubocop.yml

@@ -1,223 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
-  Exclude:
-    - 'okay.gemspec'
-    - 'bin/*'
-    - 'examples/*'
-    - '**/*~'
-    - 'spec/capture_warnings.rb'
-
-# Exceptions should inherit from StandardError.
-# (RuboCop default is to inherit from RuntimeError.)
-Lint/InheritException:
-  EnforcedStyle: standard_error
-
-Metrics/AbcSize:
-  Max: 17
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*_spec.rb'
-
-
-# Getting this back to the default of 100 would be nice,
-# but the few cases that exceed it don't seem overly concerning.
-Metrics/ClassLength:
-  Max: 120
-
-# Still try for 80, but we'll allow 110 because there's a not-insignificant
-# number of cases where we have long lines.
-#
-# It may be worth revisiting this in the future and refactoring those lines.
-Metrics/LineLength:
-  Max: 120
-  AllowHeredoc: true
-
-# Too short methods lead to extraction of single-use methods, which can make
-# the code easier to read (by naming things), but can also clutter the class
-Metrics/MethodLength:
-  Max: 25
-
-Metrics/ParameterLists:
-  Max: 6
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-# Most readable form.
-Layout/AlignHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
-  # Disable because it wound up conflicting with a lot of things like:
-  # foo('bar',
-  #   baz: 'asdf',
-  #   beep: 'boop')
-  #
-  # I suspect these'll disappear when overarching architectural issues are
-  # addressed.
-  Enabled: false
-
-Layout/AlignParameters:
-  # See Style/AlignedHash.
-  Enabled: false
-
-# This codebase may be English, but some English words contain diacritics.
-Style/AsciiComments:
-  Enabled: false
-
-# Despite the fact that some English words contain diacritics, we want all
-# method names to be writable by people who don't have an easy way to type
-# words with diacritics.
-Style/AsciiIdentifiers:
-  Enabled: true
-
-# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
-# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
-Style/BlockDelimiters:
-  Enabled: false
-
-# There's more nuance around this than RuboCop seems capable of.
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-# Don't force use of Time or Date; DateTime is okay.
-Style/DateTime:
-  Enabled: false
-
-# Unicode is good, mkay?
-Style/Encoding:
-  Enabled: true
-
-Style/RedundantSelf:
-  Enabled: false
-
-# Force Unix line endings.
-Layout/EndOfLine:
-  Enabled: true
-  EnforcedStyle: lf
-
-# A lot of the approaches I use for making things readable makes this angry.
-# E.g., formatting multiple consecutive assignments so that the equal signs
-# and values line up.
-#
-# foobar = 'blah'
-# baz    = 'asdf'
-# beep   = 'boop'
-Layout/ExtraSpacing:
-  Enabled: false
-
-#   # bad
-#
-#   format('%<greeting>s', greeting: 'Hello')
-#   format('%s', 'Hello')
-#
-#   # good
-#
-#   format('%{greeting}', greeting: 'Hello')
-Style/FormatStringToken:
-  EnforcedStyle: template
-
-# Freeze string literals to future-proof the code.
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  EnforcedStyle: always
-
-# Mixing hash styles just looks silly.
-# http://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
-Style/HashSyntax:
-  EnforcedStyle: no_mixed_keys
-
-Layout/IndentHash:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Layout/IndentArray:
-  Enabled: true
-  EnforcedStyle: consistent
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-# I deplore assignments in conditions and never want them in any codebase
-# I have direct control over.
-Style/ParenthesesAroundCondition:
-  AllowSafeAssignment: false
-Lint/AssignmentInCondition:
-  AllowSafeAssignment: false
-
-# Use [] for `%`-literal delimiters (e.g. for %q[]) that RuboCop doesn't define
-# anything for. (E.g., %q[].)
-#
-# The reason I prefer [] instead of () is that most of the time I use
-# `%`-literals is inside of function calls, and using () makes it blend in too
-# much.
-Style/PercentLiteralDelimiters:
-  Enabled: true
-  PreferredDelimiters:
-    default: "[]"
-    '%w': '[]'
-    '%W': '[]'
-
-# `has_key?` and `has_value?` are clearer than `key?` and `value?`.
-Style/PreferredHashMethods:
-  Enabled: true
-  EnforcedStyle: verbose
-
-# do / end blocks should be used for side effects,
-# methods that run a block for side effects and have
-# a useful return value are rare, assign the return
-# value to a local variable for those cases.
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-
-# Indent method calls relative to the receiver, e.g.:
-#   foo \
-#     .bar \
-#     .baz \
-#     .asdf
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented_relative_to_receiver
-
-# Indenting the chained dots beneath each other is not supported by this cop,
-# see https://github.com/bbatsov/rubocop/issues/1633
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
-# {'foo' => 'bar'} not { 'foo' => 'bar' }
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-  EnforcedStyle: no_space
-
-# I find "foo > 0" more readable than "foo.positive?" personally.
-Style/NumericPredicate:
-  Enabled: false
-
-# https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/RegexpLiteral
-Style/RegexpLiteral:
-  Enabled: false
-
-# Use double quotes everywhere by default.
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# Prefer [:foo, :bar] over %i[foo bar].
-Style/SymbolArray:
-  Enabled: true
-  EnforcedStyle: brackets
-
-# Prefer ["foo", "bar"] over %w[foo bar].
-Style/WordArray:
-  Enabled: true
-  EnforcedStyle: brackets
-
-# Require parentheses around complex ternary conditions.
-Style/TernaryParentheses:
-  Enabled: true
-  EnforcedStyle: require_parentheses_when_complex
-
-# Require a comma after the last item in an array or hash if each item is on
-# its own line.
-Style/TrailingCommaInLiteral:
-  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -1,25 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm:
-      - ruby-head
-
-before_install:
-  - gem install bundler
-
-# See https://bors.tech/documentation/getting-started/
-branches:
-  only:
-    # This is where pull requests from "bors r+" are built.
-    - staging
-    # This is where pull requests from "bors try" are built.
-    - trying
-    # Build pull requests.
-    - master

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at me@duckie.co. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in okay.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "okay"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/github-graphql-example.rb

@@ -1,11 +0,0 @@
-require "okay/graphql"
-
-query = Okay::GraphQL.query {
-  viewer {
-    login
-  }
-}
-
-headers = { bearer_token: ENV['DEMO_GITHUB_TOKEN'] }
-results = query.submit!(:github, headers).or_raise!
-puts results.from_json

data/examples/github-graphql-intentional-failure-example.rb

@@ -1,11 +0,0 @@
-require "okay/graphql"
-
-query = Okay::GraphQL.query {
-  viewer {
-    login
-  }
-}
-
-headers = { bearer_token: "oh no, invalid bearer token!" }
-results = query.submit!(:github, headers).or_raise!
-puts results.from_json