metal_archives 2.2.3 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa109d3fe5566a0b824be6a2dd5842aa74c23a46696ed296e2dc6eda07d98fd9
-  data.tar.gz: 461d4cdbaa1fb598d17a44940123346bbea4bb263ac30800aafaf301acb10ae0
+  metadata.gz: 2c000d091859fb144ab19500353d4901a3cb2aa2e10962e5a138a12e40c5eb11
+  data.tar.gz: cf9428989c5b8c3f5b36169219fbb62632703a797df2c31bf041ed8dd7e053ad
 SHA512:
-  metadata.gz: 0ad284631c8d240be0de4326f19e837e68d32c8dc812fbb399b61a3b138aa1fc0fc114b1a6b1d476d27ca8e6cf37161d9290ed6f967a52d6bc82398c075b4aaa
-  data.tar.gz: 1b3b611ee16a1f2397d0fa1e0cc5b1ae2e66346d4ddcb5ed3c3be64bf4de0393912895de92e979aa1d484badb904d534a68545443af21fd022dcf0c96c0ff7b1
+  metadata.gz: 56d38a266d6d882b9df4fe4a2efb0d2d9cf9a7f473a19d0bf3ff360a1967edd566c1f49f98a58e58cfcd2d245e856dd28b9fdc3d9bca6f283d253e752c99778e
+  data.tar.gz: a0db17d07d3703743247ed7c59dffcdbefa7686f7d50b8af4f3b6ff9d3fcc640a25208253125ad94784f9b6755298dade393a7a435fac24a8797dcf5d85ff25f

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,8 +1,23 @@
 # Changelog
 
+## 3.2.0
+
+- Add band property on release
+
+## 3.1.1
+
+- Fix some invalid parsing
+
+## 3.1.0
+
+- Add members property on band
+
 ## 3.0.0
 
-- Support for Ruby < 2.5 dropped
+- Dropped support for Ruby < 2.5
+- `MetalArchives::Errors::APIError` changed
+- Dropped support for Faraday middleware
+- Added support for basic authentication
 
 ## 2.2.0
 

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
@@ -7,7 +11,7 @@ MetalArchives is a Ruby API that transparently wraps, caches and normalizes the
 Add this line to your application's Gemfile.
 
 ```ruby
-gem "metal_archives", "0.1.0"
+gem "metal_archives"
 ```
 
 And then execute:
@@ -29,19 +33,14 @@ Configure MetalArchives before using it:
 ```ruby
 MetalArchives.configure do |c|
   ## Application identity (required)
-  c.app_name = 'My App'
-  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
+  c.app_name = "My App"
+  c.app_version = "1.0"
+  c.app_contact = "support@mymusicapp.com"
+
+  ## 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/"
@@ -49,7 +48,7 @@ MetalArchives.configure do |c|
   # c.endpoint_password = "my_password"
   
   ## Custom logger (optional)
-  c.logger = Logger.new File.new('metal_archives.log')
+  c.logger = Logger.new File.new("metal_archives.log")
   c.logger.level = Logger::INFO
 end
 ```
@@ -57,24 +56,24 @@ end
 ## Usage
 
 ```ruby
-require 'metal_archives'
+require "metal_archives"
 
 # Search for bands
-@alquimia_list = MetalArchives::Band.search('Alquimia')
+@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'
+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
 
-@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.
@@ -92,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
 
@@ -120,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: