faraday-oauth1 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3702006a3f91e531f37e456f5c9d873d20b8f9b1fd1cd6a708f3aaec603058a7
+  data.tar.gz: b88fc3ab462f82dea5b06c6e02cca1195ce67c148e989d26d376c08df93b7679
+SHA512:
+  metadata.gz: abcdb0e1a65cf6872ec1e206b5625b4d82b833f0d2e43e881f07fcce59ccc1260292177e2bb9f36279827c3141dee8af1e08a1351b53aeba44dbc7f6b5205193
+  data.tar.gz: a0605dfb01f4b1c4e1dabd9a011632980d8cbe2ff7b2ccd4a99936d959c4eea820b2e65bedaffae332faa0ee4415a4413554c6c64ab129424269e1ff9539704d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [Unreleased](https://github.com/gemhome/faraday-oauth1/compare/v0.1.0...main)
+
+## [0.1.0](https://github.com/gemhome/faraday-oauth1/blob/v0.1.0) (2024-10-12)
+
+*   feat: Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Benjamin Fleischer
+
+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,73 @@
+# Faraday OAuth1
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gemhome/faraday-oauth1/ci)](https://github.com/gemhome/faraday-oauth1/actions?query=branch%3Amain)
+[![Gem](https://img.shields.io/gem/v/faraday-oauth1.svg?style=flat-square)](https://rubygems.org/gems/faraday-oauth1)
+[![License](https://img.shields.io/github/license/gemhome/faraday-oauth1.svg?style=flat-square)](LICENSE.md)
+
+Faraday OAuth1 Middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-oauth1'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-oauth1
+```
+
+## Usage
+
+```ruby
+require 'faraday'
+require 'faraday/oauth1'
+
+base_uri = "https://example.com"
+path = "/webservices/has-oauth1"
+headers = {}
+headers["Content-Type"] ||= "application/x-www-form-urlencoded"
+# see https://github.com/laserlemon/simple_oauth for credentials options
+credentials = {
+  consumer_key: consumer_key,
+  consumer_secret: consumer_secret,
+  access_token: nil,
+  access_token_secret: nil
+}.compact
+auth_type = "param"
+conn = Faraday.new(url: base_uri) do |builder|
+  builder.request :oauth1, auth_type, **credentials
+  builder.use Faraday::Response::RaiseError
+  builder.adapter Faraday.default_adapter
+  builder.headers.update(headers) if headers
+end
+response = conn.get(path)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `bin/test` to run the tests.
+
+To install this gem onto your local machine, run `rake build`.
+
+To release a new version, make a commit with a message such as "Bumped to 0.0.2" and then run `rake release`.
+See how it works [here](https://bundler.io/guides/creating_gem.html#releasing-the-gem).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/gemhome/faraday-oauth1).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/oauth1/request.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Copied from https://github.com/lostisland/faraday_middleware/blob/v1.2.0/lib/faraday_middleware/request/oauth.rb
+
+require 'forwardable'
+
+module Faraday
+  module OAuth1
+    # Public: Uses the simple_oauth library to sign requests according the
+    # OAuth 1 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 overridden.
+    #
+    # 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 Request < Middleware
+      require 'simple_oauth'
+
+      AUTH_HEADER = 'Authorization'
+      CONTENT_TYPE = 'Content-Type'
+      TYPE_URLENCODED = 'application/x-www-form-urlencoded'
+      DEFAULT_AUTH_METHOD = 'param'
+      AUTH_METHODS = [
+        DEFAULT_AUTH_METHOD,
+        'header'
+      ].tap(&:freeze)
+
+      extend Forwardable
+      def_delegators :'Faraday::Utils', :parse_nested_query, :parse_query, :build_query
+
+      attr_reader :auth_methods
+
+      def initialize(app = nil, auth_methods = nil, options = {})
+        super(app)
+        @auth_methods = Array(auth_methods || DEFAULT_AUTH_METHOD)
+        validate_auth_methods!
+        @options = options
+      end
+
+      def on_request(env)
+        if sign_request?(env)
+          header = oauth_header(env)
+          auth_methods.each do |auth_method|
+            case auth_method
+            when 'param', :param
+              params = {
+                'oauth_consumer_key' => header.signed_attributes.fetch(:oauth_consumer_key),
+                'oauth_signature_method' => header.signed_attributes.fetch(:oauth_signature_method),
+                'oauth_timestamp' => header.signed_attributes.fetch(:oauth_timestamp),
+                'oauth_nonce' => header.signed_attributes.fetch(:oauth_nonce),
+                'oauth_version' => header.signed_attributes.fetch(:oauth_version),
+                'oauth_signature' => header.signed_attributes.fetch(:oauth_signature)
+              }
+                       .merge(query_params(env[:url]))
+              env[:url].query = build_query(params)
+            when 'header', :header
+              env[:request_headers][AUTH_HEADER] ||= header.to_s
+            else
+              raise ArgumentError, "invalid auth method: #{auth_method} not in #{AUTH_METHODS.join(', ')}"
+            end
+          end
+        end
+      end
+
+      def validate_auth_methods!
+        invalid_auth_methods = auth_methods.map(&:to_s) - AUTH_METHODS
+        return if invalid_auth_methods.empty?
+
+        raise ArgumentError,
+              "invalid auth method(s): #{invalid_auth_methods.join(', ')} not in #{AUTH_METHODS.join(', ')}"
+      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
+      alias process_request? sign_request?
+
+      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[:body].respond_to?(:to_str)
+            parse_nested_query env[:body]
+          else
+            env[: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
+
+      def query_params(url)
+        if url.query.nil? || url.query.empty?
+          {}
+        else
+          parse_query url.query
+        end
+      end
+    end
+  end
+end

data/lib/faraday/oauth1/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Faraday
+  module OAuth1
+    VERSION = '0.1.1'
+  end
+end

data/lib/faraday/oauth1.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'oauth1/request'
+require_relative 'oauth1/version'
+
+module Faraday
+  # The Faraday::OAuth1 middleware main module
+  module OAuth1
+    # Load middleware with
+    #   conn.use Faraday::OAuth1::Request
+    #   or
+    #   conn.request :oauth1
+    Faraday::Request.register_middleware(oauth1: Faraday::OAuth1::Request)
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: faraday-oauth1
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Benjamin Fleischer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-12 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description: 'Faraday OAuth1 Middleware.
+
+  '
+email:
+- github@benjaminfleischer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/oauth1.rb
+- lib/faraday/oauth1/request.rb
+- lib/faraday/oauth1/version.rb
+homepage: https://github.com/gemhome/faraday-oauth1
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/gemhome/faraday-oauth1/issues
+  changelog_uri: https://github.com/gemhome/faraday-oauth1/blob/v0.1.1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-oauth1/0.1.1
+  homepage_uri: https://github.com/gemhome/faraday-oauth1
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/gemhome/faraday-oauth1
+  wiki_uri: https://github.com/gemhome/faraday-oauth1/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.7
+signing_key:
+specification_version: 4
+summary: Faraday OAuth1 Middleware
+test_files: []