Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Push to Version 1.0.0 #8

Closed
tflanagan opened this issue Jul 31, 2015 · 2 comments
Closed

Push to Version 1.0.0 #8

tflanagan opened this issue Jul 31, 2015 · 2 comments
Labels
help wanted

Comments

@tflanagan
Copy link
Owner

Push to Version 1.0.0

With the ever increasing use of this library [Thanks guys! :)] in Node, and now the browser, getting a stable API is becoming more of an issue.

With that in mind, I would like to release 1.0.0 marking a line in the sand in terms of backwards compatibility and intended use.

If anyone has anything to add to this list before I release 1.0.0, please feel free to comment/submit a PR.

General To Do

Future...

  • ES6 Branch

Testing API Functions

Test each API function looking for sensible return objects from XML -> JSON and then cleanXML. This will help find bugs in cleanXML and keep the output standardized as much as possible.

  • API_AddField
  • API_AddGroupToRole
  • API_AddRecord
  • API_AddReplaceDBPage
  • API_AddSubGroup
  • API_AddUserToGroup
  • API_AddUserToRole
  • API_Authenticate
  • API_ChangeGroupInfo
  • API_ChangeManager
  • API_ChangeRecordOwner
  • API_ChangeUserRole
  • API_CloneDatabase
  • API_CopyGroup
  • API_CopyMasterDetail
  • API_CreateDatabase
  • API_CreateGroup
  • API_CreateTable
  • API_DeleteDatabase
  • API_DeleteField
  • API_DeleteGroup
  • API_DeleteRecord
  • API_DoQuery
  • API_DoQueryCount
  • API_EditRecord
  • API_FieldAddChoices
  • API_FieldRemoveChoices
  • API_FindDBByName
  • API_GenAddRecordForm
  • API_GenResultsTable
  • API_GetAncestorInfo
  • API_GetAppDTMInfo
  • API_GetDBPage
  • API_GetDBInfo
  • API_GetDBVar
  • API_GetGroupRole
  • API_GetNumRecords
  • API_GetSchema
  • API_GetRecordAsHTML
  • API_GetRecordInfo
  • API_GetRoleInfo
  • API_GetUserInfo
  • API_GetUserRole
  • API_GetUsersInGroup
  • API_GrantedDBs
  • API_GrantedDBsForGroup
  • API_GrantedGroups
  • API_ImportFromCSV
  • API_ProvisionUser
  • API_PurgeRecords
  • API_RemoveGroupFromRole
  • API_RemoveSubgroup
  • API_RemoveUserFromGroup
  • API_RemoveUserFromRole
  • API_RenameApp
  • API_RunImport
  • API_SendInvitation
  • API_SetDBVar
  • API_SetFieldProperties
  • API_SetKeyField
  • API_SignOut
  • API_UploadFile
  • API_UserRoles

Testing API Options

