warframe 0.1.3 → 0.3.1

data/lib/warframe/models/sortie.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative 'attributes/id'
+require_relative 'attributes/expiry'
+require_relative 'attributes/active'
+require_relative 'attributes/eta'
+
+module Warframe
+  module Models
+    # Sortie data model.
+    # {https://api.warframestat.us/pc/sortie /:platform/sortie}
+    class Sortie < Warframe::Models::Base
+      include Warframe::Models::Attributes::ID
+      include Warframe::Models::Attributes::ActiveBoth
+      include Warframe::Models::Attributes::Expiration
+      include Warframe::Models::Attributes::ETA
+
+      # The boss for this part of the sortie.
+      # @return [String]
+      attr_reader :boss
+
+      # The faction fighting you in this mission.
+      # @return [String]
+      attr_reader :faction
+
+      # Modifiers active for this challenge.
+      # @return [Array<OpenStruct>]
+      attr_reader :variants
+
+      # The reward pool which this is pulling from.
+      # @return [String]
+      attr_reader :reward_pool
+    end
+  end
+end

data/lib/warframe/models/steel_path.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Warframe
+  module Models
+    # SteelPath data model.
+    # {https://api.warframestat.us/pc/steelPath /:platform/steelPath}
+    class SteelPath < Warframe::Models::Base
+      include Warframe::Models::Attributes::Active
+      include Warframe::Models::Attributes::Expiry
+
+      # The currently available item from Teshin.
+      # @return [OpenStruct]
+      attr_reader :current_reward
+
+      # The time remaining of the current reward.
+      # @return [String]
+      attr_reader :remaining
+
+      # Current rotation of items the Arbiters have to offer.
+      # @return [Array<OpenStruct>]
+      attr_reader :rotation
+
+      # Current rotation of items Teshin has to offer.
+      # @return [Array<OpenStruct>]
+      attr_reader :evergreens
+
+      # Current incursion data
+      # @return [OpenStruct]
+      attr_reader :incursions
+    end
+  end
+end

data/lib/warframe/models/syndicate_mission.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative 'attributes/eta'
+require_relative 'attributes/id'
+require_relative 'attributes/active'
+require_relative 'attributes/start_string'
+
+module Warframe
+  module Models
+    # SyndicateMission data model.
+    # {https://api.warframestat.us/pc/syndicateMissions /:platform/syndicateMissions}
+    class SyndicateMission < Warframe::Models::Base
+      include Warframe::Models::Attributes::ETA
+      include Warframe::Models::Attributes::ID
+      include Warframe::Models::Attributes::ActiveBoth
+      include Warframe::Models::Attributes::StartString
+
+      # 'Jobs' or challenges currently available.
+      # @return [Array<OpenStruct>]
+      attr_reader :jobs
+
+      # The syndicate you will be fighting.
+      # @return [String]
+      attr_reader :syndicate
+
+      # The nodes that this mission is available on.
+      # @return [Array]
+      attr_reader :nodes
+    end
+  end
+end

