oauth 0.5.8 → 1.1.0

data/lib/oauth.rb

@@ -1,5 +1,8 @@
-root = File.dirname(__FILE__)
-$LOAD_PATH << root unless $LOAD_PATH.include?(root)
+# frozen_string_literal: true
+
+# third party gems
+require "snaky_hash"
+require "version_gem"
 
 require "oauth/version"
 
@@ -11,3 +14,7 @@ require "oauth/signature/hmac/sha1"
 require "oauth/signature/hmac/sha256"
 require "oauth/signature/rsa/sha1"
 require "oauth/request_proxy/mock_request"
+
+OAuth::Version.class_eval do
+  extend VersionGem::Basic
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oauth
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Pelle Braendgaard
@@ -16,36 +16,56 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-10 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: oauth-tty
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
+        version: 1.0.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
-  name: curb
+  name: snaky_hash
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: version_gem
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: em-http-request
   requirement: !ruby/object:Gem::Requirement
@@ -78,16 +98,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.15.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-lts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '18.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '18.0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -178,18 +212,17 @@ dependencies:
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: 3.14.0
+        version: 3.19.0
 description:
 email: oauth-ruby@googlegroups.com
-executables:
-- oauth
+executables: []
 extensions: []
 extra_rdoc_files:
 - TODO
@@ -201,15 +234,7 @@ files:
 - README.md
 - SECURITY.md
 - TODO
-- bin/oauth
 - lib/oauth.rb
-- lib/oauth/cli.rb
-- lib/oauth/cli/authorize_command.rb
-- lib/oauth/cli/base_command.rb
-- lib/oauth/cli/help_command.rb
-- lib/oauth/cli/query_command.rb
-- lib/oauth/cli/sign_command.rb
-- lib/oauth/cli/version_command.rb
 - lib/oauth/client.rb
 - lib/oauth/client/action_controller_request.rb
 - lib/oauth/client/em_http.rb
@@ -253,12 +278,39 @@ homepage: https://github.com/oauth-xx/oauth-ruby
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: https://github.com/oauth-xx/oauth-ruby/issues
-  changelog_uri: https://github.com/oauth-xx/oauth-ruby/blob/master/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/github/oauth-xx/oauth-ruby/master
   homepage_uri: https://github.com/oauth-xx/oauth-ruby
-  source_code_uri: https://github.com/oauth-xx/oauth-ruby
-post_install_message:
+  source_code_uri: https://github.com/oauth-xx/oauth-ruby/tree/v1.1.0
+  changelog_uri: https://github.com/oauth-xx/oauth-ruby/blob/v1.1.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/oauth-xx/oauth-ruby/issues
+  documentation_uri: https://www.rubydoc.info/gems/oauth/1.1.0
+  wiki_uri: https://github.com/oauth-xx/oauth-ruby/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: |2
+
+  You have installed oauth version 1.1.0, congratulations!
+
+  Non-commercial support for the 1.x series will end by April, 2025. Please make a plan to upgrade to the next version prior to that date.
+  The only breaking change will be dropped support for Ruby 2.7 and any other versions which will also have reached EOL by then.
+
+  Please see:
+  • https://github.com/oauth-xx/oauth-ruby/blob/main/SECURITY.md
+
+  Note also that I am, and this project is, in the process of leaving Github.
+  I wrote about some of the reasons here:
+  • https://dev.to/galtzo/im-leaving-github-50ba
+
+  If you are a human, please consider a donation as I move toward supporting myself with Open Source work:
+  • https://liberapay.com/pboling
+  • https://ko-fi.com/pboling
+  • https://patreon.com/galtzo
+
+  If you are a corporation, please consider supporting this project, and open source work generally, with a TideLift subscription.
+  • https://tidelift.com/funding/github/rubygems/oauth
+  • Or hire me. I am looking for a job!
+
+  Please report issues, and support the project!
+
+  Thanks, |7eter l-|. l3oling
 rdoc_options: []
 require_paths:
 - lib
@@ -266,14 +318,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
 summary: OAuth Core Ruby implementation

data/bin/oauth

@@ -1,11 +0,0 @@
-#!/usr/bin/env ruby
-
-require_relative "../lib/oauth"
-require "oauth/cli"
-
-Signal.trap("INT") { puts; exit(1) } # don't dump a backtrace on a ^C
-
-ARGV << "help" if ARGV.empty?
-command = ARGV.shift
-
-OAuth::CLI.new(STDOUT, STDIN, STDERR, command, ARGV).run

data/lib/oauth/cli/authorize_command.rb

