warframe 0.3.1 → 1.0.0

data/lib/warframe/models/attributes/expiry.rb

@@ -1,30 +1,26 @@
 # frozen_string_literal: true
 
-module Warframe
-  module Models
-    # Common Attributes between models.
-    module Attributes
-      # Includes the expiry attribute.
-      module Expiry
-        # When the event will expire.
-        # @return [String]
-        attr_reader :expiry
-      end
+# Common Attributes between models.
+module Warframe::Models::Attributes
+  # Includes the expiry attribute.
+  module Expiry
+    # When the event will expire.
+    # @return [String]
+    attr_reader :expiry
+  end
 
-      # Adds a boolean attribute expired? to see whether or not the even has expired.
-      module Expired
-        # Whether or not the event has expired.
-        # @return [Boolean]
-        attr_reader :expired
-        alias expired? expired
-      end
+  # Adds a boolean attribute expired? to see whether or not the even has expired.
+  module Expired
+    # Whether or not the event has expired.
+    # @return [Boolean]
+    attr_reader :expired
+    alias expired? expired
+  end
 
-      # Adds the {Warframe::Models::Attributes::Expiry Attributes::Expiry} &
-      # {Warframe::Models::Attributes::Expired Attributes::Expired} attributes.
-      module Expiration
-        include Expiry
-        include Expired
-      end
-    end
+  # Adds the {Warframe::Models::Attributes::Expiry Attributes::Expiry} &
+  # {Warframe::Models::Attributes::Expired Attributes::Expired} attributes.
+  module Expiration
+    include Expiry
+    include Expired
   end
 end

data/lib/warframe/models/attributes/id.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-module Warframe
-  module Models
-    module Attributes
-      # Unique data response ID.
-      module ID
-        # The unique ID of the event.
-        # @return [String]
-        attr_reader :id
-      end
-    end
+# Unique data response ID.
+module Warframe::Models::Attributes
+  module ID
+    # The unique ID of the event.
+    # @return [String]
+    attr_reader :id
   end
 end

data/lib/warframe/models/attributes/reward_types.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-module Warframe
-  module Models
-    module Attributes
-      # The types of rewards you can get from this event.
-      module RewardTypes
-        # The types of rewards you can get from this event.
-        # @return [Array<String>]
-        attr_reader :reward_types
-      end
-    end
+# The types of rewards you can get from this event.
+module Warframe::Models::Attributes
+  module RewardTypes
+    # The types of rewards you can get from this event.
+    # @return [Array<String>]
+    attr_reader :reward_types
   end
 end

data/lib/warframe/models/attributes/start_string.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-module Warframe
-  module Models
-    module Attributes
-      # Adds the start_string attribute, for when an event will begin.
-      module StartString
-        # When this event goes into effect.
-        # @return [String]
-        attr_reader :start_string
-      end
-    end
+# Adds the start_string attribute, for when an event will begin.
+module Warframe::Models::Attributes
+  module StartString
+    # When this event goes into effect.
+    # @return [String]
+    attr_reader :start_string
   end
 end

data/lib/warframe/models/attributes/translations.rb

@@ -1,18 +1,14 @@
 # frozen_string_literal: true
 
-module Warframe
-  module Models
-    module Attributes
-      # Includes the translations attribute.
-      module Translations
-        # The message that can be translated.
-        # @return [String]
-        attr_reader :message
+# Includes the translations attribute.
+module Warframe::Models::Attributes
+  module Translations
+    # The message that can be translated.
+    # @return [String]
+    attr_reader :message
 
-        # Available translations for the requested data.
-        # @return [OpenStruct]
-        attr_reader :translations
-      end
-    end
+    # Available translations for the requested data.
+    # @return [OpenStruct]
+    attr_reader :translations
   end
 end

data/lib/warframe/models/base.rb

@@ -1,36 +1,11 @@
 # frozen_string_literal: true
 
 require 'fast_underscore'
+require_rel 'attributes'
+require_rel 'objectified_hash'
 
