/orbit-normarlize-member-data

Beta tool to normalize Orbit member data

Primary LanguageGo

Orbit Normalize Member Data

Thanks for checking out my handy tool to work with Orbit's api. Everything is written in go and will continue to be updated as I add in more use cases.

These are the use cases it works for so far:

  • Synchronize Member Data, either company or location
  • Query for members

Future use cases:

  • Import members/activites from events
  • Populate tags based on attributes

Synchronize Member Location Data

  1. Query member profiles for a word and return either location or company data. This query will search the complete member profile. For example, companies or locations described in the member's title or description will trigger a match.

    $ go run ./main.go --query="brisbane" --return=location | sort -u | paste -sd " " -
"Brisbane" "Brisbane, Australia" "San Francisco"

  2. Trim the unwanted results and search for matches.

    $ go run ./main.go --field=location "Brisbane" "Brisbane, Australia"
Orbit Field: location
New Name:
Old Names: [Brisbane Brisbane, Australia]
Checking for members with location: Brisbane
Number of matching members: 1
Checking for members with location: Brisbane, Australia
Number of matching members: 12

===
Number Of Members Updated: 0

  3. Choose the value you wish to synchronize across these member accounts and specify it with the --new flag.

    WARNING: These changes are permanent. Double-check your changes before committing them.

    $ go run ./main.go --field=location --new="Brisbane, Australia"  "Brisbane"
Orbit Field: location
New Name: Brisbane, Australia
Old Names: [Brisbane]
Checking for members with location: Brisbane
Number of matching members: 1
Member Name: Kangaroo Roo
Member Email:
Member ID: xxxxxx
location changed to: Brisbane, Australia

===
Number Of Members Updated: 1

  4. To verify these changes, run the query again, but without the --new flag. You should now see more members in the field you specified as new.

    $ go run ./main.go --field=location "Brisbane, Australia"  "Brisbane"
Orbit Field: location
New Name:
Old Names: [Brisbane, Australia Brisbane]
Checking for members with location: Brisbane, Australia
Number of matching members: 13
Checking for members with location: Brisbane
Number of matching members: 0

===
Number Of Members Updated: 0

Synchronize Member Company Data

  1. Query member profiles for a word and return either location or company data. This query will search the complete member profile. For example, companies or locations described in the member's title or description will trigger a match.

    $ go run ./main.go --query="apple" --return=company | sort -u | paste -sd " " -
"" "@apple" "@atlassian " "Apple Inc." "Apple" "Roku" "ThoughtWorks"

  2. Trim the unwanted results and search for matches.

    $ go run ./main.go --field=company "@apple" "Apple Inc." "Apple"
Orbit Field: company
New Name:
Old Names: [@apple Apple Inc. Apple]
Checking for members with company: @apple
Number of matching members: 2
Checking for members with company: Apple Inc.
Number of matching members: 1
Checking for members with company: Apple
Number of matching members: 3

===
Number Of Members Updated: 0

  3. Choose the value you wish to synchronize across these member accounts and specify it with the --new flag.

    WARNING: These changes are permanent. Double-check your changes before committing them.

    $ go run ./main.go --field=company --new="Apple Inc." "@apple" "Apple"
Orbit Field: company
New Name: Apple Inc.
Old Names: [@apple Apple]
Checking for members with company: @apple
Number of matching members: 2
Member Name: Green Fish 
Member Email:
Member ID: xxxxxx
company changed to: Apple Inc.
Member Name: Red Hen
Member Email:
Member ID: xxxxxx
company changed to: Apple Inc.
Checking for members with company: Apple
Number of matching members: 3
Member Name: Blue Fish
Member Email: Blue_fish@gmail.com
Member ID: xxxxxx
company changed to: Apple Inc.
Member Name: Sandy Turtle
Member Email:
Member ID: xxxxxx
company changed to: Apple Inc.
Member Name: Billy Goat
Member Email: Billy@Goat.com
Member ID: xxxxxx
company changed to: Apple Inc.

===
Number Of Members Updated: 5

  4. Run the query again without the --new flag to see that all users have been moved over to the correct field.

    $ go run ./main.go --field=company "Apple Inc." "@apple" "Apple"
Orbit Field: company
New Name:
Old Names: [Apple Inc. @apple Apple]
Checking for members with company: Apple Inc.
Number of matching members: 6
Checking for members with company: @apple
Number of matching members: 0
Checking for members with company: Apple
Number of matching members: 0

===
Number Of Members Updated: 0

Query for user data

Querying without either of the return flags returns the raw JSON object from Orbit. This works well for searching and pulling member attributes.

$ go run ./main.go --query=apple | jq '.data[] | "\(.attributes.email) \(.attributes.github)"'
"null null"
"null bigfish"
"null green-apple"
"null null"
"user@gmail.com kitkat1919"
"mossgarden@gmail.com mgarden"
"opauser@gmail.com opauser"
"null scooterguy"
"null jackolanter"
"me@email.com null"
"big@ryhme.com bigryhme"
"null null"

Parameters

  • --field: This selects the member attribute to search; currently, location or company are available
  • Names: Pass in space-separated strings at the end of the command. Orbit will query the members that match these names.
  • --new: The value to synchronize across members for the provided field
  • --query: Search member profiles for a word or phrase.
  • --return: Specify a field like company or location, used with --query,

Create Environment Variables to authenticate Orbit API requests

  • ORBIT_API_KEY: Set your Orbit API key as an environment variable
  • ORBIT_WORKSPACE_ID: Set the Orbit workspace ID you want to modify