@@ -1,71 +0,0 @@
-class OAuth::CLI
-  class AuthorizeCommand < BaseCommand
-
-    def required_options
-      [:uri]
-    end
-
-    def _run
-      request_token = get_request_token
-
-      if request_token.callback_confirmed?
-        puts "Server appears to support OAuth 1.0a; enabling support."
-        options[:version] = "1.0a"
-      end
-
-      puts "Please visit this url to authorize:"
-      puts request_token.authorize_url
-
-      # parameters for OAuth 1.0a
-      oauth_verifier = ask_user_for_verifier
-
-      verbosely_get_access_token(request_token, oauth_verifier)
-    end
-
-    def get_request_token
-      consumer = get_consumer
-      scope_options = options[:scope] ? { "scope" => options[:scope] } : {}
-      consumer.get_request_token({ :oauth_callback => options[:oauth_callback] }, scope_options)
-    rescue OAuth::Unauthorized => e
-      alert "A problem occurred while attempting to authorize:"
-      alert e
-      alert e.request.body
-    end
-
-    def get_consumer
-      OAuth::Consumer.new \
-        options[:oauth_consumer_key],
-        options[:oauth_consumer_secret],
-        :access_token_url  => options[:access_token_url],
-        :authorize_url     => options[:authorize_url],
-        :request_token_url => options[:request_token_url],
-        :scheme            => options[:scheme],
-        :http_method       => options[:method].to_s.downcase.to_sym
-    end
-
-
-    def ask_user_for_verifier
-      if options[:version] == "1.0a"
-        puts "Please enter the verification code provided by the SP (oauth_verifier):"
-        @stdin.gets.chomp
-      else
-        puts "Press return to continue..."
-        @stdin.gets
-        nil
-      end
-    end
-
-    def verbosely_get_access_token(request_token, oauth_verifier)
-      access_token = request_token.get_access_token(:oauth_verifier => oauth_verifier)
-
-      puts "Response:"
-      access_token.params.each do |k,v|
-        puts "  #{k}: #{v}" unless k.is_a?(Symbol)
-      end
-    rescue OAuth::Unauthorized => e
-      alert "A problem occurred while attempting to obtain an access token:"
-      alert e
-      alert e.request.body
-    end
-  end
-end

data/lib/oauth/cli/base_command.rb

