binarybeast 0.1.5.pre → 0.2.0.pre

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.project

data/README.md

@@ -66,6 +66,14 @@ more to come soon....
 
 ## Some stuff you should know
 
+### Eigenclass: Tourney
+
+There is an eigenclass of the Tourney Class. Functions are
+
+    .list
+    .listpopular
+    .load
+
 ### :force => true
 
 The BinaryBeast API sends back JSON from every request. However, if you use this gem we catch the JSON Data and proccess it. If you want to have a direct response from the API you can go with something like this:
@@ -82,6 +90,15 @@ the :force options is currently available to almost every function, the exceptio
 
 ## Changelog
 
+### Version: 0.1.5.pre
+
+* Added list to eigenclass. It lists tourneys that you've created. Example: tourneys = Binarybeast::Tourney.list
+* Added listpopular to eigenclass. It lists popular tourney. Example: tourneys = Binarybeast::Tourney.listpopular
+
+### Version: 0.1.4.pre
+
+* Fixed a typo in some tests.
+
 ### Version: 0.1.3.pre
 
 * Added Eigenclass to Tourney, so you can call Binarybeast::Tourney.load(:id => "").

data/binarybeast.gemspec

@@ -5,7 +5,7 @@ require 'binarybeast/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "binarybeast"
-  gem.version       = Binarybeast::VERSION
+  gem.version       = BinaryBeast::VERSION
   gem.authors       = ["Crispin Schaeffler"]
   gem.email         = ["crispinschaeffler@googlemail.com"]
   gem.description   = %q{Ruby gem to access the binary beast api.}

data/lib/binarybeast.rb

@@ -10,25 +10,30 @@ require "HTTParty"
 # ---------------------
 # does contain all the classes that interact with binarybeast api.
 
-module Binarybeast
+module BinaryBeast
   include HTTParty
   # Base URI for the BinaryBeast API
-  base_uri 'https://binarybeast.com/api'
+  base_uri 'https://api.binarybeast.com/'
   # Set HTTParty standard format to JSON, its standard what binarybeast api returns.
   format :json
   # Default api_key, this one is taken from my personal account.
-  @@api_key = "3c8955130c6e1406420d6202649651fe.50c9faa593f9c6.00530099"
+  # @todo the api key should not be initialized with a personal account for the public release, 
+  # in the future, use the test account api if anything: e17d31bfcbedd1c39bcb018c5f0d0fbf.4dcb36f5cc0d74.24632846
+  @@api_key = 'e17d31bfcbedd1c39bcb018c5f0d0fbf.4dcb36f5cc0d74.24632846'
+
+  # Autoload the service classes
+  require                   'binarybeast/constants'
+  autoload :Service,        'binarybeast/service'
+  autoload :Tournament,     'binarybeast/tournament'
+  autoload :Team,           'binarybeast/team'
+  autoload :Game,           'binarybeast/game'
   
-  # Autoload Tourney Class when needed
-  autoload :Tourney, 'binarybeast/tourney'
-  # Autoload Team Class when needed
-  autoload :Team, 'binarybeast/team'
 
   # Getter for api_key Variable
   def self.api_key
     @@api_key
   end
-  
+
   # Setter for api_key Variable
   def self.api_key=(api_key)
     @@api_key=api_key
@@ -37,14 +42,24 @@ module Binarybeast
   # Call
   # Method
   # ------------
-  # Raw Call Method for those who want to make raw calls on the API of Binarybeast. APIKey will be taken from the module variable
+  # Raw Call Method for those who want to make raw calls on the API of Binarybeast. api_key will be taken from the module variable
   # Example:
-  # tourney = Binarybeast.call(:APIService => "Tourney.TourneyCreate.Create", :title => "Test")
+  # tourney = Binarybeast.call('Tourney.TourneyCreate.Create', :title => "Test")
   # ------------
 
-  def self.call(options={})
-    options.merge!({:APIKey => @@api_key})
-    return self.get("", :query => options)
+  def self.call(service, options={})
+    options.merge!({
+      :api_key              => @@api_key,
+      :api_use_underscores  => true,
+      :api_service          => service,
+      :api_agent            => "BinaryBeast API Ruby: Version #{BinaryBeast::VERSION}"
+    })
+
+    response = self.get('', :query => options)
+
+    yield response if block_given?
+    return response
+
   end
 
-end
+end

data/lib/binarybeast/constants.rb

