metal_archives 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e19af43a38aa2f5242fee7553c145f673811af35
-  data.tar.gz: 05f2f5ad5b31fa0b8fa095f9866f6b4d148ce4c3
+  metadata.gz: 9c1527cbe8ea9df768ea3112b958fbba43f29dd0
+  data.tar.gz: 82971bd30252efb8e77badb9dfe10c71fb86a585
 SHA512:
-  metadata.gz: 73946de65fb4d67fc98591a897bd9045db3c483e39084656ec4b4e39fa49b247ccd892aeca6f7565969c3522c8772ac0ae6d577ed1d6c6a7d7797fd960dabf89
-  data.tar.gz: 1f2bba663937069139bbd0d2a0093e9e95b7e547f1a1b7a4e0f3e4e3a40790a9f4780cecaf5804677c02fc1df44f2c3c74b938930a97c6c6c5cd29ebcd1bcc71
+  metadata.gz: 64fb61f7acd105d6aa93f005cccdc1d246de4ac7b9a2fc4f944c7a3ff729698eaedd42faee4228f25549f33beedef1f5d34d3834953abe59054f16161b4dcea0
+  data.tar.gz: e57bc2994341940aa33f283ae028ca3cb7a51f1e634eee3041c66d3d75ff0d765ee93e87cf30d394a6cc9ade61d8458bdab08fb5e4bc5dd5d45ec146fe43d38b

data/.gitignore

@@ -1,12 +1,64 @@
-# Ruby version
+Gemfile.lock
+.idea
+
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# IDE files
+.idea
+
+## Gem files
 .ruby-version
 .ruby-gemset
 
-# Temp files
+## Temp files
 .byebug_history
-
-# RDoc
 html/
-
-Gemfile.lock
-.idea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/NestedParenthesizedCalls:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.4.1
+cache:
+  bundler: true
+env:
+  - RAILS_ENV=test CI=true TRAVIS=true
+install:
+  - bundle install
+script:
+  - bundle exec rspec

data/Gemfile

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

data/README.md

@@ -1,4 +1,4 @@
-# Metal Archives Web Service Wrapper
+# 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)
 
 ## Installation
 
@@ -20,20 +20,29 @@ $ bundle install
 
 ```ruby
 MetalArchives.configure do |c|
-  # Application identity (required)
-  c.app_name = "My App"
-  c.app_version = "1.0"
-  c.app_contact = "support@mymusicapp.com"
+  ## Application identity (required)
+  c.app_name = 'My App'
+  c.app_version = '1.0'
+  c.app_contact = 'support@mymusicapp.com'
 
-  # Request throttling (optional, overrides defaults)
+  ## 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)
+  ## Custom cache size per object class (optional, overrides defaults)
   c.cache_size = 100
-
-  # Custom logger (optional)
+  
+  ## Metal Archives endpoint (optional, overrides default)
+  # c.endpoint = 'http://www.metal-archives.com/'
+  
+  ## Custom logger (optional)
   c.logger = Logger.new File.new('metal_archives.log')
+  
+  ## Verbose output
+  # c.debug = false
 end
 ```
 
@@ -74,6 +83,65 @@ By default when an model (Artist, Band, ...) is created, no data is fetched. Thi
 
 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;
+
+	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;
+
+		proxy_hide_header	Set-Cookie;
+		proxy_hide_header	Pragma;
+
+		# Cache valid responses for 30 days
+		proxy_cache			metal_archives;
+		proxy_cache_valid 200 301 302 30d;
+		proxy_cache_valid 404 7d;
+		expires 30d;
+	}
+
+	add_header	X-Cache-Status	$upstream_cache_status;
+}
+```
+
 ## Testing
 ```
 $ bundle exec rake test

data/Rakefile

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << "test"
+  t.libs << 'test'
   t.test_files = FileList['test/*/*_test.rb']
   t.verbose = true
 end
 
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|
-  rdoc.main = "README.md"
-  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end

data/lib/metal_archives.rb

@@ -1,3 +1,10 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+require 'metal_archives/middleware/headers'
+require 'metal_archives/middleware/rewrite_endpoint'
+
 require 'metal_archives/version'
 require 'metal_archives/configuration'
 require 'metal_archives/error'
@@ -5,6 +12,7 @@ require 'metal_archives/error'
 require 'metal_archives/utils/range'
 require 'metal_archives/utils/collection'
 require 'metal_archives/utils/lru_cache'
+require 'metal_archives/utils/nil_date'
 
 require 'metal_archives/models/base_model'
 require 'metal_archives/models/label'

data/lib/metal_archives/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MetalArchives
   class << self
     ##
@@ -5,7 +7,11 @@ module MetalArchives
     #
     # Instance of rdoc-ref:MetalArchives::Configuration
     #
-    attr_accessor :config
+    def config
+      raise MetalArchives::Errors::InvalidConfigurationError, 'Gem has not been configured' unless @config
+
+      @config
+    end
 
     ##
     # Configure API options.
@@ -18,11 +24,14 @@ module MetalArchives
     #
     def configure
       raise MetalArchives::Errors::InvalidConfigurationError, 'No configuration block given' unless block_given?
-      yield MetalArchives.config ||= MetalArchives::Configuration.new
+      @config = MetalArchives::Configuration.new
+      yield @config
 
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_name has not been configured' unless MetalArchives.config.app_name and not MetalArchives.config.app_name.empty?
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_version has not been configured' unless MetalArchives.config.app_version and not MetalArchives.config.app_version.empty?
-      raise MetalArchives::Errors::InvalidConfigurationError, 'app_contact has not been configured' unless MetalArchives.config.app_contact and not MetalArchives.config.app_contact.empty?
+      @config.logger.level = @config.debug ? Logger::DEBUG : Logger::WARN
+
+      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?
+      raise MetalArchives::Errors::InvalidConfigurationError, 'app_contact has not been configured' unless MetalArchives.config.app_contact && !MetalArchives.config.app_contact.empty?
     end
   end
 