@@ -1,208 +0,0 @@
-class OAuth::CLI
-  class BaseCommand
-    def initialize(stdout, stdin, stderr, arguments)
-      @stdout, @stdin, @stderr = stdout, stdin, stderr
-
-      @options = {}
-      option_parser.parse!(arguments)
-    end
-
-    def run
-      missing = required_options - options.keys
-      if missing.empty?
-        _run
-      else
-        show_missing(missing)
-        puts option_parser.help
-      end
-    end
-
-    def required_options
-      []
-    end
-
-    protected
-
-    attr_reader :options
-
-    def show_missing(array)
-      array = array.map { |s| "--#{s}" }.join(" ")
-      OAuth::CLI.puts_red "Options missing to OAuth CLI: #{array}"
-    end
-
-    def xmpp?
-      options[:xmpp]
-    end
-
-    def verbose?
-      options[:verbose]
-    end
-
-    def puts(string=nil)
-      @stdout.puts(string)
-    end
-
-    def alert(string=nil)
-      @stderr.puts(string)
-    end
-
-    def parameters
-      @parameters ||= begin
-        escaped_pairs = options[:params].collect do |pair|
-          if pair =~ /:/
-            Hash[*pair.split(":", 2)].collect do |k,v|
-              [CGI.escape(k.strip), CGI.escape(v.strip)] * "="
-            end
-          else
-            pair
-          end
-        end
-
-        querystring = escaped_pairs * "&"
-        cli_params = CGI.parse(querystring)
-
-        {
-          "oauth_consumer_key"     => options[:oauth_consumer_key],
-          "oauth_nonce"            => options[:oauth_nonce],
-          "oauth_timestamp"        => options[:oauth_timestamp],
-          "oauth_token"            => options[:oauth_token],
-          "oauth_signature_method" => options[:oauth_signature_method],
-          "oauth_version"          => options[:oauth_version]
-        }.reject { |_k,v| v.nil? || v == "" }.merge(cli_params)
-      end
-    end
-
-    def option_parser
-      @option_parser ||= OptionParser.new do |opts|
-        opts.banner = "Usage: oauth <command> [ARGS]"
-
-        _option_parser_defaults
-        _option_parser_common(opts)
-        _option_parser_sign_and_query(opts)
-        _option_parser_authorization(opts)
-      end
-    end
-
-    def _option_parser_defaults
-      options[:oauth_nonce] = OAuth::Helper.generate_key
-      options[:oauth_signature_method] = "HMAC-SHA1"
-      options[:oauth_timestamp] = OAuth::Helper.generate_timestamp
-      options[:oauth_version] = "1.0"
-      options[:method] = :post
-      options[:params] = []
-      options[:scheme] = :header
-      options[:version] = "1.0"
-    end
-
-    def _option_parser_common(opts)
-      ## Common Options
-
-      opts.on("-B", "--body", "Use the request body for OAuth parameters.") do
-        options[:scheme] = :body
-      end
-
-      opts.on("--consumer-key KEY", "Specifies the consumer key to use.") do |v|
-        options[:oauth_consumer_key] = v
-      end
-
-      opts.on("--consumer-secret SECRET", "Specifies the consumer secret to use.") do |v|
-        options[:oauth_consumer_secret] = v
-      end
-
-      opts.on("-H", "--header", "Use the 'Authorization' header for OAuth parameters (default).") do
-        options[:scheme] = :header
-      end
-
-      opts.on("-Q", "--query-string", "Use the query string for OAuth parameters.") do
-        options[:scheme] = :query_string
-      end
-
-      opts.on("-O", "--options FILE", "Read options from a file") do |v|
-        arguments = open(v).readlines.map { |l| l.chomp.split(" ") }.flatten
-        options2 = parse_options(arguments)
-        options.merge!(options2)
-      end
-    end
-
-    def _option_parser_sign_and_query(opts)
-      opts.separator("\n  options for signing and querying")
-
-      opts.on("--method METHOD", "Specifies the method (e.g. GET) to use when signing.") do |v|
-        options[:method] = v
-      end
-
-      opts.on("--nonce NONCE", "Specifies the nonce to use.") do |v|
-        options[:oauth_nonce] = v
-      end
-
-      opts.on("--parameters PARAMS", "Specifies the parameters to use when signing.") do |v|
-        options[:params] << v
-      end
-
-      opts.on("--signature-method METHOD", "Specifies the signature method to use; defaults to HMAC-SHA1.") do |v|
-        options[:oauth_signature_method] = v
-      end
-
-      opts.on("--token TOKEN", "Specifies the token to use.") do |v|
-        options[:oauth_token] = v
-      end
-
-      opts.on("--secret SECRET", "Specifies the token secret to use.") do |v|
-        options[:oauth_token_secret] = v
-      end
-
-      opts.on("--timestamp TIMESTAMP", "Specifies the timestamp to use.") do |v|
-        options[:oauth_timestamp] = v
-      end
-
-      opts.on("--realm REALM", "Specifies the realm to use.") do |v|
-        options[:realm] = v
-      end
-
-      opts.on("--uri URI", "Specifies the URI to use when signing.") do |v|
-        options[:uri] = v
-      end
-
-      opts.on("--version [VERSION]", "Specifies the OAuth version to use.") do |v|
-        options[:oauth_version] = v
-      end
-
-      opts.on("--no-version", "Omit oauth_version.") do
-        options[:oauth_version] = nil
-      end
-
-      opts.on("--xmpp", "Generate XMPP stanzas.") do
-        options[:xmpp] = true
-        options[:method] ||= "iq"
-      end
-
-      opts.on("-v", "--verbose", "Be verbose.") do
-        options[:verbose] = true
-      end
-    end
-
-    def _option_parser_authorization(opts)
-      opts.separator("\n  options for authorization")
-
-      opts.on("--access-token-url URL", "Specifies the access token URL.") do |v|
-        options[:access_token_url] = v
-      end
-
-      opts.on("--authorize-url URL", "Specifies the authorization URL.") do |v|
-        options[:authorize_url] = v
-      end
-
-      opts.on("--callback-url URL", "Specifies a callback URL.") do |v|
-        options[:oauth_callback] = v
-      end
-
-      opts.on("--request-token-url URL", "Specifies the request token URL.") do |v|
-        options[:request_token_url] = v
-      end
-
-      opts.on("--scope SCOPE", "Specifies the scope (Google-specific).") do |v|
-        options[:scope] = v
-      end
-    end
-  end
-end

data/lib/oauth/cli/help_command.rb

@@ -1,22 +0,0 @@
-class OAuth::CLI
-  class HelpCommand < BaseCommand
-    def run
-      puts <<-EOT
-  Usage: oauth COMMAND [ARGS]
-
-  Available oauth commands are:
-    a, authorize  Obtain an access token and secret for a user
-    q, query      Query a protected resource
-    s, sign       Generate an OAuth signature
-
-  In addition to those, there are:
-    v, version    Displays the current version of the library (or --version, -v)
-    h, help       Displays this help (or --help, -h)
-
-  Tip: All commands can be run without args for specific help.
-
-
-      EOT
-    end
-  end
-end

