blizzard_api 0.3.11 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d749ca8885288890aa3fd989b55d761520775a0187bc395802152d09a27b57d
-  data.tar.gz: b9da4c8d1aa1c505737a258780e80db4c41a0ea789fef38b7d673cdd5ad3a29b
+  metadata.gz: ba9df0ce8e6bc1398057fa55eae73f4081d370f13d204f0d6f2eccb313f3bed2
+  data.tar.gz: 5f3d190b6d324c45b456ccd856b6271b6e2447816930b7e451aa7fa325c85d98
 SHA512:
-  metadata.gz: 2320bad31262928a97d77ddf5092ad86a80278ac88572be33a9f252aa639d99973a8c3554b786f3c95fc9a05be0aba099412038eaee56bda11a9e6414221ff40
-  data.tar.gz: 7a9df7fb947da25b9e5ae4e19c6384acfe3f5111f6d4ca2615f4ab87ee80cdfde25bb7cbebde597e2c5bebe4b303a661605e6ff51ef68860c24c07895883c844
+  metadata.gz: aa67738363d505b469eeb89c5fcc140fe2bbd8834c3be1afd588ba1a7ae9ac79347409bfdecad97a7a24ea1c427b70a5b4f3812b8d838d11c5b41bb34916bc09
+  data.tar.gz: 6489a58fc1132f50ccd977f0ad4dff408997c9fff80be0d38b7e5d43602287c99490af2604b6bed7a913baa22ad701189fe9eb366a58b39b1266b57a275df73d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.4.0**
+
+Added support to searchable endpoints
+
+https://develop.battle.net/documentation/world-of-warcraft/guides/search
+
 **Version 0.3.11**
 
 Fixed D3 item URL.

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.3.11)
+    blizzard_api (0.4.0)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    dotenv (2.7.5)
     jaro_winkler (1.5.3)
     minitest (5.11.3)
     parallel (1.17.0)
@@ -15,7 +16,7 @@ GEM
       ast (~> 2.4.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.1.3)
+    redis (4.1.4)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -25,15 +26,18 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.6.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   blizzard_api!
+  dotenv
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 0.61)
+  yard
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -73,6 +73,46 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
 * `get` is used to get all information about a entry of the index returned data. It receives an id or slug as the first parameter, that depends on the endpoint.
 * `complete` is a complete information of all items listed in index. **This may perform various calls to the blizzard api** only use if you really need all information.
 
+### 3.1 Searchable endpoints
+
+Some endpoints support search filters. To perform a search you can use the following formats:
+
+
+To use the **or** operator you may pass an array of values as argument to `where` or `where_not` methods.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'name.en_US', %w[Azralon Nemesis]
+end
+```
+ 
+To use the **and** operator you may call `where` or `where_not` multiple times methods.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'name.en_US', 'Azralon'
+  options.where 'id', 3209
+end
+```
+
+To use the **range** operator you may pass a hash to `where` or `where_not`.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'id', min: 3209, max: 4000, mode: :exclusive
+end
+```
+*Note*: If you don't pass the `mode` key as `:exclusive` it will be `:inclusive` by default.
+
+To **sort** fields you may call the `order_by` method multiple times:
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'id', min: 3209, max: 4000, mode: :exclusive
+  options.order_by 'id', :desc
+end
+```
+
 ## 4. Available endpoints
 
 **Hint**: All methods support an additional optional hash parameter that allows you to override the following configurations for a single call:

data/blizzard_api.gemspec

@@ -34,7 +34,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
 
+  spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'yard'
 end

data/lib/blizzard_api/diablo/community/item.rb

@@ -13,7 +13,7 @@ module BlizzardApi
       ##
       # Return information about an item
       #
-      # @param item_slug [String] Item slug
+      # @param item_slug_and_id [String] Item slug
       # @!macro request_options
       #
       # @!macro response

data/lib/blizzard_api/request.rb

@@ -50,7 +50,8 @@ module BlizzardApi
       community: 'https://%s.api.blizzard.com/%s',
       profile: 'https://%s.api.blizzard.com/profile/%s',
       media: 'https://%s.api.blizzard.com/data/%s/media',
-      user_profile: 'https://%s.api.blizzard.com/profile/user/%s'
+      user_profile: 'https://%s.api.blizzard.com/profile/user/%s',
+      search: 'https://%s.api.blizzard.com/data/%s/search'
     }.freeze
 
     ##

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.3.11'
+  VERSION = '0.4.0'
 end

