metal_archives 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b077092f1a7e727aee29d04339faf31468b704b
-  data.tar.gz: 00674c9f439ba8c1f8a014cd60c4da6ec5289e22
+SHA256:
+  metadata.gz: cc72b807bbb20dcb70cfc38a6808b1088a3c5a187a6b033f82ef0083e5ff7794
+  data.tar.gz: b2424b28220556afc3c777efcd38e10f9b03d92d58905130e53723a0f5e5691c
 SHA512:
-  metadata.gz: 9217a15df5ae47a552a8214fba23a374bb9788611103d0366078aff6e72069505bf2d43fcfc0c437624aae8bbf3f9a342bbcfa67abd512ed712473a51dc56a9b
-  data.tar.gz: 22a44ac5667e462eab891c019c98f17340e2469ffa7ff71d79e5f6dc9b6d6a5eb5482ef10fcba9f0b4a320ad9fb9795d32f7df7b4122dd463bb865192613e6b2
+  metadata.gz: 5d80a6bf547b425d5d85c1b789e62a9224cf77e06911e8e8e45f298041778e2b9e976e754fc1a6f43a939e2e5b5cabf581f7b43b8677d8d48f4023a11df516fb
+  data.tar.gz: 2911d68d5725d92def587f482cc01235c280e7989b1903cac2374632136e667f988384141ffbb2ae9c69bae95a555c7f7cac50e96e12af273e562bc372bb141c

data/.github/workflows/ci.yml

@@ -0,0 +1,93 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - '*'
+    tags:
+      - '*'
+  schedule:
+    - cron: '0 7 * * 1'
+
+jobs:
+  build:
+    name: Continuous Integration
+    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@v2
+
+      - name: Install dependencies
+        run: |
+          apk add build-base git cmake openssl-dev
+          apk add tar
+
+      - name: Cache Gems
+        uses: actions/cache@v2.1.3
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
+
+      - name: Install Gems
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Test
+        env:
+          MA_ENDPOINT: ${{ secrets.MA_ENDPOINT }}
+          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/.gitignore

@@ -1,6 +1,3 @@
-Gemfile.lock
-.idea
-
 *.tar.gz
 *.gem
 *.rbc
@@ -13,9 +10,12 @@ Gemfile.lock
 /test/tmp/
 /test/version_tmp/
 /tmp/
