metal_archives 2.2.0 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3d67ee1fe72c3fb58bf95f48ee68bda41232857e
-  data.tar.gz: cfa4704bb7020f4176ad6a14de0b979249e11976
+SHA256:
+  metadata.gz: fa109d3fe5566a0b824be6a2dd5842aa74c23a46696ed296e2dc6eda07d98fd9
+  data.tar.gz: 461d4cdbaa1fb598d17a44940123346bbea4bb263ac30800aafaf301acb10ae0
 SHA512:
-  metadata.gz: be9295ee982e7600ad2aba6f5a9ae60fdcdcb5db1039e51a76c18a2fedc53e7899e3ee3c068763c171a3a7a232cbca325d3885d07f1598c4852f73ba7c4b5e17
-  data.tar.gz: 7a121ab78954206854de8d73d1131030684864dccc68c53429ddc2054cb6cc836b7014b5f8044778992bcd27317caa2f8da0f6c020c4a7f72ae848fd1b84aa39
+  metadata.gz: 0ad284631c8d240be0de4326f19e837e68d32c8dc812fbb399b61a3b138aa1fc0fc114b1a6b1d476d27ca8e6cf37161d9290ed6f967a52d6bc82398c075b4aaa
+  data.tar.gz: 1b3b611ee16a1f2397d0fa1e0cc5b1ae2e66346d4ddcb5ed3c3be64bf4de0393912895de92e979aa1d484badb904d534a68545443af21fd022dcf0c96c0ff7b1

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    tags-ignore:
+      - '*'
+    branches:
+      - '*'
+
+jobs:
+  build:
+    name: Continuous Integration
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Cache Gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-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 }}
+        run: bundle exec rspec --profile 10 --format progress
+
+      - name: Lint
+        run: bundle exec rubocop --parallel --display-cop-names

data/.github/workflows/release.yml

@@ -0,0 +1,69 @@
+name: Create release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  generate:
+    name: Create release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Cache Gems
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-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 }}
+        run: bundle exec rspec --profile 10 --format progress
+
+      - name: Lint
+        run: bundle exec rubocop --parallel --display-cop-names
+
+      - name: Get the version
+        id: get_version
+        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
+
+      - 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 Release
+        uses: actions/create-release@v1.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Gem is available as: ${{ github.event.repository.name }}-${{ steps.get_version.outputs.VERSION }}
+            Created by Github Actions

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,2 @@
+--fail-fast
 --require spec_helper

data/.rubocop.yml

@@ -1,17 +1,63 @@
-Metrics/LineLength:
-  Max: 120
+inherit_from: .rubocop_todo.yml
 
-Metrics/ClassLength:
-  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.7
 
-Metrics/MethodLength:
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+Lint/SafeNavigationWithEmpty:
   Enabled: false
 
 Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Metrics/MethodLength:
   Enabled: false
 
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
 
-Style/NestedParenthesizedCalls:
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: "()"
+    "%i": "()"
+    "%I": "()"
+    "%r": "()"
+    "%w": "()"
+    "%W": "()"
+
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  AllowInnerSlashes: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
   Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -0,0 +1,92 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-04-14 17:51:42 +0200 using RuboCop version 0.80.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/AmbiguousRegexpLiteral:
+  Exclude:
+    - 'lib/metal_archives/parsers/artist.rb'
+
+# Offense count: 2
+Lint/EmptyWhen:
+  Exclude:
+    - 'lib/metal_archives/parsers/label.rb'
+    - 'lib/metal_archives/parsers/release.rb'
+
+# Offense count: 2
+# Configuration parameters: AllowKeywordBlockArguments.
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - 'lib/metal_archives/range.rb'
+
+# Offense count: 6
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/metal_archives/parsers/artist.rb'
+    - 'lib/metal_archives/parsers/band.rb'
+    - 'lib/metal_archives/parsers/label.rb'
+    - 'lib/metal_archives/parsers/release.rb'
+    - 'spec/collection_spec.rb'
+
+# Offense count: 29
+Metrics/AbcSize:
+  Max: 102
+
+# Offense count: 9
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 42
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 147
+
+# Offense count: 12
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Offense count: 12
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Offense count: 1
+Naming/BinaryOperatorParameterName:
+  Exclude:
+    - 'lib/metal_archives/models/base_model.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/metal_archives/http_client.rb'
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/metal_archives.rb'
+    - 'lib/metal_archives/middleware/cache_check.rb'
+    - 'lib/metal_archives/models/base_model.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/metal_archives/nil_date.rb'
+
+# Offense count: 307
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 963

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 3.0.0
+
+- Support for Ruby < 2.5 dropped
+
+## 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,4 +1,4 @@
-Copyright (c) 2016 Florian Dejonckheere
+Copyright (c) 2016-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:
 

data/README.md

@@ -1,23 +1,31 @@
-# 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
+
+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", "0.1.0"
 ```
 
-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)
@@ -36,7 +44,9 @@ MetalArchives.configure do |c|
   c.cache_size = 100
   
   ## 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')
@@ -77,79 +87,40 @@ 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.  
 
 ## 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:
+In order not to stress the Metal Archives server, you can quickly set up a local proxy that caches the requests.
 
 ```
-# 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;
-
-	access_log      /var/log/nginx/metal_archives_access.log;
-	error_log       /var/log/nginx/metal_archives_error.log;
-
-	# 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/;
-
-		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;
+docker-compose up -d
+```
 
-		proxy_hide_header	Set-Cookie;
-		proxy_hide_header	Pragma;
+A caching proxy server is now available on `http://localhost/`.
 
-		# 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
 
-Copyright 2016 Florian Dejonckheere. All content acquired through the usage of this API is copyrighted by the respective owner.
+Copyright 2016-2020 Florian Dejonckheere.
+All content acquired through the usage of this API is copyrighted by the respective owner.