@@ -0,0 +1,32 @@
+module BinaryBeast
+  
+  # Constants
+  # ---------------------
+  BRACKET_GROUPS                  = 0
+  BRACKET_WINNERS                 = 1
+  BRACKET_LOSERS                  = 2
+  BRACKET_FINALS                  = 3
+  BRACKET_BRONZE                  = 4
+  # ---------------------
+  ELIMINATION_SINGLE              = 1
+  ELIMINATION_DOUBLE              = 2
+  # ---------------------
+  # Brackets
+  TOURNAMENT_TYPE_BRACKETS        = 0
+  # Round Robin -> Brackets
+  TOURNAMENT_TYPE_CUP             = 1
+  # ---------------------
+  SEEDING_RANDOM                  = 'random'
+  SEEDING_SPORTS                  = 'sports'
+  SEEDING_BALANCED                = 'balanced'
+  SEEDING_MANUAL                  = 'manual'
+  # ---------------------
+  REPLAY_DOWNLOADS_DISABLED       = 0
+  REPLAY_DOWNLOADS_ENABLED        = 1
+  REPLAY_DOWNLOADS_POST_COMPLETE  = 2
+  # ---------------------
+  REPLAY_UPLOADS_DISABLED         = 0
+  REPLAY_UPLOADS_OPTIONAL         = 1
+  REPLAY_UPLOADS_MANDATORY        = 2
+  
+end

data/lib/binarybeast/service.rb

@@ -0,0 +1,60 @@
+module BinaryBeast
+  
+  # Service
+  # Class
+  # ---------------
+  # This is the base service class that all other classes inherit from, it provides the basic
+  # API interaction functionality, in order to make this API library a bit more DRY
+  # ---------------
+  # gives you a Service object
+  
+  class Service
+
+
+    # convertKeys
+    # Method
+    # ---------------
+    # This method used in conjuction with assignAttributes, will convert all keys of a hash returned by BinaryBeast, 
+    # from strings to symbols 
+    # For example in Tournament::initialize({:title=>'title of the tour'}), :title will automatically be assigned to this.title = 'Title of the tour' 
+    # ---------------
+    def convertHashKeys(hash)
+
+      hash.inject({}) do |mem, (key, value)|
+        mem[key.to_sym] = value
+        mem
+      end 
+
+    end
+
+
+    # assignAttributes
+    # Method
+    # ---------------
+    # Used by the service class constructors to iterate through inputs to quickly assign the values
+    # into the instance variables
+    # For example in Tournament::initialize({:title=>'title of the tour'}), :title will automatically be assigned to this.title = 'Title of the tour' 
+    # ---------------
+    def assignAttributes(values = {})
+      values.each_pair do |key, value|
+        # Continue only if this method has an attribute setter for this value 
+        if respond_to?("#{key}=")  
+          self.send("#{key}=", value)
+        end
+      end
+    end
+    
+    # getAttributes
+    # Method
+    # ---------------
+    # Used by service methods for calling update services without having 
+    # to type out every single attribute in the code, once they're listed as
+    # an attr_accessor, it will be sent - if there happen to be extraneous values, it won't make any difference   
+    # ---------------
+    def getAttributes()
+      Hash[instance_variables.map {|attr| [attr.slice(1..-1), instance_variable_get(attr)] } ]
+    end
+
+  end
+
+end

data/lib/binarybeast/team.rb

@@ -1,4 +1,4 @@
-module Binarybeast
+module BinaryBeast
 	class Team
 	end
 end

data/lib/binarybeast/tournament.rb

@@ -0,0 +1,264 @@
+module BinaryBeast
+  # Tourney
+  # Class
+  # ---------------
+  # This is the Tourney service class. It will be used to most. It gives you a brand new Tourney object to call methods on.
+  # Example:
+  # tourney = Binarybeast::Tourney.new("Gamkoi Test")
+  # ---------------
+  # gives you a tourney object
+  
+  class Tournament < BinaryBeast::Service
+
+    attr_accessor :api_key, :id, :tourney_id, :title, :public, :display_name, :url,
+      :game_code, :game, :game_style, :game_icon,
+      :status, :type_id, :elimination, :teams_confirmed_count, :teams_joined_count,
+      :team_mode, :teams_from_group, :max_teams, :group_count,
+      :view_count, :date_start, :location,
+      :replay_uploads, :replay_downloads,
+      :description, :return_data
+
+
+    # Default values for each attribute
+    DEFAULTS = {
+      :id               => nil,
+      :title            => 'Gamkoi DevTest', #"BinaryBeast API Ruby (#{BinaryBeast::VERSION}) Test Tournament",
+      :game_code        => 'misc',
+      :game             => 'Misc.',
+      :type_id          => BinaryBeast::TOURNAMENT_TYPE_BRACKETS,
+      :elimination      => BinaryBeast::ELIMINATION_SINGLE,
+      :team_mode        => 1,
+      :group_count      => 1,
+      :teams_from_group => 2, 
+      :date_start       => Time.new.strftime("%Y-%m-%d"),
+      :location         => '',
+      :max_teams        => 16,
+      :replay_uploads   => BinaryBeast::REPLAY_UPLOADS_OPTIONAL,
+      :replay_downloads => BinaryBeast::REPLAY_DOWNLOADS_ENABLED,
+      :description      => nil,
+      :return_data      => 0,
+    }
+
+    # Tourney Eigenclass
+    # Eigenclass
+    # ----------------
+    # provides some functionality in order to allow certain things before creating a tourney.
+    # ----------------
+
+    class << self
+
+      # Load
+      # Method
+      # ----------------
+      # Loads a tourney from binarybeast and returns an tourney object.
+      # Example:
+      # @tourney = Binarybest::Tourney.load(:id => "xSC21212194")
+      # ----------------
+
+      def load(options={:force => false, :id => 'xSC21212194'})
+        
+        #Use this test tournament as a default value for now
+        id = options[:id] || options[:tourney_id] || 'xSC21212194'
+
+        BinaryBeast.call('Tourney.TourneyLoad.Info', :tourney_id => id) do |response|
+
+          return false if response['result'] != 200
+          return response if options[:force]
+
+          return BinaryBeast::Tournament.new(response['tourney_info'])
+          
+        end 
+
+      end
+
+
+
+      # List
+      # Method
+      # ----------------
+      # Loads the List of Tourneys you've created. Returns an array if successful, else false
+      # Example:
+      # @tourneylist = BinaryBeast::Tourney.list
+      # ----------------
+
+      def list(options={:order => 'date_start'})
+        BinaryBeast.call('Tourney.TourneyList.Creator', {:order => 'date_start'}.merge(options)) do |response|
+          return response if options[:force]
+          return false if response['result'] != 200
+
+          # return an array of initialized tournaments instead of just the raw data, unless asked otherwise          
+          return response['list'].map do |tourney|
+            BinaryBeast::Tournament.new(tourney)
+          end
+  
+        end
+        # end Tourney.TourneyList.Popular
+  
+      end
+  
+      # ListPopular
+      # Method
+      # ----------------
+      # Loads the List of Popular Tourneys. Retuns an hash if successful, else false
+      # Example:
+      # @tourneylist = Binarybeast::Tourney.listpopular
+      # ----------------
+  
+      def listPopular(options={:limit => 30})
+  
+        BinaryBeast.call('Tourney.TourneyList.Popular', {:limit => 3}.merge(options)) do |response|
+          return false if response['result'] != 200
+          return response if options[:force]
+  
+          # return an array of initialized tournaments instead of just the raw data, unless asked otherwise          
+          return response['list'].map do |tourney|
+            BinaryBeast::Tournament.new(tourney)
+          end
+  
+        end
+        # end Tourney.TourneyList.Popular
+  
+      end
+      # end listPopular
+
+    end
+    # END EIGENCLASS
+
+
+
+    # Constructor
+    # Method
+    # ----------------
+    # all tourney attributes can be given here. The title parameter is needed, all else is optional.
+    # Example:
+    # Binarybeast::Tourney.new(:title => "Gamkoi DevCup")
+    # ----------------
+
+    def initialize(options={})
+      # Merge the default values and assign all values locally using the base serice classes attribute assigner, saves loads of typing :)
+      options[:id] = options[:id] || options['id'] || options[:tourney_id] || options['tourney_id']
+      assignAttributes(Tournament::DEFAULTS.merge(options))
+    end
+
+
+    # Update
+    # Method
+    # ----------------
+    # Pushes the attributes from the object to the binarybeast api. Pushes updates from object to Binarybeast
+    # Example:
+    # @tourney = Binarybeast::Tourney.new(:title => "lol")
+    # @tourney.title = 'New Title!'
+    # @tourney.update
+    # ----------------
+
+    def update(options={:force => false})
+      response = BinaryBeast.call('Tourney.TourneyUpdate.Settings', getAttributes.merge({:tourney_id => self.id}) )
+      options[:force] ? response : response['result'] == 200 ? true : false
+    end
+
+    # Create
+    # Method
+    # ----------------
+    # Creates the tournament object at binarybeast. You want to call this once after setting up your local Tourney object.
+    # Example:
+    # @tourney = Binarybeast::Tourny.new
+    # @tourney.title = "Blabla"
+    # @tourney.description = "Changing some attributes locally..."
+    # @tourney.create
+    # ----------------
+
+    def create(options={:force => false})
+      response = BinaryBeast.call('Tourney.TourneyCreate.Create', getAttributes)
+      self.id = response['tourney_id'] if response['result'] == 200
+      options[:force] ? response : response['result'] == 200 ? true : false
+    end
+
+    # Delete
+    # Method
+    # ----------------
+    # Deletes the tourney object from binarybeast. Does not delete the tourney object itself locally.
+    # Example:
+    # @tourney = Binarybeast::Tourney.new(:title => "Test")
+    # @tourney.create
+    # @tourney.delete
+    # ----------------
+
+    def delete(options={:force => false})
+      response = BinaryBeast.call('Tourney.TourneyDelete.Delete', :tourney_id => self.id)
+      options[:force] ? response : response['result'] == 200 ? true : false
+    end
+
+    # Start
+    # Method
+    # ----------------
+    # Starts the object tourney on binarybeast.
+    # Example:
+    # @tourney = Binarybeast::Tourney.new(:title => "test")
+    # @tourney.create
+    # @tourney.start
+    # ----------------
+
+    def start(options={:force => false})
+
+      response = BinaryBeast.call('Tourney.TourneyStart.Start', {
+        :tourney_id => self.id,
+        :seeding => BinaryBeast::SEEDING_RANDOM
+      }.merge(options))
+
+      options[:force] ? response : response['result'] == 200 ? true : false
+
+      
+    end
+
+    # Load
+    # Method
+    # ----------------
+    # Loads the information of a binarybeast tourney and saving it in the object. Pulling information - inverse of update
+    # Example:
+    # @tourney = Binarybeast::Tourney.new(:id => 'xSC21212194')
+    # @tourney.load
+    # ----------------
+
+    def load(options={:force => false})
+      
+      response = BinaryBeast.call('Tourney.TourneyLoad.Info', {:tourney_id => self.id}.merge(options))
+
+      return response if options[:force]      
+      return false if response['result']
+      
+      self.assignAttributes(response['tourney_info'])
+      return true
+    end
+
+    # setBuilding
+    # Method
+    # ----------------
+    # Sets the status of the tourney correlating to the object to: Status: Building
+    # Example:
+    # @tourney = Binarybeast::Tourney.new
+    # @tourney.setBuilding
+    # ----------------
+
+    def setBuilding(options={:force => false})
+      response = BinaryBeast.call('Tourney.TourneySetStatus.Building', :tourney_id => self.id)
+      options[:force] ? response : response['result'] == 200 ? true : false
+    end
+
+
+    # setConfirmation
+    # Method
+    # ----------------
+    # Sets the status of the tourney correlating to the object to: Status: Confirmation
+    # Example:
+    # @tourney = BinaryBeast::Tourney.new
+    # @tourney.setConfirmation
+    # ----------------
+
+    def setConfirmation(options={:force => false})
+      response = BinaryBeast.call('Tourney.TourneySetStatus.Confirmation', :tourney_id => self.id)
+      options[:force] ? response : response['result'] == 200 ? true : false
+    end
+
+  end
+  # END Class Tournament
+end