data/lib/blizzard_api/wow.rb

@@ -5,6 +5,8 @@ module BlizzardApi
   module Wow
     require_relative 'wow/request'
     require_relative 'wow/game_data/generic_data_endpoint'
+    require_relative 'wow/search/search_composer'
+    require_relative 'wow/search/search_request'
 
     # WoW data api
     require_relative 'wow/game_data/achievement'

data/lib/blizzard_api/wow/game_data/connected_realm.rb

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.connected_realm
     class ConnectedRealm < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

data/lib/blizzard_api/wow/game_data/generic_data_endpoint.rb

@@ -48,9 +48,9 @@ module BlizzardApi
 
       protected
 
-      def endpoint_uri(variant = nil)
+      def endpoint_uri(variant = nil, scope = :game_data)
         endpoint = variant ? "#{@endpoint}-#{variant}" : @endpoint
-        "#{base_url(:game_data)}/#{endpoint}"
+        "#{base_url(scope)}/#{endpoint}"
       end
 
       def endpoint_setup

data/lib/blizzard_api/wow/game_data/realm.rb

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.realm
     class Realm < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

data/lib/blizzard_api/wow/search/search_composer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Composer for search endpoint arguments
+    class SearchComposer
+      attr_accessor :fields, :order, :page, :page_size
+
+      def initialize(page, page_size)
+        self.page = page
+        self.page_size = page_size
+        self.fields = []
+        self.order = []
+      end
+
+      ##
+      # Add a search field
+      #
+      # The second argument takes a simple value, an array of values or a hash for range searches.
+      #
+      # @param field [String] Field name
+      # @param value [String|Integer|Hash|Array<Integer|String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where(field, value)
+        fields.push "#{field}=#{resolve_value(value)}"
+        self
+      end
+
+      ##
+      # Add a search field
+      #
+      # The second argument takes a simple value, an array of values or a hash for range searches.
+      #
+      # @param field [String] Field name
+      # @param value [String|Integer|Hash|Array<Integer|String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where_not(field, value)
+        fields.push "#{field}!=#{resolve_value(value)}"
+        self
+      end
+
+      ##
+      # Add a sort field
+      #
+      # @param field [String] Field name
+      # @param mode [Symbol] :asc or :desc
+      #
+      # @return {SearchComposer}
+      def order_by(field, mode = :asc)
+        raise ArgumentError, 'Invalid order mode.' unless %i[asc desc].include? mode
+
+        order.push "#{field}:#{mode}"
+        self
+      end
+
+      ##
+      # Returns a valid queryString based on the options
+      #
+      # @return {String}
+      def to_search_query
+        query_string = "_page=#{page}&_pageSize=#{page_size}"
+        query_string += '&' + fields.join('&') unless fields.size.zero?
+        query_string += "&orderby=#{order.join(',')}" unless order.size.zero?
+        query_string
+      end
+
+      protected
+
+      def resolve_value(value)
+        return value.join '||' if value.is_a? Array
+
+        return value.to_s unless value.is_a? Hash
+
+        resolve_hash value
+      end
+
+      def resolve_hash(value)
+        min = value.key?(:min) ? value[:min] : ''
+        max = value.key?(:max) ? value[:max] : ''
+        mode = value.key?(:mode) ? value[:mode] : :inclusive
+
+        return "[#{min},#{max}]" if mode.eql? :inclusive
+
+        "(#{min},#{max})"
+      end
+    end
+  end
+end

data/lib/blizzard_api/wow/search/search_request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Added search support to an endpoint
+    module Searchable
+      ##
+      # Fetch data base on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def search(page = 1, page_size = 100, options = {})
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri(nil, :search)}?#{search_options.to_search_query}", default_options.merge(options)
+      end
+    end
+  end
+end

metadata

@@ -1,35 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "~>"
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This is a simple interface to obtain data from Blizzard API
 email:
 - francis.schiavo@francisschiavo.com
@@ -157,6 +185,8 @@ files:
 - lib/blizzard_api/wow/profile/guild.rb
 - lib/blizzard_api/wow/profile/profile.rb
 - lib/blizzard_api/wow/request.rb
+- lib/blizzard_api/wow/search/search_composer.rb
+- lib/blizzard_api/wow/search/search_request.rb
 homepage: https://gitlab.com/francisschiavo/blizzard_api
 licenses:
 - MIT
@@ -179,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API