Table of Contents - Ruby / Orchestrate.io

Classes and Modules

• Orchestrate
  • Ruby Application Development for Orchestrate.io
  • Orchestrate.io API wrapper gem
  • Orchestrate.io / Rails model-mapper gem
• Orchestrate::API
  • orchestrate-api
• Orchestrate::API::Error
• Orchestrate::API::Procedural
  • Procedural interface methods (optional).
• Orchestrate::API::Request
• Orchestrate::API::Response
• Orchestrate::API::Response::Header
• Orchestrate::API::ResponseBody
• Orchestrate::API::Wrapper
  • Ruby wrapper for the Orchestrate.io REST API.
• Orchestrate::Application
  • orchestrate-application
  • Usage example
• Orchestrate::Application::Connect
• Orchestrate::Application::Document
• Orchestrate::Application::Example
  • Usage example
• Orchestrate::Application::Metadata
• Orchestrate::Application::PrimaryKey
• Orchestrate::Application::Record
• Orchestrate::Application::RefTable
• Orchestrate::Application::Response
• Orchestrate::Application::ResponseBody
• Orchestrate::Application::Result
• Orchestrate::Application::Schema
• Orchestrate::Application::SchemaCollection
• Orchestrate::Application::SchemaEventType
• Orchestrate::Application::SchemaGraph
• Orchestrate::Application::SearchResult
• Orchestrate::Application::SimpleCacheCollection
• Orchestrate::Application::SimpleCacheRefs
• Orchestrate::Application::SimpleCacheRequest
• Orchestrate::Application::SimpleCacheResponse
• Orchestrate::Application::SimpleCacheResponse::Body
• Orchestrate::Application::SimpleCacheResponse::Header
• Orchestrate::Application::SimpleCacheStore
• Orchestrate::Rails
  • orchestrate-rails
  • User Guide
  • Try out the Tutorial!
• Orchestrate::Rails::Event
• Orchestrate::Rails::Model
• Orchestrate::Rails::Schema
• Orchestrate::Rails::SchemaCollection
• Orchestrate::Rails::SearchResult
• Orchestrate::Rails::Tutorial
  • Using the orchestrate-rails gem
  • Get Started Now!
  • Sections
• Orchestrate::Rails::Tutorial::BuildTheApp
  • Building the rails application
  • Setting up the rails routing
  • Setting up the schema for the films collection
  • Creating the Film model.
  • Creating the films controller.
  • Creating the view for the #index action.
  • Ready to roll
  • Next
• Orchestrate::Rails::Tutorial::CreateEvent
  • Creating Orchestrate.io events
  • Next
• Orchestrate::Rails::Tutorial::CreateGraph
  • Creating an Orchestrate.io graph
  • Next
• Orchestrate::Rails::Tutorial::GetEvents
  • Getting orchestrate.io events
  • Updating the Film model to get orchestrate.io events.
  • Updating the films controller.
  • Updating the view to display comment events.
  • Let's check it out
  • Next
• Orchestrate::Rails::Tutorial::GetGraph
  • Getting an Orchestrate.io graph
  • Updating the Film model for orchestrate.io graphs.
  • Updating the films controller.
  • Updating the view to display sequel relations.
  • Let's check it out
  • Next
• Orchestrate::Rails::Tutorial::GettingStarted
  • Getting started with orchestrate-rails
  • Signing up for Orchestrate.io
  • Creating the configuration file
  • Next
• Orchestrate::Rails::Tutorial::PopulateFilmsCollection
  • Populating the films collection with data
  • Method 1. Cut-and-paste using the Orchestrate.io dashboard
  • Method 2. Download the orchestrate-api demo
  • Next
• Orchestrate::Rails::Tutorial::SettingUpRails
  • Setting up the rails environment
  • Generating the rails application
  • Adding the orchestrate.io configuration file
  • Updating the Gemfile
  • Setting up Bootstrap
  • Next
• Orchestrate::Rails::Tutorial::TheCreateAction
  • Adding the create action
  • Updating the films controller.
  • Creating the view for the #new action.
  • Adding a form-specific stylesheet
  • Check it out
  • Next
• Orchestrate::Rails::Tutorial::TheSearchAction
  • Adding search capability to the example application
  • Updating up the rails routing
  • Adding the search_results action to the films controller.
  • Adding a search form to the index view.
  • Adding the view for search_results
  • Try it out
  • Next
