dblruby 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26976efdbb810637c0f47ae21edb5905ae183644
-  data.tar.gz: a3efa28a57d5b232f41b2e129c8cde8ead7d7c20
+  metadata.gz: 3de08405f7a2efcc93b46c09448d9f0da4332a97
+  data.tar.gz: 76cc108bcfb280a6045329e6357780e80373acf8
 SHA512:
-  metadata.gz: 318b638e5f13794dd4558ead75598248b32786cbd64be498711505e4ee5eaef8c72b11803dc861c5e144176ccdc18d5ac2693ae379746d635be85b31cb47c640
-  data.tar.gz: 734a9d1f29f2ed8364f3648e75cc60d4fe82f2ea0dcf799a61a9bfbf547e4102ca26f1cf417b7d04f391f058774d8ca00e26084d1cbc21bf5ec9a2847dac3caa
+  metadata.gz: 0d369eb612d86b6dc4b7736813262fe4159e578e072cc7b6d4bfe2e42e065af5c81591203cc08ac516ec520fc6c331da3d24b0179d1d823755f08cba5ae973d5
+  data.tar.gz: 870a7b96543b4a18cb28bedb72d95d16c77e0172dbdd6dae244b080770b4329b19765feb56d60bcc9fda66155152f2f8385cb727f1986cfb5f683fafe86421e1

data/lib/dblruby.rb

@@ -23,7 +23,7 @@ class DBLRuby
     Bot.new(id: id)
   end
 
-  alias loadbot bot
+  alias_method :loadbot, :bot
 
   # Get all of the bot's stats as if you just called DBL.bot(id)
   # @return [Bot] the bot as a bot.
@@ -37,39 +37,49 @@ class DBLRuby
     User.new(id)
   end
 
-  alias loaduser user
+  alias_method :loaduser, :user
 
   # Change the API key
   # @param apikey [String] API Key of the bot, taken from the DBL.
   attr_writer :api
 
-  alias updateapikey api=
-  alias updateapi api=
-  alias apikey= api=
+  alias_method :updateapikey, :api=
+  alias_method :updateapi, :api=
+  alias_method :apikey=, :api=
 
   # Change the bot ID
   # @param id [Integer, String] Integer/String of the bot's id.
   attr_writer :id
 
-  alias updateid id=
+  alias_method :updateid, :id=
 
   # Define weekend
   def weekend
     Weekend.new
   end
 
+  # Skip the middleman, let's just see if it's the weekend!
+  def weekend?
+    weekend.weekend?
+  end
+
   # @see Search#initialize
   def search(search: nil, limit: 50, offset: 0, sort: nil, fields: nil)
     Search.new(search: search, limit: limit, offset: offset, sort: sort, fields: fields)
   end
 
+  # @see Widget#initialize
+  def widget(size: 'large', file_type: 'png', small_type: nil, topcolor: nil, middlecolor: nil, usernamecolor: nil, certifiedcolor: nil, datacolor: nil, labelcolor: nil, highlightcolor: nil, avatarbg: nil, leftcolor: nil, rightcolor: nil, lefttextcolor: nil, righttextcolor: nil, id: @id)
+    Widget.new(size: size, file_type: file_type, small_type: small_type, topcolor: topcolor, middlecolor: middlecolor, usernamecolor: usernamecolor, certifiedcolor: certifiedcolor, datacolor: datacolor, labelcolor: labelcolor, highlightcolor: highlightcolor, avatarbg: avatarbg, leftcolor: leftcolor, rightcolor: rightcolor, lefttextcolor: lefttextcolor, righttextcolor: righttextcolor, id: id)
+  end
+
   # Get the ID from instantiation
   attr_reader :id
 
   # Get the API Key from instantiation
   attr_reader :api
 
-  alias apikey api
+  alias_method :apikey, :api
 end
 
 # Require files.
@@ -79,3 +89,4 @@ require 'dblruby/user'
 require 'dblruby/search'
 require 'dblruby/stats'
 require 'dblruby/weekend'
+require 'dblruby/widget'

data/lib/dblruby/bot.rb

@@ -18,7 +18,7 @@ class DBLRuby::Bot
   # @return data in raw json form.
   attr_reader :data
 
-  alias to_s data
+  alias_method :to_s, :data
 
   # Return the error if there is one, nil otherwise.
   # @return [String, nil] the error.
@@ -110,8 +110,8 @@ class DBLRuby::Bot
     @data['discriminator']
   end
 
-  alias discrim discriminator
-  alias tag discriminator
+  alias_method :discrim, :discriminator
+  alias_method :tag, :discriminator
 
   # The username of the bot.
   # @return [String] the bot's username.
