metal_archives 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3de990935b078060383b45f512b4c154a67714366af214c524925040fb95cb7b
-  data.tar.gz: ff36ec2f5b1e5ab7bbe4c2e4593246d02f2bc780253bb9f247b5912fda8ef397
+  metadata.gz: cc72b807bbb20dcb70cfc38a6808b1088a3c5a187a6b033f82ef0083e5ff7794
+  data.tar.gz: b2424b28220556afc3c777efcd38e10f9b03d92d58905130e53723a0f5e5691c
 SHA512:
-  metadata.gz: 1e4ceef2436f5d44f56979a9e0ecd399e5ddd61aea837e66e38cd48938ae71ccba32ed182b56bf75e8cbce29ee458443a97174b4fb93af808a0c42450868b9e1
-  data.tar.gz: 75596c0feb38577c65a2e64279415a1c8510bb97b1cbb7cf722dd2ac7973e4050e65dfd1238b198519e4696a249ae12de121af7927243f1092cf6331e0dd566b
+  metadata.gz: 5d80a6bf547b425d5d85c1b789e62a9224cf77e06911e8e8e45f298041778e2b9e976e754fc1a6f43a939e2e5b5cabf581f7b43b8677d8d48f4023a11df516fb
+  data.tar.gz: 2911d68d5725d92def587f482cc01235c280e7989b1903cac2374632136e667f988384141ffbb2ae9c69bae95a555c7f7cac50e96e12af273e562bc372bb141c

data/.github/workflows/ci.yml

@@ -1,32 +1,44 @@
-name: CI
+name: Continuous Integration
 
 on:
   push:
-    tags-ignore:
-      - '*'
     branches:
       - '*'
+    tags:
+      - '*'
+  schedule:
+    - cron: '0 7 * * 1'
 
 jobs:
   build:
     name: Continuous Integration
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby: [ "2.6", "2.7", "3.0" ]
+
+    container:
+      image: ruby:3.0-alpine
+
+    services:
+      redis:
+        image: redis:alpine
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
 
-      - name: Setup Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.7.x
+      - name: Install dependencies
+        run: |
+          apk add build-base git cmake openssl-dev
+          apk add tar
 
       - name: Cache Gems
-        uses: actions/cache@v1
+        uses: actions/cache@v2.1.3
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile') }}
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-gem-
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
 
       - name: Install Gems
         run: |
@@ -40,7 +52,42 @@ jobs:
           MA_ENDPOINT_USER: ${{ secrets.MA_ENDPOINT_USER }}
           MA_ENDPOINT_PASSWORD: ${{ secrets.MA_ENDPOINT_PASSWORD }}
           WEBMOCK_ALLOW_HOST: ${{ secrets.WEBMOCK_ALLOW_HOST }}
+          REDIS_URL: "redis://redis:6379/"
         run: bundle exec rspec --profile 10 --format progress
 
       - name: Lint
         run: bundle exec rubocop --parallel --display-cop-names
+
+  release:
+    name: Release application
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-20.04
+    needs: build
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set version
+        run: |
+          echo "VERSION=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_ENV
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p ~/.gem
+          touch ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > ~/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+
+      - name: Create Github Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Gem ${{ github.event.repository.name }} ${{ env.VERSION }} was released

data/.rspec

@@ -1,2 +1,3 @@
+--color
 --fail-fast
 --require spec_helper

data/.rubocop.yml

@@ -1,7 +1,13 @@
-inherit_from: .rubocop_todo.yml
+require:
+  - rubocop-performance
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.7
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Enabled: false
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
@@ -15,26 +21,35 @@ Lint/AssignmentInCondition:
 Lint/SafeNavigationWithEmpty:
   Enabled: false
 
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
 Metrics/BlockLength:
-  Exclude:
-    - spec/**/*.rb
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
 
 Metrics/MethodLength:
   Enabled: false
 
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
+Metrics/PerceivedComplexity:
+  Enabled: false
 
-Style/FrozenStringLiteralComment:
-  Enabled: true
+RSpec/ExampleLength:
+  Enabled: false
 