+nginx/*.key
+nginx/*.pem
 
 # Used by dotenv library to load environment variables.
 # .env
+*.env
 
 ## Specific to RubyMotion:
 .dat*
@@ -46,9 +46,9 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/.overcommit.yml

@@ -0,0 +1,35 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  Fasterer:
+    enabled: true
+
+  Flay:
+    enabled: true
+
+  Pronto:
+    enabled: true
+
+  Reek:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+
+  RubySyntax:
+    enabled: true

data/.rspec

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

data/.rubocop.yml

@@ -1,14 +1,77 @@
-Metrics/LineLength:
-  Max: 120
+require:
+  - rubocop-performance
+  - rubocop-rspec
 
-Metrics/MethodLength:
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+Lint/SafeNavigationWithEmpty:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
   Enabled: false
 
 Metrics/BlockLength:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Metrics/ClassLength:
+  Enabled: false
 
-Style/NestedParenthesizedCalls:
+Metrics/MethodLength:
   Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/FilePath:
+  Exclude:
+    - spec/metal_archives/models/*
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: "()"
+    "%i": "()"
+    "%I": "()"
+    "%r": "()"
+    "%w": "()"
+    "%W": "()"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 3.1.0
+
+- Add members property on band
+
+## 3.0.0
+
+- Dropped support for Ruby < 2.5
+- `MetalArchives::Errors::APIError` changed
+- Dropped support for Faraday middleware
+- Added support for basic authentication
+
+## 2.2.0
+
+- Add `Release` model
+
+## 2.1.1
+
+- Fix UTF-8 conversion errors
+- Don't `load!` unconditionally on `find!` and `find_by!`
+
+## 2.1.0
+
+- Added Ruby compatibility down to 2.1
+- Band and Label: return `NilDate`
+
+## 2.0.0
+
+- Artist returns `NilDate`s
+
 ## 1.0.0
 
 - Add `Artist#photo`

data/Gemfile

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/LICENSE.md

@@ -1,7 +1,20 @@
-Copyright (c) 2016 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,45 +1,54 @@
-# Metal Archives Web Service Wrapper [![Travis](https://travis-ci.org/floriandejonckheere/metal_archives.svg?branch=master)](https://travis-ci.org/floriandejonckheere/metal_archives) [![Coverage Status](https://coveralls.io/repos/github/floriandejonckheere/metal_archives/badge.svg)](https://coveralls.io/github/floriandejonckheere/metal_archives)
+# 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
 
-```shell
-$ gem install metal_archives
+Add this line to your application's Gemfile.
+
+```ruby
+gem "metal_archives"
 ```
 
-or add it to your Gemfile
+And then execute:
 
-```ruby
-gem 'metal_archives'
+```sh
+bundle
 ```
 
-```shell
-$ bundle install
+Or install it yourself as:
+
+```sh
+gem install metal_archives
 ```
 
 ## Configuration
 
+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 = 'http://www.metal-archives.com/'
+  # c.endpoint = "https://www.metal-archives.com/"
+  # c.endpoint_user = "my_user"
+  # 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
 ```
@@ -47,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.
@@ -77,79 +86,49 @@ Refer to the model's [RDoc documentation](https://floriandejonckheere.github.io/
 
 ## Lazy loading
 
-By default when an model (Artist, Band, ...) is created, no data is fetched. This leads to instantiation of a model with an invalid ID not throwing any errors. 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.
+By default when an model (Artist, Band, ...) is created, no data is fetched. 
+This leads to instantiation of a model with an invalid ID not throwing any errors. 
+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. For NGINX, adjust the following configuration:
-
-```
-# Set cache dir
-proxy_cache_path /var/cache/nginx/metal_archives levels=1:2 keys_zone=metal_archives:10m;
-
-# Set cache key to include identifying components
-proxy_cache_key $scheme$proxy_host$request_uri;
-
-# Add cache status to log
-log_format cache '$remote_addr - $remote_user [$time_local] "$request" $status $body_bytes_sent "$http_referer" "$http_user_agent" cs=$upstream_cache_status';
-
-server {
-	server_name metal-archives.myhost.com;
-	listen 443	ssl;
-	listen [::]:443	ssl;
-
-	ssl_certificate		/path/to/ssl_certificate.crt;
-	ssl_certificate_key /path/to/ssl_certificate_key.key;
+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.
 
-	access_log      /var/log/nginx/metal_archives_access.log;
-	error_log       /var/log/nginx/metal_archives_error.log;
+In order not to stress the Metal Archives server, you can quickly set up a local HTTP proxy that caches the requests.
 
-	# Limit HTTP requests
-	limit_req_zone $binary_remote_addr zone=ma_limit_req:10m rate=2r/s;
-
-	location / {
-		proxy_redirect off; 
-		proxy_set_header		Host www.metal-archives.com;
-		proxy_set_header		X-Forwarded-Host $host;
-		proxy_set_header		X-Forwarded-Server $host;
-		proxy_set_header		X-Forwarded-For $proxy_add_x_forwarded_for;
-		proxy_set_header		X-Real-IP  $remote_addr;
-
-		proxy_pass			https://www.metal-archives.com/;
+```
+# Generate TLS client certificates for NGINX
+openssl req -nodes -new -x509  -keyout nginx/client.key -out nginx/client.pem
 
-		limit_req		zone=ma_limit_req burst=5;
 
-		proxy_ignore_headers	X-Accel-Expires;
-		proxy_ignore_headers	Expires;
-		proxy_ignore_headers	Cache-Control;
-		proxy_ignore_headers	Set-Cookie;
+# Start proxy server
+docker-compose up -d
+```
 
-		proxy_hide_header	Set-Cookie;
-		proxy_hide_header	Pragma;
+A caching proxy server is now available on `http://localhost:8080/`.
 
-		# Cache valid responses for 30 days
-		proxy_cache			metal_archives;
-		proxy_cache_valid 200 301 302 30d;
-		proxy_cache_valid 404 7d;
-		expires 30d;
-	}
+## Testing
 
-	add_header	X-Cache-Status	$upstream_cache_status;
-}
-```
+Run tests:
 
-## Testing
 ```
-$ bundle exec rake test
+bundle exec rake test
 ```
 
 ## Documentation
+
+Generate documentation:
+
 ```
 $ bundle exec rake rdoc
 ```
 
-## Copyright
+## License
 
-Copyright 2016 Florian Dejonckheere. All content acquired through the usage of this API is copyrighted by the respective owner.
+See [LICENSE.md](LICENSE.md).