metal_archives 2.1.1 → 3.1.0

data/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-env:
-  - RAILS_ENV=test CI=true TRAVIS=true
-script:
-  - bundle exec rspec

data/lib/metal_archives/middleware/cache_check.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-
-module MetalArchives
-  module Middleware
-    ##
-    # Log cache status
-    #
-    class CacheCheck < Faraday::Response::Middleware # :nodoc:
-      def on_complete(env)
-        return unless MetalArchives.config.endpoint
-
-        if env[:response_headers].has_key? 'x-cache-status'
-          MetalArchives.config.logger.info "Cache #{env[:response_headers]['x-cache-status'].downcase} for #{env.url.to_s}"
-        end
-      end
-    end
-  end
-end

data/lib/metal_archives/middleware/encoding.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-
-module MetalArchives
-  module Middleware
-    ##
-    # Force UTF-8 conversion
-    #
-    class Encoding < Faraday::Response::Middleware # :nodoc:
-      def on_complete(env)
-        env.response.body.force_encoding('utf-8')
-      end
-    end
-  end
-end

data/lib/metal_archives/middleware/headers.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-
-module MetalArchives
-  module Middleware
-    ##
-    # Add appropriate request headers
-    #
-    class Headers < Faraday::Middleware # :nodoc:
-      def call(env)
-        headers = {
-          'User-Agent' => user_agent_string,
-          'Via' => via_string,
-          'Accept' => accept_string
-        }
-
-        env[:request_headers].merge! headers
-
-        @app.call env
-      end
-
-      private
-
-      def user_agent_string
-        "#{MetalArchives.config.app_name}/#{MetalArchives.config.app_version} ( #{MetalArchives.config.app_contact} )"
-      end
-
-      def accept_string
-        'application/json'
-      end
-
-      def via_string
-        "gem metal_archives/#{VERSION}"
-      end
-    end
-  end
-end

data/lib/metal_archives/middleware/rewrite_endpoint.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'faraday'
-
-module MetalArchives
-  module Middleware
-    ##
-    # Dynamically rewrite endpoints
-    #
-    class RewriteEndpoint < Faraday::Middleware
-      def call(env)
-        env[:url] = RewriteEndpoint.rewrite(env[:url])
-
-        @app.call env
-      end
-
-      class << self
-        def rewrite(uri)
-          return uri unless MetalArchives.config.endpoint
-
-          new_uri = uri.clone
-
-          default_uri = URI MetalArchives.config.default_endpoint
-          rewritten_uri = URI MetalArchives.config.endpoint
-
-          if uri.host == default_uri.host && uri.scheme == default_uri.scheme
-            new_uri.host = rewritten_uri.host
-            new_uri.scheme = rewritten_uri.scheme
-
-            MetalArchives.config.logger.debug "Rewrite #{uri.to_s} to #{new_uri}"
-          end
-
-          new_uri
-        end
-      end
-    end
-  end
-end

data/lib/metal_archives/models/base_model.rb

