rhoconnect 3.0.0.beta1

data/lib/rhoconnect/tasks.rb

@@ -0,0 +1,350 @@
+require 'json'
+require 'zip/zip'
+require 'uri'
+require File.join(File.dirname(__FILE__),'console','rhoconnect_api')
+
+module Rhoconnect
+  module TaskHelper
+    def post(path,params)
+      req = Net::HTTP.new($host,$port)
+      resp = req.post(path, params.to_json, 'Content-Type' => 'application/json')
+      print_resp(resp, resp.is_a?(Net::HTTPSuccess) ? true : false)
+    end
+
+    def print_resp(resp,success=true)
+      if success
+        puts "=> OK" 
+      else
+        puts "=> FAILED"
+      end
+      puts "=> " + resp.body if resp and resp.body and resp.body.length > 0
+    end
+
+    def archive(path)
+      File.join(path,File.basename(path))+'.zip'
+    end
+
+    def ask(msg)
+      print msg
+      STDIN.gets.chomp
+    end
+    
+    def load_settings(file)
+      begin
+        $settings = YAML.load_file(file)
+      rescue Exception => e
+        puts "Error opening settings file #{file}: #{e}."
+        puts e.backtrace.join("\n")
+        raise e
+      end
+    end
+    
+    def rhoconnect_socket
+      "/tmp/rhoconnect.dtach"
+    end
+    
+    def rhoconnect_pid
+      "/tmp/rhoconnect.pid"
+    end
+
+    def windows?
+      RUBY_PLATFORM =~ /(win|w)32$/
+    end
+    
+    def ruby19?
+      RUBY_VERSION =~ /1.9/ 
+    end
+
+    def jruby?
+      defined?(JRUBY_VERSION)
+    end
+      
+    def thin?
+      begin
+        require 'thin'
+        'rackup -s thin'
+      rescue LoadError
+        nil
+      end
+    end
+    
+    def mongrel?
+      begin
+        require 'mongrel'
+        'rackup -s mongrel'
+      rescue LoadError
+        nil
+      end
+    end
+    
+    def report_missing_server
+      msg =<<-EOF
+Could not find 'thin' or 'mongrel' on your system.  Please install one:
+  gem install thin
+or
+  gem install mongrel
+EOF
+      puts msg
+      exit 1
+    end
+
+#    def jetty_rackup?
+#      'jruby -S jetty-rackup'
+#    end
+
+    def trinidad?
+      'jruby -S trinidad -p 9292 -r config.ru'
+    end
+  end
+end
+
+namespace :rhoconnect do
+  include Rhoconnect::TaskHelper
+  include RhoconnectApi
+  
+  task :config do
+    $settings = load_settings(File.join('settings','settings.yml'))
+    $env = (ENV['RHO_ENV'] || ENV['RACK_ENV'] || :development).to_sym  
+    uri = URI.parse($settings[$env][:syncserver])
+    $url = "#{uri.scheme}://#{uri.host}"
+    $url = "#{$url}:#{uri.port}" if uri.port && uri.port != 80
+    $host = uri.host
+    $port = uri.port
+    $appname = $settings[$env][:syncserver].split('/').last
+    $token_file = File.join(ENV['HOME'],'.rhoconnect_token')
+    $token = File.read($token_file) if File.exist?($token_file)
+  end
+  
+  task :dtach_installed do
+    if !windows? and (`which dtach` == '')
+      puts "WARNING: dtach not installed or not on path, some tasks will not work!"
+      puts "  Install with '[sudo] rake dtach:install'"
+      exit
+    end
+  end
+  
+  desc "Reset the rhoconnect database (you will need to run rhoconnect:get_token afterwards)"
+  task :reset => :config do
+    confirm = ask " Are you sure? Resetting will remove all data!\n It will also return an error code to all\n existing devices when they connect! (yes/no): "
+    if confirm == 'yes'
+      RhoconnectApi.reset($url,$token) 
+      puts "Database reset."
+    else
+      puts "Cancelling."
+    end
+  end
+  
+  desc "Fetches current api token from rhoconnect"
+  task :get_token => :config do
+    password = ''
+    login = ask "admin login: "
+    begin
+      system "stty -echo"
+      password = ask "\nadmin password: "
+      system "stty echo"
+    rescue NoMethodError, Interrupt
+      system "stty echo"
+      exit
+    end
+    puts ''
+    begin
+      $token = RhoconnectApi.get_token($url,login,password)
+    rescue
+      puts "Login failed."
+      exit
+    end
+    File.open($token_file,'w') {|f| f.write $token}
+    puts "Token is saved in: #{$token_file}"
+  end
+  
+  desc "Clean rhoconnect, get token, and create new user"
+  task :clean_start => [:get_token, :reset, :get_token, :create_user]
+  
+  desc "Alias for `rake rhoconnect:stop; rake rhoconnect:start`"
+  task :restart => [:stop, :start]
+  
+  desc "Creates and subscribes user for application in rhoconnect"
+  task :create_user => :config do
+    password = ''
+    login = ask "new user login: "
+    begin
+      system "stty -echo"
+      password = ask "\nnew user password: "
+      system "stty echo"
+    rescue NoMethodError, Interrupt
+      system "stty echo"
+      exit
+    end
+    puts ''
+    RhoconnectApi.create_user($url,$token,login,password)
+  end
+  
+  desc "Deletes a user from rhoconnect"
+  task :delete_user => :config do
+    login = ask "user to delete: "
+    RhoconnectApi.delete_user($url,$token,login)
+  end
+  
+  desc "Deletes a device from rhoconnect"
+  task :delete_device => :config do
+    user_id = ask "device's user_id: "
+    device_id = ask "device to delete: "
+    RhoconnectApi.delete_client($url,$token,user_id,device_id)
+  end
+  
+  desc "Sets the admin password"
+  task :set_admin_password => :get_token do
+    new_pass,new_pass_confirm = '',''
+    begin
+      system "stty -echo"
+      new_pass = ask "\nnew admin password: "
+      new_pass_confirm = ask "\nconfirm new admin password: "
+      system "stty echo"
+    rescue NoMethodError, Interrupt
+      system "stty echo"
+      exit
+    end
+    if new_pass == ''
+      puts "\nNew password can't be empty."
+    elsif new_pass == new_pass_confirm
+      puts ""
+      post("/api/update_user", {:app_name => $appname, :api_token => $token,
+        :attributes => {:new_password => new_pass}})
+    else
+      puts "\nNew password and confirmation must match."
+    end
+  end
+  
+  desc "Reset source refresh time"
+  task :reset_refresh => :config do
+    user = ask "user: "
+    source_name = ask "source name: "
+    RestClient.post("#{$url}/api/set_refresh_time", {:api_token => $token,
+      :user_name => user, :source_name => source_name})
+  end
+  
+  begin
+    require 'rspec/core/rake_task'
+    require 'rcov/rcovtask' unless (windows? || ruby19?)
+    
+    desc "Run source adapter specs"
+    task :spec do
+      files = File.join('spec','**','*_spec.rb')
+      RSpec::Core::RakeTask.new('rhoconnect:spec') do |t|
+        t.pattern = FileList[files]
+        t.rspec_opts = %w(-fn -b --color)
+        unless (windows? || ruby19?) 
+          t.rcov = true
+          t.rcov_opts = ['--exclude', 'spec/*,gems/*']
+        end
+      end
+    end
+  rescue LoadError
+    if windows?
+      puts "rspec not available. Install it with: "
+      puts "gem install rspec\n\n"
+    else
+      puts "rspec / rcov not available. Install it with: "
+      puts "gem install rspec rcov\n\n"
+    end
+  end
+  
+  desc "Start rhoconnect server"
+  task :start => :dtach_installed do
+    cmd = (jruby?) ? trinidad? : (thin? || mongrel? || report_missing_server)
+    if windows?
+      puts 'Starting server in new window...'
+      system("start cmd.exe /c #{cmd} config.ru")
+    elsif jruby?
+      puts 'Starting server in jruby environment...'
+      system("#{cmd}")
+    else
+      puts 'Detach with Ctrl+\  Re-attach with rake rhoconnect:attach'
+      sleep 2
+      sh "dtach -A #{rhoconnect_socket} #{cmd} config.ru -P #{rhoconnect_pid}"
+    end
+  end
+  
+  desc "run rhoconnect console"
+  task :console, :environment do |t, args|
+    if RedisRunner.running?        
+      #load development environment by default
+      ENV['RACK_ENV'] = args[:environment] || 'development'
+      sh "irb -rubygems -r #{File.join(File.dirname(__FILE__),'console')} -r #{File.dirname(__FILE__)} -r application"
+    else
+      puts "Redis is not running. Please start it by running 'rake redis:start' command."
+    end
+  end
+  
+  desc "Stop rhoconnect server"
+  task :stop => :dtach_installed do
+    sh "cat #{rhoconnect_pid} | xargs kill -3" unless windows?
+  end
+  
+  desc "Attach to rhoconnect console"
+  task :attach => :dtach_installed do
+    sh "dtach -a #{rhoconnect_socket}" unless windows?
+  end
+  
+  desc "Launch the web console in a browser - uses :syncserver: in settings.yml"
+  task :web => :config do
+    windows? ? sh("start #{$url}") : sh("open #{$url}")
+  end
+  
+  desc "Flush data store - WARNING: THIS REMOVES ALL DATA IN RHOCONNECT"
+  task :flushdb => :config do
+    puts "*** WARNING: THIS WILL REMOVE ALL DATA FROM YOUR REDIS STORE ***"
+    confirm = ask "Are you sure (please answer yes/no)? "
+    if confirm == 'yes'
+      Redis.new.flushdb
+      puts "Database flushed..."
+    else
+      puts "Aborted..."
+    end
+  end
+  
+  desc "Generate a cryptographically secure secret session key"
+  task :secret do
+    begin
+      require 'securerandom' 
+      puts SecureRandom.hex(64)
+    rescue LoadError
+      puts "Missing secure random generator.  Try running `rake secret` in a rails application instead."
+    end
+  end
+  
+  desc "Build executable WAR file to be used in Java App Servers"
+  task :war do
+    if jruby? then
+      puts "building the WAR file"
+      if not File::exists? "config/warble.rb"
+        puts "generating Warbler's config file"
+        includeDirs = []
+        Dir.mkdir('config') if not File.exists?('config')
+        aFile = File.new("config/warble.rb", "w+")
+        if aFile
+          includeDirs = FileList['*'].exclude do |entry|
+            entry if (not File.directory? entry) || (entry == 'spec')
+          end
+          configFile = "Warbler::Config.new do |config|\n" +
+            "config.dirs = %w(#{includeDirs.join(' ')})\n" +
+            "config.includes = FileList[\"./*\"]\n" +
+            "config.excludes = FileList[\"./*.war\",'spec']\nend"
+          aFile.write("#{configFile}")
+          aFile.close
+        else
+          puts "Unable to create config/warble.rb file!"
+        end
+      end
+      # build the executable WAR using the config/warble.rb file
+      ENV['BUNDLE_WITHOUT'] = ['development','test'].join(':')
+      sh 'warble executable war'
+    else
+      puts "Cannot build WAR files outside of JRuby environment!"
+    end
+  end
+end
+
+task :default => ['rhoconnect:spec']
+
+load File.join(File.dirname(__FILE__),'..','..','tasks','redis.rake')