@@ -156,8 +156,8 @@ class DBLRuby::Bot
     @data['server_count'].to_i
   end
 
-  alias guild_count server_count
-  alias server server_count
+  alias_method :guild_count, :server_count
+  alias_method :server, :server_count
 
   # Get the bot's "This Bot Powers the following Servers"
   # @return [Array<String>] the bot's guilds.
@@ -165,7 +165,7 @@ class DBLRuby::Bot
     @data['guilds']
   end
 
-  alias servers guilds
+  alias_method :servers, :guilds
 
   # Get the bot's shards.
   # @return [Array<String>] the bot's shards.
@@ -179,7 +179,7 @@ class DBLRuby::Bot
     @data['monthlyPoints'].to_i
   end
 
-  alias monthlyvotes monthlypoints
+  alias_method :monthlyvotes, :monthlypoints
 
   # The amount of upvotes the bot has.
   # @return [Integer] the bot's total points/votes.
@@ -187,7 +187,7 @@ class DBLRuby::Bot
     @data['points'].to_i
   end
 
-  alias votes points
+  alias_method :votes, :points
 
   # The certified status of the bot.
   # @return [true, false] the bot's certified status.
@@ -195,9 +195,9 @@ class DBLRuby::Bot
     @data['certifiedBot']
   end
 
-  alias certifiedbot certified?
-  alias certified certified?
-  alias certifiedbot? certified?
+  alias_method :certifiedbot, :certified?
+  alias_method :certified, :certified?
+  alias_method :certifiedbot?, :certified?
 
   # The owners of the bot. First one in the array is the main owner.
   # @return [Array<String>] the bot's owners in an array.
@@ -217,5 +217,5 @@ class DBLRuby::Bot
     @data['donatebotguildid']
   end
 
-  alias donatebotserverid donatebotguildid
+  alias_method :donatebotserverid, :donatebotguildid
 end

data/lib/dblruby/errors.rb

@@ -1,14 +1,17 @@
 # Errors are cool.
 module DBLRuby::Errors
-  # Ran if a 404 error is returned in #loadbot
+  # Raised if a 404 error is returned in #bot
   class InvalidBot < RuntimeError; end
 
-  # Ran if a 404 error is returned in #loaduser
+  # Raised if a 404 error is returned in #user
   class InvalidUser < RuntimeError; end
 
-  # Ran if a 401 unauthorized error is returned in stats.
+  # Raised if a 401 unauthorized error is returned in stats.
   class InvalidAPIKey < RuntimeError; end
 
-  # Ran if a 404 unknown error is returned in stats.
+  # Raised if a 404 unknown error is returned in stats.
   class InvalidID < RuntimeError; end
+
+  # Rasied if an invalid Widget parameter is specified
+  class InvalidWidget < RuntimeError; end
 end

data/lib/dblruby/search.rb

@@ -23,7 +23,7 @@ class DBLRuby::Search
   # @return data in raw json form.
   attr_reader :data
 
-  alias to_s data
+  alias_method :to_s, :data
 
   # @return [String] the search query
   attr_reader :search

data/lib/dblruby/stats.rb

@@ -18,7 +18,7 @@ class DBLRuby::Stats
           'DBL Returned a 404 unknown error! Did you enter the correct ID?'
   end
 
-  alias servers servercount
+  alias_method :servers, :servercount
 
   # Update the bot's server count.
   # @param count [Integer, Array<Integer>] Integer/String of bot server count.
@@ -40,7 +40,7 @@ class DBLRuby::Stats
           'There was an error posting stats to the DBL. Is your API key ok?'
   end
 
-  alias servers= updateservercount
+  alias_method :servers=, :updateservercount
 
   # Check to see if a user really voted, via an ID.
   # @param id [Integer, String] Integer/String ID of user you're requesting.

data/lib/dblruby/user.rb

@@ -14,7 +14,7 @@ class DBLRuby::User
   # @return data in raw json form.
   attr_reader :data
 
-  alias to_s data
+  alias_method :to_s, :data
 
   # Return the error if there is one, nil otherwise.
   # @return [String, nil] the error.
@@ -46,8 +46,8 @@ class DBLRuby::User
     @data['discriminator'].delete('#').to_i
   end
 
-  alias discrim discriminator
-  alias tag discriminator
+  alias_method :discrim, :discriminator
+  alias_method :tag, :discriminator
 
   # Returns the user's distinct, which is the Username and Discriminator.
   # @return [String] the user's username + discrim.
@@ -133,7 +133,7 @@ class DBLRuby::User
     @data['color']
   end
 
