eol_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 491894da6db5634007466ed6a22c12157eec58696fe5c2dac6504b76ed29908b
+  data.tar.gz: a305819c3871d10e5cdbd8acf629579e617f802bf08dd6d0c03b56d2575ddc9f
+SHA512:
+  metadata.gz: 5336fb2ff4381e04be59332b7bd3bb8858b38eef543e2f333d7671b7ae70a77a4bfd88228516421353819738c1b8180ba0781c26f5b71e129f32a1079f83b579
+  data.tar.gz: 01abf889f63ba25756b6fc219776f98f1f01db862fcb0dc1c72394f046cd2dfc89afad77f7b0cb66f48ead201a9eb95b843f085d9630db1fbb571aadce38af8b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-11-23
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Coolomina
+
+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,55 @@
+# endoflife.date ruby gem
+
+`eol_rb` is an endoflife.date Ruby wrapper built on top of Faraday. 
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add eol_rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install eol_rb
+
+## Usage
+
+```ruby
+require 'eol_rb'
+
+# Optional configuration
+EOL.configure do |config|
+  config.timeout = 1
+  config.open_timeout = 1
+end
+
+EOL.products
+# => ["almalinux", "alpine", "amazon-eks", ...
+
+EOL.of('ruby')
+# => 
+# [{"cycle"=>"3.1", "eol"=>"2025-12-25", "latest"=>"3.1.2", "latestReleaseDate"=>"2022-04-12", "releaseDate"=>"2021-12-25"},
+#  {"cycle"=>"3.0", "eol"=>"2024-03-31", "latest"=>"3.0.4", "latestReleaseDate"=>"2022-04-12", "releaseDate"=>"2020-12-25"},
+# ...
+
+EOL.of('ruby', cycle: '3.1')
+# => {"eol"=>"2025-12-25", "latest"=>"3.1.2", "latestReleaseDate"=>"2022-04-12", "releaseDate"=>"2021-12-25"}
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eol_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/eol_rb/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the EolRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/eol_rb/blob/master/CODE_OF_CONDUCT.md).

data/lib/eol_rb/client.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "uri"
+require "json"
+
+module EOL
+  # HTTP client for endoflife.date API
+  class Client
+    def initialize
+      @http = Faraday.new(
+        url: "#{api.scheme}://#{api.host}",
+        headers: {
+          "Content-Type" => "application/json",
+          "User-Agent" => "endoflife.date Ruby Gem v#{EOL::VERSION}"
+        }
+      )
+    end
+
+    def get(endpoint)
+      @http.get("#{api.path}/#{endpoint}")
+    end
+
+    private
+
+    EOL_DATE_API_BASE_URL = "https://endoflife.date/api"
+
+    def api
+      URI(EOL_DATE_API_BASE_URL)
+    end
+
+    def open_timeout
+      EOL.configuration.open_timeout || 10
+    end
+
+    def timeout
+      EOL.configuration.timeout || 10
+    end
+  end
+end

data/lib/eol_rb/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module EOL
+  # Configuration class for EndOfLife HTTP client
+  class Configuration
+    SETTINGS = %i[timeout open_timeout].freeze
+    attr_accessor(*SETTINGS)
+
+    def reset!
+      SETTINGS.each { |s| instance_variable_set(:"@#{s}", nil) }
+    end
+  end
+end

data/lib/eol_rb/cycle.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module EOL
+  class Client
+    # Class for retrieving information about Cycles
+    class Cycle
+      class NotFoundError < StandardError; end
+
+      class << self
+        def get(client, product, cycle)
+          res = client.get("/#{product}/#{cycle}.json")
+          raise NotFoundError, "Cycle #{cycle} could not be found under product #{product}" if res.status == 404
+
+          res
+        end
+      end
+    end
+  end
+end

data/lib/eol_rb/product.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module EOL
+  class Client
+    # Class for retrieving information about Products
+    class Product
+      class NotFoundError < StandardError; end
+
+      class << self
+        def all(client)
+          client.get("/all.json")
+        end
+
+        def get(client, product)
+          res = client.get("/#{product}.json")
+          raise NotFoundError, "Product #{product} could not be found in the API" if res.status == 404
+
+          res
+        end
+      end
+    end
+  end
+end

data/lib/eol_rb/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EOL
+  VERSION = "0.1.0"
+end

data/lib/eol_rb.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "eol_rb/client"
+require_relative "eol_rb/configuration"
+require_relative "eol_rb/product"
+require_relative "eol_rb/cycle"
+
+# Root module for EndOfLife
+module EOL
+  class << self
+    extend Forwardable
+
+    def_delegators :new, :of, :products
+
+    def new
+      Instance.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  # Instance of EOL HTTP client
+  class Instance
+    def initialize
+      @client = Client.new
+    end
+
+    def products
+      res = Client::Product.all(@client)
+
+      JSON.parse(res.body)
+    end
+
+    def of(product, cycle: "")
+      res = if cycle.empty?
+              Client::Product.get(@client, product)
+            else
+              Client::Cycle.get(@client, product, cycle)
+            end
+
+      JSON.parse(res.body)
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: eol_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alejandro Colomina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+description: Ruby client for endoflife.date API
+email:
+- ale@coolomina.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/eol_rb.rb
+- lib/eol_rb/client.rb
+- lib/eol_rb/configuration.rb
+- lib/eol_rb/cycle.rb
+- lib/eol_rb/product.rb
+- lib/eol_rb/version.rb
+homepage: https://github.com/Coolomina/eol-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Coolomina/eol-rb
+  source_code_uri: https://github.com/Coolomina/eol-rb
+  bug_tracker_uri: https://github.com/Coolomina/eol-rb/issues
+  changelog_uri: https://github.com/Coolomina/eol-rb/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the endoflife.date API
+test_files: []