flox 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ad9881566390837774beb2f6ba709d533e2cd94
-  data.tar.gz: 25da47a5b5d16804352e2beba5e479b332f38ccf
+  metadata.gz: 4e270b70cbf4293d5e3ded85a0e179a1aadecb21
+  data.tar.gz: 7a9dd4ddb98a13d4491fbe12c677c8f77779a450
 SHA512:
-  metadata.gz: f39a94d6a7edc427e1b003773f9f44c813a033339a52c13d748cdda5306b63c19c83e012253b2caa31386570c8743707c856b666e2e736cd4adb327e2c47a316
-  data.tar.gz: 539663241fe8bfea69b91f928f052b88fea07029037ed4a56da069db6e080053708be529d972ef48b125fdc761ac2e494980b6bc0fc9798e80201a0e61951590
+  metadata.gz: 9233cde0da9935db8d8e9b4aa2e00177eee2f68c2ef46a9db828b3f247fa2a609fe15ac9198b13fbbf6aeb0db18da71b580edbb632ced6491807f0b4ef01f2c2
+  data.tar.gz: d748fe1818ce22e485257ed39916ab5211cb8b0a18c0f1f05ae53578726391de3e0a764934ce1c8f48d85ba043cd6ff207ab9f96880a9b7b17fb2dad9944e7d8

data/bin/flox

@@ -4,43 +4,36 @@
 ## Copyright: Copyright 2014 Gamua
 ## License:   Simplified BSD
 
-$LOAD_PATH << '../lib'
-
 require 'flox'
 require 'fileutils'
-require 'trollop'
+require 'slop'
 
+# Helper class that does the heavy lifting.
 class Worker
 
   attr_reader :flox
 
-  def initialize(game_id, game_key, base_url)
-    @flox = Flox.new(game_id, game_key, base_url)
-  end
-
-  def login_with_key(key)
-    flox.login_with_key(key)
-  end
+  def initialize(args={})
+    base_url = args[:url] || Flox::DEFAULT_URL
+    game_id  = args[:game_id]
+    game_key = args[:game_key]
+    hero_key = args[:hero_key]
 
-  def execute(command_name, args)
-    begin
-      method_name = command_name.downcase.gsub("-", "_")
-      self.send(method_name, **args)
-    rescue Exception => e
-      log "Error: " + e.to_s
-    end
+    @flox = Flox.new(game_id, game_key, base_url)
+    print "Logging in as Hero ... "
+    @flox.login_with_key hero_key
+    puts "done."
   end
 
-  private
-
-  def download_logs(args={})
+  def load_logs(args={})
     query = args[:query]
     limit = args[:limit]
     destination = args[:destination] || Dir.pwd
     FileUtils.mkdir_p(destination)
 
-    log "Fetching Logs ..."
+    print "Loading log IDs (this could take a moment) ... "
     log_ids = flox.load_log_ids(query, limit)
+    puts "found #{log_ids.length} logs."
     log_ids.each do |log_id|
       remote_path = "logs/#{log_id}"
       local_path = File.join(destination, log_id) + ".json"
@@ -48,55 +41,55 @@ class Worker
     end
   end
 
-  def status(args={})
-    log "Fetching Server Status ..."
-    status = flox.status
-    log "Version: #{status['version']}, status: #{status['status']}"
-  end
-
-  def log(message)
-    puts message
-  end
-
-  def fail(message)
-    log message
-    exit
-  end
+  private
 
   def load_and_save_resource(remote_path, local_path)
     if (File.exists? local_path)
-      log("Skipped #{local_path} (file exists)")
+      puts("Skipped #{local_path} (file exists)")
     else
       resource = flox.load_resource(remote_path)
       File.write(local_path, JSON.pretty_generate(resource))
-      log("Saved #{local_path}")
+      puts("Saved #{local_path}")
     end
   end
 
 end
 
-options = Trollop::options do
-  banner "Administrative utility for the Flox.cc Game Backend"
-  opt :key, "The 'Hero' key used for authentication", :type => :string, :required => true
-  opt :game_id, "The ID of the game", :type => :string, :required => true
-  opt :game_key, "The key of the game", :type => :string, :required => true
-  opt :base_url, "The URL of the Flox service", :type => :string
-  opt :destination, "The directory in which to store the logs", :type => :string
-  opt :query, "Narrows down the list of results", :type => :string
-  opt :limit, "Maximum number of logs to download", :type => :int
+#
+# Parsing command line arguments
+#
+
+def shared_options
+  on :i, "game_id=", "The public identifier of the game", :required => true
+  on :k, "game_key=", "The private key of the game", :required => true
+  on :o, "hero_key=", "The key of a Hero player that will be logged in", :required => true
+  on :u, "url=", "The URL to the Flox service"
 end
 
-commands = ARGV.clone
-# puts "Optons: #{options}"
+begin
+
+  ARGV << "-h" if ARGV.empty?
+  Slop.parse(ARGV, :help => true) do
 
-hero_key = options[:key]
-game_id  = options[:game_id]
-game_key = options[:game_key]
-base_url = options[:base_url] || Flox::DEFAULT_URL
+    on :v, "version", 'Print the current version of the Flox Gem.' do
+      puts "Gamua Flox v#{Flox::VERSION}"
+    end
 
-worker = Worker.new(game_id, game_key, base_url)
-worker.login_with_key(hero_key)
+    command "load_logs" do
+      description "Fetch log files from the server."
+
+      shared_options
+      on :d, "destination=", "The directory in which to store the logs"
+      on :q, "query=", "Narrow down the results, e.g. 'day:2013-12-24 severity:error'"
+      on :l, "limit=", "Maximum number of logs to download", as: Integer
+
+      run do |opts, args|
+        Worker.new(opts).load_logs(opts)
+      end
+    end
+
+  end
 
-commands.each do |command|
-  worker.execute(command, options)
+rescue Slop::Error, Flox::Error => error
+  puts error
 end

data/lib/flox.rb

@@ -8,6 +8,9 @@
 # of all players.
 class Flox
 
+  # The main Error class, all Exception classes inherit from this class.
+  class Error < StandardError; end
+
   # The URL where the Flox servers are found.
   DEFAULT_URL = "https://www.flox.cc"
 

data/lib/flox/rest_service.rb

@@ -115,7 +115,7 @@ class Flox::RestService
         rescue
           response.body
         end
-        raise message
+        raise Flox::Error, message
       end
     end
   end

data/lib/flox/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flox
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Sperl
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.7
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -72,7 +86,8 @@ description: |
   specific entities. It can be used from other Ruby scripts or directly with
   its bundled command-line utility.
 email: daniel@gamua.com
-executables: []
+executables:
+- flox
 extensions: []
 extra_rdoc_files: []
 files: