Interface for invoking Salesforce.com REST calls over SSL with OAUTH authentication. This interface is designed to simplify the interaction between mbed devices and salesforce.com web services.
Dependencies: HTTPClient-SSL MbedJSONValue
SalesforceInterface.h
- Committer:
- ansond
- Date:
- 2014-09-22
- Revision:
- 8:47db53cd5884
- Parent:
- 7:97ea5ef906f7
- Child:
- 9:a254fcd904be
File content as of revision 8:47db53cd5884:
/* Copyright C2014 ARM, MIT License * * Permission is hereby granted, free of charge, to any person obtaining a copy of this software * and associated documentation files the "Software", to deal in the Software without restriction, * including without limitation the rights to use, copy, modify, merge, publish, distribute, * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all copies or * substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ #ifndef _SALESFORCE_INTERFACE_H_ #define _SALESFORCE_INTERFACE_H_ // ErrorHandler #include "ErrorHandler.h" // SSL-based HTTP support #include "HTTPClient.h" // JSON parsing support #include "MbedJSONValue.h" // verbose debugging #if ENABLE_DEBUG_LOGGING #define DEBUG(...) { this->logger()->logConsole(__VA_ARGS__); } #else #define DEBUG(...) #endif // convenience macros #define DEFINE_BUFFER(x) char x[MAX_BUFFER_LENGTH+1] #define RESET_BUFFER(x) memset(x,0,MAX_BUFFER_LENGTH+1) #define ALLOC_BUFFER(x) DEFINE_BUFFER(x);RESET_BUFFER(x) #define DEFINE_SML_BUFFER(x) char x[MAX_SMALL_BUFFER_LENGTH+1] #define RESET_SML_BUFFER(x) memset(x,0,MAX_SMALL_BUFFER_LENGTH+1) #define ALLOC_SML_BUFFER(x) DEFINE_SML_BUFFER(x);RESET_SML_BUFFER(x) // Default salesforce API version (must be in XX.Y format and must be a string) #define SALESFORCE_API_VERSION_LENGTH 10 #ifndef SALESFORCE_API_VERSION #define SALESFORCE_API_VERSION "28.0" #endif // HTTP Verbs typedef enum { GET, PUT, POST, DELETE, NUM_VERBS } HttpVerb; // Supported input data types for PUT and POST (Defined by HTTPClient-SSL/data support...) typedef enum { JSON, // ContentType: application/json PLAIN_TEXT, // ContentType: plain/text FORM_MAPPED, // ContentType: application/x-www-form-urlencoded NUM_TYPES } InputDataTypes; // OAUTH structure typedef struct { bool valid; string id; string issued_at; string token_type; string instance_url; string signature; string access_token; } OauthToken; // This class provides an interface into the REST-based Salesforce.com APIs class SalesforceInterface { private: ErrorHandler *m_logger; HTTPClient *m_http; char *m_username; char *m_password; char *m_client_id; char *m_client_secret; bool m_have_creds; OauthToken m_oauth_token; HTTPResult m_http_status; int m_http_response_code; char m_http_redirection_url[MAX_BUFFER_LENGTH+1]; char m_salesforce_id[MAX_BUFFER_LENGTH+1]; char m_salesforce_api[SALESFORCE_API_VERSION_LENGTH]; public: // construction/destruction SalesforceInterface(ErrorHandler *logger,HTTPClient *http); virtual ~SalesforceInterface(); // set Salesforce.com credentials void setCredentials(char *username,char *password,char *client_id,char *client_secret); // get our ID structure from Salesforce char *getSalesforceID(); bool haveSalesforceID(); // set/get our salesforce API version void setSalesforceAPIVersion(int version); void setSalesforceAPIVersion(char *version); char *getSalesforceAPIVersion(); // QUERY: into Salesforce.com char *query(char *query_str,char *output_buffer,int output_buffer_length); // raw invocation of REST calls into Salesforce.com char *invoke(const char *url,char *output_buffer,int output_buffer_len); // defaults to GET char *invoke(const char *url,const char *input_data,const int input_data_len,char *output_buffer,int output_buffer_len); // defaults to POST with JSON input data type // defaults to GET char *invoke(const char *url,const InputDataTypes input_type,const char *input_data,const int input_data_len,char *output_buffer,int output_buffer_len); // defaults to POST with variable input data type char *invoke(const char *url,const InputDataTypes input_type,const char *input_data,const int input_data_len,char *output_buffer,int output_buffer_len,const HttpVerb verb); // full fidelity method private: // get our OAUTH Token void checkAndGetOauthToken(); char *getOauthToken(char *output_buffer,int output_buffer_length); // convenience accessors ErrorHandler *logger(); HTTPClient *http(); OauthToken *oauth(); HTTPResult httpStatus(); int httpResponseCode(); // internal checkers bool haveCreds(); void resetOauthToken(); void fillOauthToken(char *token); bool validOauthToken(); // get the specified URL from our Salesforce ID char *getSalesforceURL(char *key,char *url_buffer,int url_buffer_length); // simple char array replacement (modifies input string!) void replace(char *str,char orig_char,char new_char); // needed to replace substrings within std::string void replace(string& line, string& oldString, string& newString); }; #endif // _SALESFORCE_INTERFACE_H_