warframe 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 388d0677f507123464a3fe14a9f95c281012be81a1384f38b48d5da3e42b4cc0
-  data.tar.gz: c0777beb4ad16128159da5096f0baca39be67242ddd2ee70cb5dc60afb3ffb77
+  metadata.gz: d14b695f778a8720be1940cede86886f31104f9d0760ff6fc2ec83c38234fc0d
+  data.tar.gz: 5d06096041b3915849b52d18df667e98c441373fb7fef054d0d9b77aa9117b6a
 SHA512:
-  metadata.gz: 26368cf03ac61bd44356f739696c220402a6753725bd616d4454874fdfc45bec3769f42ab102332ed3bcf7f561a7540bf9a9d4b70df5376b5bb299d08f90c213
-  data.tar.gz: 107dcc6d59d1860b21b4bfb0f1ca8d8c217e57e55840b48dd5a0ca42d252fed412b283dfa9283c70043d1eae1d6d834070ea122a1265e07588ab63e2be6b4589
+  metadata.gz: 924f6fd8fb604b19dbb77a2f9088f3c0e4f2edfe27df2df16dd08fe3fafb4273b89a81feedf512998fc7509c2dcc88c05aa1abe3d84242e48607f4ad4757420b
+  data.tar.gz: a87e8635e2b5983344cea2b6ae92fe16ec378d3f42c431638322034ed732f4b0f8b1c37c0eed2cd749614f641ac0d0bd771d5ce845f16d732341a07a34053bfe

data/.yardopts

@@ -1,4 +1,4 @@
---no-private
---protected
--
+--no-private
+--protected
+-
 README.md

data/README.md