data/lib/binarybeast/version.rb

@@ -1,3 +1,3 @@
-module Binarybeast
-  VERSION = "0.1.5.pre"
-end
+module BinaryBeast
+  VERSION = "0.2.0.pre"
+end

data/spec/binarybeast_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Binarybeast do
+describe BinaryBeast do
 	it "must have apikey variable" do
-		Binarybeast.api_key.should == "3c8955130c6e1406420d6202649651fe.50c9faa593f9c6.00530099"
+		BinaryBeast.api_key.should == "3c8955130c6e1406420d6202649651fe.50c9faa593f9c6.00530099"
 	end
 	it "should have a raw call method" do
-		Binarybeast.should respond_to(:call)
+		BinaryBeast.should respond_to(:call)
 	end
 end

data/spec/team_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Binarybeast::Team do
+describe BinaryBeast::Team do
 	it "should work" do
 	end
 end

data/spec/tourney_spec.rb

@@ -1,114 +1,117 @@
 require 'spec_helper'
 
-describe Binarybeast::Tourney do
+describe BinaryBeast::Tournament do
   before :all do
-    @tourney = Binarybeast::Tourney.new(:title => "Gamkoi DevTest Ruby", :description => "This is a tourney created via the Gamkoi.com ruby gem.")
+    @tournament = BinaryBeast::Tournament.new(:title => 'Gamkoi DevTest Ruby', :description => 'This is a tourney created via the Gamkoi.com ruby gem.', :game_code => 'HotS')
   end
   describe "eigenclass" do
     describe "list" do
-      it "should return list of tourneys" do
-        response = Binarybeast::Tourney.list
-        response.should be_instance_of Hash
+      it "should return array of tourneys" do
+        response = BinaryBeast::Tournament.list
+        response.should be_instance_of Array
       end
     end
