fishbans 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20aabf428819fc6d0e2f63b183101ee57c026271
-  data.tar.gz: 7256f0174fddaf8481d99b61330ffa2ad7d0e34d
+  metadata.gz: 2fdccbe25f25cc750106b8bddd7f5a160918df97
+  data.tar.gz: eb98194d6ad4d4a1a9528f1a00ba10696ec0e308
 SHA512:
-  metadata.gz: 717cfcadbc596bd3a9cca44295ea184f58dda3f7b45afe1ba4ae77910de91f375df57bb1645dc6afda08f3a4363e9d347ad723ecffad5dc8b7b4346de75cf626
-  data.tar.gz: d224e2e877e3fd75750a4f8fe3f1625e2ec66b37ac9ece33d66cfa9589b86418805b1cd6ee34d7498717a1cc2bf3a2c2a4a4f9438971147677e465bbb0c1e722
+  metadata.gz: 7035bb24577060be3cc5b81db32a140b54caab32378247751d0e94a6ba542bd55d30d41ddf56460a8f2c3f624b6b0abc7f50cbb68cd15c5f9c8217df6ff58fe8
+  data.tar.gz: adb94c0aa95e11935a201ea570a3ac57271ea81c828684f48cc06cf65dadbb16bc8eb45e4cb8f6c0da3779f31bc543d11d8e4804db9e8c3c0bd7cb318371088d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 ## Version 1
+### Version 1.1.0
+* New PlayerSkins module, including methods for getting player faces, fronts, and skins.
+* New BlockEngine module, including methods for getting 3D block images, 2D monster face images, and 3D full monster images.
+
 ### Version 1.0.1
 * Fix NoMethodError with get
 

data/lib/block_engine.rb

@@ -0,0 +1,42 @@
+require 'chunky_png'
+require_relative 'fishbans'
+
+module Fishbans
+  module BlockEngine
+    # Gets a block image by its ID and Metadata. Unfortunately it uses the old
+    #   block IDs rather than the new ones, so you have to memorize those
+    #   pesky integers.
+    # @param id [Fixnum] The (outdated) block ID number.
+    # @param metadata [Fixnum] The metadata, if any, for the block.
+    # @param size [Fixnum] The size of the image to get.
+    # @return [ChunkyPNG::Image] The ChunkyPNG instance of that block image.
+    def get_block(id, metadata = nil, size = 42)
+      url = "http://blocks.fishbans.com/#{id}"
+      url += "-#{metadata}" unless metadata.nil?
+      url += "/#{size}" if size != 42
+      response = get(url, false)
+      ChunkyPNG::Image.from_blob(response.body)
+    end
+
+    # Gets the monster image by its ID.
+    # @param id [Any] The string ID. It will automatically prefix it with "m" if
+    #   that is omitted. It doesn't matter what type it is: String or Fixnum,
+    #   because it will automatically convert it to a String.
+    # @param three [Boolean] Whether to get a three-dimensional monster image.
+    #   The three-dimensional image is of the full monster, while the
+    #   two-dimensional image is just its head.
+    # @param size [Fixnum] The size of the image (width) to get. For 3D images
+    #   this will not be perfect just by nature of the API.
+    # @return [ChunkyPNG::Image] The ChunkyPNG instance of that monster image.
+    def get_monster(id, three = false, size = 42)
+      id = id.to_s unless id.is_a?(String)
+      url = 'http://blocks.fishbans.com'
+      url += "/#{id}" if id =~ /^m/
+      url += "/m#{id}" if id !~ /^m/
+      url += '-3d' if three
+      url += "/#{size}" if size != 42
+      response = get(url, false)
+      ChunkyPNG::Image.from_blob(response.body)
+    end
+  end
+end

data/lib/fishbans.rb

@@ -1,7 +1,12 @@
 require 'httpclient'
 require 'json'
+require_relative 'block_engine'
+require_relative 'player_skins'
 
 module Fishbans
+  include BlockEngine
+  include PlayerSkins
+
   extend self
   @client = HTTPClient.new
   @services = [
@@ -109,13 +114,16 @@ module Fishbans
   end
 
   private
+
   # Performs a basic GET request.
   # @param url [String] The URL to get.
+  # @param do_json [Boolean] Whether to parse the JSON.
   # @return [JSON/String] The parsed JSON of the response, or the error string.
-  def get(url)
+  def get(url, do_json = true)
     url = URI.encode(url)
     uri = URI.parse(url)
     response = @client.get(uri)
+    return response if do_json == false
     json = JSON.parse(response.body)
     if json['success']
       return json
@@ -141,6 +149,6 @@ module Fishbans
     end
 
     return nil if ret.empty?
-    return ret
+    ret
   end
 end

data/lib/player_skins.rb

@@ -0,0 +1,45 @@
+require 'chunky_png'
+require_relative 'fishbans'
+
+module Fishbans
+  module PlayerSkins
+    # Gets the image for the front face of the player head.
+    # @param username [String] The username to get the head of.
+    # @param size [Fixnum] The width of the image to get.
+    # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that head.
+    def get_player_head(username, size = 100)
+      get_player_image(username, 'helm', size)
+    end
+
+    # Gets the image for the entire front of the player.
+    # @param username [String] See #get_player_head.
+    # @param size [Fixnum] See #get_player_head.
+    # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that front.
+    def get_player_front(username, size = 100)
+      get_player_image(username, 'player', size)
+    end
+
+    # Gets the image for the player's raw skin.
+    # @param username [String] See #get_player_head.
+    # @param size [Fixnum] See #get_player_head.
+    # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance of that skin.
+    def get_player_skin(username, size = 64)
+      get_player_image(username, 'skin', size)
+    end
+
+    private
+
+    # Gets the player image for the type.
+    # @param username [String] See #get_player_head.
+    # @param type [String] The type of image to get. Can be 'helm', 'player', or
+    #   'skin' as defined by the Fishbans Player Skins API.
+    # @param size [Fixnum] See #get_player_head.
+    # @return [ChunkyPNG::Image] The ChunkyPNG::Image instance for the params.
+    def get_player_image(username, type, size)
+      type.downcase
+      url = "http://i.fishbans.com/#{type}/#{username}/#{size}"
+      response = get(url, false)
+      ChunkyPNG::Image.from_blob(response.body)
+    end
+  end
+end

metadata

@@ -1,38 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: fishbans
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-18 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
+- !ruby/object:Gem::Dependency
+  name: chunky_png
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
 description: Accessing the Fishbans Minecraft API through HTTPClient. Has methods
-  for all Fishban APIs.
+  for all Fishban APIs, including the APIs for getting block, monster, and player
+  images.
 email: elifosterwy@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- lib/block_engine.rb
 - lib/fishbans.rb
+- lib/player_skins.rb
 homepage: https://github.com/elifoster/fishbans-rb
 licenses:
 - CC-BY-NC-ND-4.0
@@ -59,3 +76,4 @@ signing_key:
 specification_version: 4
 summary: A Ruby gem for accessing the Fishbans Minecraft API.
 test_files: []
+has_rdoc: