badass 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad92642294a82e45d74eee7ca279dd8f27f2dd43ee4dcc48632d9d61cd1424a
-  data.tar.gz: 753db292948290dcf49a84b4255a244e0abbfef652727014213037887aa7322c
+  metadata.gz: '0580bae8125e3617dc67f8d4af1ddac75074a1ddbcf904a73a0bf4a86ea79fb5'
+  data.tar.gz: 14197b74f3bbb0c229d6ee3329d0033acc88cc318c75fdb6ec083e62eb92dc0b
 SHA512:
-  metadata.gz: f687086cca8eb3463aa1ac578dc1c6f92e4f51a5f348c4736f5541b96390e0aa0cad738b2831be1e0ecd64e791180fa60464e401726abd096097c74b7f3a5ee1
-  data.tar.gz: 27b315a2ce06d51b868a8bceed5e2a8640a5f7ce44f318d6037a95ce980b67fa9f4c469fab071ce863b75f5878b114ad7f22aea76d9bcae610aed6a9d660d9e9
+  metadata.gz: 0536b342f82207dfcd831042ff07e11038cde4e550910eda2c256e6d31bbd1201b124cebfd5afc9e00fbf3075de7d6f65e5c0278d8f9d056ad8de887ece4b675
+  data.tar.gz: 4f412703af4a0d5c5ed01b829d8efc34f35d452487f7a4e23ab6524824b4f84591b835fd1ef623721fd8d29c6bf2b8c2dad102f947b2193871437460a86b9874

data/lib/badass.rb

@@ -1,24 +1,39 @@
 require 'net/http'
 require 'json'
 require 'date'
-
-# https://gist.github.com/chetan/1827484
+# @todo Add rspec testing.
+# Contains a few constants used across BD's site, and a few helper methods.
 module BadASS
+  # A hash of API mappings of number to firmness.
   FIRMNESSES = { '2' => 'Extra Soft', '3' => 'Soft', '5' => 'Medium', '8' => 'Firm', '3/5' => 'Soft Shaft, Med Base', '5/3' => 'Soft Shaft, Med Base', '3/8' => 'Soft Shaft, Firm Base', '8/3' => 'Soft Shaft, Firm Base', '5/8' => 'Med Shaft, Firm Base', '8/5' => 'Med Shaft, Firm Base' }.freeze
+  # A hash of API mappings to correctly capitalize a size.
   SIZES = { 'onesize' => 'One-Size', 'mini' => 'Mini', 'small' => 'Small', 'medium' => 'Medium', 'large' => 'Large', 'extralarge' => 'Extra Large' }.freeze
+  # A hash of API mappings of toy SKU to toy name.
+  BAD_DRAGON_SKUS = JSON.parse(Net::HTTP.get(URI('https://bad-dragon.com/api/inventory-toy/product-list'))).map { |toy| { toy['sku'] => toy['name'] } }.reduce({}, :update)
 
-  @baddragon_skus = {}
-  JSON.parse(Net::HTTP.get(URI('https://bad-dragon.com/api/inventory-toy/product-list'))).each do |toy|
-    @baddragon_skus[toy['sku']] = toy['name']
-  end
-  BAD_DRAGON_SKUS = @baddragon_skus.freeze
-
-  # Gets the current sales. Returns a hash of sales.
+  # Get the current sales on the site.
+  # @return [Array<BadASS::Sale>]
   def self.sales
     JSON.parse(Net::HTTP.get(URI('https://bad-dragon.com/api/sales'))).map do |sale|
       BadASS::Sale.new(sale)
     end
   end
+
+  # Get the current drops on the site.
+  # @return [Array<BadASS::Toy>]
+  def self.drops
+    page = 1
+    toy_list = []
+    loop do
+      newtoys = JSON.parse(Net::HTTP.get(URI("https://bad-dragon.com/api/inventory-toys?price[min]=0&price[max]=300&noAccessories=false&cumtube=false&suctionCup=false&sort[field]=price&&sort[direction]=asc&page=#{page}&limit=60")))
+      page += 1
+      newtoys['toys'].each do |toy|
+        toy_list << BadASS::Toy.new(toy)
+      end
+      break if page > newtoys['totalPages']
+    end
+    toy_list
+  end
 end
 
 require 'badass/client'

data/lib/badass/client.rb

