flox 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e270b70cbf4293d5e3ded85a0e179a1aadecb21
-  data.tar.gz: 7a9dd4ddb98a13d4491fbe12c677c8f77779a450
+  metadata.gz: 0bfcc3ed174c17361a262d7634fe46f422b68305
+  data.tar.gz: 8c9a1c957fe98e7b0e557212e5cea525db3a8be7
 SHA512:
-  metadata.gz: 9233cde0da9935db8d8e9b4aa2e00177eee2f68c2ef46a9db828b3f247fa2a609fe15ac9198b13fbbf6aeb0db18da71b580edbb632ced6491807f0b4ef01f2c2
-  data.tar.gz: d748fe1818ce22e485257ed39916ab5211cb8b0a18c0f1f05ae53578726391de3e0a764934ce1c8f48d85ba043cd6ff207ab9f96880a9b7b17fb2dad9944e7d8
+  metadata.gz: 6f5bdb3a1b5391172b3ae9ee2b338e12df39589c8374934aaf17ec026978d1b8206d4d07b7a2f7a4dfbdc419dde912caf83aee9ff4044684391e6d89b5c4e4b4
+  data.tar.gz: dc46222be994747ca4a6e6b4b0dd6cdb7e5364902d7c7eb1587dd596319fc8db9b254abd4ef9138c3270762e80aa359039b34a2718c7099ed5edf68c4b9dfbe8

data/.yardopts

@@ -0,0 +1,3 @@
+--readme README.md
+--title 'Flox-Ruby API Documentation'
+--markup markdown

data/LICENSE.md

@@ -0,0 +1,28 @@
+Simplified BSD License
+======================
+
+Copyright 2014 Gamua. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY GAMUA "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GAMUA OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are those of the
+authors and should not be interpreted as representing official policies, either expressed
+or implied, of Gamua.

data/README.md

@@ -0,0 +1,78 @@
+# Flox Tools for Ruby
+
+[![Gem Version](https://badge.fury.io/rb/flox.png)](http://badge.fury.io/rb/flox)
+[![Build Status](https://travis-ci.org/Gamua/Flox-Ruby.png?branch=master)](https://travis-ci.org/Gamua/Flox-Ruby)
+
+## What is Flox?
+
+Flox is a server backend especially for game developers, providing all the basics you need for a game: analytics, leaderboards, custom entities, and much more. The focus of Flox lies on its scalability (guaranteed by running in the Google App Engine) and ease of use.
+
+While you can communicate with our servers directly via REST, we provide powerful SDKs for the most popular development platforms, including advanced features like offline-support and data caching. With these SDKs, integrating Flox into your game is just a matter of minutes.
+
+* More information about Flox can be found on [Flox.cc](http://www.flox.cc)
+* The source code of the Ruby SDK is hosted on [GitHub.com](https://github.com/Gamua/Flox-Ruby)
+* The API reference of the Ruby SDK can be found on [RubyDoc.info](http://rubydoc.info/gems/flox/frames)
+
+## How to install the Flox Gem
+
+Flox is distributed as a Ruby Gem, so you can install it just like any other gem:
+
+    gem install flox
+
+## How to use the Flox executable
+
+The Gem comes with a small command-line script that is automatically added to your system PATH. The script can be used to carry out certain tasks very easily. To get a list of supported commands, run
+
+    flox --help
+
+As an example, here's how to download all the log files of a certain day that have at least severity "warning":
+
+    flox load_logs --game_id "id" --game_key "key" --hero_key "key" \
+                   --query "day:2014-03-10 severity:warning" \
+                   --destination "logs"
+
+Note that you need to authorize with a "Hero" key. A hero is a special Flox player that has super-user rights; create it in the Flox online interface.
+
+## How to use the Flox SDK
+
+The Ruby client is designed to be used not in games, but in scripts that help you operate your games. You can use it e.g. to automatically download your leaderboards or certain entities for backup. It's also easy to utilize Flox via 'irb', allowing quick introspection into your server data.
+
+To start up, create a Flox instance with your game id and key:
+
+    flox = Flox.new('game-id', 'game-key')
+
+Just like in the command-line script, you'll need to login as a 'Hero':
+
+    flox.login_with_key('hero-key')
+
+We're done with the preparations! Now let's look at some of the things you can do.
+
+### Working with Entities
+
+    # load an entity with a certain type and id
+    entity = flox.load_entity('entity-type', 'entity-id') # => Flox::Entity
+
+    # modify it via the []-operator
+    entity['myProperty'] = 'something'
+
+    # save or delete at will
+    flox.save_entity(entity)
+    flox.delete_entity(entity)
+
+### Accessing leaderboards
+
+    # load scores from a leaderboard
+    scores = flox.load_scores('leaderboard-id', :today) # => Array of Flox::Score
+    best_score = scores.first.value
+    best_player_id = scores.first.player_id
+
+### Loading logs
+
+    # load all logs from a certain day that contain a warning or error
+    logs = flox.load_logs('day:2014-02-22 warning')
+    num_logs = logs.length
+    logs.each { |log| puts log['duration'] }
+
+## Where to go from here:
+
+This is just the tip of the iceberg! Have a look at the complete API Reference to find out what's possible. New features will be added regularly!

data/lib/flox/version.rb

@@ -9,6 +9,6 @@
 class Flox
 
   # The current version of the Flox SDK.
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Sperl
@@ -91,6 +91,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- LICENSE.md
+- ".yardopts"
 - bin/flox
 - test/test_entity.rb
 - test/test_flox.rb