warcraft 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8023f3f1c59ce6ca630b2c07d53e17ed032e7d40592a9636d27f0eb99665c09
-  data.tar.gz: 8b0f879bf9b60972701c91496e211c3d4558423ce60cfb7d198ecb404ebf80f7
+  metadata.gz: 4e6cd59e79952a7c3ef82293bb38e1dbc2e79a807b1d265f7645f939a333c781
+  data.tar.gz: 533407e86969d4af218138c34aac2a28492a08af24304c18447a7b2628e4925b
 SHA512:
-  metadata.gz: d4df3a267d426e6b23f6df371589df55ad48dad59ac126a5a7cb3fab0227436c60b177d92e45cdd2891c5b5cb37047776b052b40ddb19c11de9239f0910ee995
-  data.tar.gz: 829cba103df9e690e929c1ef1a4133f92d36b06888b5608ba70ae4edad468bae37848587d5e10558d1603c037fab1722a5ec9e15d2827180ecae578761bee630
+  metadata.gz: 45a39d55feef646f819327a3a34fa8dfef0b9cc7a1d4f59416b6f67c47635ca6a51651104bc9d08a9bdd874e354e890d214372fcddfeb8d3533573ab642af46e
+  data.tar.gz: d80a06ac5defa67de32677a33edaabf28b5dd0891c35227b88a08763413aa262cf508180e540b58fd73e9e5748fdf539d6dcff861a4aa82a49c1ce52758ac5e7

data/.rubocop.yml

@@ -1,6 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.5
 
+Style/Documentation:
+  Enabled: false
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/README.md

@@ -1,5 +1,7 @@
 # Warcraft
 
