cocRb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84a1fe5b426fcf51fcbcd804d7150f0391c9747deb9ae4d4f2f530fe9a8c0b07
-  data.tar.gz: b23639c4d7a0ba41e315292099c8052755454837b2e4bfe4d98e71351d00c824
+  metadata.gz: 677b2fcfff53c05ddb5f59305e1940b4e20d19718af145f360041c0a2357a343
+  data.tar.gz: d95a7ef479806fb6db59fb3b3b071c6a82cc2d05c5a1e31b0fbc8d3b9a402016
 SHA512:
-  metadata.gz: 42a46c37bf4ab7d645b01dfd17c33cc807b66670b4f8b458cd7df9c2cf7046ecd8c3c18b4de8cb3b8e9045026f7cd3ffefd1ff66bea2efe991b80aa38177d599
-  data.tar.gz: 9dedf905b5ef047db3dc3db46c48b8fcab46e25a4c55235dd9bdad5a19695518ae5dbd7448d77b2a0a2af99dd497556f6debd4f6dca6be7e42e44a0009055c6c
+  metadata.gz: 9d149fa8289060dfea9ee62638567f0426613dcbe23860971d9655406eb521eab5c69aed10e46e1f51736b7aa3c7239c830b15fe5110eb4dd343bba7466c889e
+  data.tar.gz: 2395f768180735e2bca893d8e764c92a038b6d735890d6b7c4b8e7be5b47c4abddbebc234d6ead51f647624892d91c6a47677c9291edb0f02c3e8a1298670b46

data/README.md

@@ -1,35 +1,74 @@
-# 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 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
+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 reponse 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**.
+
+
+
+The Detailed info about all the Classes and Methods for this Library can be found in our Documentation.
+
+
+```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"}
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cocRb.rb

@@ -7,6 +7,8 @@ require_relative './cocRb/labels'
 require_relative './cocRb/league'
 require_relative './cocRb/location'
 require_relative './cocRb/player'
+
+require 'rdoc'
 require 'faraday'
 require 'time'
 require "json"

data/lib/cocRb/api.rb

@@ -1,50 +1,49 @@
-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
+    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,250 @@
-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
+       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
 
-    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
+    def self.get_ClanByTag(tag:, status: false)
+              get
+              io = tag
+
+              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
+
+    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)
+              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
+        if status
+              puts res.status
+        else
+              val = res.body
+
+              convert = JSON.parse(val)
         end
-end
+     end
+   end
 
-end
+     def self.get_ClanByLocationID(id:, _limit: false, status:false)
+              get
 
-    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
+              res = @conn.get('v1/clans') do |req|
 
-      if status
-        puts res.status
-      else
-        val = res.body
-        convert = JSON.parse(val)
-      end
+              req.params = { locationId: id}
+
+              req.params[:limit] = _limit if _limit
+   end
 
+       if status
+              puts res.status
+       else
+              val = res.body
+
+              convert = JSON.parse(val)
+       end
     end
 
-    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
+    def self.get_ClanByMinClanLevel(clanLevel:, _limit: false, status: false)
+              get
+              res = @conn.get('v1/clans') do |req|
+
+              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
 
+     def self.get_ClanMembers(tag:, _limit:false, status:false)
+              get
+              io = tag
 
-    end
+              tag1 = io.gsub('#', '%23')
 
-  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
 
-   if status
-   puts res.status
- else
-val = res.body
-convert = JSON.parse(val)
-each = convert["items"].map {|m| m["tag"]}
+       def self.get_DetailedClanMembers(tag:, _limit: false, status: false)
+             get
+
+             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