fortnite_experience 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a65e409cd28a2f7ecdcfb86f1d900a8d045257ae02342ea924e056f8aa3479dd
+  data.tar.gz: 53d4273b22d69373fd01be14068bfa345d207a1b8328c81b211a4afb4a3e2a1f
+SHA512:
+  metadata.gz: 6ce198c8e8e62fd5aba440421c523bb56926c51222ce4582a890f14fe9e14f5cd1d021eb4809390e221a9c6505992635fcf8814d463eb0ef7633d12d0f153fa2
+  data.tar.gz: 0fa04040e048004629a1246d234595998ec31eed775fc6870b3d681f1aebf46eaeef6c2a3443ebdb5d3543d376dd2dafaf010ad3285709e9d322d63f84bfdf59

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# gem builds
+*.gem

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+# This is the configuration used to check the rubocop source code.
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 99

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at francoprud@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fortnite_experience.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    fortnite_experience (0.1.0)
+      httparty (~> 0.13.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    columnize (0.9.0)
+    crack (0.4.4)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.6)
+    multi_xml (0.6.0)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    powerpack (0.1.2)
+    public_suffix (4.0.6)
+    rainbow (2.2.2)
+      rake
+    rake (11.3.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    webmock (2.3.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 2.1)
+  fortnite_experience!
+  rake (~> 11.2, >= 11.2.2)
+  rspec (~> 3.5)
+  rubocop (~> 0.42.0)
+  webmock (~> 2.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Franco Prudhomme
+
+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,61 @@
+# FortniteExperience
+
+This gem provides a class to group the total experience of the current Fortnite season weekly challenges by Point Of Interest (POI). It uses [FortniteApi.io](https://fortniteapi.io/) API to retrieve the information about POIs and weekly challenges.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fortnite_experience'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install fortnite_experience
+
+## Usage
+
+To use this gem, you need to be registered at [FortniteApi.io](https://fortniteapi.io/) and have a developer key (`FORTNITE_API_IO_KEY`).
+
+```ruby
+require 'fortnite_experience'
+
+# Initialize with a valid FortniteApi.io key
+fortnite_calculator = FortniteExperience::Calculator.new('FORTNITE_API_IO_KEY')
+fortnite_calculator.experience_by_pois #=> { 'CRAGGY CLIFFS' => 50_000, 'CATTY CORNER' => 25_000 }
+
+# Initialize with an invalid FortniteApi.io key
+fortnite_calculator = FortniteExperience::Calculator.new('INVALID_KEY')
+fortnite_calculator.experience_by_pois #=> *** FortniteExperience::Services::FortniteAPI::APIKeyNotValidError
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/francoprud/fortnite_experience. 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/francoprud/fortnite_experience/blob/master/CODE_OF_CONDUCT.md).
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Run rubocop (`bundle exec rubocop Gemfile lib spec`)
+5. Run rspec (`bundle exec rspec`)
+6. Push your branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## 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 FortniteExperience project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fortnite_experience/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'fortnite_experience'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fortnite_experience.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/fortnite_experience/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fortnite_experience'
+  spec.version       = FortniteExperience::VERSION
+  spec.authors       = ['prudi']
+
+  spec.summary       = 'Gem that groups by POIs the amount of experience from weekly challenges.'
+  spec.description   = 'Groups POIs with the xp points from weekly challenges. Use FortniteAPI.io.'
+  spec.homepage      = 'https://github.com/francoprud/fortnite_experience'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/francoprud/fortnite_experience'
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rake', '~> 11.2', '>= 11.2.2'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.42.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'byebug', '~> 2.1'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.13.7'
+end

data/lib/fortnite_experience.rb

@@ -0,0 +1,6 @@
+require 'fortnite_experience/services/fortnite_api'
+require 'fortnite_experience/calculator'
+require 'fortnite_experience/version'
+
+module FortniteExperience
+end

data/lib/fortnite_experience/calculator.rb

@@ -0,0 +1,21 @@
+module FortniteExperience
+  class Calculator
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def experience_by_pois
+      result = {}
+
+      Services::FortniteAPI.get_poi_names(@api_key).each do |poi|
+        Services::FortniteAPI.get_weekly_challenges(@api_key).each do |challenge|
+          if challenge['title'].match?(/#{poi}/i)
+            result[poi] = (result[poi] || 0) + challenge['xp']
+          end
+        end
+      end
+
+      result
+    end
+  end
+end

data/lib/fortnite_experience/services/fortnite_api.rb

@@ -0,0 +1,36 @@
+require 'httparty'
+
+module FortniteExperience
+  module Services
+    class FortniteAPI
+      class DailyRequestLimitExceededError < StandardError; end
+      class APIKeyNotValidError < StandardError; end
+
+      BASE_URI              = -'https://fortniteapi.io'
+      POI_URI               = -"#{BASE_URI}/game/poi?lang=en"
+      WEEKLY_CHALLENGES_URI = -"#{BASE_URI}/v1/challenges?season=current&lang=en"
+
+      class << self
+        def get_poi_names(api_key)
+          response = HTTParty.get(POI_URI, headers: { 'Authorization' => api_key })
+          verify(response)
+          response.parsed_response['list'].map { |poi| poi['name'] }
+        end
+
+        def get_weekly_challenges(api_key)
+          response = HTTParty.get(WEEKLY_CHALLENGES_URI, headers: { 'Authorization' => api_key })
+          verify(response)
+          response.parsed_response['weeks'].values.map { |week| week['challenges'] }.flatten
+        end
+
+        private
+
+        def verify(response)
+          raise APIKeyNotValidError if response['code'] == 'INVALID_API_KEY'
+          # TODO: verify response code for DailyRequestLimitExceededError
+          raise DailyRequestLimitExceededError if response['code'] == 'TBD'
+        end
+      end
+    end
+  end
+end

data/lib/fortnite_experience/version.rb

@@ -0,0 +1,3 @@
+module FortniteExperience
+  VERSION = -'0.1.0'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: fortnite_experience
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- prudi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+description: Groups POIs with the xp points from weekly challenges. Use FortniteAPI.io.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fortnite_experience.gemspec
+- lib/fortnite_experience.rb
+- lib/fortnite_experience/calculator.rb
+- lib/fortnite_experience/services/fortnite_api.rb
+- lib/fortnite_experience/version.rb
+homepage: https://github.com/francoprud/fortnite_experience
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/francoprud/fortnite_experience
+  source_code_uri: https://github.com/francoprud/fortnite_experience
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem that groups by POIs the amount of experience from weekly challenges.
+test_files: []