cocRb 0.1.0 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5c340e9ec2ae5de4aad4c5f78d71e17cb0cf6eccd868e1ad960b4b5b55e2e2
-  data.tar.gz: 8698ed7dbdc391115227f824f6726fd21c32e4f6aeb8bbd2ff0c65112d25117d
+  metadata.gz: b993cb156228909ec86fb7a2602349d0716bb3f7d992f6ee6dda3170956e0fed
+  data.tar.gz: 8cd7de5ac75640877bf3050202eb09c800e7ad2a53f4958b899a4f31cb8dd91e
 SHA512:
-  metadata.gz: 31413353c3f9abc2d5f415a38241325bf1641cae63c75468b33bc28b05d7d05ed0b5d0a87a79e56266327f2333aa4b3d0d1370604cf03e9bbe56f758d77aba29
-  data.tar.gz: acc6c624a66eccc409a7d4db563ec4d4b3563ead9ce18b51776b232f2d419616c0b613cef217016a611512f16dd185f8085d349ea8998f6e6b0c56c7f6ab6cfd
+  metadata.gz: 17538b7183c09c3787d0cf9577b5aee4948acd1c213da5ace2b981dea8b3476056edcf317b8aca1e5aa969b2ade1df8b693fc9e463ca1733bd3a37cbbf830ed5
+  data.tar.gz: 9d04f8a661feebf5619607d96c55999e7186ba8e387608a997906950a6b578786740acac868937948260fa3d6b8f24c6f737bdfb3b3e6dcdaa3752a182b358ed

data/README.md

