warframe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee6b935052cc4319690a1dbf0b86898e1d6bf0fc5d4d86c0f50df3124cbd6c7a
+  data.tar.gz: ea53ac1bf17b4a3786d06f760bdaec3002bc47ac2f3a1e4de628073c9737e551
+SHA512:
+  metadata.gz: 775da85cd50ea2ce3710fc05ac5b4c5c1df5c5b87fd6bfbcb06dbed94630ba834f3ac9f1ec544b7a71b72f9aec5f92ec7ea67413e1724f088a10186054df3c94
+  data.tar.gz: fed568f336fdccb177c2462039dfdcf4c3334dfc34ae40fc2d5773d8cfb6c92a4e6631fa8c967ea8aa3cb2455952054fda539a0e339e2b928f1fab6e6b62ea54

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable
+  TargetRubyVersion: 2.5
+  DisplayCopNames: false

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--protected
+--markup markdown
+-
+README.md

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ajiellodev@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    warframe (0.1.0)
+      fast_underscore (~> 0.3.2)
+      http (~> 5.0, >= 5.0.4)
+      json (~> 2.6, >= 2.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    fast_underscore (0.3.2)
+    ffi (1.15.4)
+    ffi (1.15.4-x64-mingw32)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (5.0.4)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    llhttp-ffi (0.4.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    unf_ext (0.0.8-x64-mingw32)
+    unicode-display_width (2.1.0)
+    yard (0.9.26)
+
+PLATFORMS
+  x64-mingw32
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  activesupport (~> 5.0, >= 5.0.0.1)
+  bundler (~> 2.1, >= 2.2.31)
+  rake (~> 13.0, >= 13.0.6)
+  rspec (~> 3.10)
+  rubocop (~> 1.22, >= 1.22.3)
+  warframe!
+  yard (~> 0.9.26)
+
+BUNDLED WITH
+   2.2.31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 A.J. Romaniello
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# warframe-ruby
+[![Ruby Gem Version](https://badgen.net/rubygems/v/warframe)](https://rubygems.org/gems/palindrome_ext)
+[![Downloads](https://badgen.net/rubygems/dt/warframe)](https://rubygems.org/gems/palindrome_ext)
+[![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/[USERNAME]/warframe/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).
+
+## Code of Conduct
+
+Everyone interacting in the Warframe project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/warframe/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+RuboCop::RakeTask.new(:lint) do |t|
+  t.options = %w[-A --extra-details]
+end
+
+task default: :spec

data/lib/warframe/client_wrapper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Warframe
+  # @abstract
+  # 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

data/lib/warframe/models/alert.rb

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Warframe
+  module Models
+    module Attributes
+      # Includes the translations attribute.
+      module Translations
+        # The message that can be translated.
+        # @return [String]
+        attr_reader :message
+
+        # Available translations for the requested data.
+        # @return [OpenStruct]
+        attr_reader :translations
+      end
+    end
+  end
+end

data/lib/warframe/models/base.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'fast_underscore'
+
+module Warframe
+  # Models of HTTP responses.
+  module Models
+    # Warframe Base Model.
+    class Base
+      attr_reader :error, :code
+
+      # Creates a new [Warframe::Models::Base] instance.
+      # @param options [Hash, Array] a parsed JSON object, or collection of JSON objects.
+      def initialize(options = {})
+        if options.is_a? Array
+          from_array options
+        else
+          options.each do |k, v|
+            renamed = k.to_s.underscore
+            v = v.map { |obj| OpenStruct.new obj } if v.is_a?(Array) && v[0].is_a?(Hash)
+            v = OpenStruct.new v if v.is_a? Hash
+            instance_variable_set "@#{renamed}", v
+          end
+        end
+      end
+
+      private
+
+      # Constructs an Array of new [Warframe::Models::Base]'s'.
+      # @return [Array]
+      def from_array(arr)
+        arr.map { |obj| initialize obj }
+      end
+    end
+  end
+end

data/lib/warframe/models/global_upgrade.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative './attributes/expiry'
+require_relative './attributes/description'
+require_relative './attributes/eta'
+
+module Warframe
+  module Models
+    # Global Upgrades data model.
+    class GlobalUpgrade < Warframe::Models::Base
+      include Warframe::Models::Attributes::Expired
+      include Warframe::Models::Attributes::Description
+      include Warframe::Models::Attributes::ETA
+
+      # The start of the global upgrade.
+      # @return [String]
+      attr_reader :start
+
+      # The end of the global upgrade.
+      # @return [String]
+      attr_reader :end
+
+      # The upgrade to be received.
+      # @return [String]
+      attr_reader :upgrade
+
+      # The operation of the global upgrade.
+      # @return [String]
+      attr_reader :operation
+
+      # The symbol of the operation.
+      # @return [String]
+      attr_reader :operation_symbol
+
+      # The upgrade operation value.
+      # @return [Integer]
+      attr_reader :upgrade_operation_value
+    end
+  end
+end