-  alias colour color
+  alias_method :colour, :color
 
   # The supporter status of the user.
   # @return [true, false] the user's supporter status.
@@ -141,7 +141,7 @@ class DBLRuby::User
     @data['supporter']
   end
 
-  alias supporter supporter?
+  alias_method :supporter, :supporter?
 
   # The certified status of the user.
   # @return [true, false] the user's certified status.
@@ -149,9 +149,9 @@ class DBLRuby::User
     @data['certifiedDev']
   end
 
-  alias certified certified?
-  alias certifieddev certified
-  alias certifieddev? certified
+  alias_method :certified, :certified?
+  alias_method :certifieddev, :certified
+  alias_method :certifieddev?, :certified
 
   # The mod status of the user.
   # @return [true, false] the user's mod status.
@@ -159,7 +159,7 @@ class DBLRuby::User
     @data['mod']
   end
 
-  alias mod mod?
+  alias_method :mod, :mod?
 
   # The website moderator status of the user.
   # @return [true, false] the user's website mod status.
@@ -167,7 +167,7 @@ class DBLRuby::User
     @data['webMod']
   end
 
-  alias webmod webmod?
+  alias_method :webmod, :webmod?
 
   # The admin status of the user.
   # @return [true, false] the user's admin status.
@@ -175,5 +175,5 @@ class DBLRuby::User
     @data['admin']
   end
 
-  alias admin admin?
+  alias_method :admin, :admin?
 end

data/lib/dblruby/weekend.rb

@@ -9,7 +9,7 @@ class DBLRuby::Weekend
   # @return data in raw json form.
   attr_reader :data
 
-  alias to_s data
+  alias_method :to_s, :data
 
   # Return the whether it's the weekend.
   # @return [true, false] the weekend status.
@@ -17,5 +17,5 @@ class DBLRuby::Weekend
     @data['is_weekend']
   end
 
-  alias isweekend weekend?
+  alias_method :isweekend, :weekend?
 end

data/lib/dblruby/widget.rb