+[![Gem Version](https://badge.fury.io/rb/warcraft.svg)](https://badge.fury.io/rb/warcraft)
+
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/warcraft`. To experiment with that code, run `bin/console` for an interactive prompt.
 
 TODO: Delete this and the text above, and describe your gem

data/gems.locked

@@ -1,14 +1,20 @@
 PATH
   remote: .
   specs:
-    warcraft (0.1.0)
-      httparty
+    warcraft (0.1.1)
+      httparty (~> 0.18)
+      zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.4.4)
+    hashdiff (1.0.1)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -19,6 +25,7 @@ GEM
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
@@ -49,8 +56,14 @@ GEM
       parser (>= 2.7.1.5)
     ruby-progressbar (1.11.0)
     unicode-display_width (1.7.0)
+    webmock (3.12.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
+  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
@@ -58,6 +71,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 0.80)
   warcraft!
+  webmock
 
 BUNDLED WITH
    2.2.4

data/gems.rb

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 0.80"
+
+gem "webmock"

data/lib/warcraft.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "warcraft/version"
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
 module Warcraft
   class Error < StandardError; end

data/lib/warcraft/account/profile.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Warcraft
+  module Account
+    # @!method id
+    # @return [Integer] Blizzard Battle.net Account ID
+    class Profile < ApiRequest
+      def collections
+        link
+      end
+
+      def wow_accounts
+        @wow_accounts ||= WowAccount.new(@client, @response[:wow_accounts])
+      end
+
+      def all_characters
+        @response[:wow_accounts].map(:characters).flatten.map do |c|
+          Fragments::AccountCharacterFragment.new(@client, c)
+        end
+      end
+    end
+
+    class WowAccount
+      def initialize(client, data)
+        @client = client
+        @data = data
+      end
+
+      # The WoW account ID
+      # @return [Integer]
+      def id
+        @data[:id]
+      end
+
+      # @return [Array<Warcraft::Fragments::AccountCharacterFragment>]
+      def characters
+        @characters ||= @data[:characters].map { |c| Fragments::AccountCharacterFragment.new(@client, c) }
+      end
+    end
+  end
+end

data/lib/warcraft/account_request.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Warcraft
+  class AccountRequest < ApiRequest
+    # @param [Warcraft::Client] client
+    def initialize(client, region, token)
+      super(client, region)
+      @token = token
+    end
+
+    def profile
+      Account::Profile.new(@client, get("/profile/user/wow"))
+    end
+
+    def protected_character
+      # TODO
+    end
+
+    def collections
+      # TODO
+    end
+
+    def mounts
+      # TODO
+    end
+
+    def pets
+      # TODO
+    end
+  end
+end

data/lib/warcraft/api_request.rb

@@ -2,17 +2,14 @@
 
 module Warcraft
   class ApiRequest
-    def initialize(client)
-      super
+    def initialize(client, region)
       @client = client
+      @region = region
     end
 
-    def get(url)
-      @client.get(@region, "#{url}?namespace=#{namespace}")
-    end
-
-    def namespace
-      "profile-#{@region}"
+    def get(url, region: nil, token: nil, namespace: "profile-#{region}")
+      region ||= @region
+      @client.get("#{url}?namespace=#{namespace}", region: region, token: token)
     end
   end
 end

data/lib/warcraft/api_response.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "ostruct"
 require "forwardable"
 
 module Warcraft
@@ -10,8 +9,27 @@ module Warcraft
     def_delegator :@response, :[], :method_missing
 
     # @param [Hash] response A parsed character profile document
-    def initialize(response)
+    def initialize(client, response)
+      @client = client
       @response = response
+      @memoized_responses = {}
+    end
+
+    # @return [String]
+    def url
+      @response.dig(:_links, :self, :href)
+    end
+
+    # @return [Time]
+    def self.convert_time(timestamp)
+      Time.at(timestamp / 1000)
+    end
+
+    protected
+
+    def link
+      resource_name = caller_locations(1, 1)[0].label.to_sym
+      @memoized_responses[resource_name] ||= @client.get(@response.dig(resource_name, :href))
     end
   end
 end

data/lib/warcraft/character/achievements.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Warcraft
+  module Character
+    class Achievements < ApiResponse
+      def total_quantity
+        @response[:total_quantity]
+      end
+
+      def total_points
+        @response[:total_points]
+      end
+
+      # @return [Array<AchievementFragment>]
+      def achievements
+        @achievements ||= @response[:achievements].map { |a| AchievementFragment.new(@client, a) }
+      end
+
+      # @return [Array<CategoryProgress>]
+      def category_progress
+        @category_progress ||= @response[:category_progress].map { |c| CategoryProgress.new(@client, c) }
+      end
+
+      # @return [Array<AchievementEvent>]
+      def recent_events
+        @recent_events ||= @response[:recent_events].map { |e| AchievementEvent.new(@client, e) }
+      end
+
+      # @return [Warcraft::Fragments::CharacterFragment]
+      def character
+        @character ||= CharacterFragment.new(@client, @response[:character])
+      end
+
+      def statistics
+        link
+      end
+    end
+
+    class AchievementFragment
+      def initialize(client, data)
+        @client = client
+        @data = data
+      end
+
+      # @return [Integer]
+      def id
+        @data[:id]
+      end
+
+      # @return [String]
+      def name
+        @data.dig(:achievement, :name)
+      end
+
+      # @return [String]
+      def url
+        @data.dig(:achievement, :key, :href)
+      end
+
+      def full_achievement
+        @client.get(url)
+      end
+
+      # @return [Hash]
+      def criteria
+        @data[:criteria]
+      end
+
+      # @return [Boolean]
+      def child_criteria?
+        @data[:criteria].key? :child_criteria
+      end
+
+      # @return [Array<Hash>]
+      def child_criteria
+        has_child_criteria? ? @data.dig(:criteria, :child_criteria) : []
+      end
+
+      # @return [Integer]
+      def criteria_id
+        @data.dig(:criteria, :id)
+      end
+
+      # @return [Boolean]
+      def completed?
+        @data.dig(:criteria, :is_completed)
+      end
+
+      # @return [Time]
+      def completed_at
+        ApiResponse.convert_time(@data[:completed_timestamp])
+      end
+    end
+
+    class CategoryProgress
+      def initialize(client, data)
+        @client = client
+        @data = data
+      end
+
+      # @return [Integer]
+      def quantity
+        @data[:quantity]
+      end
+
+      # @return [Integer]
+      def points
+        @data[:points]
+      end
+
+      # @return [Hash]
+      def name
+        @data.dig(:category, :name)
+      end
+
+      # @return [Hash]
+      def category
+        @data[:category]
+      end
+
+      def full_category
+        @client.get(category_url)
+      end
+
+      # @return [Integer]
+      def category_id
+        @data.dig(:category, :id)
+      end
+
+      # @return [String]
+      def category_url
+        @data.dig(:category, :key, :href)
+      end
+    end
+
+    class AchievementEvent
+      def initialize(client, data)
+        @client = client
+        @data = data
+      end
+
+      # @return [String]
+      def achievement_url
+        @data.dig(:achievement, :key, :href)
+      end
+
+      # @return [String]
+      def achievement_name
+        @data.dig(:achievement, :name)
+      end
+
+      # @return [Integer]
+      def achievement_id
+        @data.dig(:achievement, :id)
+      end
+
+      # @return [Time]
+      def time
+        ApiResponse.convert_time(@data[:timestamp])
+      end
+    end
+  end
+end

data/lib/warcraft/character/profile.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../api_response"
-
 module Warcraft
   module Character
     # @!method id
@@ -22,12 +20,71 @@ module Warcraft
     #   @return [Integer]
     class Profile < ApiResponse
       def last_login
-        Time.at(last_login_timestamp)
+        ApiResponse.convert_time(last_login_timestamp)
+      end
+
+      def achievements
+        link
+      end
+
+      def titles
+        link
+      end
+
+      def pvp_summary
+        link
+      end
+
+      def encounters
+        link
+      end
+
+      def media
+        link
+      end
+
+      def hunter_pets
+        link
+      end
+
+      def specializations
+        link
+      end
+
+      def statistics
+        link
+      end
+
+      def mythic_keystone_profile
+        link
+      end
+
+      def equipment
+        link
+      end
+
+      def appearance
+        link
+      end
+
+      def collections
+        link
+      end
+
+      def reputations
+        link
+      end
+
+      def quests
+        link
+      end
+
+      def achievements_statistics
+        link
       end
 
-      # @return [String]
-      def url
-        @response.dig(:_links, :self, :href)
+      def professions
+        link
       end
     end
   end

data/lib/warcraft/character_request.rb

@@ -4,14 +4,18 @@ module Warcraft
   class CharacterRequest < ApiRequest
     # @param [Warcraft::Client] client
     def initialize(client, region, realm, character_name)
-      super(client)
-      @region = region
+      super(client, region)
       @realm = realm
       @name = character_name
     end
 
     def profile
-      Character::Profile.new get("/profile/wow/character/#{@realm}/#{@name}")
+      Character::Profile.new(@client, get("/profile/wow/character/#{@realm}/#{@name}", region: @region))
+    end
+
+    def achievements
+      Character::Achievements.new(@client, get("/profile/wow/character/#{@realm}/#{@name}/achievements",
+                                               region: @region))
     end
   end
 end

data/lib/warcraft/{warcraft_client.rb → client.rb}

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require "httparty"
+
 module Warcraft
   class Client
-    using StringUtils
+    using Refinements::StringUtils
 
     attr_accessor :token, :region
 
@@ -13,11 +15,12 @@ module Warcraft
       self.region = region
     end
 
-    # @param [Symbol] region
     # @param [String] url
+    # @param [Symbol] region
     # @return [Hash]
-    def get(region, url)
-      response = HTTParty.get("https://#{region}.api.blizzard.com#{url}",
+    def get(url, region = nil, token = self.token)
+      token = self.token if token.nil?
+      response = HTTParty.get(region.nil? ? url : "https://#{region}.api.blizzard.com#{url}",
                               headers: {
                                 'Authorization': "Bearer #{token}"
                               }, format: :plain)
@@ -25,7 +28,7 @@ module Warcraft
     end
 
     # @param [Symbol] region Region to fetch data for (optional)
-    def userinfo(region = nil)
+    def userinfo(token = self.token, region = nil)
       domain = region == :cn ? "www.battlenet.com.cn" : "#{region}.api.blizzard.com"
       response = HTTParty.get("https://#{domain}/oauth/userinfo?access_token",
                               headers: {
@@ -34,7 +37,11 @@ module Warcraft
       JSON.parse(response.body, symbolize_names: true)
     end
 
-    def character(realm, character_name, region = self.region)
+    def account(token: self.token, region: self.region)
+      AccountRequest.new(self, region, token)
+    end
+
+    def character(realm:, character_name:, region: self.region)
       CharacterRequest.new(self, region, realm.slugify, character_name.slugify)
     end
   end

data/lib/warcraft/fragment.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Warcraft
+  class Fragment
+    def initialize(client, data)
+      @client = client
+      @data = data
+    end
+  end
+end

data/lib/warcraft/fragments/account_character_fragment.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Warcraft
+  module Fragments
+    class AccountCharacterFragment < Fragment
+      def character
+        link
+      end
+
+      def protected_character
+        link
+      end
+
+      def name
+        @data[:name]
+      end
+
+      def id
+        @data[:id]
+      end
+
+      def realm_url
+        @data.dig(:realm, :key, :href)
+      end
+
+      def realm_name
+        @data.dig(:realm, :name)
+      end
+
+      def realm_id
+        @data.dig(:realm, :id)
+      end
+
+      def realm_slug
+        @data.dig(:realm, :slug)
+      end
+
+      def playable_class_url
+        @data.dig(:playable_class, :key, :href)
+      end
+
+      def playable_class_id
+        @data.dig(:playable_class, :id)
+      end
+
+      def playable_race_url
+        @data.dig(:playable_race, :key, :href)
+      end
+
+      def playable_race_id
+        @data.dig(:playable_race, :id)
+      end
+
+      def gender
+        @dig.dig(:gender, :type)
+      end
+
+      def faction
+        @dig.dig(:faction, :type)
+      end
+
+      def level
+        @dig[:level]
+      end
+
+      # TODO: class, race, gender and faction are localised
+    end
+  end
+end

data/lib/warcraft/fragments/character_fragment.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Warcraft
+  module Fragments
+    class CharacterFragment < Fragment
+      # @return [String]
+      def url
+        @data.dig(:key, :href)
+      end
+
+      def id
+        @data[:id]
+      end
+
+      def slug
+        @data[:slug]
+      end
+
+      def realm
+        # TODO: Localised resource
+      end
+    end
+  end
+end

data/lib/warcraft/refinements/string_utils.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Warcraft
+  module Refinements
+    module StringUtils
+      refine String do
+        def slugify
+          downcase.gsub(" ", "-")
+        end
+      end
+    end
+  end
+end

data/lib/warcraft/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Warcraft
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/warcraft.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty"
+  spec.add_dependency "httparty", "~> 0.18"
+  spec.add_dependency "zeitwerk", "~> 2.4"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: warcraft
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Karina Kwiatek
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description:
 email:
 - racc@raccube.net
@@ -44,14 +58,20 @@ files:
 - bin/setup
 - gems.locked
 - gems.rb
-- lib/refinements/string_utils.rb
 - lib/warcraft.rb
+- lib/warcraft/account/profile.rb
+- lib/warcraft/account_request.rb
 - lib/warcraft/api_request.rb
 - lib/warcraft/api_response.rb
+- lib/warcraft/character/achievements.rb
 - lib/warcraft/character/profile.rb
 - lib/warcraft/character_request.rb
+- lib/warcraft/client.rb
+- lib/warcraft/fragment.rb
+- lib/warcraft/fragments/account_character_fragment.rb
+- lib/warcraft/fragments/character_fragment.rb
+- lib/warcraft/refinements/string_utils.rb
 - lib/warcraft/version.rb
-- lib/warcraft/warcraft_client.rb
 - warcraft.gemspec
 homepage: https://github.com/raccube/warcraft
 licenses:

data/lib/refinements/string_utils.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module StringUtils
-  refine String do
-    def slugify
-      downcase.gsub(" ", "-")
-    end
-  end
-end