data/lib/warframe/rest/api/alerts.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'warframe/models/alert'
-require_relative '../utils'
-
-module Warframe
-  module REST
-    module API
-      # API endpoint for getting information on current Alerts data.
-      #
-      # {https://api.warframestat.us/pc/alerts Example Response}
-      module Alerts
-        include Warframe::REST::Utils
-
-        # Gets the current Alerts data.
-        # @return [Array<[Warframe::Models::Alert]>]
-        def alerts
-          get('/alerts', Warframe::Models::Alert)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/models/alert'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Alerts data.
+      #
+      # {https://api.warframestat.us/pc/alerts Example Response}
+      module Alerts
+        include Warframe::REST::Utils
+
+        # Gets the current Alerts data.
+        # @return [Array<[Warframe::Models::Alert]>]
+        def alerts
+          get('/alerts', Warframe::Models::Alert)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/cambion_drift.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/cambion_drift'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Cambion Drift data.
+      #
+      # {https://api.warframestat.us/pc/cambionDrift Example Response}
+      module CambionDrift
+        include Warframe::REST::Utils
+
+        # Gets the current cambionDrift Data.
+        # @return Warframe::Models::CambionDrift
+        def cambion_drift
+          get('/cambionCycle', Warframe::Models::CambionDrift)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/cetus.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/cetus'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Cetus data.
+      #
+      # {https://api.warframestat.us/pc/cetusCycle Example Response}
+      module Cetus
+        include Warframe::REST::Utils
+
+        # Gets the current cetusCycle Data.
+        # @return [Warframe::Models::Cetus]
+        def cetus
+          get('/cetusCycle', Warframe::Models::Cetus)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/conclave_challenges.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/conclave_challenge'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Conclave Challenge data.
+      #
+      # {https://api.warframestat.us/pc/conclaveChallenges Example Response}
+      module ConclaveChallenges
+        include Warframe::REST::Utils
+
+        # Gets the current conclave challenges.
+        # @return [Array<Warframe::Models::ConclaveChallenge>]
+        def conclave_challenges
+          get('/conclaveChallenges', Warframe::Models::ConclaveChallenge)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/global_upgrades.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'warframe/models/global_upgrade'
-require_relative '../utils'
-
-module Warframe
-  module REST
-    module API
-      # API endpoint for getting information on current Global Upgrades data.
-      #
-      # {https://api.warframestat.us/pc/globalUpgrades Example Response}
-      module GlobalUpgrades
-        include Warframe::REST::Utils
-
-        # Gets the current Global Upgrades data.
-        # @return [Array<[Warframe::Models::GlobalUpgrade]>]
-        def global_upgrades
-          get('/globalUpgrades', Warframe::Models::GlobalUpgrade)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/models/global_upgrade'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Global Upgrades data.
+      #
+      # {https://api.warframestat.us/pc/globalUpgrades Example Response}
+      module GlobalUpgrades
+        include Warframe::REST::Utils
+
+        # Gets the current Global Upgrades data.
+        # @return [Array<[Warframe::Models::GlobalUpgrade]>]
+        def global_upgrades
+          get('/globalUpgrades', Warframe::Models::GlobalUpgrade)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/invasions.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'warframe/models/invasion'
-require_relative '../utils'
-
-module Warframe
-  module REST
-    module API
-      # API endpoint for getting information on current Invasions data.
-      #
-      # {https://api.warframestat.us/pc/invasions Example Response}
-      module Invasions
-        include Warframe::REST::Utils
-
-        # Gets the current Invasions data.
-        # @return [Array<[Warframe::Models::Invasion]>]
-        def invasions
-          get('/invasions', Warframe::Models::Invasion)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/models/invasion'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Invasions data.
+      #
+      # {https://api.warframestat.us/pc/invasions Example Response}
+      module Invasions
+        include Warframe::REST::Utils
+
+        # Gets the current Invasions data.
+        # @return [Array<[Warframe::Models::Invasion]>]
+        def invasions
+          get('/invasions', Warframe::Models::Invasion)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/news.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'warframe/models/news'
-require_relative '../utils'
-
-module Warframe
-  module REST
-    module API
-      # API endpoint for getting information from the News route.
-      #
-      # {https://api.warframestat.us/pc/news Example Response}
-      module News
-        include Warframe::REST::Utils
-
-        # Gets the current news data.
-        # @return [Array<Warframe::Models::News>]
-        def news
-          get('/news', Warframe::Models::News)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/models/news'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information from the News route.
+      #
+      # {https://api.warframestat.us/pc/news Example Response}
+      module News
+        include Warframe::REST::Utils
+
+        # Gets the current news data.
+        # @return [Array<Warframe::Models::News>]
+        def news
+          get('/news', Warframe::Models::News)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/nightwave.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require 'warframe/models/nightwave'
-require_relative '../utils'
-
-module Warframe
-  module REST
-    module API
-      # API endpoint for getting information from the Nightwave route.
-      #
-      # {https://api.warframestat.us/pc/nightwave Example Response}
-      module Nightwave
-        include Warframe::REST::Utils
-
-        # Gets the current Nightwave Mission data.
-        # @return [Warframe::Models::Nightwave]
-        def nightwave
-          get('/nightwave', Warframe::Models::Nightwave)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/models/nightwave'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information from the Nightwave route.
+      #
+      # {https://api.warframestat.us/pc/nightwave Example Response}
+      module Nightwave
+        include Warframe::REST::Utils
+
+        # Gets the current Nightwave Mission data.
+        # @return [Warframe::Models::Nightwave]
+        def nightwave
+          get('/nightwave', Warframe::Models::Nightwave)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/sortie.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/sortie'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current Sortie data.
+      #
+      # {https://api.warframestat.us/pc/sortie Example Response}
+      module Sortie
+        include Warframe::REST::Utils
+
+        # Gets the current sortie missions.
+        # @return [Array<Warframe::Models::Sortie>]
+        def sortie
+          get('/sortie', Warframe::Models::Sortie)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/steel_path.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/steel_path'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current SteelPath data.
+      #
+      # {https://api.warframestat.us/pc/steelPath Example Response}
+      module SteelPath
+        include Warframe::REST::Utils
+
+        # Steel Path data
+        # @return [Warframe::Models::SteelPath]
+        def steel_path
+          get('/steelPath', Warframe::Models::SteelPath)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api/syndicate_missions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'warframe/models/syndicate_mission'
+require_relative '../utils'
+
+module Warframe
+  module REST
+    module API
+      # API endpoint for getting information on current SyndicateMission data.
+      #
+      # {https://api.warframestat.us/pc/syndicateMissions Example Response}
+      module SyndicateMissions
+        include Warframe::REST::Utils
+
+        # Gets the current syndicateMissions Data.
+        # @return [Array<Warframe::Models::SyndicateMission>]
+        def syndicate_missions
+          get('/syndicateMissions', Warframe::Models::SyndicateMission)
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/api.rb