-    describe "listpopular" do
+    describe "listPopular" do
       it "should return list of popular tourneys" do
-        response = Binarybeast::Tourney.listpopular
-        response.should be_instance_of Hash
+        response = BinaryBeast::Tournament.listPopular
+        response.should be_instance_of Array
       end
     end
     describe "load" do
       it "should load from eigenclass" do
-        tourney = Binarybeast::Tourney.load(:id => "xSC21212194")
-        tourney.should be_an_instance_of Binarybeast::Tourney
-        tourney.title.should eq("Gamkoi Dev Dummy")
+        tournament = BinaryBeast::Tournament.load(:id => @tournament.tourney_id)
+        tournament.should be_an_instance_of BinaryBeast::Tournament
+        tournament.title.should eq('Gamkoi DevTest Ruby')
       end
     end
   end
   describe "new" do
     it "takes one to all parameters and returns an tourney object" do
-      @tourney.should be_an_instance_of Binarybeast::Tourney
+      @tournament.should be_an_instance_of BinaryBeast::Tournament
     end
     it "should respond to title" do
-      @tourney.title.should eq("Gamkoi DevTest Ruby")
+      @tournament.title.should eq('Gamkoi DevTest Ruby')
     end
     it "should respond to description" do
-      @tourney.description.should eq("This is a tourney created via the Gamkoi.com ruby gem.")
+      @tournament.description.should eq('This is a tourney created via the Gamkoi.com ruby gem.')
     end
     it "should respond to all attributes" do
-      @tourney.should respond_to(:title)
-      @tourney.should respond_to(:id)
-      @tourney.should respond_to(:publish)
-      @tourney.should respond_to(:game_code)
-      @tourney.should respond_to(:type_id)
-      @tourney.should respond_to(:elimination)
-      @tourney.should respond_to(:team_mode)
-      @tourney.should respond_to(:group_count)
-      @tourney.should respond_to(:teams_from_group)
-      @tourney.should respond_to(:date_start)
-      @tourney.should respond_to(:location)
-      @tourney.should respond_to(:max_teams)
-      @tourney.should respond_to(:replay_uploads)
-      @tourney.should respond_to(:replay_downloads)
-      @tourney.should respond_to(:description)
-      @tourney.should respond_to(:return_data)
-      @tourney.should respond_to(:api_key)
-    end
-  end
-  describe "update" do
-    it "should respond to update" do
-      @tourney.should respond_to(:update)
-      response = @tourney.update(:force => true)
-      response.should be_instance_of Hash
+      @tournament.should respond_to(:title)
+      @tournament.should respond_to(:id)
+      @tournament.should respond_to(:public)
+      @tournament.should respond_to(:game_code)
+      @tournament.should respond_to(:type_id)
+      @tournament.should respond_to(:elimination)
+      @tournament.should respond_to(:team_mode)
+      @tournament.should respond_to(:group_count)
+      @tournament.should respond_to(:teams_from_group)
+      @tournament.should respond_to(:date_start)
+      @tournament.should respond_to(:location)
+      @tournament.should respond_to(:max_teams)
+      @tournament.should respond_to(:replay_uploads)
+      @tournament.should respond_to(:replay_downloads)
+      @tournament.should respond_to(:description)
+      @tournament.should respond_to(:return_data)
+      @tournament.should respond_to(:api_key)
     end
   end
   describe "create" do
     it "should respond to publish" do
-      @tourney.should respond_to(:publish)
+      @tournament.should respond_to(:public)
     end
     it "should return parsed json array" do
-      @tourney.create.should eq(true)
+      @tournament.create.should eq(true)
     end
     it "should return forced broadcast" do
-      response = @tourney.create(:force => true)
-      response["Result"].should eq(200)
+      response = @tournament.create(:force => true)
+      response['result'].should eq(200)
+      response.should be_instance_of Hash
+    end
+  end
+  describe "update" do
+    it "should respond to update" do
+      @tournament.should respond_to(:update)
+      response = @tournament.update(:force => true)
       response.should be_instance_of Hash
     end
   end
   describe "delete" do
     it "should respond to delete" do
-      @tourney.should respond_to(:delete)
+      @tournament.should respond_to(:delete)
     end
     it "should delete the tourney" do
-      tourney = Binarybeast::Tourney.new(:title => "Delete Test")
-      tourney.create
-      response = tourney.delete(:force => true)
+      tournament = BinaryBeast::Tournament.new(:title => "Delete Test")
+      tournament.create
+      response = tournament.delete(:force => true)
       response.should be_instance_of Hash
     end
   end
   describe "start" do
     it "should respond to start" do
-      @tourney.should respond_to(:start)
+      @tournament.should respond_to(:start)
     end
     it "should start the tourney" do