-module Warframe
-  # Models of HTTP responses.
-  module Models
-    # Warframe Base Model.
-    class Base
-      attr_reader :error, :code
-
-      # Creates a new [Warframe::Models::Base] instance.
-      # @param options [Hash, Array] a parsed JSON object, or collection of JSON objects.
-      def initialize(options = {})
-        if options.is_a? Array
-          from_array options
-        else
-          options.each do |k, v|
-            renamed = k.to_s.underscore
-            v = v.map { |obj| OpenStruct.new obj } if v.is_a?(Array) && v[0].is_a?(Hash)
-            v = OpenStruct.new v if v.is_a? Hash
-            instance_variable_set "@#{renamed}", v
-          end
-        end
-      end
-
-      private
-
-      # Constructs an Array of new [Warframe::Models::Base]'s'.
-      # @return [Array]
-      def from_array(arr)
-        arr.map { |obj| initialize obj }
-      end
-    end
+module Warframe::Models
+  # Warframe Base Model.
+  class Base < ObjectifiedHash
   end
 end

data/lib/warframe/models/cambion_drift.rb

@@ -1,26 +1,21 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative 'attributes/id'
-require_relative 'attributes/expiry'
-require_relative 'attributes/active'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # Cambion Drift data model.
-    # {https://api.warframestat.us/pc/cambionCycle /:platform/cambionCycle}
-    class CambionDrift < Warframe::Models::Base
-      include Warframe::Models::Attributes::ID
-      include Warframe::Models::Attributes::Activation
-      include Warframe::Models::Attributes::Expiry
+module Warframe::Models
+  # Cambion Drift data model.
+  # {https://api.warframestat.us/pc/cambionCycle /:platform/cambionCycle}
+  class CambionDrift < Base
+    include Attributes::ID
+    include Attributes::Activation
+    include Attributes::Expiry
 
-      # Current active state of the world, either 'vome' or 'fass'.
-      # @return [String]
-      attr_reader :active
+    # Current active state of the world, either 'vome' or 'fass'.
+    # @return [String]
+    attr_reader :active
 
-      # The time remaining until world state switches.
-      # @return [String]
-      attr_reader :time_left
-    end
+    # The time remaining until world state switches.
+    # @return [String]
+    attr_reader :time_left
   end
 end

data/lib/warframe/models/cetus.rb

@@ -1,40 +1,35 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative 'attributes/id'
-require_relative 'attributes/active'
-require_relative 'attributes/expiry'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # Cetus data model.
-    # {https://api.warframestat.us/pc/cetusCycle /:platform/cetusCycle}
-    class Cetus < Warframe::Models::Base
-      include Warframe::Models::Attributes::ID
-      include Warframe::Models::Attributes::Activation
-      include Warframe::Models::Attributes::Expiry
+module Warframe::Models
+  # Cetus data model.
+  # {https://api.warframestat.us/pc/cetusCycle /:platform/cetusCycle}
+  class Cetus < Base
+    include Attributes::ID
+    include Attributes::Activation
+    include Attributes::Expiry
 
-      # Whether or not it is currently day.
-      # @return [Boolean]
-      attr_reader :is_day
-      alias day? is_day
+    # Whether or not it is currently day.
+    # @return [Boolean]
+    attr_reader :is_day
+    alias day? is_day
 
-      # Current world state of Cetus.
-      # @return [String]
-      attr_reader :state
+    # Current world state of Cetus.
+    # @return [String]
+    attr_reader :state
 
-      # Whether or not this is Cetus.
-      # @return [Boolean]
-      attr_reader :is_cetus
-      alias cetus? is_cetus
+    # Whether or not this is Cetus.
+    # @return [Boolean]
+    attr_reader :is_cetus
+    alias cetus? is_cetus
 
-      # Time left until state change.
-      # @return [String]
-      attr_reader :time_left
+    # Time left until state change.
+    # @return [String]
+    attr_reader :time_left
 
-      # A short string of the time left until state change.
-      # @return [String]
-      attr_reader :short_string
-    end
+    # A short string of the time left until state change.
+    # @return [String]
+    attr_reader :short_string
   end
 end

data/lib/warframe/models/conclave_challenge.rb

