warframe 0.1.0

data/lib/warframe/models/invasion.rb

@@ -0,0 +1,70 @@
+# 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.
+    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
+  end
+end

data/lib/warframe/models/news.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative './attributes/translations'
+require_relative './attributes/eta'
+require_relative './attributes/id'
+
+module Warframe
+  module Models
+    # Model for the response of {https://api.warframestat.us/pc/news /:platform/news}
+    class News < Warframe::Models::Base
+      include Warframe::Models::Attributes::Translations
+      include Warframe::Models::Attributes::ETA
+      include Warframe::Models::Attributes::ID
+
+      # The date the news was released.
+      # @return [String]
+      attr_reader :date
+
+      # The image link from the news page.
+      # @return [String]
+      attr_reader :image_link
+
+      # Link for more information on this news.
+      # @return [String]
+      attr_reader :link
+
+      # Whether or not the news has to do with Prime Access.
+      # @return [Boolean]
+      attr_reader :prime_access
+      alias prime_access? prime_access
+
+      # Whether or not a DEV stream is available.
+      # @return [Boolean]
+      attr_reader :stream
+      alias stream? stream
+
+      # Whether or not this news is regarding an update.
+      # @return [Boolean]
+      attr_reader :update
+      alias update? update
+
+      # Whether or not this news is of priority.
+      # @return [Boolean]
+      attr_reader :priority
+      alias priority? priority
+
+      # The entire response as a long string.
+      # @return [String]
+      attr_reader :as_string
+    end
+  end
+end

data/lib/warframe/models/nightwave.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative './attributes/active'
+require_relative './attributes/id'
+require_relative './attributes/expiry'
+require_relative './attributes/reward_types'
+
+module Warframe
+  module Models
+    # Model for the response of {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
+    class Nightwave < Warframe::Models::Base
+      include Warframe::Models::Attributes::Activation
+      include Warframe::Models::Attributes::ID
+      include Warframe::Models::Attributes::Expiry
+      include Warframe::Models::Attributes::RewardTypes
+
+      # The current phase of this event.
+      # @return [Integer]
+      attr_reader :phase
+
+      # The current Nightwave Tag
+      # @return [String]
+      attr_reader :tag
+
+      # The current Nightwave Season
+      # @return [Integer]
+      attr_reader :season
+
+      # List of all possible challenges.
+      # @return [Array<OpenStruct>]
+      attr_reader :possible_challenges
+
+      # Active Challenges for this event.
+      # @return [Array<OpenStruct>]
+      attr_reader :active_challenges
+    end
+  end
+end

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

@@ -0,0 +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

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

@@ -0,0 +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

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

@@ -0,0 +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

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

@@ -0,0 +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

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

@@ -0,0 +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

data/lib/warframe/rest/api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'api/nightwave'
+require_relative 'api/news'
+require_relative 'api/alerts'
+require_relative 'api/invasions'
+require_relative 'api/global_upgrades'
+
+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

data/lib/warframe/rest/client.rb

@@ -0,0 +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

data/lib/warframe/rest/request.rb

@@ -0,0 +1,55 @@
+# 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
+        @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)
+        return_parsed get_response uri, req
+      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)
+        @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

@@ -0,0 +1,19 @@
+# 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)
+        Warframe::REST::Request.new(@client || self, path, klass).send
+      end
+    end
+  end
+end

data/lib/warframe/version.rb

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

data/lib/warframe.rb

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

data/warframe.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/warframe/version'
+
+Gem::Specification.new do |spec|
+  # Required
+  spec.name = 'warframe'
+  spec.version = Warframe::VERSION
+  spec.authors = ['A.J. Romaniello']
+
+  # Descriptive
+  spec.summary = 'A Ruby interface to the WarframeStat API.'
+  spec.description = spec.summary
+  spec.license = 'MIT'
+  spec.homepage = 'https://github.com/aj-rom/warframe-ruby'
+
+  # MetaData
+  spec.metadata['source_code_uri'] = 'https://github.com/aj-rom/warframe-ruby'
+  spec.metadata['bug_tracker_uri'] = "#{spec.metadata['source_code_uri']}/issues"
+  spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
+
+  # Executables / Files
+  spec.bindir = 'exe'
+  spec.require_paths = ['lib']
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+
+  # Dependencies
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.add_dependency 'fast_underscore', '~> 0.3.2'
+  spec.add_dependency 'http', '~> 5.0', '>= 5.0.4'
+  spec.add_dependency 'json', '~> 2.6', '>= 2.6.1'
+  spec.add_development_dependency 'activesupport', '~> 5.0', '>= 5.0.0.1'
+  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.2.31'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.22', '>= 1.22.3'
+  spec.add_development_dependency 'yard', '~> 0.9.26'
+end