+      #@tournament.start
+      #@tournament.load
+      #@tournament.status.should eq('Active')
     end
   end
   describe "load" do
     it "should respond to load" do
-      @tourney.should respond_to(:load)
+      @tournament.should respond_to(:load)
     end
     it "should load a tourney and set attributes" do
-      tourney = Binarybeast::Tourney.new(:id => "xSC21212194")
-      tourney.load
-      tourney.title.should eq("Gamkoi Dev Dummy")
+      tournament = BinaryBeast::Tournament.load(:id => @tournament.tourney_id)
+      tournament.load
+      tournament.title.should eq("Gamkoi DevTest Ruby")
     end
   end
   describe "set status" do
     it "should respond to building" do
-      @tourney.should respond_to(:setBuilding)
+      @tournament.should respond_to(:setBuilding)
     end
     it "should respond to confirmation" do
-      @tourney.should respond_to(:setConfirmation)
+      @tournament.should respond_to(:setConfirmation)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binarybeast
 version: !ruby/object:Gem::Version
-  version: 0.1.5.pre
+  version: 0.2.0.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -89,8 +89,10 @@ files:
 - Rakefile
 - binarybeast.gemspec
 - lib/binarybeast.rb
+- lib/binarybeast/constants.rb
+- lib/binarybeast/service.rb
 - lib/binarybeast/team.rb
-- lib/binarybeast/tourney.rb
+- lib/binarybeast/tournament.rb
 - lib/binarybeast/version.rb
 - spec/binarybeast_spec.rb
 - spec/spec_helper.rb

data/lib/binarybeast/tourney.rb

