warframe 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +3 -3
  3. data/README.md +99 -93
  4. data/lib/warframe/cache.rb +37 -37
  5. data/lib/warframe/client_wrapper.rb +39 -39
  6. data/lib/warframe/models/alert.rb +30 -30
  7. data/lib/warframe/models/attributes/active.rb +31 -31
  8. data/lib/warframe/models/attributes/description.rb +21 -21
  9. data/lib/warframe/models/attributes/eta.rb +14 -14
  10. data/lib/warframe/models/attributes/expiry.rb +30 -30
  11. data/lib/warframe/models/attributes/id.rb +14 -14
  12. data/lib/warframe/models/attributes/reward_types.rb +14 -14
  13. data/lib/warframe/models/attributes/start_string.rb +14 -14
  14. data/lib/warframe/models/attributes/translations.rb +18 -18
  15. data/lib/warframe/models/base.rb +36 -36
  16. data/lib/warframe/models/cambion_drift.rb +26 -26
  17. data/lib/warframe/models/cetus.rb +40 -40
  18. data/lib/warframe/models/conclave_challenge.rb +54 -54
  19. data/lib/warframe/models/global_upgrade.rb +41 -41
  20. data/lib/warframe/models/invasion.rb +71 -71
  21. data/lib/warframe/models/news.rb +54 -54
  22. data/lib/warframe/models/nightwave.rb +40 -40
  23. data/lib/warframe/models/sortie.rb +36 -36
  24. data/lib/warframe/models/steel_path.rb +34 -34
  25. data/lib/warframe/models/syndicate_mission.rb +32 -32
  26. data/lib/warframe/rest/api/alerts.rb +23 -23
  27. data/lib/warframe/rest/api/cambion_drift.rb +23 -23
  28. data/lib/warframe/rest/api/cetus.rb +23 -23
  29. data/lib/warframe/rest/api/conclave_challenges.rb +23 -23
  30. data/lib/warframe/rest/api/global_upgrades.rb +23 -23
  31. data/lib/warframe/rest/api/invasions.rb +23 -23
  32. data/lib/warframe/rest/api/news.rb +23 -23
  33. data/lib/warframe/rest/api/nightwave.rb +23 -23
  34. data/lib/warframe/rest/api/sortie.rb +23 -23
  35. data/lib/warframe/rest/api/steel_path.rb +23 -23
  36. data/lib/warframe/rest/api/syndicate_missions.rb +23 -23
  37. data/lib/warframe/rest/api.rb +37 -37
  38. data/lib/warframe/rest/client.rb +42 -42
  39. data/lib/warframe/rest/request.rb +61 -61
  40. data/lib/warframe/rest/utils.rb +23 -23
  41. data/lib/warframe/version.rb +6 -6
  42. data/lib/warframe.rb +7 -7
  43. metadata +14 -43
