Datasets:

---

CM

/

codexglue_code2text_ruby

like 1

[ "def", "inverse", "check_operable", "dims", "=", "dimension_uop", "{", "|", "a", "|", "-", "a", "}", "Unit", ".", "new", "(", "Rational", "(", "1", ",", "self", ".", "factor", ")", ",", "dims", ")", "end" ]

[ "Inverse", "of", "units", ".", "This", "unit", "must", "be", "operable", "." ]

[ "def", "**", "(", "x", ")", "check_operable", "m", "=", "Utils", ".", "as_numeric", "(", "x", ")", "dims", "=", "dimension_uop", "{", "|", "a", "|", "a", "m", "}", "Unit", ".", "new", "(", "@factor", "**", "m", ",", "dims", ")", "end" ]

[ "Exponentiation", "of", "units", ".", "This", "units", "must", "be", "operable", "." ]

[ "def", "products", "(", "page", ":", "-", "1", ")", "Product", ".", "from_website_page", "(", "url", ",", "page", ":", "page", ",", "products_count", ":", "products_count", ")", "if", "url", "end" ]

[ "Get", "products", "with", "country" ]

[ "def", "send_receipt", "(", "payment", ")", "@payment", "=", "payment", "@payment_url", "=", "public_receipt_payment_url", "(", ":payment_id", "=>", "@payment", ".", "id", ",", ":public_token", "=>", "@payment", ".", "public_token", ")", "mail", "(", ":to", "=>", "\"#{@payment.customer.email}\"", ",", ":from", "=>", "Jackpot", ".", "configuration", ".", "mailer", "[", ":from", "]", ",", ":subject", "=>", "\"Payment receipt\"", ")", "end" ]

[ "Sends", "the", "receipt", "to", "the", "customer", "who", "made", "this", "payment" ]

[ "def", "text", "if", "handler", "=", "find_handler", "and", "text", "=", "handler", ".", "text", "(", "@file", ",", "max_size", ":", "max_plaintext_bytes", ")", "text", ".", "gsub!", "(", "/", "\\s", "/m", ",", "' '", ")", "text", ".", "strip!", "text", ".", "mb_chars", ".", "compose", ".", "limit", "(", "max_plaintext_bytes", ")", ".", "to_s", "end", "end" ]

[ "Returns", "the", "extracted", "fulltext", "or", "nil", "if", "no", "matching", "handler", "was", "found", "for", "the", "file", "type", "." ]

[ "def", "explore", "paths", "=", "if", "Config", ".", "explore_role_files?", "possible_paths", "else", "[", "get_path", "]", "end", "paths", ".", "find", "{", "|", "path", "|", "File", ".", "readable?", "(", "path", ")", "}", "||", "paths", ".", "last", "end" ]

[ "Returns", "readable", "role", "file", "exploring", "possible", "role", "files", ".", "For", "example", "if", "role", "is", "myapp", "-", "web", "-", "staging", "this", "method", "explores", "files", "as" ]

[ "def", "djatoka_init_openlayers", "(", "rft_id", ",", "div_identifier", ",", "params", "=", "{", "}", ")", "resolver", "=", "determine_resolver", "(", "params", ")", "metadata_url", "=", "resolver", ".", "metadata_url", "(", "rft_id", ")", "%Q|<script type=\"text/javascript\">\n jQuery(document).ready(function() {openlayersInit('#{resolver.scheme}://#{resolver.host}',\n '#{metadata_url}',\n '#{rft_id}', '#{div_identifier}');\n });\n </script>\n |", "end" ]

[ "View", "helper", "to", "include", "a", "bit", "of", "jQuery", "on", "the", "page", "which", "waits", "for", "document", "load", "and", "then", "initializes", "the", "Ajax", "OpenLayers", "viewer", ".", "Since", "this", "works", "via", "Ajax", "Djatoka", "will", "need", "to", "be", "running", "or", "proxied", "at", "the", "same", "domain", "as", "the", "application", "to", "avoid", "cross", "-", "domain", "restrictions", "." ]

[ "def", "localized_resources", "(", "type", "=", ":resources", ",", "*", "resources", ",", "&", "block", ")", "localizable_route", "=", "nil", "if", "@locales", "res", "=", "resources", ".", "clone", "options", "=", "res", ".", "extract_options!", "r", "=", "res", ".", "first", "resource", "=", "resource_from_params", "(", "type", ",", "r", ",", "options", ".", "dup", ")", "# Check for translated resource", "stored_locale", "=", "I18n", ".", "locale", "@locales", ".", "each", "do", "|", "locale", "|", "I18n", ".", "locale", "=", "locale", "localized_path", "=", "I18nRouting", ".", "translation_for", "(", "resource", ".", "name", ",", "type", ")", "# A translated route exists :", "if", "!", "localized_path", ".", "blank?", "and", "String", "===", "localized_path", "puts", "(", "\"[I18n] > localize %-10s: %40s (%s) => /%s\"", "%", "[", "type", ",", "resource", ".", "name", ",", "locale", ",", "localized_path", "]", ")", "if", "@i18n_verbose", "opts", "=", "options", ".", "dup", "opts", "[", ":path", "]", "=", "localized_path", "opts", "[", ":controller", "]", "||=", "r", ".", "to_s", ".", "pluralize", "resource", "=", "resource_from_params", "(", "type", ",", "r", ",", "opts", ".", "dup", ")", "res", "=", "[", "\"#{I18nRouting.locale_escaped(locale)}_#{r}\"", ".", "to_sym", ",", "opts", "]", "constraints", "=", "opts", "[", ":constraints", "]", "?", "opts", "[", ":constraints", "]", ".", "dup", ":", "{", "}", "constraints", "[", ":i18n_locale", "]", "=", "locale", ".", "to_s", "scope", "(", ":constraints", "=>", "constraints", ",", ":path_names", "=>", "I18nRouting", ".", "path_names", "(", "resource", ".", "name", ",", "@scope", ")", ")", "do", "localized_branch", "(", "locale", ")", "do", "send", "(", "type", ",", "res", ")", "do", "# In the resource(s) block, we need to keep and restore some context :", "if", "block", "old_name", "=", "@scope", "[", ":i18n_real_resource_name", "]", "old", "=", "@scope", "[", ":scope_level_resource", "]", "@scope", "[", ":i18n_real_resource_name", "]", "=", "resource", ".", "name", "@scope", "[", ":i18n_scope_level_resource", "]", "=", "old", "@scope", "[", ":scope_level_resource", "]", "=", "resource", "if", "type", "==", ":resource", "and", "@scope", "[", ":name_prefix", "]", "# Need to fake name_prefix for singleton resource", "@scope", "[", ":name_prefix", "]", "=", "@scope", "[", ":name_prefix", "]", ".", "gsub", "(", "Regexp", ".", "new", "(", "\"#{old.name}$\"", ")", ",", "resource", ".", "name", ")", "end", "block", ".", "call", "if", "block", "@scope", "[", ":scope_level_resource", "]", "=", "old", "@scope", "[", ":i18n_real_resource_name", "]", "=", "old_name", "end", "@scope", "[", ":i18n_scope_level_resource", "]", "=", "nil", "end", "end", "end", "localizable_route", "=", "resource", "end", "end", "I18n", ".", "locale", "=", "stored_locale", "end", "return", "localizable_route", "end" ]

[ "Localize", "a", "resources", "or", "a", "resource" ]

[ "def", "initialize_with_i18n_routing", "(", "app", ",", "conditions", ",", "defaults", ",", "name", ")", "@locale", "=", "if", "conditions", ".", "key?", "(", ":i18n_locale", ")", "c", "=", "conditions", ".", "delete", "(", ":i18n_locale", ")", "# In rails 3.0 it's a regexp otherwise it's a string, so we need to call source on the regexp", "(", "c", ".", "respond_to?", "(", ":source", ")", "?", "c", ".", "source", ":", "c", ")", ".", "to_sym", "else", "nil", "end", "initialize_without_i18n_routing", "(", "app", ",", "conditions", ",", "defaults", ",", "name", ")", "end" ]

[ "During", "route", "initialization", "if", "a", "condition", "i18n_locale", "is", "present", "Delete", "it", "and", "store", "it", "in" ]

[ "def", "generate_with_i18n_routing", "(", "method", ",", "params", "=", "{", "}", ",", "recall", "=", "{", "}", ",", "options", "=", "{", "}", ")", "return", "nil", "if", "@locale", "and", "@locale", "!=", "I18n", ".", "locale", ".", "to_sym", "generate_without_i18n_routing", "(", "method", ",", "params", ",", "recall", ",", "options", ")", "end" ]

[ "Called", "for", "dynamic", "route", "generation", "If", "a" ]

