warframe 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fbb7e4ec10b0e0025f2a7270e2c29dd709999cba7658aaea54a21fd3be00947
-  data.tar.gz: 0477ac222872fc1409b196c25b570264b1a828fedf72590e9edf75bceca63464
+  metadata.gz: 064d0649ace9ff7b79f1beaa548ac113c1e8b4b1067d102c628f18b20d7b868a
+  data.tar.gz: 1f003893b70c4649472ca7643fb596bd112492641b30d96bfc22cc4b86db48cc
 SHA512:
-  metadata.gz: 3365b0ea6f6d4d24a5504a9ae3d9245b2dd7fe4aa25a9a8975fd3e93c82fd3e3401aa56968fa5590c3873f3ca0097748d62b8764b2d4f100aa2db8a2d37a501f
-  data.tar.gz: 140f505cae2155b0666d8335734818ed46a9becf42eafe77e6034dcb47d3f07311b6989e69bcd788764021855331030385225589792b655db6391e7dd43c68b2
+  metadata.gz: 24e0ff2c60f49fbd6e6234c517a75c2c005253f1c460e7fef99b0e488680d265f641009afe52cd5503551df99e1f0cacc4009d72e79aafb0726a7120f5d73b79
+  data.tar.gz: 20168043a6f49861b071e03305b416e87d1752d305827532ff8080477116bf8b8ec5400bc463a515fc40681a2a836151b199d4fe3e8d3c789c45eeee4a537563

data/README.md

@@ -55,14 +55,14 @@ After checking out the repo, run `bundle install` to install required dependenci
 ### Testing
 To check if your changes are passing tests, run:
 