Ensure that the same option name for different API Functions have the same behavior

  • accountId
    API Calls: API_ChangeGroupInfo, API_CreateGroup
  • add_to_forms
    API Calls: API_AddField
  • adminOnly
    API Calls: API_GrantedDBs
  • adminonly
    API Calls: API_GrantedGroups
  • allow_new_choices
    API Calls: API_SetFieldProperties
  • allowAdminAccess
    API Calls: API_AddUserToGroup
  • allowHTML
    API Calls: API_SetFieldProperties
  • allRoles
    API Calls: API_RemoveGroupFromRole
  • appears_by_default
    API Calls: API_SetFieldProperties
  • append-only
    API Calls: API_SetFieldProperties
  • blank_is_zero
    API Calls: API_SetFieldProperties
  • bold
    API Calls: API_SetFieldProperties
  • choice
    API Calls: API_FieldAddChoices, API_FieldRemoveChoices
  • choices
    API Calls: API_SetFieldProperties
  • clist
    API Calls: API_DoQuery, API_GenResultsTable, API_ImportFromCSV
  • clist_output
    API Calls: API_ImportFromCSV
  • comma_start
    API Calls: API_SetFieldProperties
  • copyfid
    API Calls: API_CopyMasterDetail
  • createapptoken
    API Calls: API_CreateDatabase
  • currency_format
    API Calls: API_SetFieldProperties
  • currency_symbol
    API Calls: API_SetFieldProperties
  • dbdesc
    API Calls: API_CreateDatabase
  • dbname
    API Calls: API_CreateDatabase, API_FindDBByName
  • decimal_places
    API Calls: API_SetFieldProperties
  • default_today
    API Calls: API_SetFieldProperties
  • default_value
    API Calls: API_SetFieldProperties
  • description
    API Calls: API_ChangeGroupInfo, API_CopyGroup, API_CreateGroup
  • destrid
    API Calls: API_CopyMasterDetail
  • dfid
    API Calls: API_GetRecordAsHTML
  • display_as_button
    API Calls: API_SetFieldProperties
  • display_dow
    API Calls: API_SetFieldProperties
  • display_month
    API Calls: API_SetFieldProperties
  • display_relative
    API Calls: API_SetFieldProperties
  • display_time
    API Calls: API_SetFieldProperties
  • display_zone
    API Calls: API_SetFieldProperties
  • disprec
    API Calls: API_AddRecord, API_EditRecord
  • does_average
    API Calls: API_SetFieldProperties
  • does_total
    API Calls: API_SetFieldProperties
  • doesdatacopy
    API Calls: API_SetFieldProperties
  • email
    API Calls: API_GetUserInfo, API_ProvisionUser
  • excludefiles
    API Calls: API_CloneDatabase
  • excludeparents
    API Calls: API_GrantedDBs
  • fform
    API Calls: API_AddRecord, API_EditRecord
  • fid
    API Calls: API_DeleteField, API_FieldAddChoices, API_FieldRemoveChoices, API_SetFieldProperties, API_SetKeyField
  • field
    API Calls: API_AddRecord, API_EditRecord, API_GenAddRecordForm, API_UploadFile
  • fieldhelp
    API Calls: API_SetFieldProperties
  • find_enabled
    API Calls: API_SetFieldProperties
  • fmt
    API Calls: API_DoQuery
  • fname
    API Calls: API_ProvisionUser
  • formula
    API Calls: API_SetFieldProperties
  • gacct
    API Calls: API_CopyGroup
  • gid
    API Calls: API_AddGroupToRole, API_AddSubGroup, API_AddUserToGroup, API_ChangeGroupInfo, API_CopyGroup, API_DeleteGroup, API_GetGroupRole, API_GetUsersInGroup, API_GrantedDBsForGroup, API_RemoveGroupFromRole, API_RemoveSubgroup, API_RemoveUserFromGroup
  • has_extension
    API Calls: API_SetFieldProperties
  • hours
    API Calls: API_Authenticate
  • id
    API Calls: API_RunImport
  • ignoreError
    API Calls: API_AddRecord, API_EditRecord
  • inclgrps
    API Calls: API_GetUserRole
  • includeAllMgrs
    API Calls: API_GetUsersInGroup
  • includeancestors
    API Calls: API_GrantedDBs
  • includeRids
    API Calls: API_DoQuery
  • jht
    API Calls: API_GenResultsTable
  • jsa
    API Calls: API_GenResultsTable
  • keepData
    API Calls: API_CloneDatabase
  • key
    API Calls: API_ChangeRecordOwner, API_DeleteRecord, API_EditRecord, API_GetRecordInfo
  • label
    API Calls: API_AddField, API_SetFieldProperties
  • lname
    API Calls: API_ProvisionUser
  • maxlength
    API Calls: API_SetFieldProperties
  • mode
    API Calls: API_AddField
  • msInUTC
    API Calls: API_AddRecord, API_EditRecord, API_ImportFromCSV
  • name
    API Calls: API_ChangeGroupInfo, API_CopyGroup, API_CreateGroup
  • newappname
    API Calls: API_RenameApp
  • newdbdesc
    API Calls: API_CloneDatabase
  • newdbname
    API Calls: API_CloneDatabase
  • newmgr
    API Calls: API_ChangeManager
  • newowner
    API Calls: API_ChangeRecordOwner
  • newroleid
    API Calls: API_ChangeUserRole
  • no_wrap
    API Calls: API_SetFieldProperties
  • numberfmt
    API Calls: API_SetFieldProperties
  • options
    API Calls: API_DoQuery, API_GenResultsTable
  • pagebody
    API Calls: API_AddReplaceDBPage
  • pageid
    API Calls: API_AddReplaceDBPage
  • pageID
    API Calls: API_GetDBPage
  • pagename
    API Calls: API_AddReplaceDBPage
  • pagetype
    API Calls: API_AddReplaceDBPage
  • ParentsOnly
    API Calls: API_FindDBByName
  • password
    API Calls: API_Authenticate
  • pnoun
    API Calls: API_CreateTable
  • qid
    API Calls: API_DoQuery, API_GenResultsTable, API_PurgeRecords
  • qname
    API Calls: API_DoQuery, API_GenResultsTable, API_PurgeRecords
  • query
    API Calls: API_DoQuery, API_DoQueryCount, API_GenResultsTable, API_PurgeRecords
  • records_csv
    API Calls: API_ImportFromCSV
  • recurse
    API Calls: API_CopyMasterDetail
  • relfids
    API Calls: API_CopyMasterDetail
  • required
    API Calls: API_SetFieldProperties
  • returnpercentage
    API Calls: API_DoQuery
  • rid
    API Calls: API_ChangeRecordOwner, API_DeleteRecord, API_EditRecord, API_GetRecordAsHTML, API_GetRecordInfo, API_UploadFile
  • roleid
    API Calls: API_AddGroupToRole, API_AddUserToRole, API_ChangeUserRole, API_ProvisionUser, API_RemoveGroupFromRole, API_RemoveUserFromRole
  • skipfirst
    API Calls: API_ImportFromCSV
  • slist
    API Calls: API_DoQuery, API_GenResultsTable
  • sort_as_given
    API Calls: API_SetFieldProperties
  • sourcerid
    API Calls: API_CopyMasterDetail
  • subgroupid
    API Calls: API_AddSubGroup, API_RemoveSubgroup
  • tname
    API Calls: API_CreateTable
  • type
    API Calls: API_AddField
  • unique
    API Calls: API_SetFieldProperties
  • update_id
    API Calls: API_EditRecord
  • userid
    API Calls: API_AddUserToGroup, API_AddUserToRole, API_ChangeUserRole, API_GetUserRole, API_GrantedGroups, API_RemoveUserFromGroup, API_RemoveUserFromRole, API_SendInvitation
  • username
    API Calls: API_Authenticate
  • usersandroles
    API Calls: API_CloneDatabase
  • usertext
    API Calls: API_SendInvitation
  • value
    API Calls: API_SetDBVar
  • varname
    API Calls: API_GetDBVar, API_SetDBVar
  • width
    API Calls: API_SetFieldProperties
  • withembeddedtables
    API Calls: API_GrantedDBs
@tflanagan
Copy link
Owner Author

Using http-proxy-agent and https-proxy-agent breaks this module when used in the browser with Browserify.

I'm removing Proxy Support from the v1.0.0 release as it will require me to write those two modules myself in ways that will work in the browser.

I'll plan it for v1.1.0.

@tflanagan
Copy link
Owner Author

https://github.com/tflanagan/node-quickbase/releases/tag/v1.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@tflanagan