@@ -1,54 +1,47 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative 'attributes/expiry'
-require_relative 'attributes/eta'
-require_relative 'attributes/description'
-require_relative 'attributes/id'
-require_relative 'attributes/active'
-
-module Warframe
-  module Models
-    # Conclave Challenges data model.
-    # {https://api.warframestat.us/pc/conclaveChallenges /:platform/conclaveChallenges}
-    class ConclaveChallenge < Warframe::Models::Base
-      include Warframe::Models::Attributes::Expiration
-      include Warframe::Models::Attributes::ETA
-      include Warframe::Models::Attributes::Description
-      include Warframe::Models::Attributes::ID
-      include Warframe::Models::Attributes::Activation
-
-      # The mode of the conclave.
-      # @return [String]
-      attr_reader :mode
-
-      # The amount of challenges that must be completed.
-      # @return [Integer]
-      attr_reader :amount
-
-      # The amount of standing you will gain upon completion.
-      # @return [Integer]
-      attr_reader :standing
-
-      # The title of the challenge.
-      # @return [String]
-      attr_reader :title
-
-      # The category of mission, usually 'weekly' / 'daily'.
-      # @return [String]
-      attr_reader :category
-
-      # Whether or not this is a daily mission.
-      # @return [Boolean]
-      attr_reader :daily
-
-      # The challenge information in a one line string.
-      # @return [String]
-      attr_reader :as_string
-
-      # Whether or not this is a root challenge.
-      # @return [Boolean]
-      attr_reader :root_challenge
-    end
+require_rel 'base'
+
+module Warframe::Models
+  # Conclave Challenges data model.
+  # {https://api.warframestat.us/pc/conclaveChallenges /:platform/conclaveChallenges}
+  class ConclaveChallenge < Base
+    include Attributes::Expiration
+    include Attributes::ETA
+    include Attributes::Description
+    include Attributes::ID
+    include Attributes::Activation
+
+    # The mode of the conclave.
+    # @return [String]
+    attr_reader :mode
+
+    # The amount of challenges that must be completed.
+    # @return [Integer]
+    attr_reader :amount
+
+    # The amount of standing you will gain upon completion.
+    # @return [Integer]
+    attr_reader :standing
+
+    # The title of the challenge.
+    # @return [String]
+    attr_reader :title
+
+    # The category of mission, usually 'weekly' / 'daily'.
+    # @return [String]
+    attr_reader :category
+
+    # Whether or not this is a daily mission.
+    # @return [Boolean]
+    attr_reader :daily
+
+    # The challenge information in a one line string.
+    # @return [String]
+    attr_reader :as_string
+
+    # Whether or not this is a root challenge.
+    # @return [Boolean]
+    attr_reader :root_challenge
   end
 end

data/lib/warframe/models/global_upgrade.rb

@@ -1,41 +1,37 @@
 # frozen_string_literal: true
 
-require_relative './attributes/expiry'
-require_relative './attributes/description'
-require_relative './attributes/eta'
-
-module Warframe
-  module Models
-    # Global Upgrades data model.
-    # {https://api.warframestat.us/pc/globalUpgrades /:platform/globalUpgrades}
-    class GlobalUpgrade < Warframe::Models::Base
-      include Warframe::Models::Attributes::Expired
-      include Warframe::Models::Attributes::Desc
-      include Warframe::Models::Attributes::ETA
-
-      # The start of the global upgrade.
-      # @return [String]
-      attr_reader :start
-
-      # The end of the global upgrade.
-      # @return [String]
-      attr_reader :end
-
-      # The upgrade to be received.
-      # @return [String]
-      attr_reader :upgrade
-
-      # The operation of the global upgrade.
-      # @return [String]
-      attr_reader :operation
-
-      # The symbol of the operation.
-      # @return [String]
-      attr_reader :operation_symbol
-
-      # The upgrade operation value.
-      # @return [Integer]
-      attr_reader :upgrade_operation_value
-    end
+require_rel 'base'
+
+module Warframe::Models
+  # Global Upgrades data model.
+  # {https://api.warframestat.us/pc/globalUpgrades /:platform/globalUpgrades}
+  class GlobalUpgrade < Base
+    include Attributes::Expired
+    include Attributes::Desc
+    include Attributes::ETA
+
+    # The start of the global upgrade.
+    # @return [String]
+    attr_reader :start
+
+    # The end of the global upgrade.
+    # @return [String]
+    attr_reader :end
+
+    # The upgrade to be received.
+    # @return [String]
+    attr_reader :upgrade
+
+    # The operation of the global upgrade.
+    # @return [String]
+    attr_reader :operation
+
+    # The symbol of the operation.
+    # @return [String]
+    attr_reader :operation_symbol
+
+    # The upgrade operation value.
+    # @return [Integer]
+    attr_reader :upgrade_operation_value
   end
 end

