warframe 0.3.1 → 1.0.0

data/lib/warframe/models/news.rb

@@ -1,54 +1,49 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative './attributes/translations'
-require_relative './attributes/eta'
-require_relative './attributes/id'
-
-module Warframe
-  module Models
-    # 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
-      include Warframe::Models::Attributes::ID
-
-      # The date the news was released.
-      # @return [String]
-      attr_reader :date
-
-      # The image link from the news page.
-      # @return [String]
-      attr_reader :image_link
-
-      # Link for more information on this news.
-      # @return [String]
-      attr_reader :link
-
-      # Whether or not the news has to do with Prime Access.
-      # @return [Boolean]
-      attr_reader :prime_access
-      alias prime_access? prime_access
-
-      # Whether or not a DEV stream is available.
-      # @return [Boolean]
-      attr_reader :stream
-      alias stream? stream
-
-      # Whether or not this news is regarding an update.
-      # @return [Boolean]
-      attr_reader :update
-      alias update? update
-
-      # Whether or not this news is of priority.
-      # @return [Boolean]
-      attr_reader :priority
-      alias priority? priority
-
-      # The entire response as a long string.
-      # @return [String]
-      attr_reader :as_string
-    end
+require_rel 'base'
+
+module Warframe::Models
+  # News data model.
+  # {https://api.warframestat.us/pc/news /:platform/news}
+  class News < Base
+    include Attributes::Translations
+    include Attributes::ETA
+    include Attributes::ID
+
+    # The date the news was released.
+    # @return [String]
+    attr_reader :date
+
+    # The image link from the news page.
+    # @return [String]
+    attr_reader :image_link
+
+    # Link for more information on this news.
+    # @return [String]
+    attr_reader :link
+
+    # Whether or not the news has to do with Prime Access.
+    # @return [Boolean]
+    attr_reader :prime_access
+    alias prime_access? prime_access
+
+    # Whether or not a DEV stream is available.
+    # @return [Boolean]
+    attr_reader :stream
+    alias stream? stream
+
+    # Whether or not this news is regarding an update.
+    # @return [Boolean]
+    attr_reader :update
+    alias update? update
+
+    # Whether or not this news is of priority.
+    # @return [Boolean]
+    attr_reader :priority
+    alias priority? priority
+
+    # The entire response as a long string.
+    # @return [String]
+    attr_reader :as_string
   end
 end

data/lib/warframe/models/nightwave.rb

@@ -1,40 +1,34 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative './attributes/active'
-require_relative './attributes/id'
-require_relative './attributes/expiry'
-require_relative './attributes/reward_types'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # 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
-      include Warframe::Models::Attributes::Expiry
-      include Warframe::Models::Attributes::RewardTypes
+module Warframe::Models
+  # Nightwave data model.
+  # {https://api.warframestat.us/pc/nightwave /:platform/nightwave}
+  class Nightwave < Base
+    include Attributes::Activation
+    include Attributes::ID
+    include Attributes::Expiry
+    include Attributes::RewardTypes
 
-      # The current phase of this event.
-      # @return [Integer]
-      attr_reader :phase
+    # The current phase of this event.
+    # @return [Integer]
+    attr_reader :phase
 
-      # The current Nightwave Tag
-      # @return [String]
-      attr_reader :tag
+    # The current Nightwave Tag
+    # @return [String]
+    attr_reader :tag
 
-      # The current Nightwave Season
-      # @return [Integer]
-      attr_reader :season
+    # The current Nightwave Season
+    # @return [Integer]
+    attr_reader :season
 
-      # List of all possible challenges.
-      # @return [Array<OpenStruct>]
-      attr_reader :possible_challenges
+    # List of all possible challenges.
+    # @return [Array<OpenStruct>]
+    attr_reader :possible_challenges
 
-      # Active Challenges for this event.
-      # @return [Array<OpenStruct>]
-      attr_reader :active_challenges
-    end
+    # Active Challenges for this event.
+    # @return [Array<OpenStruct>]
+    attr_reader :active_challenges
   end
 end

