Class: Net::Instagram::Models::User

Inherits:
Object
  • Object
show all
Defined in:
lib/net/instagram/models/user.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs = {}) ⇒ User

Returns a new instance of User.



10
11
12
13
 
# File 'lib/net/instagram/models/user.rb', line 10

def initialize(attrs = {})
  @username = attrs['username']
  @follower_count = attrs['counts']['followed_by']
end

Instance Attribute Details

#follower_count ⇒ Object (readonly)

Returns the value of attribute follower_count.



8
9
10
 
# File 'lib/net/instagram/models/user.rb', line 8

def follower_count
  @follower_count
end

#username ⇒ Object (readonly)

Returns the value of attribute username.



8
9
10
 
# File 'lib/net/instagram/models/user.rb', line 8

def username
  @username
end

Class Method Details

.find_by(params = {}) ⇒ Net::Instagram::Models::User?

Returns the existing Instagram user matching the provided attributes or nil when the user is not found.

Parameters:

  • params (Hash) (defaults to: {}) —

    the attributes to find a user by.

Options Hash (params):

  • :username (String) —

    The Instagram user’s username (case-insensitive).

Returns:



23
24
25
26
27
 
# File 'lib/net/instagram/models/user.rb', line 23

def self.find_by(params = {})
  find_by! params
rescue Errors::PrivateUser, Errors::UnknownUser
  nil
end

.find_by!(params = {}) ⇒ Net::Instagram::Models::User

Returns the existing Instagram user matching the provided attributes or nil when the user is not found, and raises an error when the user account is private.

Parameters:

  • params (Hash) (defaults to: {}) —

    the attributes to find a user by.

Options Hash (params):

  • :username (String) —

    The Instagram user’s username (case-insensitive).

  • :id (String) —

    The Instagram user’s id (case-insensitive).

Returns:

Raises:

  • (Net::Errors::PrivateUser) —

    if the user account is private.



39
40
41
42
43
44
45
 
# File 'lib/net/instagram/models/user.rb', line 39

def self.find_by!(params = {})
  if params[:username]
    find_by_username! params[:username]
  elsif params[:id]
    find_by_id! params[:id]
  end
end