badgeville_berlin 0.1.0

data/examples/shell/lib/berlin_shell/core.rb

@@ -0,0 +1,118 @@
+module BadgevilleBerlin::Shell
+  class Core
+    
+    class << self
+      attr_accessor 'sites', 'working_path_parts', 'cache'
+    end
+    
+    self.sites = []
+    self.working_path_parts = {:site => nil, :object => nil, :item => nil}
+    self.cache = {:site => nil, :item => nil}
+    
+    @@objects = {
+      "Activity" => BadgevilleBerlin::Activity,
+      "ActivityDefinition" => BadgevilleBerlin::ActivityDefinition,
+      "Group" => BadgevilleBerlin::Group,
+      "Leaderboard" => BadgevilleBerlin::Leaderboard,
+      "Player" => BadgevilleBerlin::Player,
+      "Reward" => BadgevilleBerlin::Reward,
+      "RewardDefinition" => BadgevilleBerlin::RewardDefinition,
+      "Track" => BadgevilleBerlin::Track,
+      "User" => BadgevilleBerlin::User
+    }
+    
+    def self.objects
+      @@objects
+    end
+    
+    def self.working_path
+      path = "/"
+      [:site, :object, :item].each do |index|
+        if Core.working_path_parts[index] != nil
+          path += Core.working_path_parts[index] + "/"
+        end
+      end
+      return path
+    end
+    
+    def self.parse_path (path)
+      if !path.match /^\// # Relative Path
+        path = Core.working_path + path
+      end
+      path = path.sub(/^\/*/,"").sub(/\/$/,"") # Trim / 
+      parts = path.split("/")
+      
+      # Handle ../../
+      parts_clean = []
+      parts.each_index do |i|
+        if parts[i] == '..'
+          parts_clean.delete_at(parts_clean.length - 1)
+        elsif parts[i] != '.'
+          parts_clean.push(parts[i])
+        end
+      end
+      
+      return {:site => parts_clean[0], :object => parts_clean[1], :item => parts_clean[2]}
+    end
+
+    def self.find_prefix (prefix, list)
+      found = false
+      list.each do |item|
+        if item.id
+          if item.id.match /^ + prefix + /
+            return item
+          end
+        end
+      end
+    end
+
+    def self.valid_path_parts (path_parts)
+      if path_parts[:site] == nil
+        return true
+      end
+      
+      # Validate site
+      site = self.is_site_cached(path_parts[:site])
+      if !site
+        begin
+          site = BadgevilleBerlin::Site.find(path_parts[:site])
+          self.cache[:site] = site
+        rescue
+          return false
+        end
+      end
+      
+      # Validate Object
+      if path_parts[:object] != nil && !Core.objects[path_parts[:object]]
+         return false
+      end
+      
+      # Validate item
+      if path_parts[:item] != nil && !self.is_item_cached(path_parts[:item])
+        begin
+          item = Core.objects[path_parts[:object]].find(path_parts[:item]) # currently only works for id
+          self.cache[:item] = item
+        rescue
+          return false
+        end
+      end
+      
+      return true
+    end
+    
+    def self.is_site_cached (site)
+      if self.cache[:site] == nil
+        return false
+      end
+      return (self.cache[:site].attributes[:url] == site || self.cache[:site].attributes[:_id] == site) ? self.cache[:site] : false
+    end
+    
+    def self.is_item_cached (item)
+      if self.cache[:item] == nil
+        return false
+      end
+      return (cache[:item].attributes[:email] == item || cache[:item].attributes[:_id] == item) ? cache[:item] : false
+    end
+    
+  end
+end

data/examples/shell/lib/berlin_shell/ls.rb

@@ -0,0 +1,72 @@
+module BadgevilleBerlin::Shell
+  class LS
+    @@spacer = "\n"
+    
+    def self.execute (path)
+      path_parts = (path == nil) ? Core.working_path_parts : Core.parse_path(path)
+      
+      if !Core.valid_path_parts(path_parts)
+        say "Path is not valid."
+        return
+      end
+      
+      if path_parts[:site] == nil
+        items = self.get_sites
+      elsif path_parts[:object] == nil
+        items = self.get_objects
+      elsif path_parts[:item] == nil
+        items = self.get_items(path_parts)
+      else
+        items = self.get_details(path_parts)
+      end
+
+      say items.join(@@spacer)
+    end
+    
+    def self.get_sites
+      items = []
+      page = 1
+      while true
+        sites = BadgevilleBerlin::Site.find(:all, :params => {:page => page, :per_page => 50})
+        if sites.empty?
+          break
+        else
+          sites.each do |site|
+            Core.sites.push(site)
+          end
+          page = page + 1
+        end
+      end
+      Core.sites.each do |site|
+        items.push(site.id + " (" + site.url + ")")
+      end
+      
+      return items
+    end
+    
+    def self.get_objects ()
+      items = []
+      Core.objects.each do |name, obj|
+        items.push(name)
+      end
+      return items
+    end
+    
+    def self.get_items (path_parts)
+      items = []
+      params = {}
+      params[:site] = path_parts[:site]
+      Core.objects[path_parts[:object]].find(:all, params).each do |item|
+        # Use ID, but try to add email then name if available
+        items.push((item.attributes["_id"] || item.attributes["id"]) + (item.attributes["email"] ? " (" + item.attributes["email"] + ")" : (item.attributes["name"] ? " (" + item.attributes["name"] + ")" : "") ))
+      end
+      return items
+    end
+    
+    def self.get_details (path_parts)
+      items = []
+      items.push(Core.objects[path_parts[:object]].find(path_parts[:item]).to_yaml)
+      return items
+    end
+  end
+end

data/examples/shell/lib/berlin_shell/prompt.rb

@@ -0,0 +1,39 @@
+module BadgevilleBerlin::Shell
+  class Prompt
+    def self.listen
+      instructions = ask(Core.working_path + " >> " ).split(" ", 2)
+
+      if instructions.empty?
+        return true
+      end
+
+      case instructions[0].downcase
+        when 'exit'
+          say 'Goodbye!'
+          return false
+          
+        when 'ls'
+          begin
+            LS.execute(instructions[1])
+          rescue
+            say('ls failed')
+          end
+          
+        when 'cd'
+          CD.execute(instructions[1])
+          
+        when 'rm'
+          Commands.rm(instructions[1])
+          
+        when 'touch'
+          Commands.touch(instructions[1])
+          
+        when "pwd"
+          Commands.pwd
+        else
+      end
+      
+      return true
+    end
+  end
+end

data/examples/shell/shell_demo.rb

@@ -0,0 +1,319 @@
+require "rubygems"
+require "ruby-debug"
+require "badgeville_berlin"
+require "highline/import"
+
+# We created a shell using the Berlin Gem.  In other words, we have created a terminal for the publisher module.
+#
+# 1.
+#   P: A client needs a list of sites within their network.
+#   A: ls /
+#
+# 2.
+#   P: A client needs a list of players within a site.
+#   A: cd /staging.widgets.badgeville.com/Player
+#   P: To get player details
+#   A: ls 4d8bb5e8d0c0b35cd7000002
+#
+# 3.
+#   P: A client may also list leaderboards
+#   A: ls
+
+module BerlinShell
+  HOST = "hostname"
+  APIKEY = "api_key"
+  NETWORK_ID = "network_id"
+  ENDPOINT = "/api/berlin/"
+  SPACER = "\n"
+  BadgevilleBerlin::Config.conf(:host_name => 'http://' + HOST + '/', :api_key => APIKEY)
+  say "Connected to " + HOST
+
+  @@bv_objs = {
+    "Activity" => BadgevilleBerlin::Activity,
+    "ActivityDefinition" => BadgevilleBerlin::ActivityDefinition,
+    "Group" => BadgevilleBerlin::Group,
+    "Leaderboard" => BadgevilleBerlin::Leaderboard,
+    "Player" => BadgevilleBerlin::Player,
+    "Reward" => BadgevilleBerlin::Reward,
+    "RewardDefinition" => BadgevilleBerlin::RewardDefinition,
+    "Site" => BadgevilleBerlin::Site,
+    "Track" => BadgevilleBerlin::Track,
+    "User" => BadgevilleBerlin::User
+  }
+  @@sites = BadgevilleBerlin::Site.find(:all)
+  @@working_path_parts = ["Staging"]
+  @@item = nil
+
+  def self.item
+    @@item
+  end
+  def self.item=(item)
+    @@item = item
+  end
+
+  def self.bv_objs
+    @@bv_objs
+  end
+
+  def self.sites
+    @@sites
+  end
+
+  def self.sites=(sites)
+    @@sites = sites
+  end
+
+  # Site/Object/ID, touch ABC.COM/player/; touch {email: name: etc,}
+  def self.working_path_parts
+     @@working_path_parts
+  end
+  def self.working_path_parts=(parts)
+    @@working_path_parts = parts
+  end
+
+  def self.parse_path (path)
+    if path == "/"
+      path = "/Staging"
+    end
+
+    # Handle ../
+    if ((path == "../" || path == "..") && BerlinShell.working_path_parts.length > 1)
+      BerlinShell.working_path_parts.pop
+      path = ""
+    end
+
+    if !path.match /^\// # Relative Path
+      path = BerlinShell.working_path_parts.join("/") + "/" + path
+    elsif !path.match /^\/Staging/ # Absolute Path w.out /Site
+      path = "/Staging" + path
+    end
+
+    path = path.sub(/^\/*/,"").sub(/\/$/,"") # Trim /
+    parts = path.split("/")
+
+    parts
+  end
+
+  def self.find_prefix (prefix, list)
+    found = false
+    list.each do |item|
+      if item.id
+        if item.id.match /^ + prefix + /
+          return item
+        end
+      end
+    end
+  end
+
+  def self.valid_path_parts (parts)
+    if parts.length == 1
+      return true
+    end
+
+    # Validate site
+    if !get_site(parts[1])
+      return false
+    end
+
+    # Validate Object
+    if parts[2] && !BerlinShell.bv_objs[parts[2]]
+       return false
+    end
+
+    # Validate item
+    if parts[3]
+      # needs to be coded
+    end
+
+    return true
+  end
+
+  def self.get_site (needle)
+    found = false
+    BerlinShell.sites.each do |site|
+      if site.url == needle || site.id == needle
+        found = site
+      end
+    end
+    return found
+  end
+
+
+  class Commands
+    def self.ls (path)
+      path_parts = (path == nil) ? BerlinShell.working_path_parts : BerlinShell.parse_path(path)
+      items = []
+      if !BerlinShell.valid_path_parts(path_parts)
+        say "Path is not valid."
+        return
+      end
+
+      case  path_parts.length
+        when 1 # List Sites
+          page = 1
+          while true
+            sites = BadgevilleBerlin::Site.find(:all, :params => {:page => page, :per_page => 50 })
+            if sites.empty?
+              break
+            else
+              sites.each do|site|
+                BerlinShell.sites.push(site)
+              end
+              page = page + 1
+            end
+          end
+
+          BerlinShell.sites.each do |site|
+            items.push(site.id + " (" + site.url + ")")
+          end
+        when 2 # List Objects
+          BerlinShell.bv_objs.each do |name, obj|
+            items.push(name)
+          end
+        when 3 # List Items
+
+          params = {}
+          case path_parts[2]
+            when "User"
+              puts "ls user"
+              page = 1
+              while true
+                users = BadgevilleBerlin::User.find(:all, :params => {:page => page, :per_page => 50 })
+                if users.empty?
+                  break
+                else
+                  users.each do|user|
+                    items.push("#{user.attributes["_id"]} (#{user.attributes["email"]}) #{user.attributes["name"]}")
+                  end
+                  page = page + 1
+                end
+              end
+            else
+              params[:site] = path_parts[1]
+              BerlinShell.bv_objs[path_parts[2]].find(:all, params).each do |item|
+                # Use ID, but try to add email then name if available
+                items.push((item.attributes["_id"] || item.attributes["id"]) + (item.attributes["email"] ? " (" + item.attributes["email"] + ")" : (item.attributes["name"] ? " (" + item.attributes["name"] + ")" : "") ))
+              end
+          end
+        when 4 # List Details
+          items.push(BerlinShell.bv_objs[path_parts[2]].find(path_parts[3]).to_yaml)
+      end
+
+      say items.join(SPACER)
+    end
+
+    def self.cd (path)
+      if (path == nil)
+          say ("Missing argument.")
+          return
+      end
+      path_parts = BerlinShell.parse_path(path)
+      if BerlinShell.valid_path_parts(path_parts)
+        BerlinShell.working_path_parts = path_parts
+      else
+        say "Path is not valid."
+      end
+    end
+
+    def self.touch(args)
+
+      #write touch
+      begin
+        param_hash = eval(args)
+      rescue
+        say "Arguments for touch must be a hash (e.g. {\"name\" => \"site\", \"url\" => \"url.com\"})"
+        return
+      end
+
+      path_parts = BerlinShell.working_path_parts
+      part = path_parts[path_parts.length-1]
+
+      merged_hash = {}
+      if part == "User" || part == "Site"
+        merged_hash = {:network_id => NETWORK_ID}
+      elsif part == "Player" || part == "ActivityDefinition" || part == "RewardDefinition"
+        merged_hash = {:site_id => path_parts[1]}
+      end
+      param_hash = param_hash.merge(merged_hash)
+
+
+      if path_parts.length == 4
+        say "You cannot create an attribute on a record"
+      elsif path_parts.length == 2
+        say "Have to be inside a model dir to create a record."
+      else
+        begin
+          object = "BadgevilleBerlin::#{part}".constantize.new(param_hash)
+          success = object.save
+        rescue
+          say("You passed invalid arguments to create a #{part}.")
+          return
+        end
+
+        if success
+          puts object
+          say "Successfully created #{part} with arguments #{args}"
+        else
+          say "Failed to create #{part}."
+        end
+      end
+    end
+
+    def self.rm (id)
+      if (id == nil)
+          say ("Missing argument.")
+      end
+
+      path_parts = BerlinShell.working_path_parts
+      part = path_parts[path_parts.length-1]
+
+      if path_parts.length == 4
+        puts "You cannot delete attributes on a record"
+      else
+        begin
+          #check that record still exists remotely (race condition)
+          object = "BadgevilleBerlin::#{part}".constantize.find(id)
+          valid_id = true
+        rescue
+          say("You passed in an invalid #{part} id or property.")
+        end
+        "BadgevilleBerlin::#{part}".constantize.delete(id) unless valid_id.nil?
+        puts "Successfully deleted #{part} #{id}" unless valid_id.nil?
+      end
+    end
+
+    def self.pwd
+      say( BerlinShell.working_path_parts.join("/") + "/")
+    end
+
+  end
+
+  while true
+    inputs = ask("/" + @@working_path_parts.join("/") +  "/ >> " ).split(" ", 2)
+
+    if inputs.empty?
+      next
+    end
+
+    case inputs[0].downcase
+    when "exit"
+      abort("Goodbye!")
+    when "ls"
+      begin
+        Commands.ls(inputs[1])
+      rescue
+        say("Unable to ls.")
+      end
+    when "cd"
+      Commands.cd(inputs[1])
+    when "rm"
+      Commands.rm(inputs[1])
+    when "touch"
+      Commands.touch(inputs[1])
+    when "pwd"
+      Commands.pwd
+    else
+    end
+  end
+
+end