@@ -1,25 +1,17 @@
+# A client to periodically check for new toys and news to avoid spamming the BD API directly.
 class BadASS::Client
-  # Creates a client to do operations.
-  # Takes a :refresh_time argument to define how often the toy list should be refreshed.
-  def initialize(refresh_time: 600)
+  # Creates a client to do API operations.
+  # @param refresh_rate [Integer] the rate at which the Client should refresh its list of toys.
+  def initialize(refresh_rate: 600)
     Thread.new do
-      @toys = []
-      loop do
-        page = 1
-        toy_list = []
-        loop do
-          newtoys = JSON.parse(Net::HTTP.get(URI("https://bad-dragon.com/api/inventory-toys?price[min]=0&price[max]=300&noAccessories=false&cumtube=false&suctionCup=false&sort[field]=price&&sort[direction]=asc&page=#{page}&limit=60")))
-          page += 1
-          newtoys['toys'].each do |toy|
-            toy_list << BadASS::Toy.new(toy)
-          end
-          break if page > newtoys['totalPages']
-        end
-        @toys = toy_list
-        sleep(refresh_time)
-      end
+      @toys = BadASS.drops
+      @sale = BadASS.sales
+      sleep(refresh_rate)
     end
   end
 
-  attr_reader :toys
+  # @return [Array<BadASS::Toy>] the current drops
+  attr_reader :drops
+  # @return [Array<BadASS::Sale>] the current BD sales
+  attr_reader :sales
 end

data/lib/badass/sale.rb

@@ -1,5 +1,7 @@
+# Base class containing a Bad Dragon sale and it's attributes.
 class BadASS::Sale
   # Create a Sale object using a hash from the API.
+  # @param [Hash]
   def initialize(sale_hash)
     @title = sale_hash['title']
     @description = JSON.parse(sale_hash['content'])['blocks'].map { |x| x['text'] }.join("\n")
@@ -8,9 +10,14 @@ class BadASS::Sale
     @end_date = Date.rfc3339(sale_hash['endDate']) rescue nil
   end
 
+  # @return [String] the title of the sale
   attr_reader :title
+  # @return [String] the description of the sale
   attr_reader :description
+  # @return [String] the image URL of the sale
   attr_reader :image
+  # @return [Date] the start date of the sale
   attr_reader :start_date
+  # @return [Date] the end date of the sale
   attr_reader :end_date
 end

data/lib/badass/toy.rb

@@ -1,5 +1,7 @@
+# Base class containing a Bad Dragon toy and it's attributes.
 class BadASS::Toy
   # Create a Toy object using a hash from the API.
+  # @param [Hash]
   def initialize(toy_hash)
     @id = toy_hash['id']
     @sku = toy_hash['sku']
@@ -16,30 +18,48 @@ class BadASS::Toy
     @images = toy_hash['images'].map { |toy| toy['fullFilename'] }
   end
 
+  # Gets the full product name of the toy.
+  # @return [String]
   def name
     BadASS::BAD_DRAGON_SKUS[@sku]
   end
 
+  # Checks if a toy has a cumtube or not.
+  # @return [Boolean]
   def cumtube?
     @cumtube == 1
   end
 
+  # Checks if a toy has a suction cup or not.
+  # @return [Boolean]
   def suction_cup?
     @suction_cup == 1
   end
 
+  # Gets the firmness of a toy.
+  # @return [String]
   def firmness
     BadASS::FIRMNESSES[@firmness]
   end
 
+  # @return [Integer] the ID of the toy
   attr_reader :id
+  # @return [String] the SKU of the toy
   attr_reader :sku
+  # @return [String] the size of the toy
   attr_reader :size
+  # @return [Integer] the price of the toy
   attr_reader :price
+  # @return [Float] the weight of the toy
   attr_reader :weight
+  # @return [String] the color of the toy
   attr_reader :color
+  # @return [Array(Integer, Integer, Integer)] the 3 colors of the toy
   attr_reader :colors
+  # @return [String] the flop reason of a toy
   attr_reader :flop_reason
+  # @return [String] the type of a toy
   attr_reader :type
+  # @return [Array] the image URLs of a toy
   attr_reader :images
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: badass
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - charagarlnad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-19 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies: []
 description: A simple Bad Dragon Assistant Gem.
 email: ''