data/lib/rhoconnect/test_methods.rb

@@ -0,0 +1,220 @@
+module Rhoconnect
+  class SourceAdapter
+    attr_accessor :result
+  end
+  
+  module TestMethods
+    # Initializes the source adapter under test for a given user, typically in a before(:each) block
+    # setup_test_for(Product,'testuser') #=> 'testuser' will be used by rest of the specs
+    def setup_test_for(adapter,user_id)
+      app_id = 'application'
+      s_fields = {
+        :user_id => user_id,
+        :app_id => app_id
+      }
+      c_fields = {
+        :device_type => 'Apple',
+        :device_pin => 'abcd',
+        :device_port => '3333',
+        :user_id => user_id,
+        :app_id => app_id 
+      }
+      @u = User.create(:login => user_id)
+      @s = Source.load(adapter.to_s,s_fields)
+      @c = Client.create(c_fields,{:source_name => adapter.to_s})
+      @ss = SourceSync.new(@s)
+    end
+    
+    # Executes the adapter's query method and returns 
+    # the master document (:md) stored in redis
+    # For example, if your source adapter query method was:
+    # def query(params=nil)
+    #   @result = { 
+    #     "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
+    #     "2"=>{"name"=>"Best", "industry"=>"Software"}
+    #   }
+    # end
+    # 
+    # test_query would return:
+    # { 
+    #   "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
+    #   "2"=>{"name"=>"Best", "industry"=>"Software"}
+    # }
+    def test_query
+      res = @ss.process_query
+      return @s.is_pass_through? ? res : md
+    end
+    
+    # Executes the adapter's query method and returns 
+    # the metadata stored in redis
+    # For example, if your source adapter metadata method was:
+    # def metadata
+    #     row1 = { 
+    #       :label => 'Address 1',
+    #       :value => '123 fake street',
+    #       :name => 'address1',
+    #       :type => 'labeledrow' 
+    #     }
+    #     table = { 
+    #       :label => 'Table',
+    #       :type => 'table',
+    #       :children => [ row1, row1, row1 ] 
+    #     }
+    #     view = { 
+    #       :title => 'UI meta panel',
+    #       :type => 'iuipanel',
+    #       :children => [table] 
+    #     }
+    #   return the definition as JSON
+    #    {'index' => view}.to_json
+    # 
+    # test_metadata would return:
+    # { 
+    #   {'index' => view}.to_json
+    # }
+    def test_metadata
+     @ss.process_query
+     return @s.get_value(:metadata)
+    end
+    
+    # Executes the adapter's schema method and returns 
+    # the schema stored in redis
+    # For example, if your source adapter schema method was:
+    # def schema
+    # {
+    #     'version' => '1.0',
+    #     'property' => {
+    #       'name' => 'string',
+    #       'brand' => 'string',
+    #       'price' => 'string',
+    #       'image_url_cropped' => 'blob,overwrite',
+    #       'image_url' => 'blob'
+    #      },
+    #     'index' => {
+    #       'by_name_brand' => 'name,brand'
+    #     },
+    #     'unique_index' => {
+    #       'by_price' => 'price'
+    #     }
+    # }.to_json
+    # test_schema would return the above
+    def test_schema
+      @ss.process_query
+      return @s.get_value(:schema)
+    end
+    
+    # Returns any errors stored in redis for the previous source adapter query
+    # For example: {"query-error"=>{"message"=>"error connecting to web service!"}}
+    def query_errors
+      @s.get_data(:errors)
+    end
+    
+    # Execute's the adapter's create method with a provided record and
+    # returns the object string from the create method.  If the create method
+    # returns a string, then a link will be saved for the device next time
+    # it synchronizes.  This link can be tested here.
+    #
+    # For example, in your spec:
+    # @product = {
+    #  'name' => 'iPhone',
+    #  'brand' => 'Apple',
+    #  'price' => '$299.99',
+    #  'quantity' => '5',
+    #  'sku' => '1234'
+    # }
+    # new_product_id = test_create(@product)
+    # create_errors.should == {}
+    # md[new_product_id].should == @product
+    # 
+    # This will return the result of the adapter's create method.  The master 
+    # document (:md) should also contain the new record.
+    def test_create(record)
+      if @s.is_pass_through?
+        @ss.pass_through_cud({'create'=> {'temp-id' => record}},nil)
+      else
+        @c.put_data(:create,{'temp-id' => record})
+        @ss.process_cud(@c.id)
+        links = @c.get_data(:create_links)['temp-id']
+        links ? links['l'] : nil
+      end
+    end
+    
+    # Returns any errors stored in redis from the previous source adapter create
+    # (same structure as query errors)
+    def create_errors
+      @c.get_data(:create_errors)
+    end
+    
+    # Execute the source adapter's update method.
+    # Takes a record as hash of hashes (object_id => object)
+    # 
+    # For example:
+    # test_update({'4' => {'price' => '$199.99'}})
+    # update_errors.should == {}
+    # test_query
+    # md[product_id]['price'].should == '$199.99'
+    # 
+    # This will call the adapter's update method for object_id '4'
+    # NOTE: To test the master document, you will need to run def test_query
+    # as shown above
+    def test_update(record)
+      if @s.is_pass_through?
+        @ss.pass_through_cud({'update'=> record },nil)
+      else
+        @c.put_data(:update,record)
+        @ss.process_cud(@c.id)
+      end
+    end
+    
+    # Returns any errors stored in redis from the previous source adapter update
+    # (same structure as query errors)
+    def update_errors
+      @c.get_data(:update_errors)
+    end
+    
+    # Execute the source adapter's delete method.
+    # Takes a record as hash of hashes (object_id => object)
+    #
+    # For example:
+    # @product = {
+    #   'name' => 'iPhone',
+    #   'brand' => 'Apple',
+    #   'price' => '$299.99',
+    #   'quantity' => '5',
+    #   'sku' => '1234'
+    # }
+    # test_delete('4' => @product)
+    # delete_errors.should == {}
+    # md.should == {}
+    # 
+    # This will call the adapter's delete method for product '4'
+    # NOTE: The master document (:md) will be updated and can be
+    # verified as shown above.
+    def test_delete(record)
+      if @s.is_pass_through?
+        @ss.pass_through_cud({'delete'=> record },nil)
+      else
+        @c.put_data(:delete,record)
+        @ss.process_cud(@c.id)
+      end
+    end
+    
+    # Returns any errors stored in redis from the previous source adapter delete
+    # (same structure as query errors)
+    def delete_errors
+      @c.get_data(:delete_errors)
+    end
+    
+    # Returns the master document (:md) for the source adapter stored in redis.
+    # This is equivalent to the @result hash of hashes structure.
+    def md
+      @s.get_data(:md)
+    end
+    
+    # Returns the client document (:cd) for the source adapter + client under test.
+    # The master document (:md) and client document (:cd) should be equal
+    def cd
+      @c.get_data(:cd)
+    end
+  end
+end

