faraday-parse_dates 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 880d0728d7dd493a141efae67fd562e31295eac4db4fb192a509c3c46febfd9f
+  data.tar.gz: 8d4c2695d5b058133917a952943d086d616e914c71ca6a3e4c6e7eb063866dff
+SHA512:
+  metadata.gz: dce4b35fb6401563e9e8f6f71e61d09f1e511b72d2e10ed52759257a6b2212683ca9c18f91176aea0bff1a06a064849d63376f4d2f04f99ea9b3ad93dcadf15d
+  data.tar.gz: a13743848f39bef78a66efa1a680d78cb5044fc090c0ff3f4e491aa74932f58de1b40eefef4df5330d664fec440f664f1732cf90dca42f0524f08e0e7382de16

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+## Unreleased
+
+## 0.1.1 (2022-07-23)
+
+*   Enable `faraday.response :parse_dates`.
+*   Clarify the case about `faraday.use`.
+
+## 0.1.0 (2022-07-23)
+
+*   Initial release.

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Alexander Popov
+
+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,64 @@
+# Faraday Parse Dates
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/faraday-parse_dates?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/faraday-parse_dates)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/faraday-parse_dates/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/faraday-parse_dates)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/faraday-parse_dates.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/faraday-parse_dates)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/faraday-parse_dates?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/faraday-parse_dates)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/faraday-parse_dates.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/faraday-parse_dates)
+[![Gem](https://img.shields.io/gem/v/faraday-parse_dates.svg?style=flat-square)](https://rubygems.org/gems/faraday-parse_dates)
+[![License](https://img.shields.io/github/license/AlexWayfer/faraday-parse_dates.svg?style=flat-square)](LICENSE.md)
+
+Parse dates from response.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday-parse_dates'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install faraday-parse_dates
+```
+
+## Usage
+
+```ruby
+require 'faraday/parse_dates'
+
+connection = Faraday.new do |faraday|
+  ## This gem only decodes responses
+  faraday.response :parse_dates
+
+  ## Alternatively, you can use `use`
+  # faraday.use :parse_dates
+end
+```
+
+## 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 `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/faraday-parse_dates).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/faraday/parse_dates/middleware.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'time'
+
+module Faraday
+  module ParseDates
+    # This class provides the main implementation for your middleware.
+    # Your middleware can implement any of the following methods:
+    # * on_request - called when the request is being prepared
+    # * on_complete - called when the response is being processed
+    #
+    # Optionally, you can also override the following methods from Faraday::Middleware
+    # * initialize(app, options = {}) - the initializer method
+    # * call(env) - the main middleware invocation method.
+    #   This already calls on_request and on_complete, so you normally don't need to override it.
+    #   You may need to in case you need to "wrap" the request or need more control
+    #   (see "retry" middleware: https://github.com/lostisland/faraday/blob/main/lib/faraday/request/retry.rb#L142).
+    #   IMPORTANT: Remember to call `@app.call(env)` or `super` to not interrupt the middleware chain!
+    class Middleware < Faraday::Middleware
+      ISO_DATE_FORMAT = /\A\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|((\+|-)\d{2}:?\d{2}))\Z/xm.freeze
+
+      def initialize(app, options = {})
+        @regexp = options[:match] || ISO_DATE_FORMAT
+        super(app)
+      end
+
+      # This method will be called when the response is being processed.
+      # You can alter it as you like, accessing things like response_body, response_headers, and more.
+      # Refer to Faraday::Env for a list of accessible fields:
+      # https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb
+      #
+      # @param env [Faraday::Env] the environment of the response being processed.
+      def on_complete(env)
+        parse_dates! env[:body]
+      end
+
+      private
+
+      def parse_dates!(value)
+        case value
+        when Hash
+          value.each { |key, element| value[key] = parse_dates!(element) }
+        when Array
+          value.each_with_index { |element, index| value[index] = parse_dates!(element) }
+        when @regexp
+          Time.parse(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/faraday/parse_dates/version.rb

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

data/lib/faraday/parse_dates.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+require_relative 'parse_dates/middleware'
+require_relative 'parse_dates/version'
+
+module Faraday
+  # This will be your middleware main module, though the actual middleware implementation will go
+  # into Faraday::ParseDates::Middleware for the correct namespacing.
+  module ParseDates
+    # Faraday allows you to register your middleware for easier configuration.
+    # This step is totally optional, but it basically allows users to use a
+    # custom symbol (in this case, `:parse_dates`), to use your middleware in their connections.
+    # After calling this line, the following are both valid ways to set the middleware in a connection:
+    # * conn.use Faraday::ParseDates::Middleware
+    # * conn.use :parse_dates
+    # Without this line, only the former method is valid.
+    Faraday::Middleware.register_middleware(parse_dates: Faraday::ParseDates::Middleware)
+
+    # Alternatively, you can register your middleware under Faraday::Request or Faraday::Response.
+    # This will allow to load your middleware using the `request` or `response` methods respectively.
+    #
+    # Load middleware with conn.request :parse_dates
+    # Faraday::Request.register_middleware(parse_dates: Faraday::ParseDates::Middleware)
+    #
+    # Load middleware with conn.response :parse_dates
+    Faraday::Response.register_middleware(parse_dates: Faraday::ParseDates::Middleware)
+  end
+end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: faraday-parse_dates
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.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: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.32.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: 'Parse dates from response.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/faraday/parse_dates.rb
+- lib/faraday/parse_dates/middleware.rb
+- lib/faraday/parse_dates/version.rb
+homepage: https://github.com/AlexWayfer/faraday-parse_dates
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/AlexWayfer/faraday-parse_dates/issues
+  changelog_uri: https://github.com/AlexWayfer/faraday-parse_dates/blob/v0.1.1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-parse_dates/0.1.1
+  homepage_uri: https://github.com/AlexWayfer/faraday-parse_dates
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/AlexWayfer/faraday-parse_dates
+  wiki_uri: https://github.com/AlexWayfer/faraday-parse_dates/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
+    - !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: Parse dates from response.
+test_files: []