[ "def", "pending", "(", "hours", "=", "24", ")", "cutoff", "=", "Time", ".", "now", ".", "to_i", "+", "hours", "*", "3600", "windows_in_state", "(", ":pending", ")", ".", "tap", "do", "|", "r", "|", "r", ".", "response", ".", "items", ".", "delete_if", "{", "|", "w", "|", "w", ".", "startTimeInSeconds", ">", "cutoff", "}", "end", "end" ]

[ "Get", "the", "windows", "which", "will", "be", "open", "in", "the", "next", "so", "-", "many", "hours" ]

[ "def", "constraint_equal?", "(", "region", ",", "constraint", ")", "[", "region", ",", "constraint", "]", ".", "collect", "{", "|", "v", "|", "v", ".", "nil?", "||", "v", "==", "''", "?", "'us-east-1'", ":", "v", "}", ".", "reduce", "(", ":==", ")", "end" ]

[ "US", "default", "constraint", "is", "often", "represented", "as", "or", "nil" ]

[ "def", "check_sub_type_without", "(", "val", ",", "delim", ")", "return", "false", "unless", "val", "=~", "delim", "new_val", "=", "val", ".", "gsub", "(", "delim", ",", "\"\"", ")", ".", "strip", "NodeCache", ".", "find", "(", "attributes", "[", "\"type\"", "]", ")", "==", "new_valu", "end" ]

[ "For", "types", "like", "pointers", "or", "references", "we", "recursively", "track", "down", "the", "base", "type", "when", "doing", "comparisons", "." ]

[ "def", "to_s", "text", "=", "''", "text", "<<", "tag_output_string", "+", "\"\\n\"", "unless", "tags", ".", "empty?", "text", "<<", "\"Feature:#{name_output_string}\"", "text", "<<", "\"\\n\"", "+", "description_output_string", "unless", "description_text", ".", "empty?", "text", "<<", "\"\\n\\n\"", "+", "background_output_string", "if", "background", "text", "<<", "\"\\n\\n\"", "+", "tests_output_string", "unless", "tests", ".", "empty?", "text", "end" ]

[ "Returns", "gherkin", "representation", "of", "the", "feature", "." ]

[ "def", "get_images", "(", "params", "=", "{", "}", ")", "@log", ".", "trace", "\"Listing images with params = #{params.to_json}...\"", "data", "=", "JSON", ".", "parse", "(", "RestClient", ".", "get", "(", "\"#{url}/v1/images\"", ",", ":params", "=>", "params", ")", ")", "[", "'images'", "]", "@log", ".", "trace", "\"Listing done.\"", "data", "end" ]

[ "Retrieves", "a", "list", "of", "public", "images", "with", "specified", "filter", ".", "If", "no", "filter", "is", "specified", "-", "all", "images", "are", "returned", "." ]

[ "def", "versions", "(", "id", ")", "wf_alert_id?", "(", "id", ")", "resp", "=", "api", ".", "get", "(", "[", "id", ",", "'history'", "]", ".", "uri_concat", ")", "versions", "=", "resp", ".", "response", ".", "items", ".", "map", "(", ":version", ")", "resp", ".", "response", "[", ":items", "]", "=", "versions", "resp", "end" ]

[ "Gets", "all", "the", "versions", "of", "the", "given", "alert" ]

[ "def", "define_enum_t_methods", "defined_enums", ".", "each", "do", "|", "enum_attr", ",", "values", "|", "self", ".", "class", ".", "send", "(", ":define_method", ",", "\"#{enum_attr}_t\"", ")", "{", "t_enum", "(", "enum_attr", ")", "}", "self", ".", "class", ".", "send", "(", ":define_method", ",", "\"#{enum_attr.pluralize}_t\"", ")", "do", "t_enum_values", "(", "enum_attr", ",", "values", ")", "end", "end", "end" ]

[ "enum", "attrubute_t", "and", "attributes_t", "return", "translated", "enum", "values" ]

[ "def", "parse_time", "(", "time", ",", "in_ms", "=", "false", ")", "return", "relative_time", "(", "time", ",", "in_ms", ")", "if", "time", "=~", "/", "\\-", "/", "ParseTime", ".", "new", "(", "time", ",", "in_ms", ")", ".", "parse!", "end" ]

[ "Return", "a", "time", "as", "an", "integer", "however", "it", "might", "come", "in", "." ]

[ "def", "relative_time", "(", "time", ",", "in_ms", "=", "false", ",", "ref", "=", "Time", ".", "now", ")", "ref", "=", "in_ms", "?", "ref", ".", "to_datetime", ".", "strftime", "(", "'%Q'", ")", ":", "ref", ".", "to_time", "ref", ".", "to_i", "+", "parse_relative_time", "(", "time", ",", "in_ms", ")", "end" ]

[ "Return", "a", "timestamp", "described", "by", "the", "given", "string", ".", "That", "is", "+", "5m", "is", "five", "minutes", "in", "the", "future", "and", "-", ".", "1h", "is", "half", "an", "hour", "ago", "." ]