-    $ rake test
+    $ thor test:rspec
 
 > Testing framework provided by [RSpec](https://rspec.info/).
 
 ### Linting
 To auto-correct styling offenses, run: 
 
-    $ rake lint
+    $ thor style:fix
 
 > All linting is provided by [RuboCop](https://github.com/rubocop/rubocop).
 
@@ -82,11 +82,7 @@ For example if we wanted to add, [conclaveChallenges](https://docs.warframestat.
     
     >       force  lib/warframe/rest/api.rb
 
-This creates a blank [model](/lib/warframe/models) for the data and a [route](/lib/warframe/rest/api) with a name spaced method for it, and then adds this method to our [REST::API](/lib/warframe/rest/api). Add attributes to the corresponding model and then run:
-
-    $ rake test
-    
-To ensure the new model is able to be created and accessed correctly, feel free to create more tests in the [spec directory](/spec/models).
+This creates a blank [model](/lib/warframe/models) for the data and a [route](/lib/warframe/rest/api) with a name spaced method for it, and then adds this method to our [REST::API](/lib/warframe/rest/api). Add attributes to the corresponding model and then write associated tests.
 
 ## Contributing
 

data/lib/warframe/models/alert.rb

@@ -9,7 +9,8 @@ require_relative './attributes/start_string'
 
 module Warframe
   module Models
-    # Model for World State data {https://api.warframestat.hub/pc/alerts /:platform/alerts}
+    # Model for Alert data.
+    # {https://api.warframestat.hub/pc/alerts /:platform/alerts}
     class Alert < Warframe::Models::Base
       include Warframe::Models::Attributes::Expired
       include Warframe::Models::Attributes::Active

data/lib/warframe/models/cambion_drift.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative 'attributes/id'
+require_relative 'attributes/expiry'
+require_relative 'attributes/active'
+
+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
+
+      # 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
+  end
+end

data/lib/warframe/models/cetus.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative 'attributes/id'
+require_relative 'attributes/active'
+require_relative 'attributes/expiry'
+
+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
+
+      # 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
+
+      # 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
+
+      # A short string of the time left until state change.
+      # @return [String]
+      attr_reader :short_string
+    end
+  end
+end

data/lib/warframe/models/conclave_challenge.rb

@@ -9,7 +9,7 @@ require_relative 'attributes/active'
 
 module Warframe
   module Models
-    # Model for ConclaveChallenge Data
+    # Conclave Challenges data model.
     # {https://api.warframestat.us/pc/conclaveChallenges /:platform/conclaveChallenges}
     class ConclaveChallenge < Warframe::Models::Base
       include Warframe::Models::Attributes::Expiration

data/lib/warframe/models/global_upgrade.rb

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

data/lib/warframe/models/invasion.rb

@@ -12,6 +12,7 @@ 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

data/lib/warframe/models/news.rb

@@ -7,7 +7,8 @@ require_relative './attributes/id'
 
 module Warframe
   module Models
-    # Model for the response of {https://api.warframestat.us/pc/news /:platform/news}
+    # News data model.
+    # {https://api.warframestat.us/pc/news /:platform/news}
     class News < Warframe::Models::Base
       include Warframe::Models::Attributes::Translations
       include Warframe::Models::Attributes::ETA

data/lib/warframe/models/nightwave.rb

@@ -8,7 +8,8 @@ require_relative './attributes/reward_types'
 
 module Warframe
   module Models
-    # Model for the response of {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
+    # Nightwave data model.
+    # {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
     class Nightwave < Warframe::Models::Base
       include Warframe::Models::Attributes::Activation
       include Warframe::Models::Attributes::ID

data/lib/warframe/models/sortie.rb

@@ -8,10 +8,11 @@ require_relative 'attributes/eta'
 
 module Warframe
   module Models
-    # Model for Sortie Data {https://api.warframestat.us/pc/sortie> /:platform/sortie}
+    # 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::Activation
+      include Warframe::Models::Attributes::ActiveBoth
       include Warframe::Models::Attributes::Expiration
       include Warframe::Models::Attributes::ETA
 

data/lib/warframe/models/steel_path.rb

@@ -4,7 +4,8 @@ require_relative './base'
 
 module Warframe
   module Models
-    # Model for SteelPath Data {https://api.warframestat.us/pc/steelPath> /:platform/steelPath}
+    # 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

data/lib/warframe/models/syndicate_mission.rb

@@ -8,7 +8,8 @@ require_relative 'attributes/start_string'
 
 module Warframe
   module Models
-    # Model for SyndicateMission Data {https://api.warframestat.us/pc/syndicateMissions> /:platform/syndicateMissions}
+    # 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

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

@@ -6,9 +6,9 @@ require_relative '../utils'
 module Warframe
   module REST
     module API
-      # API endpoint for getting information on current ConclaveChallenge data.
+      # API endpoint for getting information on current Conclave Challenge data.
       #
-      # {https://api.warframestat.us/pc/conclaveChallenges> Example Response}
+      # {https://api.warframestat.us/pc/conclaveChallenges Example Response}
       module ConclaveChallenges
         include Warframe::REST::Utils
 

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

@@ -8,7 +8,7 @@ module Warframe
     module API
       # API endpoint for getting information on current Sortie data.
       #
-      # {https://api.warframestat.us/pc/sortie> Example Response}
+      # {https://api.warframestat.us/pc/sortie Example Response}
       module Sortie
         include Warframe::REST::Utils
 

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

@@ -8,7 +8,7 @@ module Warframe
     module API
       # API endpoint for getting information on current SteelPath data.
       #
-      # {https://api.warframestat.us/pc/steelPath> Example Response}
+      # {https://api.warframestat.us/pc/steelPath Example Response}
       module SteelPath
         include Warframe::REST::Utils
 

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

@@ -8,7 +8,7 @@ module Warframe
     module API
       # API endpoint for getting information on current SyndicateMission data.
       #
-      # {https://api.warframestat.us/pc/syndicateMissions> Example Response}
+      # {https://api.warframestat.us/pc/syndicateMissions Example Response}
       module SyndicateMissions
         include Warframe::REST::Utils
 

data/lib/warframe/rest/api.rb

@@ -1,6 +1,8 @@
 # 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'
@@ -11,7 +13,7 @@ require_relative 'api/steel_path'
 require_relative 'api/syndicate_missions'
 
 module Warframe
-  # A REST-ful API service, provided by https://api.warframestat.us
+  # A REST-ful API service, provided by https://api.warframestat.us.
   module REST
     # The API Router for getting live data.
     #
@@ -20,6 +22,8 @@ module Warframe
     # 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

data/lib/warframe/version.rb

@@ -2,5 +2,5 @@
 
 module Warframe
   # The current version of this gem.
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warframe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - A.J. Romaniello
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_underscore
@@ -104,26 +104,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.31
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +187,8 @@ files:
 - lib/warframe/models/attributes/start_string.rb
 - lib/warframe/models/attributes/translations.rb
 - lib/warframe/models/base.rb
+- lib/warframe/models/cambion_drift.rb
+- lib/warframe/models/cetus.rb
 - lib/warframe/models/conclave_challenge.rb
 - lib/warframe/models/global_upgrade.rb
 - lib/warframe/models/invasion.rb
@@ -217,6 +199,8 @@ files:
 - lib/warframe/models/syndicate_mission.rb
 - lib/warframe/rest/api.rb
 - lib/warframe/rest/api/alerts.rb
+- lib/warframe/rest/api/cambion_drift.rb
+- lib/warframe/rest/api/cetus.rb
 - lib/warframe/rest/api/conclave_challenges.rb
 - lib/warframe/rest/api/global_upgrades.rb
 - lib/warframe/rest/api/invasions.rb