@@ -1,215 +0,0 @@
-# frozen_string_literal: true
-module MetalArchives
-  ##
-  # Abstract model class
-  #
-  class BaseModel
-    ##
-    # Generic shallow copy constructor
-    #
-    def initialize(hash = {})
-      raise Errors::NotImplementedError, 'no :id property in model' unless respond_to? :id?, true
-
-      hash.each do |property, value|
-        instance_variable_set("@#{property}", value) if self.class.properties.include? property
-      end
-    end
-
-    ##
-    # Returns true if two objects have the same type and id
-    #
-    def ==(obj)
-      obj.instance_of?(self.class) && id ==(obj.id)
-    end
-
-    ##
-    # Fetch, parse and load the data
-    #
-    # [Raises]
-    # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no id
-    # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-    #
-    def load!
-      raise Errors::InvalidIDError, 'no id present' unless !!id
-
-      # Use constructor to set attributes
-      initialize assemble
-
-      # Set empty properties to nil
-      self.class.properties.each do |prop|
-        instance_variable_set("@#{prop}", nil) unless instance_variable_defined? "@#{prop}"
-      end
-
-      @loaded = true
-      self.class.cache[id] = self
-    rescue => e
-      # Don't cache invalid requests
-      self.class.cache.delete id
-      raise e
-    end
-
-    ##
-    # Whether or not the object is currently loaded
-    #
-    def loaded?
-      !@loaded.nil?
-    end
-
-    ##
-    # Whether or not the object is currently cached
-    #
-    def cached?
-      loaded? && self.class.cache.include?(id)
-    end
-
-    protected
-
-      ##
-      # Fetch the data and assemble the model
-      #
-      # Override this method
-      #
-      # [Raises]
-      # - rdoc-ref:MetalArchives::Errors::InvalidIDError when no or invalid id
-      # - rdoc-ref:MetalArchives::Errors::APIError when receiving a status code >= 400 (except 404)
-      #
-    def assemble
-      raise Errors::NotImplementedError, 'method :assemble not implemented'
-    end
-
-    class << self
-      ##
-      # +Array+ of declared properties
-      #
-      attr_accessor :properties
-
-      ##
-      # Get class-level object cache
-      #
-      def cache
-        @cache ||= MetalArchives::LRUCache.new MetalArchives.config.cache_size
-      end
-
-      protected
-
-        ##
-        # Defines a model property.
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+type+]
-        #       Data type of property (a constant)
-        #
-        #       Default: +String+
-        #
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
-      def property(name, opts = {})
-        (@properties ||= []) << name
-
-        # property
-        define_method(name) do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name ==(:id)
-          instance_variable_get("@#{name}")
-        end
-
-        # property?
-        define_method("#{name}?") do
-          load! unless loaded? && instance_variable_defined?("@#{name}") || name ==(:id)
-
-          property = instance_variable_get("@#{name}")
-          property.respond_to?(:empty?) ? !property.empty? : !!property
-        end
-
-        # property=
-        define_method("#{name}=") do |value|
-          if value.nil?
-            instance_variable_set "@#{name}", value
-            return
-          end
-
-          # Check value type
-          type = opts[:type] || String
-          if opts[:multiple]
-            raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be Array for #{name}" unless value.is_a? Array
-            value.each do |val|
-              raise MetalArchives::Errors::TypeError, "invalid type #{val.class}, must be #{type} for #{name}" unless val.is_a? type
-            end
-          else
-            raise MetalArchives::Errors::TypeError, "invalid type #{value.class}, must be #{type} for #{name}" unless value.is_a? type
-          end
-
-          instance_variable_set "@#{name}", value
-        end
-      end
-
-        ##
-        # Defines a model enum property.
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+values+]
-        #       Required. An array of possible values
-        #
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
-      def enum(name, opts)
-        raise ArgumentError, 'opts[:values] is required' unless opts and opts[:values]
-
-        (@properties ||= []) << name
-
-        # property
-        define_method(name) do
-          load! unless loaded? && instance_variable_defined?("@#{name}")
-          instance_variable_get("@#{name}")
-        end
-
-        # property?
-        define_method("#{name}?") do
-          load! unless loaded? && instance_variable_defined?("@#{name}")
-
-          property = instance_variable_get("@#{name}")
-          property.respond_to?(:empty?) ? !property.empty? : !!property
-        end
-
-        # property=
-        define_method("#{name}=") do |value|
-          # Check enum type
-          if opts[:multiple]
-            raise MetalArchives::Errors::TypeError, "invalid enum value #{value}, must be Array for #{name}" unless value.is_a? Array
-            value.each do |val|
-              raise MetalArchives::Errors::TypeError, "invalid enum value #{val} for #{name}" unless opts[:values].include? val
-            end
-          else
-            raise MetalArchives::Errors::TypeError, "invalid enum value #{value} for #{name}" unless opts[:values].include? value
-          end
-
-          instance_variable_set name, value
-        end
-      end
-
-        ##
-        # Defines a model boolean property. This method is an alias for <tt>enum name, :values => [true, false]</tt>
-        #
-        # [+name+]
-        #     Name of the property
-        #
-        # [+opts+]
-        #   [+multiple+]
-        #       Whether or not the property has multiple values (which
-        #       turns it into an +Array+ of +type+)
-        #
-      def boolean(name, opts = {})
-        enum name, opts.merge(:values => [true, false])
-      end
-    end
-  end
-end