data/lib/rhoconnect/user.rb

@@ -0,0 +1,95 @@
+require 'digest/sha1'
+
+module Rhoconnect
+  # Inspired by sinatra-authentication
+  # Password uses simple sha1 digest for hashing
+  class User < Model
+    field :login,:string
+    field :email,:string
+    field :salt,:string
+    field :hashed_password,:string
+    set   :clients, :string
+    field :admin, :int
+    field :token_id, :string
+        
+    class << self
+      def create(fields={})
+        raise ArgumentError.new("Reserved user id #{fields[:login]}") if fields[:login] && fields[:login] == '__shared__'
+        fields[:id] = fields[:login]
+        user = super(fields)      
+        if Rhoconnect.stats
+          Rhoconnect::Stats::Record.set('users') { Store.incr('user:count') }
+        else
+          Store.incr('user:count')
+        end
+        user
+      end
+    
+      def authenticate(login,password)
+        return unless is_exist?(login)
+        current_user = load(login)
+        return if current_user.nil?
+        return current_user if User.encrypt(password, current_user.salt) == current_user.hashed_password
+      end
+    end
+    
+    def new_password=(pass)
+      self.password=(pass)
+    end
+    
+    def password=(pass)
+      @password = pass
+      self.salt = User.random_string(10) if !self.salt
+      self.hashed_password = User.encrypt(@password, self.salt)
+    end
+    
+    def delete
+      clients.members.each do |client_id|
+        Client.load(client_id,{:source_name => '*'}).delete
+      end
+      self.token.delete if self.token
+      if Rhoconnect.stats
+        Rhoconnect::Stats::Record.set('users') { Store.decr('user:count') }
+      else
+        Store.decr('user:count')
+      end
+      super
+    end
+    
+    def create_token
+      if self.token_id && ApiToken.is_exist?(self.token_id)
+        self.token.delete 
+      end
+      self.token_id = ApiToken.create(:user_id => self.login).id
+    end
+    
+    def token
+      ApiToken.load(self.token_id)
+    end
+    
+    def token=(value)
+      if self.token_id && ApiToken.is_exist?(self.token_id)
+        self.token.delete 
+      end
+      self.token_id = ApiToken.create(:user_id => self.login, :value => value).id
+    end
+    
+    def update(fields)
+      fields.each do |key,value|
+        self.send("#{key.to_sym}=", value) unless key == 'login'
+      end  
+    end
+      
+    protected
+    def self.encrypt(pass, salt)
+      Digest::SHA1.hexdigest(pass+salt)
+    end
+
+    def self.random_string(len)
+      chars = ("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a
+      newpass = ""
+      1.upto(len) { |i| newpass << chars[rand(chars.size-1)] }
+      return newpass
+    end
+  end
+end

data/lib/rhoconnect/version.rb

@@ -0,0 +1,3 @@
+module Rhoconnect
+  VERSION = '3.0.0.beta1'
+end