• Orchestrate::Rails::Tutorial::TheShowAction
  • Adding the show action
  • Updating the films controller.
  • Creating the view for the #show action.
  • Let's check it out
  • Next
• Orchestrate::Rails::UserGuide
  • User Guide for the orchestrate-rails gem
• Orchestrate::Rails::UserGuide::TheBasics
  • orchestrate-rails - the basics
  • Orchestrate.io information
  • The configuration file
  • The Gemfile
  • Next
• Orchestrate::Rails::UserGuide::TheController
  • The controller
  • Next
• Orchestrate::Rails::UserGuide::TheModel
  • Defining the model
  • Collection names.
  • Next
• Orchestrate::Rails::UserGuide::TheRefTable
  • The ref table
  • Next
• Orchestrate::Rails::UserGuide::TheSchema
  • Properties and attributes
  • The id attribute
  • The schema
  • Schema definition during Rails initialization
  • Next
• String
• Symbol

Methods

• ::all — Orchestrate::Rails::Model
• ::attributes — Orchestrate::Rails::Model
• ::attrs — Orchestrate::Rails::Model
• ::build_attr_map — Orchestrate::Rails::Schema
• ::client — Orchestrate::Application::Connect
• ::client — Orchestrate::Application::Record
• ::config — Orchestrate::Application::Connect
• ::connect — Orchestrate::Application::Connect
• ::create — Orchestrate::Rails::Model
• ::create! — Orchestrate::Rails::Model
• ::define_collection — Orchestrate::Rails::Schema
• ::define_event_type — Orchestrate::Rails::Schema
• ::define_graph — Orchestrate::Rails::Schema
• ::destroy — Orchestrate::Rails::Model
• ::destroy! — Orchestrate::Rails::Model
• ::destroy_all — Orchestrate::Rails::Model
• ::disable — Orchestrate::Application::SimpleCacheStore
• ::enable — Orchestrate::Application::RefTable
• ::enable — Orchestrate::Application::SimpleCacheStore
• ::enabled? — Orchestrate::Application::RefTable
• ::exists? — Orchestrate::Rails::Model
• ::find — Orchestrate::Rails::Model
• ::find_by — Orchestrate::Rails::Model
• ::find_by_method — Orchestrate::Rails::Model
• ::first — Orchestrate::Rails::Model
• ::get_collection_name — Orchestrate::Application::RefTable
• ::instance — Orchestrate::Application::SimpleCacheStore
• ::last — Orchestrate::Rails::Model
• ::list — Orchestrate::Rails::Model
• ::load — Orchestrate::Rails::Schema
• ::method_missing — Orchestrate::Rails::Model
• ::new — Orchestrate::API::Request
• ::new — Orchestrate::Application::SchemaEventType
• ::new — Orchestrate::API::Response::Header
• ::new — Orchestrate::Application::SimpleCacheRequest
• ::new — Orchestrate::Application::Result
• ::new — Orchestrate::Application::Response
• ::new — Orchestrate::Application::SchemaCollection
• ::new — Orchestrate::API::Wrapper
• ::new — Orchestrate::Application::Record
• ::new — Orchestrate::Application::Metadata
• ::new — Orchestrate::Application::SimpleCacheResponse
• ::new — Orchestrate::Application::SimpleCacheResponse::Header
• ::new — Orchestrate::Application::Schema
• ::new — Orchestrate::Application::SimpleCacheResponse::Body
• ::new — Orchestrate::Application::PrimaryKey
• ::new — Orchestrate::Application::RefTable
• ::new — Orchestrate::Application::SimpleCacheCollection
• ::new — Orchestrate::API::Response
• ::new — Orchestrate::API::ResponseBody
• ::new — Orchestrate::Application::SimpleCacheRefs
• ::new — Orchestrate::Application::SimpleCacheStore
• ::new — Orchestrate::Application::SchemaGraph
• ::new — Orchestrate::Rails::Model
• ::new — Orchestrate::Rails::Event
• ::new — Orchestrate::Application::Document
• ::orchio_delete — Orchestrate::Application::Record
• ::orchio_delete_key — Orchestrate::Application::Record
• ::orchio_list — Orchestrate::Application::Record
• ::orchio_query_str — Orchestrate::Rails::Model
• ::orchio_search — Orchestrate::Application::Record
• ::properties — Orchestrate::Rails::Model
• ::qmap — Orchestrate::Rails::Model
• ::respond_to? — Orchestrate::Rails::Model
• ::sanitize — Orchestrate::Application::Record
• ::schema — Orchestrate::Rails::Model
• ::search — Orchestrate::Rails::Model
• ::search_results — Orchestrate::Rails::Model
• ::take — Orchestrate::Rails::Model
• ::where — Orchestrate::Rails::Model
• #add_event — Orchestrate::Application::PrimaryKey
• #add_graph — Orchestrate::Application::PrimaryKey
• #attr_map — Orchestrate::Rails::Schema
• #attributes — Orchestrate::Rails::Model
• #attrs — Orchestrate::Rails::Schema
• #attrs — Orchestrate::Rails::Model
• #build_query_map — Orchestrate::Rails::Schema
• #build_url — Orchestrate::API::Wrapper
• #cache — Orchestrate::Application::Document
• #cache — Orchestrate::Application::SimpleCacheRequest
• #cache — Orchestrate::Application::SimpleCacheStore
• #cache — Orchestrate::Application::Record
• #cache_enabled? — Orchestrate::Application::Document
• #cache_request — Orchestrate::Application::Record
• #classname — Orchestrate::Rails::Schema
• #classname — Orchestrate::Application::Document
• #client — Orchestrate::Application::Record
• #collection_names — Orchestrate::Application::Schema
• #collections — Orchestrate::Application::Schema
• #create_event — Orchestrate::Rails::Model
• #define_attr_query — Orchestrate::Rails::Model
• #define_collection — Orchestrate::Application::Schema
• #define_event_type — Orchestrate::Application::SchemaCollection
• #define_event_type — Orchestrate::Application::Schema
• #define_graph — Orchestrate::Application::Schema
• #define_graph — Orchestrate::Application::SchemaCollection
• #delete_collection — Orchestrate::API::Procedural
• #delete_graph — Orchestrate::Rails::Model
• #delete_graph — Orchestrate::API::Procedural
• #delete_key — Orchestrate::API::Procedural
• #destroy — Orchestrate::Rails::Model
• #destroy! — Orchestrate::Rails::Model
• #disable — Orchestrate::Application::SimpleCacheStore
• #document — Orchestrate::Application::SimpleCacheResponse::Body
• #document — Orchestrate::Application::SimpleCacheRefs
• #enable — Orchestrate::Application::SimpleCacheStore
• #enabled? — Orchestrate::Application::SimpleCacheRequest
• #errors — Orchestrate::API::Error
• #events — Orchestrate::Rails::Model
• #fetch — Orchestrate::Application::SimpleCacheCollection
• #fetch — Orchestrate::Application::SimpleCacheStore
• #fetch_events — Orchestrate::Application::SimpleCacheCollection
• #fetch_graph — Orchestrate::Application::SimpleCacheCollection
• #flush! — Orchestrate::Application::SimpleCacheStore
• #flush! — Orchestrate::Application::SimpleCacheCollection
• #flush! — Orchestrate::Application::SimpleCacheRefs
• #fullclassname — Orchestrate::Rails::Schema
• #funkify — Orchestrate::Application::Record
• #get — Orchestrate::Rails::Model
• #get — Orchestrate::Application::Schema
• #get — Orchestrate::Application::SimpleCacheRequest
• #get_by_ref — Orchestrate::Rails::Model
• #get_by_ref — Orchestrate::API::Procedural
• #get_cache_collection — Orchestrate::Application::SimpleCacheStore
• #get_cc — Orchestrate::Application::SimpleCacheStore
• #get_collection — Orchestrate::Application::Schema
• #get_collection_from_class — Orchestrate::Rails::Schema
• #get_events — Orchestrate::Application::SimpleCacheRequest
• #get_events — Orchestrate::API::Procedural
• #get_graph — Orchestrate::API::Procedural
• #get_graph — Orchestrate::Application::SimpleCacheRequest
• #get_key — Orchestrate::API::Procedural
• #get_ref — Orchestrate::Application::SimpleCacheCollection
• #get_ref — Orchestrate::Application::SimpleCacheStore
• #graph — Orchestrate::Rails::Model
• #id — Orchestrate::Rails::Event
• #init_collection_name — Orchestrate::Application::Record
• #inst_args — Orchestrate::Application::Record
• #is_enabled? — Orchestrate::Application::SimpleCacheStore
• #list — Orchestrate::API::Procedural
• #load — Orchestrate::Application::Schema
• #load_collection — Orchestrate::Application::Schema
• #location — Orchestrate::Application::SimpleCacheResponse::Header
• #ocollection — Orchestrate::Application::Record
• #options — Orchestrate::API::Request
• #orchestrate_client — Orchestrate::Application::Record
• #orchestrate_collection_name — Orchestrate::Application::Record
• #orchestrate_collection_name — Orchestrate::Rails::Model
• #orchestrate_primary_key — Orchestrate::Application::Record
• #orchestrate_ref_value — Orchestrate::Rails::Model
• #orchestrate_ref_value — Orchestrate::Application::Record
• #orchio_delete — Orchestrate::Application::Record
• #orchio_delete_graph — Orchestrate::Application::Record
• #orchio_get — Orchestrate::Application::Record
• #orchio_get_by_ref — Orchestrate::Application::Record
• #orchio_get_events — Orchestrate::Application::Record
• #orchio_get_graph — Orchestrate::Application::Record
• #orchio_purge — Orchestrate::Application::Record
• #orchio_put — Orchestrate::Application::Record
• #orchio_put_event — Orchestrate::Application::Record
• #orchio_put_graph — Orchestrate::Application::Record
• #orchio_put_if_match — Orchestrate::Application::Record
• #orchio_put_if_none_match — Orchestrate::Application::Record
• #orchio_update_ref_table — Orchestrate::Application::Record
• #perform — Orchestrate::API::Request
• #properties — Orchestrate::Rails::Schema
• #purge_key — Orchestrate::API::Procedural
• #put_event — Orchestrate::API::Procedural
• #put_graph — Orchestrate::API::Procedural
• #put_key — Orchestrate::API::Procedural
• #put_key_if_match — Orchestrate::API::Procedural
• #put_key_if_none_match — Orchestrate::API::Procedural
• #qmap — Orchestrate::Rails::Schema
• #read_attribute_for_serialization — Orchestrate::Rails::Model
• #read_attribute_for_validation — Orchestrate::Rails::Model
• #response — Orchestrate::Application::SimpleCacheRequest
• #result — Orchestrate::Application::Result
• #result_keys — Orchestrate::API::ResponseBody
• #result_keys — Orchestrate::Application::Result
• #retval — Orchestrate::Rails::Model
• #save — Orchestrate::Application::SimpleCacheRefs
• #save — Orchestrate::Rails::Model
• #save — Orchestrate::Application::SimpleCacheCollection
• #save — Orchestrate::Application::Document
• #save — Orchestrate::Application::SimpleCacheStore
• #save! — Orchestrate::Rails::Model
• #save_event — Orchestrate::Application::SimpleCacheRequest
• #save_event — Orchestrate::Application::SimpleCacheCollection
• #save_event — Orchestrate::Rails::Model
• #save_graph — Orchestrate::Application::SimpleCacheRequest
• #save_graph — Orchestrate::Rails::Model
• #save_graph — Orchestrate::Application::SimpleCacheCollection
• #save_if_match — Orchestrate::Rails::Model
• #save_if_none_match — Orchestrate::Rails::Model
• #schema — Orchestrate::Application::Schema
• #search — Orchestrate::API::Procedural
• #send_request — Orchestrate::API::Wrapper
• #set_ref_value — Orchestrate::Application::Record
• #simple_cache — Orchestrate::Application::Record
• #simple_cache_init — Orchestrate::Application::SimpleCacheStore
• #success? — Orchestrate::Application::Result
• #success? — Orchestrate::Application::SimpleCacheResponse
• #success? — Orchestrate::API::Response
• #to_event — Orchestrate::Application::Document
• #to_json_direct — Orchestrate::Rails::Model
• #to_orchio_rails_attr — Symbol
• #to_orchio_rails_attr — String
• #to_rails — Orchestrate::Application::Document
• #update_attribute — Orchestrate::Rails::Model
• #update_attributes — Orchestrate::Rails::Model
• #update_rails — Orchestrate::Application::Document
• #verbose? — Orchestrate::API::Request