data/lib/oauth/cli/query_command.rb

@@ -1,25 +0,0 @@
-class OAuth::CLI
-  class QueryCommand < BaseCommand
-    extend OAuth::Helper
-
-    def required_options
-      [:oauth_consumer_key, :oauth_consumer_secret, :oauth_token, :oauth_token_secret]
-    end
-
-    def _run
-      consumer = OAuth::Consumer.new(options[:oauth_consumer_key], options[:oauth_consumer_secret], scheme: options[:scheme])
-
-      access_token = OAuth::AccessToken.new(consumer, options[:oauth_token], options[:oauth_token_secret])
-
-      # append params to the URL
-      uri = URI.parse(options[:uri])
-      params = parameters.map { |k,v| Array(v).map { |v2| "#{OAuth::Helper.escape(k)}=#{OAuth::Helper.escape(v2)}" } * "&" }
-      uri.query = [uri.query, *params].reject { |x| x.nil? } * "&"
-      puts uri.to_s
-
-      response = access_token.request(options[:method].to_s.downcase.to_sym, uri.to_s)
-      puts "#{response.code} #{response.message}"
-      puts response.body
-    end
-  end
-end

data/lib/oauth/cli/sign_command.rb

@@ -1,81 +0,0 @@
-class OAuth::CLI
-  class SignCommand < BaseCommand
-
-    def required_options
-      [:oauth_consumer_key, :oauth_consumer_secret, :oauth_token, :oauth_token_secret]
-    end
-
-    def _run
-      request = OAuth::RequestProxy.proxy \
-         "method"     => options[:method],
-         "uri"        => options[:uri],
-         "parameters" => parameters
-
-      if verbose?
-        puts_verbose_parameters(request)
-      end
-
-      request.sign! \
-        :consumer_secret => options[:oauth_consumer_secret],
-        :token_secret    => options[:oauth_token_secret]
-
-      if verbose?
-        puts_verbose_request(request)
-      else
-        puts request.oauth_signature
-      end
-    end
-
-    def puts_verbose_parameters(request)
-      puts "OAuth parameters:"
-      request.oauth_parameters.each do |k,v|
-        puts "  " + [k, v] * ": "
-      end
-      puts
-
-      if request.non_oauth_parameters.any?
-        puts "Parameters:"
-        request.non_oauth_parameters.each do |k,v|
-          puts "  " + [k, v] * ": "
-        end
-        puts
-      end
-    end
-
-    def puts_verbose_request(request)
-      puts "Method: #{request.method}"
-      puts "URI: #{request.uri}"
-      puts "Normalized params: #{request.normalized_parameters}" unless options[:xmpp]
-      puts "Signature base string: #{request.signature_base_string}"
-
-      if xmpp?
-        puts
-        puts "XMPP Stanza:"
-        puts xmpp_output(request)
-        puts
-        puts "Note: You may want to use bare JIDs in your URI."
-        puts
-      else
-        puts "OAuth Request URI: #{request.signed_uri}"
-        puts "Request URI: #{request.signed_uri(false)}"
-        puts "Authorization header: #{request.oauth_header(:realm => options[:realm])}"
-      end
-      puts "Signature:         #{request.oauth_signature}"
-      puts "Escaped signature: #{OAuth::Helper.escape(request.oauth_signature)}"
-    end
-
-    def xmpp_output(request)
-      <<-EOS
-  <oauth xmlns='urn:xmpp:oauth:0'>
-    <oauth_consumer_key>#{request.oauth_consumer_key}</oauth_consumer_key>
-    <oauth_token>#{request.oauth_token}</oauth_token>
-    <oauth_signature_method>#{request.oauth_signature_method}</oauth_signature_method>
-    <oauth_signature>#{request.oauth_signature}</oauth_signature>
-    <oauth_timestamp>#{request.oauth_timestamp}</oauth_timestamp>
-    <oauth_nonce>#{request.oauth_nonce}</oauth_nonce>
-    <oauth_version>#{request.oauth_version}</oauth_version>
-  </oauth>
-      EOS
-    end
-  end
-end

data/lib/oauth/cli/version_command.rb

@@ -1,7 +0,0 @@
-class OAuth::CLI
-  class VersionCommand < BaseCommand
-    def run
-      puts "OAuth Gem #{OAuth::VERSION}"
-    end
-  end
-end