cocRb 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677b2fcfff53c05ddb5f59305e1940b4e20d19718af145f360041c0a2357a343
-  data.tar.gz: d95a7ef479806fb6db59fb3b3b071c6a82cc2d05c5a1e31b0fbc8d3b9a402016
+  metadata.gz: 40977236bb351782aee366e88ea5d90fc6c0fef3dbe4b83f25fdf2b98e574a7f
+  data.tar.gz: f2015c08cb5d3d455a301e6e5d8a46cc82a7ef43098117cb620d729a9bfc8905
 SHA512:
-  metadata.gz: 9d149fa8289060dfea9ee62638567f0426613dcbe23860971d9655406eb521eab5c69aed10e46e1f51736b7aa3c7239c830b15fe5110eb4dd343bba7466c889e
-  data.tar.gz: 2395f768180735e2bca893d8e764c92a038b6d735890d6b7c4b8e7be5b47c4abddbebc234d6ead51f647624892d91c6a47677c9291edb0f02c3e8a1298670b46
+  metadata.gz: d8a652e3b7ed1d1d58260f40907511b5d62e432780e436631fa888c2790d1a6765489dfa222b376ad83b2ebee895c34762379a8c549bc8487c5c6ee5226abed4
+  data.tar.gz: 8b648b62dabbb6508b8a69c5179dda3f30a69d8f916bcc733c3bd32badba4e5182a1b5ad22fb90928c183baa21bfaee58a5b30b201cd725df44a7a17f69a5eba

data/lib/cocRb/api.rb

@@ -35,6 +35,7 @@ end
 end
 
 class ClashApi < Settings
+    # This method can call any of the API endpoint except the player verifier endpoint.Takes requestUrl in the configuration block.
     def self.call_API(status: false)
       get
       res = @conn.get(CocRb.configuration.url)

data/lib/cocRb/gp.rb

@@ -39,7 +39,7 @@ class Settings
    end
 
 class GoldPass < Settings
-
+     # This method gets GoldPass Information. 
      def self.get_GoldPassInfo(status: false)
             get
             res = @conn.get("v1/goldpass/seasons/current")

data/lib/cocRb/labels.rb

@@ -38,7 +38,7 @@ module CocRb
   end
 
 class Label < Settings
-
+  # This method gets Labels for the Player Profile.
   def self.get_LabelPlayer(_limit:false, status: false)
           get
           res = @conn.get("v1/labels/players") do |req|
@@ -52,7 +52,7 @@ class Label < Settings
            convert = JSON.parse(val)
       end
    end
-
+  # This method gets Labels for the Clan Profile.
   def self.get_LabelClan(_limit:false, status: false)
            get
            res = @conn.get("v1/labels/clans") do |req|

data/lib/cocRb/league.rb

@@ -37,7 +37,7 @@ module CocRb
 end
 
 class League < Settings
-
+   # This method gets League ID for all the Leagues.
    def self.get_LeaguesID(_limit:false, status:false)
               get
               res = @conn.get('v1/leagues') do |req|
@@ -53,8 +53,10 @@ class League < Settings
 
   end
 end
-
-def self.get_Seasons(leagueId:, _limit:false, status:false)
+   # This method gets season Info for Legend League, Takes League ID as a parameter.
+   #
+   # *Paramter Data Type*  => _Integer_
+  def self.get_Seasons(leagueId:, _limit:false, status:false)
               get
        if leagueId != 29000022
               puts "Not a valid League id,Seasons are only available for Legend League"
@@ -71,7 +73,9 @@ def self.get_Seasons(leagueId:, _limit:false, status:false)
           end
        end
     end
-
+       # This method gets Season Rank for Legend League, Takes League ID and Season ID as parameter.
+       #
+       # *Paramter Data Types*  => _Integer_, _String_
       def self.get_LeagueSeasonRank(leagueId:, seasonId:, _limit:false, status:false)
               get
       if leagueId != 29000022
@@ -88,7 +92,9 @@ def self.get_Seasons(leagueId:, _limit:false, status:false)
       end
    end
 end