data/lib/warframe/models/invasion.rb

@@ -1,71 +1,62 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative './attributes/id'
-require_relative './attributes/expiry'
-require_relative './attributes/active'
-require_relative './attributes/eta'
-require_relative './attributes/description'
-require_relative './attributes/reward_types'
-require_relative './attributes/start_string'
-
-module Warframe
-  module Models
-    # Invasion data model.
-    # {https://api.warframestat.us/pc/invasions /:platform/invasions}
-    class Invasion < Warframe::Models::Base
-      include Warframe::Models::Attributes::ID
-      include Warframe::Models::Attributes::Activation
-      include Warframe::Models::Attributes::Expiry
-      include Warframe::Models::Attributes::ETA
-      include Warframe::Models::Attributes::Description
-      include Warframe::Models::Attributes::RewardTypes
-      include Warframe::Models::Attributes::StartString
-
-      # Attacking faction data.
-      # @return [OpenStruct]
-      attr_reader :attacker
-
-      # The rewards for helping the attacking faction.
-      # @return [OpenStruct]
-      attr_reader :attacker_reward
-
-      # Attacking Faction Name
-      # @return [String]
-      attr_reader :attacking_faction
-
-      # Whether or not the invasion has been completed.
-      # @return [Boolean]
-      attr_reader :completed
-      alias completed? completed
-
-      # The status of completion of the invasion.
-      # @return [Array<Float>]
-      attr_reader :completion
-
-      # Defending faction data.
-      # @return [OpenStruct]
-      attr_reader :defender
-
-      # The rewards for helping the defending faction.
-      # @return [OpenStruct]
-      attr_reader :defender_reward
-
-      # The name of the defending faction.
-      # @return [String]
-      attr_reader :defending_faction
-
-      # The name of the node of the invasion.
-      # @return [String]
-      attr_reader :node
-
-      # The key of the node.
-      # @return [String]
-      attr_reader :node_key
-
-      # The amount of runs required for completion.
-      # @return [Integer]
-      attr_reader :required_runs
-    end
+require_rel 'base'
+
+module Warframe::Models
+  # Invasion data model.
+  # {https://api.warframestat.us/pc/invasions /:platform/invasions}
+  class Invasion < Base
+    include Attributes::ID
+    include Attributes::Activation
+    include Attributes::Expiry
+    include Attributes::ETA
+    include Attributes::Description
+    include Attributes::RewardTypes
+    include Attributes::StartString
+
+    # Attacking faction data.
+    # @return [OpenStruct]
+    attr_reader :attacker
+
+    # The rewards for helping the attacking faction.
+    # @return [OpenStruct]
+    attr_reader :attacker_reward
+
+    # Attacking Faction Name
+    # @return [String]
+    attr_reader :attacking_faction
+
+    # Whether or not the invasion has been completed.
+    # @return [Boolean]
+    attr_reader :completed
+    alias completed? completed
+
+    # The status of completion of the invasion.
+    # @return [Array<Float>]
+    attr_reader :completion
+
+    # Defending faction data.
+    # @return [OpenStruct]
+    attr_reader :defender
+
+    # The rewards for helping the defending faction.
+    # @return [OpenStruct]
+    attr_reader :defender_reward
+
+    # The name of the defending faction.
+    # @return [String]
+    attr_reader :defending_faction
+
+    # The name of the node of the invasion.
+    # @return [String]
+    attr_reader :node
+
+    # The key of the node.
+    # @return [String]
+    attr_reader :node_key
+
+    # The amount of runs required for completion.
+    # @return [Integer]
+    attr_reader :required_runs
   end
 end