data/lib/metal_archives/utils/lru_cache.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module MetalArchives
-  ##
-  # Generic LRU memory cache
-  #
-  class LRUCache
-    def initialize(size = 100)
-      @size = size
-
-      # Underlying data store
-      @cache = {}
-
-      # Array of keys in order of insertion
-      @keys = []
-    end
-
-    def []=(key, value)
-      @cache[key] = value
-
-      @keys.delete key if @keys.include? key
-
-      @keys << key
-
-      pop if @keys.size > @size
-    end
-
-    def [](key)
-      if @keys.include? key
-        MetalArchives.config.logger.debug "Cache hit for #{key}"
-        @keys.delete key
-        @keys << key
-      else
-        MetalArchives.config.logger.debug "Cache miss for #{key}"
-      end
-
-      @cache[key]
-    end
-
-    def clear
-      @cache.clear
-      @keys.clear
-    end
-
-    def include?(key)
-      @cache.include? key
-    end
-
-    def delete(key)
-      @cache.delete key
-    end
-
-    private
-
-    def pop
-      to_remove = @keys.shift @keys.size - @size
-
-      to_remove.each { |key| @cache.delete key }
-    end
-  end
-end

data/lib/metal_archives/utils/nil_date.rb

@@ -1,99 +0,0 @@
-# frozen_string_literal: true
-
-require 'date'
-
-module MetalArchives
-  ##
-  # Date with nullable year, month and day
-  #
-  # WARNING: No validation on actual date is performed
-  #
-  class NilDate
-    include Comparable
-
-    attr_accessor :year, :month, :day
-
-    def initialize(year = nil, month = nil, day = nil)
-      @year = year
-      @month = month
-      @day = day
-    end
-
-    def year?
-      !@year.nil?
-    end
-
-    def month?
-      !@month.nil?
-    end
-
-    def day?
-      !@day.nil?
-    end
-
-    ##
-    # Return a +Date+ object
-    #
-    def date
-      raise MetalArchives::Errors::ArgumentError, "Invalid conversion to Date: #{self.to_s}" unless year?
-
-      ::Date.new @year, month || 1, day || 1
-    end
-
-    ##
-    # Parse YYYY[-MM[-DD]]
-    #
-    def self.parse(value)
-      split = value.split('-')
-
-      year = Integer(split[0], 10) if split.any? && split[0] && !split[0].empty?
-      year = nil if year == 0
-
-      month = Integer(split[1], 10) if split.length > 1 && split[1] && !split[1].empty?
-      month = nil if month == 0
-
-      day = Integer(split[2], 10) if split.length > 2 && split[2] && !split[2].empty?
-      day = nil if day == 0
-
-      return MetalArchives::NilDate.new year, month, day
-    rescue => e
-      raise MetalArchives::Errors::ArgumentError, "Invalid date: #{value}: #{e}"
-    end
-
-    def to_s
-      year = (@year || 0).to_s.rjust 2, '0'
-      month = (@month || 0).to_s.rjust 2, '0'
-      day = (@day || 0).to_s.rjust 2, '0'
-
-      "#{year}-#{month}-#{day}"
-    end
-
-    ##
-    # Comparison operator
-    #
-    def <=>(other)
-      return nil if other.nil?
-
-      # Return nil if one of the two years is nil
-      return nil if (@year.nil? && !other.year.nil?) || !@year.nil? && other.year.nil?
-
-      # Return nil if one of the two months is nil
-      return nil if (@month.nil? && !other.month.nil?) || !@month.nil? && other.month.nil?
-
-      # Return nil if one of the two months is nil
-      return nil if (@day.nil? && !other.day.nil?) || !@day.nil? && other.day.nil?
-
-      comp_year = @year <=> other.year
-      if comp_year == 0
-        comp_month = @month <=> other.month
-        if comp_month == 0
-          return @day <=> other.day
-        else
-          return comp_month
-        end
-      else
-        comp_year
-      end
-    end
-  end
-end