@@ -1,75 +1,99 @@
-# warframe-ruby
-[![Ruby Gem Version](https://badgen.net/rubygems/v/warframe)](https://rubygems.org/gems/warframe)
-[![Downloads](https://badgen.net/rubygems/dt/warframe)](https://rubygems.org/gems/warframe)
-[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
-[![Platform](https://badgen.net/rubygems/p/warframe)](https://www.ruby-lang.org/en/)
-
-A Ruby client for [Warframe Stat](https://warframestat.us) bringing you live modeled data from their API.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'warframe'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install warframe
-
-## Usage
-
-To get started accessing live data, you must instantiate a new `Warframe::REST::Client`
-```ruby
-require 'warframe'
-
-client = Warframe::REST::Client.new # => <Warframe::REST::Client platform='pc' language='en'>
-
-# You can supply a hash to set your preferred platform or language.
-my_custom_options = { platform: 'ps4', language: 'de' }
-german_ps4 = Warframe::REST:Client.new my_custom_options # => <Warframe::REST::Client platform='ps4' language='de'>
-```
-
-This gives us access to a plethora of methods, check out the [documentation](https://rubydoc.info/gems/warframe) for more info.
-```ruby
-
-client = Warframe::REST::Client.new
-client.nightwave # => <Warframe::Models::Nightwave>
-client.alerts # => [ <Warframe::Models::Alert>, <Warframe::Models::Alert> ]
-```
-
-## Documentation
-
-Documentation is currently provided by [rubydoc.info](https://rubydoc.info), check out the current versions documentation at https://rubydoc.info/gems/warframe.
-
-## Development
-
-### Dependency Management
-After checking out the repo, run `bundle install` to install required dependencies. 
-
-### Testing
-To check if your changes are passing tests, run:
-
-    $ rake test
-
-> Testing framework provided by [RSpec](https://rspec.info/).
-
-### Linting
-To auto-correct styling offenses, run: 
-
-    $ rake lint
-
-> All linting is provided by [RuboCop](https://github.com/rubocop/rubocop).
-
-## 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).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# warframe-ruby
+[![Supported by Warframe Community Developers](https://warframestat.us/wfcd.png)](https://github.com/WFCD/banner/blob/main/PROJECTS.md "Supported by Warframe Community Developers")
+[![Ruby Gem Version](https://badgen.net/rubygems/v/warframe)](https://rubygems.org/gems/warframe)
+[![Downloads](https://badgen.net/rubygems/dt/warframe)](https://rubygems.org/gems/warframe)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Platform](https://badgen.net/rubygems/p/warframe)](https://www.ruby-lang.org/en/)
+
+
+A Ruby client for [Warframe Stat](https://warframestat.us) bringing you live modeled data from their API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'warframe'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install warframe
+
+## Usage
+
+To get started accessing live data, you must instantiate a new `Warframe::REST::Client`
+```ruby
+require 'warframe'
+
+client = Warframe::REST::Client.new # => <Warframe::REST::Client platform='pc' language='en'>
+
+# You can supply a hash to set your preferred platform or language.
+my_custom_options = { platform: 'ps4', language: 'de' }
+german_ps4 = Warframe::REST:Client.new my_custom_options # => <Warframe::REST::Client platform='ps4' language='de'>
+```
+
+This gives us access to a plethora of methods, check out the [documentation](https://rubydoc.info/gems/warframe) for more info.
+```ruby
+
+client = Warframe::REST::Client.new
+client.nightwave # => <Warframe::Models::Nightwave>
+client.alerts # => [ <Warframe::Models::Alert>, <Warframe::Models::Alert> ]
+```
+
+## Documentation
+
+Documentation is currently provided by [rubydoc.info](https://rubydoc.info), check out the current versions documentation at https://rubydoc.info/gems/warframe.
+
+## Development
+
+### Dependency Management
+After checking out the repo, run: 
+
+    $ bundle install
+    
+> This will install all required dependencies for this gem to run.
+
+### Testing
+To check if your changes are passing tests, run:
+
+    $ thor test:rspec
+
+> Testing framework provided by [RSpec](https://rspec.info/).
+
+### Linting
+To auto-correct styling offenses, run: 
+
+    $ thor style:fix
+
+> 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 ~/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 write associated tests.
+
+## 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).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/warframe/cache.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Warframe
+  # @private
+  class Cache
+    # Expiration time in seconds
+    EXPIRATION_TIME = 5 * 60
+    attr_accessor :cache
+
+    def initialize
+      @cache = {}
+    end
+
+    def get_from_cache(key)
+      cache[key][:result]
+    end
+
+    def find_in_cache(key)
+      cache[key][:result] if exist?(key) && !expired?(key)
+    end
+
+    def add_to_cache(key, val, time = EXPIRATION_TIME)
+      cache[key] = { time: Time.now.to_i + time, result: val }
+      val
+    end
+
+    private
+
+    def exist?(key)
+      !cache[key].nil?
+    end
+
+    def expired?(key)
+      cache[key][:time] - Time.now.to_i <= 0
+    end
+  end
+end

data/lib/warframe/client_wrapper.rb

@@ -1,37 +1,39 @@
-# frozen_string_literal: true
-
-module Warframe
-  # @abstract
-  # @private
-  # Wraps the {Warframe::REST::Client REST::Client} with necessary variables and methods.
-  #
-  # This class should < not be used > for interacting with the API.
-  class ClientWrapper
-    # The base Warframe Stat API link
-    BASE_URL = 'https://api.warframestat.us/'
-    # Default attributes
-    DEFAULT_OPTIONS = { platform: 'pc', language: 'en' }.freeze
-    attr_accessor :platform, :language
-
-    # Initialize the Wrapper for {Warframe::REST::Client REST::Client}
-    #
-    # @param options [Hash] merges with {DEFAULT_OPTIONS}
-    #
-    # See {Warframe::REST::Client REST::Client} for all accepted languages, platforms, and examples.
-    #
-    # This class is ABSTRACT and should not be instantiated outside of {Warframe::REST::Client REST::Client}.
-    # @return [Warframe::ClientWrapper]
-    def initialize(options = {})
-      DEFAULT_OPTIONS.merge(options).each { |k, v| instance_variable_set "@#{k}", v }
-
-      yield self if block_given?
-    end
-
-    # @return [String] the base url and platform combined.
-    def base_url
-      BASE_URL + platform
-    end
-
-    # might need to manipulate user_agent
-  end
-end
+# frozen_string_literal: true
+
+require_relative 'cache'
+
+module Warframe
+  # @abstract
+  # @private
+  # Wraps the {Warframe::REST::Client REST::Client} with necessary variables and methods.
+  #
+  # This class should < not be used > for interacting with the API.
+  class ClientWrapper < Warframe::Cache
+    # The base Warframe Stat API link
+    BASE_URL = 'https://api.warframestat.us/'
+    # Default attributes
+    DEFAULT_OPTIONS = { platform: 'pc', language: 'en' }.freeze
+
+    # The Client Cache
+    attr_accessor :platform, :language
+
+    # Initialize the Wrapper for {Warframe::REST::Client REST::Client}
+    #
+    # @param options [Hash] merges with {DEFAULT_OPTIONS}
+    #
+    # See {Warframe::REST::Client REST::Client} for all accepted languages, platforms, and examples.
+    #
+    # This class is ABSTRACT and should not be instantiated outside of {Warframe::REST::Client REST::Client}.
+    # @return [Warframe::ClientWrapper]
+    def initialize(options = {})
+      super()
+      DEFAULT_OPTIONS.merge(options).each { |k, v| instance_variable_set "@#{k}", v }
+      yield self if block_given?
+    end
+
+    # @return [String] the base url and platform combined.
+    def base_url
+      BASE_URL + platform
+    end
+  end
+end

data/lib/warframe/models/alert.rb

@@ -1,29 +1,30 @@
-# frozen_string_literal: true
-
-require_relative './base'
-require_relative './attributes/expiry'
-require_relative './attributes/active'
-require_relative './attributes/eta'
-require_relative './attributes/reward_types'
-require_relative './attributes/start_string'
-
-module Warframe
-  module Models
-    # Model for World State data {https://api.warframestat.hub/pc/alerts /:platform/alerts}
-    class Alert < Warframe::Models::Base
-      include Warframe::Models::Attributes::Expired
-      include Warframe::Models::Attributes::Active
-      include Warframe::Models::Attributes::ETA
-      include Warframe::Models::Attributes::RewardTypes
-      include Warframe::Models::Attributes::StartString
-
-      # The id of the Alert.
-      # @return [String]
-      attr_reader :id
-
-      # The mission data of this alert.
-      # @return [OpenStruct]
-      attr_reader :mission
-    end
-  end
-end
+# frozen_string_literal: true
+
+require_relative './base'
+require_relative './attributes/expiry'
+require_relative './attributes/active'
+require_relative './attributes/eta'
+require_relative './attributes/reward_types'
+require_relative './attributes/start_string'
+
+module Warframe
+  module Models
+    # 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
+      include Warframe::Models::Attributes::ETA
+      include Warframe::Models::Attributes::RewardTypes
+      include Warframe::Models::Attributes::StartString
+
+      # The id of the Alert.
+      # @return [String]
+      attr_reader :id
+
+      # The mission data of this alert.
+      # @return [OpenStruct]
+      attr_reader :mission
+    end
+  end
+end

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

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # Includes the active? attribute.
-      module Active
-        # Whether or not the event is active.
-        # @return [Boolean]
-        attr_reader :active
-        alias active? active
-      end
-
-      # Includes the activation date as an attribute.
-      module Activation
-        # The time the event was activated.
-        # @return [String]
-        attr_reader :activation
-      end
-
-      # For models that require both {Warframe::Models::Common::Active Common::Active}
-      # and {Warframe::Models::Common::Activation Common::Activation}
-      #
-      # Includes both the active? and activation methods.
-      module ActiveBoth
-        include Activation
-        include Active
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # Includes the active? attribute.
+      module Active
+        # Whether or not the event is active.
+        # @return [Boolean]
+        attr_reader :active
+        alias active? active
+      end
+
+      # Includes the activation date as an attribute.
+      module Activation
+        # The time the event was activated.
+        # @return [String]
+        attr_reader :activation
+      end
+
+      # For models that require both {Warframe::Models::Common::Active Common::Active}
+      # and {Warframe::Models::Common::Activation Common::Activation}
+      #
+      # Includes both the active? and activation methods.
+      module ActiveBoth
+        include Activation
+        include Active
+      end
+    end
+  end
+end

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

@@ -1,14 +1,21 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # Includes the desc attribute.
-      module Description
-        # The description of the data requested.
-        # @return [String]
-        attr_reader :desc
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # 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 :description
+      end
+    end
+  end
+end

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

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # Adds the eta attribute.
-      module ETA
-        # The estimated time until arrival.
-        # @return [String]
-        attr_reader :eta
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # Adds the eta attribute.
+      module ETA
+        # The estimated time until arrival.
+        # @return [String]
+        attr_reader :eta
+      end
+    end
+  end
+end

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

@@ -1,30 +1,30 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    # Common Attributes between models.
-    module Attributes
-      # Includes the expiry attribute.
-      module Expiry
-        # When the event will expire.
-        # @return [String]
-        attr_reader :expiry
-      end
-
-      # Adds a boolean attribute expired? to see whether or not the even has expired.
-      module Expired
-        # Whether or not the event has expired.
-        # @return [Boolean]
-        attr_reader :expired
-        alias expired? expired
-      end
-
-      # Adds the {Warframe::Models::Attributes::Expiry Attributes::Expiry} &
-      # {Warframe::Models::Attributes::Expired Attributes::Expired} attributes.
-      module Expiration
-        include Expiry
-        include Expired
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    # Common Attributes between models.
+    module Attributes
+      # Includes the expiry attribute.
+      module Expiry
+        # When the event will expire.
+        # @return [String]
+        attr_reader :expiry
+      end
+
+      # Adds a boolean attribute expired? to see whether or not the even has expired.
+      module Expired
+        # Whether or not the event has expired.
+        # @return [Boolean]
+        attr_reader :expired
+        alias expired? expired
+      end
+
+      # Adds the {Warframe::Models::Attributes::Expiry Attributes::Expiry} &
+      # {Warframe::Models::Attributes::Expired Attributes::Expired} attributes.
+      module Expiration
+        include Expiry
+        include Expired
+      end
+    end
+  end
+end

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

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # Unique data response ID.
-      module ID
-        # The unique ID of the event.
-        # @return [String]
-        attr_reader :id
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # Unique data response ID.
+      module ID
+        # The unique ID of the event.
+        # @return [String]
+        attr_reader :id
+      end
+    end
+  end
+end

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

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # The types of rewards you can get from this event.
-      module RewardTypes
-        # The types of rewards you can get from this event.
-        # @return [Array<String>]
-        attr_reader :reward_types
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # The types of rewards you can get from this event.
+      module RewardTypes
+        # The types of rewards you can get from this event.
+        # @return [Array<String>]
+        attr_reader :reward_types
+      end
+    end
+  end
+end

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

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-module Warframe
-  module Models
-    module Attributes
-      # Adds the start_string attribute, for when an event will begin.
-      module StartString
-        # When this event goes into effect.
-        # @return [String]
-        attr_reader :start_string
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # Adds the start_string attribute, for when an event will begin.
+      module StartString
+        # When this event goes into effect.
+        # @return [String]
+        attr_reader :start_string
+      end
+    end
+  end
+end