Class: Groups

Inherits:
ChinoBaseAPI show all
Defined in:
lib/chino_ruby.rb

Instance Method Summary collapse

Methods inherited from ChinoBaseAPI

#delete_resource, #get_resource, #initialize, #parse_response, #patch_resource, #post_resource, #post_resource_with_string_result, #put_resource, #return_uri

Methods inherited from CheckValues

#check_boolean, #check_int, #check_json, #check_string

Constructor Details

This class inherits a constructor from ChinoBaseAPI

Instance Method Details

#add_user_schema_to_group(user_schema_id, group_id) ⇒ Object 



866
867
868
869
870
 
# File 'lib/chino_ruby.rb', line 866

def add_user_schema_to_group(user_schema_id, group_id)
    check_string(group_id)
    check_string(user_schema_id)
    post_resource("/groups/#{group_id}/user_schemas/#{user_schema_id}")
end

#add_user_to_group(user_id, group_id) ⇒ Object 



860
861
862
863
864
 
# File 'lib/chino_ruby.rb', line 860

def add_user_to_group(user_id, group_id)
    check_string(group_id)
    check_string(user_id)
    post_resource("/groups/#{group_id}/users/#{user_id}")
end

#create_group(group_name, attributes) ⇒ Object 



835
836
837
838
839
840
841
842
 
# File 'lib/chino_ruby.rb', line 835

def create_group(group_name, attributes)
    check_string(group_name)
    check_json(attributes)
    data = {"group_name": group_name, "attributes": attributes}.to_json
    group = Group.new
    group.from_json(post_resource("/groups", data).to_json, true)
    group
end

#delete_group(group_id, force) ⇒ Object 



854
855
856
857
858
 
# File 'lib/chino_ruby.rb', line 854

def delete_group(group_id, force)
    check_string(group_id)
    check_boolean(force)
    delete_resource("/groups/#{group_id}", force)
end

#get_group(group_id) ⇒ Object 



811
812
813
814
815
816
 
# File 'lib/chino_ruby.rb', line 811

def get_group(group_id)
    check_string(group_id)
    g = Group.new
    g.from_json(get_resource("/groups/#{group_id}").to_json, true)
    g
end

#list_groups(limit = nil, offset = nil) ⇒ Object 



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
 
# File 'lib/chino_ruby.rb', line 818

def list_groups(limit=nil, offset=nil)
    groups = GetGroupsResponse.new
    if limit==nil && offset==nil
      groups.from_json(get_resource("/groups", ChinoRuby::QUERY_DEFAULT_LIMIT, 0).to_json)
    else
      groups.from_json(get_resource("/groups", limit, offset).to_json)
    end
    gs = groups.groups
    groups.groups = []
    gs.each do |g|
        group = Group.new
        group.from_json(g.to_json)
        groups.groups.push(group)
    end
    groups
end

#remove_user_from_group(user_id, group_id) ⇒ Object 



872
873
874
875
876
 
# File 'lib/chino_ruby.rb', line 872

def remove_user_from_group(user_id, group_id)
    check_string(group_id)
    check_string(user_id)
    delete_resource("/groups/#{group_id}/users/#{user_id}", false)
end

#remove_user_schema_from_group(user_schema_id, group_id) ⇒ Object 



878
879
880
881
882
 
# File 'lib/chino_ruby.rb', line 878

def remove_user_schema_from_group(user_schema_id, group_id)
    check_string(group_id)
    check_string(user_schema_id)
    delete_resource("/groups/#{group_id}/user_schemas/#{user_schema_id}", false)
end

#update_group(group_id, group_name, attributes) ⇒ Object 



844
845
846
847
848
849
850
851
852
 
# File 'lib/chino_ruby.rb', line 844

def update_group(group_id, group_name, attributes)
    check_string(group_id)
    check_string(group_name)
    check_json(attributes)
    data = {"group_name": group_name, "attributes": attributes}.to_json
    group = Group.new
    group.from_json(put_resource("/groups/#{group_id}", data).to_json, true)
    group
end