@@ -1,35 +1,123 @@
-# CocRb
-
-Welcome everyone to your Ruby Gem CocRb. By using this gem you can easily interact with the Game API of Clash of Clans. Without using any external gems to call the API.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'cocRb'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install cocRb
-
-## Usage
-
-TODO: Write usage instructions here
-
-After the development will do..
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+![coc Rb](https://media.discordapp.net/attachments/662341843861766164/840316348554412042/unknown-removebg-preview.png)
+
+# CocRb
+
+Welcome everyone to your Ruby Gem CocRb. By using this gem you can easily interact with the Game API of Clash of Clans without using any external gems to call this service.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cocRb'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cocRb
+
+
+# Links
+
+* Full Documentation
+* [GEM](https://rubygems.org/gems/cocRb)
+
+
+
+## Optional Paramters
+
+ * **status**: This is default set to false on every method except *verify_PlayerByToken* method. The method Parameter takes any String as an arguement.
+  **Returns => Status Code for a method**
+
+ * **_limit**: This is also set to false. You can *limit* any request where limit parameter is available for a method.
+  **Paramter Data Type => Integer**
+
+
+## Method Options
+
+### Filter Options
+
+* warFrequency
+* locationId
+* minMembers
+* maxMembers
+* minClanPoints
+* minClanLevel
+
+### Team Input Options
+
+* clan
+* opponent
+
+## Status Codes
+
+* **200**: Successful Response.
+* **400**: Client provided incorrect parameters for the request.
+* **403**: Access denied, either because of missing/incorrect credentials or used API token does not grant access to the requested resource.
+* **404**: Resource was not found.
+* **429**: Request was throttled, because amount of requests was above the threshold defined for the used API token.
+* **500**: Unknown error happened when handling the request.
+* **503**: Service is temporarily unavailable because of maintenance.
+* **504**: Request Timeout.
+
+
+## Usage
+CocRb Gem is categorized with [Classes](https://www.tutorialspoint.com/ruby/ruby_classes.htm) and [Methods](https://www.tutorialspoint.com/ruby/ruby_methods.htm) as below down you can see but before accessing any of those we have to set **Configuration** in order to setup the Authorization for accessing the [Clash of Clans API](https://developer.clashofclans.com/#) so to do that we have set **Configure** block and inside that block we have configured our **TOKEN** and the **URL**.
+
+
+```ruby
+token = <Your_Token>
+requestUrl = <Your_Url>
+
+CocRb.configure do |config|
+     config.token = token
+     config.url = requestUrl
+end
+```
+After done setting up the Authorization we now need to call the API as you can see down below we called the API using **call_API** method now just before that line we have set the class **ClashApi** by name_spacing with **CocRb** [Module](https://www.tutorialspoint.com/ruby/ruby_modules.htm).
+
+**Note:** All the data that we will get from the API response was in [JSON](https://jsonapi.org/) but since you are using this gem all of the responses has been **parsed** to Ruby [Hashes](https://www.tutorialspoint.com/ruby/ruby_hashes.htm) so that its get easy for you to access the data.
+
+
+```ruby
+set_Class = CocRb::ClashApi
+
+response = set_Class.call_API
+
+puts response
+
+# data from the API in Ruby Hashes...
+```
+
+The API can also be called without using the **URL** in the Configuration block the way you can do is shown down below. As you can we have almost followed the same procedure like we did before just changed few things those are we have removed the *config.url* line, We now have called a new class and a method. This method now takes two parameters one is your [Player Tag](https://clashofclans.fandom.com/wiki/Player_Profile#:~:text=The%20player%27s%20name%20and%20player,they%20are%20in%20a%20clan) and another thing is your [Player API Token](eddit.com/r/ClashOfClans/comments/apebtq/ask_what_is_an_api_token/) which you will find **In-Game Settings**.
+
+
+
+```ruby
+
+CocRb.configure do |config|
+     config.token = token
+end
+
+set_var = CocRb::Player   
+
+response = set_var.verify_PlayerByToken(tag: "#PG8RLGQ2", playertoken: "7jeagw4c")
+
+# Response => {"tag"=>"#PG8RLGQ2", "token"=>"7jeagw4c", "status"=>"ok"}
+
+```
+
+## Support
+
+* If you need any help understanding the Library, you can join our [Discord Server](https://discord.gg/Eaja7gJ)
+* OR You can create a new Issue on this Repo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cocRb.rb

@@ -1,29 +1,17 @@
-require_relative 'cocRb/clan'
-require_relative 'cocRb/utility'
-require_relative 'cocRb/api'
-require_relative 'cocRb/clanWar'
-require_relative 'cocRb/gp'
-require_relative 'cocRb/labels'
-require_relative 'cocRb/league'
-require_relative 'cocRb/loactions'
-require_relative 'cocRb/player'
+require_relative './cocRb/clan'
+require_relative './cocRb/utility'
+require_relative './cocRb/api'
+require_relative './cocRb/clanWar'
+require_relative './cocRb/gp'
+require_relative './cocRb/labels'
+require_relative './cocRb/league'
+require_relative './cocRb/location'
+require_relative './cocRb/player'
+
+require 'rdoc'
 require 'faraday'
 require 'time'
 require "json"
 
- token = "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiIsImtpZCI6IjI4YTMxOGY3LTAwMDAtYTFlYi03ZmExLTJjNzQzM2M2Y2NhNSJ9.eyJpc3MiOiJzdXBlcmNlbGwiLCJhdWQiOiJzdXBlcmNlbGw6Z2FtZWFwaSIsImp0aSI6IjA4M2E3NWQ4LTE3NGMtNDBmZC1hZjdlLWE1MGVmODEyZDU3ZiIsImlhdCI6MTU5NzIyMDQxOSwic3ViIjoiZGV2ZWxvcGVyL2Q1NWNjNDdhLTBmYjUtNDM5Yi00N2Q2LWFkZTIyMzIwMzJhYSIsInNjb3BlcyI6WyJjbGFzaCJdLCJsaW1pdHMiOlt7InRpZXIiOiJkZXZlbG9wZXIvc2lsdmVyIiwidHlwZSI6InRocm90dGxpbmcifSx7ImNpZHJzIjpbIjEwMy42MC4xNzUuNjMiXSwidHlwZSI6ImNsaWVudCJ9XX0.0r0WB3cL6rVco9DqFMnOG4s-g1sroQebE69iUHSXYepzwSc5ZDy1e4qstvAN_fOu-fN9cg37NmsAdv_elVZWpg"
-
-CocRb.configure do |config|
-     config.token = token
-end
-
-conn = CocRb::Player
-
-get = conn.getPlayerBy_Tag(tag: "#8LR0RUGJU", status: "check_status")
-
-if get == 503
-puts "The Server is under Maintenance, Try again later."
-else
 module CocRb
 end
-end

data/lib/cocRb/api.rb

@@ -1,50 +1,50 @@
-require 'faraday'
+require "faraday"
 require "json"
 
 module CocRb
   class << self
-      attr_accessor :configuration
-    end
+       attr_accessor :configuration
+  end
 
-    def self.configure
-      @configuration ||= Configuration.new
-      yield(configuration)
-    end
+  def self.configure
+       @configuration ||= Configuration.new
+       yield(configuration)
+  end
 
     class Configuration
-      attr_accessor :token, :url
-
+        attr_accessor :token, :url
       def initialize
         @token = nil
         @url = nil
-      end
-    end
+   end
+end
+
   class Settings
-  def self.get
-     @conn = Faraday.new(
-       url: CocRb.configuration.url,
+     def self.get
+       @conn = Faraday.new(
+       url: CocRb.configuration.url ,
        headers: {
-         'Content-Type' => 'application/json',
-         'Authorization' => "Bearer #{CocRb.configuration.token}"
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{CocRb.configuration.token}"
        }
      )
-     rescue => e
-      raise "Oops Unexpected error Caught!"
-      puts e
+  rescue => e
+     raise "Oops Unexpected error Caught!"
+     puts e
   end
 end
 
-  class ClashApi < Settings
-    def self.call_api(status: false)
-    get
-     res = @conn.get(CocRb.configuration.url)
-   if status
-     res.status
-   else
-     val = res.body
-     convert = JSON.parse(val)
-   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)
+  if status
+    res.status
+  else
+      val = res.body
+      convert = JSON.parse(val)
+      end
     end
   end
 end

data/lib/cocRb/clan.rb

@@ -1,212 +1,270 @@
-require 'faraday'
+require "faraday"
 require "json"
 
 module CocRb
-  class << self
+    class << self
       attr_accessor :configuration
     end
 
     def self.configure
-      @configuration ||= Configuration.new
-      yield(configuration)
+           @configuration ||= Configuration.new
+           yield(configuration)
     end
 
     class Configuration
-      attr_accessor :token, :url
+           attr_accessor :token, :url
 
-      def initialize
-        @token = nil
-        @url = nil
-      end
+    def initialize
+            @token = nil
+
+            @url = nil
+       end
     end
-  class Settings
-    def self.get
-       @conn = Faraday.new(
-         url:"https://api.clashofclans.com" ,
-         headers: {
-           'Content-Type' => 'application/json',
-           'Authorization' => "Bearer #{CocRb.configuration.token}"
+
+   class Settings
+        def self.get
+             @conn = Faraday.new(
+             url:"https://api.clashofclans.com" ,
+             headers: {
+                'Content-Type' => 'application/json',
+                'Authorization' => "Bearer #{CocRb.configuration.token}"
          }
-       )
-       rescue => e
-        raise "Oops Unexpected error Caught!"
-        puts e
-  end
-end
-  class Clans < Settings
-    def self.getClans(name:, filterOptions:, filterValue:, _limit: false, status: false)
-      get
-      options = ["warFrequency", "locationId", "minMembers", "maxMembers", "minClanPoints", "minClanLevel"]
-      check = options.include?(filterOptions)
+      )
+        rescue => e
+             raise "Oops Unexpected error Caught!"
+             puts e
+      end
+   end
+
+  class Clan < Settings
+       # This method gets clan according to clan filter option. Takes name, filterOptions and filterValue as a parameter.
+       #
+       # If you want to know about _filterOptions_ please check the Github README page for that.
+       #
+       # Paramter Data Types => _String_, _String_, _Integer_
+
+       def self.get_FiltredClan(name:, filterOptions:, filterValue:, _limit: false, status: false)
+              get
+
+              options = ["warFrequency", "locationId", "minMembers", "maxMembers", "minClanPoints", "minClanLevel"]
+
+              check = options.include?(filterOptions)
         if check
-        count = name.split(/[^-a-zA-Z]/).size
+              count = name.split(/[^-a-zA-Z]/).size
         if count > 2
-          res = @conn.get('v1/clans') do |req|
-            req.params = { name: name, filterOptions:filterValue}
-            req.params[:limit] = _limit if _limit
-          end
-          if status
-            puts res.status
-          else
-            val = res.body
-            convert = JSON.parse(val)
-          end
+              res = @conn.get('v1/clans') do |req|
+
+              req.params = { name: name, filterOptions: filterValue }
+
+              req.params[:limit] = _limit if _limit
+   end
+        if status
+              puts res.status
+        else
+              val = res.body
+
+              convert = JSON.parse(val)
+   end
         elsif count == 2
-          res = @conn.get('v1/clans') do |req|
-            req.params = { name: name, filterOptions:filterValue}
-            req.params[:limit] = _limit if _limit
-          end
-          if status
-            puts res.status
-          else
-            val = res.body
-            convert = JSON.parse(val)
-          end
+             res = @conn.get('v1/clans') do |req|
+
+             req.params = { name: name, filterOptions: filterValue }
+
+             req.params[:limit] = _limit if _limit
+   end
+        if status
+             puts res.status
         else
-          res = @conn.get('v1/clans') do |req|
-            req.params = { name: name, filterOptions:filterValue}
-            req.params[:limit] = _limit if _limit
-          end
-          if status
-            puts res.status
-          else
-            val = res.body
-            convert = JSON.parse(val)
-          end
-        end
-      else
-      puts "Not a valid input option for this method"
-end
-end
+             val = res.body
+             convert = JSON.parse(val)
+   end
+        else
+             res = @conn.get('v1/clans') do |req|
 
-    def self.get_clans_ByTag(tag:, status: false)
-      get
-      io = tag
-      clanTag = io.gsub('#', '%23')
-      res = @conn.get("v1/clans/#{clanTag}")
-      if status
-        puts res.status
-      else
-        val = res.body
-        convert = JSON.parse(val)
-      end
+             req.params = { name: name, filterOptions: filterValue }
+
+             req.params[:limit] = _limit if _limit
+   end
+        if status
+             puts res.status
+        else
+             val = res.body
+
+             convert = JSON.parse(val)
+       end
     end
+         else
+              puts "Not a valid input option for this method"
+      end
+   end
+    # This method gets Clan Information, Takes tag as a parameter.
+    #
+    # Paramter Data Type => _String_
+    def self.get_ClanByTag(tag:, status: false)
+              get
+              io = tag
 
-    def self.get_clans_ByName(name:, _limit:false, status:false)
-      get
-      count = name.split(/[^-a-zA-Z]/).size
-      if count > 2
-        res = @conn.get('v1/clans') do |req|
-          req.params = { name: name}
-          req.params[:limit] = _limit if _limit
-        end
+              clanTag = io.gsub('#', '%23')
+
+              res = @conn.get("v1/clans/#{clanTag}")
         if status
-          puts res.status
+              puts res.status
         else
-          val = res.body
-          convert = JSON.parse(val)
-        end
-      elsif count == 2
-        res = @conn.get('v1/clans') do |req|
-          req.params = { name: name}
-          req.params[:limit] = _limit if _limit
-        end
+              val = res.body
+
+              convert = JSON.parse(val)
+     end
+  end
+    # This method gets Clans by name, Takes name as a parameter.
+    #
+    # Paramter Data Type => _String_
+    def self.get_ClanByName(name:, _limit: false, status: false)
+              get
+              count = name.split(/[^-a-zA-Z]/).size
+        if count > 2
+              res = @conn.get('v1/clans') do |req|
+
+              req.params = { name: name}
+
+              req.params[:limit] = _limit if _limit
+    end
         if status
-          puts res.status
+              puts res.status
         else
-          val = res.body
-          convert = JSON.parse(val)
-        end
-      else
-        res = @conn.get('v1/clans') do |req|
-          req.params = { name: name}
-          req.params[:limit] = _limit if _limit
-        end
+              val = res.body
+
+              convert = JSON.parse(val)
+    end
+        elsif count == 2
+              res = @conn.get('v1/clans') do |req|
+
+              req.params = { name: name}
+
+              req.params[:limit] = _limit if _limit
+    end
         if status
-          puts res.status
+              puts res.status
+        else
+              val = res.body
+
+              convert = JSON.parse(val)
+    end
         else
-          val = res.body
-          convert = JSON.parse(val)
+              res = @conn.get('v1/clans') do |req|
+
+              req.params = { name: name}
+
+              req.params[:limit] = _limit if _limit
+    end
+        if status
+              puts res.status
+        else
+              val = res.body
+
+              convert = JSON.parse(val)
         end
-end
+     end
+   end
+     # This method gets clan by Location ID. Takes Location ID as a parameter.
+     #
+     # Paramter Data Type => _Integer_
+     def self.get_ClanByLocationID(id:, _limit: false, status:false)
+              get
 
-end
+              res = @conn.get('v1/clans') do |req|
 
-    def self.get_clans_ByLocationID(id:, _limit: false, status:false)
-      get
-      res = @conn.get('v1/clans') do |req|
-        req.params = { locationId: id}
-        req.params[:limit] = _limit if _limit
-      end
+              req.params = { locationId: id}
 
-      if status
-        puts res.status
-      else
-        val = res.body
-        convert = JSON.parse(val)
-      end
+              req.params[:limit] = _limit if _limit
+   end
 
+       if status
+              puts res.status
+       else
+              val = res.body
+
+              convert = JSON.parse(val)
+       end
     end
+    # This method gets clan by minimum Clan Level. Takes clan level as a parameter.
+    #
+    # Paramter Data Type => _Integer_
+    def self.get_ClanByMinClanLevel(clanLevel:, _limit: false, status: false)
+              get
+              res = @conn.get('v1/clans') do |req|
 
-    def self.get_clans_ByMinClanLevel(clanLevel:, _limit: false, status: false)
-      get
-      res = @conn.get('v1/clans') do |req|
-        req.params = { minClanLevel: clanLevel }
-        req.params[:limit] = _limit if _limit
-      end
+              req.params = { minClanLevel: clanLevel }
+
+              req.params[:limit] = _limit if _limit
+    end
       if status
-        puts res.status
+              puts res.status
       else
-        val = res.body
-        convert = JSON.parse(val)
+              val = res.body
+
+              convert = JSON.parse(val)
       end
+   end
+     # This method gets clan members. Takes clan tag as a parameter.
+     #
+     # Paramter Data Type => _String_
+     def self.get_ClanMembers(tag:, _limit:false, status:false)
+              get
+              io = tag
 
+              tag1 = io.gsub('#', '%23')
 
-    end
-
-  def self.get_clan_Members(tag:, _limit:false, status:false)
-       get
-      io = tag
-      tag1 = io.gsub('#', '%23')
-      res = @conn.get("v1/clans/#{tag1}/members") do |req|
-         req.params[:limit] = _limit if _limit
-      end
+              res = @conn.get("v1/clans/#{tag1}/members") do |req|
 
+              req.params[:limit] = _limit if _limit
+  end
       if status
-        puts res.status
+            puts res.status
       else
-          val = res.body
-          convert = JSON.parse(val)
+              val = res.body
+              convert = JSON.parse(val)
       end
-
-end
-
-def self.get_detailed_ClanMembers(tag:, _limit: false, status: false)
-   get
-   io = tag
-   tag1 = io.gsub('#', '%23')
-   res = @conn.get("v1/clans/#{tag1}/members") do |req|
-      req.params[:limit] = _limit if _limit
    end
+       # This method gets detailed clan members. Takes clan tag as a parameter.
+       #
+       # Note: _This method might take 1-2 min time to get execute depending on the data you are requesting_
+       #
+       # Paramter Data Type => _String_
+       def self.get_DetailedClanMembers(tag:, _limit: false, status: false)
+             get
 
-   if status
-   puts res.status
- else
-val = res.body
-convert = JSON.parse(val)
-each = convert["items"].map {|m| m["tag"]}
+             io = tag
 
-extract = each.map {|x| x.gsub /^#/, '%23'}
+             tag1 = io.gsub('#', '%23')
 
-resp = extract.map do |ext|
-  anotheres = @conn.get("v1/players/#{ext}") do |req|
-    req.params[:limit] = _limit if _limit
+             res = @conn.get("v1/clans/#{tag1}/members") do |req|
+             req.params[:limit] = _limit if _limit
   end
-  response = anotheres.body
-  val = JSON.parse(response)
-end
-end
-end
 
-end
+        if status
+              puts res.status
+        else
+              val = res.body
+
+              convert = JSON.parse(val)
+
+              each = convert["items"].map {|m| m["tag"]}
+
+              extract = each.map {|x| x.gsub /^#/, '%23'}
+
+              resp = extract.map do |ext|
+
+              anotheres = @conn.get("v1/players/#{ext}") do |req|
+
+              req.params[:limit] = _limit if _limit
+
+              end
+              response = anotheres.body
+
+              val = JSON.parse(response)
+
+             end
+          end
+       end
+    end
 end