-
+       # This method gets League Info for a particular league ID.
+       #
+       # *Paramter Data Type*  => _Integer_
        def self.get_LeagueInfo(leagueId:, status:false)
               get
               res = @conn.get("v1/leagues/#{leagueId}")
@@ -101,7 +107,7 @@ end
     end
 end
 
-
+    # This method gets War League ID.
     def self.get_WarLeagueId(_limit:false, status:false)
              get
              res = @conn.get("v1/warleagues") do |req|
@@ -115,7 +121,9 @@ end
              convert = JSON.parse(val)
         end
     end
-
+     # This method gets War League Info takes warLeagueId as a paramter.
+     #
+     # *Paramter Data Type*  => _Integer_
      def self.get_WarLeagueInfo(warLeagueId:, status:false)
              get
              res = @conn.get("v1/warleagues/#{warLeagueId}")

data/lib/cocRb/location.rb

@@ -50,7 +50,9 @@ class Location < Settings
 
   end
 end
-   # This method gets detailed location information takes Location as a paramter 
+   # This method gets detailed location information, takes Location ID as a paramter.
+   #
+   # *Paramter Data Type*  => _Integer_
    def self.get_LocationInfo(locationId:, status:false)
              get
              res = @conn.get("v1/locations/#{locationId}")
@@ -62,7 +64,9 @@ end
   end
 end
 
-
+   # This method gets all the Ranked clans for a particular Location, Takes Location id as a paramter.
+   #
+   # *Paramter Data Type*  => _Integer_
    def self.get_LocationRankClan(locationId:, _limit:false, status:false)
               get
               res = @conn.get("v1/locations/#{locationId}/rankings/clans") do |req|
@@ -75,7 +79,9 @@ end
               convert = JSON.parse(val)
   end
 end
-
+   # This method gets all the Ranked palyers for a particular Location, Takes Location id as a paramter.
+   #
+   # *Paramter Data Type*  => _Integer_
    def self.get_LocationRankPlayer(locationId:, _limit:false, status:false)
               get
               res = @conn.get("v1/locations/#{locationId}/rankings/players") do |req|
@@ -88,7 +94,9 @@ end
               convert = JSON.parse(val)
   end
 end
-
+  # This method gets all the Ranked clans for Builder Base Clan Versus Trophies, Takes Location id as a paramter.
+  #
+  # *Paramter Data Type*  => _Integer_
   def self.get_LocationRankClanVersus(locationId:, _limit:false, status:false)
               get
               res = @conn.get("v1/locations/#{locationId}/rankings/clans-versus") do |req|
@@ -101,7 +109,9 @@ end
               convert = JSON.parse(val)
   end
 end
-
+  # This method gets all the Ranked players for Builder Base Player Versus Trophies, Takes Location id as a paramter.
+  #
+  # *Paramter Data Type*  => _Integer_
   def self.get_LocationRankPlayerVersus(locationId:, _limit:false, status:false)
              get
              res = @conn.get("v1/locations/#{locationId}/rankings/players-versus") do |req|

data/lib/cocRb/player.rb

@@ -37,7 +37,9 @@ end
 end
 
   class Player < Settings
-
+     # This method gets Player Information, Takes player tag as a paramter
+     #
+     # *Paramter Data Type*  => _String_
      def self.get_PlayerByTag(tag:, status: false)
           get
           io = tag
@@ -51,7 +53,9 @@ end
           convert = JSON.parse(val)
       end
    end
-
+   # This method verifies a player, Takes tag and playertoken as a parameter.
+   #
+   # *Paramter Data Types*  => _String_
    def self.verify_PlayerByToken(tag:, playertoken:)
            get
            io = tag

data/lib/cocRb/utility.rb

@@ -37,8 +37,8 @@ end
 
 
   class Check < Settings
-
-      def self.check_headers
+       # This method gets headers for a particular endpoint. Takes the requestUrl in the configuration block.
+      def self.get_Headers
            get
            res = @conn.get(CocRb.configuration.url)
            res.headers

data/lib/cocRb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CocRb
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocRb
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Crusader123