@@ -1,271 +0,0 @@
-module Binarybeast
-# Tourney
-  # Class
-  # ---------------
-  # This is the Tourney class. It will be used to most. It gives you a brand new Tourney object to call methods on.
-  # Example:
-  # tourney = Binarybeast::Tourney.new("Gamkoi Test")
-  # ---------------
-  # gives you a tourney object
-  
-  class Tourney
-    include HTTParty
-    base_uri 'https://binarybeast.com/api'
-    format :json
-    attr_accessor :api_key, :id, :title, :publish, :game_code, :type_id, :elimination, :team_mode, :group_count, :teams_from_group, :date_start, :location, :max_teams, :replay_uploads, :replay_downloads, :description, :return_data
-    
-    # Tourney Eigenclass
-    # Eigenclass
-    # ----------------
-    # provides some functionality in order to allow certain things before creating a tourney.
-    # ----------------
-
-    class << self
-      include HTTParty
-      format :json
-
-      # Load
-      # Method
-      # ----------------
-      # Loads a tourney from binarybeast and returns an tourney object.
-      # Example:
-      # @tourney = Binarybest::Tourney.load(:id => "xSC21212194")
-      # ----------------
-
-      def load(options={:force => false})
-        options[:id] ? id = options[:id] : id = "xSC21212194"
-        options[:force] ? force = options[:force] : force = false
-        response = self.get('https://binarybeast.com/api', :query => {:APIKey => Binarybeast.api_key,  :APIService => "Tourney.TourneyLoad.Info", :TourneyID => id})
-        if response["Result"] == 200
-          return response if force
-          tourney = Binarybeast::Tourney.new( :id => id,
-                                              :title => response["TourneyInfo"]["Title"],
-                                              :publish => response["TourneyInfo"]["Public"],
-                                              :game_code => response["TourneyInfo"]["GameCode"],
-                                              :type_id => response["TourneyInfo"]["TypeID"],
-                                              :elimination => response["TourneyInfo"]["Elimination"],
-                                              :team_mode => response["TourneyInfo"]["TeamMode"],
-                                              :group_count => response["TourneyInfo"]["GroupCount"],
-                                              :teams_from_group => response["TourneyInfo"]["TeamsFromGroup"],
-                                              :date_start => response["TourneyInfo"]["DateStart"],
-                                              :location => response["TourneyInfo"]["Location"],
-                                              :max_teams => response["TourneyInfo"]["MaxTeams"],
-                                              :replay_uploads => response["TourneyInfo"]["ReplayUploads"],
-                                              :replay_downloads => response["TourneyInfo"]["ReplayDownloads"],
-                                              :description => response["TourneyInfo"]["Description"],
-                                              :return_data => response["TourneyInfo"]["ReturnData"],
-                                              :api_key => Binarybeast.api_key)
-          return tourney
-        else
-          return false
-        end
-      end
-
-      # List
-      # Method
-      # ----------------
-      # Loads the List of Tourneys you've created. Returns an hash if successful, else false
-      # Example:
-      # @tourneylist = Binarybeast::Tourney.list
-      # ----------------
-
-      def list(options={:order => "DateStart"})
-        options[:api_key] ? api_key = options[:api_key] : api_key = Binarybeast.api_key
-        options[:order] ? order = options[:order] : order = "DateStart"
-        options[:direction] ? direction = options[:direction] : direction = "DESC"
-        options[:verbose] ? verbose = options[:verbose] : verbose = false
-        response = self.get('https://binarybeast.com/api', :query => {:APIKey => api_key, :APIService => "Tourney.TourneyList.My", :Order => order, :Direction => direction, :Verbose => verbose})
-        response["Result"] == 200 ? response : false
-      end
-
-      # ListPopular
-      # Method
-      # ----------------
-      # Loads the List of Popular Tourneys. Retuns an hash if successful, else false
-      # Example:
-      # @tourneylist = Binarybeast::Tourney.listpopular
-      # ----------------
-
-      def listpopular(options={:limit => 30})
-        options[:limit] ? limit = options[:limit] : limit = 30
-        options[:api_key] ? api_key = options[:api_key] : api_key = Binarybeast.api_key
-        response = self.get('https://binarybeast.com/api', :query => {:APIKey => api_key, :APIService => "Tourney.TourneyList.Popular", :Limit => limit})
-        response["Result"] == 200 ? response : false
-      end
-
-    end
-
-    # END EIGENCLASS
-
-
-
-    # Constructor
-    # Method
-    # ----------------
-    # all tourney attributes can be given here. The title parameter is needed, all else is optional.
-    # Example:
-    # Binarybeast::Tourney.new(:title => "Gamkoi DevCup")
-    # ----------------
-
-    def initialize(options={:title => "Gamkoi DevTest"})
-      self.id = options[:id] if options[:id]
-      options[:title] ? self.title = options[:title] : self.title = "Test"
-      options[:public] ? self.publish = options[:public] : self.publish = 0
-      options[:game_code] ? self.game_code = options[:game_code] : self.game_code = ""
-      options[:type_id] ? self.type_id = options[:type_id] : self.type_id = 0
-      options[:elimination] ? self.elimination = options[:elimination] : self.elimination = 1
-      options[:team_mode] ? self.team_mode = options[:team_mode] : self.team_mode = 1
-      options[:group_count] ? self.group_count = options[:group_count] : self.group_count = 1
-      options[:teams_from_group] ? self.teams_from_group = options[:teams_from_group] : self.teams_from_group = 2
-      options[:date_start] ? self.date_start = options[:date_start] : self.date_start = nil
-      options[:location] ? self.location = options[:location] : self.location = ""
-      options[:max_teams] ? self.max_teams = options[:max_teams] : self.max_teams = 16
-      options[:replay_uploads] ? self.replay_uploads = options[:replay_uploads] : self.replay_uploads = 1
-      options[:replay_downloads] ? self.replay_downloads = options[:replay_downloads] : self.replay_downloads = 1
-      options[:description] ? self.description = options[:description] : self.description = ""
-      options[:return_data] ? self.return_data = options[:return_data] : self.return_data = 0
-      options[:api_key] ? self.api_key = options[:api_key] : self.api_key = Binarybeast.api_key
-    end
-
-
-    # Update
-    # Method
-    # ----------------
-    # Pushes the attributes from the object to the binarybeast api. Pushes updates from object to Binarybeast
-    # Example:
-    # @tourney = Binarybeast::Tourney.new(:title => "lol")
-    # @tourney.update
-    # ----------------
-
-    def update(options={:force => false})
-      response = self.class.get("", :query => {:TourneyID => self.id, :APIKey => self.api_key, :APIService => "Tourney.TourneyUpdate.Settings",
-                                    :Title => self.title, :Public => self.publish, :game_code => self.game_code,
-                                    :TypeID => self.type_id, :Elimination => self.elimination,
-                                    :TeamMode => self.team_mode, :GroupCount => self.group_count,
-                                    :TeamsFromGroup => self.teams_from_group, :DateStart => self.date_start,
-                                    :Location => self.location, :MaxTeams => self.max_teams, :ReplayUploads => self.replay_uploads,
-                                    :ReplayDownloads => self.replay_downloads, :Description => self.description, :ReturnData => self.return_data})
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-    # Create
-    # Method
-    # ----------------
-    # Creates the tournament object at binarybeast. You want to call this once after setting up your local Tourney object.
-    # Example:
-    # @tourney = Binarybeast::Tourny.new
-    # @tourney.title = "Blabla"
-    # @tourney.description = "Changing some attributes locally..."
-    # @tourney.create
-    # ----------------
-
-    def create(options={:force => false})
-      response = self.class.get("", :query => {:APIKey => self.api_key, :APIService => "Tourney.TourneyCreate.Create",
-                                    :Title => self.title, :Public => self.publish, :GameCode => self.game_code,
-                                    :TypeID => self.type_id, :Elimination => self.elimination,
-                                    :TeamMode => self.team_mode, :GroupCount => self.group_count,
-                                    :TeamsFromGroup => self.teams_from_group, :DateStart => self.date_start,
-                                    :Location => self.location, :MaxTeams => self.max_teams, :ReplayUploads => self.replay_uploads,
-                                    :ReplayDownloads => self.replay_downloads, :Description => self.description, :ReturnData => self.return_data})
-      self.id = response["TourneyID"] if response["Result"] == 200
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-    # Delete
-    # Method
-    # ----------------
-    # Deletes the tourney object from binarybeast. Does not delete the tourney object itself locally.
-    # Example:
-    # @tourney = Binarybeast::Tourney.new(:title => "Test")
-    # @tourney.create
-    # @tourney.delete
-    # ----------------
-
-    def delete(options={:force => false})
-      response = self.class.get("", :query => {:APIKey => self.api_key, :APIService => "Tourney.TourneyDelete.Delete", :TourneyID => self.id})
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-    # Start
-    # Method
-    # ----------------
-    # Starts the object tourney on binarybeast.
-    # Example:
-    # @tourney = Binarybeast::Tourney.new(:title => "test")
-    # @tourney.create
-    # @tourney.start
-    # ----------------
-
-    def start(options={:force => false})
-      options[:force] ? force = true : force = false
-      options[:seeding] ? seeding = options[:seeding] : seeding = "random"
-      options[:teams] ? teams = options[:teams] : teams = nil
-      response = self.class.get("", :query => {:APIKey => self.api_key, :APIService => "Tourney.TourneyStart.Start", :Seeding => seeding, :Teams => teams, :TourneyID => self.id})
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-    # Load
-    # Method
-    # ----------------
-    # Loads the information of a binarybeast tourney and saving it in the object. Pulling information - inverse of update
-    # Example:
-    # @tourney = Binarybeast::Tourney.new(:id => "xSC21212194")
-    # @tourney.load
-    # ----------------
-
-    def load(options={:force => false})
-      response = self.class.get("", :query => {:APIKey => self.api_key,  :APIService => "Tourney.TourneyLoad.Info", :TourneyID => self.id})
-      return response if options[:force]
-      if response["Result"] == 200
-        self.title = response["TourneyInfo"]["Title"]
-        self.publish = response["TourneyInfo"]["Public"]
-        self.game_code = response["TourneyInfo"]["GameCode"]
-        self.type_id = response["TourneyInfo"]["TypeID"]
-        self.elimination = response["TourneyInfo"]["Elimination"]
-        self.team_mode = response["TourneyInfo"]["TeamMode"]
-        self.group_count = response["TourneyInfo"]["GroupCount"]
-        self.teams_from_group = response["TourneyInfo"]["TeamsFromGroup"]
-        self.date_start = response["TourneyInfo"]["DateStart"]
-        self.location = response["TourneyInfo"]["Location"]
-        self.max_teams = response["TourneyInfo"]["MaxTeams"]
-        self.replay_uploads = response["TourneyInfo"]["ReplayUploads"]
-        self.replay_downloads = response["TourneyInfo"]["ReplayDownloads"]
-        self.description = response["TourneyInfo"]["Description"]
-        self.return_data = response["TourneyInfo"]["ReturnData"]
-        return true
-      else
-        return false
-      end
-    end
-
-    # setBuilding
-    # Method
-    # ----------------
-    # Sets the status of the tourney correlating to the object to: Status: Building
-    # Example:
-    # @tourney = Binarybeast::Tourney.new
-    # @tourney.setBuilding
-    # ----------------
-
-    def setBuilding(options={:force => false})
-      response = self.class.get("", :query => {:APIKey => self.api_key, :APIService => "Tourney.TourneySetStatus.Building", :TourneyID => self.id})
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-    # setConfirmation
-    # Method
-    # ----------------
-    # Sets the status of the tourney correlating to the object to: Status: Confirmation
-    # Example:
-    # @tourney = Binarybeast::Tourney.new
-    # @tourney.setConfirmation
-    # ----------------
-
-    def setConfirmation(options={:force => false})
-      response = self.class.get("", :query => {:APIKey => self.api_key, :APIService => "Tourney.TourneySetStatus.Confirmation", :TourneyID => self.id})
-      options[:force] ? response : response["Result"] == 200 ? true : false
-    end
-
-  end
-  # END Class Tourney
-end