@@ -1,54 +1,54 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative './base'
4
- require_relative './attributes/translations'
5
- require_relative './attributes/eta'
6
- require_relative './attributes/id'
7
-
8
- module Warframe
9
- module Models
10
- # News data model.
11
- # {https://api.warframestat.us/pc/news /:platform/news}
12
- class News < Warframe::Models::Base
13
- include Warframe::Models::Attributes::Translations
14
- include Warframe::Models::Attributes::ETA
15
- include Warframe::Models::Attributes::ID
16
-
17
- # The date the news was released.
18
- # @return [String]
19
- attr_reader :date
20
-
21
- # The image link from the news page.
22
- # @return [String]
23
- attr_reader :image_link
24
-
25
- # Link for more information on this news.
26
- # @return [String]
27
- attr_reader :link
28
-
29
- # Whether or not the news has to do with Prime Access.
30
- # @return [Boolean]
31
- attr_reader :prime_access
32
- alias prime_access? prime_access
33
-
34
- # Whether or not a DEV stream is available.
35
- # @return [Boolean]
36
- attr_reader :stream
37
- alias stream? stream
38
-
39
- # Whether or not this news is regarding an update.
40
- # @return [Boolean]
41
- attr_reader :update
42
- alias update? update
43
-
44
- # Whether or not this news is of priority.
45
- # @return [Boolean]
46
- attr_reader :priority
47
- alias priority? priority
48
-
49
- # The entire response as a long string.
50
- # @return [String]
51
- attr_reader :as_string
52
- end
53
- end
54
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative './base'
4
+ require_relative './attributes/translations'
5
+ require_relative './attributes/eta'
6
+ require_relative './attributes/id'
7
+
8
+ module Warframe
9
+ module Models
10
+ # News data model.
11
+ # {https://api.warframestat.us/pc/news /:platform/news}
12
+ class News < Warframe::Models::Base
13
+ include Warframe::Models::Attributes::Translations
14
+ include Warframe::Models::Attributes::ETA
15
+ include Warframe::Models::Attributes::ID
16
+
17
+ # The date the news was released.
18
+ # @return [String]
19
+ attr_reader :date
20
+
21
+ # The image link from the news page.
22
+ # @return [String]
23
+ attr_reader :image_link
24
+
25
+ # Link for more information on this news.
26
+ # @return [String]
27
+ attr_reader :link
28
+
29
+ # Whether or not the news has to do with Prime Access.
30
+ # @return [Boolean]
31
+ attr_reader :prime_access
32
+ alias prime_access? prime_access
33
+
34
+ # Whether or not a DEV stream is available.
35
+ # @return [Boolean]
36
+ attr_reader :stream
37
+ alias stream? stream
38
+
39
+ # Whether or not this news is regarding an update.
40
+ # @return [Boolean]
41
+ attr_reader :update
42
+ alias update? update
43
+
44
+ # Whether or not this news is of priority.
45
+ # @return [Boolean]
46
+ attr_reader :priority
47
+ alias priority? priority
48
+
49
+ # The entire response as a long string.
50
+ # @return [String]
51
+ attr_reader :as_string
52
+ end
53
+ end
54
+ end
@@ -1,40 +1,40 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative './base'
4
- require_relative './attributes/active'
5
- require_relative './attributes/id'
6
- require_relative './attributes/expiry'
7
- require_relative './attributes/reward_types'
8
-
9
- module Warframe
10
- module Models
11
- # Nightwave data model.
12
- # {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
13
- class Nightwave < Warframe::Models::Base
14
- include Warframe::Models::Attributes::Activation
15
- include Warframe::Models::Attributes::ID
16
- include Warframe::Models::Attributes::Expiry
17
- include Warframe::Models::Attributes::RewardTypes
18
-
19
- # The current phase of this event.
20
- # @return [Integer]
21
- attr_reader :phase
22
-
23
- # The current Nightwave Tag
24
- # @return [String]
25
- attr_reader :tag
26
-
27
- # The current Nightwave Season
28
- # @return [Integer]
29
- attr_reader :season
30
-
31
- # List of all possible challenges.
32
- # @return [Array<OpenStruct>]
33
- attr_reader :possible_challenges
34
-
35
- # Active Challenges for this event.
36
- # @return [Array<OpenStruct>]
37
- attr_reader :active_challenges
38
- end
39
- end
40
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative './base'
4
+ require_relative './attributes/active'
5
+ require_relative './attributes/id'
6
+ require_relative './attributes/expiry'
7
+ require_relative './attributes/reward_types'
8
+
9
+ module Warframe
10
+ module Models
11
+ # Nightwave data model.
12
+ # {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
13
+ class Nightwave < Warframe::Models::Base
14
+ include Warframe::Models::Attributes::Activation
15
+ include Warframe::Models::Attributes::ID
16
+ include Warframe::Models::Attributes::Expiry
17
+ include Warframe::Models::Attributes::RewardTypes
18
+
19
+ # The current phase of this event.
20
+ # @return [Integer]
21
+ attr_reader :phase
22
+
23
+ # The current Nightwave Tag
24
+ # @return [String]
25
+ attr_reader :tag
26
+
27
+ # The current Nightwave Season
28
+ # @return [Integer]
29
+ attr_reader :season
30
+
31
+ # List of all possible challenges.
32
+ # @return [Array<OpenStruct>]
33
+ attr_reader :possible_challenges
34
+
35
+ # Active Challenges for this event.
36
+ # @return [Array<OpenStruct>]
37
+ attr_reader :active_challenges
38
+ end
39
+ end
40
+ end
@@ -1,36 +1,36 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative './base'
4
- require_relative 'attributes/id'
5
- require_relative 'attributes/expiry'
6
- require_relative 'attributes/active'
7
- require_relative 'attributes/eta'
8
-
9
- module Warframe
10
- module Models
11
- # Sortie data model.
12
- # {https://api.warframestat.us/pc/sortie /:platform/sortie}
13
- class Sortie < Warframe::Models::Base
14
- include Warframe::Models::Attributes::ID
15
- include Warframe::Models::Attributes::ActiveBoth
16
- include Warframe::Models::Attributes::Expiration
17
- include Warframe::Models::Attributes::ETA
18
-
19
- # The boss for this part of the sortie.
20
- # @return [String]
21
- attr_reader :boss
22
-
23
- # The faction fighting you in this mission.
24
- # @return [String]
25
- attr_reader :faction
26
-
27
- # Modifiers active for this challenge.
28
- # @return [Array<OpenStruct>]
29
- attr_reader :variants
30
-
31
- # The reward pool which this is pulling from.
32
- # @return [String]
33
- attr_reader :reward_pool
34
- end
35
- end
36
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative './base'
4
+ require_relative 'attributes/id'
5
+ require_relative 'attributes/expiry'
6
+ require_relative 'attributes/active'
7
+ require_relative 'attributes/eta'
8
+
9
+ module Warframe
10
+ module Models
11
+ # Sortie data model.
12
+ # {https://api.warframestat.us/pc/sortie /:platform/sortie}
13
+ class Sortie < Warframe::Models::Base
14
+ include Warframe::Models::Attributes::ID
15
+ include Warframe::Models::Attributes::ActiveBoth
16
+ include Warframe::Models::Attributes::Expiration
17
+ include Warframe::Models::Attributes::ETA
18
+
19
+ # The boss for this part of the sortie.
20
+ # @return [String]
21
+ attr_reader :boss
22
+
23
+ # The faction fighting you in this mission.
24
+ # @return [String]
25
+ attr_reader :faction
26
+
27
+ # Modifiers active for this challenge.
28
+ # @return [Array<OpenStruct>]
29
+ attr_reader :variants
30
+
31
+ # The reward pool which this is pulling from.
32
+ # @return [String]
33
+ attr_reader :reward_pool
34
+ end
35
+ end
36
+ end
@@ -1,34 +1,34 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative './base'
4
-
5
- module Warframe
6
- module Models
7
- # SteelPath data model.
8
- # {https://api.warframestat.us/pc/steelPath /:platform/steelPath}
9
- class SteelPath < Warframe::Models::Base
10
- include Warframe::Models::Attributes::Active
11
- include Warframe::Models::Attributes::Expiry
12
-
13
- # The currently available item from Teshin.
14
- # @return [OpenStruct]
15
- attr_reader :current_reward
16
-
17
- # The time remaining of the current reward.
18
- # @return [String]
19
- attr_reader :remaining
20
-
21
- # Current rotation of items the Arbiters have to offer.
22
- # @return [Array<OpenStruct>]
23
- attr_reader :rotation
24
-
25
- # Current rotation of items Teshin has to offer.
26
- # @return [Array<OpenStruct>]
27
- attr_reader :evergreens
28
-
29
- # Current incursion data
30
- # @return [OpenStruct]
31
- attr_reader :incursions
32
- end
33
- end
34
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative './base'
4
+
5
+ module Warframe
6
+ module Models
7
+ # SteelPath data model.
8
+ # {https://api.warframestat.us/pc/steelPath /:platform/steelPath}
9
+ class SteelPath < Warframe::Models::Base
10
+ include Warframe::Models::Attributes::Active
11
+ include Warframe::Models::Attributes::Expiry
12
+
13
+ # The currently available item from Teshin.
14
+ # @return [OpenStruct]
15
+ attr_reader :current_reward
16
+
17
+ # The time remaining of the current reward.
18
+ # @return [String]
19
+ attr_reader :remaining
20
+
21
+ # Current rotation of items the Arbiters have to offer.
22
+ # @return [Array<OpenStruct>]
23
+ attr_reader :rotation
24
+
25
+ # Current rotation of items Teshin has to offer.
26
+ # @return [Array<OpenStruct>]
27
+ attr_reader :evergreens
28
+
29
+ # Current incursion data
30
+ # @return [OpenStruct]
31
+ attr_reader :incursions
32
+ end
33
+ end
34
+ end
@@ -1,32 +1,32 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative './base'
4
- require_relative 'attributes/eta'
5
- require_relative 'attributes/id'
6
- require_relative 'attributes/active'
7
- require_relative 'attributes/start_string'
8
-
9
- module Warframe
10
- module Models
11
- # SyndicateMission data model.
12
- # {https://api.warframestat.us/pc/syndicateMissions /:platform/syndicateMissions}
13
- class SyndicateMission < Warframe::Models::Base
14
- include Warframe::Models::Attributes::ETA
15
- include Warframe::Models::Attributes::ID
16
- include Warframe::Models::Attributes::ActiveBoth
17
- include Warframe::Models::Attributes::StartString
18
-
19
- # 'Jobs' or challenges currently available.
20
- # @return [Array<OpenStruct>]
21
- attr_reader :jobs
22
-
23
- # The syndicate you will be fighting.
24
- # @return [String]
25
- attr_reader :syndicate
26
-
27
- # The nodes that this mission is available on.
28
- # @return [Array]
29
- attr_reader :nodes
30
- end
31
- end
32
- end
1
+ # frozen_string_literal: true
2
+
3
+ require_relative './base'
4
+ require_relative 'attributes/eta'
5
+ require_relative 'attributes/id'
6
+ require_relative 'attributes/active'
7
+ require_relative 'attributes/start_string'
8
+
9
+ module Warframe
10
+ module Models
11
+ # SyndicateMission data model.
12
+ # {https://api.warframestat.us/pc/syndicateMissions /:platform/syndicateMissions}
13
+ class SyndicateMission < Warframe::Models::Base
14
+ include Warframe::Models::Attributes::ETA
15
+ include Warframe::Models::Attributes::ID
16
+ include Warframe::Models::Attributes::ActiveBoth
17
+ include Warframe::Models::Attributes::StartString
18
+
19
+ # 'Jobs' or challenges currently available.
20
+ # @return [Array<OpenStruct>]
21
+ attr_reader :jobs
22
+
23
+ # The syndicate you will be fighting.
24
+ # @return [String]
25
+ attr_reader :syndicate
26
+
27
+ # The nodes that this mission is available on.
28
+ # @return [Array]
29
+ attr_reader :nodes
30
+ end
31
+ end
32
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- require 'warframe/models/alert'
4
- require_relative '../utils'
5
-
6
- module Warframe
7
- module REST
8
- module API
9
- # API endpoint for getting information on current Alerts data.
10
- #
11
- # {https://api.warframestat.us/pc/alerts Example Response}
12
- module Alerts
13
- include Warframe::REST::Utils
14
-
15
- # Gets the current Alerts data.
16
- # @return [Array<[Warframe::Models::Alert]>]
17
- def alerts
18
- get('/alerts', Warframe::Models::Alert)
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'warframe/models/alert'
4
+ require_relative '../utils'
5
+
6
+ module Warframe
7
+ module REST
8
+ module API
9
+ # API endpoint for getting information on current Alerts data.
10
+ #
11
+ # {https://api.warframestat.us/pc/alerts Example Response}
12
+ module Alerts
13
+ include Warframe::REST::Utils
14
+
15
+ # Gets the current Alerts data.
16
+ # @return [Array<[Warframe::Models::Alert]>]
17
+ def alerts
18
+ get('/alerts', Warframe::Models::Alert)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- require 'warframe/models/cambion_drift'
4
- require_relative '../utils'
5
-
6
- module Warframe
7
- module REST
8
- module API
9
- # API endpoint for getting information on current Cambion Drift data.
10
- #
11
- # {https://api.warframestat.us/pc/cambionDrift Example Response}
12
- module CambionDrift
13
- include Warframe::REST::Utils
14
-
15
- # Gets the current cambionDrift Data.
16
- # @return Warframe::Models::CambionDrift
17
- def cambion_drift
18
- get('/cambionCycle', Warframe::Models::CambionDrift)
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'warframe/models/cambion_drift'
4
+ require_relative '../utils'
5
+
6
+ module Warframe
7
+ module REST
8
+ module API
9
+ # API endpoint for getting information on current Cambion Drift data.
10
+ #
11
+ # {https://api.warframestat.us/pc/cambionDrift Example Response}
12
+ module CambionDrift
13
+ include Warframe::REST::Utils
14
+
15
+ # Gets the current cambionDrift Data.
16
+ # @return Warframe::Models::CambionDrift
17
+ def cambion_drift
18
+ get('/cambionCycle', Warframe::Models::CambionDrift)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- require 'warframe/models/cetus'
4
- require_relative '../utils'
5
-
6
- module Warframe
7
- module REST
8
- module API
9
- # API endpoint for getting information on current Cetus data.
10
- #
11
- # {https://api.warframestat.us/pc/cetusCycle Example Response}
12
- module Cetus
13
- include Warframe::REST::Utils
14
-
15
- # Gets the current cetusCycle Data.
16
- # @return [Warframe::Models::Cetus]
17
- def cetus
18
- get('/cetusCycle', Warframe::Models::Cetus)
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'warframe/models/cetus'
4
+ require_relative '../utils'
5
+
6
+ module Warframe
7
+ module REST
8
+ module API
9
+ # API endpoint for getting information on current Cetus data.
10
+ #
11
+ # {https://api.warframestat.us/pc/cetusCycle Example Response}
12
+ module Cetus
13
+ include Warframe::REST::Utils
14
+
15
+ # Gets the current cetusCycle Data.
16
+ # @return [Warframe::Models::Cetus]
17
+ def cetus
18
+ get('/cetusCycle', Warframe::Models::Cetus)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- require 'warframe/models/conclave_challenge'
4
- require_relative '../utils'
5
-
6
- module Warframe
7
- module REST
8
- module API
9
- # API endpoint for getting information on current Conclave Challenge data.
10
- #
11
- # {https://api.warframestat.us/pc/conclaveChallenges Example Response}
12
- module ConclaveChallenges
13
- include Warframe::REST::Utils
14
-
15
- # Gets the current conclave challenges.
16
- # @return [Array<Warframe::Models::ConclaveChallenge>]
17
- def conclave_challenges
18
- get('/conclaveChallenges', Warframe::Models::ConclaveChallenge)
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'warframe/models/conclave_challenge'
4
+ require_relative '../utils'
5
+
6
+ module Warframe
7
+ module REST
8
+ module API
9
+ # API endpoint for getting information on current Conclave Challenge data.
10
+ #
11
+ # {https://api.warframestat.us/pc/conclaveChallenges Example Response}
12
+ module ConclaveChallenges
13
+ include Warframe::REST::Utils
14
+
15
+ # Gets the current conclave challenges.
16
+ # @return [Array<Warframe::Models::ConclaveChallenge>]
17
+ def conclave_challenges
18
+ get('/conclaveChallenges', Warframe::Models::ConclaveChallenge)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end
@@ -1,23 +1,23 @@
1
- # frozen_string_literal: true
2
-
3
- require 'warframe/models/global_upgrade'
4
- require_relative '../utils'
5
-
6
- module Warframe
7
- module REST
8
- module API
9
- # API endpoint for getting information on current Global Upgrades data.
10
- #
11
- # {https://api.warframestat.us/pc/globalUpgrades Example Response}
12
- module GlobalUpgrades
13
- include Warframe::REST::Utils
14
-
15
- # Gets the current Global Upgrades data.
16
- # @return [Array<[Warframe::Models::GlobalUpgrade]>]
17
- def global_upgrades
18
- get('/globalUpgrades', Warframe::Models::GlobalUpgrade)
19
- end
20
- end
21
- end
22
- end
23
- end
1
+ # frozen_string_literal: true
2
+
3
+ require 'warframe/models/global_upgrade'
4
+ require_relative '../utils'
5
+
6
+ module Warframe
7
+ module REST
8
+ module API
9
+ # API endpoint for getting information on current Global Upgrades data.
10
+ #
11
+ # {https://api.warframestat.us/pc/globalUpgrades Example Response}
12
+ module GlobalUpgrades
13
+ include Warframe::REST::Utils
14
+
15
+ # Gets the current Global Upgrades data.
16
+ # @return [Array<[Warframe::Models::GlobalUpgrade]>]
17
+ def global_upgrades
18
+ get('/globalUpgrades', Warframe::Models::GlobalUpgrade)
19
+ end
20
+ end
21
+ end
22
+ end
23
+ end