warframe 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388d0677f507123464a3fe14a9f95c281012be81a1384f38b48d5da3e42b4cc0
-  data.tar.gz: c0777beb4ad16128159da5096f0baca39be67242ddd2ee70cb5dc60afb3ffb77
+  metadata.gz: 5fbb7e4ec10b0e0025f2a7270e2c29dd709999cba7658aaea54a21fd3be00947
+  data.tar.gz: 0477ac222872fc1409b196c25b570264b1a828fedf72590e9edf75bceca63464
 SHA512:
-  metadata.gz: 26368cf03ac61bd44356f739696c220402a6753725bd616d4454874fdfc45bec3769f42ab102332ed3bcf7f561a7540bf9a9d4b70df5376b5bb299d08f90c213
-  data.tar.gz: 107dcc6d59d1860b21b4bfb0f1ca8d8c217e57e55840b48dd5a0ca42d252fed412b283dfa9283c70043d1eae1d6d834070ea122a1265e07588ab63e2be6b4589
+  metadata.gz: 3365b0ea6f6d4d24a5504a9ae3d9245b2dd7fe4aa25a9a8975fd3e93c82fd3e3401aa56968fa5590c3873f3ca0097748d62b8764b2d4f100aa2db8a2d37a501f
+  data.tar.gz: 140f505cae2155b0666d8335734818ed46a9becf42eafe77e6034dcb47d3f07311b6989e69bcd788764021855331030385225589792b655db6391e7dd43c68b2

data/README.md

@@ -66,6 +66,28 @@ To auto-correct styling offenses, run:
 
 > All linting is provided by [RuboCop](https://github.com/rubocop/rubocop).
 
+### Generating New Routes / Models with Thor
+Using Thor allows us to create new routes and models via the command line, making it very simple to add new elements.
+
+For example if we wanted to add, [conclaveChallenges](https://docs.warframestat.us/#tag/Worldstate/paths/~1{platform}~1conclaveChallenges/get) we run:
+
+    $ thor generate conclaveChallenges 
+    
+    >       create  lib/warframe/models/conclave_challenge.rb
+    >       create  lib/warframe/rest/api/conclave_challenges.rb
+    >       conflict  lib/warframe/rest/api.rb
+    > Overwrite C:/Users/ajrom/RubymineProjects/warframe/lib/warframe/rest/api.rb? (enter "h" for help) [Ynaqdh] 
+    
+    $ Y
+    
+    >       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).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/aj-rom/warframe-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aj-rom/warframe-ruby/blob/master/CODE_OF_CONDUCT.md).

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

@@ -3,11 +3,18 @@
 module Warframe
   module Models
     module Attributes
-      # Includes the desc attribute.
+      # Includes the desc attribute
+      module Desc
+        # The description of the data requested
+        # @return [String]
+        attr_reader :desc
+      end
+
+      # Includes the description attribute.
       module Description
         # The description of the data requested.
         # @return [String]
-        attr_reader :desc
+        attr_reader :description
       end
     end
   end

data/lib/warframe/models/conclave_challenge.rb

@@ -0,0 +1,54 @@
+# 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
+    # Model for ConclaveChallenge Data
+    # {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
+  end
+end

data/lib/warframe/models/global_upgrade.rb

@@ -9,7 +9,7 @@ module Warframe
     # Global Upgrades data model.
     class GlobalUpgrade < Warframe::Models::Base
       include Warframe::Models::Attributes::Expired
-      include Warframe::Models::Attributes::Description
+      include Warframe::Models::Attributes::Desc
       include Warframe::Models::Attributes::ETA
 
       # The start of the global upgrade.

data/lib/warframe/models/sortie.rb

@@ -0,0 +1,35 @@
+# 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
+    # Model for Sortie Data {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::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,33 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Warframe
+  module Models
+    # Model for SteelPath Data {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,31 @@
+# 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
+    # Model for SyndicateMission Data {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/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 ConclaveChallenge 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/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,10 +1,14 @@
 # frozen_string_literal: true
 
 require_relative 'api/alerts'
+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
@@ -16,10 +20,14 @@ 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::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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warframe
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - A.J. Romaniello
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_underscore
@@ -207,16 +207,24 @@ files:
 - lib/warframe/models/attributes/start_string.rb
 - lib/warframe/models/attributes/translations.rb
 - lib/warframe/models/base.rb
+- lib/warframe/models/conclave_challenge.rb
 - lib/warframe/models/global_upgrade.rb
 - lib/warframe/models/invasion.rb
 - lib/warframe/models/news.rb
 - lib/warframe/models/nightwave.rb
+- lib/warframe/models/sortie.rb
+- lib/warframe/models/steel_path.rb
+- lib/warframe/models/syndicate_mission.rb
 - lib/warframe/rest/api.rb
 - lib/warframe/rest/api/alerts.rb
+- lib/warframe/rest/api/conclave_challenges.rb
 - lib/warframe/rest/api/global_upgrades.rb
 - lib/warframe/rest/api/invasions.rb
 - lib/warframe/rest/api/news.rb
 - lib/warframe/rest/api/nightwave.rb
+- lib/warframe/rest/api/sortie.rb
+- lib/warframe/rest/api/steel_path.rb
+- lib/warframe/rest/api/syndicate_missions.rb
 - lib/warframe/rest/client.rb
 - lib/warframe/rest/request.rb
 - lib/warframe/rest/utils.rb