faraday-oauth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b9a49fa8f01cff86e6b4097fab5b43afb2bb3d56709d5c0576d1531992537f3
+  data.tar.gz: 94b53c2e46f65d21c9c57c584bed32f33ac86652c17ed19d7e6905cf0e2410fc
+SHA512:
+  metadata.gz: 4a1838d153d2553f2a51f6c93ee7130f890c43bdca22fe61ffe4baddced79f00d3a14b23d21d94109a88d2341a91bee29a209c737c7ba149ea9c68a4ea8d6bc7
+  data.tar.gz: 01f999083739df25dd2da66710fbfba77ed936195c1e9e1cb9a684288b3378ffc0a878a94aae0cb4687afdc91313a4ba648ab079339f90e2ef034fa26efbe3fd

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Instructure Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Faraday OAuth
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/instructure/faraday-oauth/ci)](https://github.com/instructure/faraday-oauth/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-oauth.svg?style=flat-square)](https://rubygems.org/gems/faraday-oauth)
+[![License](https://img.shields.io/github/license/instructure/faraday-oauth.svg?style=flat-square)](LICENSE.md)
+
+A Faraday middleware that adds an access token to each request.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-oauth'
+```
+
+## Usage and configuration
+
+You have to use the middleware in the Faraday instance that you want to.
+
+```ruby
+
+client = Faraday.new do |builder|
+  builder.use :oauth, {:consumer_key => consumer_key, :consumer_secret => consumer_secret, :body_hash => body_hash}
+
+  builder.adapter Faraday.default_adapter
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/oauth/middleware.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "simple_oauth"
+
+module Faraday
+  module OAuth
+    # Uses the simple_oauth library to sign requests according the
+    # OAuth protocol.
+    #
+    # The options for this middleware are forwarded to SimpleOAuth::Header:
+    # :consumer_key, :consumer_secret, :token, :token_secret. All these
+    # parameters are optional.
+    #
+    # The signature is added to the "Authorization" HTTP request header. If the
+    # value for this header already exists, it is not overriden.
+    #
+    # If no Content-Type header is specified, this middleware assumes that
+    # request body parameters should be included while signing the request.
+    # Otherwise, it only includes them if the Content-Type is
+    # "application/x-www-form-urlencoded", as per OAuth 1.0.
+    #
+    # For better performance while signing requests, this middleware should be
+    # positioned before UrlEncoded middleware on the stack, but after any other
+    # body-encoding middleware (such as EncodeJson).
+    class Middleware < Faraday::Middleware
+      AUTH_HEADER = "Authorization"
+      CONTENT_TYPE = "Content-Type"
+      TYPE_URLENCODED = "application/x-www-form-urlencoded"
+
+      extend Forwardable
+      def_delegator :"Faraday::Utils", :parse_nested_query
+
+      # @param env [Faraday::Env] the environment of the request being processed
+      def on_request(env)
+        env.request_headers[AUTH_HEADER] ||= oauth_header(env).to_s if sign_request?(env)
+      end
+
+      def oauth_header(env)
+        SimpleOAuth::Header.new(env.method,
+                                env.url.to_s,
+                                signature_params(body_params(env)),
+                                oauth_options(env))
+      end
+
+      def sign_request?(env)
+        !!env.request.fetch(:oauth, true)
+      end
+
+      def oauth_options(env)
+        if (extra = env.request[:oauth]) && extra.is_a?(Hash) && !extra.empty?
+          options.merge extra
+        else
+          options
+        end
+      end
+
+      def body_params(env)
+        if include_body_params?(env)
+          if env.request_body.respond_to?(:to_str)
+            parse_nested_query(env.request_body)
+          else
+            env.request_body
+          end
+        end || {}
+      end
+
+      def include_body_params?(env)
+        # see RFC 5849, section 3.4.1.3.1 for details
+        !(type = env.request_headers[CONTENT_TYPE]) || (type == TYPE_URLENCODED)
+      end
+
+      def signature_params(params)
+        if params.empty?
+          params
+        else
+          params.reject { |_k, v| v.respond_to?(:content_type) }
+        end
+      end
+    end
+  end
+end

data/lib/faraday/oauth/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module OAuth
+    VERSION = "0.1.0"
+  end
+end

data/lib/faraday/oauth.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "oauth/version"
+
+module Faraday
+  module OAuth
+    autoload :Middleware, "faraday/oauth/middleware"
+
+    Faraday::Request.register_middleware(oauth: -> { Faraday::OAuth::Middleware })
+  end
+end

data/lib/faraday-oauth.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "faraday/oauth"

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: faraday-oauth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-inst
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: |
+  Uses the simple_oauth library to sign requests according the
+  OAuth protocol.
+email:
+- cody@instructure.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday-oauth.rb
+- lib/faraday/oauth.rb
+- lib/faraday/oauth/middleware.rb
+- lib/faraday/oauth/version.rb
+homepage: https://github.com/instructure/faraday-oauth
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/instructure/faraday-oauth/issues
+  changelog_uri: https://github.com/instructure/faraday-oauth/blob/v0.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-oauth/0.1.0
+  homepage_uri: https://github.com/instructure/faraday-oauth
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/instructure/faraday-oauth
+  wiki_uri: https://github.com/instructure/faraday-oauth/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A Faraday middleware that adds an access token to each request.
+test_files: []