Table of Contents - right_api_client-1.6.3 Documentation
Pages
- LICENSE
-
README
- RightScale API Client
- Installation
- Versioning
- Usage Instructions
- Making API calls
- Last HTTP Request
- Parameters
- Logging HTTP Requests
- Retrying HTTP Requests
- Managing multiple accounts
- Examples
- Object Types
- Exceptions:
- Instance Facing Calls:
- Examples
- Notes
- RightLink10 and Instance Facing Calls:
- Example
- Design Decisions
- Special Cases
- Returning resource_types that are not actual API resources:
- Index call does not act like an index call
- Having a resource_type that cannot be accurately determined from the URL:
- Method defined on the generic resource_type itself
- Resources are not linked together
- Testing
- Unit Testing
- Functional Testing
- Troubleshooting
- Known issues:
- Wrong ruby version
- Warning message: To disable read timeouts, please set timeout to nil instead of -1
Classes and Modules
- LogOverride
- PostOverride
- RightApi
- RightApi::ApiError
- RightApi::ApiException
- RightApi::Client
- RightApi::Client::@cookies;
- RightApi::Client::ErrorDetails
- RightApi::Client::error;
- RightApi::EmptyBodyError
- RightApi::Exceptions
- RightApi::Helper
- RightApi::Resource
- RightApi::ResourceDetail
- RightApi::Resources
- RightApi::UnknownRouteError
- RightApi::UnknownRouteException
Methods
- ::new — RightApi::Client
- ::new — RightApi::Client::ErrorDetails
- ::new — RightApi::ApiError
- ::new — RightApi::ApiError
- ::new — RightApi::Resource
- ::new — RightApi::ResourceDetail
- ::new — RightApi::Resources
- ::process — RightApi::Resource
- ::process_detailed — RightApi::Resource
- #[] — RightApi::ResourceDetail
- #add_id_and_params_to_path — RightApi::Helper
- #api_methods — RightApi::Helper
- #code — RightApi::Client::ErrorDetails
- #define_instance_method — RightApi::Helper
- #do_delete — RightApi::Client
- #do_get — RightApi::Client
- #do_post — RightApi::Client
- #do_put — RightApi::Client
- #fix_array_of_hashes — RightApi::Helper
- #get_and_delete_href_from_links — RightApi::Helper
- #get_associated_resources — RightApi::Helper
- #get_charset — RightApi::Client
- #get_href_from_links — RightApi::Helper
- #get_resource_type — RightApi::Client
- #get_singular — RightApi::Helper
- #has_id — RightApi::Helper
- #headers — RightApi::Client
- #insert_in_path — RightApi::Helper
- #inspect — RightApi::Client
- #inspect — RightApi::Resource
- #inspect — RightApi::ResourceDetail
- #inspect — RightApi::Resources
- #is_singular? — RightApi::Helper
- #log — RightApi::Client
- #log_request — LogOverride
- #login — RightApi::Client
- #method_missing — RightApi::Resource
- #method_missing — RightApi::ResourceDetail
- #method_missing — RightApi::Resources
- #need_login? — RightApi::Client
- #post — PostOverride
- #prefix — RightApi::ApiError
- #prefix — RightApi::UnknownRouteError
- #prefix — RightApi::EmptyBodyError
- #prefix — RightApi::ApiError
- #prefix — RightApi::UnknownRouteError
- #re_login? — RightApi::Client
- #resource — RightApi::Client
- #resources — RightApi::Client
- #response_code — RightApi::ApiError
- #response_code — RightApi::ApiError
- #retry_request — RightApi::Client
- #simple_singularize — RightApi::Helper
- #timestamp_cookies — RightApi::Client
- #to_ary — RightApi::Resources
- #to_s — RightApi::Client
- #update_access_token — RightApi::Client
- #update_api_url — RightApi::Client
- #update_cookies — RightApi::Client
- #update_last_request — RightApi::Client
- #wrap — RightApi::Client