flox 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 219bdba8d257f7a35c1b9174877fc74775ce0a89
-  data.tar.gz: cc1abbb765aa82c4b6c3d650e308869b9594361e
+  metadata.gz: 9ad9881566390837774beb2f6ba709d533e2cd94
+  data.tar.gz: 25da47a5b5d16804352e2beba5e479b332f38ccf
 SHA512:
-  metadata.gz: 77c3fe30874b4bd0531108be4965dfa5178813712f319346cd167fa9b41985737904e095375b7b64792a0135275d1231d1817ba16e023d20b9c4906a5c4d4c86
-  data.tar.gz: 01509872cb9f839e79bd2941894d01eee92f5b238404e75aff60f1dba2a4099a0e05e96936840e617a070172ea5e2f0adc993986c95bb03540af14426bc3c9cf
+  metadata.gz: f39a94d6a7edc427e1b003773f9f44c813a033339a52c13d748cdda5306b63c19c83e012253b2caa31386570c8743707c856b666e2e736cd4adb327e2c47a316
+  data.tar.gz: 539663241fe8bfea69b91f928f052b88fea07029037ed4a56da069db6e080053708be529d972ef48b125fdc761ac2e494980b6bc0fc9798e80201a0e61951590

data/lib/flox.rb

@@ -14,7 +14,7 @@ class Flox
   # @private
   attr_reader :service
 
-  # The player that is currently logged in.
+  # @return [Flox::Player] The player that is currently logged in.
   attr_reader :current_player
 
   # Creates a new instance with a certain game ID and key. Per default, a guest
@@ -26,12 +26,16 @@ class Flox
   end
 
   # Makes a key-login on the server. It is recommended to create a 'hero'
-  # player in the web interface and use that for the login.
+  # player in the web interface and use that for the login. After the login,
+  # `current_player` will point to this player.
+  # @return [Flox::Player]
   def login_with_key(key)
     login(:key, key)
   end
 
-  # Creates a new guest player and logs it in.
+  # Creates a new guest player and logs it in. After the login,
+  # `current_player` will point to this player.
+  # @return [Flox::Player]
   def login_guest()
     login(:guest)
   end
@@ -47,7 +51,7 @@ class Flox
 
   # Loads an entity with a certain type and id from the server.
   # Normally, the type is the class name you used for the entity in your game.
-  # Returns a Flox::Entity instance.
+  # @return [Flox::Entity]
   def load_entity(type, id)
     path = entity_path(type, id)
     data = service.get(path)
@@ -58,7 +62,14 @@ class Flox
     end
   end
 
+  # Loads an entity with type '.player'.
+  # @return [Flox::Player]
+  def load_player(id)
+    load_entity('.player', id)
+  end
+
   # Stores an entity on the server.
+  # @return [Flox::Entity]
   def save_entity(entity)
     result = service.put(entity.path, entity)
     entity['updatedAt'] = result['updatedAt']
@@ -66,11 +77,12 @@ class Flox
     entity
   end
 
-  # :call-seq:
-  #   delete_entity(entity)
-  #   delete_entity(type, id)
-  #
   # Deletes the given entity from the database.
+  # @overload delete_entity(entity)
+  #   @param [Flox:Entity] entity the entity to delete
+  # @overload delete_entity(type, id)
+  #   @param [String] type the type of the entity
+  #   @param [String] id the id of the entity
   def delete_entity(*entity)
     if entity.length > 1
       type, id = entity[0], entity[1]
@@ -91,6 +103,7 @@ class Flox
 
   # Loads all scores of a leaderboard, sorted by rank. 'scope' can either be
   # one of the symbols +:today, :this_week, :all_time+ or an array of player IDs.
+  # @return [Array<Flox::Score>]
   def load_scores(leaderboard_id, scope)
     path = leaderboard_path(leaderboard_id)
     args = {}
@@ -106,35 +119,37 @@ class Flox
   end
 
   # Loads a JSON object from the given path. This works with any resource
-  # e.g. entities, logs, etc. Always returns a Hash.
+  # e.g. entities, logs, etc.
+  # @return [Hash]
   def load_resource(path, args=nil)
     service.get(path, args)
   end
 
   # Loads a log with a certain ID. A log is a Hash instance.
+  # @return [Hash]
   def load_log(log_id)
     log = service.get log_path(log_id)
     log['id'] = log_id unless log['id']
     log
   end
 
-  # Loads logs, optionally restricted by a certain query.
+  # Loads logs defined by a certain query.
   # Here are some sample queries:
   #