data/lib/warframe/models/objectified_hash.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Warframe::Models
+  # An objectified hash response. Used for turning raw JSON objects into a ruby friendly object.
+  # This can be accessed in multiple formats, ie: JSON `obj['String']` access, Ruby hash `obj[:symbol]`,
+  # Ruby object `obj.method`.
+  # This also handles serialization of nested hashes or arrays of hashes, which in turn will become
+  # a Waframe::Models::ObjectifiedHash.
+  class ObjectifiedHash
+    def initialize(data)
+      @data = transform_to_hash(data)
+      populate_object
+    end
+
+    def [](key)
+      @data[key] || @data[string_to_symbol(key)]
+    end
+
+    def to_hash # rubocop:todo Metrics/CyclomaticComplexity
+      @to_hash ||= @data.each_with_object({}) do |(k, v), hash|
+        v = v.to_h if v.is_a?(Warframe::Models::ObjectifiedHash) && !v.empty?
+        v = v.map(&:to_h) if v.is_a?(Array) && v.first.is_a?(Warframe::Models::ObjectifiedHash)
+        hash[k] = v
+      end
+    end
+    alias to_h to_hash
+    alias hash to_hash
+
+    def to_s
+      @to_s ||= hash.to_s
+    end
+
+    def self.from_array(arr)
+      arr.map { |data| new(data) if data.is_a?(Hash) }.compact
+    end
+
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} { data: #{data.inspect} }".gsub('\"', '')
+    end
+
+    def size
+      @data.size
+    end
+
+    private
+
+    attr_reader :data
+
+    def populate_object # rubocop:todo Metrics/AbcSize
+      data.each do |k, v|
+        if v.is_a?(Hash) && v.size.positive?
+          v = ObjectifiedHash.new(v)
+        elsif v.is_a?(Array) && v.first.is_a?(Hash) && v.first.size.positive?
+          v = ObjectifiedHash.from_array(v)
+        end
+
+        self.class.send(:attr_reader, k)
+        instance_variable_set("@#{k}", v)
+        @data[k] = v
+      end
+    end
+
+    def transform_to_hash(hash)
+      hash.transform_keys { |data| string_to_symbol(data) }
+    rescue NoMethodError
+      pp "Error decoding: #{hash}"
+    end
+
+    def string_to_symbol(string)
+      string.split(/(?=[A-Z])/).map(&:downcase).join('_').to_sym
+    end
+  end
+end

data/lib/warframe/models/sortie.rb

@@ -1,36 +1,30 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative 'attributes/id'
-require_relative 'attributes/expiry'
-require_relative 'attributes/active'
-require_relative 'attributes/eta'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # 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::ActiveBoth
-      include Warframe::Models::Attributes::Expiration
-      include Warframe::Models::Attributes::ETA
+# Sortie data model.
+# {https://api.warframestat.us/pc/sortie /:platform/sortie}
+module Warframe::Models
+  class Sortie < Base
+    include Attributes::ID
+    include Attributes::ActiveBoth
+    include Attributes::Expiration
+    include Attributes::ETA
 
-      # The boss for this part of the sortie.
-      # @return [String]
-      attr_reader :boss
+    # 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
+    # The faction fighting you in this mission.
+    # @return [String]
+    attr_reader :faction
 
-      # Modifiers active for this challenge.
-      # @return [Array<OpenStruct>]
-      attr_reader :variants
+    # 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
+    # The reward pool which this is pulling from.
+    # @return [String]
+    attr_reader :reward_pool
   end
 end

data/lib/warframe/models/steel_path.rb

@@ -1,34 +1,32 @@
 # frozen_string_literal: true
 
-require_relative './base'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # 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
+# SteelPath data model.
+# {https://api.warframestat.us/pc/steelPath /:platform/steelPath}
+module Warframe::Models
+  class SteelPath < Base
+    include Attributes::Active
+    include Attributes::Expiry
 
-      # The currently available item from Teshin.
-      # @return [OpenStruct]
-      attr_reader :current_reward
+    # The currently available item from Teshin.
+    # @return [OpenStruct]
+    attr_reader :current_reward
 
-      # The time remaining of the current reward.
-      # @return [String]
-      attr_reader :remaining
+    # 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 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 rotation of items Teshin has to offer.
+    # @return [Array<OpenStruct>]
+    attr_reader :evergreens
 
-      # Current incursion data
-      # @return [OpenStruct]
-      attr_reader :incursions
-    end
+    # Current incursion data
+    # @return [OpenStruct]
+    attr_reader :incursions
   end
 end

data/lib/warframe/models/syndicate_mission.rb

@@ -1,32 +1,26 @@
 # frozen_string_literal: true
 
-require_relative './base'
-require_relative 'attributes/eta'
-require_relative 'attributes/id'
-require_relative 'attributes/active'
-require_relative 'attributes/start_string'
+require_rel 'base'
 
-module Warframe
-  module Models
-    # 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
-      include Warframe::Models::Attributes::ActiveBoth
-      include Warframe::Models::Attributes::StartString
+# SyndicateMission data model.
+# {https://api.warframestat.us/pc/syndicateMissions /:platform/syndicateMissions}
+module Warframe::Models
+  class SyndicateMission < Base
+    include Attributes::ETA
+    include Attributes::ID
+    include Attributes::ActiveBoth
+    include Attributes::StartString
 
-      # 'Jobs' or challenges currently available.
-      # @return [Array<OpenStruct>]
-      attr_reader :jobs
+    # 'Jobs' or challenges currently available.
+    # @return [Array<OpenStruct>]
+    attr_reader :jobs
 
-      # The syndicate you will be fighting.
-      # @return [String]
-      attr_reader :syndicate
+    # 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
+    # The nodes that this mission is available on.
+    # @return [Array]
+    attr_reader :nodes
   end
 end

data/lib/warframe/models/vallis_cycle.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_rel 'base'
+
+module Warframe::Models
+  # Model for VallisCycle data.
+  # {https://api.warframestat.us/pc/vallisCycle /:platform/vallisCycle}
+  class VallisCycle < Base
+    include Attributes::ID
+    include Attributes::Expiry
+    include Attributes::Activation
+
+    # @!attribute time_left
+    # @return [String] time left until next cycle.
+    attr_reader :time_left
+
+    # @!attribute is_warm?
+    # @return [Boolean] whether or not it currently is warm.
+    attr_reader :is_warm
+    alias is_warm? is_warm
+
+    # @!attribute state
+    # @return [String] the current world state (Cold or Warm)
+    attr_reader :state
+
+    # @!attribute short_string
+    # @return [String] the time remaining until state change. Ex: `5m to Warm`.
+    attr_reader :short_string
+  end
+end

data/lib/warframe/models.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_rel 'models'
+
+# Currently supported models.
+module Warframe::Models; end

data/lib/warframe/version.rb

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

data/lib/warframe.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
-require 'warframe/version'
-require 'warframe/rest/client'
+require 'require_all'
+require 'rest-client'
+require 'json'
+require_rel 'warframe'
 
 # Warframe Stat Ruby Client main module
 module Warframe; end

data/warframe.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/warframe/version'
+
+Gem::Specification.new do |spec|
+  # Required
+  spec.name = 'warframe'
+  spec.version = Warframe::VERSION
+  spec.authors = ['A.J. Romaniello', 'Warframe Community Developers']
+
+  # Descriptive
+  spec.summary = 'A Ruby interface to the WarframeStat API.'
+  spec.description = spec.summary
+  spec.license = 'MIT'
+  spec.homepage = 'https://gitlab.com/aj-rom/warframe-ruby'
+
+  # MetaData
+  spec.metadata['source_code_uri'] = "#{spec.homepage}/-/tree/v#{spec.version}"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/tree/v#{spec.version}/CHANGELOG.md"
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/-/issues"
+  spec.metadata['documentation_uri'] = "https://rubydoc.info/gems/#{spec.name}/#{spec.version}"
+
+  # Executables / Files
+  spec.bindir = 'exe'
+  spec.require_paths = ['lib']
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z lib *.gemspec README.md CHANGELOG.md *.txt .yardopts`.split("\x0")
+  end
+
+  # Dependencies
+  spec.required_ruby_version = '>= 2.3' # rubocop:disable Gemspec/RequiredRubyVersion
+  spec.add_dependency 'fast_underscore', '~> 0.3'
+  spec.add_dependency 'require_all', '~> 3.0'
+  spec.add_dependency 'rest-client', '~> 2.1'
+
+  # Development Dependencies
+  spec.add_development_dependency 'bundler', '~> 2.3'
+end