[ "def", "time_multiplier", "(", "suffix", ")", "u", "=", "{", "s", ":", "1", ",", "m", ":", "60", ",", "h", ":", "3600", ",", "d", ":", "86_400", ",", "w", ":", "604_800", ",", "y", ":", "31_536_000", "}", "return", "u", "[", "suffix", ".", "to_sym", "]", "if", "u", ".", "key?", "(", "suffix", ".", "to_sym", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidTimeUnit", "end" ]

[ "naively", "return", "the", "number", "of", "seconds", "from", "the", "given", "multiplier", ".", "This", "makes", "absolutely", "no", "attempt", "to", "compensate", "for", "any", "kind", "of", "daylight", "savings", "or", "calendar", "adjustment", ".", "A", "day", "is", "always", "going", "to", "60", "seconds", "x", "60", "minutes", "x", "24", "hours", "and", "a", "year", "will", "always", "have", "365", "days", "." ]

[ "def", "create_agreement", "(", "agreement", ")", "agreement_response", "=", "Echochamber", "::", "Request", ".", "create_agreement", "(", "agreement", ",", "token", ",", "agreement", ".", "user_id", ",", "agreement", ".", "user_email", ")", "agreement_response", ".", "fetch", "(", "\"agreementId\"", ")", "end" ]

[ "Creates", "an", "agreement" ]

[ "def", "agreement_documents", "(", "agreement_id", ",", "recipient_email", ",", "format", ",", "version_id", "=", "nil", ")", "result", "=", "Echochamber", "::", "Request", ".", "agreement_documents", "(", "token", ",", "agreement_id", ",", "recipient_email", ",", "format", ",", "version_id", ")", "end" ]

[ "All", "documents", "relating", "to", "an", "agreement" ]

[ "def", "agreement_document_file", "(", "agreement_id", ",", "document_id", ",", "file_path", "=", "nil", ")", "response", "=", "Echochamber", "::", "Request", ".", "agreement_document_file", "(", "token", ",", "agreement_id", ",", "document_id", ")", "unless", "file_path", ".", "nil?", "file", "=", "File", ".", "new", "(", "file_path", ",", "'wb'", ")", "file", ".", "write", "(", "response", ")", "file", ".", "close", "end", "response", "end" ]

[ "Retrieve", "a", "document", "file", "from", "an", "agreement" ]

[ "def", "agreement_combined_pdf", "(", "agreement_id", ",", "file_path", "=", "nil", ",", "versionId", "=", "nil", ",", "participantEmail", "=", "nil", ",", "attachSupportingDocuments", "=", "true", ",", "auditReport", "=", "false", ")", "response", "=", "Echochamber", "::", "Request", ".", "agreement_combined_pdf", "(", "token", ",", "agreement_id", ",", "versionId", ",", "participantEmail", ",", "attachSupportingDocuments", ",", "auditReport", ")", "unless", "file_path", ".", "nil?", "file", "=", "File", ".", "new", "(", "file_path", ",", "'wb'", ")", "file", ".", "write", "(", "response", ")", "file", ".", "close", "end", "response", "end" ]

[ "Gets", "a", "single", "combined", "PDF", "document", "for", "the", "documents", "associated", "with", "an", "agreement", "." ]

[ "def", "wf_link_template?", "(", "template", ")", "if", "template", ".", "is_a?", "(", "String", ")", "&&", "template", ".", "start_with?", "(", "'http://'", ",", "'https://'", ")", "return", "true", "end", "raise", "Wavefront", "::", "Exception", "::", "InvalidLinkTemplate", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "external", "link", "template" ]

[ "def", "wf_name?", "(", "name", ")", "return", "true", "if", "name", ".", "is_a?", "(", "String", ")", "&&", "name", ".", "size", "<", "1024", "&&", "name", "=~", "/", "\\w", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidName", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "name", "for", "instance", "for", "an", "event", ".", "Names", "can", "contain", "AFAIK", "word", "characters", "." ]

[ "def", "wf_string?", "(", "str", ")", "#", "# Only allows PCRE \"word\" characters, spaces, full-stops and", "# commas in tags and descriptions. This might be too restrictive,", "# but if it is, this is the only place we need to change it.", "#", "if", "str", ".", "is_a?", "(", "String", ")", "&&", "str", ".", "size", "<", "1024", "&&", "str", "=~", "/", "\\-", "\\w", "\\.", "/", "return", "true", "end", "raise", "Wavefront", "::", "Exception", "::", "InvalidString", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "string", "for", "a", "tag", "name", "." ]

[ "def", "wf_ts?", "(", "timestamp", ")", "return", "true", "if", "timestamp", ".", "is_a?", "(", "Time", ")", "||", "timestamp", ".", "is_a?", "(", "Date", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidTimestamp", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "timestamp" ]

[ "def", "wf_epoch?", "(", "timestamp", ")", "return", "true", "if", "timestamp", ".", "is_a?", "(", "Numeric", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidTimestamp", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "epoch", "timestamp", ".", "Again", "no", "range", "checking", "." ]

[ "def", "wf_value?", "(", "value", ")", "return", "true", "if", "value", ".", "is_a?", "(", "Numeric", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidMetricValue", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "Wavefront", "value", ".", "Can", "be", "any", "form", "of", "Numeric", "including", "standard", "notation", "." ]

[ "def", "wf_version?", "(", "version", ")", "version", "=", "version", ".", "to_i", "if", "version", ".", "is_a?", "(", "String", ")", "&&", "version", "=~", "/", "\\d", "/", "return", "true", "if", "version", ".", "is_a?", "(", "Integer", ")", "&&", "version", ".", "positive?", "raise", "Wavefront", "::", "Exception", "::", "InvalidVersion", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "version", "number" ]

[ "def", "wf_alert_id?", "(", "id", ")", "id", "=", "id", ".", "to_s", "if", "id", ".", "is_a?", "(", "Numeric", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", ".", "match", "(", "/", "\\d", "/", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidAlertId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "Wavefront", "alert", "ID", ".", "Alerts", "are", "identified", "by", "the", "epoch", "-", "nanosecond", "at", "which", "they", "were", "created", "." ]

[ "def", "wf_dashboard_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", ".", "size", "<", "256", "&&", "id", ".", "match", "(", "/", "\\w", "\\-", "/", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidDashboardId", "end" ]

[ "There", "doesn", "t", "seem", "to", "be", "a", "public", "statement", "on", "what", "s", "allowed", "in", "a", "dashboard", "name", ".", "For", "now", "I", "m", "going", "to", "assume", "up", "to", "255", "word", "characters", "." ]

[ "def", "wf_derivedmetric_id?", "(", "id", ")", "id", "=", "id", ".", "to_s", "if", "id", ".", "is_a?", "(", "Numeric", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\d", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidDerivedMetricId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "derived", "metric", "ID", ".", "IDs", "are", "the", "millisecond", "epoch", "timestamp", "at", "which", "the", "derived", "metric", "was", "created", "." ]

[ "def", "wf_link_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\w", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidExternalLinkId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "external", "Link", "ID" ]

[ "def", "wf_maintenance_window_id?", "(", "id", ")", "id", "=", "id", ".", "to_s", "if", "id", ".", "is_a?", "(", "Numeric", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\d", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidMaintenanceWindowId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "maintenance", "window", "ID", ".", "IDs", "are", "the", "millisecond", "epoch", "timestamp", "at", "which", "the", "window", "was", "created", "." ]

[ "def", "wf_alert_severity?", "(", "severity", ")", "return", "true", "if", "%w[", "INFO", "SMOKE", "WARN", "SEVERE", "]", ".", "include?", "(", "severity", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidAlertSeverity", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "alert", "severity" ]

[ "def", "wf_message_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\w", "\\w", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidMessageId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "message", "ID" ]

[ "def", "wf_granularity?", "(", "granularity", ")", "return", "true", "if", "%w[", "d", "h", "m", "s", "]", ".", "include?", "(", "granularity", ".", "to_s", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidGranularity", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "query", "granularity" ]

[ "def", "wf_savedsearch_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\w", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidSavedSearchId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "saved", "search", "ID", "." ]

[ "def", "wf_savedsearch_entity?", "(", "id", ")", "return", "true", "if", "%w[", "DASHBOARD", "ALERT", "MAINTENANCE_WINDOW", "NOTIFICANT", "EVENT", "SOURCE", "EXTERNAL_LINK", "AGENT", "CLOUD_INTEGRATION", "]", ".", "include?", "(", "id", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidSavedSearchEntity", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "saved", "search", "entity", "type", "." ]

[ "def", "wf_source_id?", "(", "source", ")", "if", "source", ".", "is_a?", "(", "String", ")", "&&", "source", ".", "match", "(", "/", "\\w", "\\.", "\\-", "/", ")", "&&", "source", ".", "size", "<", "1024", "return", "true", "end", "raise", "Wavefront", "::", "Exception", "::", "InvalidSourceId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "Wavefront", "source", "name" ]

[ "def", "wf_user_id?", "(", "user", ")", "return", "true", "if", "user", ".", "is_a?", "(", "String", ")", "&&", "user", ".", "length", "<", "256", "&&", "!", "user", ".", "empty?", "raise", "Wavefront", "::", "Exception", "::", "InvalidUserId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "user", "." ]

[ "def", "wf_webhook_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidWebhookId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "webhook", "ID", "." ]

[ "def", "wf_distribution?", "(", "dist", ")", "wf_metric_name?", "(", "dist", "[", ":path", "]", ")", "wf_distribution_values?", "(", "dist", "[", ":value", "]", ")", "wf_epoch?", "(", "dist", "[", ":ts", "]", ")", "if", "dist", "[", ":ts", "]", "wf_source_id?", "(", "dist", "[", ":source", "]", ")", "if", "dist", "[", ":source", "]", "wf_point_tags?", "(", "dist", "[", ":tags", "]", ")", "if", "dist", "[", ":tags", "]", "true", "end" ]

[ "Validate", "a", "distribution", "description" ]

[ "def", "wf_distribution_values?", "(", "vals", ")", "vals", ".", "each", "do", "|", "times", ",", "val", "|", "wf_distribution_count?", "(", "times", ")", "wf_value?", "(", "val", ")", "end", "true", "end" ]

[ "Validate", "an", "array", "of", "distribution", "values" ]

[ "def", "wf_notificant_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "\\w", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidNotificantId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "Wavefront", "notificant", "ID", "." ]

[ "def", "wf_integration_id?", "(", "id", ")", "return", "true", "if", "id", ".", "is_a?", "(", "String", ")", "&&", "id", "=~", "/", "/", "raise", "Wavefront", "::", "Exception", "::", "InvalidIntegrationId", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "Wavefront", "integration", "ID", ".", "These", "appear", "to", "be", "lower", "-", "case", "strings", "." ]

[ "def", "wf_distribution_interval?", "(", "interval", ")", "return", "true", "if", "%i[", "m", "h", "d", "]", ".", "include?", "(", "interval", ")", "raise", "Wavefront", "::", "Exception", "::", "InvalidDistributionInterval", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "distribution", "interval", "." ]

[ "def", "wf_distribution_count?", "(", "count", ")", "return", "true", "if", "count", ".", "is_a?", "(", "Integer", ")", "&&", "count", ".", "positive?", "raise", "Wavefront", "::", "Exception", "::", "InvalidDistributionCount", "end" ]

[ "Ensure", "the", "given", "argument", "is", "a", "valid", "distribution", "count", "." ]

[ "def", "response_shim", "(", "body", ",", "status", ")", "resp", ",", "err_msg", "=", "parsed_response", "(", "body", ")", "{", "response", ":", "resp", ",", "status", ":", "{", "result", ":", "status", "==", "200", "?", "'OK'", ":", "'ERROR'", ",", "message", ":", "err_msg", ",", "code", ":", "status", "}", "}", ".", "to_json", "end" ]

[ "Fake", "a", "response", "which", "looks", "like", "we", "get", "from", "all", "the", "other", "paths", ".", "The", "default", "response", "is", "a", "single", "array", "." ]

[ "def", "parsed_response", "(", "body", ")", "[", "JSON", ".", "parse", "(", "body", ")", ",", "''", "]", "rescue", "JSON", "::", "ParserError", "[", "''", ",", "body", ".", "match", "(", "/", "/", ")", ".", "captures", ".", "first", "]", "end" ]

[ "A", "bad", "query", "doesn", "t", "send", "back", "a", "JSON", "object", ".", "It", "sends", "back", "a", "string", "with", "an", "embedded", "message", "." ]

[ "def", "populate", "(", "raw", ")", "@config", "=", "Map", "(", "raw", ")", "@creds", "=", "Map", "(", "raw", ".", "select", "{", "|", "k", ",", "_v", "|", "%i[", "endpoint", "token", "]", ".", "include?", "(", "k", ")", "}", ")", "@proxy", "=", "Map", "(", "raw", ".", "select", "{", "|", "k", ",", "_v", "|", "%i[", "proxy", "port", "]", ".", "include?", "(", "k", ")", "}", ")", "@all", "=", "Map", "(", "raw", ".", "select", "do", "|", "k", ",", "_v", "|", "%i[", "proxy", "port", "endpoint", "token", "]", ".", "include?", "(", "k", ")", "end", ")", "end" ]

[ "Make", "the", "helper", "values", ".", "We", "use", "a", "Map", "so", "they", "re", "super", "-", "easy", "to", "access" ]

[ "def", "log_hack", "read_stderr", ",", "write_stderr", "=", "IO", ".", "pipe", "fork", "do", "write_stderr", ".", "close", "read_stderr", ".", "each", "do", "|", "l", "|", "@log", ".", "trace", "\"GFS: #{l.chomp.strip}\"", "end", "read_stderr", ".", "close", "end", "old_stderr", "=", "STDERR", ".", "clone", "STDERR", ".", "reopen", "(", "write_stderr", ")", "STDERR", ".", "sync", "=", "true", "begin", "# Execute all tasks", "yield", "if", "block_given?", "ensure", "STDERR", ".", "reopen", "(", "old_stderr", ")", "end", "write_stderr", ".", "close", "read_stderr", ".", "close", "Process", ".", "wait", "end" ]

[ "If", "log", "callback", "aren", "t", "available", "we", "will", "fail", "to", "this", "which", "sucks", "..." ]

[ "def", "mount_partitions", "(", "device", ",", "mount_prefix", "=", "''", ")", "@log", ".", "trace", "\"Mounting partitions...\"", "partitions", "=", "mountable_partitions", "(", "device", ")", "mount_points", "=", "LinuxHelper", ".", "new", "(", ":log", "=>", "@log", ")", ".", "partition_mount_points", "(", "@appliance_config", ".", "hardware", ".", "partitions", ")", "# https://issues.jboss.org/browse/BGBUILD-307", "# We don't want to mount swap partitions at all...", "mount_points", ".", "delete", "(", "\"swap\"", ")", "partitions", ".", "each_index", "{", "|", "i", "|", "mount_partition", "(", "partitions", "[", "i", "]", ",", "mount_points", "[", "i", "]", ",", "mount_prefix", ")", "}", "end" ]

[ "This", "mount", "partitions", ".", "We", "assume", "that", "the", "first", "partition", "is", "a", "root", "partition", "." ]

[ "def", "umount_partitions", "(", "device", ")", "partitions", "=", "mountable_partitions", "(", "device", ")", "@log", ".", "trace", "\"Unmounting partitions...\"", "partitions", ".", "reverse", ".", "each", "{", "|", "part", "|", "umount_partition", "(", "part", ")", "}", "@log", ".", "trace", "\"All partitions unmounted.\"", "end" ]

[ "Unmounts", "partitions", "in", "reverse", "order", "." ]

[ "def", "body", "(", "query", ",", "options", ")", "ret", "=", "{", "limit", ":", "options", "[", ":limit", "]", "||", "10", ",", "offset", ":", "options", "[", ":offset", "]", "||", "0", "}", "if", "query", "&&", "!", "query", ".", "empty?", "ret", "[", ":query", "]", "=", "[", "query", "]", ".", "flatten", ".", "map", "do", "|", "q", "|", "q", ".", "tap", "{", "|", "iq", "|", "iq", "[", ":matchingMethod", "]", "||=", "'CONTAINS'", "}", "end", "ret", "[", ":sort", "]", "=", "sort_field", "(", "options", ",", "query", ")", "end", "ret", "end" ]

[ "Build", "a", "query", "body" ]

[ "def", "create_server", "@log", ".", "info", "\"Creating new server...\"", "memory", "=", "(", "(", "is_cloudsigma?", "and", "@appliance_config", ".", "hardware", ".", "memory", "<", "512", ")", "?", "512", ":", "@appliance_config", ".", "hardware", ".", "memory", ")", "body", "=", "hash_to_request", "(", "'name'", "=>", "\"#{@appliance_config.name}-#{@appliance_config.version}.#{@appliance_config.release}\"", ",", "'cpu'", "=>", "@appliance_config", ".", "hardware", ".", "cpus", "*", "1000", ",", "# MHz", "'smp'", "=>", "'auto'", ",", "'mem'", "=>", "memory", ",", "'persistent'", "=>", "'true'", ",", "# hack", "'ide:0:0'", "=>", "@plugin_config", "[", "'drive_uuid'", "]", ",", "'boot'", "=>", "'ide:0:0'", ",", "'nic:0:model'", "=>", "'e1000'", ",", "'nic:0:dhcp'", "=>", "'auto'", ",", "'vnc:ip'", "=>", "'auto'", ",", "'vnc:password'", "=>", "(", "0", "...", "8", ")", ".", "map", "{", "(", "(", "'a'", "..", "'z'", ")", ".", "to_a", "+", "(", "'A'", "..", "'Z'", ")", ".", "to_a", ")", "[", "rand", "(", "52", ")", "]", "}", ".", "join", "# 8 character VNC password", ")", "begin", "path", "=", "is_cloudsigma?", "?", "'/servers/create'", ":", "'/servers/create/stopped'", "ret", "=", "response_to_hash", "(", "RestClient", ".", "post", "(", "api_url", "(", "path", ")", ",", "body", ")", ")", "@log", ".", "info", "\"Server was registered with '#{ret['name']}' name as '#{ret['server']}' UUID. Use web UI or API tools to start your server.\"", "rescue", "=>", "e", "@log", ".", "error", "e", ".", "info", "raise", "PluginError", ",", "\"An error occurred while creating the server, #{e.message}. See logs for more info.\"", "end", "end" ]

[ "Creates", "the", "server", "for", "previously", "uploaded", "disk" ]

[ "def", "initialize_plugins", "@plugin_chain", "=", "[", "]", "os_plugin", ",", "os_plugin_info", "=", "PluginManager", ".", "instance", ".", "initialize_plugin", "(", ":os", ",", "@appliance_config", ".", "os", ".", "name", ".", "to_sym", ")", "initialize_plugin", "(", "os_plugin", ",", "os_plugin_info", ")", "if", "platform_selected?", "platform_plugin", ",", "platform_plugin_info", "=", "PluginManager", ".", "instance", ".", "initialize_plugin", "(", ":platform", ",", "@config", ".", "platform", ")", "initialize_plugin", "(", "platform_plugin", ",", "platform_plugin_info", ")", "end", "if", "delivery_selected?", "delivery_plugin", ",", "delivery_plugin_info", "=", "PluginManager", ".", "instance", ".", "initialize_plugin", "(", ":delivery", ",", "@config", ".", "delivery", ")", "# Here we need to specify additionally the type of the plugin, as some delivery plugins", "# can have multiple types of delivery implemented. See s3-plugin.rb for example.", "initialize_plugin", "(", "delivery_plugin", ",", "delivery_plugin_info", ",", ":type", "=>", "@config", ".", "delivery", ")", "end", "end" ]

[ "Here", "we", "initialize", "all", "required", "plugins", "and", "create", "a", "plugin", "chain", ".", "Initialization", "involves", "also", "plugin", "configuration", "validation", "for", "specified", "plugin", "type", "." ]

[ "def", "initialize_plugin", "(", "plugin", ",", "plugin_info", ",", "options", "=", "{", "}", ")", "options", "=", "{", ":log", "=>", "@log", "}", ".", "merge", "(", "options", ")", "unless", "@plugin_chain", ".", "empty?", "options", ".", "merge!", "(", ":previous_plugin", "=>", "@plugin_chain", ".", "last", "[", ":plugin", "]", ")", "end", "plugin", ".", "init", "(", "@config", ",", "@appliance_config", ",", "plugin_info", ",", "options", ")", "# Execute callbacks if implemented", "#", "# Order is very important", "[", ":after_init", ",", ":validate", ",", ":after_validate", "]", ".", "each", "do", "|", "callback", "|", "plugin", ".", "send", "(", "callback", ")", "if", "plugin", ".", "respond_to?", "(", "callback", ")", "end", "param", "=", "nil", "# For operating system plugins we need to inject appliance definition.", "if", "plugin_info", "[", ":type", "]", "==", ":os", "param", "=", "@appliance_definition", "end", "@plugin_chain", "<<", "{", ":plugin", "=>", "plugin", ",", ":param", "=>", "param", "}", "end" ]

[ "Initializes", "the", "plugin", "by", "executing", "init", "after_init", "validate", "and", "after_validate", "methods", "." ]

[ "def", "create", "@log", ".", "debug", "\"Launching new build...\"", "@log", ".", "trace", "\"Used configuration: #{@config.to_yaml.gsub(/(\\S*(key|account|cert|username|host|password)\\S*).*:(.*)/, '\\1' + \": <REDACTED>\")}\"", "# Let's load all plugins first", "PluginHelper", ".", "new", "(", "@config", ",", ":log", "=>", "@log", ")", ".", "load_plugins", "read_definition", "validate_definition", "initialize_plugins", "remove_old_builds", "if", "@config", ".", "force", "execute_plugin_chain", "self", "end" ]

[ "This", "creates", "the", "appliance", "by", "executing", "the", "plugin", "chain", "." ]

[ "def", "determine_capabilities", "(", "conn", ",", "previous_plugin_info", ")", "plugin", "=", "get_plugin", "(", "previous_plugin_info", ")", "root", "=", "Nokogiri", "::", "XML", ".", "parse", "(", "conn", ".", "capabilities", ")", "guests", "=", "root", ".", "xpath", "(", "\"//guest/arch[@name='x86_64']/..\"", ")", "guests", "=", "guests", ".", "sort", "do", "|", "a", ",", "b", "|", "dom_maps", "=", "[", "a", ",", "b", "]", ".", "map", "{", "|", "x", "|", "plugin", ".", "domain_map", "[", "xpath_first_intern", "(", "x", ",", "'.//domain/@type'", ")", "]", "}", "# Handle unknown mappings", "next", "resolve_unknowns", "(", "dom_maps", ")", "if", "dom_maps", ".", "include?", "(", "nil", ")", "# Compare according to domain ranking", "dom_rank", "=", "dom_maps", ".", "map", "{", "|", "m", "|", "m", "[", ":rank", "]", "}", ".", "reduce", "(", ":<=>", ")", "# Compare according to virtualisation ranking", "virt_rank", "=", "[", "a", ",", "b", "]", ".", "enum_for", "(", ":each_with_index", ")", ".", "map", "do", "|", "x", ",", "i", "|", "dom_maps", "[", "i", "]", "[", ":domain", "]", ".", "virt_map", "[", "xpath_first_intern", "(", "x", ",", "'.//os_type'", ")", "]", "end", "# Handle unknown mappings", "next", "resolve_unknowns", "(", "virt_rank", ")", "if", "virt_rank", ".", "include?", "(", "nil", ")", "# Domain rank first", "next", "dom_rank", "unless", "dom_rank", "==", "0", "# OS type rank second", "virt_rank", ".", "reduce", "(", ":<=>", ")", "end", "# Favourite!", "build_guest", "(", "guests", ".", "first", ")", "end" ]

[ "Connect", "to", "the", "remote", "machine", "and", "determine", "the", "best", "available", "settings" ]

[ "def", "get_plugin", "(", "previous_plugin_info", ")", "if", "previous_plugin_info", "[", ":type", "]", "==", ":platform", "if", "PLUGINS", ".", "has_key?", "(", "previous_plugin_info", "[", ":name", "]", ")", "@log", ".", "debug", "(", "\"Using #{previous_plugin_info[:name]} mapping\"", ")", "return", "PLUGINS", "[", "previous_plugin_info", "[", ":name", "]", "]", "else", "@log", ".", "debug", "(", "\"This plugin does not know what mappings to choose, so will assume default values where user values are not provided.\"", ")", "end", "end", "@log", ".", "debug", "(", "\"Using default domain mappings.\"", ")", "PLUGINS", "[", ":default", "]", "end" ]

[ "At", "present", "we", "don", "t", "have", "enough", "meta", "-", "data", "to", "work", "with", "to", "easily", "generalise", "so", "we", "have", "to", "assume", "defaults", "often", ".", "This", "is", "something", "to", "improve", "later", "." ]

[ "def", "pay_now", "order", "=", "current_order", "||", "raise", "(", "ActiveRecord", "::", "RecordNotFound", ")", "session", "[", ":order_number", "]", "=", "current_order", ".", "number", "invoice", "=", "order", ".", "place_bitpay_order", "notificationURL", ":", "bitpay_notification_url", "@invoice_iframe_url", "=", "\"#{invoice['url']}&view=iframe\"", "render", "json", ":", "@invoice_iframe_url", "end" ]

[ "Generates", "Bitpay", "Invoice", "and", "returns", "iframe", "view" ]

[ "def", "payment_sent", "order_number", "=", "session", "[", ":order_number", "]", "session", "[", ":order_number", "]", "=", "nil", "order", "=", "Spree", "::", "Order", ".", "find_by_number", "(", "order_number", ")", "||", "raise", "(", "ActiveRecord", "::", "RecordNotFound", ")", "redirect_to", "spree", ".", "order_path", "(", "order", ")", ",", ":notice", "=>", "Spree", ".", "t", "(", ":order_processed_successfully", ")", "end" ]

[ "Fires", "on", "receipt", "of", "payment", "received", "window", "message" ]

[ "def", "notification", "begin", "posData", "=", "JSON", ".", "parse", "(", "params", "[", "\"posData\"", "]", ")", "order_id", "=", "posData", "[", "\"orderID\"", "]", "payment_id", "=", "posData", "[", "\"paymentID\"", "]", "order", "=", "Spree", "::", "Order", ".", "find_by_number", "(", "order_id", ")", "||", "raise", "(", "ActiveRecord", "::", "RecordNotFound", ")", "begin", "order", ".", "process_bitpay_ipn", "payment_id", "head", ":ok", "rescue", "=>", "exception", "logger", ".", "debug", "exception", "head", ":uprocessable_entity", "end", "rescue", "=>", "error", "logger", ".", "error", "\"Spree_Bitpay: Unprocessable notification received from #{request.remote_ip}: #{params.inspect}\"", "head", ":unprocessable_entity", "end", "end" ]

[ "Handle", "IPN", "from", "Bitpay", "server", "Receives", "incoming", "IPN", "message", "and", "retrieves", "official", "BitPay", "invoice", "for", "processing" ]

[ "def", "refresh", "payment", "=", "Spree", "::", "Payment", ".", "find", "(", "params", "[", ":payment", "]", ")", "# Retrieve payment by ID", "old_state", "=", "payment", ".", "state", "payment", ".", "process_bitpay_ipn", "new_state", "=", "payment", ".", "reload", ".", "state", "notice", "=", "(", "new_state", "==", "old_state", ")", "?", "Spree", ".", "t", "(", ":bitpay_payment_not_updated", ")", ":", "(", "Spree", ".", "t", "(", ":bitpay_payment_updated", ")", "+", "new_state", ".", "titlecase", ")", "redirect_to", "(", "request", ".", "referrer", "||", "root_path", ")", ",", "notice", ":", "notice", "end" ]

[ "Reprocess", "Invoice", "and", "update", "order", "status" ]

[ "def", "add_ec2_user", "(", "guestfs", ")", "@log", ".", "debug", "\"Adding ec2-user user...\"", "# We need to add ec2-user only when it doesn't exists", "#", "# https://issues.jboss.org/browse/BGBUILD-313", "unless", "guestfs", ".", "fgrep", "(", "\"ec2-user\"", ",", "\"/etc/passwd\"", ")", ".", "empty?", "@log", ".", "debug", "(", "\"ec2-user already exists, skipping.\"", ")", "return", "end", "guestfs", ".", "sh", "(", "\"useradd ec2-user\"", ")", "guestfs", ".", "sh", "(", "\"echo -e 'ec2-user\\tALL=(ALL)\\tNOPASSWD: ALL' >> /etc/sudoers\"", ")", "@log", ".", "debug", "\"User ec2-user added.\"", "end" ]

[ "Adds", "ec2", "-", "user", "will", "full", "sudo", "access", "without", "password", "per", "Fedora", "security", "guidelines", ".", "We", "should", "not", "use", "root", "access", "on", "AMIs", "as", "it", "is", "not", "secure", "and", "prohibited", "by", "AWS", "." ]

[ "def", "step_text", "(", "options", "=", "{", "}", ")", "options", "=", "{", ":with_keywords", "=>", "true", ",", ":with_arguments", "=>", "true", ",", ":left_delimiter", "=>", "self", ".", "left_delimiter", ",", ":right_delimiter", "=>", "self", ".", "right_delimiter", "}", ".", "merge", "(", "options", ")", "final_step", "=", "[", "]", "step_text", "=", "''", "step_text", "+=", "\"#{@keyword} \"", "if", "options", "[", ":with_keywords", "]", "if", "options", "[", ":with_arguments", "]", "step_text", "+=", "@base", "final_step", "<<", "step_text", "final_step", ".", "concat", "(", "rebuild_block_text", "(", "@block", ")", ")", "if", "@block", "else", "step_text", "+=", "stripped_step", "(", "@base", ",", "options", "[", ":left_delimiter", "]", ",", "options", "[", ":right_delimiter", "]", ")", "final_step", "<<", "step_text", "end", "final_step", "end" ]

[ "Returns", "true", "if", "the", "two", "steps", "have", "the", "same", "text", "minus", "any", "keywords", "and", "arguments", "and", "false", "otherwise", ".", "Deprecated" ]

[ "def", "scan_arguments", "(", "*", "how", ")", "if", "how", ".", "count", "==", "1", "pattern", "=", "how", ".", "first", "else", "left_delimiter", "=", "how", "[", "0", "]", "||", "self", ".", "left_delimiter", "right_delimiter", "=", "how", "[", "1", "]", "||", "self", ".", "right_delimiter", "return", "[", "]", "unless", "left_delimiter", "&&", "right_delimiter", "pattern", "=", "Regexp", ".", "new", "(", "Regexp", ".", "escape", "(", "left_delimiter", ")", "+", "'(.*?)'", "+", "Regexp", ".", "escape", "(", "right_delimiter", ")", ")", "end", "@arguments", "=", "@base", ".", "scan", "(", "pattern", ")", ".", "flatten", "end" ]

[ "Populates", "the", "step", "s", "arguments", "based", "on", "the", "step", "s", "text", "and", "some", "method", "of", "determining", "which", "parts", "of", "the", "text", "are", "arguments", ".", "Methods", "include", "using", "a", "regular", "expression", "and", "using", "the", "step", "s", "delimiters", "." ]

[ "def", "stripped_step", "(", "step", ",", "left_delimiter", ",", "right_delimiter", ")", "unless", "left_delimiter", ".", "nil?", "||", "right_delimiter", ".", "nil?", "pattern", "=", "Regexp", ".", "new", "(", "Regexp", ".", "escape", "(", "left_delimiter", ")", "+", "'.*?'", "+", "Regexp", ".", "escape", "(", "right_delimiter", ")", ")", "step", "=", "step", ".", "gsub", "(", "pattern", ",", "left_delimiter", "+", "right_delimiter", ")", "end", "step", "end" ]

[ "Returns", "the", "step", "string", "minus", "any", "arguments", "based", "on", "the", "given", "delimiters", "." ]

[ "def", "substitute_vars", "(", "str", ")", "return", "if", "str", ".", "nil?", "@appliance_config", ".", "variables", ".", "keys", ".", "each", "do", "|", "var", "|", "str", "=", "str", ".", "gsub", "(", "\"##{var}#\"", ",", "@appliance_config", ".", "variables", "[", "var", "]", ")", "end", "str", "end" ]

[ "Substitute", "variables", "in", "selected", "string", "." ]

[ "def", "install_files", "(", "guestfs", ")", "@log", ".", "debug", "\"Installing files specified in appliance definition file...\"", "@appliance_config", ".", "files", ".", "each", "do", "|", "dir", ",", "files", "|", "@log", ".", "debug", "\"Proceding files for '#{dir}' destination directory...\"", "local_files", "=", "[", "]", "# Create the directory if it doesn't exists", "guestfs", ".", "mkdir_p", "(", "dir", ")", "unless", "guestfs", ".", "exists", "(", "dir", ")", "!=", "0", "files", ".", "each", "do", "|", "f", "|", "if", "f", ".", "match", "(", "/", "\\/", "\\/", "/", ")", "# Remote url provided", "@log", ".", "trace", "\"Remote url detected: '#{f}'.\"", "# We have a remote file, try to download it using curl!", "guestfs", ".", "sh", "(", "\"cd #{dir} && curl -O -L #{f}\"", ")", "else", "@log", ".", "trace", "\"Local path detected: '#{f}'.\"", "file_path", "=", "(", "f", ".", "match", "(", "/", "\\/", "/", ")", "?", "f", ":", "\"#{File.dirname(@appliance_definition_file)}/#{f}\"", ")", "# TODO validate this earlier", "raise", "ValidationError", ",", "\"File '#{f}' specified in files section of appliance definition file doesn't exists.\"", "unless", "File", ".", "exists?", "(", "file_path", ")", "local_files", "<<", "f", "end", "end", "next", "if", "local_files", ".", "empty?", "@log", ".", "trace", "\"Tarring files...\"", "@exec_helper", ".", "execute", "(", "\"cd #{File.dirname(@appliance_definition_file)} && tar -cvf /tmp/bg_install_files.tar --wildcards #{local_files.join(' ')}\"", ")", "@log", ".", "trace", "\"Files tarred.\"", "@log", ".", "trace", "\"Uploading and unpacking...\"", "guestfs", ".", "tar_in", "(", "\"/tmp/bg_install_files.tar\"", ",", "dir", ")", "@log", ".", "trace", "\"Files uploaded.\"", "end", "@log", ".", "debug", "\"Files installed.\"", "end" ]

[ "Copies", "specified", "files", "into", "appliance", "." ]

[ "def", "get_library_document_file", "(", "library_document_id", ",", "file_id", ",", "file_path", "=", "nil", ")", "response", "=", "Echochamber", "::", "Request", ".", "get_library_document_file", "(", "token", ",", "library_document_id", ",", "file_id", ")", "unless", "file_path", ".", "nil?", "file", "=", "File", ".", "new", "(", "file_path", ",", "'wb'", ")", "file", ".", "write", "(", "response", ")", "file", ".", "close", "end", "response", "end" ]

[ "Retrieves", "library", "document", "file", "data" ]

[ "def", "library_combined_document", "(", "library_document_id", ",", "file_path", "=", "nil", ",", "auditReport", "=", "false", ")", "response", "=", "Echochamber", "::", "Request", ".", "library_combined_document", "(", "token", ",", "library_document_id", ",", "auditReport", ")", "unless", "file_path", ".", "nil?", "file", "=", "File", ".", "new", "(", "file_path", ",", "'wb'", ")", "file", ".", "write", "(", "response", ")", "file", ".", "close", "end", "response", "end" ]

[ "Retrieves", "library", "combined", "document", "file" ]

[ "def", "enter_into_queue?", "# Check if enough space in queue", "current_limit", "=", "queue_constraints", "[", ":capacity", "]", ".", "to_i", "current_usage", "=", "queue_constraints", "[", ":taken", "]", ".", "to_i", "+", "UserQ", "::", "UserQueue", ".", "count_unexpired", "(", "queue_constraints", "[", ":context", "]", ")", "# Assess whether enough space left into queue", "current_usage", "<", "current_limit", "end" ]

[ "Beautiful", "syntax", "." ]

[ "def", "gallery_list_all", "# ToDo: Research why Typhoeus works better than Faraday for this endpoint", "request", "=", "Typhoeus", "::", "Request", ".", "new", "(", "\"#{Kairos::Configuration::GALLERY_LIST_ALL}\"", ",", "method", ":", ":post", ",", "headers", ":", "{", "\"Content-Type\"", "=>", "\"application/x-www-form-urlencoded\"", ",", "\"app_id\"", "=>", "\"#{@app_id}\"", ",", "\"app_key\"", "=>", "\"#{@app_key}\"", "}", ")", "response", "=", "request", ".", "run", "JSON", ".", "parse", "(", "response", ".", "body", ")", "rescue", "\"INVALID_JSON: #{response.body}\"", "end" ]

[ "List", "all", "Galleries" ]

[ "def", "method_missing", "(", "name", ",", "*", "args", ")", "if", "self", "[", "0", "]", ".", "respond_to?", "(", "name", ")", "self", ".", "inject", "(", "QueryResult", ".", "new", ")", "do", "|", "memo", ",", "node", "|", "ret", "=", "node", ".", "send", "(", "name", ",", "args", ")", "memo", "<<", "ret", "if", "ret", "memo", "end", "else", "super", "end", "end" ]

[ "To", "facilitate", "the", "management", "of", "what", "could", "be", "many", "nodes", "found", "by", "a", "single", "query", "we", "forward", "off", "any", "unknown", "methods", "to", "each", "node", "in", "the", "results", "query", ".", "We", "assume", "that", "if", "one", "node", "accepts", "the", "method", "then", "all", "of", "them", "will", "." ]

[ "def", "sync_attr_sync", "(", "attribute", ",", "&", "block", ")", "mutex_var_name", "=", "\"@sync_attr_#{attribute}\"", ".", "to_sym", "instance_variable_set", "(", "mutex_var_name", ",", "Mutex", ".", "new", ")", "unless", "instance_variable_defined?", "(", "mutex_var_name", ")", "instance_variable_get", "(", "mutex_var_name", ")", ".", "synchronize", "(", "block", ")", "end" ]

[ "Thread", "safe", "way", "of", "creating", "the", "instance", "sync" ]

[ "def", "wait_for_instance_death", "(", "instance", ",", "opts", "=", "{", "}", ")", "wait_for_instance_status", "(", ":terminated", ",", "instance", ",", "opts", ")", "if", "instance", ".", "exists?", "rescue", "AWS", "::", "EC2", "::", "Errors", "::", "InvalidInstanceID", "::", "NotFound", "end" ]

[ "Being", "serial", "shouldn", "t", "be", "much", "slower", "as", "we", "are", "blocked", "by", "the", "slowest", "stopper", "anyway" ]

[ "def", "get_widget_documents", "(", "widget_id", ",", "version_id", "=", "nil", ",", "participant_email", "=", "nil", ")", "Echochamber", "::", "Request", ".", "get_widget_documents", "(", "token", ",", "widget_id", ",", "version_id", ",", "participant_email", ")", "end" ]

[ "Retrieves", "the", "IDs", "of", "the", "documents", "associated", "with", "widget", "." ]

[ "def", "get_widget_document_file", "(", "widget_id", ",", "document_id", ",", "file_path", "=", "nil", ")", "response", "=", "Echochamber", "::", "Request", ".", "get_widget_document_file", "(", "token", ",", "widget_id", ",", "document_id", ")", "unless", "file_path", ".", "nil?", "file", "=", "File", ".", "new", "(", "file_path", ",", "'wb'", ")", "file", ".", "write", "(", "response", ")", "file", ".", "close", "end", "response", "end" ]

[ "Retrieves", "the", "file", "stream", "of", "a", "document", "of", "a", "widget" ]

[ "def", "redirect_notice", "(", "record", "=", "nil", ")", "{", "notice", ":", "I18n", ".", "t", "(", "\"crud.notices.#{action_name}\"", ",", "model", ":", "helpers", ".", "t_model", ",", "record", ":", "record", ".", "present?", "?", "\"#{record} \"", ":", "''", ")", "}", "end" ]

[ "returns", "a", "redirect", "notice", "for", "create", "update", "and", "destroy", "actions" ]

[ "def", "initialize_with_i18n_routing", "(", "name", ",", "app", ",", "path", ",", "constraints", ",", "defaults", "=", "{", "}", ")", "@locale", "=", "if", "constraints", ".", "key?", "(", ":i18n_locale", ")", "c", "=", "constraints", ".", "delete", "(", ":i18n_locale", ")", "# In rails 3.0 it's a regexp otherwise it's a string, so we need to call source on the regexp", "(", "c", ".", "respond_to?", "(", ":source", ")", "?", "c", ".", "source", ":", "c", ")", ".", "to_sym", "else", "nil", "end", "initialize_without_i18n_routing", "(", "name", ",", "app", ",", "path", ",", "constraints", ",", "defaults", ")", "end" ]

[ "During", "route", "initialization", "if", "a", "condition", "i18n_locale", "is", "present", "Delete", "it", "store", "it", "in" ]

[ "def", "raw_response", "(", "json", ",", "status", ")", "json", ".", "empty?", "?", "{", "}", ":", "JSON", ".", "parse", "(", "json", ",", "symbolize_names", ":", "true", ")", "rescue", "StandardError", "{", "message", ":", "json", ",", "code", ":", "status", "}", "end" ]

[ "Turn", "the", "API", "s", "JSON", "response", "and", "HTTP", "status", "code", "into", "a", "Ruby", "object", "." ]

[ "def", "do_migration", "migration_exists", "=", "Dir", "[", "\"db/migrate/*_create_user_queues.rb\"", "]", ".", "count", ">", "0", "if", "migration_exists", "and", "installing?", "puts", "\"UserQ is already installed. Maybe a 'rake db:migrate' command might help?\"", "return", "end", "create_migration", "puts", "\"Success! UserQ is installed. You can now use it in your application.\"", "if", "installing?", "puts", "\"UserQ has already been uninstalled. Remember the 'user_queue' table needs to be manually destroyed.\"", "if", "destroying?", "and", "migration_exists", "==", "false", "puts", "\"Success! UserQ is uninstalled. The table 'userq_queue' needs to be destroyed manually to complete removal.\"", "if", "destroying?", "and", "migration_exists", "end" ]

[ "Setup", "and", "create", "the", "migration" ]

[ "def", "create_user", "(", "user", ")", "user_response", "=", "Echochamber", "::", "Request", ".", "create_user", "(", "user", ",", "token", ")", "user_response", ".", "fetch", "(", "\"userId\"", ")", "end" ]

[ "Initializes", "the", "Client", "object" ]

[ "def", "create_transient_document", "(", "file_name", ",", "mime_type", ",", "file_handle", ")", "transient_document_response", "=", "Echochamber", "::", "Request", ".", "create_transient_document", "(", "token", ",", "file_name", ",", "file_handle", ",", "mime_type", ")", "transient_document_response", ".", "fetch", "(", "\"transientDocumentId\"", ")", "end" ]

[ "Creates", "a", "transient", "document", "for", "later", "referral" ]

[ "def", "ask_run_new_file", "(", "new_file_path", ",", "source_path", ",", "tmp", ")", "return", "if", "tmp", "&&", "IRT", ".", "rails_server", "original_ask_run_new_file", "(", "new_file_path", ",", "source_path", ",", "tmp", ")", "end" ]

[ "skips", "asking", "to", "run", "the", "save", "file", "if", "it", "is", "a", "tmp", "file", "in", "a", "server", "session", "because", "the", "server", "is", "exiting", "so", "no", "rerun", "is", "possible" ]

[ "def", "response_shim", "(", "body", ",", "status", ")", "items", "=", "JSON", ".", "parse", "(", "body", ",", "symbolize_names", ":", "true", ")", "{", "response", ":", "{", "items", ":", "items", ",", "offset", ":", "0", ",", "limit", ":", "items", ".", "size", ",", "totalItems", ":", "items", ".", "size", ",", "modeItems", ":", "false", "}", ",", "status", ":", "{", "result", ":", "status", "==", "200", "?", "'OK'", ":", "'ERROR'", ",", "message", ":", "extract_api_message", "(", "status", ",", "items", ")", ",", "code", ":", "status", "}", "}", ".", "to_json", "end" ]

[ "Fake", "a", "response", "which", "looks", "like", "we", "get", "from", "all", "the", "other", "paths", ".", "I", "m", "expecting", "the", "user", "response", "model", "to", "be", "made", "consistent", "with", "others", "in", "the", "future", "." ]

[ "def", "parse_opts", "(", "opts_in", ",", "opts_defaults", ")", "diff_id", "=", "opts_in", ".", "keys", "-", "opts_defaults", ".", "keys", "raise", "ArgumentError", ",", "\"Unrecognised argument(s): #{diff_id.join(\", \")}\"", "if", "diff_id", ".", "any?", "(", "opts_in", ".", "keys", "&", "opts_defaults", ".", "keys", ")", ".", "each", "do", "|", "k", "|", "raise", "ArgumentError", ",", "\"Argument #{k.to_s} must not be nil\"", "if", "opts_defaults", "[", "k", "]", "==", "nil", "and", "opts_in", "[", "k", "]", "==", "nil", "end", "(", "opts_defaults", ".", "keys", "-", "opts_in", ".", "keys", ")", ".", "each", "do", "|", "k", "|", "raise", "ArgumentError", ",", "\"Argument #{k.to_s} must not be nil\"", "if", "opts_defaults", "[", "k", "]", "==", "nil", "opts_in", ".", "merge!", "(", "k", "=>", "opts_defaults", "[", "k", "]", ")", "end", "opts_in", "end" ]

[ "Setting", "value", "of", "a", "key", "to", "nil", "in", "opts_defaults", "forces", "non", "-", "nil", "value", "of", "key", "in", "opts_in" ]

[ "def", "determine_remotely", "# Remove password field from URI, as libvirt doesn't support it directly. We can use it for passphrase if needed.", "lv_uri", "=", "URI", "::", "Generic", ".", "build", "(", ":scheme", "=>", "@connection_uri", ".", "scheme", ",", ":userinfo", "=>", "@connection_uri", ".", "user", ",", ":host", "=>", "@connection_uri", ".", "host", ",", ":path", "=>", "@connection_uri", ".", "path", ",", ":query", "=>", "@connection_uri", ".", "query", ")", "# The authentication only pertains to libvirtd itself and _not_ the transport (e.g. SSH).", "conn", "=", "Libvirt", "::", "open_auth", "(", "lv_uri", ".", "to_s", ",", "[", "Libvirt", "::", "CRED_AUTHNAME", ",", "Libvirt", "::", "CRED_PASSPHRASE", "]", ")", "do", "|", "cred", "|", "case", "cred", "[", "\"type\"", "]", "when", "Libvirt", "::", "CRED_AUTHNAME", "@connection_uri", ".", "user", "when", "Libvirt", "::", "CRED_PASSPHRASE", "@connection_uri", ".", "password", "end", "end", "if", "dom", "=", "get_existing_domain", "(", "conn", ",", "@appliance_name", ")", "unless", "@overwrite", "@log", ".", "fatal", "(", "\"A domain already exists with the name #{@appliance_name}. Set overwrite:true to automatically destroy and undefine it.\"", ")", "raise", "RuntimeError", ",", "\"Domain '#{@appliance_name}' already exists\"", "#Make better specific exception", "end", "@log", ".", "info", "(", "\"Undefining existing domain #{@appliance_name}\"", ")", "undefine_domain", "(", "dom", ")", "end", "guest", "=", "@libvirt_capabilities", ".", "determine_capabilities", "(", "conn", ",", "@previous_plugin_info", ")", "raise", "\"Remote libvirt machine offered no viable guests!\"", "if", "guest", ".", "nil?", "xml", "=", "generate_xml", "(", "guest", ")", "@log", ".", "info", "(", "\"Defining domain #{@appliance_name}\"", ")", "conn", ".", "define_domain_xml", "(", "xml", ")", "xml", "ensure", "if", "conn", "conn", ".", "close", "unless", "conn", ".", "closed?", "end", "end" ]

[ "Interact", "with", "a", "libvirtd", "attempt", "to", "determine", "optimal", "settings", "where", "possible", ".", "Register", "the", "appliance", "as", "a", "new", "domain", "." ]

[ "def", "determine_locally", "domain", "=", "@libvirt_capabilities", ".", "get_plugin", "(", "@previous_plugin_info", ")", ".", "domain_rank", ".", "last", "generate_xml", "(", "OpenStruct", ".", "new", "(", "{", ":domain_type", "=>", "domain", ".", "name", ",", ":os_type", "=>", "domain", ".", "virt_rank", ".", "last", ",", ":bus", "=>", "domain", ".", "bus", "}", ")", ")", "end" ]

[ "Make", "no", "external", "connections", "just", "dump", "a", "basic", "XML", "skeleton", "and", "provide", "sensible", "defaults", "where", "user", "provided", "values", "are", "not", "given", "." ]

[ "def", "upload_image", "uploader", "=", "SFTPHelper", ".", "new", "(", ":log", "=>", "@log", ")", "#SFTP library automagically uses keys registered with the OS first before trying a password.", "uploader", ".", "connect", "(", "@image_delivery_uri", ".", "host", ",", "(", "@image_delivery_uri", ".", "user", "||", "Etc", ".", "getlogin", ")", ",", ":password", "=>", "@image_delivery_uri", ".", "password", ")", "uploader", ".", "upload_files", "(", "@image_delivery_uri", ".", "path", ",", "@default_permissions", ",", "@overwrite", ",", "File", ".", "basename", "(", "@previous_deliverables", ".", "disk", ")", "=>", "@previous_deliverables", ".", "disk", ")", "ensure", "uploader", ".", "disconnect", "if", "uploader", ".", "connected?", "end" ]

[ "Upload", "an", "image", "via", "SFTP" ]

[ "def", "build_xml", "(", "opts", "=", "{", "}", ")", "opts", "=", "{", ":bus", "=>", "@bus", ",", ":os_type", "=>", ":hvm", "}", ".", "merge!", "(", "opts", ")", "builder", "=", "Builder", "::", "XmlMarkup", ".", "new", "(", ":indent", "=>", "2", ")", "xml", "=", "builder", ".", "domain", "(", ":type", "=>", "opts", "[", ":domain_type", "]", ".", "to_s", ")", "do", "|", "domain", "|", "domain", ".", "name", "(", "@appliance_name", ")", "domain", ".", "description", "(", "@appliance_config", ".", "summary", ")", "domain", ".", "memory", "(", "@appliance_config", ".", "hardware", ".", "memory", "*", "1024", ")", "#KB", "domain", ".", "vcpu", "(", "@appliance_config", ".", "hardware", ".", "cpus", ")", "domain", ".", "os", "do", "|", "os", "|", "os", ".", "type", "(", "opts", "[", ":os_type", "]", ".", "to_s", ",", ":arch", "=>", "@appliance_config", ".", "hardware", ".", "arch", ")", "os", ".", "boot", "(", ":dev", "=>", "'hd'", ")", "end", "domain", ".", "devices", "do", "|", "devices", "|", "devices", ".", "disk", "(", ":type", "=>", "'file'", ",", ":device", "=>", "'disk'", ")", "do", "|", "disk", "|", "disk", ".", "source", "(", ":file", "=>", "\"#{@libvirt_image_uri}/#{File.basename(@previous_deliverables.disk)}\"", ")", "disk", ".", "target", "(", ":dev", "=>", "'hda'", ",", ":bus", "=>", "opts", "[", ":bus", "]", ".", "to_s", ")", "end", "devices", ".", "interface", "(", ":type", "=>", "'network'", ")", "do", "|", "interface", "|", "interface", ".", "source", "(", ":network", "=>", "@network", ")", "interface", ".", "mac", "(", ":address", "=>", "@mac", ")", "if", "@mac", "end", "devices", ".", "console", "(", ":type", "=>", "'pty'", ")", "unless", "@noautoconsole", "devices", ".", "graphics", "(", ":type", "=>", "'vnc'", ",", ":port", "=>", "-", "1", ")", "unless", "@novnc", "end", "domain", ".", "features", "do", "|", "features", "|", "features", ".", "pae", "if", "@appliance_config", ".", "os", ".", "pae", "end", "end", "@log", ".", "debug", "xml", "# Let the user modify the XML specification to their requirements", "if", "@script", "@log", ".", "info", "\"Attempting to run user provided script for modifying libVirt XML...\"", "xml", "=", "IO", "::", "popen", "(", "\"#{@script} --domain '#{xml}'\"", ")", ".", "read", "@log", ".", "debug", "\"Response was: #{xml}\"", "end", "xml", "end" ]

[ "Build", "the", "XML", "domain", "definition", ".", "If", "the", "user", "provides", "a", "script", "it", "will", "be", "called", "after", "the", "basic", "definition", "has", "been", "constructed", "with", "the", "XML", "as", "the", "sole", "parameter", ".", "The", "output", "from", "stdout", "of", "the", "script", "will", "be", "used", "as", "the", "new", "domain", "definition", "." ]

[ "def", "get_existing_domain", "(", "conn", ",", "name", ")", "return", "conn", ".", "lookup_domain_by_name", "(", "name", ")", "rescue", "Libvirt", "::", "Error", "=>", "e", "return", "nil", "if", "e", ".", "libvirt_code", "==", "42", "# If domain not defined", "raise", "# Otherwise reraise", "end" ]

[ "Look", "up", "a", "domain", "by", "name" ]

[ "def", "undefine_domain", "(", "dom", ")", "case", "dom", ".", "info", ".", "state", "when", "Libvirt", "::", "Domain", "::", "RUNNING", ",", "Libvirt", "::", "Domain", "::", "PAUSED", ",", "Libvirt", "::", "Domain", "::", "BLOCKED", "dom", ".", "destroy", "end", "dom", ".", "undefine", "end" ]

[ "Undefine", "a", "domain", ".", "The", "domain", "will", "be", "destroyed", "first", "if", "required", "." ]

[ "def", "write_xml", "(", "xml", ")", "fname", "=", "\"#{@appliance_name}.xml\"", "File", ".", "open", "(", "\"#{@dir.tmp}/#{fname}\"", ",", "'w'", ")", "{", "|", "f", "|", "f", ".", "write", "(", "xml", ")", "}", "register_deliverable", "(", ":xml", "=>", "fname", ")", "end" ]

[ "Write", "domain", "XML", "to", "file" ]

[ "def", "with_temp_file", "filename", "=", "original_filename", "||", "content", ".", "default_file_name", "basename", "=", "[", "File", ".", "basename", "(", "filename", ",", "\".*\"", ")", ",", "File", ".", "extname", "(", "filename", ")", "]", "infile", "=", "Tempfile", ".", "open", "(", "basename", ",", "Ddr", "::", "Models", ".", "tempdir", ",", "encoding", ":", "'ascii-8bit'", ")", "begin", "infile", ".", "write", "(", "content", ".", "content", ")", "infile", ".", "close", "verify_checksum!", "(", "infile", ")", "yield", "infile", ".", "path", "ensure", "infile", ".", "close", "unless", "infile", ".", "closed?", "File", ".", "unlink", "(", "infile", ")", "end", "end" ]

[ "Yields", "path", "of", "tempfile", "containing", "content", "to", "block" ]

[ "def", "member_of?", "(", "group", ")", "if", "group", ".", "is_a?", "Group", "groups", ".", "include?", "group", "else", "member_of?", "Group", ".", "new", "(", "group", ")", "end", "end" ]

[ "Is", "the", "user", "associated", "with", "the", "auth", "context", "a", "member", "of", "the", "group?" ]