@@ -46,9 +55,15 @@ module MetalArchives
     attr_accessor :app_contact
 
     ##
-    # Metal Archives endpoint (defaults to http://www.metal-archives.com/)
+    # Override Metal Archives endpoint (defaults to http://www.metal-archives.com/)
     #
     attr_accessor :endpoint
+    attr_reader :default_endpoint
+
+    ##
+    # Additional Faraday middleware
+    #
+    attr_accessor :middleware
 
     ##
     # Request throttling rate (in seconds per request per path)
@@ -65,6 +80,11 @@ module MetalArchives
     #
     attr_accessor :logger
 
+    ##
+    # Verbose output
+    #
+    attr_accessor :debug
+
     ##
     # Cache size (per object class)
     #
@@ -74,10 +94,11 @@ module MetalArchives
     # Default configuration values
     #
     def initialize
-      @endpoint = 'http://www.metal-archives.com/'
+      @default_endpoint = 'https://www.metal-archives.com/'
       @throttle_rate = 1
       @throttle_wait = 3
       @logger = Logger.new STDOUT
+      @debug = false
       @cache_size = 100
     end
   end

data/lib/metal_archives/error.rb

@@ -1,40 +1,47 @@
+# frozen_string_literal: true
+
 module MetalArchives
-##
-# MetalArchives gem specific errors
-#
-module Errors
   ##
-  # Generic error
+  # MetalArchives gem specific errors
   #
-  class Error < StandardError; end
+  module Errors
+    ##
+    # Generic error
+    #
+    class Error < StandardError; end
 
-  ##
-  # No or invalid ID
-  #
-  class InvalidIDError < Error; end
+    ##
+    # No or invalid ID
+    #
+    class InvalidIDError < Error; end
 
-  ##
-  # No or invalid configuration
-  #
-  class InvalidConfigurationError < Error; end
+    ##
+    # No or invalid configuration
+    #
+    class InvalidConfigurationError < Error; end
 
-  ##
-  # Error parsing value
-  #
-  class ParserError < Error; end
+    ##
+    # Error parsing value
+    #
+    class ParserError < Error; end
 
-  ##
-  # Functionality not implemented (yet)
-  class NotImplementedError < Error; end
+    ##
+    # Functionality not implemented (yet)
+    class NotImplementedError < Error; end
 
-  ##
-  # Error in backend response
-  #
-  class APIError < Error; end
+    ##
+    # Error in backend response
+    #
+    class APIError < Error; end
 
-  ##
-  # Error in method argument
-  #
-  class ArgumentError < Error; end
-end
+    ##
+    # Error in method argument
+    #
+    class ArgumentError < Error; end
+
+    ##
+    # Incorrect type
+    #
+    class TypeError < Error; end
+  end
 end

data/lib/metal_archives/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_throttler'
 
@@ -7,7 +9,6 @@ module MetalArchives
   #
   class HTTPClient # :nodoc:
     class << self
-
       ##
       # Retrieve a HTTP resource
       #
@@ -27,53 +28,31 @@ module MetalArchives
       end
 
       private
-        ##
-        # Retrieve a HTTP client
-        #
-        #
-        def client
-          raise Errors::InvalidConfigurationError, 'Not configured yet' unless MetalArchives.config
 
-          @faraday ||= Faraday.new do |f|
-            f.request   :url_encoded            # form-encode POST params
-            f.response  :logger, MetalArchives.config.logger
-
-            f.use       MetalArchives::Middleware
-            f.use       :throttler,
-                                :rate => MetalArchives.config.request_rate,
-                                :wait => MetalArchives.config.request_timeout,
-                                :logger => MetalArchives.config.logger
+      ##
+      # Retrieve a HTTP client
+      #
+      #
+      def client
+        raise Errors::InvalidConfigurationError, 'Not configured yet' unless MetalArchives.config
 
-            f.adapter   Faraday.default_adapter
-          end
-        end
-    end
-  end
+        @faraday ||= Faraday.new do |f|
+          f.request   :url_encoded # form-encode POST params
+          f.response  :logger, MetalArchives.config.logger
 
-  ##
-  # Faraday middleware
-  #
-  class Middleware < Faraday::Middleware # :nodoc:
-    def call(env)
-      env[:request_headers].merge!(
-        'User-Agent'  => user_agent_string,
-        'Via'         => via_string,
-        'Accept'      => accept_string
-      )
-      @app.call(env)
-    end
+          f.use       MetalArchives::Middleware::Headers
+          f.use       MetalArchives::Middleware::RewriteEndpoint
 
-    private
-      def user_agent_string
-        "#{MetalArchives.config.app_name}/#{MetalArchives.config.app_version} ( #{MetalArchives.config.app_contact} )"
-      end
+          MetalArchives.config.middleware.each { |m| f.use m } if MetalArchives.config.middleware
 
-      def accept_string
-        'application/json'
-      end
+          f.use       :throttler,
+                      :rate => MetalArchives.config.request_rate,
+                      :wait => MetalArchives.config.request_timeout,
+                      :logger => MetalArchives.config.logger
 
-      def via_string
-        "gem metal_archives/#{VERSION}"
+          f.adapter   Faraday.default_adapter
+        end
       end
+    end
   end
 end