@@ -1,25 +1,37 @@
-# frozen_string_literal: true
-
-require_relative 'api/alerts'
-require_relative 'api/global_upgrades'
-require_relative 'api/invasions'
-require_relative 'api/news'
-require_relative 'api/nightwave'
-
-module Warframe
-  # A REST-ful API service, provided by https://api.warframestat.us
-  module REST
-    # The API Router for getting live data.
-    #
-    # Attempting to have every accessible route from {https://docs.warframestat.us Warframe Stat}.
-    #
-    # Module names are 'routes' to this API. See {Warframe::REST::API::Alerts Alerts} for example.
-    module API
-      include Warframe::REST::API::Alerts
-      include Warframe::REST::API::GlobalUpgrades
-      include Warframe::REST::API::Invasions
-      include Warframe::REST::API::News
-      include Warframe::REST::API::Nightwave
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'api/alerts'
+require_relative 'api/cambion_drift'
+require_relative 'api/cetus'
+require_relative 'api/conclave_challenges'
+require_relative 'api/global_upgrades'
+require_relative 'api/invasions'
+require_relative 'api/news'
+require_relative 'api/nightwave'
+require_relative 'api/sortie'
+require_relative 'api/steel_path'
+require_relative 'api/syndicate_missions'
+
+module Warframe
+  # A REST-ful API service, provided by https://api.warframestat.us.
+  module REST
+    # The API Router for getting live data.
+    #
+    # Attempting to have every accessible route from {https://docs.warframestat.us Warframe Stat}.
+    #
+    # Module names are 'routes' to this API. See {Warframe::REST::API::Alerts Alerts} for example.
+    module API
+      include Warframe::REST::API::Alerts
+      include Warframe::REST::API::CambionDrift
+      include Warframe::REST::API::Cetus
+      include Warframe::REST::API::ConclaveChallenges
+      include Warframe::REST::API::GlobalUpgrades
+      include Warframe::REST::API::Invasions
+      include Warframe::REST::API::News
+      include Warframe::REST::API::Nightwave
+      include Warframe::REST::API::Sortie
+      include Warframe::REST::API::SteelPath
+      include Warframe::REST::API::SyndicateMissions
+    end
+  end
+end

data/lib/warframe/rest/client.rb

@@ -1,42 +1,42 @@
-# frozen_string_literal: true
-
-require 'warframe/client_wrapper'
-require_relative './api'
-
-module Warframe
-  module REST
-    # The main application Client for access live feed data.
-    #
-    # == Example Usage
-    #
-    #   client = Warframe::REST::Client.new
-    #   client.nightwave.tag # => 'Radio Legion Intermission'
-    #
-    # == Accepted Platforms
-    #
-    #   default = 'pc'
-    #   all_platorms = [ 'pc', 'ps4', 'xb1', 'swi' ]
-    #
-    #   client = Waframe::REST::Client.new(platform: 'ps4')
-    #   client.platform # => 'ps4'
-    #   client.language # => 'en'
-    #
-    # == Accepted Languages
-    #
-    #   default = 'en'
-    #   all_languages = [ 'de', 'es', 'en', 'fr', 'it', 'ko', 'pl', 'pt', 'ru', 'zh' ]
-    #
-    #   client = Warframe::REST::Client.new(language: 'fr')
-    #   client.language # => 'fr'
-    #   client.platform # => 'pc'
-    #
-    # == Setting both Platform and Language
-    #
-    #   client = Warframe::REST::Client.new(platform: 'ps4', language: 'de')
-    #   client.platform # => 'ps4'
-    #   client.language # => 'de'
-    class Client < Warframe::ClientWrapper
-      include Warframe::REST::API
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'warframe/client_wrapper'
+require_relative './api'
+
+module Warframe
+  module REST
+    # The main application Client for access live feed data.
+    #
+    # == Example Usage
+    #
+    #   client = Warframe::REST::Client.new
+    #   client.nightwave.tag # => 'Radio Legion Intermission'
+    #
+    # == Accepted Platforms
+    #
+    #   default = 'pc'
+    #   all_platorms = [ 'pc', 'ps4', 'xb1', 'swi' ]
+    #
+    #   client = Waframe::REST::Client.new(platform: 'ps4')
+    #   client.platform # => 'ps4'
+    #   client.language # => 'en'
+    #
+    # == Accepted Languages
+    #
+    #   default = 'en'
+    #   all_languages = [ 'de', 'es', 'en', 'fr', 'it', 'ko', 'pl', 'pt', 'ru', 'zh' ]
+    #
+    #   client = Warframe::REST::Client.new(language: 'fr')
+    #   client.language # => 'fr'
+    #   client.platform # => 'pc'
+    #
+    # == Setting both Platform and Language
+    #
+    #   client = Warframe::REST::Client.new(platform: 'ps4', language: 'de')
+    #   client.platform # => 'ps4'
+    #   client.language # => 'de'
+    class Client < Warframe::ClientWrapper
+      include Warframe::REST::API
+    end
+  end
+end