warframe 0.3.0 → 0.3.1

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

@@ -1,23 +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
+# 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

@@ -1,23 +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
+# 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

@@ -1,23 +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
+# 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,37 +1,37 @@
-# 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
+# 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

data/lib/warframe/rest/request.rb

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-require 'net/http'
-require 'json'
-
-module Warframe
-  module REST
-    # A request to send to the Warframe Stat API.
-    class Request
-      # @return [Warframe::REST::Client]
-      attr_reader :client
-
-      # @return [String]
-      attr_reader :path
-
-      # Instantiate a Request
-      #
-      # @param client [Warframe::REST::Client]
-      # @param path [String]
-      # @param klass [Warframe::Models]
-      # @return [Warframe:REST:Request]
-      def initialize(client, path, klass)
-        @client = client
-        @route = path
-        @path = client.base_url + path + "?language=#{@client.language}"
-        @klass = klass
-      end
-
-      # Sends an HTTP request with the attached parameters and headers.
-      # Will either return the Model, or collection of Models.
-      # @return [Warframe::Models, Array<[Warframe::Models]>]
-      def send
-        uri = URI(path)
-        req = Net::HTTP::Get.new(uri)
-        resp = get_response uri, req
-        return_parsed resp
-      end
-
-      private
-
-      # Returns the parsed JSON response in the form of a [Warframe::Models] or an array of [Warframe::Models]
-      # @param resp [Net::HTTP.get]
-      # @return [Warframe::Models, Array<[Warframe::Models]>]
-      def return_parsed(resp)
-        parsed = JSON.parse(resp)
-
-        # Return Empty array if no data found.
-        return [] if parsed.is_a?(Array) && parsed.empty?
-
-        @klass.new parsed
-      end
-
-      def get_response(uri, req)
-        Net::HTTP.get(uri) do |http|
-          http.use_ssl = true
-          http.request req
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+
+module Warframe
+  module REST
+    # A request to send to the Warframe Stat API.
+    class Request
+      # @return [Warframe::REST::Client]
+      attr_reader :client
+
+      # @return [String]
+      attr_reader :path
+
+      # Instantiate a Request
+      #
+      # @param client [Warframe::REST::Client]
+      # @param path [String]
+      # @param klass [Warframe::Models]
+      # @return [Warframe:REST:Request]
+      def initialize(client, path, klass)
+        @client = client
+        @route = path
+        @path = client.base_url + path + "?language=#{@client.language}"
+        @klass = klass
+      end
+
+      # Sends an HTTP request with the attached parameters and headers.
+      # Will either return the Model, or collection of Models.
+      # @return [Warframe::Models, Array<[Warframe::Models]>]
+      def send
+        uri = URI(path)
+        req = Net::HTTP::Get.new(uri)
+        resp = get_response uri, req
+        return_parsed resp
+      end
+
+      private
+
+      # Returns the parsed JSON response in the form of a [Warframe::Models] or an array of [Warframe::Models]
+      # @param resp [Net::HTTP.get]
+      # @return [Warframe::Models, Array<[Warframe::Models]>]
+      def return_parsed(resp)
+        parsed = JSON.parse(resp)
+
+        # Return Empty array if no data found.
+        return [] if parsed.is_a?(Array) && parsed.empty?
+
+        @klass.new parsed
+      end
+
+      def get_response(uri, req)
+        Net::HTTP.get(uri) do |http|
+          http.use_ssl = true
+          http.request req
+        end
+      end
+    end
+  end
+end

data/lib/warframe/rest/utils.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-require_relative './request'
-
-module Warframe
-  module REST
-    # Private REST Utilities
-    module Utils
-      private
-
-      # Performs a get operation on the requested path, and returns a mapped response of the requested model.
-      # @param path [String]
-      # @param klass [Warframe::Models]
-      def get(path, klass)
-        inst = @client || self
-        return inst.get_from_cache(path) if inst.find_in_cache(path)
-
-        result = Warframe::REST::Request.new(inst, path, klass).send
-        inst.add_to_cache(path, result)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative './request'
+
+module Warframe
+  module REST
+    # Private REST Utilities
+    module Utils
+      private
+
+      # Performs a get operation on the requested path, and returns a mapped response of the requested model.
+      # @param path [String]
+      # @param klass [Warframe::Models]
+      def get(path, klass)
+        inst = @client || self
+        return inst.get_from_cache(path) if inst.find_in_cache(path)
+
+        result = Warframe::REST::Request.new(inst, path, klass).send
+        inst.add_to_cache(path, result)
+      end
+    end
+  end
+end

data/lib/warframe/version.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-module Warframe
-  # The current version of this gem.
-  VERSION = '0.3.0'
-end
+# frozen_string_literal: true
+
+module Warframe
+  # The current version of this gem.
+  VERSION = '0.3.1'
+end

data/lib/warframe.rb

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-
-require 'warframe/version'
-require 'warframe/rest/client'
-
-# Warframe Stat Ruby Client main module
-module Warframe; end
+# frozen_string_literal: true
+
+require 'warframe/version'
+require 'warframe/rest/client'
+
+# Warframe Stat Ruby Client main module
+module Warframe; end