-Style/HashEachMethods:
-  Enabled: true
+RSpec/FilePath:
+  Exclude:
+    - spec/metal_archives/models/*
 
-Style/HashTransformKeys:
-  Enabled: true
+RSpec/MultipleExpectations:
+  Enabled: false
 
-Style/HashTransformValues:
+Style/FrozenStringLiteralComment:
   Enabled: true
 
 Style/PercentLiteralDelimiters:
@@ -46,18 +61,17 @@ Style/PercentLiteralDelimiters:
     "%w": "()"
     "%W": "()"
 
-Style/RegexpLiteral:
-  EnforcedStyle: slashes
-  AllowInnerSlashes: false
-
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/SymbolArray:
-  Enabled: false
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
+  EnforcedStyleForMultiline: consistent_comma
 
 Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.0
+
+- Add members property on band
+
 ## 3.0.0
 
 - Dropped support for Ruby < 2.5

data/LICENSE.md

@@ -1,7 +1,20 @@
-Copyright (c) 2016-2020 Florian Dejonckheere
+Copyright 2020 Florian Dejonckheere
 
-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:
+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 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.
+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

@@ -1,5 +1,9 @@
 # Metal Archives Ruby API
 
+![Continuous Integration](https://github.com/floriandejonckheere/metal_archives/workflows/Continuous%20Integration/badge.svg)
+![Release](https://img.shields.io/github/v/release/floriandejonckheere/metal_archives?label=Latest%20release)
+
+
 MetalArchives is a Ruby API that transparently wraps, caches and normalizes the [Metal Archives](https://www.metal-archives.com) website.
 
 ## Installation
@@ -33,8 +37,10 @@ MetalArchives.configure do |c|
   c.app_version = "1.0"
   c.app_contact = "support@mymusicapp.com"
 
-  ## Custom cache size per object class (optional, overrides defaults)
-  # c.cache_size = 100
+  ## Enable Redis as caching backend (optional, overrides default memory cache)
+  ## Available cache strategies: :memory, :redis or :null (disable caching)
+  # c.cache_strategy = :redis
+  # c.cache_options = { url: "redis://redis:6379", ttl: 1.month.to_i }
   
   ## Metal Archives endpoint (optional, overrides default)
   # c.endpoint = "https://www.metal-archives.com/"
@@ -56,18 +62,18 @@ require "metal_archives"
 @alquimia_list = MetalArchives::Band.search("Alquimia")
 
 # Find bands by name
-@iron_maiden = MetalArchives::Band.find_by(:name => "Iron Maiden")
+@iron_maiden = MetalArchives::Band.find_by(name: "Iron Maiden")
 
 # Find bands by attributes
 require "countries"
 
-@bands_in_belgium = MetalArchives::Band.search_by :country => ISO3166::Country["BE"]
-@bands_formed_in_1990 = MetalArchives::Band.search_by :year => Range.new(Date.new(1990))
+@bands_in_belgium = MetalArchives::Band.search_by(country: ISO3166::Country["BE"])
+@bands_formed_in_1990 = MetalArchives::Band.search_by(year: 1990..)
 
-# Metal Archives" usual tips apply
+# Metal Archives' usual tips apply
 
-@bands_containing_hell = MetalArchives::Band.search_by :name => "*hell*"
-@non_melodic_death_bands = MetalArchives::Band.search_by :genre => "death -melodic"
+@bands_containing_hell = MetalArchives::Band.search_by name: "*hell*"
+@non_melodic_death_bands = MetalArchives::Band.search_by genre: "death -melodic"
 
 # Methods returning multiple results return a MetalArchives::Collection.
 # Collection wraps a paginated resource, and can be used to iterate over huge queries.
@@ -85,17 +91,27 @@ This leads to instantiation of a model with an invalid ID not throwing any error
 Calling any attribute other than `id` will cause all data to be fetched and any errors to be thrown. 
 Refer to the respective methods to find out what errors are thrown in what circumstances.
 
-Models can be forced to load all data by calling the `:load!` method.  
+Models can be forced to load all data by calling the `load!` method.  
 
 ## Cache
 
-In order not to stress the Metal Archives server, you can quickly set up a local proxy that caches the requests.
+The gem has builtin caching functionality.
+By default, an in-memory cache is used that evicts cache entries using an LRU-based algorithm.
+However, it is also possible to use Redis as a caching backend.
+Don't forget to include the `redis` gem in your application bundle if you wish to use Redis caching.
+
+In order not to stress the Metal Archives server, you can quickly set up a local HTTP proxy that caches the requests.
 
 ```
+# Generate TLS client certificates for NGINX
+openssl req -nodes -new -x509  -keyout nginx/client.key -out nginx/client.pem
+
+
+# Start proxy server
 docker-compose up -d
 ```
 
-A caching proxy server is now available on `http://localhost/`.
+A caching proxy server is now available on `http://localhost:8080/`.
 
 ## Testing
 
@@ -113,7 +129,6 @@ Generate documentation:
 $ bundle exec rake rdoc
 ```
 
-## Copyright
+## License
 
-Copyright 2016-2020 Florian Dejonckheere.
-All content acquired through the usage of this API is copyrighted by the respective owner.
+See [LICENSE.md](LICENSE.md).

data/bin/console

@@ -15,21 +15,18 @@ MetalArchives.configure do |c|
   c.app_version = "1.0"
   c.app_contact = "support@mymusicapp.com"
 
-  ## Request throttling (optional, overrides defaults)
-  # c.request_rate = 1
-  # c.request_timeout = 3
-
-  ## Connect additional Faraday middleware
-  # c.middleware = [MyMiddleware, MyOtherMiddleware]
-
-  ## Custom cache size per object class (optional, overrides defaults)
-  # c.cache_size = 100
+  ## Enable Redis as caching backend (optional, overrides default memory cache)
+  ## Available cache strategies: :memory, :redis or :null (disable caching)
+  # c.cache_strategy = :redis
+  # c.cache_options = { url: "redis://redis:6379", ttl: 1.month.to_i }
 
   ## Metal Archives endpoint (optional, overrides default)
-  # c.endpoint = "http://www.metal-archives.com/"
+  c.endpoint = ENV["MA_ENDPOINT"] if ENV["MA_ENDPOINT"]
+  c.endpoint_user = ENV["MA_ENDPOINT_USER"] if ENV["MA_ENDPOINT_USER"]
+  c.endpoint_password = ENV["MA_ENDPOINT_PASSWORD"] if ENV["MA_ENDPOINT_PASSWORD"]
 
   ## Custom logger (optional)
-  c.logger = Logger.new STDOUT
+  c.logger = Logger.new $stdout
   c.logger.level = Logger::WARN
 end
 

data/config/inflections.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+MetalArchives.loader.inflector.inflect(
+  "id" => "ID",
+  "http_client" => "HTTPClient",
+  "lru_cache" => "LRUCache",
+)

data/docker-compose.yml

@@ -4,11 +4,20 @@ services:
   nginx:
     image: nginx:alpine
     ports:
-      - "80:80"
+      - "0.0.0.0:8080:80"
     volumes:
       - ./nginx/:/etc/nginx/conf.d/
       - nginx:/cache/
     restart: always
 
+  redis:
+    image: redis:alpine
+    ports:
+      - "0.0.0.0:6379:6379"
+    volumes:
+      - redis:/data/
+    restart: always
+
 volumes:
   nginx:
+  redis:

data/lib/metal_archives.rb

@@ -1,33 +1,49 @@
 # frozen_string_literal: true
 
-require "openssl"
-
 require "zeitwerk"
-loader = Zeitwerk::Loader.for_gem
-load.enable_reloading if ENV["METAL_ARCHIVES_ENV"] == "development"
-loader.inflector.inflect(
-  "id" => "ID",
-  "api" => "API",
-  "http_client" => "HTTPClient",
-  "lru_cache" => "LRUCache"
-)
-loader.collapse("lib/metal_archives/models")
-loader.setup
+require "byebug" if ENV["METAL_ARCHIVES_ENV"] == "development"
+require "active_support/all"
 
 ##
 # Metal Archives Ruby API
 #
 module MetalArchives
   class << self
+    # Code loader instance
+    attr_reader :loader
+
+    ##
+    # Root path
+    #
+    def root
+      @root ||= Pathname.new(File.expand_path(File.join("..", ".."), __FILE__))
+    end
+
+    ##
+    # HTTP client
+    #
+    def http
+      @http ||= HTTPClient.new
+    end
+
     ##
     # API configuration
     #
     # Instance of rdoc-ref:MetalArchives::Configuration
     #
     def config
-      raise MetalArchives::Errors::InvalidConfigurationError, "Gem has not been configured" unless @config
+      @config ||= Configuration.new
+    end
 
-      @config
+    ##
+    # Cache instance
+    #
+    def cache
+      raise MetalArchives::Errors::InvalidConfigurationError, "cache has not been configured" unless config.cache_strategy
+
+      @cache ||= Cache
+        .const_get(loader.inflector.camelize(config.cache_strategy, root))
+        .new(config.cache_options)
     end
 
     ##
@@ -40,19 +56,37 @@ module MetalArchives
     # - rdoc-ref:InvalidConfigurationException
     #
     def configure
-      raise MetalArchives::Errors::InvalidConfigurationError, "No configuration block given" unless block_given?
+      raise Errors::InvalidConfigurationError, "no configuration block given" unless block_given?
+
+      yield config
+
+      config.validate!
+    end
 
-      @config = MetalArchives::Configuration.new
-      yield @config
+    ##
+    # Set up application framework
+    #
+    def setup
+      @loader = Zeitwerk::Loader.for_gem
 
-      raise MetalArchives::Errors::InvalidConfigurationError, "app_name has not been configured" unless MetalArchives.config.app_name && !MetalArchives.config.app_name.empty?
-      raise MetalArchives::Errors::InvalidConfigurationError, "app_version has not been configured" unless MetalArchives.config.app_version && !MetalArchives.config.app_version.empty?
+      # Register inflections
+      require root.join("config/inflections.rb")
 
-      return if MetalArchives.config.app_contact && !MetalArchives.config.app_contact.empty?
+      # Set up code loader
+      loader.enable_reloading if ENV["METAL_ARCHIVES_ENV"] == "development"
+      loader.collapse(root.join("lib/metal_archives/models"))
+      loader.do_not_eager_load(root.join("lib/metal_archives/cache"))
+      loader.setup
+      loader.eager_load
 
-      raise MetalArchives::Errors::InvalidConfigurationError, "app_contact has not been configured"
+      # Load initializers
+      Dir[root.join("config/initializers/*.rb")].sort.each { |f| require f }
     end
   end
 end
 
-loader.eager_load
+def reload!
+  MetalArchives.loader.reload
+end
+
+MetalArchives.setup