advantage_quickbase 0.3.2 → 0.3.3

data/lib/quickbase.rb

@@ -3,18 +3,30 @@ require 'nokogiri'
 require 'json'
 require 'csv'
 
+Dir['lib/*.rb'].each {|file| require_relative file.gsub!(/lib\//, "")}
+
 module AdvantageQuickbase
   class API
+
     attr_accessor :ticket
 
-    def initialize( domain, username, password, app_token=nil )
+    include User
+    include Table
+    
+    def initialize( domain, username, password, app_token=nil, ticket=nil)
       @domain = domain
 
-      data = {
-        username: username,
-        password: password,
-        apptoken: app_token
-      }
+      if username && password #authenticate with username/password
+        data = {
+          username: username,
+          password: password,
+          apptoken: app_token
+        }
+      else #authenticate with existing ticket
+        @ticket = ticket if ticket
+        data = {}
+      end
+
       request_xml = build_request_xml( data )
 
       @http = Net::HTTP.new( base_domain, 443 )
@@ -233,6 +245,7 @@ module AdvantageQuickbase
 
     def get_tag_value( xml, tag_name )
       tag = xml.css( tag_name.to_s )
+
       tag_value = nil
       if !tag.empty?
         tag_value = tag.text
@@ -241,6 +254,20 @@ module AdvantageQuickbase
       tag_value
     end
 
+    def get_attr_value(tag, attr_name)
+      attr_value = tag.attribute(attr_name.to_s).to_s
+    end
+
+    def send_quickbase_ui_action(url)
+      url = URI.parse(url)
+      request = Net::HTTP::Post.new(url.request_uri)
+      request.set_form_data({'ticket' => @ticket })
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      response = http.request(request)
+    end
+
     def send_request( api_call, db_id, request_data, request_xml=nil )
       # Format request data hash into xml
       if request_data && !request_xml

data/lib/table.rb

@@ -0,0 +1,59 @@
+module AdvantageQuickbase
+  class API
+    module Table
+      def find_db_by_name(name)
+        result = send_request( :FindDBByName, "main", { :dbname => name } )
+        get_tag_value(result, :dbid)
+      end
+
+      def get_db_info(db_id)
+        result = send_request( :GetDBInfo, db_id, {})
+
+        {
+          :name => get_tag_value(result, "dbname"),
+          :last_modified_record => get_tag_value(result, "lastrecmodtime"),
+          :last_modified_time => get_tag_value(result, "lastmodifiedtime"),
+          :created_time => get_tag_value(result, "createdtime"),
+          :number_of_records => get_tag_value(result, "numrecords"),
+          :manager => get_tag_value(result, "mgrid"),
+          :manager_name => get_tag_value(result, "mgrname"),
+          :version => get_tag_value(result, "version"),
+          :time_zone => get_tag_value(result, "time_zone"),
+        }
+      end
+
+      def get_role_info(db_id)
+        roles = []
+        result = send_request( :GetRoleInfo, db_id, {})
+
+        result.css( 'role' ).each do |role|
+          roles << {
+            :id => get_attr_value(role, :id),
+            :name => get_tag_value(role, :name),
+            :access => get_tag_value(role, :access)
+          }
+        end
+
+        roles
+      end
+
+      def get_users_access(db_id)
+        users = []
+        result = send_request( :UserRoles, db_id, {})
+
+        result.css( 'user' ).each do |user|
+          puts user
+          users << {
+            :id => get_attr_value(user, :id),
+            :last_access => get_tag_value(user, :lastaccess),
+            :first_name => get_tag_value(user, :firstname),
+            :last_name => get_tag_value(user, :lastname),
+            :roles => { :name => get_tag_value(user.css( 'role' ), :name), :access => get_tag_value(user.css( 'role' ), :access)}
+          }
+        end
+
+        users
+      end
+    end
+  end
+end

data/lib/user.rb

@@ -0,0 +1,109 @@
+module AdvantageQuickbase
+  class API
+    module User
+      def get_user_info(email)
+        user = send_request( :GetUserInfo, "main", { :email => email })
+        user = {
+          :id => get_attr_value(user.css("user"), :id),
+          :first_name => get_tag_value(user, :firstname),
+          :last_name => get_tag_value(user, :lastname),
+          :login => get_tag_value(user, :login),
+          :email => get_tag_value(user, :email),
+          :screen_name => get_tag_value(user, :screenname),
+        }
+      end
+
+      def get_user_role(db_id, user_id)
+        roles = []
+        result = send_request(:GetUserRole, db_id, { :userid => user_id })
+
+        result.css( 'role' ).each do |role|
+          roles << role = { 
+            :id => get_attr_value(role, :id), 
+            :name => get_tag_value(role, :name), 
+            :type => get_tag_value(role, :access )
+          }
+        end
+
+        roles
+      end
+
+      def add_user_to_role(db_id, user_id, role_id)
+        send_request(:AddUserToRole, db_id, { :userid => user_id, :roleid => role_id }) 
+      end
+
+      def remove_user_from_role(db_id, user_id, role_id)
+        send_request(:RemoveUserFromRole, db_id, { :userid => user_id, :roleid => role_id })
+      end
+
+      def change_user_role(db_id, user_id, role_id, new_role_id=nil)
+        send_request(:ChangeUserRole, db_id, { :userid => user_id, :roleid => role_id, :newroleid => new_role_id })
+      end
+
+      def provision_user(db_id, email, role_id=nil, first_name=nil, last_name=nil)
+        options = {
+          :email => email,
+          :roleid => role_id,
+          :first_name => first_name, 
+          :last_name => last_name
+        }
+
+        send_request(:ProvisionUser, db_id, options)
+      end
+
+      def get_app_access()
+        tables = []
+        result = send_request(:GrantedDBs, "main", {})
+
+        result.css( 'dbinfo' ).each do |database|
+          tables << { :name => get_tag_value(database, "dbname"), :db_id => get_tag_value(database, "dbid") }
+        end
+
+        tables
+      end
+
+      def remove_access(db_id, email)
+        user = self.get_user_info(email)
+        roles = get_user_role(db_id, user[:id])
+
+        roles.each do |role|
+          self.remove_user_from_role(db_id, user[:id], role[:id])
+        end
+      end
+
+      def deny_users(account_id, emails)
+        user_ids = get_user_ids(emails);
+
+        url = "https://#{base_domain}/db/main?a=QBI_AccountRemoveMultiUserAccess"
+        url += "&accountid=#{account_id}"
+        url += "&removeAction=deny"
+        url += "&uids=" + user_ids.join(",")
+
+        result = send_quickbase_ui_action(url)
+        result = parse_xml( result.body )
+
+        get_tag_value(result, "numchanged")
+      end
+
+      def undeny_users(account_id, emails)
+        user_ids = get_user_ids(emails);
+
+        url = "https://#{base_domain}/db/main?a=QBI_AccountRemoveMultiUserAccess"
+        url += "&accountid=#{account_id}"
+        url += "&removeAction=allow"
+        url += "&uids=" + user_ids.join(",")
+
+        result = send_quickbase_ui_action(url)
+        result = parse_xml( result.body )
+
+        get_tag_value(result, "numchanged")
+      end
+
+      def get_user_ids(emails)
+        user_ids = emails.map do |email|
+          self.get_user_info(email)[:id]
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,23 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: advantage_quickbase
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
 - Ben Roux
+- Kit Hensel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000Z
 dependencies: []
 description: Concise implementation of select Quickbase API functions
-email: liquid.ise@gmail.com
+email:
+- liquid.ise@gmail.com
+- kithensel@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/quickbase.rb
+- lib/table.rb
+- lib/user.rb
 homepage: https://github.com/liquidise/Quickbase-Gem
 licenses:
 - MIT
@@ -39,8 +44,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Quickbase API gem
 test_files: []
+has_rdoc: