xingapi

type APIError ¶

type APIError struct {
	Message       string `json:"message"`
	ThrottledType string `json:"throttled"`
	BanTime       string `json:"ban_time"`
	ErrorName     string `json:"error_name"`
}

An APIError represents an error that occurred in the XING API error domain

func (error APIError) String() string

type Address ¶

type Address struct {
	Street   string
	Zipcode  string `json:"zip_code"`
	City     string
	Province string
	Country  string
}

Address represents user and companys' addresses.

func (address Address) String() string

type AuthenticateHandler ¶

type AuthenticateHandler func()

AuthenticateHandler will be called upon successful authentication

type AuthenticationHandler ¶

type AuthenticationHandler func(err error)

AuthenticationHandler is the function to be invoked once authentication against the API has completed

type Birthdate ¶

type Birthdate struct {
	Day   uint
	Month uint
	Year  uint
}

A Birthdate represents a user's birthday

func (birthdate Birthdate) String() string

type Client ¶

type Client interface {
	User(id string, handler UserHandler)
	ContactsList(userID string, limit int, offset int, handler ContactsHandler)
	Me(handler UserHandler)
	Messages(userID string, handler func(err error))
}

The Client interface describes the available methods that wrap around the XING API.

type ContactRepository ¶

type ContactRepository struct {
	// contains filtered or unexported fields
}

ContactRepository represents a repository to retrieve and store contacts

func NewContactRepository(client Client) *ContactRepository

func (repo *ContactRepository) Contact(name string, done func())

func (repo *ContactRepository) Contacts(userID string, contactsHandler func(list []*User, err error))

func (repo ContactRepository) UserDetails(userID string, wg *sync.WaitGroup, userChannel chan User)

type ContactsHandler ¶

type ContactsHandler func(ContactsList, error)

The ContactsHandler can be passed as parameter to methods fetching contact lists. Either ContactsList or error might be nil.

type ContactsList ¶

type ContactsList struct {
	UserIDs []string
	Total   int
}

ContactsList holds a list of UserIDs

type ContactsListUnmarshaler ¶

type ContactsListUnmarshaler interface {
	UnmarshalContactsList(reader io.Reader) (ContactsList, error)
}

ContactsListUnmarshaler defines ContactsList marshaler

type Conversation ¶

type Conversation struct {
	Subject          string `json:"subject"`
	MessageCount     int    `json:"message_count"`
	ChangeTimeString string `json:"updated_at"`
	Readonly         bool   `json:"read_only"`
	Participants     []struct {
		UserID string `json:"id"`
	} `json:"participants"`
}

func (c Conversation) ChangeTime() (time.Time, error)

func (c Conversation) String() string

type ConversationsInfo ¶

type ConversationsInfo struct {
	ConversationsList ConversationsList `json:"conversations"`
}

type ConversationsList ¶

type ConversationsList struct {
	Total         string          `json:"total"`
	Conversations []*Conversation `json:"items"`
}

type ConversationsMarshaler ¶

type ConversationsMarshaler struct{}

func (ConversationsMarshaler) UnmarshalConversationList(reader io.Reader) (ConversationsInfo, error)

type CredentialStore ¶

type CredentialStore struct{}

CredentialStore stores credentials

func (store *CredentialStore) Credentials() (Credentials, error)

func (store *CredentialStore) SaveCredentials(credentials Credentials) error

type Credentials ¶

type Credentials struct {
	Token  string `json:"token"`
	Secret string `json:"secret"`
}

Credentials are used to authenticate against the API via OAuth

type CredentialsMarshaler ¶

type CredentialsMarshaler interface {
	MarshalCredentials(writer io.Writer, credentials Credentials) error
}

CredentialsMarshaler defines Credentials marshaler

type CredentialsUnmarshaler ¶

type CredentialsUnmarshaler interface {
	UnmarshalCredentials(reader io.Reader) (Credentials, error)
}

CredentialsUnmarshaler defines Credentials unmarshaler

type DummyClient ¶

type DummyClient struct {
	Client
	DummyUsers []User
}

DummyClient is used as a mock for tests that need a Client

func (client *DummyClient) ContactsList(userID string, limit int, offset int, handler ContactsHandler)

func (client *DummyClient) User(contactUserID string, handler UserHandler)

type DummyUser ¶

type DummyUser struct {
	XINGUser
	UserID string
}

DummyUser is used as a mock in tests that need a user mock

func (user DummyUser) DisplayName() string

func (user DummyUser) String() string

type JSONContactsList ¶

type JSONContactsList struct {
	JSONContactsUserIDList JSONContactsUserIDList `json:"contacts"`
}

JSONContactsList is a wrapper for parsing contacts JSON.

type JSONContactsUserIDList ¶

type JSONContactsUserIDList struct {
	Total int                 `json:"total"`
	Users []map[string]string `json:"users"`
}

JSONContactsUserIDList is a wrapper for parsing ContactsLists that consist of a Total number of users and a list of UserIDs

func (jsonList *JSONContactsUserIDList) UserIDs() []string

type JSONMarshaler ¶

type JSONMarshaler struct{}