@@ -0,0 +1,119 @@
+# Make a widget
+class DBLRuby::Widget
+  BASE_URL = 'https://discordbots.org/api/widget/'.freeze
+
+  # Make a new widget
+  # @param size ['large', 'small'] The size of the widget.
+  # @param file_type ['png', 'svg'] The file type of the image
+  # @param small_type ['owner', 'status', 'upvotes', 'servers', 'lib'] The type of small widget.
+  # @param topcolor [Hexadecimal] The top color of the widget (Large)
+  # @param middlecolor [Hexadecimal] The middle color of the widget (Large)
+  # @param usernamecolor [Hexadecimal] The username color of the widget (Large)
+  # @param certifiedcolor [Hexadecimal] The certified color of the widget (Large)
+  # @param datacolor [Hexadecimal] The data color of the widget (Large)
+  # @param labelcolor [Hexadecimal] The label color of the widget (Large)
+  # @param highlightcolor [Hexadecimal] The highlight color of the widget (Large)
+  # @param avatarbg [Hexadecimal] The avatar background color of the widget (Small)
+  # @param leftcolor [Hexadecimal] The left color of the widget (Small)
+  # @param rightcolor [Hexadecimal] The right color of the widget (Small)
+  # @param lefttextcolor [Hexadecimal] The left text color of the widget (Small)
+  # @param righttextcolor [Hexadecimal] The right text color of the widget (Small)
+  # @param noavatar [true, false] Whether there should be an avatar (Small)
+  def initialize(size: 'large', file_type: 'png',
+                 small_type: nil,
+                 topcolor: nil, middlecolor: nil, usernamecolor: nil, certifiedcolor: nil, datacolor: nil, labelcolor: nil, highlightcolor: nil,
+                 avatarbg: nil, leftcolor: nil, rightcolor: nil, lefttextcolor: nil, righttextcolor: nil, noavatar: nil,
+                 id: nil)
+    @size = size
+    @file_type = file_type
+    @small_type = small_type
+    @topcolor = topcolor
+    @middlecolor = middlecolor
+    @usernamecolor = usernamecolor
+    @certifiedcolor = certifiedcolor
+    @datacolor = datacolor
+    @labelcolor = labelcolor
+    @highlightcolor = highlightcolor
+    @avatarbg = avatarbg
+    @leftcolor = leftcolor
+    @rightcolor = rightcolor
+    @lefttextcolor = lefttextcolor
+    @righttextcolor = righttextcolor
+    @noavatar = noavatar
+    @id = id
+
+    raise DBLRuby::Errors::InvalidWidget, 'Small size specified but no small type was provided' if @size == 'small' && @small_type.nil?
+    raise DBLRuby::Errors::InvalidWidget, 'Small parameter specified for large widget' if @size == 'large' && (!@avatarbg.nil? || !@leftcolor.nil? || !@rightcolor.nil? || !@lefttextcolor.nil? || !@righttextcolor.nil? || !@noavatar.nil?)
+    raise DBLRuby::Errors::InvalidWidget, 'Large parameter specified for small widget' if @size == 'small' && (!@topcolor.nil? || !@middlecolor.nil? || !@usernamecolor.nil? || !@certifiedcolor.nil? || !@datacolor.nil? || !@labelcolor.nil? || !@highlightcolor.nil?)
+
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid size' unless %w[small large].include? @size
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid small widget type' if @size == 'small' && !%w[owner status upvotes servers lib].include?(@small_type)
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid file type' unless %w[png svg].include? @file_type
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid noavatar parameter' unless %w[true false].include? @noavatar
+  end
+
+  def size=(size)
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid size' unless %w[small large].include? size
+
+    @size = size
+  end
+
+  def file_type=(file_type)
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid file type' unless %w[png svg].include? file_type
+
+    @file_type = file_type
+  end
+
+  def small_type=(small_type)
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid small widget type' if @size == 'small' && !%w[owner status upvotes servers lib].include?(small_type)
+
+    @small_type = small_type
+  end
+
+  attr_writer :topcolor
+  attr_writer :middlecolor
+  attr_writer :usernamecolor
+  attr_writer :certifiedcolor
+  attr_writer :datacolor
+  attr_writer :labelcolor
+  attr_writer :highlightcolor
+  attr_writer :avatarbg
+  attr_writer :leftcolor
+  attr_writer :rightcolor
+  attr_writer :lefttextcolor
+  attr_writer :righttextcolor
+
+  def noavatar=(noavatar)
+    raise DBLRuby::Errors::InvalidWidget, 'Invalid noavatar parameter' unless %w[true false].include? noavatar
+
+    @noavatar = noavatar
+  end
+
+  # @return [String] The URL, ready for linking.
+  def url
+    params = []
+    if @size == 'large'
+      params.push("topcolor=#{@topcolor}") unless @topcolor.nil?
+      params.push("middlecolor=#{@middlecolor}") unless @middlecolor.nil?
+      params.push("usernamecolor=#{@usernamecolor}") unless @usernamecolor.nil?
+      params.push("certifiedcolor=#{@certifiedcolor}") unless @certifiedcolor.nil?
+      params.push("datacolor=#{@datacolor}") unless @datacolor.nil?
+      params.push("labelcolor=#{@labelcolor}") unless @labelcolor.nil?
+      params.push("highlightcolor=#{@highlightcolor}") unless @highlightcolor.nil?
+      output = "#{BASE_URL}#{@id}.#{@file_type}"
+    elsif @size == 'small'
+      params.push("avatarbg=#{@avatarbg}") unless @avatarbg.nil?
+      params.push("leftcolor=#{@leftcolor}") unless @leftcolor.nil?
+      params.push("rightcolor=#{@rightcolor}") unless @rightcolor.nil?
+      params.push("certifiedcolor=#{@certifiedcolor}") unless @certifiedcolor.nil?
+      params.push("lefttextcolor=#{@lefttextcolor}") unless @lefttextcolor.nil?
+      params.push("righttextcolor=#{@labelcolor}") unless @righttextcolor.nil?
+      params.push("noavatar=#{@noavatar}") unless @noavatar.nil?
+      output = "#{BASE_URL}#{@small_type}/#{@id}.#{@file_type}"
+    end
+    output += "?#{params.join('&')}" unless params.length.zero?
+    output
+  end
+
+  alias_method :to_s, :url
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dblruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chewsterchew
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-10 00:00:00.000000000 Z
+date: 2018-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,13 +45,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/dblruby.rb
-- lib/dblruby/api.rb
 - lib/dblruby/bot.rb
 - lib/dblruby/errors.rb
 - lib/dblruby/search.rb
 - lib/dblruby/stats.rb
 - lib/dblruby/user.rb
 - lib/dblruby/weekend.rb
+- lib/dblruby/widget.rb
 homepage: http://github.com/Chewsterchew/DBLRuby
 licenses:
 - MIT

data/lib/dblruby/api.rb

@@ -1,11 +0,0 @@
-# What api
-class DBLRuby::API
-  # Run a simple GET request.
-  # @return [JSON] whatever rest-client returned, but parsed.
-  def get(url)
-    r = RestClient.get(url,
-                       :Authorization => DBLRuby.api,
-                       :'Content-Type' => :json)
-    JSON.parse(r)
-  end
-end