-  # * 'day:2014-02-20' -> all logs of a certain day
-  # * 'severity:warning' -> all logs of type warning & error
-  # * 'severity:error' -> all logs of type error
-  # * 'day:2014-02-20 severity:error' all error logs from February 20th.
+  # * `day:2014-02-20` → all logs of a certain day
+  # * `severity:warning` → all logs of type warning & error
+  # * `severity:error` → all logs of type error
+  # * `day:2014-02-20 severity:error` → all error logs from February 20th.
   #
-  # Returns a Flox::ResourceEnumerator you can use to iterate
-  # over the logs.
+  # @return [Flox::ResourceEnumerator<Hash>]
   def load_logs(query=nil, limit=nil)
     log_ids = load_log_ids(query, limit)
     paths = log_ids.map { |log_id| log_path(log_id) }
     ResourceEnumerator.new(service, paths)
   end
 
-  # Loads just the IDs of the logs, restricted by a certain query.
+  # Loads just the IDs of the logs, defined by a certain query.
+  # @return [Array<String>]
   def load_log_ids(query=nil, limit=nil)
     log_ids = []
     cursor = nil
@@ -152,23 +167,26 @@ class Flox
     log_ids
   end
 
-  # Loads the status of the Flox service, which is a Hash with the
-  # keys 'status' and 'version'.
+  # Loads the status of the Flox service.
+  # @return [Hash] with the keys 'status' and 'version'.
   def status
     service.get("")
   end
 
   # The ID of the game you are accessing.
+  # @return [String]
   def game_id
     service.game_id
   end
 
   # The key of the game you are accessing.
+  # @return [String]
   def game_key
     service.game_key
   end
 
   # The base URL of the Flox service.
+  # @return [String]
   def base_url
     service.base_url
   end

data/lib/flox/rest_service.rb

@@ -3,7 +3,6 @@
 ## License:   Simplified BSD
 
 require 'json'
-require 'yaml'
 require 'net/http'
 
 # A class that makes it easy to communicate with the Flox server via a REST protocol.
@@ -22,7 +21,7 @@ class Flox::RestService
     @game_id = game_id
     @game_key = game_key
     @base_url = base_url
-    @authentication = { "authType" => "guest" }
+    login :guest
   end
 
   # Makes a `GET` request at the server. The given data-Hash is URI-encoded
@@ -64,12 +63,12 @@ class Flox::RestService
     auth_data = {
       "authType"  => auth_type,
       "authId"    => auth_id,
-      "authToken" => auth_token,
-      "id"        => auth_id
+      "authToken" => auth_token
     }
 
     if (auth_type.to_sym == :guest)
       response = auth_data
+      auth_data["id"] = String.random_uid
     else
       response = post("authenticate", auth_data)
       auth_data["id"] = response["id"]

data/lib/flox/version.rb

@@ -2,9 +2,13 @@
 ## Copyright: Copyright 2014 Gamua
 ## License:   Simplified BSD
 
+# The main class used to interact with the Flox cloud service. Create an
+# instance of Flox using the game ID and key acquired from the web interface,
+# then login with a "Hero" key. That way, you will be able to access the data
+# of all players.
 class Flox
 
   # The current version of the Flox SDK.
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 
 end

data/test/test_flox.rb

@@ -4,7 +4,7 @@
 
 require 'flox'
 require 'test/unit'
-require 'mocha/test_unit'
+require 'mocha/setup'
 
 class FloxTest < Test::Unit::TestCase
 
@@ -79,6 +79,7 @@ class FloxTest < Test::Unit::TestCase
     assert_not_nil(player)
     assert_equal(:guest, player.auth_type)
     assert_equal(player, flox.current_player)
+    assert_not_nil(player.id)
   end
 
   def test_load_entity
@@ -97,6 +98,17 @@ class FloxTest < Test::Unit::TestCase
     assert_equal(data["name"], entity["name"])
   end
 
+  def test_load_player
+    id = "id"
+    data = { "name" => "Jean-Luc" }
+    flox.service.expects(:get).once.returns(data)
+    player = flox.load_player(id)
+    assert_kind_of(Flox::Player, player)
+    assert_equal(data["name"], player["name"])
+    assert_equal(id, player.id)
+    assert_equal('.player', player.type)
+  end
+
   def test_save_entity
     data   = { "name" => "Jean-Luc" }
     entity = Flox::Entity.new("type", "id", data)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flox
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Daniel Sperl
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Flox is the no-fuzz backend for game developers. The Ruby SDK allows direct
   interaction with the Flox servers, e.g. to download log files or update