The JSONMarshaler is a concrete implementation of UsersMarshaler/UsersUnmarshaler, CredentialsMarshaler/CredentialsUnmarshaler, ContactsListUnmarshaler and UserUnmarshaler. The JSONMarshaler that allows marshaling and unmarshaling all entities to and from JSON.

func (JSONMarshaler) MarshalCredentials(writer io.Writer, credentials Credentials) error

func (JSONMarshaler) MarshalUser(user User) ([]byte, error)

func (JSONMarshaler) MarshalUsers(writer io.Writer, users Users) error

func (JSONMarshaler) UnmarshalContactsList(reader io.Reader) (ContactsList, error)

func (JSONMarshaler) UnmarshalCredentials(reader io.Reader) (Credentials, error)

func (JSONMarshaler) UnmarshalUser(reader io.Reader) (User, error)

func (JSONMarshaler) UnmarshalUsers(reader io.Reader) (Users, error)

type JSONMessageMarshaler ¶

type JSONMessageMarshaler struct{}

func (JSONMessageMarshaler) UnmarshalMessage(reader io.Reader) (Message, error)

type Message ¶

type Message struct {
}

type OAuthAuthenticator ¶

type OAuthAuthenticator struct {
	Client               oauth.Client
	TemporaryCredentials oauth.Credentials
	OAuthCredentials     oauth.Credentials
	// contains filtered or unexported fields
}

OAuthAuthenticator handles OAuth authentication

func (authenticator *OAuthAuthenticator) Authenticate(handler AuthenticationHandler)

func (authenticator *OAuthAuthenticator) AuthenticateUsingStoredCredentials(storedCredentials Credentials, handler AuthenticationHandler)

type OAuthConsumer ¶

type OAuthConsumer struct {
	// Authenticated indicates whether or not the consumer is currently authenticated
	Authenticated bool

	// AuthenticateHandlers store handlers to be executed once authentication was successful
	AuthenticateHandlers []AuthenticateHandler
	// contains filtered or unexported fields
}

OAuthConsumer connects to the API in a authenticated manner. It wraps GET calls to the API by attaching OAuth information to them.

func (consumer *OAuthConsumer) Get(path string, parameters url.Values, handler ResponseHandler)

type Printer ¶

type Printer struct{}

Printer can be used to print out various domain specific objects in an individually formatted way.

type ResponseHandler ¶

type ResponseHandler func(io.Reader, error)

ResponseHandler handles HTTP response bodies and a potential error

type User ¶

type User interface {
	Name() string
	DisplayName() string
	ID() string
	ActiveEmail() string
	Birthdate() Birthdate
	BusinessAddress() Address
	fmt.Stringer
}

User interface defines methods to call on a user entity

type UserHandler ¶

type UserHandler func(User, error)

A UserHandler is used as parameter to methods that fetch a User. Either the User or error might be nil.

type UserMarshaler ¶

type UserMarshaler interface {
	MarshalUser(user User) (bytes []byte, err error)
}

UserMarshaler defines marshaler for marshaling user to JSON

type UserUnmarshaler ¶

type UserUnmarshaler interface {
	UnmarshalUser(reader io.Reader) (User, error)
}

UserUnmarshaler defines User marshaler

type Users ¶

type Users struct {
	// Users exposes the list of users
	Users []*XINGUser
}

Users contains a list of XING users

type UsersMarshaler ¶

type UsersMarshaler interface {
	MarshalUsers(writer io.Writer, users Users) error
}

UsersMarshaler interface defines Users marshaler

type UsersRequest ¶

type UsersRequest struct {
	UserID     string
	Limit      int
	Offset     int
	Total      int
	Completion UsersRequestHandler
}

UsersRequest represents the request to fetch users from an offset

func (request *UsersRequest) IsFinal() bool

type UsersRequestHandler ¶

type UsersRequestHandler func(users []*User, err error)

UsersRequestHandler represents the function to execute once the users request has completed.

type UsersUnmarshaler ¶

type UsersUnmarshaler interface {
	UnmarshalUsers(reader io.Reader) (Users, error)
}

UsersUnmarshaler interface defines Users unmarshaler

type XINGClient ¶

type XINGClient struct {
	OAuthConsumer OAuthConsumer
}

The XINGClient conforms to the Client interface and handles oAuth authentication for the XING API. It manages all communication with the API's endpoints.

func (client *XINGClient) ContactsList(userID string, limit int, offset int, handler ContactsHandler)

func (client *XINGClient) Me(handler UserHandler)

func (client *XINGClient) Messages(userID string, handler func(err error))

func (client *XINGClient) User(id string, handler UserHandler)

func (client *XINGClient) Users(userIDs []string) []User

type XINGUser ¶

type XINGUser struct {
	InternalName            string    `json:"first_name"`
	InternalDisplayName     string    `json:"display_name"`
	InternalID              string    `json:"id"`
	InternalActiveEmail     string    `json:"active_email"`
	InternalBirthdate       Birthdate `json:"birth_date"`
	InternalBusinessAddress Address   `json:"business_address"`
}

XINGUser is the concrete implementation of a User

func (user XINGUser) ActiveEmail() string

func (user XINGUser) Birthdate() Birthdate

func (user XINGUser) BusinessAddress() Address

func (user XINGUser) DisplayName() string

func (user XINGUser) ID() string

func (user XINGUser) Name() string

func (user XINGUser) String() string